BookStack

Tested Versions

Before You Begin

Common Notes

  1. You are required to utilize a unique client id for every client.
  2. The client id on this page is merely an example and you can theoretically use any alphanumeric string.
  3. You should not use the client secret in this example, We strongly recommend reading the Generating Client Secrets guide instead.

Assumptions

This example makes the following assumptions:

  • Application Root URL: https://bookstack.example.com
  • Authelia Root URL: https://auth.example.com
  • Client ID: bookstack
  • Client Secret: bookstack_client_secret

Important Note: 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.

Configuration

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: bookstack_client_secret
    6. OIDC_ISSUER: https://auth.example.com
    7. OIDC_ISSUER_DISCOVER: true

Authelia

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

- id: bookstack
  description: BookStack
  secret: '$plaintext$bookstack_client_secret'
  public: false
  authorization_policy: two_factor
  redirect_uris:
    - https://bookstack.example.com/oidc/callback
  scopes:
    - openid
    - profile
    - email
  userinfo_signing_algorithm: none

See Also