Outline
This documentation is maintained by the community, it is not guaranteed to be complete or up-to-date.
We always recommend users read the third-party documentation as part of the integration process to ensure the configuration matches their needs and as such we always link the documentation if available.
If you find an error in this documentation please either start a Discussion, make a Pull Request, or contact us on a Chat Room.
Tested Versions
Before You Begin
Common Notes
- You are required to utilize a unique client id for every client.
- The client id on this page is merely an example and you can theoretically use any alphanumeric string.
- 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://outline.example.com
- Authelia Root URL:
https://auth.example.com
- Client ID:
outline
- Client Secret:
outline_client_secret
Important Note: At the time of this writing Outline requires the offline_access
scope by default. Failure to include this scope will result
in an error as Outline will attempt to use a refresh token that is never issued.
Configuration
Application
To configure Outline to utilize Authelia as an OpenID Connect 1.0 Provider:
- Configure the following environment options:
URL=https://outline.example.com
FORCE_HTTPS=true
OIDC_CLIENT_ID=outline
OIDC_CLIENT_SECRET=outline_client_secret
OIDC_AUTH_URI=https://auth.example.com/api/oidc/authorization
OIDC_TOKEN_URI=https://auth.example.com/api/oidc/token
OIDC_USERINFO_URI=https://auth.example.com/api/oidc/userinfo
OIDC_USERNAME_CLAIM=preferred_username
OIDC_DISPLAY_NAME=Authelia
OIDC_SCOPES="openid offline_access profile email"
Authelia
The following YAML configuration is an example Authelia client configuration for use with Outline which will operate with the above example:
- id: outline
description: Outline
secret: '$plaintext$outline_client_secret'
public: false
authorization_policy: two_factor
redirect_uris:
- https://outline.example.com/auth/oidc.callback
scopes:
- openid
- offline_access
- profile
- email
userinfo_signing_algorithm: none