ContextQMD
Back to Authelia

HedgeDoc

docs/content/integration/openid-connect/clients/hedge-doc/index.md

4.39.195.0 KB
Original Source

Tested Versions

{{% oidc-common %}}

Assumptions

This example makes the following assumptions:

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

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

{{< sitevar-preferences >}}

Configuration

Authelia

The following YAML configuration is an example Authelia client configuration for use with HedgeDoc 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: 'hedgedoc'
        client_name: 'HedgeDoc'
        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://hedgedoc.{{< sitevar name="domain" nojs="example.com" >}}/auth/oauth2/callback'
        scopes:
          - 'openid'
          - 'profile'
          - 'email'
          - 'groups'
        response_types:
          - 'code'
        grant_types:
          - 'authorization_code'
        access_token_signed_response_alg: 'none'
        userinfo_signed_response_alg: 'none'
        token_endpoint_auth_method: 'client_secret_post'

Application

{{< callout context="caution" title="Important Note" icon="outline/alert-triangle" >}} This configuration assumes HedgeDoc users are part of the hedgedoc-users group. Depending on your specific group configuration, you will have to adapt the CMD_OAUTH2_ACCESS_ROLE variable. Alternatively you may elect to create a new authorization policy in provider authorization policies then utilize that policy as the client authorization policy. {{< /callout >}}

To configure HedgeDoc there is one method, using the Environment Variables.

Environment Variables

To configure HedgeDoc to utilize Authelia as an OpenID Connect 1.0 Provider, use the following environment variables:

Standard
shell
CMD_OAUTH2_PROVIDERNAME=Authelia
CMD_OAUTH2_AUTHORIZATION_URL=https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/api/oidc/authorization
CMD_OAUTH2_TOKEN_URL=https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/api/oidc/token
CMD_OAUTH2_USER_PROFILE_URL=https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/api/oidc/userinfo
CMD_OAUTH2_CLIENT_ID=hedgedoc
CMD_OAUTH2_CLIENT_SECRET=insecure_secret
CMD_OAUTH2_SCOPE=openid email profile groups
CMD_OAUTH2_USER_PROFILE_USERNAME_ATTR=preferred_username
CMD_OAUTH2_USER_PROFILE_DISPLAY_NAME_ATTR=name
CMD_OAUTH2_USER_PROFILE_EMAIL_ATTR=email
CMD_OAUTH2_ROLES_CLAIM=groups
CMD_OAUTH2_ACCESS_ROLE=hedgedoc-users
Docker Compose
yaml
services:
  hedgedoc:
    environment:
      CMD_OAUTH2_PROVIDERNAME: 'Authelia'
      CMD_OAUTH2_AUTHORIZATION_URL: 'https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/api/oidc/authorization'
      CMD_OAUTH2_TOKEN_URL: 'https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/api/oidc/token'
      CMD_OAUTH2_USER_PROFILE_URL: 'https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/api/oidc/userinfo'
      CMD_OAUTH2_CLIENT_ID: 'hedgedoc'
      CMD_OAUTH2_CLIENT_SECRET: 'insecure_secret'
      CMD_OAUTH2_SCOPE: 'openid email profile groups'
      CMD_OAUTH2_USER_PROFILE_USERNAME_ATTR: 'preferred_username'
      CMD_OAUTH2_USER_PROFILE_DISPLAY_NAME_ATTR: 'name'
      CMD_OAUTH2_USER_PROFILE_EMAIL_ATTR: 'email'
      CMD_OAUTH2_ROLES_CLAIM: 'groups'
      CMD_OAUTH2_ACCESS_ROLE: 'hedgedoc-users'

See Also