Back to Authelia

Plesk

docs/content/integration/openid-connect/clients/plesk/index.md

4.39.193.7 KB
Original Source

Tested Versions

{{% oidc-common %}}

Assumptions

This example makes the following assumptions:

  • Application Root URL: https://plesk.{{< sitevar name="domain" nojs="example.com" >}}/
  • Authelia Root URL: https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/
  • Client ID: plesk
  • Client Secret: insecure_secret

Some of the values presented in this guide can automatically be replaced with documentation variables.

{{< sitevar-preferences >}}

Configuration

The following example uses the OAuth login Extension which is assumed to be installed when following this section of the guide.

To install the OAuth login Extension for Plesk via the Web GUI:

  1. Login to Plesk.
  2. Navigate to Extensions.
  3. Navigate to Extensions Catalog.
  4. Search for OAuth login.
  5. Click Install.

Authelia

The following YAML configuration is an example Authelia client configuration for use with Plesk which will operate with the application example:

yaml
identity_providers:
  oidc:
    ## The other portions of the mandatory OpenID Connect 1.0 configuration go here.
    ## See: https://www.authelia.com/c/oidc
    clients:
      - client_id: 'plesk'
        client_name: 'Plesk'
        client_secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng'  # The digest of 'insecure_secret'.
        public: false
        authorization_policy: 'two_factor'
        require_pkce: false
        pkce_challenge_method: ''
        redirect_uris:
          - 'https://plesk.{{< sitevar name="domain" nojs="example.com" >}}/modules/oauth/public/login.php'
        scopes:
          - 'openid'
          - 'email'
          - 'profile'
        response_types:
          - 'code'
        grant_types:
          - 'authorization_code'
        access_token_signed_response_alg: 'none'
        userinfo_signed_response_alg: 'none'
        token_endpoint_auth_method: 'client_secret_basic'

Application

To configure Plesk there is one method, using the Web GUI.

Web GUI

To configure Plesk to utilize Authelia as an OpenID Connect 1.0 Provider, use the following instructions:

  1. Login to Plesk.
  2. Navigate to Extensions.
  3. Navigate to OAuth login.
  4. Toggle the switch into the on position.
  5. Configure the following options:
    • Type: OpenID Connect
    • Client ID: plesk
    • Client Secret: insecure_secret
    • Callback Host: https://plesk.{{< sitevar name="domain" nojs="example.com" >}}
    • Authorize URL: https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/api/oidc/authorization
    • Token URL: https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/api/oidc/token
    • Userinfo URL: https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/api/oidc/userinfo
    • Scopes: openid,email,profile
    • Login Button Text: Login with Authelia
  6. Press Save at the bottom.

See Also