Add a guide on configuring OIDC #1921

Merged
ginger merged 6 commits from ginger/oidc-docs into main 2026-07-09 18:20:38 +00:00
Owner

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:

  • This pull request targets the main branch, and the branch is named something other than
    main.
  • I have written an appropriate pull request title and my description is clear.
  • I understand I am responsible for the contents of this pull request.
  • I have followed the contributing guidelines:
<!-- In order to help reviewers know what your pull request does at a glance, you should ensure that 1. Your PR title is a short, single sentence describing what you changed 2. You have described in more detail what you have changed, why you have changed it, what the intended effect is, and why you think this will be beneficial to the project. If you have made any potentially strange/questionable design choices, but didn't feel they'd benefit from code comments, please don't mention them here - after opening your pull request, go to "files changed", and click on the "+" symbol in the line number gutter, and attach comments to the lines that you think would benefit from some clarification. --> This pull request does what it says on the tin. I also renamed the "Advanced" section to "Guides" to better convey its purpose. <!-- Example: This pull request allows us to warp through time and space ten times faster than before by double-inverting the warp drive with hyperheated jump fluid, both making the drive faster and more efficient. This resolves the common issue where we have to wait more than 10 milliseconds to engage, use, and disengage the warp drive when travelling between galaxies. --> <!-- Closes: #... --> <!-- Fixes: #... --> <!-- Uncomment the above line(s) if your pull request fixes an issue or closes another pull request by superseding it. Replace `#...` with the issue/pr number, such as `#123`. --> **Pull request checklist:** <!-- You need to complete these before your PR can be considered. If you aren't sure about some, feel free to ask for clarification in #dev:continuwuity.org. --> - [x] This pull request targets the `main` branch, and the branch is named something other than `main`. - [x] I have written an appropriate pull request title and my description is clear. - [x] I understand I am responsible for the contents of this pull request. - I have followed the [contributing guidelines][c1]: - [x] My contribution follows the [code style][c2], if applicable. - [x] I ran [pre-commit checks][c1pc] before opening/drafting this pull request. - [x] I have [tested my contribution][c1t] (or proof-read it for documentation-only changes) myself, if applicable. This includes ensuring code compiles. - [x] My commit messages follow the [commit message format][c1cm] and are descriptive. <!-- Notes on these requirements: - While not required, we encourage you to sign your commits with GPG or SSH to attest the authenticity of your changes. - While we allow LLM-assisted contributions, we do not appreciate contributions that are low quality, which is typical of machine-generated contributions that have not had a lot of love and care from a human. Please do not open a PR if all you have done is asked ChatGPT to tidy up the codebase with a +-100,000 diff. - In the case of code style violations, reviewers may leave review comments/change requests indicating what the ideal change would look like. For example, a reviewer may suggest you lower a log level, or use `match` instead of `if/else` etc. - In the case of code style violations, pre-commit check failures, minor things like typos/spelling errors, and in some cases commit format violations, reviewers may modify your branch directly, typically by making changes and adding a commit. Particularly in the latter case, a reviewer may rebase your commits to squash "spammy" ones (like "fix", "fix", "actually fix"), and reword commit messages that don't satisfy the format. - Pull requests MUST pass the `Checks` CI workflows to be capable of being merged. This can only be bypassed in exceptional circumstances. If your CI flakes, let us know in matrix:r/dev:continuwuity.org. - Pull requests have to be based on the latest `main` commit before being merged. If the main branch changes while you're making your changes, you should make sure you rebase on main before opening a PR. Your branch will be rebased on main before it is merged if it has fallen behind. - We typically only do fast-forward merges, so your entire commit log will be included. Once in main, it's difficult to get out cleanly, so put on your best dress, smile for the cameras! --> [c1]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md [c2]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/docs/development/code_style.mdx [c1pc]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#pre-commit-checks [c1t]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#running-tests-locally [c1cm]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#commit-messages
ginger force-pushed ginger/oidc-docs from 6e516b6997
Some checks failed
Auto Labeler / Apply labels based on changed files (pull_request_target) Successful in 2s
Checks / Prek / Check changed files (pull_request) Successful in 7s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 51s
Documentation / Build and Deploy Documentation (pull_request) Failing after 57s
to e3cf7debae
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 51s
Documentation / Build and Deploy Documentation (pull_request) Failing after 57s
2026-07-07 14:17:49 +00:00
Compare
nex requested review from nex 2026-07-07 14:23:25 +00:00
nex requested changes 2026-07-07 14:25:36 +00:00
Dismissed
@ -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.
Owner

nit:

