docs(oidc): Add Authelia to OIDC instructions #2341

Open
fhoekstra wants to merge 8 commits from fhoekstra/continuwuity:add-authelia-to-oidc-docs into main
First-time contributor

This pull request adds instructions for setting up Continuwuity OIDC with a second identity provider, Authelia. It will help people who are using Authelia as their identity provider to configure Continuwuity with OIDC, and perhaps more broadly help with other providers as well, as Authelia does some things differently: it makes it obvious what is commonn to all OIDC providers and what is implementation-specific.

Some things I am not certain about and would appreciate feedback on:

  • having the required commands to generate client id and secret inline in our docs, as now, or just linking to Authelia docs
  • how to deal with the different discovery_url structure in the Configuring Continuwuity section, depending on the ID provider used

Thanks for reviewing my PR!

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 adds instructions for setting up Continuwuity OIDC with a second identity provider, Authelia. It will help people who are using Authelia as their identity provider to configure Continuwuity with OIDC, and perhaps more broadly help with other providers as well, as Authelia does some things differently: it makes it obvious what is commonn to all OIDC providers and what is implementation-specific. Some things I am not certain about and would appreciate feedback on: - having the required commands to generate client id and secret inline in our docs, as now, or just linking to Authelia docs - how to deal with the different discovery_url structure in the `Configuring Continuwuity` section, depending on the ID provider used Thanks for reviewing my PR! <!-- 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]: - [ ] My contribution follows the [code style][c2], if applicable. - [ ] 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
docs(oidc): Add Authelia to OIDC instructions
All checks were successful
Auto Labeler / Apply labels based on changed files (pull_request_target) Successful in 3s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 6s
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
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 1m46s
7c1afb91e0
fhoekstra force-pushed add-authelia-to-oidc-docs from 7c1afb91e0
All checks were successful
Auto Labeler / Apply labels based on changed files (pull_request_target) Successful in 3s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 6s
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
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 1m46s
to 28b93d015d
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 6s
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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
2026-10-10 17:49:41 +00:00
Compare
docs(oidc): Simplify, deduplicate and improve consistency
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 6s
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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
b201694fe9
fhoekstra force-pushed add-authelia-to-oidc-docs from b201694fe9
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 6s
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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
to c4b97121a4
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 6s
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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
2026-10-10 19:11:23 +00:00
Compare
docs(oidc): Styling and QoL fixes
All checks were successful
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
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 20m51s
281d72a316
Author
First-time contributor

Thanks for your tips in Matrix @stratself ! I am quite happy with like how this looks now. Let me know how I can improve it further!

Thanks for your tips in Matrix @stratself ! I am quite happy with like how this looks now. Let me know how I can improve it further!
stratself requested changes 2026-10-12 10:51:03 +00:00
Dismissed
stratself left a comment

Thanks for the PR. Some changes to address. Please include a changelog.d/ entry once we're all done

Thanks for the PR. Some changes to address. Please include a `changelog.d/` entry once we're all done
@ -14,15 +16,20 @@ A simple OIDC configuration is as easy as creating a new OIDC application in you
### Configuring the OIDC provider
Member

Since we're going to write guides for multiple providers, standardise the domains to use and put them in the ## Instructions beginning section. This is also the place where you write about the [global.well_known] client requirement

Since we're going to write guides for multiple providers, standardise the domains to use and put them in the _## Instructions_ beginning section. This is also the place where you write about the `[global.well_known] client` requirement
Author
First-time contributor

Done in 8f4d4a73df

Done in 8f4d4a73dfea2d2229e3585bfe98cee9181f5f0e
Member

Thanks, next time you can click the Resolve conversation button yourself

