Skip to content

Environment Variables

Some of Dorsal's settings can be configured by setting an Environment Variable.

When set, environment variables always take precedence over options set in the dorsal.toml configuration file.

Authentication

Variable Description
DORSAL_API_KEY The API Key used to authenticate with DorsalHub. Setting this overrides any key stored in the global config file.

Example: VULlMCo8CalJHcgpJz1g074Qt-C2_vZsJlUEDQaa

Networking & Offline Mode

Variable Description
DORSAL_OFFLINE If set to true or 1, Dorsal enters Offline Mode. All communication with the DorsalHub API is blocked. Attempts to use API-dependent features (like push or search) will raise an error.

Note: This only blocks calls to DorsalHub and has no other effect on networking
DORSAL_API_URL Overrides the destination URL for API requests. Primarily used for development (pointing to a local mock server) or enterprise (routing through a specific API gateway)

Default: https://api.dorsalhub.com

Caching

Variable Description
DORSAL_CACHE_ENABLED If set to false or 0, the local cache is disabled. Dorsal will neither read from nor write to the local cache database.

Default: true
DORSAL_CACHE_COMPRESSION If set to false or 0, cache records will be stored as raw JSON strings instead of zlib-compressed blobs.

Default: true

CLI

Variable Description
DORSAL_THEME Sets the color theme for the CLI output. Accepts the name of any built-in theme.

Values: default, dracula, mono, high_contrast, light, neon