Skip to content

website/integrations: Forgejo: cleanup #23642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dominic-r wants to merge 2 commits into
base: main
Choose a base branch
from
+32 −27
Open

website/integrations: Forgejo: cleanup #23642

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5391ffa
website/integrations: Forgejo: cleanup
dominic-r Jul 2, 2026
f864862
Apply suggestion from @dominic-r
dominic-r Jul 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 32 additions & 27 deletions website/integrations/development/forgejo/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ import RedirectURI20265Note from "../../\_redirect-uri-2026-5-note.mdx";

## What is Forgejo?

> Forgejo is a lightweight, self‑hosted alternative to GitHub/GitLab, with a strong emphasis on community governance and open development.
> Forgejo is a lightweight, self-hosted alternative to GitHub/GitLab, with a strong emphasis on community governance and open development.
>
> -- https://forgejo.org/

## Preparation

The following placeholders are used in this guide:

- `authentik.company` is the FQDN of the authentik installation.
- `forgejo.company` is the FQDN of the Forgejo 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.
Expand All @@ -29,17 +29,16 @@ This documentation lists only the settings that you need to change from their de

To support the integration of Forgejo with authentik, you need to create an application/provider pair in authentik.

### Create an application and provider in authentik
### Create an application and provider

1. Log in to authentik as an administrator and open the authentik Admin interface.
2. Navigate to **Applications** > **Applications** and click **New Application** to open the application wizard.
- **Application**: provide a descriptive name, an optional group for the type of application, the policy engine mode, and optional UI settings.
- **Application**: provide a descriptive name, an optional group for the type of application, the policy engine mode, and optional UI settings. Note the application **Slug** because it will be required later.
- **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 a **Redirect URI** of type `Strict` `Authorization` as `https://<forgejo.company>/user/oauth2/authentik/callback`.
- Note the **Client ID** and **Client Secret** values because they will be required later.
- Add a **Redirect URI** of type `Strict` `Authorization` as `https://forgejo.company/user/oauth2/authentik/callback`.
- Select any available signing key.
- Under **Advanced protocol settings** > **Selected Scopes**, add `authentik default OAuth Mapping: OpenID 'entitlements'`.
- **Configure Bindings** _(optional)_: you can create a [binding](/docs/add-secure-apps/bindings-overview/) (policy, group, or user) to manage the listing and access to applications on a user's **Application Dashboard** page.

3. Click **Submit** to save the new application and provider.
Expand All @@ -49,16 +48,27 @@ To support the integration of Forgejo with authentik, you need to create an appl
1. Log in to Forgejo as an administrator, then click your profile icon in the top-right corner and select **Site Administration**.
2. Select the **Authentication Sources** tab and then click on **Add Authentication Source**.
3. Set the following required configurations:
- **Authentication Name**: `authentik` (This must match the name used in the **Redirect URI** in the previous section)
- **OAuth2 Provider**: `OpenID Connect`
- **Client ID (Key)**: Enter the Client ID from authentik.
- **Client Secret**: Enter the Client Secret from authentik.
- **Authentication Name**: `authentik`. This value must match the name used in the **Redirect URI** in the previous section.
- **OAuth2 Provider**: select **OpenID Connect**.
- **Client ID (Key)**: enter the **Client ID** from authentik.
- **Client Secret**: enter the **Client Secret** from authentik.
- **Icon URL**: `https://authentik.company/static/dist/assets/icons/icon.png`
- **OpenID Connect Auto Discovery URL**: `https://authentik.company/application/o/<application_slug>/.well-known/openid-configuration`
- **Additional Scopes**: `email profile`

4. Click **Add Authentication Source**.

### Enable automatic user registration _(optional)_

If Forgejo should create user accounts after a successful authentik login, enable OAuth2 auto-registration in the Forgejo configuration:

```ini title="app.ini"
[oauth2_client]
ENABLE_AUTO_REGISTRATION = true
```

Restart Forgejo after changing its configuration file.

### Configure permissions _(optional)_

Optionally, application entitlements and property mappings can be created to manage user permissions in Forgejo.
Expand All @@ -72,7 +82,7 @@ The following application entitlements will be created:
- `gitrestricted`: restricted Forgejo users.

:::info Entitlement assignment is required
Users who are not assigned any of these entitlements will be denied login access. In contrast, users assigned the `gitadmin` entitlement will have full administrative privileges, while users assigned the `gitrestricted` entitlement will have limited access.
Users who are not assigned any of these entitlements will be denied login access. Users assigned the `gitadmin` entitlement will have full administrative privileges, while users assigned the `gitrestricted` entitlement will have limited access.
:::

1. Log in to authentik as an administrator and open the authentik Admin interface.
Expand Down Expand Up @@ -110,38 +120,33 @@ Users who are not assigned any of these entitlements will be denied login access

3. Click **Finish**.

#### Add the custom property mapping to the Forgejo provider
#### Add the custom property mapping to the provider

1. Log in to authentik as an administrator and open the authentik Admin interface.
2. Navigate to **Applications** > **Providers** and click on the **Edit** icon of the Forgejo provider.
3. Under **Advanced protocol settings** > **Scopes** add the following scopes to **Selected Scopes**:
- `authentik default OAuth Mapping: OpenID 'email'`
- `authentik default OAuth Mapping: OpenID 'profile'`
- `authentik default OAuth Mapping: OpenID 'openid'`
3. Under **Advanced protocol settings** > **Scopes**, add the following scope to **Selected Scopes**:
- `authentik forgejo OAuth Mapping: OpenID 'forgejo'`

4. Click **Update**.

#### Configure Forgejo to use the new claims

:::info
For this to function, the Forgejo `ENABLE_AUTO_REGISTRATION: true` variable must be set. More information on configuration variables is available in the [Forgejo Configuration Cheat Sheet](https://forgejo.org/docs/latest/admin/config-cheat-sheet/).
:::

1. Log in to Forgejo as an admin. Click your profile icon in the top-right corner, and then click **Site Administration**.
1. Log in to Forgejo as an administrator. Click your profile icon in the top-right corner, and then click **Site Administration**.
2. Select the **Authentication Sources** tab and edit the **authentik** Authentication Source.
3. Set the following configurations:
- **Additional Scopes**: `email profile forgejo`
- **Required Claim Name**: `forgejo`
- **Claim name providing group names for this source.** (Optional): `forgejo`
- **Group Claim value for administrator users.** (Optional - requires claim name to be set): `admin`
- **Group Claim value for restricted users.** (Optional - requires claim name to be set): `restricted`
- **Claim name providing group names for this source. (Optional)**: `forgejo`
- **Group Claim value for administrator users. (Optional - requires claim name above)**: `admin`
- **Group Claim value for restricted users. (Optional - requires claim name above)**: `restricted`
4. Click **Update Authentication Source**.

## Configuration verification

To verify that authentik is correctly set up with Forgejo, log out and then log back in using the **Sign in with authentik** button. You should be redirected to authentik, and once authenticated, you should then be signed in to Forgejo.
To confirm that authentik is properly configured with Forgejo, open Forgejo and sign in using the **Sign in with authentik** button.

## Resources

- [Official Forgejo Documentation](https://forgejo.org/docs/latest/)
- [Forgejo documentation - Configuration Cheat Sheet: OAuth2 Client](https://forgejo.org/docs/latest/admin/config-cheat-sheet/#oauth2-client-oauth2_client)
- [Forgejo source - OpenID Connect provider](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/services/auth/source/oauth2/providers_openid.go)
- [Forgejo source - OAuth2 callback handling](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/routers/web/auth/oauth.go)
Loading