continuwuation/continuwuity
continuwuation/continuwuity
16
112
Fork 128
Code Issues 127 Pull requests 25 Releases 40 Packages 3 Activity Actions

WIP: docs: Authentication section #2234

Draft
stratself wants to merge 13 commits from stratself/continuwuity:stratself/docs-authentication into main
pull from: stratself/continuwuity:stratself/docs-authentication
merge into: continuwuation:main
Conversation 2 Commits 13 Files changed 5 +172
stratself commented 2026-09-12 06:32:45 +00:00
Member
Copy link

Adds a dedicated chapter for authentication in Continuwuity. This functionality was previously underdocumented.

The phrases "OAuth/legacy authentication" has been changed to "Oauth/legacy login flows" to separate it from authentication sources (internal versus delegated). Further pages were added to detail on these sources

Preview: https://muc.muoi.me/authentication.html

Closes #2140

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. --> Adds a dedicated chapter for authentication in Continuwuity. This functionality was previously underdocumented. The phrases "OAuth/legacy authentication" has been changed to "Oauth/legacy login flows" to separate it from authentication sources (internal versus delegated). Further pages were added to detail on these sources Preview: https://muc.muoi.me/authentication.html Closes #2140 <!-- 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. --> - [ ] 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][c1]: - [ ] My contribution follows the [code style][c2], if applicable. - [ ] I ran [pre-commit checks][c1pc] before opening/drafting this pull request. - [ ] I have [tested my contribution][c1t] (or proof-read it for documentation-only changes) myself, if applicable. This includes ensuring code compiles. - [ ] 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 
The commit moves legacy.mdx to registration.mdx and significantly
shortens it. Instead of explaining every registration option now a table
is provided. Renaming the page because besides registration there is not
much else to explain about legacy auth. If anything, those should be
elaborated on the main authentication.mdx page (i.e. difference between
OAuth and UIAA)

The email section has also been updated with (some) relevant info.
The guide would be removed at a later time
chore: Add few todos
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Details
Auto Labeler / Apply labels based on changed files (pull_request_target) Successful in 3s
Details
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Details
Checks / Prek / Check changed files (pull_request) Successful in 6s
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m23s
Details
07a921cebb
stratself reviewed 2026-09-12 06:36:58 +00:00
docs/authentication/registration.mdx Outdated
@ -0,0 +1,40 @@
# Registration
stratself commented 2026-09-12 06:36:58 +00:00
Author
Member
Copy link

This document could be retitled as "Internal authentication" and covers all about registration, email, and password resets

This document could be retitled as "Internal authentication" and covers all about registration, email, and password resets
* Moved around a few paragraphs to fit new title as well
docs(oidc): Add important notice to OIDC breaking legacy logins
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Details
Checks / Prek / Check changed files (pull_request) Successful in 6s
Details
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m29s
Details
a1471c2c49
lveneris reviewed 2026-09-12 09:35:07 +00:00
lveneris left a comment
Copy link

reviewing on the forge, at least on my device, seems to be bugged, so I can only drop these for now and I'll finish later.

reviewing on the forge, at least on my device, seems to be bugged, so I can only drop these for now and I'll finish later.
docs/authentication.mdx Outdated
@ -0,0 +6,4 @@
Continuwuity implements the following authentication flows:
- **OAuth login** (also known as **next-gen auth**): clients redirect the user to Continuwuity's login/signup page.
lveneris commented 2026-09-12 09:17:21 +00:00
Member
Copy link

"own login and registration page"

"own login and registration page"
docs/authentication.mdx Outdated
@ -0,0 +7,4 @@
Continuwuity implements the following authentication flows:
- **OAuth login** (also known as **next-gen auth**): clients redirect the user to Continuwuity's login/signup page.
- **Legacy login** (also known as the **UIAA** framework): clients logs in/signs up directly to the server via its own UI.
lveneris commented 2026-09-12 09:19:09 +00:00
Member
Copy link

"clients provide their own UI to log in to or register with the server directly"

"clients provide their own UI to log in to or register with the server directly"
docs/authentication.mdx Outdated
@ -0,0 +13,4 @@
:::important Configure your client well-known for OAuth logins
To ensure OAuth logins work, Continuwuity must know the path from which its Client-Server API is being served from:
lveneris commented 2026-09-12 09:23:36 +00:00
Member
Copy link

"the base URL its Client-Server API is being served on"

"the base URL its Client-Server API is being served on"
docs/authentication/internal.mdx Outdated
@ -0,0 +1,49 @@
# Internal authentication
Continuwuity by default comes with an internal database for user authentication. Using the internal database allows for self-servicing of account registration, linking emails, and password resets.
lveneris commented 2026-09-12 09:28:11 +00:00
Member
Copy link

"by default" implies the internal database stops existing in other modes of operation, which is not true. You may wish to drop it and suffix the first sentence with ", which it uses by default."

