Add a guide on configuring OIDC #1921
No reviewers
Labels
No labels
Abandoned
Blocked
Bug
Changelog
Added
Changelog
Missing
Changelog
None
Cherry-picking
Database
Dependencies
Dependencies/Renovate
Difficulty
Easy
Difficulty
Hard
Difficulty
Medium
Documentation
Enhancement
Good first issue
Help wanted
Inherited
Matrix/Administration
Matrix/Appservices
Matrix/Auth
Matrix/Client
Matrix/Core
Matrix/E2EE
Matrix/Federation
Matrix/Hydra
Matrix/MSC
Matrix/Media
Matrix/T&S
Merge
Merge/Manual
Merge/Squash
Meta
Meta/CI
Meta/Packaging
Priority
Blocking
Priority
High
Priority
Low
Security
Status
Confirmed
Status
Duplicate
Status
Invalid
Status
Needs Investigation
Support
bob the builder
No milestone
No project
No assignees
5 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
continuwuation/continuwuity!1921
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "ginger/oidc-docs"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
This pull request does what it says on the tin. I also renamed the "Advanced" section to "Guides" to better convey its purpose.
Pull request checklist:
mainbranch, and the branch is named something other thanmain.myself, if applicable. This includes ensuring code compiles.
6e516b6997e3cf7debae@ -0,0 +3,4 @@Continuwuity supports delegating user authentication to an external identity provider that implements the OpenID Connect specification, such as Authentik, kanidm, or Keycloak.:::warning{title="OIDC versus OAuth, and supported clients"}**OIDC** is not to be confused with **OAuth**. In the context of Matrix, OAuth is the protocol that Matrix clients use to authenticate with the _homeserver_. OIDC is the protocol that the _homeserver_ uses to communicate with the _identity provider_. Continuwuity supports OAuth by default, alongside the legacy **UIAA** authentication framework.nit:
@ -0,0 +5,4 @@:::warning{title="OIDC versus OAuth, and supported clients"}**OIDC** is not to be confused with **OAuth**. In the context of Matrix, OAuth is the protocol that Matrix clients use to authenticate with the _homeserver_. OIDC is the protocol that the _homeserver_ uses to communicate with the _identity provider_. Continuwuity supports OAuth by default, alongside the legacy **UIAA** authentication framework.When OIDC is configured, Continuwuity will disable its support for UIAA. **Only clients that support OAuth**, such asnit:
@ -0,0 +17,4 @@```sh# Here, `c10y` is the client ID that kanidm will use, and `Continuwuity` is the display name.# Other identity providers may generate a client ID for you.# Use the domain that Continuwuity is actually running on, even if you've configured delegation.It would be nice to link to the delegation page.
Some people (me) serve well-known files without configuring
[matrix.well_known], and this breaks OAuth/account management. I'll reword that page's section to state[matrix.well_known]should be declared no matter whatI've added a note to the delegation page. I can't link to it directly because this text is inside a codeblock.
@ -0,0 +10,4 @@when you try to log in after configuring OIDC, it likely does not support OAuth. This is an issue with your client, notContinuwuity, and should be reported to your client's developers.:::Please add a note that the URL in
[matrix.well_known] > clientwill be used as the account mgmt page for delegated servers.Perhaps, also add note that the
/_continuwuity*endpoints will be needed.both of those are done later on in the doc
@ -0,0 +53,4 @@client_secret = "d1qgx352kkuvs1j70b6w293d65x68jve1f7b27fyk90gjhpr"```Finally, restart Continuwuity, and log out and back in again. Your client should prompt you to continue in your web browser and open a webpage with the Continuwuity logo that allows you to continue in your identity provider. Once you log in successfully, you will be prompted to choose a user ID -- to link your existing account, enter its user ID, and then your old password when prompted.Maybe mention this is only relevant when
prompt_for_localpart = true?prompt_for_localpartistrueby default, and the guide doesn't include it in the provided example configuration.@ -0,0 +58,4 @@To enable full discovery, you will need to reverse proxy these paths from the base domain back to Continuwuity.:::warningPlease move this warning to the "Serving well-known files manually" section e.g. in L163. Please also change the following in L134
LGTM :3