mirror of
https://github.com/goauthentik/authentik
synced 2026-04-28 02:18:11 +02:00
6ed5cb5249
* 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>
85 lines
4.0 KiB
Markdown
85 lines
4.0 KiB
Markdown
---
|
|
title: Integrate with Plesk
|
|
sidebar_label: Plesk
|
|
support_level: community
|
|
---
|
|
|
|
## What is Plesk
|
|
|
|
> Plesk is a web hosting platform with a control panel that helps manage servers, applications, and websites through a comprehensive graphical user interface. It provides tools for web professionals, IT administrators, and hosting companies to simplify the process of hosting and managing websites.
|
|
>
|
|
> -- https://www.plesk.com
|
|
|
|
:::info
|
|
This documentation lists only the settings that you need to change from their default values. Changes other than those mentioned in this guide can cause issues accessing your application.
|
|
:::
|
|
|
|
:::caution
|
|
This integration works only with additional administrator accounts. It does not affect the main administrator account or customer accounts. The integration includes security measures such as strict token validation and secure OAuth implementation.
|
|
:::
|
|
|
|
## Preparation
|
|
|
|
Replace these placeholders in the guide with your values:
|
|
|
|
- `plesk.company`: The FQDN of your Plesk installation
|
|
- `authentik.company`: The FQDN of your authentik installation
|
|
|
|
## authentik configuration
|
|
|
|
To support the integration of Plesk 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.
|
|
- Note the **Client ID**, **Client Secret**, and **slug** values because they will be required later.
|
|
- Set a `Strict` redirect URI to `https://plesk.company/modules/oauth/public/login.php`.
|
|
- Select any available signing key.
|
|
- **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.
|
|
|
|
## Plesk configuration
|
|
|
|
1. Install the OAuth login extension:
|
|
- Log in to your Plesk installation.
|
|
- Navigate to **Extensions** in the left sidebar.
|
|
- Select **Extensions Catalog**.
|
|
- Search for "OAuth login".
|
|
- Click **Install** next to the OAuth login extension.
|
|
|
|
2. Enable and configure OAuth authentication:
|
|
- After installation, select **Extensions** > **OAuth Login** in the left sidebar.
|
|
- Enable OAuth authentication using the toggle switch in the main configuration panel.
|
|
|
|
3. In the same panel, configure these OAuth settings:
|
|
- **Client ID**: Enter the Client ID from your authentik provider
|
|
- **Client Secret**: Enter the Client Secret from your authentik provider
|
|
- **Callback Host**: Enter your Plesk FQDN (example: `https://plesk.company`)
|
|
- **Authorize URL**: `https://authentik.company/application/o/authorize/`
|
|
- **Token URL**: `https://authentik.company/application/o/token/`
|
|
- **Userinfo URL**: `https://authentik.company/application/o/userinfo/`
|
|
- **Scopes**: `openid,profile,email`
|
|
- **Login Button Text**: Set your preferred text (example: "Log in with authentik")
|
|
|
|
|
|
|
|
4. Click **Save** to apply the settings.
|
|
|
|
## Verify the configuration
|
|
|
|
To confirm that authentik is properly configured with Plesk:
|
|
|
|
1. Log out of Plesk.
|
|
2. Look for the OAuth login button on the login page.
|
|
3. Click the OAuth login button.
|
|
4. Verify that you are redirected to authentik for authentication.
|
|
5. After successful authentication, confirm that you can log in to your Plesk administrator account.
|
|
|
|
|