Add missing documentation to config parameters. #1619

Closed
renegadespork wants to merge 16 commits from renegadespork/continuwuity:main into main
Contributor

Addresses issue #1544

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:

Addresses [issue #1544](https://forgejo.ellis.link/continuwuation/continuwuity/issues/1544) 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.
renegadespork force-pushed main from d48f2ebdf1
Some checks failed
Check Changelog / Check for changelog (pull_request_target) Waiting to run
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
to 339fa08947
Some checks are pending
Documentation / Build and Deploy Documentation (pull_request) Blocked by required conditions
Checks / Prek / Pre-commit & Formatting (pull_request) Blocked by required conditions
Checks / Prek / Clippy and Cargo Tests (pull_request) Blocked by required conditions
Check Changelog / Check for changelog (pull_request_target) Successful in 10s
2026-04-06 20:11:55 +00:00
Compare
nex 2026-04-06 20:16:38 +00:00

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.
Jade force-pushed main from 339fa08947
Some checks are pending
Documentation / Build and Deploy Documentation (pull_request) Blocked by required conditions
Checks / Prek / Pre-commit & Formatting (pull_request) Blocked by required conditions
Checks / Prek / Clippy and Cargo Tests (pull_request) Blocked by required conditions
Check Changelog / Check for changelog (pull_request_target) Successful in 10s
to ec052ede59
Some checks failed
Check Changelog / Check for changelog (pull_request_target) Successful in 33s
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m17s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 9m46s
2026-04-12 14:51:31 +00:00
Compare
Jade force-pushed main from ec052ede59
Some checks failed
Check Changelog / Check for changelog (pull_request_target) Successful in 33s
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m17s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 9m46s
to 03fd891051
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Failing after 31s
Checks / Prek / Check changed files (pull_request) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 8m21s
Deploy Element Web / 🏗️ Build and Deploy (pull_request) Failing after 17m14s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 20m57s
2026-04-23 19:52:47 +00:00
Compare
@ -178,0 +193,4 @@
# When determining is a user is authorized to send an event,
# the server will first check the auth chain cache.
# If the auth chain is not present in the cache,
# The server will reach out to the origin server for
Owner

This isn't correct - it fetches fron the database in the only place this is used

This isn't correct - it fetches fron the database in the only place this is used
Author
Contributor

Thank you for the correction! I updated the auth_chain_cache_capacity description.

Thank you for the correction! I updated the `auth_chain_cache_capacity` description.
renegadespork marked this conversation as resolved
Owner

Otherwise looks good, although I think like half of these cache options should never be touched ever

Otherwise looks good, although I think like half of these cache options should never be touched ever
renegadespork force-pushed main from 03fd891051
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Failing after 31s
Checks / Prek / Check changed files (pull_request) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 8m21s
Deploy Element Web / 🏗️ Build and Deploy (pull_request) Failing after 17m14s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 20m57s
to fa9fd7f5a6
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 7s
Checks / Changelog / Check changelog is added (pull_request_target) Failing after 30s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m22s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 8m1s
2026-04-27 15:49:45 +00:00
Compare
Member

Hello, is this PR still active? Would be nice to have these detailed documentation in

Hello, is this PR still active? Would be nice to have these detailed documentation in
Author
Contributor

@stratself wrote in #1619 (comment):

Hello, is this PR still active? Would be nice to have these detailed documentation in

Oh whoops, I thought this was merged already. >.<

I'll update with @Jade 's correction today.

@stratself wrote in https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1619#issuecomment-33679: > Hello, is this PR still active? Would be nice to have these detailed documentation in Oh whoops, I thought this was merged already. >.< I'll update with @Jade 's correction today.
Merge remote-tracking branch 'upstream/main'
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Failing after 7s
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 54s
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m22s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
Deploy Element Web / 🏗️ Build and Deploy (pull_request) Failing after 6m47s
324553973b
docs: Added config documentation for the remaining undocumented variables.
Some checks failed
Check Changelog / Check for changelog (pull_request_target) Waiting to run
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
d48f2ebdf1
Merge pull request 'docs: Corrected description of auth chain logic.' (#2) from renegadespork/dev into main
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Failing after 6s
Checks / Prek / Check changed files (pull_request) Successful in 4s
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m9s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 9m9s
5a231cda84
Revert "Merge pull request 'docs: Corrected description of auth chain logic.' (#2) from renegadespork/dev into main"
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Changelog / Check changelog is added (pull_request_target) Failing after 7s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m11s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 9m9s
cd471971c7
This reverts commit 5a231cda84, reversing
changes made to 324553973b.
Author
Contributor

Ugh... I made an absolute mess of my commit tree by pulling in upstream changes in a weird order. Give me a bit while I try to sort this out.

I might just nuke and pave these branches and try a new pull request with just my updates.

Ugh... I made an absolute mess of my commit tree by pulling in upstream changes in a weird order. Give me a bit while I try to sort this out. I might just nuke and pave these branches and try a new pull request with just my updates.
Author
Contributor

Okay, sorry this branch became a mess. I cleaned things up and opened a new pull request: #2107

Okay, sorry this branch became a mess. I cleaned things up and opened a new pull request: #2107
renegadespork closed this pull request 2026-08-05 22:32:56 +00:00
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 6s
Required
Details
Checks / Changelog / Check changelog is added (pull_request_target) Failing after 7s
Required
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m11s
Required
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 9m9s
Required
Details

Pull request closed

Sign in to join this conversation.
No reviewers
No milestone
No project
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!1619
No description provided.