6d4c9a3446
* Typo and improved language * Changes "admin" to "administrator" and updates indentation * Updates miniflux to newer styling * Combines two notes at beginning of jellyfin doc into one * Replaces all "your application slug" with "application_slug" and replaces tags that are no longer in use * Replaces tags that are no longer in use * Updates immich indentation, application_slug and removes tags * Updated bookstack indentation, tags and application slug * Removes kbd and em tags, and updates the application slug * Gix metadata header in bookstack doc * Lint fix miniflux * ArgoCD indentation --------- Signed-off-by: Dewi Roberts <dewi@goauthentik.io>
3.0 KiB
title, sidebar_label, support_level
| title | sidebar_label | support_level |
|---|---|---|
| Integrate with Miniflux | Miniflux | community |
What is Miniflux
Miniflux is a minimalist and opinionated RSS feed reader.
Preparation
The following placeholders are used in this guide:
miniflux.companyis the FQDN of the Miniflux installation.authentik.companyis the FQDN of the authentik installation.
:::note 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
-
Log in to authentik as an administrator and open the authentik Admin interface.
-
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 Provider 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
Strictredirect URI tohttps://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.
- Application: provide a descriptive name (e.g.,
-
Click Submit to save the new application and provider.
Miniflux configuration
Add the following environment variables to your Miniflux configuration. Make sure to fill in the client ID, client secret, and OpenID Connect well-known URL 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
```
:::note
The trailing .well-known/openid-configuration is not required for OAUTH2_OIDC_DISCOVERY_ENDPOINT
:::
Restart the Miniflux service for the changes to take effect.
Configuration verification
To confirm that authentik is properly configured with Miniflux, log out of Miniflux, locate the "Sign in with OpenID Connect" button on the login page, click on it, and ensure you can successfully log in using Single Sign-On.