continuwuation/continuwuity
continuwuation/continuwuity
15
84
Fork 97
Code Issues 127 Pull requests 25 Releases 27 Packages 3 Activity Actions 5

docs(delegation): Add section for manually serving .well-knowns files #1626

Merged
Jade merged 2 commits from stratself/continuwuity:stratself/docs-delegation-fixes into main 2026-04-15 09:53:26 +00:00
Conversation 4 Commits 2 Files changed 1 +53 -4
stratself commented 2026-04-08 10:29:48 +00:00
Contributor
Copy link
  • Also add note on default support contacts
  • Also add individual env vars for .well-knowns

Following #1498 (comment) I've decided to document this here.

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:
* Also add note on default support contacts * Also add individual env vars for .well-knowns Following https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1498#issuecomment-27572 I've decided to document this here. <!-- 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. - [ ] I have written a [news fragment][n1] for this PR, if applicable<!--(can be done after hitting open!)-->. <!-- 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 [n1]: https://towncrier.readthedocs.io/en/stable/tutorial.html#creating-news-fragments
docs(delegation): Add section for manually serving .well-knowns files
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Details
Check Changelog / Check for changelog (pull_request_target) Successful in 10s
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 3m11s
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 13m45s
Details
6b49b24061 
* Also add note on default support contacts
* Also add individual env vars for .well-knowns
stratself force-pushed stratself/docs-delegation-fixes from 6b49b24061
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Details
Check Changelog / Check for changelog (pull_request_target) Successful in 10s
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 3m11s
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 13m45s
Details
to c1e1113525
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Details
Check Changelog / Check for changelog (pull_request_target) Successful in 10s
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 3m7s
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 14m4s
Details
2026-04-08 10:46:01 +00:00 Compare
lveneris requested changes 2026-04-09 09:44:22 +00:00
docs/advanced/delegation.mdx Outdated
@ -45,3 +50,3 @@
```
## Serving with a reverse proxy
## Reverse proxying .well-knowns to Continuwuity
lveneris commented 2026-04-09 09:41:50 +00:00
Contributor
Copy link

Something about having .well-knowns chilling in plain text bugs me. I would prefer either an inline code block, or better yet, calling them by their name (well-known URIs).

Something about having `.well-known`s chilling in plain text bugs me. I would prefer either an inline code block, or better yet, calling them by their name (well-known URIs).
stratself marked this conversation as resolved
docs/advanced/delegation.mdx
@ -117,1 +120,4 @@
### Serving .well-knowns manually
Instead of reverse proxying .well-knowns, you can serve them directly as static JSON files that matches the ones above. This is useful if your base domain points to a different physical server, and reverse proxying isn't available.
lveneris commented 2026-04-09 09:42:28 +00:00
Contributor
Copy link

minor nit but "matches" -> "match"

minor nit but "matches" -> "match"
stratself marked this conversation as resolved
docs/advanced/delegation.mdx
@ -118,0 +148,4 @@
</details>
When doing this, the `[global.well_known]` configurations can be safely removed. Remember to set the `Access-Control-Allow-Origin: *` header in your `/.well-known/matrix/client` path for web clients to work.
lveneris commented 2026-04-09 09:44:20 +00:00
Contributor
Copy link

maybe "Doing this makes [global.well-known] redundant." for brevity? "When doing this" reads like a cookbook

maybe "Doing this makes `[global.well-known]` redundant." for brevity? "When doing this" reads like a cookbook
stratself marked this conversation as resolved
gan commented 2026-04-09 09:58:18 +00:00
First-time contributor
Copy link

For sake of a pedantic remark, perhaps the docs should mention that most clients will follow client's well-known, so if an alternative method for accessing the server is used, the client will redirect itself to the url set in client's well-known which might be not desirable in certain cases.

For sake of a pedantic remark, perhaps the docs should mention that most clients will follow client's well-known, so if an alternative method for accessing the server is used, the client will redirect itself to the url set in client's well-known which might be not desirable in certain cases.
docs(delegation): Add remark on .well-knowns against alt setups
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Details
Check Changelog / Check for changelog (pull_request_target) Successful in 10s
Details
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m42s
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 4m45s
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Failing after 5m38s
Details
95d22069ee 
* Also incorporate feedback from PR comments
forgejo-actions commented 2026-04-11 15:40:37 +00:00
Copy link

Please add a changelog fragment to changelog.d/ describing your changes.

<!-- changelog-check-action --> Please add a changelog fragment to `changelog.d/` describing your changes.
stratself commented 2026-04-11 15:41:44 +00:00
Author
Contributor
Copy link

@gan added the remark.

@gan added the remark.
Jade merged commit 9d11f56393 into main 2026-04-15 09:53:26 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
lveneris
Labels
Clear labels   
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

  
Wont fix

This will not be worked on

  
old/ci/cd

Ci/CD

Archived

  
old/rust

Pull requests that update Rust code

Archived

No labels
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
Wont fix
old/ci/cd
old/rust
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
4 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!1626
No description provided.