Homarr is running on port 7575 inside the container. Choose the external port for the container. Access Homarr using the external port or forward requests using a reverse proxy.

Target

7575

Value

10004

Homarr will write application data into a database and the filesystem. This mount is required to persist data when the container is re-created.

Target

/appdata

Value

/mnt/user/appdata/homarr/appdata

Homarr needs API keys, usernames, passwords and other confidential data to access data in your integrations. To safely store this data, we use AES-256-CBC, which prevents third parties from extracting these credentials. For this, you must provide a randomly generated encryption key. Open a shell and copy the output of 'openssl rand -hex 32' to this field.

Target

SECRET_ENCRYPTION_KEY

Gives Homarr the ability to restart, stop, start, refresh and remove containers as well as add them to the dashboard. Set to read-only actions by default - can be a potential security risk.

Target

/var/run/docker.sock

Value

/var/run/docker.sock

Alternative to mounting via path. Comma separated list of hostnames to connect to. Example: localhost,docker.example.com

Target

DOCKER_HOSTNAMES

Alternative to mounting via path. Comma separated list of ports to connect to. Must be the same length as DOCKER_HOSTNAMES. Example: 2375,2376

Target

DOCKER_PORTS

Select Which provider to use between credentials, ldap and oidc. Multiple providers can be enabled with by separating them with commas (ex. 'AUTH_PROVIDERS=credentials,oidc'). It is highly recommended to just enable one provider.

Target

AUTH_PROVIDERS

Default

credentials

URL to redirect to after clicking logging out. Can be left empty in most cases.

Target

AUTH_LOGOUT_REDIRECT_URL

Time for the session to time out. Can be set as pure number, which will automatically be used in seconds, or followed by s, m, h or d for seconds, minutes, hours or days. (ex: '30m')

Target

AUTH_SESSION_EXPIRY_TIME

Default

30d

Value

30d

URI of your LDAP server. See https://homarr.dev/docs/advanced/single-sign-on/ for more information.

Target

AUTH_LDAP_URI

Base DN (aka. distinguished name) of your LDAP server. See https://homarr.dev/docs/advanced/single-sign-on/ for more information.

Target

AUTH_LDAP_BASE

User used for finding users and groups. See https://homarr.dev/docs/advanced/single-sign-on/ for more information.

Target

AUTH_LDAP_BIND_DN

Password for bind user. See https://homarr.dev/docs/advanced/single-sign-on/ for more information.

Target

AUTH_LDAP_BIND_PASSWORD

Attribute used for username. See https://homarr.dev/docs/advanced/single-sign-on/ for more information.

Target

AUTH_LDAP_USERNAME_ATTRIBUTE

Attribute used for mail field. See https://homarr.dev/docs/advanced/single-sign-on/ for more information.

Target

AUTH_LDAP_USER_MAIL_ATTRIBUTE

Class used for querying groups. See https://homarr.dev/docs/advanced/single-sign-on/ for more information.

Target

AUTH_LDAP_GROUP_CLASS

Attribute used for querying group member. See https://homarr.dev/docs/advanced/single-sign-on/ for more information.

Target

AUTH_LDAP_GROUP_MEMBER_ATTRIBUTE

User attribute used for comparing with group member. See https://homarr.dev/docs/advanced/single-sign-on/ for more information.

Target

AUTH_LDAP_GROUP_MEMBER_USER_ATTRIBUTE

Search scopes between base, one and sub. See https://homarr.dev/docs/advanced/single-sign-on/ for more information.

Target

AUTH_LDAP_SEARCH_SCOPE

Extra arguments for user search filter (and based). See https://homarr.dev/docs/advanced/single-sign-on/ for more information.

Target

AUTH_LDAP_USERNAME_FILTER_EXTRA_ARG

Extra arguments for user's groups search filter (and based). See https://homarr.dev/docs/advanced/single-sign-on/ for more information.

Target

AUTH_LDAP_GROUP_FILTER_EXTRA_ARG

Issuer URI of OIDC provider without trailing slash (/). See https://homarr.dev/docs/advanced/single-sign-on/ for more information.

Target

AUTH_OIDC_ISSUER

ID of OIDC client (application). See https://homarr.dev/docs/advanced/single-sign-on/ for more information.

Target

AUTH_OIDC_CLIENT_ID

Secret of OIDC client (application). See https://homarr.dev/docs/advanced/single-sign-on/ for more information.

Target

AUTH_OIDC_CLIENT_SECRET

Display name of provider (in login screen). See https://homarr.dev/docs/advanced/single-sign-on/ for more information.

Target

AUTH_OIDC_CLIENT_NAME

Automatically redirect to OIDC login. See https://homarr.dev/docs/advanced/single-sign-on/ for more information.

Target

AUTH_OIDC_AUTO_LOGIN

Overwrite default scopes (openid, profile, email). See https://homarr.dev/docs/advanced/single-sign-on/ for more information.

Target

AUTH_OIDC_SCOPE_OVERWRITE

Attribute used for groups (roles) claim. See https://homarr.dev/docs/advanced/single-sign-on/ for more information.

Target

AUTH_OIDC_GROUPS_ATTRIBUTE

Attribute used for name (preferred_username or name) claim. See https://homarr.dev/docs/advanced/single-sign-on/ for more information.

Target

AUTH_OIDC_NAME_ATTRIBUTE_OVERWRITE

Database driver to use. Currently better-sqlite3 is used for sqlite and mysql2 for mysql. better-sqlite3 is easier to use and requires to additional containers but may not scale as well. Default is 'better-sqlite3'.

Target

DB_DRIVER

Default

better-sqlite3|mysql2

Value

better-sqlite3

Database dialect to use. Either choose 'sqlite' or 'mysql'. Default is 'sqlite'

Target

DB_DIALECT

Default

sqlite|mysql

Value

sqlite

Database URL to connect to. Default is '/appdata/db/db.sqlite'. The URL is a combination of all DB fields below. The URL will be prioritized over the other values if both are present.

Target

DB_URL

Database host to connect to.

Target

DB_HOST

Database port to connect to.

Target

DB_PORT

Database name to connect to.

Target

DB_NAME

Database user to connect with.

Target

DB_USER

Database password to connect with.

Target

DB_PASSWORD

Disable any automatic database migrations. Can be useful, when you manually migrate your database or if you want to restore data. Only set this to true if you know what you're doing!

Target

DB_MIGRATIONS_DISABLED

Default

false|true

Value

false

By default, the container is running as root and the application is running as a lower user. Using this variable, you can override the container user - this comes at the cost of some additional complexity. See https://homarr.dev/docs/advanced/running-as-different-user/. Only set this if you know what you're doing!

Target

PUID

By default, the container is running as root and the application is running as a lower user. Using this variable, you can override the container group - this comes at the cost of some additional complexity. See https://homarr.dev/docs/advanced/running-as-different-user/. Only set this if you know what you're doing!

Target

PGID