2022-08-11 23:11:42 +00:00
|
|
|
---
|
|
|
|
|
title: "Outline"
|
|
|
|
|
description: "Integrating Outline with the Authelia OpenID Connect Provider."
|
|
|
|
|
lead: ""
|
2022-09-01 02:24:47 +00:00
|
|
|
date: 2022-08-12T09:11:42+10:00
|
2022-08-11 23:11:42 +00:00
|
|
|
draft: false
|
|
|
|
|
images: []
|
|
|
|
|
menu:
|
|
|
|
|
integration:
|
|
|
|
|
parent: "openid-connect"
|
|
|
|
|
weight: 620
|
|
|
|
|
toc: true
|
|
|
|
|
community: true
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Tested Versions
|
|
|
|
|
|
|
|
|
|
* [Authelia]
|
|
|
|
|
* [v4.36.4](https://github.com/authelia/authelia/releases/tag/v4.36.4)
|
|
|
|
|
* [Outline]
|
|
|
|
|
* 0.65.2
|
|
|
|
|
|
|
|
|
|
## Before You Begin
|
|
|
|
|
|
2022-10-20 04:27:09 +00:00
|
|
|
### 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.
|
|
|
|
|
|
2022-10-20 04:42:22 +00:00
|
|
|
[Generating Client Secrets]: ../specific-information.md#generating-client-secrets
|
|
|
|
|
|
2022-10-20 04:27:09 +00:00
|
|
|
### Assumptions
|
2022-08-11 23:11:42 +00:00
|
|
|
|
|
|
|
|
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`
|
|
|
|
|
|
2022-08-26 22:43:55 +00:00
|
|
|
*__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.*
|
|
|
|
|
|
2022-08-11 23:11:42 +00:00
|
|
|
## Configuration
|
|
|
|
|
|
|
|
|
|
### Application
|
|
|
|
|
|
|
|
|
|
To configure [Outline] to utilize Authelia as an [OpenID Connect] Provider:
|
|
|
|
|
|
|
|
|
|
1. Configure the following environment options:
|
|
|
|
|
```text
|
|
|
|
|
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
|
2022-08-26 22:43:55 +00:00
|
|
|
OIDC_SCOPES="openid offline_access profile email"
|
2022-08-11 23:11:42 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Authelia
|
|
|
|
|
|
|
|
|
|
The following YAML configuration is an example __Authelia__
|
|
|
|
|
[client configuration](../../../configuration/identity-providers/open-id-connect.md#clients) for use with [Outline]
|
|
|
|
|
which will operate with the above example:
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
- id: outline
|
2022-08-26 03:26:58 +00:00
|
|
|
description: Outline
|
2022-10-20 03:21:45 +00:00
|
|
|
secret: '$plaintext$outline_client_secret'
|
2022-08-11 23:11:42 +00:00
|
|
|
public: false
|
|
|
|
|
authorization_policy: two_factor
|
2022-08-26 03:26:58 +00:00
|
|
|
redirect_uris:
|
|
|
|
|
- https://outline.example.com/auth/oidc.callback
|
2022-08-11 23:11:42 +00:00
|
|
|
scopes:
|
|
|
|
|
- openid
|
2022-08-26 22:43:55 +00:00
|
|
|
- offline_access
|
2022-08-11 23:11:42 +00:00
|
|
|
- profile
|
|
|
|
|
- email
|
|
|
|
|
userinfo_signing_algorithm: none
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## See Also
|
|
|
|
|
|
|
|
|
|
* [Outline OpenID Connect Documentation](https://app.getoutline.com/share/770a97da-13e5-401e-9f8a-37949c19f97e/doc/oidc-8CPBm6uC0I)
|
|
|
|
|
|
|
|
|
|
[Authelia]: https://www.authelia.com
|
|
|
|
|
[Outline]: https://www.getoutline.com/
|
|
|
|
|
[OpenID Connect]: ../../openid-connect/introduction.md
|
