ContextQMD
Back to Authentik

Integrate with Miniflux

website/integrations/media/miniflux/index.md

latest3.2 KB
Original Source

What is Miniflux

Miniflux is a minimalist and opinionated RSS feed reader.

-- https://github.com/miniflux/v2

Preparation

The following placeholders are used in this guide:

  • miniflux.company is the FQDN of the Miniflux 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 Miniflux 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 (e.g., Miniflux), 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://miniflux.company/oauth2/oidc/callback
      • 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.

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

Miniflux configuration

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

sh
OAUTH2_PROVIDER=oidc
OAUTH2_CLIENT_ID=<Client ID from authentik>
OAUTH2_CLIENT_SECRET=<Client Secret from authentik>
OAUTH2_REDIRECT_URL=https://miniflux.company/oauth2/oidc/callback
OAUTH2_OIDC_DISCOVERY_ENDPOINT=https://authentik.company/application/o/<application_slug>/
OAUTH2_USER_CREATION=1

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

:::info The trailing .well-known/openid-configuration is not required for OAUTH2_OIDC_DISCOVERY_ENDPOINT. :::

Restart the Miniflux service for the changes to take effect.

:::info Existing Miniflux accounts Existing Miniflux accounts must first be linked to a matching authentik account. To do this, log in using your existing Miniflux credentials, go to Settings and click on Link my OpenID Connect account. :::

Configuration verification

To confirm that authentik is properly configured with Miniflux, log out of Miniflux, then use the "Sign in with OpenID Connect" button on the login page and verify that Single Sign-On succeeds.