"by default" implies the internal database stops existing in other modes of operation, which is not true. You may wish to drop it and suffix the first sentence with ", which it uses by default."
docs/authentication/internal.mdx
@ -0,0 +18,4 @@
Registrations can be made via Continuwuity's account management page, as well as in-band from within a Matrix client (if legacy login is enabled).
Admin-issued tokens are the recommended method of registration. These tokens can be scoped with an expiry duration or maximum times used, and are suited for private/invite-only homeservers. See the `!admin token` commands for more details.
lveneris commented 2026-09-12 09:33:41 +00:00
Member
Copy link

"Admin-issued tokens are the recommended registration method. These tokens can be scoped with an expiry duration, given a usage limit, and are well suited for private or invite-only servers."

It would also be worth linking to the admin commands reference.

"Admin-issued tokens are the recommended registration method. These tokens can be scoped with an expiry duration, given a usage limit, and are well suited for private or invite-only servers." It would also be worth linking to the admin commands reference.
stratself commented 2026-09-12 14:46:08 +00:00
Author
Member
Copy link

Linking in a future commit

Linking in a future commit
docs/authentication/internal.mdx Outdated
@ -0,0 +16,4 @@
| 6 | Static token + email + reCAPTCHA | Methods 3 + 5 |
| 7 | Email only | `require_email_for_registration = true` in `[global.smtp]` section. See [Email configuration](#email-configuration) |
Registrations can be made via Continuwuity's account management page, as well as in-band from within a Matrix client (if legacy login is enabled).
lveneris commented 2026-09-12 09:31:54 +00:00
Member
Copy link

"Users can register on Continuwiity's account management page, or directly within a Matrix client if legacy login is enabled."

"Users can register on Continuwiity's account management page, or directly within a Matrix client if legacy login is enabled."
docs(auth): Address concerns from feedback part 1
All checks were successful
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 10s
Details
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m25s
Details
Checks / Prek / Check changed files (pull_request) Successful in 6s
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Details
eda47afa70
All checks were successful
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 10s
Required
Details
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m25s
Required
Details
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
This pull request is marked as a work in progress.
This branch is out-of-date with the base branch
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u stratself/docs-authentication:stratself-stratself/docs-authentication
git switch stratself-stratself/docs-authentication
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
Abandoned
This pull request appears to be abandoned by its author.

  
Blocked
This pull request or issue is currently blocked from being merged/closed

  
Bug
Something isn't working as intended

  
Changelog
Added
 Changelog entry added

  
Changelog
Missing
 No changelog when one is needed

  
Changelog
None
 Changelog is unnecesary for this change

  
Cherry-picking
Commits picked from other conduit projects

  
Database
This requires or includes changes to the database

  
Dependencies
Something dependency related

  
Dependencies/Renovate
Automatic dependency upgrades by Renovate

  
Difficulty
Easy
 Low difficulty to implement - touches few parts of the codebase, low complexity

  
Difficulty
Hard
 High difficulty to implement - touches many parts of the codebase, high complexity

  
Difficulty
Medium
 Medium difficulty to implement - touches more parts of the codebase, higher complexity

  
Documentation
Improvements or additions to documentation

  
Enhancement
New feature or request

  
Good first issue
Good for newcomers

  
Help wanted
Additional eyes and keyboards are required for this one

  
Inherited
Issues that have been inhereted from the project pre-fork

  
Matrix/Administration
Features pertaining to homeserver administration

  
Matrix/Appservices
Features pertaining to the appservice API

  
Matrix/Auth
Features pertaining to authentication

  
Matrix/Client
Features pertaining to client-to-server interactions

  
Matrix/Core
Issues relating to core matrix functionality, such as state resolution and PDU formats

  
Matrix/E2EE
Issues related to end to end encryption

  
Matrix/Federation
Features pertaining to server-to-server interactions

  
Matrix/Hydra
Issues related to room version 12 and related changes (temporary label)

  
Matrix/MSC
Features pertaining to unstable matrix features

  
Matrix/Media
Features pertaining to media interactions

  
Matrix/T&S
Changes or issues related to trust & safety tooling

  
Merge
This PR is ready to be merged

  
Merge/Manual
This PR should be manually merged

  
Merge/Squash
This PR should be squashed when it is merged

  
Meta
Related to housekeeping, maintenance, or other repo-meta.

  
Meta/CI
Issues related to CI changes

  
Meta/Packaging
Packaging

  
Priority
Blocking
 This issue is blocking the next release

  
Priority
High
 This issue is very important

  
Priority
Low
 This issue is of a rather low priority

  
Security
This item is related to general security

  
Status
Confirmed
 This issue has enough information and is confirmed

  
Status
Duplicate
 This issue or pull request already exists

  
Status
Invalid
 This issue doesn't seem right

  
Status
Needs Investigation
 This issue needs further investigation

  
Support
Questions or support requests

  
bob the builder
pdu logic rewrite starring nexus nicholson

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
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
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!2234
No description provided.