- alongside the legacy **UIAA** authentication framework.
+ alongside the legacy authentication method, *user-interactive authentication* (UIAA).
nit: ```diff - alongside the legacy **UIAA** authentication framework. + alongside the legacy authentication method, *user-interactive authentication* (UIAA). ```
ginger marked this conversation as resolved
@ -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 as
Owner

nit:

- Continuwuity will disable its support for UIAA
+ Continuwuity will disable its support for legacy authentication, only allowing logging in with OAuth
nit: ```diff - Continuwuity will disable its support for UIAA + Continuwuity will disable its support for legacy authentication, only allowing logging in with OAuth ```
ginger marked this conversation as resolved
@ -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.
Owner
- # Use the domain that Continuwuity is actually running on, even if you've configured delegation.
+ # Use the domain that clients can reach Continuwuity at, which may not be the same as your server name if you have configured well-known delegation.
```diff - # Use the domain that Continuwuity is actually running on, even if you've configured delegation. + # Use the domain that clients can reach Continuwuity at, which may not be the same as your server name if you have configured well-known delegation. ```
Contributor

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 what

It would be nice to link to the [delegation page](https://continuwuity.org/advanced/delegation). Some people (me) [serve well-known files](https://continuwuity.org/advanced/delegation#serving-well-known-files-manually) 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 what
Author
Owner

I've added a note to the delegation page. I can't link to it directly because this text is inside a codeblock.

I've added a note to the delegation page. I can't link to it directly because this text is inside a codeblock.
nex marked this conversation as resolved
fix: Fix dead links
All checks were successful
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 5s
Checks / Prek / Check changed files (pull_request) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Documentation / Build and Deploy Documentation (pull_request) Successful in 1m23s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m24s
2f2287d5ee
@ -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, not
Continuwuity, and should be reported to your client's developers.
:::
Contributor

Please add a note that the URL in [matrix.well_known] > client will be used as the account mgmt page for delegated servers.

Perhaps, also add note that the /_continuwuity* endpoints will be needed.

Please add a note that the URL in `[matrix.well_known] > client` will be used as the account mgmt page for delegated servers. Perhaps, also add note that the `/_continuwuity*` endpoints will be needed.
Owner

both of those are done later on in the doc

both of those are done later on in the doc
ginger marked this conversation as resolved
@ -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.
Contributor

you will be prompted to choose a user ID

Maybe mention this is only relevant when prompt_for_localpart = true?

> you will be prompted to choose a user ID Maybe mention this is only relevant when `prompt_for_localpart = true`?
Author
Owner

prompt_for_localpart is true by default, and the guide doesn't include it in the provided example configuration.

`prompt_for_localpart` is `true` by default, and the guide doesn't include it in the provided example configuration.
ginger marked this conversation as resolved
docs: Fix nitpicks
All checks were successful
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Check changed files (pull_request) Successful in 11s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Documentation / Build and Deploy Documentation (pull_request) Successful in 59s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m23s
6ca6e51a65
@ -0,0 +58,4 @@
To enable full discovery, you will need to reverse proxy these paths from the base domain back to Continuwuity.
:::warning
Contributor

Please move this warning to the "Serving well-known files manually" section e.g. in L163. Please also change the following in L134

- Instead of configuring `[global.well_known]` options and reverse proxying well-known URIs,
+ Instead of reverse proxying well-known URIs,
Please move this warning to the "Serving well-known files manually" section e.g. in [L163](https://forgejo.ellis.link/continuwuation/continuwuity/src/commit/6ca6e51a65c74756f1683d6944a9dcd8298e8356/docs/guides/delegation.mdx#L163). Please also change the following in [L134](https://forgejo.ellis.link/continuwuation/continuwuity/src/commit/6ca6e51a65c74756f1683d6944a9dcd8298e8356/docs/guides/delegation.mdx#L134) ```diff - Instead of configuring `[global.well_known]` options and reverse proxying well-known URIs, + Instead of reverse proxying well-known URIs, ```
ginger marked this conversation as resolved
fix: Move manual delegation warning
Some checks failed
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Checks / Prek / Check changed files (pull_request) Has been cancelled
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
Checks / Changelog / Check changelog is added (pull_request_target) Has been cancelled
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
5aaa0d7dd0
Henry-Hiles left a comment

LGTM :3

LGTM :3
nex approved these changes 2026-07-09 18:19:25 +00:00
ginger merged commit 2a342bcbc9 into main 2026-07-09 18:20:38 +00:00
ginger deleted branch ginger/oidc-docs 2026-07-09 18:20:38 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
5 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
continuwuation/continuwuity!1921
No description provided.