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).

🔐 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).

🖨 Printer Integration

Configuration for integrating with industrial label and barcode printers.

Variable Description
PRINTER_MODE Connection type (local or network).
PRINTER_HOST IP address of the network printer.
PRINTER_PORT Printer communication port (Standard: 9100).