System Configuration

Technical reference for environment variables and operational parameters.

🔑 Core Application Settings

These values are mandatory for the initial setup and activation of your ScanStock instance.

Variable	Description
`LICENSE_KEY`	Required. Your unique license key issued by JCP-VISION.
`DJANGO_SUPERUSER_USERNAME`	Administrator username for the initial setup.
`DJANGO_SUPERUSER_PASSWORD`	Secure password for the administrator account.
`DJANGO_SUPERUSER_EMAIL`	Contact email for the administrator account.

🌐 Application Behavior

Settings to control the runtime environment and network access.

Variable	Description	Default
`DEBUG`	Enables debug mode (Set to `False` for production).	`False`
`ALLOWED_HOSTS`	Comma-separated list of allowed domains or IPs.	`*`

🗄 Database Configuration

By default, ScanStock uses a high-performance SQLite database stored within the persistent Docker volume. Enterprise users may connect to external databases for enhanced scalability.

Variable	Description
`CUSTOM_ENGINE`	Set to `true` to enable external database support.
`DB_ENGINE`	Database backend (e.g., `django.db.backends.mysql`).
`DB_NAME`	Name of the external database.
`DB_HOST`	Hostname or IP of the database server.
`DB_PORT`	Communication port (MySQL: 3306, Postgres: 5432).
`DB_USER`	Database Username.
`DB_PASSWORD`	Database Password.

🔐 Security Settings

Optional hardening settings for production environments, especially when using HTTPS.

Variable	Description
`SECRET_KEY`	A unique, unpredictable value for cryptographic signing.
`SESSION_COOKIE_SECURE`	Set to `True` to enforce secure session cookies (HTTPS).
`CSRF_COOKIE_SECURE`	Set to `True` to enforce secure CSRF cookies (HTTPS).

⚙ Operational Settings

These control system behavior and scanning features.

Variable	Description	Default
`WEB_LABEL_PRINTER`	Enable web label printing.	`True`
`TRANSACTION_APPROVAL_NEEDED`	Require approval for transactions.	`True`
`LOGIN_AUTH_NEEDED`	Require authentication barcode login.	`True`
`ALLOW_ORDER_ENTRY`	Allow manual order entry.	`True`
`LOGIN_BARCODE_OVERRIDE`	Allow barcode login override.	`False`
`ALLOW_ORDER_SCAN`	Allow scanning for order details.	`True`
`ENFORCE_JS_REGEX`	Enforce Javascript regex validation.	`True`

📦 Barcode Scanning Configuration

These settings define barcode formats recognized by the system.

Variable	Description
`ITEM_SCAN_REGEX`	Regex pattern for item barcodes.
`QTY_SCAN_REGEX`	Regex pattern for quantity scans.
`AUTH_SCAN_REGEX`	Regex pattern for authentication barcodes.
`ORDER_SCAN_REGEX`	Regex pattern for order barcodes.

🔁 License & System Checks

Settings controlling licensing validation interval and behavior.

Variable	Description	Default
`CHECK_PERIODIC`	Enable periodic system checks.	`True`
`LICENSE_CHECK_INTERVAL_SECONDS`	License validation interval (in seconds).	`300`

🖨 Printer Configuration

Configure the internal label printing service.

Variable	Description	Default
`PRINTER_LOCAL_PORT`	Port used by the local printer service.	`54321`