website/integrations: add plesk (#13000)
* website: add plesk integration * fix: pr feedback * fix: pr feedback * fix: pr feedback
This commit is contained in:
85
website/integrations/services/plesk/index.md
Normal file
85
website/integrations/services/plesk/index.md
Normal file
@ -0,0 +1,85 @@
|
||||
---
|
||||
title: Integrate with Plesk
|
||||
sidebar_label: Plesk
|
||||
---
|
||||
|
||||
# Integrate with Plesk
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## 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
|
||||
|
||||
:::note
|
||||
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
|
||||
|
||||
1. In the Admin interface, navigate to **Applications** > **Providers** to create an OAuth2/OpenID provider with these settings:
|
||||
|
||||
- **Name**: Plesk
|
||||
- **Redirect URI**: <kbd>https://<em>plesk.company</em>/modules/oauth/public/login.php</kbd>
|
||||
- **Signing Key**: Select any available key
|
||||
|
||||
2. Create an application using the provider that you just created:
|
||||
- Navigate to **Applications** > **Applications**.
|
||||
- Create a new application and configure it to use the provider from step 1.
|
||||
- Optionally, apply access restrictions to the application.
|
||||
- Set the **Launch URL** to <kbd>https://<em>plesk.company</em></kbd>.
|
||||
|
||||
## 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: <kbd>https://<em>plesk.company</em></kbd>)
|
||||
- **Authorize URL**: <kbd>https://<em>authentik.company</em>/application/o/authorize/</kbd>
|
||||
- **Token URL**: <kbd>https://<em>authentik.company</em>/application/o/token/</kbd>
|
||||
- **Userinfo URL**: <kbd>https://<em>authentik.company</em>/application/o/userinfo/</kbd>
|
||||
- **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.
|
||||
|
||||

|
BIN
website/integrations/services/plesk/plesk-login-page.png
Normal file
BIN
website/integrations/services/plesk/plesk-login-page.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 34 KiB |
BIN
website/integrations/services/plesk/plesk-oauth-settings.png
Normal file
BIN
website/integrations/services/plesk/plesk-oauth-settings.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 133 KiB |
@ -89,6 +89,7 @@ module.exports = {
|
||||
"services/netbox/index",
|
||||
"services/pgadmin/index",
|
||||
"services/phpipam/index",
|
||||
"services/plesk/index",
|
||||
"services/powerdns-admin/index",
|
||||
"services/proftpd/index",
|
||||
"services/qnap-nas/index",
|
||||
|
Reference in New Issue
Block a user