authentik/website/integrations/hypervisors-orchestrators/arcane/index.md at e7fcfb7e67d5df3e8a8a5da170f18fa4c6b98731

mirror of https://github.com/goauthentik/authentik synced 2026-04-27 18:07:15 +02:00

Files

Teffen Ellis 6ed5cb5249 website/docs: Modal and wizard button labels (#21549 )

* 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>

2026-04-16 17:35:38 +00:00

3.8 KiB

Raw Blame History

title, sidebar_label, support_level

title	sidebar_label	support_level
Integrate with Arcane	Arcane	community

What is Arcane

Modern Docker Management, Designed for Everyone.

-- https://github.com/getarcaneapp/arcane

Preparation

The following placeholders are used in this guide:

arcane.company is the FQDN of the Arcane 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 Arcane with authentik, you need to create an application/provider pair in authentik.

Create custom scope mapping

Arcane either requires the email scope to return a true value for whether the email address is verified, if account merge is enabled. As of authentik 2025.10 the default behavior is to return email_verified: False, so a custom scope mapping is required for Arcane to allow authentication.

Log in to authentik as an administrator and open the authentik Admin interface.
Navigate to Customization > Property Mappings and click Create.
- Select type: select Scope Mapping.
- Configure the Scope Mapping: Provide a descriptive name (e.g. Arcane Email Scope), and an optional description.
  - Scope name: email
  - Expression:
```
return {
    "email": request.user.email,
    "email_verified": True
}
```
Click Finish to save the property mapping.

Create an application and provider in authentik

Log in to authentik as an administrator and open the authentik Admin interface.
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.
  - Note the Client ID, Client Secret, and slug values because they will be required later.
  - Set a Strict redirect URI to https://arcane.company/auth/oidc/callback.
  - Select any available signing key.
  - Under Advanced protocol settings:
    - Remove the authentik default OAuth Mapping: OpenID 'email' scope, and add the custom scope mapping you created above.
- Configure Bindings (optional): you can create a binding (policy, group, or user) to manage the listing and access to applications on a user's My applications page.
Click Submit to save the new application and provider.

Arcane configuration

To configure Arcane to use authentik, add the following environment variables to your Arcane deployment:

OIDC_ENABLED=true
OIDC_CLIENT_ID=<client_id>
OIDC_CLIENT_SECRET=<client_secret>
OIDC_ISSUER_URL=https://authentik.company/application/o/<application_slug>/
OIDC_MERGE_ACCOUNTS=true # Match first SSO login to existing account by email
OIDC_SCOPES="openid email profile"

Then restart Arcane to apply the changes.

Resources

Arcane Docs - OIDC Single Sign-On

Configuration verification

To verify the integration of authentik with Arcane, log out of Arcane, then on the login page select Sign in with OIDC Provider.

3.8 KiB Raw Blame History