-
-
Notifications
You must be signed in to change notification settings - Fork 996
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add references to gatus, freshrss, frappe; frappe new authentik confi…
…g format, freshrss revamp; fix typo in bookstack cfg
- Loading branch information
Showing
5 changed files
with
102 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
--- | ||
title: Integrate with FreshRSS | ||
sidebar_label: FreshRSS | ||
--- | ||
|
||
import IntegrationsMultilineCodeblock from "@site/src/components/Integrations/IntegrationsCodeblock"; | ||
|
||
# Integrate with FreshRSS | ||
|
||
<span class="badge badge--secondary">Support level: Community</span> | ||
|
||
## What is FreshRSS | ||
|
||
> FreshRSS is a self-hosted RSS feed aggregator. | ||
> | ||
> -- https://github.com/FreshRSS/FreshRSS | ||
## Preparation | ||
|
||
The following placeholders are used in this guide: | ||
|
||
- `freshrss.company` is the FQDN of the FreshRSS installation. | ||
- `authentik.company` is the FQDN of the authentik installation. | ||
|
||
:::note | ||
This documentation only lists the settings that have been changed from their default values. Please verify your changes carefully to avoid any issues accessing your application. | ||
::: | ||
|
||
## authentik configuration | ||
|
||
To support the integration of FreshRss with authentik, you need to create an application/provider pair in authentik. | ||
|
||
**Create an application and provider in authentik** | ||
|
||
In the authentik Admin Interface, navigate to **Applications** > **Applications** and click **[Create with Provider](/docs/add-secure-apps/applications/manage_apps#add-new-applications)** 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, 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. | ||
- Add two `Strict` redirect URI and set them to <kbd>https://<em>freshrss.company</em>/i/oidc/</kbd> and <kbd>https://<em>freshrss.company:443</em>/i/oidc/</kbd>. If FreshRSS is exposed on a port other than `443`, update the second redirect URI accordingly. | ||
- Select any available signing key. | ||
- **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. | ||
|
||
## FreshRSS configuration | ||
|
||
:::info | ||
This integration is compatible only with Docker or Kubernetes installations of FreshRSS that use the [FreshRSS Docker image](https://hub.docker.com/r/freshrss/freshrss/) on x86_64 systems. Note that the Alpine version of the image is not supported. For more details, see [this issue on the FreshRSS GitHub repository](https://github.com/FreshRSS/FreshRSS/issues/5722). | ||
::: | ||
|
||
:::warning | ||
Before restarting your Docker container, ensure that at least one Admin user in your FreshRSS instance has a username that matches an authentik user. | ||
::: | ||
|
||
To enable OIDC login with FreshRSS, update your `.env` file to include the following variables: | ||
|
||
<IntegrationsMultilineCodeblock> | ||
{` | ||
OIDC_ENABLED=1 | ||
OIDC_PROVIDER_METADATA_URL=https://<em>authentik.company</em>/application/o/<em>your-application-slug</em>/.well-known/openid-configuration | ||
OIDC_CLIENT_ID=<em>Your Client ID from authentik</em> | ||
OIDC_CLIENT_SECRET=<em>Your Client Secret from authentik</em> | ||
OIDC_X_FORWARDED_HEADERS=X-Forwarded-Port X-Forwarded-Proto X-Forwarded-Host | ||
OIDC_SCOPES=openid email profile | ||
`} | ||
</IntegrationsMultilineCodeblock> | ||
|
||
Once your container or pod is restarted, attempt to login as a user that exists in both FreshRSS and authentik. Go to **Settings** -> **Authentication** and set the authentication method to **HTTP**. | ||
|
||
## References | ||
|
||
- [FreshRSS documentation for OpenID Connect](https://freshrss.github.io/FreshRSS/en/admins/16_OpenID-Connect.html). | ||
- [FreshRSS documentation for OIDC with authentik](https://freshrss.github.io/FreshRSS/en/admins/16_OpenID-Connect-Authentik.html) | ||
|
||
## Configuration verification | ||
|
||
To verify that authentik is correctly set up with FreshRSS, log out of FreshRSS and try logging back in using authentik. You should see a new button on the login page for OIDC authentication. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters