diff --git a/config.yml.sample b/config.yml.sample index e38e5383b..542c44137 100644 --- a/config.yml.sample +++ b/config.yml.sample @@ -301,6 +301,8 @@ auth: enabled: false # The url to redirect clients to. Defaults to the configured frontend url. If you're using Vikunja with the official # frontend, you don't need to change this value. + # **Note:** The redirect url must exactly match the configured redirect url with the third party provider. + # This includes all slashes at the end or protocols. redirecturl: # A list of enabled providers providers: diff --git a/docs/content/doc/setup/openid-examples.md b/docs/content/doc/setup/openid-examples.md new file mode 100644 index 000000000..23386501d --- /dev/null +++ b/docs/content/doc/setup/openid-examples.md @@ -0,0 +1,45 @@ +--- +date: "2022-08-09:00:00+02:00" +title: "OpenID example configurations" +draft: false +type: "doc" +menu: + sidebar: + parent: "setup" +--- + +# OpenID example configurations + +On this page you will find examples about how to set up Vikunja with a third-party OpenID provider. +To add another example, please [edit this document](https://kolaente.dev/vikunja/api/src/branch/main/docs/content/doc/setup/openid-examples.md) and send a PR. + +{{< table_of_contents >}} + +## Authelia + +Vikunja Config: + +```yaml +openid: + enabled: true + redirecturl: https://vikunja.mydomain.com/auth/openid/ <---- slash at the end is important + providers: + - name: Authelia + authurl: https://login.mydomain.com + clientid: + clientsecret: +``` + +Authelia config: + +```yaml +- id: +description: Vikunja +secret: +redirect_uris: + - https://vikunja.mydomain.com/auth/openid/ <----- Matching slash at the end +scopes: + - openid + - email + - profile +```