mirror of https://github.com/authelia/authelia.git
104 lines
3.7 KiB
Markdown
104 lines
3.7 KiB
Markdown
---
|
|
title: "Outline"
|
|
description: "Integrating Outline with the Authelia OpenID Connect 1.0 Provider."
|
|
summary: ""
|
|
date: 2022-08-12T09:11:42+10:00
|
|
draft: false
|
|
images: []
|
|
weight: 620
|
|
toc: true
|
|
support:
|
|
level: community
|
|
versions: true
|
|
integration: true
|
|
seo:
|
|
title: "" # custom title (optional)
|
|
description: "" # custom description (recommended)
|
|
canonical: "" # custom canonical URL (optional)
|
|
noindex: false # false (default) or true
|
|
---
|
|
|
|
## Tested Versions
|
|
|
|
* [Authelia]
|
|
* [v4.38.0](https://github.com/authelia/authelia/releases/tag/v4.38.0)
|
|
* [Outline]
|
|
* 0.65.2
|
|
|
|
{{% oidc-common %}}
|
|
|
|
### Assumptions
|
|
|
|
This example makes the following assumptions:
|
|
|
|
* __Application Root URL:__ `https://outline.{{< sitevar name="domain" nojs="example.com" >}}/`
|
|
* __Authelia Root URL:__ `https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/`
|
|
* __Client ID:__ `outline`
|
|
* __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" >}}
|
|
At the time of this writing [Outline](https://www.getoutline.com/) requires the `offline_access` scope by default. Failure to
|
|
include this scope will result in an error as [Outline](https://www.getoutline.com/) will attempt to use a refresh token that is never issued.
|
|
{{< /callout >}}
|
|
|
|
## Configuration
|
|
|
|
### Authelia
|
|
|
|
The following YAML configuration is an example __Authelia__ [client configuration] for use with [Outline] which will
|
|
operate with the application example:
|
|
|
|
```yaml {title="configuration.yml"}
|
|
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: 'outline'
|
|
client_name: 'Outline'
|
|
client_secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'.
|
|
public: false
|
|
authorization_policy: 'two_factor'
|
|
redirect_uris:
|
|
- 'https://outline.{{< sitevar name="domain" nojs="example.com" >}}/auth/oidc.callback'
|
|
scopes:
|
|
- 'openid'
|
|
- 'offline_access'
|
|
- 'profile'
|
|
- 'email'
|
|
userinfo_signed_response_alg: 'none'
|
|
token_endpoint_auth_method: 'client_secret_post'
|
|
```
|
|
|
|
### Application
|
|
|
|
To configure [Outline] to utilize Authelia as an [OpenID Connect 1.0] Provider:
|
|
|
|
1. Configure the following environment options:
|
|
```text
|
|
URL=https://outline.{{< sitevar name="domain" nojs="example.com" >}}
|
|
FORCE_HTTPS=true
|
|
|
|
OIDC_CLIENT_ID=outline
|
|
OIDC_CLIENT_SECRET=insecure_secret
|
|
OIDC_AUTH_URI=https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/api/oidc/authorization
|
|
OIDC_TOKEN_URI=https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/api/oidc/token
|
|
OIDC_USERINFO_URI=https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/api/oidc/userinfo
|
|
OIDC_USERNAME_CLAIM=preferred_username
|
|
OIDC_DISPLAY_NAME=Authelia
|
|
OIDC_SCOPES=openid offline_access profile email
|
|
```
|
|
|
|
## 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 1.0]: ../../openid-connect/introduction.md
|
|
[client configuration]: ../../../configuration/identity-providers/openid-connect/clients.md
|