ContextQMD
Back to Authentik

Integrate with Homarr

website/integrations/dashboards/homarr/index.md

latest3.0 KB
Original Source

What is Homarr

A sleek, modern dashboard that puts all of your apps and services at your fingertips. Control everything in one convenient location. Seamlessly integrates with the apps you've added, providing you with valuable information.

-- https://homarr.dev/

Preparation

The following placeholders are used in this guide:

  • homarr.company is the FQDN of the Homarr installation.
  • authentik.company is the FQDN of the authentik installation.

:::info This documentation lists only the settings that you need to change from their default values. Be aware that any changes other than those explicitly mentioned in this guide could cause issues accessing your application. :::

authentik configuration

To support the integration of Homarr with authentik, you need to create an application/provider pair in authentik.

Create an application and provider in authentik

  1. Log in to authentik as an administrator and open the authentik Admin interface.
  2. Navigate to Applications > Applications and click Create with Provider to create an application and provider pair. (Alternatively you can first create a provider separately, then create the application and connect it with the provider.)
  • Application: provide a descriptive name, an optional group for the type of application, the policy engine mode, and optional UI settings.
  • Choose a Provider type: select OAuth2/OpenID Connect as the provider type.
  • Configure the Provider: provide a name (or accept the auto-provided name), the authorization flow to use for this provider, and the following required configurations.
    • Note the Client ID, Client Secret, and slug values because they will be required later.
    • Create two Strict redirect URIs: https://homarr.company/api/auth/callback/oidc and http://localhost:50575/api/auth/callback/oidc.
    • Select any available signing key.
  • Configure Bindings (optional): you can create a binding (policy, group, or user) to manage the listing and access to applications on a user's My applications page.
  1. Click Submit to save the new application and provider.

Homarr configuration

Add the following environment variables to your Homarr configuration. Replace the placeholders with values from your authentik instance.

sh
AUTH_PROVIDERS=oidc,credentials
AUTH_OIDC_CLIENT_ID=<Client ID from authentik>
AUTH_OIDC_CLIENT_SECRET=<Client secret from authentik>
AUTH_OIDC_ISSUER=https://authentik.company/application/o/<application_slug>/
AUTH_OIDC_URI=https://authentik.company/application/o/authorize
AUTH_OIDC_CLIENT_NAME=authentik
# Optional: Enable this if you want to allow migrating Homarr accounts between OIDC providers.
# AUTH_OIDC_ENABLE_DANGEROUS_ACCOUNT_LINKING=true
# Optional: Enable this if you want to skip the login button and auto-login via authentik.
# AUTH_OIDC_AUTO_LOGIN=true

Replace <application_slug> with the authentik application slug created earlier.

Restart the Homarr service for the changes to take effect.