🐳 Environment variables
Homarr offers a Docker Container, which can be run on any compatible system, such as Unraid, Kubernetes and many more systems! Our Docker container is based on the node:16-alpine image and serves per standard on the port 7575.
Homarr offers a few environment variables, which can be used to configure the container.
| Environment Variable | Section |
|---|---|
DEFAULT_COLOR_SCHEME | |
PORT | Web server settings |
DOCKER_HOST | Docker Integration |
DOCKER_PORT | Docker Integration |
TZ | Timezone |
DISABLE_ANALYTICS | Anonymous analytics |
Colors and preferences
| Environment key | Possible values | Default |
|---|---|---|
DEFAULT_COLOR_SCHEME | dark / light | light |
You can change the default color theme for all users using this environment variable. However, this will be overwritten on a per-user basis if they selected another theme in the application. This is mostly useful for new users.
Web server settings
| Environment key | Possible values | Default |
|---|---|---|
PORT | any valid networking Port | 7575 |
By default, Homarr will run on port 7575. However, you might want to change this for advanced setups or if you're running in host network mode.
Docker Integration
| Environment key | Possible values | Default |
|---|---|---|
DOCKER_HOST | unix:///var/run/docker.sock or tcp://<ip>:<port> | - |
DOCKER_PORT | any valid networking Port | - |
If the Docker instance you want to connect to is not on the same machine, then you can use unix: or tcp: protocols instead.
This will enable you to control a completly different machine over your network.
Timezone Settings
| Environment key | Possible values | Default |
|---|---|---|
TZ | Any TZ identifier from here | your local time zone |
Some users might experience wrong dates/times in their Calendar. This is because the Calendar is using the server-side time. Although you should always set your host machine to your local time zone, you should specify the timezone for Homarr to ensure that the timezone is always set correctly.
Unsure what your timezone is? You can find yours on this Wikipedia page. Simply copy the value of the column "TZ database name".
Please note that this should work on nearly all systems. Check out these two amazing articles by howtogeek on timezones in containers:
Anonymous Analytics
| Environment key | Possible values | Default |
|---|---|---|
DISABLE_ANALYTICS | true / false | false |
By default we collect anonymous analytics when you visit https://homarr.dev or your personal Homarr instance.
As a fully open source project we value privacy as much as you do.
For that reason we aren't using Google Analytics and use Umami Analytics instead.
We use this data to evaluate and prioritize new features or improvements to Homarr.
All of your data is anonymized before it is sent to the server.
You can disable this data reporting by setting the environment variable DISABLE_ANALYTICS to true.
Alternatively, you can block any outgoing requests to umami.homarr.dev on your firewall.
We will never sell this data or track your specific user activity.
Authentication
Homarr supports multiple authentication providers. For a more detailed walkthrough, it is recommended that you read on how to set up SSO in Homarr.
| Environment Variable | Description | Default value |
|---|---|---|
AUTH_PROVIDER | Specifies which providers you want to use | credentials |
AUTH_LDAP_URI | URI of your LDAP server | --- |
AUTH_LDAP_BASE | Base dn of your LDAP server | --- |
AUTH_LDAP_BIND_DN | User used for finding users and groups | --- |
AUTH_LDAP_BIND_PASSWORD | Password for bind user | --- |
AUTH_LDAP_USERNAME_ATTRIBUTE | Attribute used for username | uid |
AUTH_LDAP_GROUP_CLASS | Class used for querying groups | groupOfUniqueNames |
AUTH_LDAP_GROUP_MEMBER_ATTRIBUTE | Attribute used for querying group member | member |
AUTH_LDAP_GROUP_MEMBER_USER_ATTRIBUTE | User attribute used for comparing with group member | dn |
AUTH_LDAP_ADMIN_GROUP | Admin group | admin |
AUTH_LDAP_OWNER_GROUP | Owner group | admin |
AUTH_OIDC_URI | URI of OIDC provider | --- |
AUTH_OIDC_CLIENT_ID | ID of OIDC client (application) | --- |
AUTH_OIDC_CLIENT_SECRET | Secret of OIDC client (application) | --- |
AUTH_OIDC_CLIENT_NAME | Display name of provider (in login screen) | OIDC |
AUTH_OIDC_ADMIN_GROUP | Admin group | admin |
AUTH_OIDC_OWNER_GROUP | Owner group | admin |
AUTH_OIDC_TIMEOUT | Timeout in milliseconds | 3500 |