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
Homarr offers a few environment variables, which can be used to configure the container.
|Web server settings
Colors and preferences
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
|any valid networking Port
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.
|any valid networking Port
If the Docker instance you want to connect to is not on the same machine, then you can use
tcp: protocols instead.
This will enable you to control a completly different machine over your network.
|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:
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
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.
Homarr supports multiple authentication providers. For a more detailed walkthrough, it is recommended that you read on how to set up SSO in Homarr.
|Specifies which providers you want to use
|URI of your LDAP server
|Base dn of your LDAP server
|User used for finding users and groups
|Password for bind user
|Attribute used for username
|Class used for querying groups
|Attribute used for querying group member
|User attribute used for comparing with group member
|URI of OIDC provider
|ID of OIDC client (application)
|Secret of OIDC client (application)
|Display name of provider (in login screen)