From 98c3e0d68b55eaa7cb2be97cdda06c7cce838803 Mon Sep 17 00:00:00 2001 From: chwshka Date: Thu, 20 Mar 2025 15:52:49 +0200 Subject: [PATCH] website/integrations: add miniflux (#13559) * website/integrations: add miniflux * fixes authentik capitalisation * Updated to match suggestions * Update website/integrations/services/miniflux/index.md Co-authored-by: Dominic R Signed-off-by: Dewi Roberts * Updated to include and tags * fixed codeblock * Added explanatory text and removed extra EM tags * fixed prettier issue * Update website/integrations/services/miniflux/index.md Co-authored-by: Tana M Berry Signed-off-by: Dewi Roberts * Update website/integrations/services/miniflux/index.md Signed-off-by: Tana M Berry * Update website/integrations/services/miniflux/index.md Signed-off-by: Tana M Berry --------- Signed-off-by: Dewi Roberts Signed-off-by: Tana M Berry Co-authored-by: Dominic R Co-authored-by: Tana M Berry --- .../integrations/services/miniflux/index.md | 67 +++++++++++++++++++ website/sidebarsIntegrations.js | 1 + 2 files changed, 68 insertions(+) create mode 100644 website/integrations/services/miniflux/index.md diff --git a/website/integrations/services/miniflux/index.md b/website/integrations/services/miniflux/index.md new file mode 100644 index 0000000000..096f2f2dcb --- /dev/null +++ b/website/integrations/services/miniflux/index.md @@ -0,0 +1,67 @@ +--- +title: Integrate with Miniflux +sidebar_label: Miniflux +support_level: community +--- + +## 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. + +:::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 + +1. Log in to authentik as an admin, 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 create only an application, without a provider, by clicking **Create**.) + +- **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. + + - **Redirect URI**: + - Strict: https://miniflux.company/oauth2/oidc/callback + +- **Configure Bindings** _(optional)_: you can create a [binding](/docs/add-secure-apps/flows-stages/bindings/) (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. 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= +OAUTH2_CLIENT_SECRET= +OAUTH2_REDIRECT_URL=https://miniflux.company/oauth2/oidc/callback +OAUTH2_OIDC_DISCOVERY_ENDPOINT=https://authentik.company/application/o// +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. diff --git a/website/sidebarsIntegrations.js b/website/sidebarsIntegrations.js index 4b6e410861..ad4ade7fc1 100644 --- a/website/sidebarsIntegrations.js +++ b/website/sidebarsIntegrations.js @@ -141,6 +141,7 @@ module.exports = { "services/immich/index", "services/jellyfin/index", "services/komga/index", + "services/miniflux/index", "services/node-red/index", "services/open-webui/index", "services/semaphore/index",