mirror of
https://github.com/goauthentik/authentik
synced 2026-04-28 10:28:22 +02:00
* website/integrations: rename "Create with Provider" to "New Application" The application list page now uses a split-button labeled "New Application" instead of the old "Create with Provider" dropdown. Update all 113 integration guides to match. * website/docs: update flow, stage, and policy button labels - "Create" → "New Flow", "New Stage", "New Policy" for trigger buttons - "Finish" → "Create Flow", "Create Stage", "Create Policy" for submit - "Create and bind stage" → "New Stage" / "Bind Existing Stage" - "Create" (binding submit) → "Create Stage Binding" * website/docs: update provider button labels - "Create" → "New Provider" for trigger buttons - "Create with Provider" → "New Application" in RAC docs - "Create" → "New Property Mapping", "New RAC Endpoint", "New Prompt" for related entity creation * website/docs: update directory button labels - "Create" → "New Source" for federation/social login pages - "Create" → "New Role", submit → "Create Role" - "Create" → "New Invitation" - Policy binding submit → "Create Policy Binding" * website/docs: update endpoint device and system management button labels - "Create" → "New Endpoint Connector", "New Enrollment Token", "New Device Access Group", "New Flow" - Submit → "Create Device Access Group" - "Create" → "New Notification Rule", "New Notification Transport" - Binding submit → "Create Policy Binding" * Reorganize policy documentation * website/docs: address policy docs review feedback * post-rebase * website/docs: Reorganize policy documentation -- Revisions (#21601) * apply suggestions * Fix escaped. * Fix whitespace. * Update button label. * Fix phrasing. * Fix phrasing. * Clean up stragglers. * Format. --------- Co-authored-by: Dominic R <dominic@sdko.org>
71 lines
3.4 KiB
Markdown
71 lines
3.4 KiB
Markdown
---
|
|
title: Integrate with Harbor
|
|
sidebar_label: Harbor
|
|
support_level: community
|
|
---
|
|
|
|
## What is Harbor
|
|
|
|
> Harbor is an open source container image registry that secures images with role-based access control, scans images for vulnerabilities, and signs images as trusted. A CNCF Graduated project, Harbor delivers compliance, performance, and interoperability to help you consistently and securely manage images across cloud native compute platforms like Kubernetes and Docker.
|
|
>
|
|
> -- https://goharbor.io
|
|
|
|
## Preparation
|
|
|
|
The following placeholders are used in this guide:
|
|
|
|
- `harbor.company` is the FQDN of the Harbor 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.
|
|
:::
|
|
|
|
## authentik configuration
|
|
|
|
To support the integration of Harbor 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 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.
|
|
- **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.
|
|
- **Protocol Settings**:
|
|
- **Redirect URI**:
|
|
- Strict: `https://harbor.company/c/oidc/callback`.
|
|
- **Signing Key**: select any available signing key.
|
|
- **Advanced Protocol Settings**:
|
|
- **Scopes**: add `authentik default OAuth Mapping: OpenID 'offline_access'` to **Selected Scopes**.
|
|
|
|
- **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 **My applications** page.
|
|
|
|
3. Click **Submit** to save the new application and provider.
|
|
|
|
## Harbor configuration
|
|
|
|
To support the integration of authentik with Harbor, you need to configure OIDC authentication.
|
|
|
|
1. Log in to the Harbor dashboard as an admin.
|
|
2. Navigate to **Configuration** and select the **Authentication** tab.
|
|
3. In the **Auth Mode** dropdown, select **OIDC** and provide the following required configurations.
|
|
- **OIDC Provider Name**: `authentik`
|
|
- **OIDC Endpoint**: `https://authentik.company/application/o/harbor/`
|
|
- **OIDC Client ID**: client ID from authentik
|
|
- **OIDC Client Secret**: client secret from authentik
|
|
- **Group Claim Name**: `groups`
|
|
- **OIDC Scope**: `openid,profile,email,offline_access`
|
|
- **Username Claim**: `preferred_username`
|
|
|
|
4. Click **Save**.
|
|
|
|
:::info
|
|
If you are experiencing redirect errors, ensure that you have set the `hostname` and `external_url` fields in your `harbor.yml` file and run the `setup.sh` script.
|
|
:::
|
|
|
|
## Configuration verification
|
|
|
|
To confirm that authentik is properly configured with Harbor, log out of Harbor, then use the "LOGIN VIA OIDC PROVIDER" button on the login page and verify that Single Sign-On succeeds.
|