Skip to main content

Integrate with Dashy

Support level: Community

What is Dashy?​

Dashy is a self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more.

-- https://github.com/Lissy93/dashy

Preparation​

The following placeholders are used in this guide:

  • dashy.company is the FQDN of the Dashy 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 Dashy with authentik, you need to create an application/provider pair in authentik.

If you want to manage Dashy administrator access through authentik, create or choose a group for Dashy administrators and add the appropriate users to it. Note the exact group name because it will be required later.

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 New Application to open the application wizard.

    • 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 and slug values because they will be required later.
      • Set the Client type to Public. Dashy runs entirely in the browser and does not store a client secret.
      • Create two Strict redirect URIs:
        • https://dashy.company
        • https://dashy.company/
      • 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 Application Dashboard page.

  3. Click Submit to save the new application and provider.

Dashy configuration​

Dashy can be configured through the web UI under Config > Edit Config or by editing conf.yml directly. The following steps describe the web UI flow.

  1. Log in to Dashy as an administrator and click Config > Edit Config.
  2. Open the App Config > Auth section.
  3. Check Enable OIDC?.
  4. Under Oidc:
    • Set OIDC Endpoint to https://authentik.company/application/o/<application_slug>/.
    • Set OIDC Client Id to the Client ID from the authentik provider.
    • Set OIDC Scope to openid profile email.
    • If you use an authentik group for Dashy administrators, set Admin Group to the exact name of that group.
  5. If you use an authentik group for Dashy administrators, enable Disable all UI Config for non admin users..
  6. Click Save Changes and reload Dashy to apply the new authentication settings.
Manual configuration

The same settings can also be set directly in conf.yml.

/user-data/conf.yml
appConfig:
    auth:
        enableOidc: true
        oidc:
            endpoint: https://authentik.company/application/o/<application_slug>/
            clientId: <Client ID from authentik>
            scope: openid profile email
            adminGroup: Dashy Admins
    disableConfigurationForNonAdmin: true

Replace Dashy Admins with the exact name of your authentik group for Dashy administrators.

Configuration verification​

To confirm that authentik is properly configured with Dashy, log out of Dashy, then open Dashy. You should be redirected to authentik to log in, then redirected back to Dashy.

Resources​