RPJosh
/
authelia
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
authelia/docs/community/oidc-integrations.md

52 lines
9.3 KiB
Markdown
Raw Normal View History

docs: update and enhance oidc documentation (#2142) Update and adjust OIDC documentation. This also adds information for users about RP's that have been tested. Co-authored-by: Georg Lauterbach <44545919+aendeavor@users.noreply.github.com> Co-authored-by: Clément Michaud <clement.michaud34@gmail.com> Co-authored-by: Amir Zarrinkafsh <nightah@me.com> Co-authored-by: James Elliott <james-d-elliott@users.noreply.github.com>
2021-07-14 01:36:07 +00:00
---
layout: default
title: Community-Tested OIDC Integrations
parent: Community
docs: added example configs for oidc for specific services (portainer, proxmox) (#2831) Co-authored-by: Clément Michaud <clement.michaud34@gmail.com>
2022-02-07 23:05:10 +00:00
nav_order: 5
has_children: true
has_toc: false
docs: update and enhance oidc documentation (#2142) Update and adjust OIDC documentation. This also adds information for users about RP's that have been tested. Co-authored-by: Georg Lauterbach <44545919+aendeavor@users.noreply.github.com> Co-authored-by: Clément Michaud <clement.michaud34@gmail.com> Co-authored-by: Amir Zarrinkafsh <nightah@me.com> Co-authored-by: James Elliott <james-d-elliott@users.noreply.github.com>
2021-07-14 01:36:07 +00:00
---
docs: add gitea redirect_uri with notes to community docs (#2275) * docs: add gitea redirect_uri with notes to community docs * docs: remove unnecessary dash from Gitea notes Co-authored-by: Amir Zarrinkafsh <nightah@me.com>
2021-08-10 10:48:31 +00:00
# OIDC Integrations
docs: update and enhance oidc documentation (#2142) Update and adjust OIDC documentation. This also adds information for users about RP's that have been tested. Co-authored-by: Georg Lauterbach <44545919+aendeavor@users.noreply.github.com> Co-authored-by: Clément Michaud <clement.michaud34@gmail.com> Co-authored-by: Amir Zarrinkafsh <nightah@me.com> Co-authored-by: James Elliott <james-d-elliott@users.noreply.github.com>
2021-07-14 01:36:07 +00:00
**Note** This is community-based content for which the core-maintainers cannot guarantee correctness. The parameters may change over time. If a parameter does not work as documented, please submit a PR to update the list.
## Currently Tested Applications
fix(handlers): include preferred_username claim in meta (#2829) This includes the preferred_username claim in the meta. Also uses the consts for all the applicable claims and scopes.
2022-02-09 22:55:28 +00:00
| Application | Minimal Version | Notes |
|:----------------:|:------------------------------:|:-----------------------------------------------------------------------------------------------------------:|
| Bookstack | `21.10` | |
docs(oidc): seafile integration example (#3131) - Adds description and callback URL for the Seafile file server. - Orders the entries in the two OIDC integration tables by name.
2022-04-07 21:11:43 +00:00
| Gitea | `1.14.6` | |
| GitLab | `13.0.0` | |
| Grafana | `8.0.5` | |
| Harbor | `1.10` | It works on >v2.1 also, but not sure if there is OIDC support on v2.0 |
| Hashicorp Vault | `1.8.1` | |
docs: add oidc details for miniflux app (#3096) Co-authored-by: James Elliott <james-d-elliott@users.noreply.github.com>
2022-04-02 06:28:48 +00:00
| Miniflux | `2.0.21` | |
docs(oidc): seafile integration example (#3131) - Adds description and callback URL for the Seafile file server. - Orders the entries in the two OIDC integration tables by name.
2022-04-07 21:11:43 +00:00
| MinIO | `RELEASE.2021-11-09T03-21-45Z` | must set `MINIO_IDENTITY_OPENID_CLAIM_NAME: groups` in MinIO and set [MinIO policies](https://docs.min.io/minio/baremetal/security/minio-identity-management/policy-based-access-control.html#minio-policy) as groups in Authelia |
| Nextcloud | `22.1.0` | Tested using the `nextcloud-oidc-login` app - [Link](https://github.com/pulsejet/nextcloud-oidc-login) |
| Portainer CE | `2.6.1` | Settings to use username as ID: set `Scopes` to `openid` and `User Identifier` to `preferred_username` |
| Seafile | `9.0.4` | Requires `OAUTH_ATTRIBUTE_MAP` to contain the mapping of the `id` field even if not present in Authelia, e.g. `'id': (False, "unused") (see [seahub#5162](https://github.com/haiwen/seahub/issues/5162)) |
| Verdaccio | `5` | Depends on this fork of verdaccio-github-oauth-ui: [Link](https://github.com/OnekO/verdaccio-github-oauth-ui) |
| Wekan | `5.41` | |
docs: update and enhance oidc documentation (#2142) Update and adjust OIDC documentation. This also adds information for users about RP's that have been tested. Co-authored-by: Georg Lauterbach <44545919+aendeavor@users.noreply.github.com> Co-authored-by: Clément Michaud <clement.michaud34@gmail.com> Co-authored-by: Amir Zarrinkafsh <nightah@me.com> Co-authored-by: James Elliott <james-d-elliott@users.noreply.github.com>
2021-07-14 01:36:07 +00:00
## Known Callback URLs
If you do not find the application in the list below, you will need to search for yourself - and maybe come back to open a PR to add your application to this list so others won't have to search for them.
`<DOMAIN>` needs to be substituted with the full URL on which the application runs on. If GitLab, as an example, was reachable under `https://gitlab.example.com`, `<DOMAIN>` would be exactly the same.
fix(handlers): include preferred_username claim in meta (#2829) This includes the preferred_username claim in the meta. Also uses the consts for all the applicable claims and scopes.
2022-02-09 22:55:28 +00:00
| Application | Version | Callback URL | Notes |
|:---------------:|:-------------------------------------:|:------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
docs(oidc): seafile integration example (#3131) - Adds description and callback URL for the Seafile file server. - Orders the entries in the two OIDC integration tables by name.
2022-04-07 21:11:43 +00:00
| Bookstack | `21.10` | `<DOMAIN>/oidc/callback` | |
| Gitea | `1.14.6` | `<DOMAIN>/user/oauth2/authelia/callback` | `ROOT_URL` in `[server]` section of `app.ini` must be configured correctly. Typically it is `<DOMAIN>/`. The string `authelia` in the callback url is the `Authentication Name` of the configured Authentication Source in Gitea (Authentication Type: OAuth2, OAuth2 Provider: OpenID Connect). |
| GitLab | `14.0.1` | `<DOMAIN>/users/auth/openid_connect/callback` | |
| Harbor | `1.10` | `<DOMAIN>/-/oauth/callback` | |
| Hasicorp Vault | `14.0.1` | `<DOMAIN>/oidc/callback` and `<DOMAIN>/ui/vault/auth/oidc/oidc/callback` | |
docs: add oidc details for miniflux app (#3096) Co-authored-by: James Elliott <james-d-elliott@users.noreply.github.com>
2022-04-02 06:28:48 +00:00
| Miniflux | `2.0.21` | `<DOMAIN>/oauth2/oidc/callback` | Set via Miniflux `OAUTH2_REDIRECT_URL` [configuration parameter](https://miniflux.app/docs/configuration.html#oauth2-redirect-url). Example value follows this format |
docs(oidc): seafile integration example (#3131) - Adds description and callback URL for the Seafile file server. - Orders the entries in the two OIDC integration tables by name.
2022-04-07 21:11:43 +00:00
| MinIO | `RELEASE.2021-07-12T02-44-53Z` | `<DOMAIN>/oauth_callback` | |
| Nextcloud | `22.1.0` + `nextcloud-oidc-login` app | `<DOMAIN>/apps/oidc_login/oidc` | |
| Portainer CE | `2.6.1` | `<DOMAIN>` | |
| Seafile | `9.0.4` | `<DOMAIN>/oauth/callback/` | Must exactly match `OAUTH_REDIRECT_URL` value as set in `seahub_settings.py` |
| Verdaccio | `5` | `<DOMAIN>/oidc/callback` | |
| Wekan | `5.41` | `<DOMAIN>/_oauth_oidc` | |