continuwuation/continuwuity
continuwuation/continuwuity
17
112
Fork 122
Code Issues 141 Pull requests 27 Releases 39 Packages 3 Activity Actions

docs: Add missing documentation to config parameters. #2107

Merged
Aranjedeath merged 6 commits from renegadespork/continuwuity:dev into main 2026-08-06 22:58:51 +00:00
Conversation 3 Commits 6 Files changed 3 +313 -17
renegadespork commented 2026-08-05 22:25:37 +00:00
Contributor
Copy link

Fixes #1544
Closes #1619

Added documentation for the following:

  • pdu_cache_capacity
  • auth_chain_cache_capacity
  • shorteventid_cache_capacity
  • eventidshort_cache_capacity
  • eventid_pdu_cache_capacity
  • shortstatekey_cache_capacity
  • statekeyshort_cache_capacity
  • servernameevent_data_cache_capacity
  • stateinfo_cache_capacity
  • roomid_spacehierarchy_cache_capacity
  • max_fetch_prev_events
  • tracing_flame_filter
  • rocksdb_log_stderr
  • notification_push_path
  • freeze_legacy_media
  • test

Information referenced from:

Pull request checklist:

  • [ 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:
    • [ x ] My contribution follows the code style, if applicable.
    • [ x ] I ran pre-commit checks before opening/drafting this pull request.
    • [ x ] I have tested my contribution (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 and are descriptive.
Fixes #1544 Closes #1619 Added documentation for the following: - `pdu_cache_capacity` - `auth_chain_cache_capacity` - `shorteventid_cache_capacity` - `eventidshort_cache_capacity` - `eventid_pdu_cache_capacity` - `shortstatekey_cache_capacity` - `statekeyshort_cache_capacity` - `servernameevent_data_cache_capacity` - `stateinfo_cache_capacity` - `roomid_spacehierarchy_cache_capacity` - `max_fetch_prev_events` - `tracing_flame_filter` - `rocksdb_log_stderr` - `notification_push_path` - `freeze_legacy_media` - `test` Information referenced from: - `/src/config/mod.rs` - [Conduit Docs](https://docs.conduit.rs/configuration.html) - [Matrix Specification](https://spec.matrix.org/v1.9/server-server-api/) - Variable references in the code. **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
docs: Corrected description of auth chain logic.
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 2s
Details
Checks / Changelog / Check changelog is added (pull_request_target) Failing after 6s
Details
Checks / Prek / Check changed files (pull_request) Successful in 6s
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m11s
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 9m27s
Details
fb4e6e2c34
chore: Add changelog for config documentation.
Some checks failed
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 / Pre-commit & Formatting (pull_request) Failing after 1m5s
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 8m26s
Details
0d6efbbee8
chore: Fix changelog news fragment formatting
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 6s
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m11s
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 8m25s
Details
64189fdcb6
Jade approved these changes 2026-08-06 00:29:46 +00:00
Aranjedeath reviewed 2026-08-06 00:58:14 +00:00
conduwuit-example.toml Outdated
@ -202,0 +276,4 @@
# This caps the capacity of cached event_data referenced
# by server_name.
#
# This defaults to 500,000 + (10,000 * CPU core count)
Aranjedeath commented 2026-08-06 00:58:14 +00:00
Owner
Copy link

500k + 100k per core, not 10k!

500k + 100k per core, not 10k!
👍 1
Aranjedeath commented 2026-08-06 00:59:50 +00:00
Owner
Copy link

Line 2764 in f1755dd
parallelism_scaled_u32(100_000).saturating_add(500_000)

https://forgejo.ellis.link/continuwuation/continuwuity/src/commit/f1755dd36f3049ef7f4fc710edd65437e9b993b0/src/core/config/mod.rs#L2764
renegadespork commented 2026-08-06 04:17:55 +00:00
Author
Contributor
Copy link

Thank you for catching that! Fixed in 839b573f7c.

Thank you for catching that! Fixed in 839b573f7cba8e58f5cf985decfbea0d92b4ee4e.
Aranjedeath marked this conversation as resolved
docs: Fix servernameevent_data_cache_capacity default description.
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
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 / Pre-commit & Formatting (pull_request) Successful in 1m10s
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 11m32s
Details
839b573f7c
stratself reviewed 2026-08-06 04:20:55 +00:00
conduwuit-example.toml Outdated
@ -1218,0 +1327,4 @@
# You should only change this if you have configured your own push gateway
# that requires a different path.
#
# For more information on Push Gateways: https://spec.matrix.org/v1.9/push-gateway-api/
stratself commented 2026-08-06 04:20:55 +00:00
Member
Copy link

Pls use v1.19 or latest for the spec version

Pls use `v1.19` or `latest` for the spec version
👍 1
renegadespork force-pushed dev from 839b573f7c
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
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 / Pre-commit & Formatting (pull_request) Successful in 1m10s
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 11m32s
Details
to 1c23cf3a93
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
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 / Pre-commit & Formatting (pull_request) Successful in 1m11s
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 8m37s
Details
2026-08-06 14:18:33 +00:00 Compare
docs: Reference latest version of matrix spec
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
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 / Pre-commit & Formatting (pull_request) Successful in 1m11s
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 8m12s
Details
Documentation / Build and Deploy Documentation (push) Successful in 1m8s
Details
Checks / Prek / Pre-commit & Formatting (push) Successful in 1m10s
Details
Checks / Prek / Check changed files (push) Successful in 7s
Details
Release Docker Image / Build linux-amd64 (release) (push) Failing after 2m40s
Details
Checks / Prek / Clippy and Cargo Tests (push) Successful in 9m37s
Details
Release Docker Image / Build linux-arm64 (release) (push) Successful in 12m25s
Details
Release Docker Image / Create Multi-arch Release Manifest (push) Has been skipped
Details
Release Docker Image / Build linux-amd64 (max-perf) (push) Has been skipped
Details
Release Docker Image / Build linux-arm64 (max-perf) (push) Has been skipped
Details
Release Docker Image / Create Max-Perf Manifest (push) Has been skipped
Details
Release Docker Image / Mirror Images (push) Has been skipped
Details
Release Docker Image / Release Binaries (push) Has been skipped
Details
02bee2e898
Sign in to join this conversation.
Reviewers
No reviewers
Jade
Aranjedeath
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
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!2107
No description provided.