authelia/docs/content/integration/openid-connect/bookstack/index.md

3.3 KiB

title description summary date draft images weight toc support seo
BookStack Integrating BookStack with the Authelia OpenID Connect 1.0 Provider. 2022-06-15T17:51:47+10:00 false
620 true
level versions integration
community true true
title description canonical noindex
false

Tested Versions

{{% oidc-common %}}

Assumptions

This example makes the following assumptions:

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

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

{{< sitevar-preferences >}}

{{< callout context="caution" title="Important Note" icon="outline/alert-triangle" >}} BookStack does not properly URL encode the secret per RFC6749 Appendix B at the time this article was last modified (noted at the bottom). This means you'll either have to use only alphanumeric characters for the secret or URL encode the secret yourself. {{< /callout >}}

Configuration

Authelia

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

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: 'bookstack'
        client_name: 'BookStack'
        client_secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng'  # The digest of 'insecure_secret'.
        public: false
        authorization_policy: 'two_factor'
        redirect_uris:
          - 'https://bookstack.{{< sitevar name="domain" nojs="example.com" >}}/oidc/callback'
        scopes:
          - 'openid'
          - 'profile'
          - 'email'
        userinfo_signed_response_alg: 'none'

Application

To configure BookStack to utilize Authelia as an OpenID Connect 1.0 Provider:

  1. Edit your .env file
  2. Set the following values:
    1. AUTH_METHOD: oidc
    2. OIDC_NAME: Authelia
    3. OIDC_DISPLAY_NAME_CLAIMS: name
    4. OIDC_CLIENT_ID: bookstack
    5. OIDC_CLIENT_SECRET: insecure_secret
    6. OIDC_ISSUER: https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}
    7. OIDC_ISSUER_DISCOVER: true

See Also