Obscreen Docs

Appearance

Environment variables setup ​

🌐 Network ​

PORT ​

Set the application port for incoming connections.

Default: 5000

BIND ​

Define the application bind address for network interfaces.

Default: 0.0.0.0

NO_ZEROCONF ​

Disable zeroconf networking features. Zeroconf is useful for ObscreenOS users only.

Default: false

💬 Language & Localization ​

SETTING_LANG ​

Force a specific language for the application.

Default: (disabled)

SETTING_TIMEZONE ​

Force a specific timezone for the application.

Default: (disabled)

FALLBACK_LANG ​

Specify the fallback language if the primary is unavailable.

Default: en

LANGS_WHITELIST ​

Specify languages that users can manage.

Default: false

🗄️ Database ​

DATABASE_ENGINE ​

Specify the database engine to be used.

Default: sqlite [possible values: sqlite, postgresql]

DATABASE_DSN ​

Define the Data Source Name for database connections.

Default: sqlite:///%application_dir%/data/db/obscreen.db

DATABASE_HOST ​

Set the host address for the database server.

Default: (disabled)

DATABASE_PORT ​

Define the port number for the database server.

Default: (disabled)

DATABASE_USER ​

Specify the username for database authentication.

Default: (disabled)

DATABASE_PASSWORD ​

Provide the password for database authentication.

Default: (disabled)

DATABASE_NAME ​

Set the name of the database to connect to.

Default: (disabled)

DATABASE_SCHEMA ​

Define the database schema to be used.

Default: (disabled)

📋 Logging ​

LOG_FILE ​

Specify the file path for logging output.

Default: (disabled)

LOG_LEVEL ​

Set the logging level (e.g., DEBUG, INFO, WARN).

Default: INFO [possible values: DEBUG, INFO, WARN, ERROR, CRITICAL]

LOG_STDOUT ​

Enable logging to standard output.

Default: false [possible values: true, false]

🔒 System & Security ​

SAFE_MODE ​

Enable safe mode with authentication disabled.

Default: false

EXPOSE_SYSTEM ​

Display system information.

Default: true

EXTERNAL_ONLY ​

Restrict content display to external URLs only.

Default: false

AUTH_MASTER_PASSWORD ​

Set a master password for authentication purposes.

Default: (disabled)

📂 Directories ​

DATA_MOUNTPOINT ​

Define the directory for data mountpoints.

Default: %application_dir%/data

EXTERNAL_STORAGE_MOUNTPOINT ​

Set the directory for external storage mountpoints.

Default: %application_dir%/var/run/storage