Signed-off-by: Amir Zarrinkafsh <3339418+nightah@users.noreply.github.com>
4.8 KiB
title, description, summary, date, draft, images, weight, toc, aliases, support, seo
| title | description | summary | date | draft | images | weight | toc | aliases | support | seo | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Ryot (Roll Your Own Tracker) | Integrating Ryot with the Authelia OpenID Connect 1.0 Provider. | 2025-07-26T19:41:59+10:00 | false | 620 | true |
|
|
|
Tested Versions
{{% oidc-common bugs="claims-hydration" %}}
Assumptions
This example makes the following assumptions:
- Application Root URL:
https://ryot.{{< sitevar name="domain" nojs="example.com" >}}/- This option determines the redirect URI in the format of
https://ryot.{{< sitevar name="domain" nojs="example.com" >}}/auth/oidc/callback. This means if you change this value, you need to update the redirect URI.
- This option determines the redirect URI in the format of
- Authelia Root URL:
https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/ - Client ID:
ryot - Client Secret:
insecure_secret
Some of the values presented in this guide can automatically be replaced with documentation variables.
{{< sitevar-preferences >}}
Configuration
Authelia
The following YAML configuration is an example Authelia client configuration for use with Ryot 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: 'ryot'
client_name: 'Ryot'
client_secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'.
public: false
require_pkce: false
pkce_challenge_method: ''
authorization_policy: 'two_factor'
redirect_uris:
- 'https://ryot.{{< sitevar name="domain" nojs="example.com" >}}/api/auth'
scopes:
- 'openid'
- 'email'
response_types:
- 'code'
grant_types:
- 'authorization_code'
access_token_signed_response_alg: 'none'
userinfo_signed_response_alg: 'none'
token_endpoint_auth_method: 'client_secret_basic'
Configuration Escape Hatch
{{% oidc-escape-hatch-claims-hydration client_id="ryot" claims="email" %}}
Application
To configure Ryot there are two methods, using the Configuration File or using the Environment Variables.
Configuration File
To configure Ryot to utilize Authelia as an OpenID Connect 1.0 Provider, use the following configuration:
frontend:
url: 'https://ryot.{{< sitevar name="domain" nojs="example.com" >}}'
oidc_button_label: 'Use Authelia'
server:
odic:
client_id: 'ryot'
client_secret: 'insecure_secret'
issuer_url: 'https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}'
Environment Variables
To configure Ryot to utilize Authelia as an OpenID Connect 1.0 Provider, use the following environment variables:
Standard
FRONTEND_URL=https://ryot.{{< sitevar name="domain" nojs="example.com" >}}
SERVER_OIDC_CLIENT_ID=ryot
SERVER_OIDC_CLIENT_SECRET=insecure_secret
SERVER_OIDC_ISSUER_URL=https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}
FRONTEND_OIDC_BUTTON_LABEL=Use Authelia
Docker Compose
services:
ryot:
environment:
FRONTEND_URL: 'https://ryot.{{< sitevar name="domain" nojs="example.com" >}}'
SERVER_OIDC_CLIENT_ID: 'ryot'
SERVER_OIDC_CLIENT_SECRET: 'insecure_secret'
SERVER_OIDC_ISSUER_URL: 'https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}'
FRONTEND_OIDC_BUTTON_LABEL: 'Use Authelia'