Environment variables
Here is a list of environment variables used by runtipi and their usage. These values are set in the .env
file and cannot be manually changed as the file is generated by the start
command.
You can change some values by using custom settings or by using custom environment variables.
Variable | Description |
---|---|
INTERNAL_IP | This is the IP address of the server in the internal network. It is used to generate links to the web interface. |
ARCHITECTURE | This is the architecture of the server. It is used to download the correct version of the runtipi apps. |
TIPI_VERSION | The current version of runtipi. |
ROOT_FOLDER_HOST | The root folder of the runtipi installation. |
NGINX_PORT | The port used by nginx without SSL (default 80) |
NGINX_PORT_SSL | The port used by nginx with SSL (default 443) |
POSTGRES_HOST | The host of the postgres database. |
POSTGRES_PASSWORD | The password of the postgres database. |
POSTGRES_PORT | The port used by postgres (default 5432) |
POSTGRES_USERNAME | The username of the postgres database. |
POSTGRES_DBNAME | The name of the postgres database. |
REDIS_HOST | The host of the redis database. |
REDIS_PASSWORD | The password of the redis database. |
RUNTIPI_APP_DATA_PATH | The path where to store the app-data folder. |
RUNTIPI_USER_CONFIG_PATH | The path where to store the user-config folder. |
RUNTIPI_TRAEFIK_PATH | The path where to store the traefik folder. |
RUNTIPI_LOGS_PATH | The path where to store the logs folder. |
RUNTIPI_APPS_PATH | The path where to store the apps folder. |
RUNTIPI_REPOS_PATH | The path where to store the repos folder. |
RUNTIPI_STATE_PATH | The path where to store the state folder. |
RUNTIPI_MEDIA_PATH | The path where to store the media folder. |
NODE_ENV | The environment of the server. |
DOMAIN | The domain name of the server. |
LOCAL_DOMAIN | The domain name of the server in the local network. |
APPS_REPO_URL | The URL of the apps repository. |
APPS_REPO_ID | A hash of the apps repository URL. |
TZ | The timezone of the server. Used only by some apps |
DNS_IP | The IP address of the DNS server. Legacy variable, not used anymore. Kept for compatibility. |
JWT_SECRET | The secret used to sign the JWT tokens. |
DEMO_MODE | Whether the server will be in demo mode and have a limited set of features. |
GUEST_DASHBOARD | Whether the server will have a guest dashboard. |
ALLOW_ERROR_MONITORING | Whether the server will send error reports to runtipi developers. |
PERSIST_TRAEFIK_CONFIG | Do not replace the traefik config in every restart |
App specific environment variables
Each app will have access to the previously mentioned environment variables as well as the following ones:
Variable | Description |
---|---|
APP_PORT | The port used by the app. |
APP_ID | The ID of the app. |
APP_DATA_DIR | The path where the app data is stored. |
APP_EXPOSED | Whether the app is exposed by traefik. |
APP_DOMAIN | The domain of the app. FQDN if exposed otherwise ip:port. |
APP_HOST | Same as APP_DOMAIN . But without the port in non-exposed scenarios. |
APP_PROTOCOL | The protocol used by the app. (http or https) |