Environment variables - tylergibbs2/Tsundoku GitHub Wiki
Environment variables and their uses are listed below.
All environment variables are optional. None of these are required to be set.
Variable | Type | Description | Sample value | Notes |
---|---|---|---|---|
HOST |
string | Which host to run the application under | localhost |
Will override any configuration option |
PORT |
number | Which port to bind to on the host | 6439 |
Will override any configuration option |
SECRET_KEY |
string | Secure key for encrypting session information | AGgDjF464DD2Wwnvbcw |
Tsundoku auto-generates this, but you can override it with this env var |
DATA_DIR |
string | Path (absolute or relative) for storing app data | data |
Tsundoku defaults to using data/ |
DISABLE_POLL_ON_START |
boolean | Disables polling RSS feeds upon app startup | 1 |
|
IS_DOCKER |
boolean | The current environment is a Docker container | 1 |
You shouldn't set this manually |
IS_DEBUG |
boolean | The app should run in debug/development mode | 0 |
|
GITHUB_REPO_OWNER |
string | GitHub repo owner to use when checking for new releases | tylergibbs2 |
|
GITHUB_REPO_NAME |
string | GitHub repo name to use when checking for new releases | Tsundoku |
You can also load environment variables at app startup via the use of a .env
file in the root directory.