Thanks, next time you can click the Resolve conversation button yourself
stratself marked this conversation as resolved
@ -47,0 +56,4 @@
</Tab>
<Tab label="Authelia">
These instructions assume you have already set up Authelia as an OIDC provider and are just adding Continuwuity to it. If you are looking how to set up your Authelia as an OIDC provider, [this article](https://blog.stonegarden.dev/articles/2025/06/authelia-oidc/) is very useful.
Member

Remove both sentences, as this is assumed

Remove both sentences, as this is assumed
Author
First-time contributor

Done in 8f4d4a73df

Done in 8f4d4a73dfea2d2229e3585bfe98cee9181f5f0e
stratself marked this conversation as resolved
@ -47,0 +57,4 @@
<Tab label="Authelia">
These instructions assume you have already set up Authelia as an OIDC provider and are just adding Continuwuity to it. If you are looking how to set up your Authelia as an OIDC provider, [this article](https://blog.stonegarden.dev/articles/2025/06/authelia-oidc/) is very useful.
To create a new client in your identity provider, it is [recommended](https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#how-do-i-generate-a-client-identifier-or-client-secret) to randomly generate both the client id and client secret. The commands below should get you those:
Member

For cleanliness, use indirect links

[recommended][authelia-faq-client-secret]

[authelia-faq-client-secret]: https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#how-do-i-generate-a-client-identifier-or-client-secret
For cleanliness, use indirect links ``` [recommended][authelia-faq-client-secret] [authelia-faq-client-secret]: https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#how-do-i-generate-a-client-identifier-or-client-secret ```
Member

Also, s/in your identity provider/in Authelia

Also, `s/in your identity provider/in Authelia`
Author
First-time contributor

Done in 8f4d4a73df

Done in 8f4d4a73dfea2d2229e3585bfe98cee9181f5f0e
stratself marked this conversation as resolved
@ -47,0 +59,4 @@
These instructions assume you have already set up Authelia as an OIDC provider and are just adding Continuwuity to it. If you are looking how to set up your Authelia as an OIDC provider, [this article](https://blog.stonegarden.dev/articles/2025/06/authelia-oidc/) is very useful.
To create a new client in your identity provider, it is [recommended](https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#how-do-i-generate-a-client-identifier-or-client-secret) to randomly generate both the client id and client secret. The commands below should get you those:
<Tabs groupId="authelia-docker-or-not">
Member

Tabs aren't needed here, so make them normal code blocks. Just write something like "If you're using Docker for Authelia, prepend docker run --rm authelia/authelia:latest to the commands above" afterwards

Tabs aren't needed here, so make them normal code blocks. Just write something like "If you're using Docker for Authelia, prepend `docker run --rm authelia/authelia:latest` to the commands above" afterwards
Author
First-time contributor

I got this from the Authelia docs, I really like the ease of clicking "Docker" and copy. Are you sure?

I got this from the Authelia docs, I really like the ease of clicking "Docker" and copy. Are you sure?
Member

It's fine this can be kept

It's fine this can be kept
fhoekstra marked this conversation as resolved
@ -47,0 +72,4 @@
```sh
echo "Random value for Client ID:"
docker run --rm authelia/authelia:latest authelia crypto rand --length 72 --charset rfc3986
echo "\nClient Secret (labeled Random Password) and its Digest:"
Member

These echos should be comments instead

These echos should be comments instead
Author
First-time contributor

Done in 8f4d4a73df

Done in 8f4d4a73dfea2d2229e3585bfe98cee9181f5f0e
stratself marked this conversation as resolved
@ -47,0 +78,4 @@
</Tab>
</Tabs>
:::important client secret or digest?
Member

This does not need to be an important block, should be removed

This does not need to be an `important` block, should be removed
Author
First-time contributor

Done in 8f4d4a73df

Done in 8f4d4a73dfea2d2229e3585bfe98cee9181f5f0e
stratself marked this conversation as resolved
@ -47,0 +94,4 @@
# Add this block below to the clients list
- client_name: continuwuity
client_id: "client-id-goes-here"
client_secret: "client-secret-DIGEST-goes-here"
Member

Add a comment above this line saying

# Use the client secret's DIGEST, not the client secret itself

or something to that tune

Add a comment above this line saying ``` # Use the client secret's DIGEST, not the client secret itself ``` or something to that tune
Author
First-time contributor

Done in 8f4d4a73df

Done in 8f4d4a73dfea2d2229e3585bfe98cee9181f5f0e
stratself marked this conversation as resolved
docs(oidc): PR feedback
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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
8f4d4a73df
fhoekstra force-pushed add-authelia-to-oidc-docs from 8f4d4a73df
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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
to c660c4671b
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 6s
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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
Update flake hashes / update-flake-hashes (pull_request) Successful in 2m31s
2026-10-12 12:39:57 +00:00
Compare
docs(oidc): Sweepfixes for PR2341
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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
e62781d223
* Replaces yourdomain.com with example.com (other pages use this)
* Improve initial domain instructions, remove important block there
* Capitalize "Bare Metal/Docker" tabs
spelling
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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
ca59bd08ca
fhoekstra force-pushed add-authelia-to-oidc-docs from ca59bd08ca
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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
to df457bd772
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
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
2026-10-12 17:41:01 +00:00
Compare
stratself approved these changes 2026-10-12 18:04:43 +00:00
chore: Add changelog
All checks were successful
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 8s
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
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 1m39s
05aaf36245
Member
Preview: https://muc.muoi.me/authentication/oidc.html#instructions Should be all good
nex requested review from ginger 2026-10-17 02:15:39 +00:00
All checks were successful
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 8s
Required
Details
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 6s
Required
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Required
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m39s
Required
Details
This pull request is blocked because it's outdated.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u add-authelia-to-oidc-docs:fhoekstra-add-authelia-to-oidc-docs
git switch fhoekstra-add-authelia-to-oidc-docs
Sign in to join this conversation.
No reviewers
No milestone
No assignees
2 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!2341
No description provided.