This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
authentik/website/integrations/services/freshrss/index.md
2023-11-07 14:28:38 +01:00

2.4 KiB

title
FreshRSS

Support level: Community

What is FreshRSS

FreshRSS is a self-hosted RSS feed aggregator.

-- https://github.com/FreshRSS/FreshRSS

Preparation

The following placeholders will be used:

  • freshrss.company is the FQDN of the FreshRSS install.
  • port is the port on which the FreshRSS install is running (usually 443)
  • authentik.company is the FQDN of the authentik install.

authentik Configuration

In Authentik, create an OAuth2/OpenID Provider under Applications > Providers.

** Protocol Settings ** Client Type : Confidential

:::note Take note of the Client ID and Client Secret, you'll need them later. :::

Redirect URIs/Origins :

  • https://freshrss.company/i/oidc/
  • https://freshrss.company:port/i/oidc

Signing Key : Any of your signing keys

Then click Finish to create your provider.

Then create an Application, note its slug, and assign it to the provider you've just created.

FreshRSS Configuration

:::info This integration only works with the Docker or Kubernetes install of FreshRSS, using FreshRSS docker image, on x86_64 systems and without the Alpine version of the image. More information can be found on this issue on FreshRSS GitHub :::

Add those environment variables to your Docker image :

  • OIDC_ENABLED : 1
  • OIDC_PROVIDER_METADATA_URL : https://authentik.company/application/o/<application-slug>/.well-known/openid-configuration replacing <application-slug> with the slug of your created application
  • OIDC_CLIENT_ID : the client ID of your provider
  • OIDC_CLIENT_SECRET : the client secret of your provider
  • OIDC_X_FORWARDED_HEADERS : X-Forwarded-Port X-Forwarded-Proto X-Forwarded-Host
  • OIDC_SCOPES : openid email profile

Before restarting your Docker container, ensure that one of the Admin users of your FreshRSS instance has the same login as one of your Authentik user.

Restart your FreshRSS container, and login as a user that exists on both FreshRSS and your Authentik. Navigate to Settings > Authentication in your FreshRSS instance, and choose as an authentication method HTTP (for advanced users with HTTPS)

You can find additional information on FreshRSS documentation