authentik/website/integrations/media/komga/index.md at e7fcfb7e67d5df3e8a8a5da170f18fa4c6b98731

mirror of https://github.com/goauthentik/authentik synced 2026-04-27 18:07:15 +02:00

Files

Teffen Ellis 6ed5cb5249 website/docs: Modal and wizard button labels (#21549 )

* website/integrations: rename "Create with Provider" to "New Application"

The application list page now uses a split-button labeled
"New Application" instead of the old "Create with Provider" dropdown.
Update all 113 integration guides to match.

* website/docs: update flow, stage, and policy button labels

- "Create" → "New Flow", "New Stage", "New Policy" for trigger buttons
- "Finish" → "Create Flow", "Create Stage", "Create Policy" for submit
- "Create and bind stage" → "New Stage" / "Bind Existing Stage"
- "Create" (binding submit) → "Create Stage Binding"

* website/docs: update provider button labels

- "Create" → "New Provider" for trigger buttons
- "Create with Provider" → "New Application" in RAC docs
- "Create" → "New Property Mapping", "New RAC Endpoint", "New Prompt"
  for related entity creation

* website/docs: update directory button labels

- "Create" → "New Source" for federation/social login pages
- "Create" → "New Role", submit → "Create Role"
- "Create" → "New Invitation"
- Policy binding submit → "Create Policy Binding"

* website/docs: update endpoint device and system management button labels

- "Create" → "New Endpoint Connector", "New Enrollment Token",
  "New Device Access Group", "New Flow"
- Submit → "Create Device Access Group"
- "Create" → "New Notification Rule", "New Notification Transport"
- Binding submit → "Create Policy Binding"

* Reorganize policy documentation

* website/docs: address policy docs review feedback

* post-rebase

* website/docs: Reorganize policy documentation -- Revisions (#21601)

* apply suggestions

* Fix escaped.

* Fix whitespace.

* Update button label.

* Fix phrasing.

* Fix phrasing.

* Clean up stragglers.

* Format.

---------

Co-authored-by: Dominic R <dominic@sdko.org>

2026-04-16 17:35:38 +00:00

4.2 KiB

Raw Blame History

title, sidebar_label, support_level

title	sidebar_label	support_level
Integrate with Komga	Komga	community

What is Komga

Komga is an open-source comic and manga server that lets users organize, read, and stream their digital comic collections with ease.

-- https://komga.org/

Preparation

The following placeholders are used in this guide:

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

Create an email verification scope mapping in authentik

Komga requires the email scope to return a value of email_verified: True. As of authentik 2025.10 the default behavior is to return email_verified: False, so a custom scope mapping is required for Komga to allow authentication.

Refer to Email scope verification for instructions on how to create the required custom scope mapping.

Create an application and provider in authentik

Log in to authentik as an administrator and open the authentik Admin interface.
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, Client Secret, and slug values because they will be required later.
- Set a Strict redirect URI to https://komga.company/login/oauth2/code/authentik.
- Select any available signing key.
- Advanced protocol settings > Scopes:
  - Add OAuth Mapping: OpenID 'email' with "email_verified" to the Selected Scopes.
  - Remove the authentik default OAuth Mapping: OpenID 'email' scope.
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.

Click Submit to save the new application and provider.

Komga configuration

To configure Komga, update its application.yml file to include the following options:

:::info All configuration options can be found in Komga's OAuth2 Advanced configuration documentation. :::

:::warning You can configure Komga to use either the sub or preferred_username as the UID field under user-name-attribute. When using preferred_username as the user identifier, ensure that the Allow users to change username setting is disabled to prevent authentication issues. The sub option uses a unique, stable identifier for the user, while preferred_username uses the username configured in authentik. :::

spring:
    security:
        oauth2:
            client:
                registration:
                    authentik:
                        provider: authentik
                        client-id: <client_id>
                        client-secret: <client_secret>
                        client-name: authentik
                        scope: openid,email,profile
                        authorization-grant-type: authorization_code
                        redirect-uri: "{baseUrl}/{action}/oauth2/code/{registrationId}"
                provider:
                    authentik:
                        user-name-attribute: preferred_username
                        issuer-uri: https://authentik.company/application/o/<application_slug>/

4.2 KiB Raw Blame History