document all the fancy admin room config options and arguments

Signed-off-by: strawberry <strawberry@puppygock.gay>
dont use HTML for initial welcome message
2024-09-01 12:44:24 -04:00 · 2024-09-01 12:11:56 -04:00 · 2024-09-01 12:08:38 -04:00 · 2024-09-01 12:00:08 -04:00 · 2024-08-31 18:58:39 +02:00 · 2024-09-01 11:15:55 +00:00
52 changed files with 1755 additions and 795 deletions
@@ -18,3 +18,6 @@ max_line_length = 80

 [*.nix]
 indent_size = 2
+
+[*.rs]
+indent_style = tab
@@ -58,7 +58,7 @@ before_script:

 ci:
  stage: ci
-  image: nixos/nix:2.23.3
+  image: nixos/nix:2.24.4
  script:
    # Cache CI dependencies
    - ./bin/nix-build-and-cache ci
@@ -83,7 +83,7 @@ ci:

 artifacts:
  stage: artifacts
-  image: nixos/nix:2.23.3
+  image: nixos/nix:2.24.4
  script:
    - ./bin/nix-build-and-cache just .#static-x86_64-unknown-linux-musl
    - cp result/bin/conduit x86_64-unknown-linux-musl
@@ -1,29 +1,46 @@
 # Contributing guide

-This page is for about contributing to conduwuit. The [development](development.md) page may be of interest for you as well.
+This page is for about contributing to conduwuit. The
+[development](development.md) page may be of interest for you as well.

-If you would like to work on an [issue][issues] that is not assigned, preferably ask in the Matrix room first at [#conduwuit:puppygock.gay][conduwuit-matrix], and comment on it.
+If you would like to work on an [issue][issues] that is not assigned, preferably
+ask in the Matrix room first at [#conduwuit:puppygock.gay][conduwuit-matrix],
+and comment on it.

 ### Linting and Formatting

-It is mandatory all your changes satisfy the lints (clippy, rustc, rustdoc, etc) and your code is formatted via the **nightly** `cargo fmt`. A lot of the `rustfmt.toml` features depend on nightly toolchain. It would be ideal if they weren't nightly-exclusive features, but they currently still are. CI's rustfmt uses nightly.
+It is mandatory all your changes satisfy the lints (clippy, rustc, rustdoc, etc)
+and your code is formatted via the **nightly** `cargo fmt`. A lot of the
+`rustfmt.toml` features depend on nightly toolchain. It would be ideal if they
+weren't nightly-exclusive features, but they currently still are. CI's rustfmt
+uses nightly.

-If you need to allow a lint, please make sure it's either obvious as to why (e.g. clippy saying redundant clone but it's actually required) or it has a comment saying why. Do not write inefficient code for the sake of satisfying lints. If a lint is wrong and provides a more inefficient solution or suggestion, allow the lint and mention that in a comment.
+If you need to allow a lint, please make sure it's either obvious as to why
+(e.g. clippy saying redundant clone but it's actually required) or it has a
+comment saying why. Do not write inefficient code for the sake of satisfying
+lints. If a lint is wrong and provides a more inefficient solution or
+suggestion, allow the lint and mention that in a comment.

 ### Running CI tests locally

-conduwuit's CI for tests, linting, formatting, audit, etc use [`engage`][engage]. engage can be installed from nixpkgs or `cargo install engage`. conduwuit's Nix flake devshell has the nixpkgs engage with `direnv`. Use `engage --help` for more usage details.
+conduwuit's CI for tests, linting, formatting, audit, etc use
+[`engage`][engage]. engage can be installed from nixpkgs or `cargo install
+engage`. conduwuit's Nix flake devshell has the nixpkgs engage with `direnv`.
+Use `engage --help` for more usage details.

-To test, format, lint, etc that CI would do, install engage, allow the `.envrc` file using `direnv allow`, and run `engage`.
+To test, format, lint, etc that CI would do, install engage, allow the `.envrc`
+file using `direnv allow`, and run `engage`.

-All of the tasks are defined at the [engage.toml][engage.toml] file. You can view all of them neatly by running `engage list`
+All of the tasks are defined at the [engage.toml][engage.toml] file. You can
+view all of them neatly by running `engage list`

 If you would like to run only a specific engage task group, use `just`:

 - `engage just <group>`
 - Example: `engage just lints`

-If you would like to run a specific engage task in a specific group, use `just <GROUP> [TASK]`: `engage just lints cargo-fmt`
+If you would like to run a specific engage task in a specific group, use `just
+<GROUP> [TASK]`: `engage just lints cargo-fmt`

 The following binaries are used in [`engage.toml`][engage.toml]:

@@ -43,43 +60,75 @@ The following binaries are used in [`engage.toml`][engage.toml]:

 ### Matrix tests

-CI runs [Complement][complement], but currently does not fail if results from the checked-in results differ with the new results. If your changes are done to fix Matrix tests, note that in your pull request. If more Complement tests start failing from your changes, please review the logs (they are uploaded as artifacts) and determine if they're intended or not.
+CI runs [Complement][complement], but currently does not fail if results from
+the checked-in results differ with the new results. If your changes are done to
+fix Matrix tests, note that in your pull request. If more Complement tests start
+failing from your changes, please review the logs (they are uploaded as
+artifacts) and determine if they're intended or not.

-If you'd like to run Complement locally using Nix, see the [testing](docs/development/testing.md) page.
+If you'd like to run Complement locally using Nix, see the
+[testing](docs/development/testing.md) page.

 [Sytest][sytest] support will come soon.

 ### Writing documentation

-conduwuit's website uses [`mdbook`][mdbook] and deployed via CI using GitHub Pages in the [`documentation.yml`][documentation.yml] workflow file with Nix's mdbook in the devshell. All documentation is in the `docs/` directory at the top level. The compiled mdbook website is also uploaded as an artifact.
+conduwuit's website uses [`mdbook`][mdbook] and deployed via CI using GitHub
+Pages in the [`documentation.yml`][documentation.yml] workflow file with Nix's
+mdbook in the devshell. All documentation is in the `docs/` directory at the top
+level. The compiled mdbook website is also uploaded as an artifact.

 To build the documentation using Nix, run: `bin/nix-build-and-cache just .#book`

-The output of the mdbook generation is in `result/`. mdbooks can be opened in your browser from the individual HTML files without any web server needed.
+The output of the mdbook generation is in `result/`. mdbooks can be opened in
+your browser from the individual HTML files without any web server needed.

 ### Inclusivity and Diversity

-All **MUST** code and write with inclusivity and diversity in mind. See the [following page by Google on writing inclusive code and documentation](https://developers.google.com/style/inclusive-documentation).
+All **MUST** code and write with inclusivity and diversity in mind. See the
+[following page by Google on writing inclusive code and
+documentation](https://developers.google.com/style/inclusive-documentation).

-This **EXPLICITLY** forbids usage of terms like "blacklist"/"whitelist" and "master"/"slave", [forbids gender-specific words and phrases](https://developers.google.com/style/pronouns#gender-neutral-pronouns), forbids ableist language like "sanity-check", "cripple", or "insane", and forbids culture-specific language (e.g. US-only holidays or cultures).
+This **EXPLICITLY** forbids usage of terms like "blacklist"/"whitelist" and
+"master"/"slave", [forbids gender-specific words and
+phrases](https://developers.google.com/style/pronouns#gender-neutral-pronouns),
+forbids ableist language like "sanity-check", "cripple", or "insane", and
+forbids culture-specific language (e.g. US-only holidays or cultures).

-No exceptions are allowed. Dependencies that may use these terms are allowed but [do not replicate the name in your functions or variables](https://developers.google.com/style/inclusive-documentation#write-around).
+No exceptions are allowed. Dependencies that may use these terms are allowed but
+[do not replicate the name in your functions or
+variables](https://developers.google.com/style/inclusive-documentation#write-around).

-In addition to language, write and code with the user experience in mind. This is software that intends to be used by everyone, so make it easy and comfortable for everyone to use. 🏳️‍⚧️
+In addition to language, write and code with the user experience in mind. This
+is software that intends to be used by everyone, so make it easy and comfortable
+for everyone to use. 🏳️‍⚧️

 ### Variable, comment, function, etc standards

-Rust's default style and standards with regards to [function names, variable names, comments](https://rust-lang.github.io/api-guidelines/naming.html), etc applies here.
+Rust's default style and standards with regards to [function names, variable
+names, comments](https://rust-lang.github.io/api-guidelines/naming.html), etc
+applies here.

 ### Creating pull requests

-Please try to keep contributions to the GitHub. While the mirrors of conduwuit allow for pull/merge requests, there is no guarantee I will see them in a timely manner. Additionally, please mark WIP or unfinished or incomplete PRs as drafts. This prevents me from having to ping once in a while to double check the status of it, especially when the CI completed successfully and everything so it *looks* done.
+Please try to keep contributions to the GitHub. While the mirrors of conduwuit
+allow for pull/merge requests, there is no guarantee I will see them in a timely
+manner. Additionally, please mark WIP or unfinished or incomplete PRs as drafts.
+This prevents me from having to ping once in a while to double check the status
+of it, especially when the CI completed successfully and everything so it
+*looks* done.

-If you open a pull request on one of the mirrors, it is your responsibility to inform me about its existence. In the future I may try to solve this with more repo bots in the conduwuit Matrix room. There is no mailing list or email-patch support on the sr.ht mirror, but if you'd like to email me a git patch you can do so at `strawberry@puppygock.gay`.
+If you open a pull request on one of the mirrors, it is your responsibility to
+inform me about its existence. In the future I may try to solve this with more
+repo bots in the conduwuit Matrix room. There is no mailing list or email-patch
+support on the sr.ht mirror, but if you'd like to email me a git patch you can
+do so at `strawberry@puppygock.gay`.

 Direct all PRs/MRs to the `main` branch.

-By sending a pull request or patch, you are agreeing that your changes are allowed to be licenced under the Apache-2.0 licence and all of your conduct is in line with the Contributor's Covenant.
+By sending a pull request or patch, you are agreeing that your changes are
+allowed to be licenced under the Apache-2.0 licence and all of your conduct is
+in line with the Contributor's Covenant.

 [issues]: https://github.com/girlbossceo/conduwuit/issues
 [conduwuit-matrix]: https://matrix.to/#/#conduwuit:puppygock.gay
@@ -130,7 +130,7 @@ checksum = "16e62a023e7c117e27523144c5d2459f4397fcc3cab0085af8e2224f643a0193"
 dependencies = [
 "proc-macro2",
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 ]

 [[package]]
@@ -141,7 +141,7 @@ checksum = "6e0c28dcc82d7c8ead5cb13beb15405b57b8546e93215673ff8ca0349a028107"
 dependencies = [
 "proc-macro2",
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 ]

 [[package]]
@@ -376,7 +376,7 @@ dependencies = [
 "regex",
 "rustc-hash 1.1.0",
 "shlex",
- "syn 2.0.75",
+ "syn 2.0.76",
 "which",
 ]

@@ -572,7 +572,7 @@ dependencies = [
 "heck 0.5.0",
 "proc-macro2",
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 ]

 [[package]]
@@ -746,7 +746,7 @@ dependencies = [
 "itertools 0.13.0",
 "proc-macro2",
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 ]

 [[package]]
@@ -1042,7 +1042,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "edb49164822f3ee45b17acd4a208cfc1251410cf0cad9a833234c9890774dd9f"
 dependencies = [
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 ]

 [[package]]
@@ -1069,7 +1069,7 @@ checksum = "f46882e17999c6cc590af592290432be3bce0428cb0d5f8b6715e4dc7b383eb3"
 dependencies = [
 "proc-macro2",
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 ]

 [[package]]
@@ -1179,7 +1179,7 @@ dependencies = [
 "heck 0.4.1",
 "proc-macro2",
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 ]

 [[package]]
@@ -1331,7 +1331,7 @@ checksum = "87750cf4b7a4c0625b1529e4c543c2182106e4dedc60a2a6455e00d212c489ac"
 dependencies = [
 "proc-macro2",
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 ]

 [[package]]
@@ -1602,7 +1602,7 @@ dependencies = [
 "markup5ever",
 "proc-macro2",
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 ]

 [[package]]
@@ -1966,7 +1966,7 @@ dependencies = [
 "proc-macro2",
 "quote",
 "regex",
- "syn 2.0.75",
+ "syn 2.0.76",
 ]

 [[package]]
@@ -2497,7 +2497,7 @@ dependencies = [
 "proc-macro2",
 "proc-macro2-diagnostics",
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 ]

 [[package]]
@@ -2590,7 +2590,7 @@ checksum = "2f38a4412a78282e09a2cf38d195ea5420d15ba0602cb375210efbc877243965"
 dependencies = [
 "proc-macro2",
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 ]

 [[package]]
@@ -2662,7 +2662,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "5f12335488a2f3b0a83b14edad48dca9879ce89b2edd10e80237e4e852dd645e"
 dependencies = [
 "proc-macro2",
- "syn 2.0.75",
+ "syn 2.0.76",
 ]

 [[package]]
@@ -2691,7 +2691,7 @@ checksum = "af066a9c399a26e020ada66a034357a868728e72cd426f3adcd35f80d88d88c8"
 dependencies = [
 "proc-macro2",
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 "version_check",
 "yansi",
 ]
@@ -2716,7 +2716,7 @@ dependencies = [
 "itertools 0.13.0",
 "proc-macro2",
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 ]

 [[package]]
@@ -2975,7 +2975,7 @@ dependencies = [
 [[package]]
 name = "ruma"
 version = "0.10.1"
-source = "git+https://github.com/girlbossceo/ruwuma?rev=1de0f493e8aab7e65ea78e3a079a3de10167c777#1de0f493e8aab7e65ea78e3a079a3de10167c777"
+source = "git+https://github.com/girlbossceo/ruwuma?rev=d7ddcd036f81edb257ab9371f9cadd46444e8a90#d7ddcd036f81edb257ab9371f9cadd46444e8a90"
 dependencies = [
 "assign",
 "js_int",
@@ -2997,7 +2997,7 @@ dependencies = [
 [[package]]
 name = "ruma-appservice-api"
 version = "0.10.0"
-source = "git+https://github.com/girlbossceo/ruwuma?rev=1de0f493e8aab7e65ea78e3a079a3de10167c777#1de0f493e8aab7e65ea78e3a079a3de10167c777"
+source = "git+https://github.com/girlbossceo/ruwuma?rev=d7ddcd036f81edb257ab9371f9cadd46444e8a90#d7ddcd036f81edb257ab9371f9cadd46444e8a90"
 dependencies = [
 "js_int",
 "ruma-common",
@@ -3009,7 +3009,7 @@ dependencies = [
 [[package]]
 name = "ruma-client-api"
 version = "0.18.0"
-source = "git+https://github.com/girlbossceo/ruwuma?rev=1de0f493e8aab7e65ea78e3a079a3de10167c777#1de0f493e8aab7e65ea78e3a079a3de10167c777"
+source = "git+https://github.com/girlbossceo/ruwuma?rev=d7ddcd036f81edb257ab9371f9cadd46444e8a90#d7ddcd036f81edb257ab9371f9cadd46444e8a90"
 dependencies = [
 "as_variant",
 "assign",
@@ -3032,7 +3032,7 @@ dependencies = [
 [[package]]
 name = "ruma-common"
 version = "0.13.0"
-source = "git+https://github.com/girlbossceo/ruwuma?rev=1de0f493e8aab7e65ea78e3a079a3de10167c777#1de0f493e8aab7e65ea78e3a079a3de10167c777"
+source = "git+https://github.com/girlbossceo/ruwuma?rev=d7ddcd036f81edb257ab9371f9cadd46444e8a90#d7ddcd036f81edb257ab9371f9cadd46444e8a90"
 dependencies = [
 "as_variant",
 "base64 0.22.1",
@@ -3062,7 +3062,7 @@ dependencies = [
 [[package]]
 name = "ruma-events"
 version = "0.28.1"
-source = "git+https://github.com/girlbossceo/ruwuma?rev=1de0f493e8aab7e65ea78e3a079a3de10167c777#1de0f493e8aab7e65ea78e3a079a3de10167c777"
+source = "git+https://github.com/girlbossceo/ruwuma?rev=d7ddcd036f81edb257ab9371f9cadd46444e8a90#d7ddcd036f81edb257ab9371f9cadd46444e8a90"
 dependencies = [
 "as_variant",
 "indexmap 2.4.0",
@@ -3086,7 +3086,7 @@ dependencies = [
 [[package]]
 name = "ruma-federation-api"
 version = "0.9.0"
-source = "git+https://github.com/girlbossceo/ruwuma?rev=1de0f493e8aab7e65ea78e3a079a3de10167c777#1de0f493e8aab7e65ea78e3a079a3de10167c777"
+source = "git+https://github.com/girlbossceo/ruwuma?rev=d7ddcd036f81edb257ab9371f9cadd46444e8a90#d7ddcd036f81edb257ab9371f9cadd46444e8a90"
 dependencies = [
 "bytes",
 "http",
@@ -3104,7 +3104,7 @@ dependencies = [
 [[package]]
 name = "ruma-identifiers-validation"
 version = "0.9.5"
-source = "git+https://github.com/girlbossceo/ruwuma?rev=1de0f493e8aab7e65ea78e3a079a3de10167c777#1de0f493e8aab7e65ea78e3a079a3de10167c777"
+source = "git+https://github.com/girlbossceo/ruwuma?rev=d7ddcd036f81edb257ab9371f9cadd46444e8a90#d7ddcd036f81edb257ab9371f9cadd46444e8a90"
 dependencies = [
 "js_int",
 "thiserror",
@@ -3113,7 +3113,7 @@ dependencies = [
 [[package]]
 name = "ruma-identity-service-api"
 version = "0.9.0"
-source = "git+https://github.com/girlbossceo/ruwuma?rev=1de0f493e8aab7e65ea78e3a079a3de10167c777#1de0f493e8aab7e65ea78e3a079a3de10167c777"
+source = "git+https://github.com/girlbossceo/ruwuma?rev=d7ddcd036f81edb257ab9371f9cadd46444e8a90#d7ddcd036f81edb257ab9371f9cadd46444e8a90"
 dependencies = [
 "js_int",
 "ruma-common",
@@ -3123,7 +3123,7 @@ dependencies = [
 [[package]]
 name = "ruma-macros"
 version = "0.13.0"
-source = "git+https://github.com/girlbossceo/ruwuma?rev=1de0f493e8aab7e65ea78e3a079a3de10167c777#1de0f493e8aab7e65ea78e3a079a3de10167c777"
+source = "git+https://github.com/girlbossceo/ruwuma?rev=d7ddcd036f81edb257ab9371f9cadd46444e8a90#d7ddcd036f81edb257ab9371f9cadd46444e8a90"
 dependencies = [
 "once_cell",
 "proc-macro-crate",
@@ -3131,14 +3131,14 @@ dependencies = [
 "quote",
 "ruma-identifiers-validation",
 "serde",
- "syn 2.0.75",
+ "syn 2.0.76",
 "toml",
 ]

 [[package]]
 name = "ruma-push-gateway-api"
 version = "0.9.0"
-source = "git+https://github.com/girlbossceo/ruwuma?rev=1de0f493e8aab7e65ea78e3a079a3de10167c777#1de0f493e8aab7e65ea78e3a079a3de10167c777"
+source = "git+https://github.com/girlbossceo/ruwuma?rev=d7ddcd036f81edb257ab9371f9cadd46444e8a90#d7ddcd036f81edb257ab9371f9cadd46444e8a90"
 dependencies = [
 "js_int",
 "ruma-common",
@@ -3150,7 +3150,7 @@ dependencies = [
 [[package]]
 name = "ruma-server-util"
 version = "0.3.0"
-source = "git+https://github.com/girlbossceo/ruwuma?rev=1de0f493e8aab7e65ea78e3a079a3de10167c777#1de0f493e8aab7e65ea78e3a079a3de10167c777"
+source = "git+https://github.com/girlbossceo/ruwuma?rev=d7ddcd036f81edb257ab9371f9cadd46444e8a90#d7ddcd036f81edb257ab9371f9cadd46444e8a90"
 dependencies = [
 "headers",
 "http",
@@ -3163,7 +3163,7 @@ dependencies = [
 [[package]]
 name = "ruma-signatures"
 version = "0.15.0"
-source = "git+https://github.com/girlbossceo/ruwuma?rev=1de0f493e8aab7e65ea78e3a079a3de10167c777#1de0f493e8aab7e65ea78e3a079a3de10167c777"
+source = "git+https://github.com/girlbossceo/ruwuma?rev=d7ddcd036f81edb257ab9371f9cadd46444e8a90#d7ddcd036f81edb257ab9371f9cadd46444e8a90"
 dependencies = [
 "base64 0.22.1",
 "ed25519-dalek",
@@ -3179,7 +3179,7 @@ dependencies = [
 [[package]]
 name = "ruma-state-res"
 version = "0.11.0"
-source = "git+https://github.com/girlbossceo/ruwuma?rev=1de0f493e8aab7e65ea78e3a079a3de10167c777#1de0f493e8aab7e65ea78e3a079a3de10167c777"
+source = "git+https://github.com/girlbossceo/ruwuma?rev=d7ddcd036f81edb257ab9371f9cadd46444e8a90#d7ddcd036f81edb257ab9371f9cadd46444e8a90"
 dependencies = [
 "itertools 0.12.1",
 "js_int",
@@ -3560,22 +3560,22 @@ dependencies = [

 [[package]]
 name = "serde"
-version = "1.0.208"
+version = "1.0.209"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cff085d2cb684faa248efb494c39b68e522822ac0de72ccf08109abde717cfb2"
+checksum = "99fce0ffe7310761ca6bf9faf5115afbc19688edd00171d81b1bb1b116c63e09"
 dependencies = [
 "serde_derive",
 ]

 [[package]]
 name = "serde_derive"
-version = "1.0.208"
+version = "1.0.209"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "24008e81ff7613ed8e5ba0cfaf24e2c2f1e5b8a0495711e44fcd4882fca62bcf"
+checksum = "a5831b979fd7b5439637af1752d535ff49f4860c0f341d1baeb6faf0f4242170"
 dependencies = [
 "proc-macro2",
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 ]

 [[package]]
@@ -3869,9 +3869,9 @@ dependencies = [

 [[package]]
 name = "syn"
-version = "2.0.75"
+version = "2.0.76"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f6af063034fc1935ede7be0122941bafa9bacb949334d090b77ca98b5817c7d9"
+checksum = "578e081a14e0cefc3279b0472138c513f37b41a08d5a3cca9b6e4e8ceb6cd525"
 dependencies = [
 "proc-macro2",
 "quote",
@@ -3947,7 +3947,7 @@ checksum = "a4558b58466b9ad7ca0f102865eccc95938dca1a74a856f2b57b6629050da261"
 dependencies = [
 "proc-macro2",
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 ]

 [[package]]
@@ -4058,9 +4058,9 @@ checksum = "1f3ccbac311fea05f86f61904b462b55fb3df8837a366dfc601a0161d0532f20"

 [[package]]
 name = "tokio"
-version = "1.39.3"
+version = "1.40.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9babc99b9923bfa4804bd74722ff02c0381021eafa4db9949217e3be8e84fff5"
+checksum = "e2b070231665d27ad9ec9b8df639893f46727666c6767db40317fbe920a5d998"
 dependencies = [
 "backtrace",
 "bytes",
@@ -4082,7 +4082,7 @@ checksum = "693d596312e88961bc67d7f1f97af8a70227d9f90c31bba5806eec004978d752"
 dependencies = [
 "proc-macro2",
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 ]

 [[package]]
@@ -4306,7 +4306,7 @@ source = "git+https://github.com/girlbossceo/tracing?rev=4d78a14a5e03f539b8c6b47
 dependencies = [
 "proc-macro2",
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 ]

 [[package]]
@@ -4577,7 +4577,7 @@ dependencies = [
 "once_cell",
 "proc-macro2",
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 "wasm-bindgen-shared",
 ]

@@ -4611,7 +4611,7 @@ checksum = "afc340c74d9005395cf9dd098506f7f44e38f2b4a21c6aaacf9a105ea5e1e836"
 dependencies = [
 "proc-macro2",
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 "wasm-bindgen-backend",
 "wasm-bindgen-shared",
 ]
@@ -4976,7 +4976,7 @@ checksum = "fa4f8080344d4671fb4e831a13ad1e68092748387dfc4f55e356242fae12ce3e"
 dependencies = [
 "proc-macro2",
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 ]

 [[package]]
@@ -4996,7 +4996,7 @@ checksum = "ce36e65b0d2999d2aafac989fb249189a141aee1f53c612c1f37d72631959f69"
 dependencies = [
 "proc-macro2",
 "quote",
- "syn 2.0.75",
+ "syn 2.0.76",
 ]

 [[package]]
@@ -142,7 +142,7 @@ features = [
 ]

 [workspace.dependencies.serde]
-version = "1.0.204"
+version = "1.0.209"
 default-features = false
 features = ["rc"]

@@ -216,7 +216,7 @@ version = "0.3.30"
 default-features = false

 [workspace.dependencies.tokio]
-version = "1.39.2"
+version = "1.40.0"
 default-features = false
 features = [
 	"fs",
@@ -314,7 +314,7 @@ version = "0.1.2"
 [workspace.dependencies.ruma]
 git = "https://github.com/girlbossceo/ruwuma"
 #branch = "conduwuit-changes"
-rev = "1de0f493e8aab7e65ea78e3a079a3de10167c777"
+rev = "d7ddcd036f81edb257ab9371f9cadd46444e8a90"
 features = [
    "compat",
    "rand",
@@ -336,6 +336,8 @@ features = [
    "unstable-msc3026",
    "unstable-msc3061",
    "unstable-msc3266",
+    "unstable-msc3381", # polls
+    "unstable-msc3489", # beacon / live location
    "unstable-msc3575",
    "unstable-msc4121",
    "unstable-msc4125",
@@ -447,7 +449,7 @@ default-features = false
 version = "0.1"

 [workspace.dependencies.syn]
-version = "2.0.72"
+version = "2.0.76"
 default-features = false
 features = ["full", "extra-traits"]

@@ -1,14 +1,19 @@
 # conduwuit

-`main` / stable: [![CI and Artifacts](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml)
+`main`: [![CI and
+Artifacts](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml)

 <!-- ANCHOR: catchphrase -->
+
 ### a very cool, featureful fork of [Conduit](https://conduit.rs/)
+
 <!-- ANCHOR_END: catchphrase -->

-Visit the [Conduwuit documentation](https://conduwuit.puppyirl.gay/) for more information.
+Visit the [Conduwuit documentation](https://conduwuit.puppyirl.gay/) for more
+information.

 <!-- ANCHOR: body -->
+
 #### What is Matrix?

 [Matrix](https://matrix.org) is an open network for secure and decentralized
@@ -18,23 +23,28 @@ to communicate with users outside of Matrix, like a community on Discord.

 #### What is the goal?

-An efficient Matrix homeserver that's easy to set up and just works. You can install
-it on a mini-computer like the Raspberry Pi to host Matrix for your family,
-friends or company.
+An efficient Matrix homeserver that's easy to set up and just works. You can
+install it on a mini-computer like the Raspberry Pi to host Matrix for your
+family, friends or company.

 #### Can I try it out?

-An official conduwuit server ran by me is available at transfem.dev ([element.transfem.dev](https://element.transfem.dev) / [cinny.transfem.dev](https://cinny.transfem.dev))
+An official conduwuit server ran by me is available at transfem.dev
+([element.transfem.dev](https://element.transfem.dev) /
+[cinny.transfem.dev](https://cinny.transfem.dev))

-transfem.dev is a public homeserver that can be used, it is not a "test only homeserver". This means there are rules, so please read the rules: [https://transfem.dev/homeserver_rules.txt](https://transfem.dev/homeserver_rules.txt)
+transfem.dev is a public homeserver that can be used, it is not a "test only
+homeserver". This means there are rules, so please read the rules:
+[https://transfem.dev/homeserver_rules.txt](https://transfem.dev/homeserver_rules.txt)

-transfem.dev is also listed at [servers.joinmatrix.org](https://servers.joinmatrix.org/)
+transfem.dev is also listed at
+[servers.joinmatrix.org](https://servers.joinmatrix.org/)

 #### What is the current status?

-conduwuit is a hard fork of Conduit which is in beta, meaning you can join and participate in most
-Matrix rooms, but not all features are supported and you might run into bugs
-from time to time.
+conduwuit is a hard fork of Conduit which is in beta, meaning you can join and
+participate in most Matrix rooms, but not all features are supported and you
+might run into bugs from time to time.

 <!-- ANCHOR_END: body -->

@@ -55,7 +65,9 @@ If you run into any question, feel free to

 #### Logo

-Original repo and Matrix room picture was from bran (<3). Current banner image and logo is directly from [this cohost post](https://cohost.org/RatBaby/post/1028290-finally-a-flag-for).
+Original repo and Matrix room picture was from bran (<3). Current banner image
+and logo is directly from [this cohost
+post](https://cohost.org/RatBaby/post/1028290-finally-a-flag-for).

 #### Is it conduwuit or Conduwuit?

@@ -69,4 +81,5 @@ Both, but I prefer conduwuit.
 - git.gay: <https://git.gay/june/conduwuit>
 - Codeberg: <https://codeberg.org/girlbossceo/conduwuit>
 - sourcehut: <https://git.sr.ht/~girlbossceo/conduwuit>
+
 <!-- ANCHOR_END: footer -->
@@ -68,6 +68,10 @@
 # only effective in release-mode; forced to false in debug-mode.
 #sentry_send_error = true

+# Controls the tracing log level for Sentry to send things like breadcrumbs and transactions
+# Defaults to "info"
+#sentry_filter = "info"
+

 ### Database configuration

@@ -160,6 +164,19 @@ ip_range_denylist = [

 ### Moderation / Privacy / Security

+# Config option to control whether the legacy unauthenticated Matrix media repository endpoints will be enabled.
+# These endpoints consist of:
+# - /_matrix/media/*/config
+# - /_matrix/media/*/upload
+# - /_matrix/media/*/preview_url
+# - /_matrix/media/*/download/*
+# - /_matrix/media/*/thumbnail/*
+#
+# The authenticated equivalent endpoints are always enabled.
+#
+# Defaults to true for now, but this is highly subject to change, likely in the next release.
+#allow_legacy_media = true
+
 # Set to true to allow user type "guest" registrations. Element attempts to register guest users automatically.
 # Defaults to false
 allow_guest_registration = false
@@ -207,11 +224,6 @@ registration_token = "change this token for something specific to your server"
 # defaults to false
 # block_non_admin_invites = false

-# Allows admins to enter commands in rooms other than #admins by prefixing with \!admin. The reply
-# will be publicly visible to the room, originating from the sender.
-# defaults to true
-#admin_escape_commands = true
-
 # List of forbidden username patterns/strings. Values in this list are matched as *contains*.
 # This is checked upon username availability check, registration, and startup as warnings if any local users in your database
 # have a forbidden username.
@@ -305,6 +317,41 @@ allow_profile_lookup_federation_requests = true
 #auto_deactivate_banned_room_attempts = false


+### Admin Room and Console
+
+# Controls whether the conduwuit admin room console / CLI will immediately activate on startup.
+# This option can also be enabled with `--console` conduwuit argument
+#
+# Defaults to false
+#admin_console_automatic = false
+
+# Controls what admin commands will be executed on startup. This is a vector list of strings of admin commands to run.
+#
+# An example of this can be: `admin_execute = ["debug ping puppygock.gay", "debug echo hi"]`
+#
+# This option can also be configured with the `--execute` conduwuit argument and can take standard shell commands and environment variables
+#
+# Such example could be: `./conduwuit --execute "server admin-notice conduwuit has started up at $(date)"`
+#
+# Defaults to nothing.
+#admin_execute = [""]
+
+# Controls whether conduwuit should error and fail to start if an admin execute command (`--execute` / `admin_execute`) fails
+#
+# Defaults to false
+#admin_execute_errors_ignore = false
+
+# Controls the max log level for admin command log captures (logs generated from running admin commands)
+#
+# Defaults to "info" on release builds, else "debug" on debug builds
+#admin_log_capture = info
+
+# Allows admins to enter commands in rooms other than #admins by prefixing with \!admin. The reply
+# will be publicly visible to the room, originating from the sender.
+# defaults to true
+#admin_escape_commands = true
+
+
 ### Misc

 # max log level for conduwuit. allows debug, info, warn, or error
@@ -2,13 +2,15 @@

 ## Getting help

-If you run into any problems while setting up an Appservice: ask us in [#conduwuit:puppygock.gay](https://matrix.to/#/#conduwuit:puppygock.gay) or [open an issue on GitHub](https://github.com/girlbossceo/conduwuit/issues/new).
+If you run into any problems while setting up an Appservice: ask us in
+[#conduwuit:puppygock.gay](https://matrix.to/#/#conduwuit:puppygock.gay) or
+[open an issue on GitHub](https://github.com/girlbossceo/conduwuit/issues/new).

 ## Set up the appservice - general instructions

 Follow whatever instructions are given by the appservice. This usually includes
-downloading, changing its config (setting domain, homeserver url, port etc.)
-and later starting it.
+downloading, changing its config (setting domain, homeserver url, port etc.) and
+later starting it.

 At some point the appservice guide should ask you to add a registration yaml
 file to the homeserver. In Synapse you would do this by adding the path to the
@@ -1,76 +1,93 @@
 # conduwuit Community Code of Conduct

-Welcome to the conduwuit community! We’re excited to have you here. conduwuit is a hard-fork of the Conduit homeserver,
-aimed at making Matrix more accessible and inclusive for everyone.
+Welcome to the conduwuit community! We’re excited to have you here. conduwuit is
+a hard-fork of the Conduit homeserver, aimed at making Matrix more accessible
+and inclusive for everyone.

-This space is dedicated to fostering a positive, supportive, and inclusive environment for everyone. This Code of
-Conduct applies to all conduwuit spaces, including any further community rooms that reference this CoC. Here are our
+This space is dedicated to fostering a positive, supportive, and inclusive
+environment for everyone. This Code of Conduct applies to all conduwuit spaces,
+including any further community rooms that reference this CoC. Here are our
 guidelines to help maintain the welcoming atmosphere that sets conduwuit apart.

-For the general foundational rules, please refer to the [Contributor's Covenant](https://github.com/girlbossceo/conduwuit/blob/main/CODE_OF_CONDUCT.md).
+For the general foundational rules, please refer to the [Contributor's
+Covenant](https://github.com/girlbossceo/conduwuit/blob/main/CODE_OF_CONDUCT.md).
 Below are additional guidelines specific to the conduwuit community.

 ## Our Values and Guidelines

-1. **Respect and Inclusivity**: We are committed to maintaining a community where everyone feels safe and respected.
-   Discrimination, harassment, or hate speech of any kind will not be tolerated. Recognise that each community member
-   experiences the world differently based on their past experiences, background, and identity. Share your own
-   experiences and be open to learning about others' diverse perspectives.
+1. **Respect and Inclusivity**: We are committed to maintaining a community
+   where everyone feels safe and respected. Discrimination, harassment, or hate
+speech of any kind will not be tolerated. Recognise that each community member
+experiences the world differently based on their past experiences, background,
+and identity. Share your own experiences and be open to learning about others'
+diverse perspectives.

-2. **Positivity and Constructiveness**: Engage in constructive discussions and support each other. If you feel angry,
-   negative, or aggressive, take a break until you can participate in a positive and constructive manner. Process
-   intense feelings with a friend or in a private setting before engaging in community conversations to help maintain
-   a supportive and focused environment.
+2. **Positivity and Constructiveness**: Engage in constructive discussions and
+   support each other. If you feel angry, negative, or aggressive, take a break
+until you can participate in a positive and constructive manner. Process intense
+feelings with a friend or in a private setting before engaging in community
+conversations to help maintain a supportive and focused environment.

-3. **Clarity and Understanding**: Our community includes neurodivergent individuals and those who may not appreciate
-   sarcasm or subtlety. Communicate clearly and kindly, avoiding sarcasm and ensuring your messages are easily
-   understood by all. Additionally, avoid putting the burden of education on marginalized groups by doing your own
-   research before asking for explanations.
+3. **Clarity and Understanding**: Our community includes neurodivergent
+   individuals and those who may not appreciate sarcasm or subtlety. Communicate
+clearly and kindly, avoiding sarcasm and ensuring your messages are easily
+understood by all. Additionally, avoid putting the burden of education on
+marginalized groups by doing your own research before asking for explanations.

-4. **Be Open to Inclusivity**: Actively engage in conversations about making our community more inclusive. Report
-   discriminatory behavior to the moderators and be open to constructive feedback that aims to improve our community.
-   Understand that discussing discrimination and negative experiences can be emotionally taxing, so focus on the
-   message rather than critiquing the tone used.
+4. **Be Open to Inclusivity**: Actively engage in conversations about making our
+   community more inclusive. Report discriminatory behavior to the moderators
+and be open to constructive feedback that aims to improve our community.
+Understand that discussing discrimination and negative experiences can be
+emotionally taxing, so focus on the message rather than critiquing the tone
+used.

-5. **Commit to Inclusivity**: Building an inclusive community requires time, energy, and resources. Recognise that
-   addressing discrimination and bias is an ongoing process that necessitates commitment and action from all community
-   members.
+5. **Commit to Inclusivity**: Building an inclusive community requires time,
+   energy, and resources. Recognise that addressing discrimination and bias is
+an ongoing process that necessitates commitment and action from all community
+members.

 ## Matrix Community

-This Code of Conduct applies to the entire [conduwuit Matrix Space](https://matrix.to/#/#conduwuit-space:puppygock.gay)
-and its rooms, including:
+This Code of Conduct applies to the entire [conduwuit Matrix
+Space](https://matrix.to/#/#conduwuit-space:puppygock.gay) and its rooms,
+including:

 ### [#conduwuit:puppygock.gay](https://matrix.to/#/#conduwuit:puppygock.gay)

-This room is for support and discussions about conduwuit. Ask questions, share insights, and help each other out.
+This room is for support and discussions about conduwuit. Ask questions, share
+insights, and help each other out.

 ### [#conduwuit-offtopic:girlboss.ceo](https://matrix.to/#/#conduwuit-offtopic:girlboss.ceo)

-For off-topic community conversations about any subject. While this room allows for a wide range of topics, the same
-CoC applies. Keep discussions respectful and inclusive, and avoid divisive subjects like country/world politics.
-General topics, such as world events, are welcome as long as they follow the CoC.
+For off-topic community conversations about any subject. While this room allows
+for a wide range of topics, the same CoC applies. Keep discussions respectful
+and inclusive, and avoid divisive subjects like country/world politics. General
+topics, such as world events, are welcome as long as they follow the CoC.

 ### [#conduwuit-dev:puppygock.gay](https://matrix.to/#/#conduwuit-dev:puppygock.gay)

-This room is dedicated to discussing active development of conduwuit. Posting requires an elevated power level, which
-can be requested in one of the other rooms. Use this space to collaborate and innovate.
+This room is dedicated to discussing active development of conduwuit. Posting
+requires an elevated power level, which can be requested in one of the other
+rooms. Use this space to collaborate and innovate.

 ## Enforcement

-We have a zero-tolerance policy for violations of this Code of Conduct. If someone’s behavior makes you uncomfortable,
-please report it to the moderators. Actions we may take include:
+We have a zero-tolerance policy for violations of this Code of Conduct. If
+someone’s behavior makes you uncomfortable, please report it to the moderators.
+Actions we may take include:

-1. **Warning**: A warning given directly in the room or via a private message from the moderators, identifying
-   the violation and requesting corrective action.
-2. **Temporary Mute**: Temporary restriction from participating in discussions for a specified period to allow for
-   reflection and cooling off.
-3. **Kick or Ban**: Egregious behavior may result in an immediate kick or ban to protect other community members.
-   Bans are considered permanent and will only be reversed in exceptional circumstances after proven good behavior.
+1. **Warning**: A warning given directly in the room or via a private message
+   from the moderators, identifying the violation and requesting corrective
+action.
+2. **Temporary Mute**: Temporary restriction from participating in discussions
+   for a specified period to allow for reflection and cooling off.
+3. **Kick or Ban**: Egregious behavior may result in an immediate kick or ban to
+   protect other community members. Bans are considered permanent and will only
+be reversed in exceptional circumstances after proven good behavior.

-Please highlight issues directly in rooms when possible, but if you don't feel comfortable doing that, then please send
-a DM to one of the moderators directly.
+Please highlight issues directly in rooms when possible, but if you don't feel
+comfortable doing that, then please send a DM to one of the moderators directly.

 Together, let’s build a community where everyone feels valued and respected.

- The conduwuit Moderation Team
+— The conduwuit Moderation Team
@@ -4,35 +4,61 @@ This chapter describes various ways to configure conduwuit.

 ## Basics

-conduwuit uses a config file for the majority of the settings, but also supports setting individual config options via commandline.
+conduwuit uses a config file for the majority of the settings, but also supports
+setting individual config options via commandline.

-Please refer to the [example config file](./configuration/examples.md#example-configuration) for all of those settings.
+Please refer to the [example config
+file](./configuration/examples.md#example-configuration) for all of those
+settings.

-The config file to use can be specified on the commandline when running conduwuit by specifying the
-`-c`, `--config` flag. Alternatively, you can use the environment variable `CONDUWUIT_CONFIG` to specify the config
-file to used. Conduit's environment variables are supported for backwards compatibility.
+The config file to use can be specified on the commandline when running
+conduwuit by specifying the `-c`, `--config` flag. Alternatively, you can use
+the environment variable `CONDUWUIT_CONFIG` to specify the config file to used.
+Conduit's environment variables are supported for backwards compatibility.

 ## Option commandline flag

-conduwuit supports setting individual config options in TOML format from the `-O` / `--option` flag. For example, you can set your server name via `-O server_name=\"example.com\"`.
+conduwuit supports setting individual config options in TOML format from the
+`-O` / `--option` flag. For example, you can set your server name via `-O
+server_name=\"example.com\"`.

-Note that the config is parsed as TOML, and shells like bash will remove quotes. So unfortunately it is required to escape quotes if the config option takes a string.
-This does not apply to options that take booleans or numbers:
+Note that the config is parsed as TOML, and shells like bash will remove quotes.
+So unfortunately it is required to escape quotes if the config option takes a
+string. This does not apply to options that take booleans or numbers:
 - `--option allow_registration=true` works ✅
 - `-O max_request_size=99999999` works ✅
 - `-O server_name=example.com` does not work ❌
 - `--option log=\"debug\"` works ✅
 - `--option server_name='"example.com'"` works ✅

+## Execute commandline flag
+
+conduwuit supports running admin commands on startup using the commandline
+argument `--execute`. The most notable use for this is to create an admin user
+on first startup.
+
+The syntax of this is a standard admin command without the prefix such as
+`./conduwuit --execute "users create_user june"`
+
+An example output of a success is:
+```
+INFO conduit_service::admin::startup: Startup command #0 completed:
+Created user with user_id: @june:girlboss.ceo and password: `<redacted>`
+```
+
+This commandline argument can be paired with the `--option` flag.

 ## Environment variables

-All of the settings that are found in the config file can be specified by using environment variables.
-The environment variable names should be all caps and prefixed with `CONDUWUIT_`.
+All of the settings that are found in the config file can be specified by using
+environment variables. The environment variable names should be all caps and
+prefixed with `CONDUWUIT_`.

-For example, if the setting you are changing is `max_request_size`, then the environment variable to set is
-`CONDUWUIT_MAX_REQUEST_SIZE`.
+For example, if the setting you are changing is `max_request_size`, then the
+environment variable to set is `CONDUWUIT_MAX_REQUEST_SIZE`.

-To modify config options not in the `[global]` context such as `[global.well_known]`, use the `__` suffix split: `CONDUWUIT_WELL_KNOWN__SERVER`
+To modify config options not in the `[global]` context such as
+`[global.well_known]`, use the `__` suffix split: `CONDUWUIT_WELL_KNOWN__SERVER`

-Conduit's environment variables are supported for backwards compatibility (e.g. `CONDUIT_SERVER_NAME`).
+Conduit's environment variables are supported for backwards compatibility (e.g.
+`CONDUIT_SERVER_NAME`).
@@ -2,8 +2,14 @@

 Currently conduwuit is only on the Arch User Repository (AUR).

-The conduwuit AUR packages are community maintained and are not maintained by conduwuit development team, but the AUR package maintainers are in the Matrix room. Please attempt to verify your AUR package's PKGBUILD file looks fine before asking for support.
+The conduwuit AUR packages are community maintained and are not maintained by
+conduwuit development team, but the AUR package maintainers are in the Matrix
+room. Please attempt to verify your AUR package's PKGBUILD file looks fine
+before asking for support.

- [conduwuit](https://aur.archlinux.org/packages/conduwuit) - latest tagged conduwuit
- [conduwuit-git](https://aur.archlinux.org/packages/conduwuit-git) - latest git conduwuit from `main` branch
- [conduwuit-bin](https://aur.archlinux.org/packages/conduwuit-bin) - latest tagged conduwuit static binary
+- [conduwuit](https://aur.archlinux.org/packages/conduwuit) - latest tagged
+conduwuit
+- [conduwuit-git](https://aur.archlinux.org/packages/conduwuit-git) - latest git
+conduwuit from `main` branch
+- [conduwuit-bin](https://aur.archlinux.org/packages/conduwuit-bin) - latest
+tagged conduwuit static binary
@@ -1,40 +1,44 @@
 # conduwuit - Behind Traefik Reverse Proxy

 services:
-    homeserver:
-        ### If you already built the conduduwit image with 'docker build' or want to use the Docker Hub image,
-        ### then you are ready to go.
-        image: girlbossceo/conduwuit:latest
-        restart: unless-stopped
-        volumes:
-            - db:/var/lib/conduwuit
-            #- ./conduwuit.toml:/etc/conduwuit.toml
-        networks:
-            - proxy
-        environment:
-            CONDUWUIT_SERVER_NAME: your.server.name # EDIT THIS
-            CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit
-            CONDUWUIT_DATABASE_BACKEND: rocksdb
-            CONDUWUIT_PORT: 6167
-            CONDUWUIT_MAX_REQUEST_SIZE: 20_000_000 # in bytes, ~20 MB
-            CONDUWUIT_ALLOW_REGISTRATION: 'true'
-            CONDUWUIT_ALLOW_FEDERATION: 'true'
-            CONDUWUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
-            CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
-            #CONDUWUIT_LOG: warn,state_res=warn
-            CONDUWUIT_ADDRESS: 0.0.0.0
-            #CONDUWUIT_CONFIG: '/etc/conduwuit.toml' # Uncomment if you mapped config toml above
-        #cpuset: "0-4" # Uncomment to limit to specific CPU cores
+  homeserver:
+    ### If you already built the conduduwit image with 'docker build' or want to use the Docker Hub image,
+    ### then you are ready to go.
+    image: girlbossceo/conduwuit:latest
+    restart: unless-stopped
+    volumes:
+      - db:/var/lib/conduwuit
+      #- ./conduwuit.toml:/etc/conduwuit.toml
+    networks:
+      - proxy
+    environment:
+      CONDUWUIT_SERVER_NAME: your.server.name.example # EDIT THIS
+      CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit
+      CONDUWUIT_DATABASE_BACKEND: rocksdb
+      CONDUWUIT_PORT: 6167 # should match the loadbalancer traefik label
+      CONDUWUIT_MAX_REQUEST_SIZE: 20_000_000 # in bytes, ~20 MB
+      CONDUWUIT_ALLOW_REGISTRATION: 'true'
+      CONDUWUIT_ALLOW_FEDERATION: 'true'
+      CONDUWUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
+      CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
+      #CONDUWUIT_LOG: warn,state_res=warn
+      CONDUWUIT_ADDRESS: 0.0.0.0
+      #CONDUWUIT_CONFIG: '/etc/conduwuit.toml' # Uncomment if you mapped config toml above
+
+      # We need some way to serve the client and server .well-known json. The simplest way is via the CONDUWUIT_WELL_KNOWN
+      # variable / config option, there are multiple ways to do this, e.g. in the conduwuit.toml file, and in a seperate
+      # see the override file for more information about delegation
+      CONDUWUIT_WELL_KNOWN: |
+        {
+        client=https://your.server.name.example,
+        server=your.server.name.example:443
+        }
+    #cpuset: "0-4" # Uncomment to limit to specific CPU cores
+    ulimits: # conduwuit uses quite a few file descriptors, and on some systems it defaults to 1024, so you can tell docker to increase it
+      nofile:
+        soft: 1048567
+        hard: 1048567

-    # We need some way to server the client and server .well-known json. The simplest way is to use a nginx container
-    # to serve those two as static files. If you want to use a different way, delete or comment the below service, here
-    # and in the docker compose override file.
-    well-known:
-        image: nginx:latest
-        restart: unless-stopped
-        volumes:
-            - ./nginx/matrix.conf:/etc/nginx/conf.d/matrix.conf # the config to serve the .well-known/matrix files
-            - ./nginx/www:/var/www/ # location of the client and server .well-known-files
    ### Uncomment if you want to use your own Element-Web App.
    ### Note: You need to provide a config.json for Element and you also need a second
    ###       Domain or Subdomain for the communication between Element and conduwuit
@@ -50,10 +54,12 @@ services:
    #         - homeserver

 volumes:
-    db:
+  db:

 networks:
-    # This is the network Traefik listens to, if your network has a different
-    # name, don't forget to change it here and in the docker-compose.override.yml
-    proxy:
-        external: true
+  # This is the network Traefik listens to, if your network has a different
+  # name, don't forget to change it here and in the docker-compose.override.yml
+  proxy:
+    external: true
+
+# vim: ts=2:sw=2:expandtab
@@ -1,44 +1,37 @@
 # conduwuit - Traefik Reverse Proxy Labels

 services:
-    homeserver:
-        labels:
-            - "traefik.enable=true"
-            - "traefik.docker.network=proxy"  # Change this to the name of your Traefik docker proxy network
+  homeserver:
+    labels:
+      - "traefik.enable=true"
+      - "traefik.docker.network=proxy"  # Change this to the name of your Traefik docker proxy network

-            - "traefik.http.routers.to-conduwuit.rule=Host(`<SUBDOMAIN>.<DOMAIN>`)"  # Change to the address on which conduwuit is hosted
-            - "traefik.http.routers.to-conduwuit.tls=true"
-            - "traefik.http.routers.to-conduwuit.tls.certresolver=letsencrypt"
-            - "traefik.http.routers.to-conduwuit.middlewares=cors-headers@docker"
+      - "traefik.http.routers.to-conduwuit.rule=Host(`<SUBDOMAIN>.<DOMAIN>`)"  # Change to the address on which conduwuit is hosted
+      - "traefik.http.routers.to-conduwuit.tls=true"
+      - "traefik.http.routers.to-conduwuit.tls.certresolver=letsencrypt"
+      - "traefik.http.routers.to-conduwuit.middlewares=cors-headers@docker"
+      - "traefik.http.services.to_conduwuit.loadbalancer.server.port=6167"

-            - "traefik.http.middlewares.cors-headers.headers.accessControlAllowOriginList=*"
-            - "traefik.http.middlewares.cors-headers.headers.accessControlAllowHeaders=Origin, X-Requested-With, Content-Type, Accept, Authorization"
-            - "traefik.http.middlewares.cors-headers.headers.accessControlAllowMethods=GET, POST, PUT, DELETE, OPTIONS"
+      - "traefik.http.middlewares.cors-headers.headers.accessControlAllowOriginList=*"
+      - "traefik.http.middlewares.cors-headers.headers.accessControlAllowHeaders=Origin, X-Requested-With, Content-Type, Accept, Authorization"
+      - "traefik.http.middlewares.cors-headers.headers.accessControlAllowMethods=GET, POST, PUT, DELETE, OPTIONS"

-    # We need some way to server the client and server .well-known json. The simplest way is to use a nginx container
-    # to serve those two as static files. If you want to use a different way, delete or comment the below service, here
-    # and in the docker compose file.
-    well-known:
-        labels:
-            - "traefik.enable=true"
-            - "traefik.docker.network=proxy"
+      # If you want to have your account on <DOMAIN>, but host conduwuit on a subdomain,
+      # you can let it only handle the well known file on that domain instead
+      #- "traefik.http.routers.to-matrix-wellknown.rule=Host(`<DOMAIN>`) && PathPrefix(`/.well-known/matrix`)"
+      #- "traefik.http.routers.to-matrix-wellknown.tls=true"
+      #- "traefik.http.routers.to-matrix-wellknown.tls.certresolver=letsencrypt"
+      #- "traefik.http.routers.to-matrix-wellknown.middlewares=cors-headers@docker"

-            - "traefik.http.routers.to-matrix-wellknown.rule=Host(`<SUBDOMAIN>.<DOMAIN>`) && PathPrefix(`/.well-known/matrix`)"
-            - "traefik.http.routers.to-matrix-wellknown.tls=true"
-            - "traefik.http.routers.to-matrix-wellknown.tls.certresolver=letsencrypt"
-            - "traefik.http.routers.to-matrix-wellknown.middlewares=cors-headers@docker"
+  ### Uncomment this if you uncommented Element-Web App in the docker-compose.yml
+  # element-web:
+  #     labels:
+  #         - "traefik.enable=true"
+  #         - "traefik.docker.network=proxy"  # Change this to the name of your Traefik docker proxy network

-            - "traefik.http.middlewares.cors-headers.headers.accessControlAllowOriginList=*"
-            - "traefik.http.middlewares.cors-headers.headers.accessControlAllowHeaders=Origin, X-Requested-With, Content-Type, Accept, Authorization"
-            - "traefik.http.middlewares.cors-headers.headers.accessControlAllowMethods=GET, POST, PUT, DELETE, OPTIONS"
+  #         - "traefik.http.routers.to-element-web.rule=Host(`<SUBDOMAIN>.<DOMAIN>`)"  # Change to the address on which Element-Web is hosted
+  #         - "traefik.http.routers.to-element-web.tls=true"
+  #         - "traefik.http.routers.to-element-web.tls.certresolver=letsencrypt"

+# vim: ts=2:sw=2:expandtab

-    ### Uncomment this if you uncommented Element-Web App in the docker-compose.yml
-    # element-web:
-    #     labels:
-    #         - "traefik.enable=true"
-    #         - "traefik.docker.network=proxy"  # Change this to the name of your Traefik docker proxy network
-
-    #         - "traefik.http.routers.to-element-web.rule=Host(`<SUBDOMAIN>.<DOMAIN>`)"  # Change to the address on which Element-Web is hosted
-    #         - "traefik.http.routers.to-element-web.tls=true"
-    #         - "traefik.http.routers.to-element-web.tls.certresolver=letsencrypt"
@@ -1,42 +1,52 @@
 # conduwuit - Behind Traefik Reverse Proxy

 services:
-    homeserver:
-        ### If you already built the conduwuit image with 'docker build' or want to use the Docker Hub image,
-        ### then you are ready to go.
-        image: girlbossceo/conduwuit:latest
-        restart: unless-stopped
-        volumes:
-            - db:/srv/conduwuit/.local/share/conduwuit
-            #- ./conduwuit.toml:/etc/conduwuit.toml
-        networks:
-            - proxy
-        environment:
-            CONDUWUIT_SERVER_NAME: your.server.name # EDIT THIS
-            CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
-            CONDUWUIT_ALLOW_REGISTRATION : 'true'
-            #CONDUWUIT_CONFIG: '/etc/conduwuit.toml' # Uncomment if you mapped config toml above
-            ### Uncomment and change values as desired
-            # CONDUWUIT_ADDRESS: 0.0.0.0
-            # CONDUWUIT_PORT: 6167
-            # CONDUWUIT_LOG: info  # default is: "warn,state_res=warn"
-            # CONDUWUIT_ALLOW_JAEGER: 'false'
-            # CONDUWUIT_ALLOW_ENCRYPTION: 'true'
-            # CONDUWUIT_ALLOW_FEDERATION: 'true'
-            # CONDUWUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
-            # CONDUWUIT_DATABASE_PATH: /srv/conduwuit/.local/share/conduwuit
-            # CONDUWUIT_WORKERS: 10
-            # CONDUWUIT_MAX_REQUEST_SIZE: 20000000  # in bytes, ~20 MB
+  homeserver:
+    ### If you already built the conduwuit image with 'docker build' or want to use the Docker Hub image,
+    ### then you are ready to go.
+    image: girlbossceo/conduwuit:latest
+    restart: unless-stopped
+    volumes:
+      - db:/var/lib/conduwuit
+      #- ./conduwuit.toml:/etc/conduwuit.toml
+    networks:
+      - proxy
+    environment:
+      CONDUWUIT_SERVER_NAME: your.server.name.example # EDIT THIS
+      CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
+      CONDUWUIT_ALLOW_REGISTRATION: 'false' # After setting a secure registration token, you can enable this
+      CONDUWUIT_REGISTRATION_TOKEN: # This is a token you can use to register on the server
+      CONDUWUIT_ADDRESS: 0.0.0.0
+      CONDUWUIT_PORT: 6167 # you need to match this with the traefik load balancer label if you're want to change it
+      CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit
+      #CONDUWUIT_CONFIG: '/etc/conduit.toml' # Uncomment if you mapped config toml above
+      ### Uncomment and change values as desired, note that conduwuit has plenty of config options, so you should check out the example example config too
+      # Available levels are: error, warn, info, debug, trace - more info at: https://docs.rs/env_logger/*/env_logger/#enabling-logging
+      # CONDUWUIT_LOG: info  # default is: "warn,state_res=warn"
+      # CONDUWUIT_ALLOW_JAEGER: 'false'
+      # CONDUWUIT_ALLOW_ENCRYPTION: 'true'
+      # CONDUWUIT_ALLOW_FEDERATION: 'true'
+      # CONDUWUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
+      # CONDUWUIT_ALLOW_INCOMING_PRESENCE: true
+      # CONDUWUIT_ALLOW_OUTGOING_PRESENCE: true
+      # CONDUWUIT_ALLOW_LOCAL_PRESENCE: true
+      # CONDUWUIT_WORKERS: 10
+      # CONDUWUIT_MAX_REQUEST_SIZE: 20_000_000  # in bytes, ~20 MB
+      # CONDUWUIT_NEW_USER_DISPLAYNAME_SUFFIX = "🏳<200d>⚧"

-    # We need some way to server the client and server .well-known json. The simplest way is to use a nginx container
-    # to serve those two as static files. If you want to use a different way, delete or comment the below service, here
-    # and in the docker compose override file.
-    well-known:
-        image: nginx:latest
-        restart: unless-stopped
-        volumes:
-            - ./nginx/matrix.conf:/etc/nginx/conf.d/matrix.conf # the config to serve the .well-known/matrix files
-            - ./nginx/www:/var/www/ # location of the client and server .well-known-files
+      # We need some way to serve the client and server .well-known json. The simplest way is via the CONDUWUIT_WELL_KNOWN
+      # variable / config option, there are multiple ways to do this, e.g. in the conduwuit.toml file, and in a seperate
+      # reverse proxy, but since you do not have a reverse proxy and following this guide, this example is included
+      CONDUWUIT_WELL_KNOWN: |
+        {
+          client=https://your.server.name.example,
+          server=your.server.name.example:443
+        }
+    #cpuset: "0-4" # Uncomment to limit to specific CPU cores
+    ulimits: # conduwuit uses quite a few file descriptors, and on some systems it defaults to 1024, so you can tell docker to increase it
+      nofile:
+        soft: 1048567
+        hard: 1048567

    ### Uncomment if you want to use your own Element-Web App.
    ### Note: You need to provide a config.json for Element and you also need a second
@@ -52,29 +62,79 @@ services:
    #     depends_on:
    #         - homeserver

-    traefik:
-        image: "traefik:latest"
-        container_name: "traefik"
-        restart: "unless-stopped"
-        ports:
-            - "80:80"
-            - "443:443"
-        volumes:
-            - "/var/run/docker.sock:/var/run/docker.sock"
-            # - "./traefik_config:/etc/traefik"
-            - "acme:/etc/traefik/acme"
-        labels:
-            - "traefik.enable=true"
+  traefik:
+    image: "traefik:latest"
+    container_name: "traefik"
+    restart: "unless-stopped"
+    ports:
+      - "80:80"
+      - "443:443"
+    volumes:
+      - "/var/run/docker.sock:/var/run/docker.sock:z"
+      - "acme:/etc/traefik/acme"
+      #- "./traefik_config:/etc/traefik:z"
+    labels:
+      - "traefik.enable=true"

-            # middleware redirect
-            - "traefik.http.middlewares.redirect-to-https.redirectscheme.scheme=https"
-            # global redirect to https
-            - "traefik.http.routers.redirs.rule=hostregexp(`{host:.+}`)"
-            - "traefik.http.routers.redirs.entrypoints=http"
-            - "traefik.http.routers.redirs.middlewares=redirect-to-https"
+      # middleware redirect
+      - "traefik.http.middlewares.redirect-to-https.redirectscheme.scheme=https"
+      # global redirect to https
+      - "traefik.http.routers.redirs.rule=hostregexp(`{host:.+}`)"
+      - "traefik.http.routers.redirs.entrypoints=web"
+      - "traefik.http.routers.redirs.middlewares=redirect-to-https"

-        networks:
-            - proxy
+    configs:
+      - source: dynamic.yml
+        target: /etc/traefik/dynamic.yml
+
+    environment:
+      TRAEFIK_LOG_LEVEL: DEBUG
+      TRAEFIK_ENTRYPOINTS_WEB: true
+      TRAEFIK_ENTRYPOINTS_WEB_ADDRESS: ":80"
+      TRAEFIK_ENTRYPOINTS_WEB_HTTP_REDIRECTIONS_ENTRYPOINT_TO: websecure
+
+      TRAEFIK_ENTRYPOINTS_WEBSECURE: true
+      TRAEFIK_ENTRYPOINTS_WEBSECURE_ADDRESS: ":443"
+      TRAEFIK_ENTRYPOINTS_WEBSECURE_HTTP_TLS_CERTRESOLVER: letsencrypt
+      #TRAEFIK_ENTRYPOINTS_WEBSECURE_HTTP_MIDDLEWARES: secureHeaders@file # if you want to enabled STS
+
+      TRAEFIK_CERTIFICATESRESOLVERS_LETSENCRYPT: true
+      TRAEFIK_CERTIFICATESRESOLVERS_LETSENCRYPT_ACME_EMAIL: # Set this to the email you want to receive certificate expiration emails for
+      TRAEFIK_CERTIFICATESRESOLVERS_LETSENCRYPT_ACME_KEYTYPE: EC384
+      TRAEFIK_CERTIFICATESRESOLVERS_LETSENCRYPT_ACME_HTTPCHALLENGE: true
+      TRAEFIK_CERTIFICATESRESOLVERS_LETSENCRYPT_ACME_HTTPCHALLENGE_ENTRYPOINT: web
+      TRAEFIK_CERTIFICATESRESOLVERS_LETSENCRYPT_ACME_STORAGE: "/etc/traefik/acme/acme.json"
+
+      TRAEFIK_PROVIDERS_DOCKER: true
+      TRAEFIK_PROVIDERS_DOCKER_ENDPOINT: "unix:///var/run/docker.sock"
+      TRAEFIK_PROVIDERS_DOCKER_EXPOSEDBYDEFAULT: false
+
+      TRAEFIK_PROVIDERS_FILE: true
+      TRAEFIK_PROVIDERS_FILE_FILENAME: "/etc/traefik/dynamic.yml"
+
+configs:
+  dynamic.yml:
+    content: |
+      # Optionally set STS headers, like in https://hstspreload.org
+      # http:
+      #   middlewares:
+      #     secureHeaders:
+      #       headers:
+      #         forceSTSHeader: true
+      #         stsIncludeSubdomains: true
+      #         stsPreload: true
+      #         stsSeconds: 31536000
+      tls:
+        options:
+          default:
+            cipherSuites:
+              - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
+              - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
+              - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
+              - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
+              - TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305
+              - TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305
+            minVersion: VersionTLS12

 volumes:
    db:
@@ -82,3 +142,5 @@ volumes:

 networks:
    proxy:
+
+# vim: ts=2:sw=2:expandtab
@@ -2,7 +2,8 @@

 ## Docker

-To run conduwuit with Docker you can either build the image yourself or pull it from a registry.
+To run conduwuit with Docker you can either build the image yourself or pull it
+from a registry.

 ### Use a registry

@@ -26,7 +27,7 @@ OCI images for conduwuit are available in the registries listed below.
 Use

 ```bash
-docker image pull <link>
+docker image pull $LINK
 ```

 to pull it to your machine.
@@ -37,59 +38,77 @@ When you have the image you can simply run it with

 ```bash
 docker run -d -p 8448:6167 \
-  -v db:/var/lib/conduwuit/ \
-  -e CONDUWUIT_SERVER_NAME="your.server.name" \
-  -e CONDUWUIT_DATABASE_BACKEND="rocksdb" \
-  -e CONDUWUIT_ALLOW_REGISTRATION=false \
-  --name conduit <link>
+    -v db:/var/lib/conduwuit/ \
+    -e CONDUWUIT_SERVER_NAME="your.server.name" \
+    -e CONDUWUIT_DATABASE_BACKEND="rocksdb" \
+    -e CONDUWUIT_ALLOW_REGISTRATION=false \
+    --name conduit $LINK
 ```

 or you can use [docker compose](#docker-compose).

-The `-d` flag lets the container run in detached mode. You may supply an optional `conduwuit.toml` config file, the example config can be found [here](../configuration/examples.md).
-You can pass in different env vars to change config values on the fly. You can even configure conduwuit completely by using env vars. For an overview of possible
-values, please take a look at the [`docker-compose.yml`](docker-compose.yml) file.
+The `-d` flag lets the container run in detached mode. You may supply an
+optional `conduwuit.toml` config file, the example config can be found
+[here](../configuration/examples.md). You can pass in different env vars to
+change config values on the fly. You can even configure conduwuit completely by
+using env vars. For an overview of possible values, please take a look at the
+[`docker-compose.yml`](docker-compose.yml) file.

-If you just want to test conduwuit for a short time, you can use the `--rm` flag, which will clean up everything related to your container after you stop it.
+If you just want to test conduwuit for a short time, you can use the `--rm`
+flag, which will clean up everything related to your container after you stop
+it.

 ### Docker-compose

-If the `docker run` command is not for you or your setup, you can also use one of the provided `docker-compose` files.
+If the `docker run` command is not for you or your setup, you can also use one
+of the provided `docker-compose` files.

 Depending on your proxy setup, you can use one of the following files;

- If you already have a `traefik` instance set up, use [`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml)
- If you don't have a `traefik` instance set up and would like to use it, use [`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)
- If you want a setup that works out of the box with `caddy-docker-proxy`, use [`docker-compose.with-caddy.yml`](docker-compose.with-caddy.yml) and replace all `example.com` placeholders with your own domain
+- If you already have a `traefik` instance set up, use
+[`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml)
+- If you don't have a `traefik` instance set up and would like to use it, use
+[`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)
+- If you want a setup that works out of the box with `caddy-docker-proxy`, use
+[`docker-compose.with-caddy.yml`](docker-compose.with-caddy.yml) and replace all
+`example.com` placeholders with your own domain
 - For any other reverse proxy, use [`docker-compose.yml`](docker-compose.yml)

-When picking the traefik-related compose file, rename it so it matches `docker-compose.yml`, and
-rename the override file to `docker-compose.override.yml`. Edit the latter with the values you want
-for your server.
+When picking the traefik-related compose file, rename it so it matches
+`docker-compose.yml`, and rename the override file to
+`docker-compose.override.yml`. Edit the latter with the values you want for your
+server.

-When picking the `caddy-docker-proxy` compose file, it's important to first create the `caddy` network before spinning up the containers:
+When picking the `caddy-docker-proxy` compose file, it's important to first
+create the `caddy` network before spinning up the containers:

 ```bash
 docker network create caddy
 ```

-After that, you can rename it so it matches `docker-compose.yml` and spin up the containers!
+After that, you can rename it so it matches `docker-compose.yml` and spin up the
+containers!

 Additional info about deploying conduwuit can be found [here](generic.md).

 ### Build

-To build the conduwuit image with docker-compose, you first need to open and modify the `docker-compose.yml` file. There you need to comment the `image:` option and uncomment the `build:` option. Then call docker compose with:
+To build the conduwuit image with docker-compose, you first need to open and
+modify the `docker-compose.yml` file. There you need to comment the `image:`
+option and uncomment the `build:` option. Then call docker compose with:

 ```bash
 docker compose up
 ```

-This will also start the container right afterwards, so if want it to run in detached mode, you also should use the `-d` flag.
+This will also start the container right afterwards, so if want it to run in
+detached mode, you also should use the `-d` flag.

 ### Run

-If you already have built the image or want to use one from the registries, you can just start the container and everything else in the compose file in detached mode with:
+If you already have built the image or want to use one from the registries, you
+can just start the container and everything else in the compose file in detached
+mode with:

 ```bash
 docker compose up -d
@@ -99,18 +118,21 @@ docker compose up -d

 ### Use Traefik as Proxy

-As a container user, you probably know about Traefik. It is a easy to use reverse proxy for making
-containerized app and services available through the web. With the two provided files,
+As a container user, you probably know about Traefik. It is a easy to use
+reverse proxy for making containerized app and services available through the
+web. With the two provided files,
 [`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml) (or
 [`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)) and
-[`docker-compose.override.yml`](docker-compose.override.yml), it is equally easy to deploy
-and use conduwuit, with a little caveat. If you already took a look at the files, then you should have
-seen the `well-known` service, and that is the little caveat. Traefik is simply a proxy and
-loadbalancer and is not able to serve any kind of content, but for conduwuit to federate, we need to
-either expose ports `443` and `8448` or serve two endpoints `.well-known/matrix/client` and
-`.well-known/matrix/server`.
+[`docker-compose.override.yml`](docker-compose.override.yml), it is equally easy
+to deploy and use conduwuit, with a little caveat. If you already took a look at
+the files, then you should have seen the `well-known` service, and that is the
+little caveat. Traefik is simply a proxy and loadbalancer and is not able to
+serve any kind of content, but for conduwuit to federate, we need to either
+expose ports `443` and `8448` or serve two endpoints `.well-known/matrix/client`
+and `.well-known/matrix/server`.

-With the service `well-known` we use a single `nginx` container that will serve those two files.
+With the service `well-known` we use a single `nginx` container that will serve
+those two files.

 ## Voice communication

@@ -1,8 +1,11 @@
 # conduwuit for FreeBSD

-conduwuit at the moment does not provide FreeBSD builds. Building conduwuit on FreeBSD requires a specific environment variable to use the
-system prebuilt RocksDB library instead of rust-rocksdb / rust-librocksdb-sys which does *not* work and will cause a build error or coredump.
+conduwuit at the moment does not provide FreeBSD builds. Building conduwuit on
+FreeBSD requires a specific environment variable to use the system prebuilt
+RocksDB library instead of rust-rocksdb / rust-librocksdb-sys which does *not*
+work and will cause a build error or coredump.

 Use the following environment variable: `ROCKSDB_LIB_DIR=/usr/local/lib`

-Such example commandline with it can be: `ROCKSDB_LIB_DIR=/usr/local/lib cargo build --release`
+Such example commandline with it can be: `ROCKSDB_LIB_DIR=/usr/local/lib cargo
+build --release`
@@ -2,24 +2,34 @@

 > ## Getting help
 >
-> If you run into any problems while setting up conduwuit, ask us
-> in `#conduwuit:puppygock.gay` or [open an issue on GitHub](https://github.com/girlbossceo/conduwuit/issues/new).
+> If you run into any problems while setting up conduwuit, ask us in
+> `#conduwuit:puppygock.gay` or [open an issue on
+> GitHub](https://github.com/girlbossceo/conduwuit/issues/new).

 ## Installing conduwuit

-You may simply download the binary that fits your machine. Run `uname -m` to see what you need.
+You may simply download the binary that fits your machine. Run `uname -m` to see
+what you need.

-Prebuilt fully static musl binaries can be downloaded from the latest tagged release [here](https://github.com/girlbossceo/conduwuit/releases/latest) or `main` CI branch workflow artifact output. These also include Debian packages. These binaries have jemalloc and io_uring statically linked and included with them.
+Prebuilt fully static musl binaries can be downloaded from the latest tagged
+release [here](https://github.com/girlbossceo/conduwuit/releases/latest) or
+`main` CI branch workflow artifact output. These also include Debian packages.
+These binaries have jemalloc and io_uring statically linked and included with
+them.

-Alternatively, you may compile the binary yourself. We recommend using [Lix](https://lix.systems) to build conduwuit as this has the most guaranteed
+Alternatively, you may compile the binary yourself. We recommend using
+[Lix](https://lix.systems) to build conduwuit as this has the most guaranteed
 reproducibiltiy and easiest to get a build environment and output going.

-Otherwise, follow standard Rust project build guides (installing git and cloning the repo, getting the Rust toolchain via rustup, installing LLVM toolchain + libclang for RocksDB, installing liburing for io_uring and RocksDB, etc).
+Otherwise, follow standard Rust project build guides (installing git and cloning
+the repo, getting the Rust toolchain via rustup, installing LLVM toolchain +
+libclang for RocksDB, installing liburing for io_uring and RocksDB, etc).

 ## Adding a conduwuit user

-While conduwuit can run as any user it is better to use dedicated users for different services. This also allows
-you to make sure that the file permissions are correctly set up.
+While conduwuit can run as any user it is better to use dedicated users for
+different services. This also allows you to make sure that the file permissions
+are correctly set up.

 In Debian or Fedora/RHEL, you can use this command to create a conduwuit user:

@@ -35,54 +45,67 @@ sudo useradd -r --shell /usr/bin/nologin --no-create-home conduwuit

 ## Forwarding ports in the firewall or the router

-conduwuit uses the ports 443 and 8448 both of which need to be open in the firewall.
+conduwuit uses the ports 443 and 8448 both of which need to be open in the
+firewall.

-If conduwuit runs behind a router or in a container and has a different public IP address than the host system these public ports need to be forwarded directly or indirectly to the port mentioned in the config.
+If conduwuit runs behind a router or in a container and has a different public
+IP address than the host system these public ports need to be forwarded directly
+or indirectly to the port mentioned in the config.

 ## Setting up a systemd service

-The systemd unit for conduwuit can be found [here](../configuration/examples.md#example-systemd-unit-file). You may need to change the `ExecStart=` path to where you placed the conduwuit binary.
+The systemd unit for conduwuit can be found
+[here](../configuration/examples.md#example-systemd-unit-file). You may need to
+change the `ExecStart=` path to where you placed the conduwuit binary.

 ## Creating the conduwuit configuration file

-Now we need to create the conduwuit's config file in `/etc/conduwuit/conduwuit.toml`. The example config can be found at [conduwuit-example.toml](../configuration/examples.md).**Please take a moment to read it. You need to change at least the server name.**
+Now we need to create the conduwuit's config file in
+`/etc/conduwuit/conduwuit.toml`. The example config can be found at
+[conduwuit-example.toml](../configuration/examples.md).
+
+**Please take a moment to read the config. You need to change at least the server name.**

 RocksDB is the only supported database backend.

 ## Setting the correct file permissions

-If you are using a dedicated user for conduwuit, you will need to allow it to read the config. To do that you can run this:
+If you are using a dedicated user for conduwuit, you will need to allow it to
+read the config. To do that you can run this:

 ```bash
-sudo chown -R root:root /etc/conduwuit
-sudo chmod -R 755 /etc/conduwuit
+sudo chown -R root:root /etc/conduwuit sudo chmod -R 755 /etc/conduwuit
 ```

 If you use the default database path you also need to run this:

 ```bash
-sudo mkdir -p /var/lib/conduwuit/
-sudo chown -R conduwuit:conduwuit /var/lib/conduwuit/
+sudo mkdir -p /var/lib/conduwuit/ sudo chown -R conduwuit:conduwuit /var/lib/conduwuit/
 sudo chmod 700 /var/lib/conduwuit/
 ```

 ## Setting up the Reverse Proxy

-Refer to the documentation or various guides online of your chosen reverse proxy software. A [Caddy](https://caddyserver.com/) example will be provided as this is the recommended reverse proxy for new users and is very trivial to use (handles TLS, reverse proxy headers, etc transparently with proper defaults).
+Refer to the documentation or various guides online of your chosen reverse proxy
+software. A [Caddy](https://caddyserver.com/) example will be provided as this
+is the recommended reverse proxy for new users and is very trivial to use
+(handles TLS, reverse proxy headers, etc transparently with proper defaults).

-Lighttpd is not supported as it seems to mess with the `X-Matrix` Authorization header, making federation non-functional. If using Apache, you need to use `nocanon` to prevent this.
+Lighttpd is not supported as it seems to mess with the `X-Matrix` Authorization
+header, making federation non-functional. If using Apache, you need to use
+`nocanon` to prevent this.

 ### Caddy

-Create `/etc/caddy/conf.d/conduwuit_caddyfile` and enter this (substitute for your server name).
+Create `/etc/caddy/conf.d/conduwuit_caddyfile` and enter this (substitute for
+your server name).

-```caddy
+```caddyfile
 your.server.name, your.server.name:8448 {
-        # TCP
-        reverse_proxy 127.0.0.1:6167
-
-        # UNIX socket
-        #reverse_proxy unix//run/conduwuit/conduwuit.sock
+    # TCP reverse_proxy
+    127.0.0.1:6167
+    # UNIX socket
+    #reverse_proxy unix//run/conduwuit/conduwuit.sock
 }
 ```

@@ -108,19 +131,23 @@ sudo systemctl enable conduwuit

 ## How do I know it works?

-You can open [a Matrix client](https://matrix.org/ecosystem/clients), enter your homeserver and try to register.
+You can open [a Matrix client](https://matrix.org/ecosystem/clients), enter your
+homeserver and try to register.

-You can also use these commands as a quick health check (replace `your.server.name`).
+You can also use these commands as a quick health check (replace
+`your.server.name`).

 ```bash
-$ curl https://your.server.name/_conduwuit/server_version
+curl https://your.server.name/_conduwuit/server_version

 # If using port 8448
-$ curl https://your.server.name:8448/_conduwuit/server_version
+curl https://your.server.name:8448/_conduwuit/server_version
 ```

- To check if your server can talk with other homeservers, you can use the [Matrix Federation Tester](https://federationtester.matrix.org/).
-  If you can register but cannot join federated rooms check your config again and also check if the port 8448 is open and forwarded correctly.
+- To check if your server can talk with other homeservers, you can use the
+[Matrix Federation Tester](https://federationtester.matrix.org/). If you can
+register but cannot join federated rooms check your config again and also check
+if the port 8448 is open and forwarded correctly.

 # What's next?

@@ -130,4 +157,5 @@ For Audio/Video call functionality see the [TURN Guide](../turn.md).

 ## Appservices

-If you want to set up an appservice, take a look at the [Appservice Guide](../appservices.md).
+If you want to set up an appservice, take a look at the [Appservice
+Guide](../appservices.md).
@@ -17,23 +17,24 @@ https://attic.kennel.juneis.dog/conduwuit
 conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE=
 ```

-The binary caches have been recreated recently due to attic issues. The old public keys were:
+The binary caches have been recreated recently due to attic issues. The old
+public keys were:

 ```
 conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg=
-
 conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw=
 ```

-If specifying a URL in your flake, please use the GitHub remote: `github:girlbossceo/conduwuit`
+If specifying a URL in your flake, please use the GitHub remote:
+`github:girlbossceo/conduwuit`

 The `flake.nix` and `default.nix` do not (currently) provide a NixOS module, so
 (for now) [`services.matrix-conduit`][module] from Nixpkgs should be used to
 configure conduwuit.

-If you want to run the latest code, you should get conduwuit from the `flake.nix`
-or `default.nix` and set [`services.matrix-conduit.package`][package]
-appropriately.
+If you want to run the latest code, you should get conduwuit from the
+`flake.nix` or `default.nix` and set
+[`services.matrix-conduit.package`][package] appropriately.

 [lix]: https://lix.systems/
 [module]: https://search.nixos.org/options?channel=unstable&query=services.matrix-conduit
@@ -4,23 +4,39 @@ Information about developing the project. If you are only interested in using
 it, you can safely ignore this section. If you plan on contributing, see the
 [contributor's guide](contributing.md).

-## List of forked dependencies
-During conduwuit development, we have had to fork some dependencies to support our use-cases in some areas. This ranges from things said upstream project won't accept for any reason, faster-paced development (unresponsive or slow upstream), conduwuit-specific usecases, or lack of time to upstream some things.
+## List of forked dependencies During conduwuit development, we have had to fork
+some dependencies to support our use-cases in some areas. This ranges from
+things said upstream project won't accept for any reason, faster-paced
+development (unresponsive or slow upstream), conduwuit-specific usecases, or
+lack of time to upstream some things.

- [ruma/ruma][1]: <https://github.com/girlbossceo/ruwuma> - various performance improvements, more features, faster-paced development, client/server interop hacks upstream won't accept, etc
- [facebook/rocksdb][2]: <https://github.com/girlbossceo/rocksdb> - liburing build fixes, GCC build fix, and logging callback C API for Rust tracing integration
- [tikv/jemallocator][3]: <https://github.com/girlbossceo/jemallocator> - musl builds seem to be broken on upstream
- [zyansheep/rustyline-async][4]: <https://github.com/girlbossceo/rustyline-async> - tab completion callback and `CTRL+\` signal quit event for CLI
- [rust-rocksdb/rust-rocksdb][5]: <https://github.com/girlbossceo/rust-rocksdb-zaidoon1> - [`@zaidoon1`'s][8] fork has quicker updates, more up to date dependencies. Our changes fix musl build issues, Rust part of the logging callback C API, removes unnecessary `gtest` include, and uses our RocksDB and jemallocator
- [tokio-rs/tracing][6]: <https://github.com/girlbossceo/tracing> - Implements `Clone` for `EnvFilter` to support dynamically changing tracing envfilter's alongside other logging/metrics things
+- [ruma/ruma][1]: <https://github.com/girlbossceo/ruwuma> - various performance
+improvements, more features, faster-paced development, client/server interop
+hacks upstream won't accept, etc
+- [facebook/rocksdb][2]: <https://github.com/girlbossceo/rocksdb> - liburing
+build fixes, GCC build fix, and logging callback C API for Rust tracing
+integration
+- [tikv/jemallocator][3]: <https://github.com/girlbossceo/jemallocator> - musl
+builds seem to be broken on upstream
+- [zyansheep/rustyline-async][4]:
+<https://github.com/girlbossceo/rustyline-async> - tab completion callback and
+`CTRL+\` signal quit event for CLI
+- [rust-rocksdb/rust-rocksdb][5]:
+<https://github.com/girlbossceo/rust-rocksdb-zaidoon1> - [`@zaidoon1`'s][8] fork
+has quicker updates, more up to date dependencies. Our changes fix musl build
+issues, Rust part of the logging callback C API, removes unnecessary `gtest`
+include, and uses our RocksDB and jemallocator
+- [tokio-rs/tracing][6]: <https://github.com/girlbossceo/tracing> - Implements
+`Clone` for `EnvFilter` to support dynamically changing tracing envfilter's
+alongside other logging/metrics things

 ## Debugging with `tokio-console`

-[`tokio-console`][7] can be a useful tool for debugging and profiling. To make
-a `tokio-console`-enabled build of conduwuit, enable the `tokio_console` feature,
-disable the default `release_max_log_level` feature, and set the
-`--cfg tokio_unstable` flag to enable experimental tokio APIs. A build might
-look like this:
+[`tokio-console`][7] can be a useful tool for debugging and profiling. To make a
+`tokio-console`-enabled build of conduwuit, enable the `tokio_console` feature,
+disable the default `release_max_log_level` feature, and set the `--cfg
+tokio_unstable` flag to enable experimental tokio APIs. A build might look like
+this:

 ```bash
 RUSTFLAGS="--cfg tokio_unstable" cargo build \
@@ -2,89 +2,190 @@

 ### Summary

-When developing in debug-builds with the nightly toolchain, conduwuit is modular using dynamic libraries and various parts of the application are hot-reloadable while the server is running: http api handlers, admin commands, services, database, etc. These are all split up into individual workspace crates as seen in the `src/` directory. Changes to sourcecode in a crate rebuild that crate and subsequent crates depending on it. Reloading then occurs for the changed crates.
+When developing in debug-builds with the nightly toolchain, conduwuit is modular
+using dynamic libraries and various parts of the application are hot-reloadable
+while the server is running: http api handlers, admin commands, services,
+database, etc. These are all split up into individual workspace crates as seen
+in the `src/` directory. Changes to sourcecode in a crate rebuild that crate and
+subsequent crates depending on it. Reloading then occurs for the changed crates.

-Release builds still produce static binaries which are unaffected. Rust's soundness guarantees are in full force. Thus you cannot hot-reload release binaries.
+Release builds still produce static binaries which are unaffected. Rust's
+soundness guarantees are in full force. Thus you cannot hot-reload release
+binaries.

 ### Requirements

-Currently, this development setup only works on x86_64 and aarch64 Linux glibc. [musl explicitly does not support hot reloadable libraries, and does not implement `dlclose`][2]. macOS does not fully support our usage of `RTLD_GLOBAL` possibly due to some thread-local issues. [This Rust issue][3] may be of relevance, specifically [this comment][4]. It may be possible to get it working on only very modern macOS versions such as at least Sonoma, as currently loading dylibs is supported, but not unloading them in our setup, and the cited comment mentions an Apple WWDC confirming there have been TLS changes to somewhat make this possible.
+Currently, this development setup only works on x86_64 and aarch64 Linux glibc.
+[musl explicitly does not support hot reloadable libraries, and does not
+implement `dlclose`][2]. macOS does not fully support our usage of `RTLD_GLOBAL`
+possibly due to some thread-local issues. [This Rust issue][3] may be of
+relevance, specifically [this comment][4]. It may be possible to get it working
+on only very modern macOS versions such as at least Sonoma, as currently loading
+dylibs is supported, but not unloading them in our setup, and the cited comment
+mentions an Apple WWDC confirming there have been TLS changes to somewhat make
+this possible.

-As mentioned above this requires the nightly toolchain. This is due to reliance on various Cargo.toml features that are only available on nightly, most specifically `RUSTFLAGS` in Cargo.toml. Some of the implementation could also be simpler based on other various nightly features. We hope lots of nightly features start making it out of nightly sooner as there have been dozens of very helpful features that have been stuck in nightly ("unstable") for at least 5+ years that would make this simpler. We encourage greater community consensus to move these features into stability.
+As mentioned above this requires the nightly toolchain. This is due to reliance
+on various Cargo.toml features that are only available on nightly, most
+specifically `RUSTFLAGS` in Cargo.toml. Some of the implementation could also be
+simpler based on other various nightly features. We hope lots of nightly
+features start making it out of nightly sooner as there have been dozens of very
+helpful features that have been stuck in nightly ("unstable") for at least 5+
+years that would make this simpler. We encourage greater community consensus to
+move these features into stability.

-This currently only works on x86_64/aarch64 Linux with a glibc C library. musl C library, macOS, and likely other host architectures are not supported (if other architectures work, feel free to let us know and/or make a PR updating this). This should work on GNU ld and lld (rust-lld) and gcc/clang, however if you happen to have linker issues it's recommended to try using `mold` or `gold` linkers, and please let us know in the [conduwuit Matrix room][7] the linker error and what linker solved this issue so we can figure out a solution. Ideally there should be minimal friction to using this, and in the future a build script (`build.rs`) may be suitable to making this easier to use if the capabilities allow us.
+This currently only works on x86_64/aarch64 Linux with a glibc C library. musl C
+library, macOS, and likely other host architectures are not supported (if other
+architectures work, feel free to let us know and/or make a PR updating this).
+This should work on GNU ld and lld (rust-lld) and gcc/clang, however if you
+happen to have linker issues it's recommended to try using `mold` or `gold`
+linkers, and please let us know in the [conduwuit Matrix room][7] the linker
+error and what linker solved this issue so we can figure out a solution. Ideally
+there should be minimal friction to using this, and in the future a build script
+(`build.rs`) may be suitable to making this easier to use if the capabilities
+allow us.

 ### Usage

 As of 19 May 2024, the instructions for using this are:

-0. Have patience. Don't hesitate to join the [conduwuit Matrix room][7] to receive help using this. As indicated by the various rustflags used and some of the interesting issues linked at the bottom, this is definitely not something the Rust ecosystem or toolchain is used to doing.
+0. Have patience. Don't hesitate to join the [conduwuit Matrix room][7] to
+   receive help using this. As indicated by the various rustflags used and some
+of the interesting issues linked at the bottom, this is definitely not something
+the Rust ecosystem or toolchain is used to doing.

-1. Install the nightly toolchain using rustup. You may need to use `rustup override set nightly` in your local conduwuit directory, or use `cargo +nightly` for all actions.
+1. Install the nightly toolchain using rustup. You may need to use `rustup
+   override set nightly` in your local conduwuit directory, or use `cargo
+nightly` for all actions.

 2. Uncomment `cargo-features` at the top level / root Cargo.toml

-3. Scroll down to the `# Developer profile` section and uncomment ALL the rustflags for each dev profile and their respective packages.
+3. Scroll down to the `# Developer profile` section and uncomment ALL the
+   rustflags for each dev profile and their respective packages.

-4. In each workspace crate's Cargo.toml (everything under `src/*` AND `deps/rust-rocksdb/Cargo.toml`), uncomment the `dylib` crate type under `[lib]`.
+4. In each workspace crate's Cargo.toml (everything under `src/*` AND
+   `deps/rust-rocksdb/Cargo.toml`), uncomment the `dylib` crate type under
+`[lib]`.

-5. Due to [this rpath issue][5], you must export the `LD_LIBRARY_PATH` environment variable to your nightly Rust toolchain library directory. If using rustup (hopefully), use this: `export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$HOME/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/`
+5. Due to [this rpath issue][5], you must export the `LD_LIBRARY_PATH`
+   environment variable to your nightly Rust toolchain library directory. If
+using rustup (hopefully), use this: `export
+LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$HOME/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/`

-6. Start the server. You can use `cargo +nightly run` for this along with the standard.
+6. Start the server. You can use `cargo +nightly run` for this along with the
+   standard.

 7. Make some changes where you need to.

-8. In a separate terminal window in the same directory (or using a terminal multiplexer like tmux), run the *build* Cargo command `cargo +nightly build`. Cargo should only rebuild what was changed / what's necessary, so it should not be rebuilding all the crates.
+8. In a separate terminal window in the same directory (or using a terminal
+   multiplexer like tmux), run the *build* Cargo command `cargo +nightly build`.
+   Cargo should only rebuild what was changed / what's necessary, so it should
+   not be rebuilding all the crates.

-9. In your conduwuit server terminal, hit/send `CTRL+C` signal. This will tell conduwuit to find which libraries need to be reloaded, and reloads them as necessary.
+9. In your conduwuit server terminal, hit/send `CTRL+C` signal. This will tell
+   conduwuit to find which libraries need to be reloaded, and reloads them as
+   necessary.

-10. If there were no errors, it will tell you it successfully reloaded `#` modules, and your changes should now be visible. Repeat 7 - 9 as needed.
+10. If there were no errors, it will tell you it successfully reloaded `#`
+   modules, and your changes should now be visible. Repeat 7 - 9 as needed.

-To shutdown conduwuit in this setup, hit/send `CTRL+\`. Normal builds still shutdown with `CTRL+C` as usual.
+To shutdown conduwuit in this setup, hit/send `CTRL+\`. Normal builds still
+shutdown with `CTRL+C` as usual.

-Steps 1 - 5 are the initial first-time steps for using this. To remove the hot reload setup, revert/comment all the Cargo.toml changes.
+Steps 1 - 5 are the initial first-time steps for using this. To remove the hot
+reload setup, revert/comment all the Cargo.toml changes.

-As mentioned in the requirements section, if you happen to have some linker issues, try using the `-fuse-ld=` rustflag and specify mold or gold in all the `rustflags` definitions in the top level Cargo.toml, and please let us know in the [conduwuit Matrix room][7] the problem. mold can be installed typically through your distro, and gold is provided by the binutils package.
+As mentioned in the requirements section, if you happen to have some linker
+issues, try using the `-fuse-ld=` rustflag and specify mold or gold in all the
+`rustflags` definitions in the top level Cargo.toml, and please let us know in
+the [conduwuit Matrix room][7] the problem. mold can be installed typically
+through your distro, and gold is provided by the binutils package.

-It's possible a helper script can be made to do all of this, or most preferably a specially made build script (build.rs). `cargo watch` support will be implemented soon which will eliminate the need to manually run `cargo build` all together.
+It's possible a helper script can be made to do all of this, or most preferably
+a specially made build script (build.rs). `cargo watch` support will be
+implemented soon which will eliminate the need to manually run `cargo build` all
+together.

 ### Addendum

-Conduit was inherited as a single crate without modularity or reloading in its design. Reasonable partitioning and abstraction allowed a split into several crates, though many circular dependencies had to be corrected. The resulting crates now form a directed graph as depicted in figures below. The interfacing between these crates is still extremely broad which is not mitigable.
+Conduit was inherited as a single crate without modularity or reloading in its
+design. Reasonable partitioning and abstraction allowed a split into several
+crates, though many circular dependencies had to be corrected. The resulting
+crates now form a directed graph as depicted in figures below. The interfacing
+between these crates is still extremely broad which is not mitigable.

-Initially [hot_lib_reload][6] was investigated but found appropriate for a project designed with modularity through limited interfaces, not a large and complex existing codebase. Instead a bespoke solution built directly on [libloading][8] satisfied our constraints. This required relatively minimal modifications and zero maintenance burden compared to what would be required otherwise. The technical difference lies with relocation processing: we leverage global bindings (`RTLD_GLOBAL`) in a very intentional way. Most libraries and off-the-shelf module systems (such as [hot_lib_reload][6]) restrict themselves to local bindings (`RTLD_LOCAL`). This allows them to release software to multiple platforms with much greater consistency, but at the cost of burdening applications to explicitly manage these bindings. In our case with an optional feature for developers, we shrug any such requirement to enjoy the cost/benefit on platforms where global relocations are properly cooperative.
+Initially [hot_lib_reload][6] was investigated but found appropriate for a
+project designed with modularity through limited interfaces, not a large and
+complex existing codebase. Instead a bespoke solution built directly on
+[libloading][8] satisfied our constraints. This required relatively minimal
+modifications and zero maintenance burden compared to what would be required
+otherwise. The technical difference lies with relocation processing: we leverage
+global bindings (`RTLD_GLOBAL`) in a very intentional way. Most libraries and
+off-the-shelf module systems (such as [hot_lib_reload][6]) restrict themselves
+to local bindings (`RTLD_LOCAL`). This allows them to release software to
+multiple platforms with much greater consistency, but at the cost of burdening
+applications to explicitly manage these bindings. In our case with an optional
+feature for developers, we shrug any such requirement to enjoy the cost/benefit
+on platforms where global relocations are properly cooperative.

-To make use of `RTLD_GLOBAL` the application has to be oriented as a directed acyclic graph. The primary rule is simple and illustrated in the figure below: **no crate is allowed to call a function or use a variable from a crate below it.**
+To make use of `RTLD_GLOBAL` the application has to be oriented as a directed
+acyclic graph. The primary rule is simple and illustrated in the figure below:
+**no crate is allowed to call a function or use a variable from a crate below
+it.**

-![conduwuit's dynamic library setup diagram - created by Jason Volk](assets/libraries.png)
+![conduwuit's dynamic library setup diagram - created by Jason
+Volk](assets/libraries.png)

-When a symbol is referenced between crates they become bound: **crates cannot be unloaded until their calling crates are first unloaded.** Thus we start the reloading process from the crate which has no callers. There is a small problem though: the first crate is called by the base executable itself! This is solved by using an `RTLD_LOCAL` binding for just one link between the main executable and the first crate, freeing the executable from all modules as no global binding ever occurs between them.
+When a symbol is referenced between crates they become bound: **crates cannot be
+unloaded until their calling crates are first unloaded.** Thus we start the
+reloading process from the crate which has no callers. There is a small problem
+though: the first crate is called by the base executable itself! This is solved
+by using an `RTLD_LOCAL` binding for just one link between the main executable
+and the first crate, freeing the executable from all modules as no global
+binding ever occurs between them.

-![conduwuit's reload and load order diagram - created by Jason Volk](assets/reload_order.png)
+![conduwuit's reload and load order diagram - created by Jason
+Volk](assets/reload_order.png)

-Proper resource management is essential for reliable reloading to occur. This is a very basic ask in RAII-idiomatic Rust and the exposure to reloading hazards is remarkably low, generally stemming from poor patterns and practices. Unfortunately static analysis doesn't enforce reload-safety programmatically (though it could one day), for now hazards can be avoided by knowing a few basic do's and dont's:
+Proper resource management is essential for reliable reloading to occur. This is
+a very basic ask in RAII-idiomatic Rust and the exposure to reloading hazards is
+remarkably low, generally stemming from poor patterns and practices.
+Unfortunately static analysis doesn't enforce reload-safety programmatically
+(though it could one day), for now hazards can be avoided by knowing a few basic
+do's and dont's:

-1. Understand that code is memory. Just like one is forbidden from referencing free'd memory, one must not transfer control to free'd code. Exposure to this is primarily from two things:
+1. Understand that code is memory. Just like one is forbidden from referencing
+   free'd memory, one must not transfer control to free'd code. Exposure to this
+is primarily from two things:

- Callbacks, which this project makes very little use of.
- Async tasks, which are addressed below.
+    - Callbacks, which this project makes very little use of.
+    - Async tasks, which are addressed below.

-2. Tie all resources to a scope or object lifetime with greatest possible symmetry (locality). For our purposes this applies to code resources, which means async blocks and tokio tasks.
+2. Tie all resources to a scope or object lifetime with greatest possible
+symmetry (locality). For our purposes this applies to code resources, which
+means async blocks and tokio tasks.

- **Never spawn a task without receiving and storing its JoinHandle**.
- **Always wait on join handles** before leaving a scope or in another cleanup function called by an owning scope.
+    - **Never spawn a task without receiving and storing its JoinHandle**.
+    - **Always wait on join handles** before leaving a scope or in another cleanup
+    function called by an owning scope.

 3. Know any minor specific quirks documented in code or here:

- Don't use `tokio::spawn`, instead use our `Handle` in `core/server.rs`, which is reachable in most of the codebase via `services()` or other state. This is due to some bugs or assumptions made in tokio, as it happens in `unsafe {}` blocks, which are mitigated by circumventing some thread-local variables. Using runtime handles is good practice in any case.
+    - Don't use `tokio::spawn`, instead use our `Handle` in `core/server.rs`, which
+    is reachable in most of the codebase via `services()` or other state. This is
+    due to some bugs or assumptions made in tokio, as it happens in `unsafe {}`
+    blocks, which are mitigated by circumventing some thread-local variables. Using
+    runtime handles is good practice in any case.

 The initial implementation PR is available [here][1].

 ### Interesting related issues/bugs

 - [DT_RUNPATH produced in binary with rpath = true is wrong (cargo)][5]
- [Disabling MIR Optimization in Rust Compilation (cargo)](https://internals.rust-lang.org/t/disabling-mir-optimization-in-rust-compilation/19066/5)
- [Workspace-level metadata (cargo-deb)](https://github.com/kornelski/cargo-deb/issues/68)
+- [Disabling MIR Optimization in Rust Compilation
+(cargo)](https://internals.rust-lang.org/t/disabling-mir-optimization-in-rust-compilation/19066/5)
+- [Workspace-level metadata
+(cargo-deb)](https://github.com/kornelski/cargo-deb/issues/68)

 [1]: https://github.com/girlbossceo/conduwuit/pull/387
 [2]: https://wiki.musl-libc.org/functional-differences-from-glibc.html#Unloading-libraries
@@ -5,15 +5,18 @@
 Have a look at [Complement's repository][complement] for an explanation of what
 it is.

-To test against Complement, with [Lix][lix] and direnv installed and set up, you can:
+To test against Complement, with [Lix][lix] and direnv installed and set up, you
+can:

-* Run `./bin/complement "$COMPLEMENT_SRC" ./path/to/logs.jsonl ./path/to/results.jsonl`
-  to build a Complement image, run the tests, and output the logs and results
-  to the specified paths. This will also output the OCI image at `result`
+* Run `./bin/complement "$COMPLEMENT_SRC" ./path/to/logs.jsonl
+./path/to/results.jsonl` to build a Complement image, run the tests, and output
+the logs and results to the specified paths. This will also output the OCI image
+at `result`
 * Run `nix build .#complement` from the root of the repository to just build a
-  Complement OCI image outputted to `result` (it's a `.tar.gz` file)
-* Or download the latest Complement OCI image from the CI workflow artifacts output
-  from the commit/revision you want to test (e.g. from main) [here][ci-workflows]
+Complement OCI image outputted to `result` (it's a `.tar.gz` file)
+* Or download the latest Complement OCI image from the CI workflow artifacts
+output from the commit/revision you want to test (e.g. from main)
+[here][ci-workflows]

 [lix]: https://lix.systems/
 [ci-workflows]: https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml?query=event%3Apush+is%3Asuccess+actor%3Agirlbossceo
@@ -1,4 +1,8 @@
-#### **Note: This list may not up to date. There are rapidly more and more improvements, fixes, changes, etc being made that it is becoming more difficult to maintain this list. I recommend that you give conduwuit a try and see the differences for yourself. If you have any concerns, feel free to join the conduwuit Matrix room and ask any pre-usage questions.**
+#### **Note: This list may not up to date. There are rapidly more and more
+improvements, fixes, changes, etc being made that it is becoming more difficult
+to maintain this list. I recommend that you give conduwuit a try and see the
+differences for yourself. If you have any concerns, feel free to join the
+conduwuit Matrix room and ask any pre-usage questions.**

 ### list of features, bug fixes, etc that conduwuit does that Conduit does not

@@ -6,192 +10,371 @@ Outgoing typing indicators, outgoing read receipts, **and** outgoing presence!

 ## Performance

- Concurrency support for individual homeserver key fetching for faster remote room joins and room joins that will error less frequently
- Send `Cache-Control` response header with `immutable` and 1 year cache length for all media requests (download and thumbnail) to instruct clients to cache media, and reduce server load from media requests that could be otherwise cached
- Add feature flags and config options to enable/build with zstd, brotli, and/or gzip HTTP body compression (response and request)
- Eliminate all usage of the thread-blocking `getaddrinfo(3)` call upon DNS queries, significantly improving federation latency/ping and cache DNS results (NXDOMAINs, successful queries, etc) using hickory-dns / hickory-resolver
+- Concurrency support for individual homeserver key fetching for faster remote
+room joins and room joins that will error less frequently
+- Send `Cache-Control` response header with `immutable` and 1 year cache length
+for all media requests (download and thumbnail) to instruct clients to cache
+media, and reduce server load from media requests that could be otherwise cached
+- Add feature flags and config options to enable/build with zstd, brotli, and/or
+gzip HTTP body compression (response and request)
+- Eliminate all usage of the thread-blocking `getaddrinfo(3)` call upon DNS
+queries, significantly improving federation latency/ping and cache DNS results
+(NXDOMAINs, successful queries, etc) using hickory-dns / hickory-resolver
 - Enable HTTP/2 support on all requests
- Vastly improve RocksDB default settings to use new features that help with performance significantly, uses settings tailored to SSDs, various ways to tweak RocksDB, and a conduwuit setting to tell RocksDB to use settings that are tailored to HDDs or slow spinning rust storage or buggy filesystems.
+- Vastly improve RocksDB default settings to use new features that help with
+performance significantly, uses settings tailored to SSDs, various ways to tweak
+RocksDB, and a conduwuit setting to tell RocksDB to use settings that are
+tailored to HDDs or slow spinning rust storage or buggy filesystems.
 - Implement database flush and cleanup conduwuit operations when using RocksDB
- Implement RocksDB write buffer corking and coalescing in database write-heavy areas
- Perform connection pooling and keepalives where necessary to significantly improve federation performance and latency
- Various config options to tweak connection pooling, request timeouts, connection timeouts, DNS timeouts and settings, etc with good defaults which also help huge with performance via reusing connections and retrying where needed
+- Implement RocksDB write buffer corking and coalescing in database write-heavy
+areas
+- Perform connection pooling and keepalives where necessary to significantly
+improve federation performance and latency
+- Various config options to tweak connection pooling, request timeouts,
+connection timeouts, DNS timeouts and settings, etc with good defaults which
+also help huge with performance via reusing connections and retrying where
+needed
 - Properly get and use the amount of parallelism / tokio workers
- Implement building conduwuit with jemalloc (which extends to the RocksDB jemalloc feature for maximum gains) or hardened_malloc light variant, and io_uring support, and produce CI builds with jemalloc and io_uring by default for performance (Nix doesn't seem to build [hardened_malloc-rs](https://github.com/girlbossceo/hardened_malloc-rs) properly)
- Add support for caching DNS results with hickory-dns / hickory-resolver in conduwuit (not a replacement for a proper resolver cache, but still far better than nothing), also properly falls back on TCP for UDP errors or if a SRV response is too large
- Add config option for using DNS over TCP, and config option for controlling A/AAAA record lookup strategy (e.g. don't query AAAA records if you don't have IPv6 connectivity)
- Overall significant database, Client-Server, and federation performance and latency improvements (check out the ping room leaderboards if you don't believe me :>)
- Add config options for RocksDB compression and bottommost compression, including choosing the algorithm and compression level
- Use [loole](https://github.com/mahdi-shojaee/loole) MPSC channels instead of tokio MPSC channels for huge performance boosts in sending channels (mainly relevant for federation) and presence channels
- Use `tracing`/`log`'s `release_max_level_info` feature to improve performance, build speeds, binary size, and CPU usage in release builds by avoid compiling debug/trace log level macros that users will generally never use (can be disabled with a build-time feature flag)
- Remove some unnecessary checks on EDU handling for incoming transactions, effectively speeding them up
- Simplify, dedupe, etc huge chunks of the codebase, including some that were unnecessary overhead, binary bloats, or preventing compiler/linker optimisations
- Implement zero-copy RocksDB database accessors, substantially improving performance caused by unnecessary memory allocations
+- Implement building conduwuit with jemalloc (which extends to the RocksDB
+jemalloc feature for maximum gains) or hardened_malloc light variant, and
+io_uring support, and produce CI builds with jemalloc and io_uring by default
+for performance (Nix doesn't seem to build
+[hardened_malloc-rs](https://github.com/girlbossceo/hardened_malloc-rs)
+properly)
+- Add support for caching DNS results with hickory-dns / hickory-resolver in
+conduwuit (not a replacement for a proper resolver cache, but still far better
+than nothing), also properly falls back on TCP for UDP errors or if a SRV
+response is too large
+- Add config option for using DNS over TCP, and config option for controlling
+A/AAAA record lookup strategy (e.g. don't query AAAA records if you don't have
+IPv6 connectivity)
+- Overall significant database, Client-Server, and federation performance and
+latency improvements (check out the ping room leaderboards if you don't believe
+me :>)
+- Add config options for RocksDB compression and bottommost compression,
+including choosing the algorithm and compression level
+- Use [loole](https://github.com/mahdi-shojaee/loole) MPSC channels instead of
+tokio MPSC channels for huge performance boosts in sending channels (mainly
+relevant for federation) and presence channels
+- Use `tracing`/`log`'s `release_max_level_info` feature to improve performance,
+build speeds, binary size, and CPU usage in release builds by avoid compiling
+debug/trace log level macros that users will generally never use (can be
+disabled with a build-time feature flag)
+- Remove some unnecessary checks on EDU handling for incoming transactions,
+effectively speeding them up
+- Simplify, dedupe, etc huge chunks of the codebase, including some that were
+unnecessary overhead, binary bloats, or preventing compiler/linker optimisations
+- Implement zero-copy RocksDB database accessors, substantially improving
+performance caused by unnecessary memory allocations

 ## General Fixes/Features

- Add legacy Element client hack fixing password changes and deactivations on legacy Element Android/iOS due to usage of an unspecced `user` field for UIAA
- Raise and improve all the various request timeouts making some things like room joins and client bugs error less or none at all than they should, and make them all user configurable
+- Add legacy Element client hack fixing password changes and deactivations on
+legacy Element Android/iOS due to usage of an unspecced `user` field for UIAA
+- Raise and improve all the various request timeouts making some things like
+room joins and client bugs error less or none at all than they should, and make
+them all user configurable
 - Add missing `reason` field to user ban events (`/ban`)
- Safer and cleaner shutdowns across incoming/outgoing requests (graceful shutdown) and the database
- Stop sending `make_join` requests on room joins if 15 servers respond with `M_UNSUPPORTED_ROOM_VERSION` or `M_INVALID_ROOM_VERSION`
- Stop sending `make_join` requests if 50 servers cannot provide `make_join` for us
- Respect *most* client parameters for `/media/` requests (`allow_redirect` still needs work)
- Return joined member count of rooms for push rules/conditions instead of a hardcoded value of 10
- Make `CONDUIT_CONFIG` optional, relevant for container users that configure only by environment variables and no longer need to set `CONDUIT_CONFIG` to an empty string.
- Allow HEAD and PATCH (MSC4138) HTTP requests in CORS for clients (despite not being explicity mentioned in Matrix spec, HTTP spec says all HEAD requests need to behave the same as GET requests, Synapse supports HEAD requests)
+- Safer and cleaner shutdowns across incoming/outgoing requests (graceful
+shutdown) and the database
+- Stop sending `make_join` requests on room joins if 15 servers respond with
+`M_UNSUPPORTED_ROOM_VERSION` or `M_INVALID_ROOM_VERSION`
+- Stop sending `make_join` requests if 50 servers cannot provide `make_join` for
+us
+- Respect *most* client parameters for `/media/` requests (`allow_redirect`
+still needs work)
+- Return joined member count of rooms for push rules/conditions instead of a
+hardcoded value of 10
+- Make `CONDUIT_CONFIG` optional, relevant for container users that configure
+only by environment variables and no longer need to set `CONDUIT_CONFIG` to an
+empty string.
+- Allow HEAD and PATCH (MSC4138) HTTP requests in CORS for clients (despite not
+being explicity mentioned in Matrix spec, HTTP spec says all HEAD requests need
+to behave the same as GET requests, Synapse supports HEAD requests)
 - Fix using conduwuit with flake-compat on NixOS
- Resolve and remove some "features" from upstream that result in concurrency hazards, exponential backoff issues, or arbitrary performance limiters
- Find more servers for outbound federation `/hierarchy` requests instead of just the room ID server name
- Support for suggesting servers to join through at `/_matrix/client/v3/directory/room/{roomAlias}`
- Support for suggesting servers to join through us at `/_matrix/federation/v1/query/directory`
+- Resolve and remove some "features" from upstream that result in concurrency
+hazards, exponential backoff issues, or arbitrary performance limiters
+- Find more servers for outbound federation `/hierarchy` requests instead of
+just the room ID server name
+- Support for suggesting servers to join through at
+`/_matrix/client/v3/directory/room/{roomAlias}`
+- Support for suggesting servers to join through us at
+`/_matrix/federation/v1/query/directory`
 - Misc edge-case search fixes (e.g. potentially missing some events)
- Misc `/sync` fixes (e.g. returning unnecessary data or incorrect/invalid responses)
- Add `replaces_state` and `prev_sender` in `unsigned` for state event changes which primarily makes Element's "See history" button on a state event functional
- Fix Conduit not allowing incoming federation requests for various world readable rooms
+- Misc `/sync` fixes (e.g. returning unnecessary data or incorrect/invalid
+responses)
+- Add `replaces_state` and `prev_sender` in `unsigned` for state event changes
+which primarily makes Element's "See history" button on a state event functional
+- Fix Conduit not allowing incoming federation requests for various world
+readable rooms
 - Fix Conduit not respecting the client-requested file name on media requests
- Prevent sending junk / non-membership events to `/send_join` and `/send_leave` endpoints
- Only allow the requested membership type on `/send_join` and `/send_leave` endpoints (e.g. don't allow leave memberships on join endpoints)
+- Prevent sending junk / non-membership events to `/send_join` and `/send_leave`
+endpoints
+- Only allow the requested membership type on `/send_join` and `/send_leave`
+endpoints (e.g. don't allow leave memberships on join endpoints)
 - Prevent state key impersonation on `/send_join` and `/send_leave` endpoints
- Validate `X-Matrix` origin and request body `"origin"` field on incoming transactions
- Add `GET /_matrix/client/v1/register/m.login.registration_token/validity` endpoint
- Explicitly define support for sliding sync at `/_matrix/client/versions` (`org.matrix.msc3575`)
+- Validate `X-Matrix` origin and request body `"origin"` field on incoming
+transactions
+- Add `GET /_matrix/client/v1/register/m.login.registration_token/validity`
+endpoint
+- Explicitly define support for sliding sync at `/_matrix/client/versions`
+(`org.matrix.msc3575`)
 - Fix seeing empty status messages on user presences

 ## Moderation

- (Also see [Admin Room](#admin-room) for all the admin commands pertaining to moderation, there's a lot!)
+- (Also see [Admin Room](#admin-room) for all the admin commands pertaining to
+moderation, there's a lot!)
 - Add support for room banning/blocking by ID using admin command
- Add support for serving `support` well-known from `[global.well_known]` (MSC1929) (`/.well-known/matrix/support`)
- Config option to forbid publishing rooms to the room directory (`lockdown_public_room_directory`) except for admins
- Admin commands to delete room aliases and unpublish rooms from our room directory
- For all [`/report`](https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3roomsroomidreporteventid) requests: check if the reported event ID belongs to the reported room ID, raise report reasoning character limit to 750, fix broken formatting, make a small delayed random response per spec suggestion on privacy, and check if the sender user is in the reported room.
+- Add support for serving `support` well-known from `[global.well_known]`
+(MSC1929) (`/.well-known/matrix/support`)
+- Config option to forbid publishing rooms to the room directory
+(`lockdown_public_room_directory`) except for admins
+- Admin commands to delete room aliases and unpublish rooms from our room
+directory
+- For all
+[`/report`](https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3roomsroomidreporteventid)
+requests: check if the reported event ID belongs to the reported room ID, raise
+report reasoning character limit to 750, fix broken formatting, make a small
+delayed random response per spec suggestion on privacy, and check if the sender
+user is in the reported room.
 - Support blocking servers from downloading remote media from, returning a 404
- Don't allow `m.call.invite` events to be sent in public rooms (prevents calling the entire room)
- On new public room creations, only allow moderators to send `m.call.invite`, `org.matrix.msc3401.call`, and `org.matrix.msc3401.call.member` events to prevent unprivileged users from calling the entire room
- Add support for a "global ACLs" feature (`forbidden_remote_server_names`) that blocks inbound remote room invites, room joins by room ID on server name, room joins by room alias on server name, incoming federated joins, and incoming federated room directory requests. This is very helpful for blocking servers that are purely toxic/bad and serve no value in allowing our users to suffer from things like room invite spam or such. Please note that this is not a substitute for room ACLs.
- Add support for a config option to forbid our local users from sending federated room directory requests for (`forbidden_remote_room_directory_server_names`). Similar to above, useful for blocking servers that help prevent our users from wandering into bad areas of Matrix via room directories of those malicious servers.
- Add config option for auto remediating/deactivating local non-admin users who attempt to join bad/forbidden rooms (`auto_deactivate_banned_room_attempts`)
- Deactivating users will remove their profile picture, blurhash, display name, and leave all rooms by default just like Synapse and for additional privacy
+- Don't allow `m.call.invite` events to be sent in public rooms (prevents
+calling the entire room)
+- On new public room creations, only allow moderators to send `m.call.invite`,
+`org.matrix.msc3401.call`, and `org.matrix.msc3401.call.member` events to
+prevent unprivileged users from calling the entire room
+- Add support for a "global ACLs" feature (`forbidden_remote_server_names`) that
+blocks inbound remote room invites, room joins by room ID on server name, room
+joins by room alias on server name, incoming federated joins, and incoming
+federated room directory requests. This is very helpful for blocking servers
+that are purely toxic/bad and serve no value in allowing our users to suffer
+from things like room invite spam or such. Please note that this is not a
+substitute for room ACLs.
+- Add support for a config option to forbid our local users from sending
+federated room directory requests for
+(`forbidden_remote_room_directory_server_names`). Similar to above, useful for
+blocking servers that help prevent our users from wandering into bad areas of
+Matrix via room directories of those malicious servers.
+- Add config option for auto remediating/deactivating local non-admin users who
+attempt to join bad/forbidden rooms (`auto_deactivate_banned_room_attempts`)
+- Deactivating users will remove their profile picture, blurhash, display name,
+and leave all rooms by default just like Synapse and for additional privacy
 - Reject some EDUs from ACL'd users such as read receipts and typing indicators

 ## Privacy/Security

- Add config option for device name federation with a privacy-friendly default (disabled)
- Add config option for requiring authentication to the `/publicRooms` endpoint (room directory) with a default enabled for privacy
- Add config option for federating `/publicRooms` endpoint (room directory) to other servers with a default disabled for privacy
- Uses proper `argon2` crate by RustCrypto instead of questionable `rust-argon2` crate
+- Add config option for device name federation with a privacy-friendly default
+(disabled)
+- Add config option for requiring authentication to the `/publicRooms` endpoint
+(room directory) with a default enabled for privacy
+- Add config option for federating `/publicRooms` endpoint (room directory) to
+other servers with a default disabled for privacy
+- Uses proper `argon2` crate by RustCrypto instead of questionable `rust-argon2`
+crate
 - Generate passwords with 25 characters instead of 15
- Config option `ip_range_denylist` to support refusing to send requests (typically federation) to specific IP ranges, typically RFC 1918, non-routable, testnet, etc addresses like Synapse for security (note: this is not a guaranteed protection, and you should be using a firewall with zones if you want guaranteed protection as doing this on the application level is prone to bypasses).
- Config option to block non-admin users from sending room invites or receiving remote room invites. Admin users are still allowed.
+- Config option `ip_range_denylist` to support refusing to send requests
+(typically federation) to specific IP ranges, typically RFC 1918, non-routable,
+testnet, etc addresses like Synapse for security (note: this is not a guaranteed
+protection, and you should be using a firewall with zones if you want guaranteed
+protection as doing this on the application level is prone to bypasses).
+- Config option to block non-admin users from sending room invites or receiving
+remote room invites. Admin users are still allowed.
 - Config option to disable incoming and/or outgoing remote read receipts
 - Config option to disable incoming and/or outgoing remote typing indicators
- Config option to disable incoming, outgoing, and/or local presence and for timing out remote users
- Sanitise file names for the `Content-Disposition` header for all media requests (thumbnails, downloads, uploads)
- Media repository on handling `Content-Disposition` and `Content-Type` is fully spec compliant and secured
- Send secure default HTTP headers such as a strong restrictive CSP (see MSC4149), deny iframes, disable `X-XSS-Protection`, disable interest cohort in `Permission-Policy`, etc to mitigate any potential attack surface such as from untrusted media
+- Config option to disable incoming, outgoing, and/or local presence and for
+timing out remote users
+- Sanitise file names for the `Content-Disposition` header for all media
+requests (thumbnails, downloads, uploads)
+- Media repository on handling `Content-Disposition` and `Content-Type` is fully
+spec compliant and secured
+- Send secure default HTTP headers such as a strong restrictive CSP (see
+MSC4149), deny iframes, disable `X-XSS-Protection`, disable interest cohort in
+`Permission-Policy`, etc to mitigate any potential attack surface such as from
+untrusted media

 ## Administration/Logging

- Commandline argument to specify the path to a config file instead of relying on `CONDUIT_CONFIG`
+- Commandline argument to specify the path to a config file instead of relying
+on `CONDUIT_CONFIG`
 - Revamped admin room infrastructure and commands
- Substantially clean up, improve, and fix logging (less noisy dead server logging, registration attempts, more useful troubleshooting logging, proper error propagation, etc)
- Configurable RocksDB logging (`LOG` files) with proper defaults (rotate, max size, verbosity, etc) to stop LOG files from accumulating so much
- Explicit startup error if your configuration allows open registration without a token or such like Synapse with a way to bypass it if needed
- Replace the lightning bolt emoji option with support for setting any arbitrary text (e.g. another emoji) to suffix to all new user registrations, with a conduwuit default of "🏳️‍⚧️"
+- Substantially clean up, improve, and fix logging (less noisy dead server
+logging, registration attempts, more useful troubleshooting logging, proper
+error propagation, etc)
+- Configurable RocksDB logging (`LOG` files) with proper defaults (rotate, max
+size, verbosity, etc) to stop LOG files from accumulating so much
+- Explicit startup error if your configuration allows open registration without
+a token or such like Synapse with a way to bypass it if needed
+- Replace the lightning bolt emoji option with support for setting any arbitrary
+text (e.g. another emoji) to suffix to all new user registrations, with a
+conduwuit default of "🏳️‍⚧️"
 - Implement config option to auto join rooms upon registration
 - Warn on unknown config options specified
- Add `/_conduwuit/server_version` route to return the version of conduwuit without relying on the federation API `/_matrix/federation/v1/version`
- Add `/_conduwuit/local_user_count` route to return the amount of registered active local users on your homeserver *if federation is enabled*
- Add configurable RocksDB recovery modes to aid in recovering corrupted RocksDB databases
- Support config options via `CONDUWUIT_` prefix and accessing non-global struct config options with the `__` split (e.g. `CONDUWUIT_WELL_KNOWN__SERVER`)
+- Add `/_conduwuit/server_version` route to return the version of conduwuit
+without relying on the federation API `/_matrix/federation/v1/version`
+- Add `/_conduwuit/local_user_count` route to return the amount of registered
+active local users on your homeserver *if federation is enabled*
+- Add configurable RocksDB recovery modes to aid in recovering corrupted RocksDB
+databases
+- Support config options via `CONDUWUIT_` prefix and accessing non-global struct
+config options with the `__` split (e.g. `CONDUWUIT_WELL_KNOWN__SERVER`)
 - Add support for listening on multiple TCP ports and multiple addresses
 - **Opt-in** Sentry.io telemetry and metrics, mainly used for crash reporting
- Log the client IP on various requests such as registrations, banned room join attempts, logins, deactivations, federation transactions, etc
+- Log the client IP on various requests such as registrations, banned room join
+attempts, logins, deactivations, federation transactions, etc
 - Fix Conduit dropping some remote server federation response errors

 ## Maintenance/Stability

 - GitLab CI ported to GitHub Actions
- Add support for the Matrix spec compliance test suite [Complement](https://github.com/matrix-org/complement/) via the Nix flake and various other fixes for it
- Implement running and diff'ing Complement results in CI and error if any mismatch occurs to prevent large cases of conduwuit regressions
- Repo is (officially) mirrored to GitHub, GitLab, git.gay, git.girlcock.ceo, sourcehut, and Codeberg (see README.md for their links)
- Docker container images published to GitLab Container Registry, GitHub Container Registry, and Dockerhub
- Extensively revamp the example config to be extremely helpful and useful to both new users and power users
- Fixed every single clippy (default lints) and rustc warnings, including some that were performance related or potential safety issues / unsoundness
+- Add support for the Matrix spec compliance test suite
+[Complement](https://github.com/matrix-org/complement/) via the Nix flake and
+various other fixes for it
+- Implement running and diff'ing Complement results in CI and error if any
+mismatch occurs to prevent large cases of conduwuit regressions
+- Repo is (officially) mirrored to GitHub, GitLab, git.gay, git.girlcock.ceo,
+sourcehut, and Codeberg (see README.md for their links)
+- Docker container images published to GitLab Container Registry, GitHub
+Container Registry, and Dockerhub
+- Extensively revamp the example config to be extremely helpful and useful to
+both new users and power users
+- Fixed every single clippy (default lints) and rustc warnings, including some
+that were performance related or potential safety issues / unsoundness
 - Add a **lot** of other clippy and rustc lints and a rustfmt.toml file
- Repo uses [Renovate](https://docs.renovatebot.com/), [Trivy](https://github.com/aquasecurity/trivy-action), and keeps ALL dependencies as up to date as possible
- Purge unmaintained/irrelevant/broken database backends (heed, sled, persy) and other unnecessary code or overhead
+- Repo uses [Renovate](https://docs.renovatebot.com/),
+[Trivy](https://github.com/aquasecurity/trivy-action), and keeps ALL
+dependencies as up to date as possible
+- Purge unmaintained/irrelevant/broken database backends (heed, sled, persy) and
+other unnecessary code or overhead
 - webp support for images
 - Add cargo audit support to CI
 - Add documentation lints via lychee and markdownlint-cli to CI
- CI tests for all sorts of feature matrixes (jemalloc, non-defaullt, all features, etc)
- Add static and dynamic linking smoke tests in CI to prevent any potential linking regressions for Complement, static binaries, Nix devshells, etc
- Add timestamp by commit date when building OCI images for keeping image build reproducibility and still have a meaningful "last modified date" for OCI image
+- CI tests for all sorts of feature matrixes (jemalloc, non-defaullt, all
+features, etc)
+- Add static and dynamic linking smoke tests in CI to prevent any potential
+linking regressions for Complement, static binaries, Nix devshells, etc
+- Add timestamp by commit date when building OCI images for keeping image build
+reproducibility and still have a meaningful "last modified date" for OCI image
 - Add timestamp by commit date via `SOURCE_DATE_EPOCH` for Debian packages
- Startup check if conduwuit running in a container and is listening on 127.0.0.1 (generally containers are using NAT networking and 0.0.0.0 is the intended listening address)
- Add a panic catcher layer to return panic messages in HTTP responses if a panic occurs
- Add full compatibility support for SHA256 media file names instead of base64 file names to overcome filesystem file name length limitations (OS error file name too long) while still retaining upstream database compatibility
- Remove SQLite support due to being very poor performance, difficult to maintain against RocksDB, and is a blocker to significantly improved database code
+- Startup check if conduwuit running in a container and is listening on
+127.0.0.1 (generally containers are using NAT networking and 0.0.0.0 is the
+intended listening address)
+- Add a panic catcher layer to return panic messages in HTTP responses if a
+panic occurs
+- Add full compatibility support for SHA256 media file names instead of base64
+file names to overcome filesystem file name length limitations (OS error file
+name too long) while still retaining upstream database compatibility
+- Remove SQLite support due to being very poor performance, difficult to
+maintain against RocksDB, and is a blocker to significantly improved database
+code

 ## Admin Room

- Add support for a console CLI interface that can issue admin commands and output them in your terminal
- Add support for an admin-user-only commandline admin room interface that can be issued in any room with the `\\!admin` or `\!admin` prefix and returns the response as yourself in the same room
- Add admin commands for uptime, server startup, server shutdown, and server restart
- Fix admin room handler to not panic/crash if the admin room command response fails (e.g. too large message)
- Add command to dynamically change conduwuit's tracing log level filter on the fly
+- Add support for a console CLI interface that can issue admin commands and
+output them in your terminal
+- Add support for an admin-user-only commandline admin room interface that can
+be issued in any room with the `\\!admin` or `\!admin` prefix and returns the
+response as yourself in the same room
+- Add admin commands for uptime, server startup, server shutdown, and server
+restart
+- Fix admin room handler to not panic/crash if the admin room command response
+fails (e.g. too large message)
+- Add command to dynamically change conduwuit's tracing log level filter on the
+fly
 - Add admin command to fetch a server's `/.well-known/matrix/support` file
- Add debug admin command to force update user device lists (could potentially resolve some E2EE flukes)
- Implement **RocksDB online backups**, listing RocksDB backups, and listing database file counts all via admin commands
- Add various database visibility commands such as being able to query the getters and iterators used in conduwuit, a very helpful online debugging utility
+- Add debug admin command to force update user device lists (could potentially
+resolve some E2EE flukes)
+- Implement **RocksDB online backups**, listing RocksDB backups, and listing
+database file counts all via admin commands
+- Add various database visibility commands such as being able to query the
+getters and iterators used in conduwuit, a very helpful online debugging utility
 - Forbid the admin room from being made public or world readable history
 - Add `!admin` as a way to call the admin bot
- Extend clear cache admin command to support clearing more caches such as DNS and TLS name overrides
- Admin debug command to send a federation request/ping to a server's `/_matrix/federation/v1/version` endpoint and measures the latency it took
+- Extend clear cache admin command to support clearing more caches such as DNS
+and TLS name overrides
+- Admin debug command to send a federation request/ping to a server's
+`/_matrix/federation/v1/version` endpoint and measures the latency it took
 - Add admin command to bulk delete media via a codeblock list of MXC URLs.
- Add admin command to delete both the thumbnail and media MXC URLs from an event ID (e.g. from an abuse report)
+- Add admin command to delete both the thumbnail and media MXC URLs from an
+event ID (e.g. from an abuse report)
 - Add admin command to list all the rooms a local user is joined in
 - Add admin command to list joined members in a room
 - Add admin command to view the room topic of a room
- Add admin command to delete all remote media in the past X minutes as a form of deleting media that you don't want on your server that a remote user posted in a room, a `--force` flag to ignore errors, and support for reading `last modified time` instead of `creation time` for filesystems that don't support file created metadata
+- Add admin command to delete all remote media in the past X minutes as a form
+of deleting media that you don't want on your server that a remote user posted
+in a room, a `--force` flag to ignore errors, and support for reading `last
+modified time` instead of `creation time` for filesystems that don't support
+file created metadata
 - Add admin command to return a room's full/complete state
- Admin debug command to fetch a PDU from a remote server and inserts it into our database/timeline as backfill
- Add admin command to delete media via a specific MXC. This deletes the MXC from our database, and the file locally.
- Add admin commands for banning (blocking) room IDs from our local users joining (admins are always allowed) and evicts all our local users from that room, in addition to bulk room banning support, and blocks room invites (remote and local) to the banned room, as a moderation feature
+- Admin debug command to fetch a PDU from a remote server and inserts it into
+our database/timeline as backfill
+- Add admin command to delete media via a specific MXC. This deletes the MXC
+from our database, and the file locally.
+- Add admin commands for banning (blocking) room IDs from our local users
+joining (admins are always allowed) and evicts all our local users from that
+room, in addition to bulk room banning support, and blocks room invites (remote
+and local) to the banned room, as a moderation feature
 - Add admin commands to output jemalloc memory stats and memory usage
 - Add admin command to get rooms a *remote* user shares with us
 - Add debug admin commands to get the earliest and latest PDU in a room
 - Add debug admin command to echo a message
- Add admin command to insert rooms tags for a user, most useful for inserting the `m.server_notice` tag on your admin room to make it "persistent" in the "System Alerts" section of Element
- Add experimental admin debug command for Dendrite's `AdminDownloadState` (`/admin/downloadState/{serverName}/{roomID}`) admin API endpoint to download and use a remote server's room state in the room
- Disable URL previews by default in the admin room due to various command outputs having "URLs" in them that clients may needlessly render/request
- Extend memory usage admin server command to support showing memory allocator stats such as jemalloc's
- Add admin debug command to see memory allocator's full extended debug statistics such as jemalloc's
+- Add admin command to insert rooms tags for a user, most useful for inserting
+the `m.server_notice` tag on your admin room to make it "persistent" in the
+"System Alerts" section of Element
+- Add experimental admin debug command for Dendrite's `AdminDownloadState`
+(`/admin/downloadState/{serverName}/{roomID}`) admin API endpoint to download
+and use a remote server's room state in the room
+- Disable URL previews by default in the admin room due to various command
+outputs having "URLs" in them that clients may needlessly render/request
+- Extend memory usage admin server command to support showing memory allocator
+stats such as jemalloc's
+- Add admin debug command to see memory allocator's full extended debug
+statistics such as jemalloc's

 ## Misc

- Add guest support for accessing TURN servers via `turn_allow_guests` like Synapse
- Support for creating rooms with custom room IDs like Maunium Synapse (`room_id` request body field to `/createRoom`)
- Query parameter `?format=event|content` for returning either the room state event's content (default) for the full room state event on `/_matrix/client/v3/rooms/{roomId}/state/{eventType}[/{stateKey}]` requests (see <https://github.com/matrix-org/matrix-spec/issues/1047>)
+- Add guest support for accessing TURN servers via `turn_allow_guests` like
+Synapse
+- Support for creating rooms with custom room IDs like Maunium Synapse
+(`room_id` request body field to `/createRoom`)
+- Query parameter `?format=event|content` for returning either the room state
+event's content (default) for the full room state event on
+`/_matrix/client/v3/rooms/{roomId}/state/{eventType}[/{stateKey}]` requests (see
+<https://github.com/matrix-org/matrix-spec/issues/1047>)
 - Send a User-Agent on all of our requests
 - Send `avatar_url` on invite room membership events/changes
- Support sending [`well_known` response to client login responses](https://spec.matrix.org/v1.10/client-server-api/#post_matrixclientv3login) if using config option `[well_known.client]`
- Implement `include_state` search criteria support for `/search` requests (response now can include room states)
- Declare various missing Matrix versions and features at `/_matrix/client/versions`
- Implement legacy Matrix `/v1/` media endpoints that some clients and servers may still call
- Config option to change Conduit's behaviour of homeserver key fetching (`query_trusted_key_servers_first`). This option sets whether conduwuit will query trusted notary key servers first before the individual homeserver(s), or vice versa which may help in joining certain rooms.
+- Support sending [`well_known` response to client login
+responses](https://spec.matrix.org/v1.10/client-server-api/#post_matrixclientv3login)
+if using config option `[well_known.client]`
+- Implement `include_state` search criteria support for `/search` requests
+(response now can include room states)
+- Declare various missing Matrix versions and features at
+`/_matrix/client/versions`
+- Implement legacy Matrix `/v1/` media endpoints that some clients and servers
+may still call
+- Config option to change Conduit's behaviour of homeserver key fetching
+(`query_trusted_key_servers_first`). This option sets whether conduwuit will
+query trusted notary key servers first before the individual homeserver(s), or
+vice versa which may help in joining certain rooms.
 - Implement unstable MSC2666 support for querying mutual rooms with a user
 - Implement unstable MSC3266 room summary API support
- Implement unstable MSC4125 support for specifying servers to join via on federated invites
+- Implement unstable MSC4125 support for specifying servers to join via on
+federated invites
 - Make conduwuit build and be functional under Nix + macOS
 - Log out all sessions after unsetting the emergency password
 - Assume well-knowns are broken if they exceed past 12288 characters.
- Add support for listening on both HTTP and HTTPS if using direct TLS with conduwuit for usecases such as Complement
+- Add support for listening on both HTTP and HTTPS if using direct TLS with
+conduwuit for usecases such as Complement
 - Add config option for disabling RocksDB Direct IO if needed
- Add various documentation on maintaining conduwuit, using RocksDB online backups, some troubleshooting, using admin commands, moderation documentation, etc
- (Developers): Add support for [hot reloadable/"live" modular development](development/hot_reload.md)
+- Add various documentation on maintaining conduwuit, using RocksDB online
+backups, some troubleshooting, using admin commands, moderation documentation,
+etc
+- (Developers): Add support for [hot reloadable/"live" modular
+development](development/hot_reload.md)
 - (Developers): Add support for tokio-console
 - (Developers): Add support for tracing flame graphs
- No cryptocurrency donations allowed, conduwuit is fully maintained by independent queer maintainers, and with a strong priority on inclusitivity and comfort for protected groups 🏳️‍⚧️
- [Add a community Code of Conduct for all conduwuit community spaces, primarily the Matrix space](https://conduwuit.puppyirl.gay/conduwuit_coc.html)
+- No cryptocurrency donations allowed, conduwuit is fully maintained by
+independent queer maintainers, and with a strong priority on inclusitivity and
+comfort for protected groups 🏳️‍⚧️
+- [Add a community Code of Conduct for all conduwuit community spaces, primarily
+the Matrix space](https://conduwuit.puppyirl.gay/conduwuit_coc.html)
@@ -12,7 +12,8 @@ See the [differences](differences.md) page

 - [Deployment options](deploying.md)

-If you want to connect an appservice to conduwuit, take a look at the [appservices documentation](appservices.md).
+If you want to connect an appservice to conduwuit, take a look at the
+[appservices documentation](appservices.md).

 #### How can I contribute?

@@ -2,7 +2,11 @@

 ## Moderation

-conduwuit has moderation through admin room commands. "binary commands" (medium priority) and an admin API (low priority) is planned. Some moderation-related config options are available in the example config such as "global ACLs" and blocking media requests to certain servers. See the example config for the moderation config options under the "Moderation / Privacy / Security" section.
+conduwuit has moderation through admin room commands. "binary commands" (medium
+priority) and an admin API (low priority) is planned. Some moderation-related
+config options are available in the example config such as "global ACLs" and
+blocking media requests to certain servers. See the example config for the
+moderation config options under the "Moderation / Privacy / Security" section.

 conduwuit has moderation admin commands for:

@@ -11,56 +15,83 @@ conduwuit has moderation admin commands for:
 - managing room banning/blocking and user removal (`!admin rooms moderation`)
 - managing user accounts (`!admin users`)
 - fetching `/.well-known/matrix/support` from servers (`!admin federation`)
- blocking incoming federation for certain rooms (not the same as room banning) (`!admin federation`)
+- blocking incoming federation for certain rooms (not the same as room banning)
+(`!admin federation`)
 - deleting media (see [the media section](#media))

-Any commands with `-list` in them will require a codeblock in the message with each object being newline delimited. An example of doing this is:
+Any commands with `-list` in them will require a codeblock in the message with
+each object being newline delimited. An example of doing this is:

-````
-!admin rooms moderation ban-list-of-rooms
-```
-!roomid1:server.name
-!roomid2:server.name
-!roomid3:server.name
-```
-````
+```` !admin rooms moderation ban-list-of-rooms ``` !roomid1:server.name
+!roomid2:server.name !roomid3:server.name ``` ````

 ## Database

-If using RocksDB, there's very little you need to do. Compaction is ran automatically based on various defined thresholds tuned for conduwuit to be high performance with the least I/O amplifcation or overhead. Manually running compaction is not recommended, or compaction via a timer. RocksDB is built with io_uring support via liburing for async read I/O.
+If using RocksDB, there's very little you need to do. Compaction is ran
+automatically based on various defined thresholds tuned for conduwuit to be high
+performance with the least I/O amplifcation or overhead. Manually running
+compaction is not recommended, or compaction via a timer. RocksDB is built with
+io_uring support via liburing for async read I/O.

-Some RocksDB settings can be adjusted such as the compression method chosen. See the RocksDB section in the [example config](configuration/examples.md). btrfs users may benefit from disabling compression on RocksDB if CoW is in use.
+Some RocksDB settings can be adjusted such as the compression method chosen. See
+the RocksDB section in the [example config](configuration/examples.md). btrfs
+users may benefit from disabling compression on RocksDB if CoW is in use.

-RocksDB troubleshooting can be found [in the RocksDB section of troubleshooting](troubleshooting.md).
+RocksDB troubleshooting can be found [in the RocksDB section of
+troubleshooting](troubleshooting.md).

 ## Backups

-Currently only RocksDB supports online backups. If you'd like to backup your database online without any downtime, see the `!admin server` command for the backup commands and the `database_backup_path` config options in the example config. Please note that the format of the database backup is not the exact same. This is unfortunately a bad design choice by Facebook as we are using the database backup engine API from RocksDB, however the data is still there and can still be joined together.
+Currently only RocksDB supports online backups. If you'd like to backup your
+database online without any downtime, see the `!admin server` command for the
+backup commands and the `database_backup_path` config options in the example
+config. Please note that the format of the database backup is not the exact
+same. This is unfortunately a bad design choice by Facebook as we are using the
+database backup engine API from RocksDB, however the data is still there and can
+still be joined together.

 To restore a backup from an online RocksDB backup:

 - shutdown conduwuit
 - create a new directory for merging together the data
- in the online backup created, copy all `.sst` files in `$DATABASE_BACKUP_PATH/shared_checksum` to your new directory
- trim all the strings so instead of `######_sxxxxxxxxx.sst`, it reads `######.sst`. A way of doing this with sed and bash is `for file in *.sst; do mv "$file" "$(echo "$file" | sed 's/_s.*/.sst/')"; done`
- copy all the files in `$DATABASE_BACKUP_PATH/1` (or the latest backup number if you have multiple) to your new directory
- set your `database_path` config option to your new directory, or replace your old one with the new one you crafted
+- in the online backup created, copy all `.sst` files in
+`$DATABASE_BACKUP_PATH/shared_checksum` to your new directory
+- trim all the strings so instead of `######_sxxxxxxxxx.sst`, it reads
+`######.sst`. A way of doing this with sed and bash is `for file in *.sst; do mv
+"$file" "$(echo "$file" | sed 's/_s.*/.sst/')"; done`
+- copy all the files in `$DATABASE_BACKUP_PATH/1` (or the latest backup number
+if you have multiple) to your new directory
+- set your `database_path` config option to your new directory, or replace your
+old one with the new one you crafted
 - start up conduwuit again and it should open as normal

-If you'd like to do an offline backup, shutdown conduwuit and copy your `database_path` directory elsewhere. This can be restored with no modifications needed.
+If you'd like to do an offline backup, shutdown conduwuit and copy your
+`database_path` directory elsewhere. This can be restored with no modifications
+needed.

-Backing up media is also just copying the `media/` directory from your database directory.
+Backing up media is also just copying the `media/` directory from your database
+directory.

 ## Media

 Media still needs various work, however conduwuit implements media deletion via:

- MXC URI or Event ID (unencrypted and attempts to find the MXC URI in the event)
+- MXC URI or Event ID (unencrypted and attempts to find the MXC URI in the
+event)
 - Delete list of MXC URIs
- Delete remote media in the past `N` seconds/minutes via filesystem metadata on the file created time (`btime`) or file modified time (`mtime`)
+- Delete remote media in the past `N` seconds/minutes via filesystem metadata on
+the file created time (`btime`) or file modified time (`mtime`)

-See the `!admin media` command for further information. All media in conduwuit is stored at `$DATABASE_DIR/media`. This will be configurable soon.
+See the `!admin media` command for further information. All media in conduwuit
+is stored at `$DATABASE_DIR/media`. This will be configurable soon.

-If you are finding yourself needing extensive granular control over media, we recommend looking into [Matrix Media Repo](https://github.com/t2bot/matrix-media-repo). conduwuit intends to implement various utilities for media, but MMR is dedicated to extensive media management.
+If you are finding yourself needing extensive granular control over media, we
+recommend looking into [Matrix Media
+Repo](https://github.com/t2bot/matrix-media-repo). conduwuit intends to
+implement various utilities for media, but MMR is dedicated to extensive media
+management.

-Built-in S3 support is also planned, but for now using a "S3 filesystem" on `media/` works. conduwuit also sends a `Cache-Control` header of 1 year and immutable for all media requests (download and thumbnail) to reduce unnecessary media requests from browsers, reduce bandwidth usage, and reduce load.
+Built-in S3 support is also planned, but for now using a "S3 filesystem" on
+`media/` works. conduwuit also sends a `Cache-Control` header of 1 year and
+immutable for all media requests (download and thumbnail) to reduce unnecessary
+media requests from browsers, reduce bandwidth usage, and reduce load.
@@ -2,34 +2,66 @@

 > ## Docker users ⚠️
 >
-> Docker is extremely UX unfriendly. Because of this, a ton of issues or support is actually Docker support, not conduwuit support. We also cannot document the ever-growing list of Docker issues here.
+> Docker is extremely UX unfriendly. Because of this, a ton of issues or support
+> is actually Docker support, not conduwuit support. We also cannot document the
+> ever-growing list of Docker issues here.
 >
-> If you intend on asking for support and you are using Docker, **PLEASE** triple validate your issues are **NOT** because you have a misconfiguration in your Docker setup.
+> If you intend on asking for support and you are using Docker, **PLEASE**
+> triple validate your issues are **NOT** because you have a misconfiguration in
+> your Docker setup.
 >
-> If there are things like Compose file issues or Dockerhub image issues, those can still be mentioned as long as they're something we can fix.
+> If there are things like Compose file issues or Dockerhub image issues, those
+> can still be mentioned as long as they're something we can fix.
+
+## conduwuit and Matrix issues
+
+#### Lost access to admin room
+
+You can reinvite yourself to the admin room through the following methods:
+- Use the `--execute "users make_user_admin <username>"` conduwuit binary
+argument once to invite yourslf to the admin room on startup
+- Use the conduwuit console/CLI to run the `users make_user_admin` command
+- Or specify the `emergency_password` config option to allow you to temporarily
+log into the server account (`@conduit`) from a web client

 ## General potential issues

 #### Potential DNS issues when using Docker

-Docker has issues with its default DNS setup that may cause DNS to not be properly functional when running conduwuit, resulting in federation issues.
-The symptoms of this have shown in excessively long room joins (30+ minutes) from very long DNS timeouts, log entries of "mismatching responding nameservers", and/or partial or non-functional inbound/outbound federation.
+Docker has issues with its default DNS setup that may cause DNS to not be
+properly functional when running conduwuit, resulting in federation issues. The
+symptoms of this have shown in excessively long room joins (30+ minutes) from
+very long DNS timeouts, log entries of "mismatching responding nameservers",
+and/or partial or non-functional inbound/outbound federation.

-This is **not** a conduwuit issue, and is purely a Docker issue. It is not sustainable for heavy DNS activity which is normal for Matrix federation. The workarounds for this are:
+This is **not** a conduwuit issue, and is purely a Docker issue. It is not
+sustainable for heavy DNS activity which is normal for Matrix federation. The
+workarounds for this are:
 - Use DNS over TCP via the config option `query_over_tcp_only = true`
- Don't use Docker's default DNS setup and instead allow the container to use and communicate with your host's DNS servers (host's `/etc/resolv.conf`)
+- Don't use Docker's default DNS setup and instead allow the container to use
+and communicate with your host's DNS servers (host's `/etc/resolv.conf`)

-## Rocksdb / database issues
+## RocksDB / database issues

 #### Direct IO

-Some filesystems may not like RocksDB using [Direct IO](https://github.com/facebook/rocksdb/wiki/Direct-IO). Direct IO is for non-buffered I/O which improves conduwuit performance, but at least FUSE is a filesystem potentially known to not like this. See the [example config](configuration/examples.md) for disabling it if needed. Issues from Direct IO on unsupported filesystems are usually shown as startup errors.
+Some filesystems may not like RocksDB using [Direct
+IO](https://github.com/facebook/rocksdb/wiki/Direct-IO). Direct IO is for
+non-buffered I/O which improves conduwuit performance, but at least FUSE is a
+filesystem potentially known to not like this. See the [example
+config](configuration/examples.md) for disabling it if needed. Issues from
+Direct IO on unsupported filesystems are usually shown as startup errors.

 #### Database corruption

-If your database is corrupted *and* is failing to start (e.g. checksum mismatch), it may be recoverable but careful steps must be taken, and there is no guarantee it may be recoverable.
+If your database is corrupted *and* is failing to start (e.g. checksum
+mismatch), it may be recoverable but careful steps must be taken, and there is
+no guarantee it may be recoverable.

-The first thing that can be done is launching conduwuit with the `rocksdb_repair` config option set to true. This will tell RocksDB to attempt to repair itself at launch. If this does not work, disable the option and continue reading.
+The first thing that can be done is launching conduwuit with the
+`rocksdb_repair` config option set to true. This will tell RocksDB to attempt to
+repair itself at launch. If this does not work, disable the option and continue
+reading.

 RocksDB has the following recovery modes:

@@ -38,33 +70,59 @@ RocksDB has the following recovery modes:
 - `PointInTime`
 - `SkipAnyCorruptedRecord`

-By default, conduwuit uses `TolerateCorruptedTailRecords` as generally these may be due to bad federation and we can re-fetch the correct data over federation. The RocksDB default is `PointInTime` which will attempt to restore a "snapshot" of the data when it was last known to be good. This data can be either a few seconds old, or multiple minutes prior. `PointInTime` may not be suitable for default usage due to clients and servers possibly not being able to handle sudden "backwards time travels", and `AbsoluteConsistency` may be too strict.
+By default, conduwuit uses `TolerateCorruptedTailRecords` as generally these may
+be due to bad federation and we can re-fetch the correct data over federation.
+The RocksDB default is `PointInTime` which will attempt to restore a "snapshot"
+of the data when it was last known to be good. This data can be either a few
+seconds old, or multiple minutes prior. `PointInTime` may not be suitable for
+default usage due to clients and servers possibly not being able to handle
+sudden "backwards time travels", and `AbsoluteConsistency` may be too strict.

-`AbsoluteConsistency` will fail to start the database if any sign of corruption is detected. `SkipAnyCorruptedRecord` will skip all forms of corruption unless it forbids the database from opening (e.g. too severe). Usage of `SkipAnyCorruptedRecord` voids any support as this may cause more damage and/or leave your database in a permanently inconsistent state, but it may do something if `PointInTime` does not work as a last ditch effort.
+`AbsoluteConsistency` will fail to start the database if any sign of corruption
+is detected. `SkipAnyCorruptedRecord` will skip all forms of corruption unless
+it forbids the database from opening (e.g. too severe). Usage of
+`SkipAnyCorruptedRecord` voids any support as this may cause more damage and/or
+leave your database in a permanently inconsistent state, but it may do something
+if `PointInTime` does not work as a last ditch effort.

 With this in mind:

- First start conduwuit with the `PointInTime` recovery method. See the [example config](configuration/examples.md) for how to do this using `rocksdb_recovery_mode`
- If your database successfully opens, clients are recommended to clear their client cache to account for the rollback
- Leave your conduwuit running in `PointInTime` for at least 30-60 minutes so as much possible corruption is restored
- If all goes will, you should be able to restore back to using `TolerateCorruptedTailRecords` and you have successfully recovered your database
+- First start conduwuit with the `PointInTime` recovery method. See the [example
+config](configuration/examples.md) for how to do this using
+`rocksdb_recovery_mode`
+- If your database successfully opens, clients are recommended to clear their
+client cache to account for the rollback
+- Leave your conduwuit running in `PointInTime` for at least 30-60 minutes so as
+much possible corruption is restored
+- If all goes will, you should be able to restore back to using
+`TolerateCorruptedTailRecords` and you have successfully recovered your database

 ## Debugging

-Note that users should not really be debugging things. If you find yourself debugging and find the issue, please let us know and/or how we can fix it. Various debug commands can be found in `!admin debug`.
+Note that users should not really be debugging things. If you find yourself
+debugging and find the issue, please let us know and/or how we can fix it.
+Various debug commands can be found in `!admin debug`.

 #### Debug/Trace log level

-conduwuit builds without debug or trace log levels by default for at least performance reasons. This may change in the future and/or binaries providing such configurations may be provided. If you need to access debug/trace log levels, you will need to build without the `release_max_log_level` feature.
+conduwuit builds without debug or trace log levels by default for at least
+performance reasons. This may change in the future and/or binaries providing
+such configurations may be provided. If you need to access debug/trace log
+levels, you will need to build without the `release_max_log_level` feature.

 #### Changing log level dynamically

-conduwuit supports changing the tracing log environment filter on-the-fly using the admin command `!admin debug change-log-level`. This accepts a string **without quotes** the same format as the `log` config option.
+conduwuit supports changing the tracing log environment filter on-the-fly using
+the admin command `!admin debug change-log-level`. This accepts a string
+**without quotes** the same format as the `log` config option.

 #### Pinging servers

-conduwuit can ping other servers using `!admin debug ping`. This takes a server name and goes through the server discovery process and queries `/_matrix/federation/v1/version`. Errors are outputted.
+conduwuit can ping other servers using `!admin debug ping`. This takes a server
+name and goes through the server discovery process and queries
+`/_matrix/federation/v1/version`. Errors are outputted.

 #### Allocator memory stats

-When using jemalloc with jemallocator's `stats` feature, you can see conduwuit's jemalloc memory stats by using `!admin debug memory-stats`
+When using jemalloc with jemallocator's `stats` feature, you can see conduwuit's
+jemalloc memory stats by using `!admin debug memory-stats`
@@ -1,6 +1,8 @@
 # Setting up TURN/STURN

-In order to make or receive calls, a TURN server is required. conduwuit suggests using [Coturn](https://github.com/coturn/coturn) for this purpose, which is also available as a Docker image.
+In order to make or receive calls, a TURN server is required. conduwuit suggests
+using [Coturn](https://github.com/coturn/coturn) for this purpose, which is also
+available as a Docker image.

 ### Configuration

@@ -12,20 +14,25 @@ static-auth-secret=<a secret key>
 realm=<your server domain>
 ```

-A common way to generate a suitable alphanumeric secret key is by using `pwgen -s 64 1`.
+A common way to generate a suitable alphanumeric secret key is by using `pwgen
+-s 64 1`.

-These same values need to be set in conduwuit. See the [example config](configuration/examples.md) in the TURN section for configuring these and restart conduwuit after.
+These same values need to be set in conduwuit. See the [example
+config](configuration/examples.md) in the TURN section for configuring these and
+restart conduwuit after.

 ### Run

 Run the [Coturn](https://hub.docker.com/r/coturn/coturn) image using

 ```bash
-docker run -d --network=host -v $(pwd)/coturn.conf:/etc/coturn/turnserver.conf coturn/coturn
+docker run -d --network=host -v
+$(pwd)/coturn.conf:/etc/coturn/turnserver.conf coturn/coturn
 ```

-or docker-compose. For the latter, paste the following section into a file called `docker-compose.yml`
-and run `docker compose up -d` in the same directory.
+or docker-compose. For the latter, paste the following section into a file
+called `docker-compose.yml` and run `docker compose up -d` in the same
+directory.

 ```yml
 version: 3
@@ -39,6 +46,9 @@ services:
        - ./coturn.conf:/etc/coturn/turnserver.conf
 ```

-To understand why the host networking mode is used and explore alternative configuration options, please visit [Coturn's Docker documentation](https://github.com/coturn/coturn/blob/master/docker/coturn/README.md).
+To understand why the host networking mode is used and explore alternative
+configuration options, please visit [Coturn's Docker
+documentation](https://github.com/coturn/coturn/blob/master/docker/coturn/README.md).

-For security recommendations see Synapse's [Coturn documentation](https://element-hq.github.io/synapse/latest/turn-howto.html).
+For security recommendations see Synapse's [Coturn
+documentation](https://element-hq.github.io/synapse/latest/turn-howto.html).
@@ -34,7 +34,7 @@
        inherit pkgs;
        book = self.callPackage ./nix/pkgs/book {};
        complement = self.callPackage ./nix/pkgs/complement {};
-        craneLib = ((inputs.crane.mkLib pkgs).overrideToolchain toolchain);
+        craneLib = ((inputs.crane.mkLib pkgs).overrideToolchain (_: toolchain));
        inherit inputs;
        main = self.callPackage ./nix/pkgs/main {};
        oci-image = self.callPackage ./nix/pkgs/oci-image {};
@@ -12,5 +12,15 @@
  "nix": {
    "enabled": true
  },
-  "labels": ["dependencies", "github_actions"]
+  "labels": [
+    "dependencies",
+    "github_actions"
+  ],
+  "ignoreDeps": [
+    "tikv-jemllocator",
+    "tikv-jemalloc-sys",
+    "tikv-jemalloc-ctl",
+    "opentelemetry-rust",
+    "tracing-opentelemetry"
+  ]
 }
@@ -15,7 +15,7 @@ use conduit::{
 	},
 	trace,
 	utils::string::{collect_stream, common_prefix},
-	Error, Result,
+	warn, Error, Result,
 };
 use futures_util::future::FutureExt;
 use ruma::{
@@ -114,7 +114,15 @@ async fn process(context: &Command<'_>, command: AdminCommand, args: &[String])

 fn capture_create(context: &Command<'_>) -> (Arc<Capture>, Arc<Mutex<String>>) {
 	let env_config = &context.services.server.config.admin_log_capture;
-	let env_filter = EnvFilter::try_new(env_config).unwrap_or_else(|_| "debug".into());
+	let env_filter = EnvFilter::try_new(env_config).unwrap_or_else(|e| {
+		warn!("admin_log_capture filter invalid: {e:?}");
+		cfg!(debug_assertions)
+			.then_some("debug")
+			.or(Some("info"))
+			.map(Into::into)
+			.expect("default capture EnvFilter")
+	});
+
 	let log_level = env_filter
 		.max_level_hint()
 		.and_then(LevelFilter::into_level)
@@ -1,13 +1,11 @@
-use std::fmt::Write;
-
 use conduit::Result;
 use ruma::events::room::message::RoomMessageEventContent;

-use crate::{admin_command, escape_html, get_room_info, PAGE_SIZE};
+use crate::{admin_command, get_room_info, PAGE_SIZE};

 #[admin_command]
 pub(super) async fn list_rooms(
-	&self, page: Option<usize>, exclude_disabled: bool, exclude_banned: bool,
+	&self, page: Option<usize>, exclude_disabled: bool, exclude_banned: bool, no_details: bool,
 ) -> Result<RoomMessageEventContent> {
 	// TODO: i know there's a way to do this with clap, but i can't seem to find it
 	let page = page.unwrap_or(1);
@@ -61,29 +59,18 @@ pub(super) async fn list_rooms(
 	};

 	let output_plain = format!(
-		"Rooms:\n{}",
+		"Rooms ({}):\n```\n{}\n```",
+		rooms.len(),
 		rooms
 			.iter()
-			.map(|(id, members, name)| format!("{id}\tMembers: {members}\tName: {name}"))
+			.map(|(id, members, name)| if no_details {
+				format!("{id}")
+			} else {
+				format!("{id}\tMembers: {members}\tName: {name}")
+			})
 			.collect::<Vec<_>>()
 			.join("\n")
 	);
-	let output_html = format!(
-		"<table><caption>Room list - page \
-		 {page}</caption>\n<tr><th>id</th>\t<th>members</th>\t<th>name</th></tr>\n{}</table>",
-		rooms
-			.iter()
-			.fold(String::new(), |mut output, (id, members, name)| {
-				writeln!(
-					output,
-					"<tr><td>{}</td>\t<td>{}</td>\t<td>{}</td></tr>",
-					escape_html(id.as_ref()),
-					members,
-					escape_html(name)
-				)
-				.expect("should be able to write to string buffer");
-				output
-			})
-	);
-	Ok(RoomMessageEventContent::text_html(output_plain, output_html))
+
+	Ok(RoomMessageEventContent::notice_markdown(output_plain))
 }
@@ -27,6 +27,11 @@ pub(super) enum RoomCommand {
 		/// Excludes rooms that we have banned
 		#[arg(long)]
 		exclude_banned: bool,
+
+		#[arg(long)]
+		/// Whether to only output room IDs without supplementary room
+		/// information
+		no_details: bool,
 	},

 	#[command(subcommand)]
@@ -1,6 +1,6 @@
 use std::{collections::BTreeMap, fmt::Write as _};

-use api::client::{join_room_by_id_helper, leave_all_rooms, update_avatar_url, update_displayname};
+use api::client::{join_room_by_id_helper, leave_all_rooms, leave_room, update_avatar_url, update_displayname};
 use conduit::{error, info, utils, warn, PduBuilder, Result};
 use ruma::{
 	events::{
@@ -13,7 +13,7 @@ use ruma::{
 use serde_json::value::to_raw_value;

 use crate::{
-	admin_command, escape_html, get_room_info,
+	admin_command, get_room_info,
 	utils::{parse_active_local_user_id, parse_local_user_id},
 };

@@ -320,7 +320,7 @@ pub(super) async fn list_joined_rooms(&self, user_id: String) -> Result<RoomMess
 	rooms.reverse();

 	let output_plain = format!(
-		"Rooms {user_id} Joined ({}):\n{}",
+		"Rooms {user_id} Joined ({}):\n```\n{}\n```",
 		rooms.len(),
 		rooms
 			.iter()
@@ -329,26 +329,7 @@ pub(super) async fn list_joined_rooms(&self, user_id: String) -> Result<RoomMess
 			.join("\n")
 	);

-	let output_html = format!(
-		"<table><caption>Rooms {user_id} Joined \
-		 ({})</caption>\n<tr><th>id</th>\t<th>members</th>\t<th>name</th></tr>\n{}</table>",
-		rooms.len(),
-		rooms
-			.iter()
-			.fold(String::new(), |mut output, (id, members, name)| {
-				writeln!(
-					output,
-					"<tr><td>{}</td>\t<td>{}</td>\t<td>{}</td></tr>",
-					escape_html(id.as_ref()),
-					members,
-					escape_html(name)
-				)
-				.unwrap();
-				output
-			})
-	);
-
-	Ok(RoomMessageEventContent::text_html(output_plain, output_html))
+	Ok(RoomMessageEventContent::notice_markdown(output_plain))
 }

 #[admin_command]
@@ -369,6 +350,24 @@ pub(super) async fn force_join_room(
 	)))
 }

+#[admin_command]
+pub(super) async fn force_leave_room(
+	&self, user_id: String, room_id: OwnedRoomOrAliasId,
+) -> Result<RoomMessageEventContent> {
+	let user_id = parse_local_user_id(self.services, &user_id)?;
+	let room_id = self.services.rooms.alias.resolve(&room_id).await?;
+
+	assert!(
+		self.services.globals.user_is_local(&user_id),
+		"Parsed user_id must be a local user"
+	);
+	leave_room(self.services, &user_id, &room_id, None).await?;
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"{user_id} has left {room_id}.",
+	)))
+}
+
 #[admin_command]
 pub(super) async fn make_user_admin(&self, user_id: String) -> Result<RoomMessageEventContent> {
 	let user_id = parse_local_user_id(self.services, &user_id)?;
@@ -73,6 +73,12 @@ pub(super) enum UserCommand {
 		room_id: OwnedRoomOrAliasId,
 	},

+	/// - Manually leave a local user from a room.
+	ForceLeaveRoom {
+		user_id: String,
+		room_id: OwnedRoomOrAliasId,
+	},
+
 	/// - Grant server-admin privileges to a user.
 	MakeUserAdmin {
 		user_id: String,
@@ -0,0 +1,47 @@
+use axum::extract::State;
+use conduit::{err, Err, Result};
+use ruma::api::{appservice::ping, client::appservice::request_ping};
+
+use crate::Ruma;
+
+/// # `POST /_matrix/client/v1/appservice/{appserviceId}/ping`
+///
+/// Ask the homeserver to ping the application service to ensure the connection
+/// works.
+pub(crate) async fn appservice_ping(
+	State(services): State<crate::State>, body: Ruma<request_ping::v1::Request>,
+) -> Result<request_ping::v1::Response> {
+	let appservice_info = body
+		.appservice_info
+		.as_ref()
+		.ok_or_else(|| err!(Request(Forbidden("This endpoint can only be called by appservices."))))?;
+
+	if body.appservice_id != appservice_info.registration.id {
+		return Err!(Request(Forbidden(
+			"Appservices can only ping themselves (wrong appservice ID)."
+		)));
+	}
+
+	if appservice_info.registration.url.is_none() {
+		return Err!(Request(UrlNotSet(
+			"Appservice does not have a URL set, there is nothing to ping."
+		)));
+	}
+
+	let timer = tokio::time::Instant::now();
+
+	let _response = services
+		.sending
+		.send_appservice_request(
+			appservice_info.registration.clone(),
+			ping::send_ping::v1::Request {
+				transaction_id: body.transaction_id.clone(),
+			},
+		)
+		.await?
+		.expect("We already validated if an appservice URL exists above");
+
+	Ok(request_ping::v1::Response {
+		duration: timer.elapsed(),
+	})
+}
@@ -1,8 +1,11 @@
 use std::collections::BTreeMap;

 use axum::extract::State;
-use ruma::api::client::discovery::get_capabilities::{
-	self, Capabilities, RoomVersionStability, RoomVersionsCapability, ThirdPartyIdChangesCapability,
+use ruma::{
+	api::client::discovery::get_capabilities::{
+		self, Capabilities, RoomVersionStability, RoomVersionsCapability, ThirdPartyIdChangesCapability,
+	},
+	RoomVersionId,
 };

 use crate::{Result, Ruma};
@@ -14,13 +17,19 @@ use crate::{Result, Ruma};
 pub(crate) async fn get_capabilities_route(
 	State(services): State<crate::State>, _body: Ruma<get_capabilities::v3::Request>,
 ) -> Result<get_capabilities::v3::Response> {
-	let mut available = BTreeMap::new();
-	for room_version in &services.globals.unstable_room_versions {
-		available.insert(room_version.clone(), RoomVersionStability::Unstable);
-	}
-	for room_version in &services.globals.stable_room_versions {
-		available.insert(room_version.clone(), RoomVersionStability::Stable);
-	}
+	let available: BTreeMap<RoomVersionId, RoomVersionStability> = services
+		.globals
+		.unstable_room_versions
+		.iter()
+		.map(|unstable_room_version| (unstable_room_version.clone(), RoomVersionStability::Unstable))
+		.chain(
+			services
+				.globals
+				.stable_room_versions
+				.iter()
+				.map(|stable_room_version| (stable_room_version.clone(), RoomVersionStability::Stable)),
+		)
+		.collect();

 	let mut capabilities = Capabilities::default();
 	capabilities.room_versions = RoomVersionsCapability {
@@ -28,7 +37,7 @@ pub(crate) async fn get_capabilities_route(
 		available,
 	};

-	// conduit does not implement 3PID stuff
+	// we do not implement 3PID stuff
 	capabilities.thirdparty_id_changes = ThirdPartyIdChangesCapability {
 		enabled: false,
 	};
@@ -139,6 +139,14 @@ pub(crate) async fn set_room_visibility_route(
 					 \"lockdown_public_room_directory\" is enabled",
 					body.room_id
 				);
+				services
+					.admin
+					.send_text(&format!(
+						"Non-admin user {sender_user} tried to publish {0} to the room directory while \
+						 \"lockdown_public_room_directory\" is enabled",
+						body.room_id
+					))
+					.await;

 				return Err(Error::BadRequest(
 					ErrorKind::forbidden(),
@@ -147,7 +155,11 @@ pub(crate) async fn set_room_visibility_route(
 			}

 			services.rooms.directory.set_public(&body.room_id)?;
-			info!("{sender_user} made {0} public", body.room_id);
+			services
+				.admin
+				.send_text(&format!("{sender_user} made {} public to the room directory", body.room_id))
+				.await;
+			info!("{sender_user} made {0} public to the room directory", body.room_id);
 		},
 		room::Visibility::Private => services.rooms.directory.set_not_public(&body.room_id)?,
 		_ => {
@@ -20,7 +20,8 @@ use ruma::{
 			error::ErrorKind,
 			membership::{
 				ban_user, forget_room, get_member_events, invite_user, join_room_by_id, join_room_by_id_or_alias,
-				joined_members, joined_rooms, kick_user, leave_room, unban_user, ThirdPartySigned,
+				joined_members::{self, v3::RoomMember},
+				joined_rooms, kick_user, leave_room, unban_user, ThirdPartySigned,
 			},
 		},
 		federation::{self, membership::create_invite},
@@ -635,24 +636,22 @@ pub(crate) async fn joined_members_route(
 		));
 	}

-	let mut joined = BTreeMap::new();
-	for user_id in services
+	let joined: BTreeMap<OwnedUserId, RoomMember> = services
 		.rooms
 		.state_cache
 		.room_members(&body.room_id)
-		.filter_map(Result::ok)
-	{
-		let display_name = services.users.displayname(&user_id)?;
-		let avatar_url = services.users.avatar_url(&user_id)?;
+		.filter_map(|user| {
+			let user = user.ok()?;

-		joined.insert(
-			user_id,
-			joined_members::v3::RoomMember {
-				display_name,
-				avatar_url,
-			},
-		);
-	}
+			Some((
+				user.clone(),
+				RoomMember {
+					display_name: services.users.displayname(&user).unwrap_or_default(),
+					avatar_url: services.users.avatar_url(&user).unwrap_or_default(),
+				},
+			))
+		})
+		.collect();

 	Ok(joined_members::v3::Response {
 		joined,
@@ -1,5 +1,6 @@
 pub(super) mod account;
 pub(super) mod alias;
+pub(super) mod appservice;
 pub(super) mod backup;
 pub(super) mod capabilities;
 pub(super) mod config;
@@ -38,6 +39,7 @@ pub(super) mod voip;

 pub(super) use account::*;
 pub(super) use alias::*;
+pub(super) use appservice::*;
 pub(super) use backup::*;
 pub(super) use capabilities::*;
 pub(super) use config::*;
@@ -31,6 +31,8 @@ pub(crate) async fn report_event_route(
 		body.room_id, body.event_id
 	);

+	delay_response().await;
+
 	// check if we know about the reported event ID or if it's invalid
 	let Some(pdu) = services.rooms.timeline.get_pdu(&body.event_id)? else {
 		return Err(Error::BadRequest(
@@ -81,21 +83,19 @@ pub(crate) async fn report_event_route(
 		))
 		.await;

-	delay_response().await?;
-
 	Ok(report_content::v3::Response {})
 }

 /// in the following order:
 ///
 /// check if the room ID from the URI matches the PDU's room ID
-/// check if reporting user is in the reporting room
 /// check if score is in valid range
 /// check if report reasoning is less than or equal to 750 characters
+/// check if reporting user is in the reporting room
 fn is_report_valid(
 	services: &Services, event_id: &EventId, room_id: &RoomId, sender_user: &UserId, reason: &Option<String>,
 	score: Option<ruma::Int>, pdu: &std::sync::Arc<PduEvent>,
-) -> Result<bool> {
+) -> Result<()> {
 	debug_info!("Checking if report from user {sender_user} for event {event_id} in room {room_id} is valid");

 	if room_id != pdu.room_id {
@@ -105,10 +105,24 @@ fn is_report_valid(
 		));
 	}

+	if score.is_some_and(|s| s > int!(0) || s < int!(-100)) {
+		return Err(Error::BadRequest(
+			ErrorKind::InvalidParam,
+			"Invalid score, must be within 0 to -100",
+		));
+	};
+
+	if reason.as_ref().is_some_and(|s| s.len() > 750) {
+		return Err(Error::BadRequest(
+			ErrorKind::InvalidParam,
+			"Reason too long, should be 750 characters or fewer",
+		));
+	};
+
 	if !services
 		.rooms
 		.state_cache
-		.room_members(&pdu.room_id)
+		.room_members(room_id)
 		.filter_map(Result::ok)
 		.any(|user_id| user_id == *sender_user)
 	{
@@ -118,30 +132,14 @@ fn is_report_valid(
 		));
 	}

-	if score.map(|s| s > int!(0) || s < int!(-100)) == Some(true) {
-		return Err(Error::BadRequest(
-			ErrorKind::InvalidParam,
-			"Invalid score, must be within 0 to -100",
-		));
-	};
-
-	if reason.clone().map(|s| s.len() >= 750) == Some(true) {
-		return Err(Error::BadRequest(
-			ErrorKind::InvalidParam,
-			"Reason too long, should be 750 characters or fewer",
-		));
-	};
-
-	Ok(true)
+	Ok(())
 }

 /// even though this is kinda security by obscurity, let's still make a small
-/// random delay sending a successful response per spec suggestion regarding
+/// random delay sending a response per spec suggestion regarding
 /// enumerating for potential events existing in our server.
-async fn delay_response() -> Result<()> {
-	let time_to_wait = rand::thread_rng().gen_range(8..21);
+async fn delay_response() {
+	let time_to_wait = rand::thread_rng().gen_range(3..10);
 	debug_info!("Got successful /report request, waiting {time_to_wait} seconds before sending successful response.");
 	sleep(Duration::from_secs(time_to_wait)).await;
-
-	Ok(())
 }
@@ -1,18 +1,18 @@
 use std::{
-	cmp,
-	cmp::Ordering,
+	cmp::{self, Ordering},
 	collections::{hash_map::Entry, BTreeMap, BTreeSet, HashMap, HashSet},
 	time::Duration,
 };

 use axum::extract::State;
 use conduit::{
-	error,
+	debug, error,
 	utils::math::{ruma_from_u64, ruma_from_usize, usize_from_ruma, usize_from_u64_truncated},
-	Err, PduCount,
+	warn, Err, PduCount,
 };
 use ruma::{
 	api::client::{
+		error::ErrorKind,
 		filter::{FilterDefinition, LazyLoadOptions},
 		sync::sync_events::{
 			self,
@@ -28,11 +28,14 @@ use ruma::{
 	events::{
 		presence::PresenceEvent,
 		room::member::{MembershipState, RoomMemberEventContent},
-		StateEventType, TimelineEventType,
+		AnyRawAccountDataEvent, StateEventType, TimelineEventType,
 	},
+	room::RoomType,
 	serde::Raw,
-	uint, DeviceId, EventId, OwnedUserId, RoomId, UInt, UserId,
+	state_res::Event,
+	uint, DeviceId, EventId, MilliSecondsSinceUnixEpoch, OwnedRoomId, OwnedUserId, RoomId, UInt, UserId,
 };
+use service::rooms::read_receipt::pack_receipts;
 use tracing::{Instrument as _, Span};

 use crate::{
@@ -40,6 +43,25 @@ use crate::{
 	utils, Error, PduEvent, Result, Ruma, RumaResponse,
 };

+const SINGLE_CONNECTION_SYNC: &str = "single_connection_sync";
+const DEFAULT_BUMP_TYPES: &[TimelineEventType] = &[
+	TimelineEventType::RoomMessage,
+	TimelineEventType::RoomEncrypted,
+	TimelineEventType::Sticker,
+	TimelineEventType::CallInvite,
+	TimelineEventType::PollStart,
+	TimelineEventType::Beacon,
+];
+
+macro_rules! extract_variant {
+	($e:expr, $variant:path) => {
+		match $e {
+			$variant(value) => Some(value),
+			_ => None,
+		}
+	};
+}
+
 /// # `GET /_matrix/client/r0/sync`
 ///
 /// Synchronize the client's state with the latest state on the server.
@@ -278,11 +300,7 @@ pub(crate) async fn sync_events_route(
 				.account_data
 				.changes_since(None, &sender_user, since)?
 				.into_iter()
-				.filter_map(|(_, v)| {
-					serde_json::from_str(v.json().get())
-						.map_err(|_| Error::bad_database("Invalid account event in database."))
-						.ok()
-				})
+				.filter_map(|e| extract_variant!(e, AnyRawAccountDataEvent::Global))
 				.collect(),
 		},
 		device_lists: DeviceLists {
@@ -323,7 +341,7 @@ pub(crate) async fn sync_events_route(
 #[tracing::instrument(skip_all, fields(user_id = %sender_user, room_id = %room_id), name = "left_room")]
 async fn handle_left_room(
 	services: &Services, since: u64, room_id: &RoomId, sender_user: &UserId,
-	left_rooms: &mut BTreeMap<ruma::OwnedRoomId, LeftRoom>, next_batch_string: &str, full_state: bool,
+	left_rooms: &mut BTreeMap<OwnedRoomId, LeftRoom>, next_batch_string: &str, full_state: bool,
 	lazy_load_enabled: bool,
 ) -> Result<()> {
 	// Get and drop the lock to wait for remaining operations to finish
@@ -975,11 +993,7 @@ async fn load_joined_room(
 				.account_data
 				.changes_since(Some(room_id), sender_user, since)?
 				.into_iter()
-				.filter_map(|(_, v)| {
-					serde_json::from_str(v.json().get())
-						.map_err(|_| Error::bad_database("Invalid account event in database."))
-						.ok()
-				})
+				.filter_map(|e| extract_variant!(e, AnyRawAccountDataEvent::Room))
 				.collect(),
 		},
 		summary: RoomSummary {
@@ -1078,7 +1092,7 @@ fn share_encrypted_room(
 /// Sliding Sync endpoint (future endpoint: `/_matrix/client/v4/sync`)
 pub(crate) async fn sync_events_v4_route(
 	State(services): State<crate::State>, body: Ruma<sync_events::v4::Request>,
-) -> Result<sync_events::v4::Response, RumaResponse<UiaaResponse>> {
+) -> Result<sync_events::v4::Response> {
 	let sender_user = body.sender_user.expect("user is authenticated");
 	let sender_device = body.sender_device.expect("user is authenticated");
 	let mut body = body.body;
@@ -1087,18 +1101,34 @@ pub(crate) async fn sync_events_v4_route(

 	let next_batch = services.globals.next_count()?;

+	let conn_id = body
+		.conn_id
+		.clone()
+		.unwrap_or_else(|| SINGLE_CONNECTION_SYNC.to_owned());
+
 	let globalsince = body
 		.pos
 		.as_ref()
 		.and_then(|string| string.parse().ok())
 		.unwrap_or(0);

+	if globalsince != 0
+		&& !services
+			.users
+			.remembered(sender_user.clone(), sender_device.clone(), conn_id.clone())
+	{
+		debug!("Restarting sync stream because it was gone from the database");
+		return Err(Error::Request(
+			ErrorKind::UnknownPos,
+			"Connection data lost since last time".into(),
+			http::StatusCode::BAD_REQUEST,
+		));
+	}
+
 	if globalsince == 0 {
-		if let Some(conn_id) = &body.conn_id {
-			services
-				.users
-				.forget_sync_request_connection(sender_user.clone(), sender_device.clone(), conn_id.clone());
-		}
+		services
+			.users
+			.forget_sync_request_connection(sender_user.clone(), sender_device.clone(), conn_id.clone());
 	}

 	// Get sticky parameters from cache
@@ -1114,6 +1144,20 @@ pub(crate) async fn sync_events_v4_route(
 		.filter_map(Result::ok)
 		.collect::<Vec<_>>();

+	let all_invited_rooms = services
+		.rooms
+		.state_cache
+		.rooms_invited(&sender_user)
+		.filter_map(Result::ok)
+		.map(|r| r.0)
+		.collect::<Vec<_>>();
+
+	let all_rooms = all_joined_rooms
+		.iter()
+		.cloned()
+		.chain(all_invited_rooms.clone())
+		.collect();
+
 	if body.extensions.to_device.enabled.unwrap_or(false) {
 		services
 			.users
@@ -1124,6 +1168,37 @@ pub(crate) async fn sync_events_v4_route(
 	let mut device_list_changes = HashSet::new();
 	let mut device_list_left = HashSet::new();

+	let mut receipts = sync_events::v4::Receipts {
+		rooms: BTreeMap::new(),
+	};
+
+	let mut account_data = sync_events::v4::AccountData {
+		global: Vec::new(),
+		rooms: BTreeMap::new(),
+	};
+	if body.extensions.account_data.enabled.unwrap_or(false) {
+		account_data.global = services
+			.account_data
+			.changes_since(None, &sender_user, globalsince)?
+			.into_iter()
+			.filter_map(|e| extract_variant!(e, AnyRawAccountDataEvent::Global))
+			.collect();
+
+		if let Some(rooms) = body.extensions.account_data.rooms {
+			for room in rooms {
+				account_data.rooms.insert(
+					room.clone(),
+					services
+						.account_data
+						.changes_since(Some(&room), &sender_user, globalsince)?
+						.into_iter()
+						.filter_map(|e| extract_variant!(e, AnyRawAccountDataEvent::Room))
+						.collect(),
+				);
+			}
+		}
+	}
+
 	if body.extensions.e2ee.enabled.unwrap_or(false) {
 		// Look for device list updates of this account
 		device_list_changes.extend(
@@ -1288,9 +1363,23 @@ pub(crate) async fn sync_events_v4_route(
 	let mut todo_rooms = BTreeMap::new(); // and required state

 	for (list_id, list) in body.lists {
-		if list.filters.and_then(|f| f.is_invite).unwrap_or(false) {
-			continue;
-		}
+		let active_rooms = match list.filters.clone().and_then(|f| f.is_invite) {
+			Some(true) => &all_invited_rooms,
+			Some(false) => &all_joined_rooms,
+			None => &all_rooms,
+		};
+
+		let active_rooms = match list.filters.clone().map(|f| f.not_room_types) {
+			Some(filter) if filter.is_empty() => active_rooms.clone(),
+			Some(value) => filter_rooms(active_rooms, State(services), &value, true),
+			None => active_rooms.clone(),
+		};
+
+		let active_rooms = match list.filters.clone().map(|f| f.room_types) {
+			Some(filter) if filter.is_empty() => active_rooms.clone(),
+			Some(value) => filter_rooms(&active_rooms, State(services), &value, false),
+			None => active_rooms,
+		};

 		let mut new_known_rooms = BTreeSet::new();

@@ -1303,13 +1392,15 @@ pub(crate) async fn sync_events_v4_route(
 					.map(|mut r| {
 						r.0 = r.0.clamp(
 							uint!(0),
-							UInt::try_from(all_joined_rooms.len().saturating_sub(1)).unwrap_or(UInt::MAX),
+							UInt::try_from(active_rooms.len().saturating_sub(1)).unwrap_or(UInt::MAX),
 						);
-						r.1 = r.1.clamp(
-							r.0,
-							UInt::try_from(all_joined_rooms.len().saturating_sub(1)).unwrap_or(UInt::MAX),
-						);
-						let room_ids = all_joined_rooms[usize_from_ruma(r.0)..=usize_from_ruma(r.1)].to_vec();
+						r.1 =
+							r.1.clamp(r.0, UInt::try_from(active_rooms.len().saturating_sub(1)).unwrap_or(UInt::MAX));
+						let room_ids = if !active_rooms.is_empty() {
+							active_rooms[usize_from_ruma(r.0)..=usize_from_ruma(r.1)].to_vec()
+						} else {
+							Vec::new()
+						};
 						new_known_rooms.extend(room_ids.iter().cloned());
 						for room_id in &room_ids {
 							let todo_room = todo_rooms
@@ -1342,7 +1433,7 @@ pub(crate) async fn sync_events_v4_route(
 						}
 					})
 					.collect(),
-				count: ruma_from_usize(all_joined_rooms.len()),
+				count: ruma_from_usize(active_rooms.len()),
 			},
 		);

@@ -1409,10 +1500,54 @@ pub(crate) async fn sync_events_v4_route(
 	for (room_id, (required_state_request, timeline_limit, roomsince)) in &todo_rooms {
 		let roomsincecount = PduCount::Normal(*roomsince);

-		let (timeline_pdus, limited) =
-			load_timeline(&services, &sender_user, room_id, roomsincecount, *timeline_limit)?;
+		let mut timestamp: Option<_> = None;
+		let mut invite_state = None;
+		let (timeline_pdus, limited);
+		if all_invited_rooms.contains(room_id) {
+			// TODO: figure out a timestamp we can use for remote invites
+			invite_state = services
+				.rooms
+				.state_cache
+				.invite_state(&sender_user, room_id)
+				.unwrap_or(None);

-		if roomsince != &0 && timeline_pdus.is_empty() {
+			(timeline_pdus, limited) = (Vec::new(), true);
+		} else {
+			(timeline_pdus, limited) =
+				match load_timeline(&services, &sender_user, room_id, roomsincecount, *timeline_limit) {
+					Ok(value) => value,
+					Err(err) => {
+						warn!("Encountered missing timeline in {}, error {}", room_id, err);
+						continue;
+					},
+				};
+		}
+
+		account_data.rooms.insert(
+			room_id.clone(),
+			services
+				.account_data
+				.changes_since(Some(room_id), &sender_user, *roomsince)?
+				.into_iter()
+				.filter_map(|e| extract_variant!(e, AnyRawAccountDataEvent::Room))
+				.collect(),
+		);
+
+		let room_receipts = services
+			.rooms
+			.read_receipt
+			.readreceipts_since(room_id, *roomsince);
+		let vector: Vec<_> = room_receipts.into_iter().collect();
+		let receipt_size = vector.len();
+		receipts
+			.rooms
+			.insert(room_id.clone(), pack_receipts(Box::new(vector.into_iter())));
+
+		if roomsince != &0
+			&& timeline_pdus.is_empty()
+			&& account_data.rooms.get(room_id).is_some_and(Vec::is_empty)
+			&& receipt_size == 0
+		{
 			continue;
 		}

@@ -1440,6 +1575,13 @@ pub(crate) async fn sync_events_v4_route(
 			.map(|(_, pdu)| pdu.to_sync_room_event())
 			.collect();

+		for (_, pdu) in timeline_pdus {
+			let ts = MilliSecondsSinceUnixEpoch(pdu.origin_server_ts);
+			if DEFAULT_BUMP_TYPES.contains(pdu.event_type()) && !timestamp.is_some_and(|time| time > ts) {
+				timestamp = Some(ts);
+			}
+		}
+
 		let required_state = required_state_request
 			.iter()
 			.map(|state| {
@@ -1520,7 +1662,7 @@ pub(crate) async fn sync_events_v4_route(
 				},
 				initial: Some(roomsince == &0),
 				is_dm: None,
-				invite_state: None,
+				invite_state,
 				unread_notifications: UnreadNotificationsCount {
 					highlight_count: Some(
 						services
@@ -1562,7 +1704,7 @@ pub(crate) async fn sync_events_v4_route(
 						.unwrap_or_else(|_| uint!(0)),
 				),
 				num_live: None, // Count events in timeline greater than global sync counter
-				timestamp: None,
+				timestamp,
 				heroes: Some(heroes),
 			},
 		);
@@ -1607,26 +1749,8 @@ pub(crate) async fn sync_events_v4_route(
 				// Fallback keys are not yet supported
 				device_unused_fallback_key_types: None,
 			},
-			account_data: sync_events::v4::AccountData {
-				global: if body.extensions.account_data.enabled.unwrap_or(false) {
-					services
-						.account_data
-						.changes_since(None, &sender_user, globalsince)?
-						.into_iter()
-						.filter_map(|(_, v)| {
-							serde_json::from_str(v.json().get())
-								.map_err(|_| Error::bad_database("Invalid account event in database."))
-								.ok()
-						})
-						.collect()
-				} else {
-					Vec::new()
-				},
-				rooms: BTreeMap::new(),
-			},
-			receipts: sync_events::v4::Receipts {
-				rooms: BTreeMap::new(),
-			},
+			account_data,
+			receipts,
 			typing: sync_events::v4::Typing {
 				rooms: BTreeMap::new(),
 			},
@@ -1634,3 +1758,35 @@ pub(crate) async fn sync_events_v4_route(
 		delta_token: None,
 	})
 }
+
+fn filter_rooms(
+	rooms: &[OwnedRoomId], State(services): State<crate::State>, filter: &[Option<RoomType>], negate: bool,
+) -> Vec<OwnedRoomId> {
+	return rooms
+		.iter()
+		.filter(|r| {
+			match services.rooms.state_accessor.get_room_type(r) {
+				Err(e) => {
+					warn!("Requested room type for {}, but could not retrieve with error {}", r, e);
+					false
+				},
+				Ok(None) => {
+					// For rooms which do not have a room type, use 'null' to include them
+					if negate {
+						!filter.contains(&None)
+					} else {
+						filter.contains(&None)
+					}
+				},
+				Ok(Some(room_type)) => {
+					if negate {
+						!filter.contains(&Some(room_type))
+					} else {
+						filter.is_empty() || filter.contains(&Some(room_type))
+					}
+				},
+			}
+		})
+		.cloned()
+		.collect();
+}
@@ -22,6 +22,7 @@ use crate::{client, server};
 pub fn build(router: Router<State>, server: &Server) -> Router<State> {
 	let config = &server.config;
 	let mut router = router
+        .ruma_route(client::appservice_ping)
 		.ruma_route(client::get_supported_versions_route)
 		.ruma_route(client::get_register_available_route)
 		.ruma_route(client::register_route)
@@ -249,7 +250,11 @@ pub fn build(router: Router<State>, server: &Server) -> Router<State> {
 			.route("/_matrix/media/v3/config", any(legacy_media_disabled))
 			.route("/_matrix/media/v3/download/*path", any(legacy_media_disabled))
 			.route("/_matrix/media/v3/thumbnail/*path", any(legacy_media_disabled))
-			.route("/_matrix/media/v3/preview_url", any(redirect_legacy_preview));
+			.route("/_matrix/media/v3/preview_url", any(redirect_legacy_preview))
+			.route("/_matrix/media/r0/config", any(legacy_media_disabled))
+			.route("/_matrix/media/r0/download/*path", any(legacy_media_disabled))
+			.route("/_matrix/media/r0/thumbnail/*path", any(legacy_media_disabled))
+			.route("/_matrix/media/r0/preview_url", any(redirect_legacy_preview));
 	}

 	router
@@ -1079,6 +1079,11 @@ fn default_sentry_filter() -> String { "info".to_owned() }

 fn default_startup_netburst_keep() -> i64 { 50 }

-fn default_admin_log_capture() -> String { "debug".to_owned() }
+fn default_admin_log_capture() -> String {
+	cfg!(debug_assertions)
+		.then_some("debug")
+		.unwrap_or("info")
+		.to_owned()
+}

 fn default_admin_room_tag() -> String { "m.server_notice".to_owned() }
@@ -1,10 +1,10 @@
 use std::{collections::HashMap, sync::Arc};

-use conduit::{utils, warn, Error, Result};
+use conduit::{Error, Result};
 use database::Map;
 use ruma::{
 	api::client::error::ErrorKind,
-	events::{AnyEphemeralRoomEvent, RoomAccountDataEventType},
+	events::{AnyGlobalAccountDataEvent, AnyRawAccountDataEvent, AnyRoomAccountDataEvent, RoomAccountDataEventType},
 	serde::Raw,
 	RoomId, UserId,
 };
@@ -110,7 +110,7 @@ impl Data {
 	/// Returns all changes to the account data that happened after `since`.
 	pub(super) fn changes_since(
 		&self, room_id: Option<&RoomId>, user_id: &UserId, since: u64,
-	) -> Result<HashMap<RoomAccountDataEventType, Raw<AnyEphemeralRoomEvent>>> {
+	) -> Result<Vec<AnyRawAccountDataEvent>> {
 		let mut userdata = HashMap::new();

 		let mut prefix = room_id
@@ -132,25 +132,21 @@ impl Data {
 			.take_while(move |(k, _)| k.starts_with(&prefix))
 			.map(|(k, v)| {
 				Ok::<_, Error>((
-					RoomAccountDataEventType::from(
-						utils::string_from_bytes(
-							k.rsplit(|&b| b == 0xFF)
-								.next()
-								.ok_or_else(|| Error::bad_database("RoomUserData ID in db is invalid."))?,
-						)
-						.map_err(|e| {
-							warn!("RoomUserData ID in database is invalid: {}", e);
-							Error::bad_database("RoomUserData ID in db is invalid.")
-						})?,
-					),
-					serde_json::from_slice::<Raw<AnyEphemeralRoomEvent>>(&v)
-						.map_err(|_| Error::bad_database("Database contains invalid account data."))?,
+					k,
+					match room_id {
+						None => serde_json::from_slice::<Raw<AnyGlobalAccountDataEvent>>(&v)
+							.map(AnyRawAccountDataEvent::Global)
+							.map_err(|_| Error::bad_database("Database contains invalid account data."))?,
+						Some(_) => serde_json::from_slice::<Raw<AnyRoomAccountDataEvent>>(&v)
+							.map(AnyRawAccountDataEvent::Room)
+							.map_err(|_| Error::bad_database("Database contains invalid account data."))?,
+					},
 				))
 			}) {
 			let (kind, data) = r?;
 			userdata.insert(kind, data);
 		}

-		Ok(userdata)
+		Ok(userdata.into_values().collect())
 	}
 }
@@ -1,12 +1,11 @@
 mod data;

-use std::{collections::HashMap, sync::Arc};
+use std::sync::Arc;

 use conduit::Result;
 use data::Data;
 use ruma::{
-	events::{AnyEphemeralRoomEvent, RoomAccountDataEventType},
-	serde::Raw,
+	events::{AnyRawAccountDataEvent, RoomAccountDataEventType},
 	RoomId, UserId,
 };

@@ -47,7 +46,7 @@ impl Service {
 	#[tracing::instrument(skip_all, name = "since", level = "debug")]
 	pub fn changes_since(
 		&self, room_id: Option<&RoomId>, user_id: &UserId, since: u64,
-	) -> Result<HashMap<RoomAccountDataEventType, Raw<AnyEphemeralRoomEvent>>> {
+	) -> Result<Vec<AnyRawAccountDataEvent>> {
 		self.db.changes_since(room_id, user_id, since)
 	}
 }
@@ -123,9 +123,8 @@ impl super::Service {
 		self.services.timeline.build_and_append_pdu(
  			PduBuilder {
                event_type: TimelineEventType::RoomMessage,
-                content: to_raw_value(&RoomMessageEventContent::text_html(
-                        format!("## Thank you for trying out conduwuit!\n\nconduwuit is a fork of upstream Conduit which is in Beta. This means you can join and participate in most Matrix rooms, but not all features are supported and you might run into bugs from time to time.\n\nHelpful links:\n> Git and Documentation: https://github.com/girlbossceo/conduwuit\n> Report issues: https://github.com/girlbossceo/conduwuit/issues\n\nFor a list of available commands, send the following message in this room: `@conduit:{}: --help`\n\nHere are some rooms you can join (by typing the command):\n\nconduwuit room (Ask questions and get notified on updates):\n`/join #conduwuit:puppygock.gay`", self.services.globals.server_name()),
-                        format!("<h2>Thank you for trying out conduwuit!</h2>\n<p>conduwuit is a fork of upstream Conduit which is in Beta. This means you can join and participate in most Matrix rooms, but not all features are supported and you might run into bugs from time to time.</p>\n<p>Helpful links:</p>\n<blockquote>\n<p>Git and Documentation: https://github.com/girlbossceo/conduwuit<br>Report issues: https://github.com/girlbossceo/conduwuit/issues</p>\n</blockquote>\n<p>For a list of available commands, send the following message in this room: <code>@conduit:{}: --help</code></p>\n<p>Here are some rooms you can join (by typing the command):</p>\n<p>conduwuit room (Ask questions and get notified on updates):<br><code>/join #conduwuit:puppygock.gay</code></p>\n", self.services.globals.server_name()),
+                content: to_raw_value(&RoomMessageEventContent::text_markdown(
+                        String::from("## Thank you for trying out conduwuit!\n\nconduwuit is a fork of upstream Conduit which is in Beta. This means you can join and participate in most Matrix rooms, but not all features are supported and you might run into bugs from time to time.\n\nHelpful links:\n> Git and Documentation: https://github.com/girlbossceo/conduwuit\n> Report issues: https://github.com/girlbossceo/conduwuit/issues\n\nFor a list of available commands, send the following message in this room: `!admin --help`\n\nHere are some rooms you can join (by typing the command):\n\nconduwuit room (Ask questions and get notified on updates):\n`/join #conduwuit:puppygock.gay`"),
                ))
                .expect("event is valid, we just created it"),
                unsigned: None,
@@ -92,12 +92,12 @@ fn startup_command_error(i: usize, content: &RoomMessageEventContent) -> Result<
 #[cfg(not(feature = "console"))]
 #[implement(super::Service)]
 fn startup_command_output(i: usize, content: &RoomMessageEventContent) -> Result<()> {
-	info!("Startup command #{i} completed:\n{:#?}", content.body());
+	info!("Startup command #{i} completed:\n{:#}", content.body());
 	Ok(())
 }

 #[cfg(not(feature = "console"))]
 #[implement(super::Service)]
 fn startup_command_error(i: usize, content: &RoomMessageEventContent) -> Result<()> {
-	Err!(error!("Startup command #{i} failed:\n{:#?}", content.body()))
+	Err!(error!("Startup command #{i} failed:\n{:#}", content.body()))
 }
@@ -120,7 +120,7 @@ fn base(config: &Config) -> Result<reqwest::ClientBuilder> {
 		builder = if config.zstd_compression {
 			builder.zstd(true)
 		} else {
-			builder.zstd(false).no_brotli()
+			builder.zstd(false).no_zstd()
 		};
 	};

@@ -8,7 +8,7 @@ use std::{
 	time::Instant,
 };

-use conduit::{error, trace, Config, Result};
+use conduit::{err, error, trace, Config, Result};
 use data::Data;
 use ipaddress::IPAddress;
 use regex::RegexSet;
@@ -76,12 +76,13 @@ impl crate::Service for Service {
 		// Experimental, partially supported room versions
 		let unstable_room_versions = vec![RoomVersionId::V2, RoomVersionId::V3, RoomVersionId::V4, RoomVersionId::V5];

-		let mut cidr_range_denylist = Vec::new();
-		for cidr in config.ip_range_denylist.clone() {
-			let cidr = IPAddress::parse(cidr).expect("valid cidr range");
-			trace!("Denied CIDR range: {:?}", cidr);
-			cidr_range_denylist.push(cidr);
-		}
+		let cidr_range_denylist: Vec<_> = config
+			.ip_range_denylist
+			.iter()
+			.map(IPAddress::parse)
+			.inspect(|cidr| trace!("Denied CIDR range: {cidr:?}"))
+			.collect::<Result<_, String>>()
+			.map_err(|e| err!(Config("ip_range_denylist", e)))?;

 		let mut s = Self {
 			db,
@@ -2,17 +2,11 @@ use std::{mem::size_of, sync::Arc};

 use conduit::{utils, Error, Result};
 use database::Map;
-use ruma::{
-	events::{receipt::ReceiptEvent, AnySyncEphemeralRoomEvent},
-	serde::Raw,
-	CanonicalJsonObject, OwnedUserId, RoomId, UserId,
-};
+use ruma::{events::receipt::ReceiptEvent, serde::Raw, CanonicalJsonObject, RoomId, UserId};

+use super::AnySyncEphemeralRoomEventIter;
 use crate::{globals, Dep};

-type AnySyncEphemeralRoomEventIter<'a> =
-	Box<dyn Iterator<Item = Result<(OwnedUserId, u64, Raw<AnySyncEphemeralRoomEvent>)>> + 'a>;
-
 pub(super) struct Data {
 	roomuserid_privateread: Arc<Map>,
 	roomuserid_lastprivatereadupdate: Arc<Map>,
@@ -1,10 +1,17 @@
 mod data;

-use std::sync::Arc;
+use std::{collections::BTreeMap, sync::Arc};

-use conduit::Result;
+use conduit::{debug, Result};
 use data::Data;
-use ruma::{events::receipt::ReceiptEvent, serde::Raw, OwnedUserId, RoomId, UserId};
+use ruma::{
+	events::{
+		receipt::{ReceiptEvent, ReceiptEventContent},
+		AnySyncEphemeralRoomEvent, SyncEphemeralRoomEvent,
+	},
+	serde::Raw,
+	OwnedUserId, RoomId, UserId,
+};

 use crate::{sending, Dep};

@@ -17,6 +24,9 @@ struct Services {
 	sending: Dep<sending::Service>,
 }

+type AnySyncEphemeralRoomEventIter<'a> =
+	Box<dyn Iterator<Item = Result<(OwnedUserId, u64, Raw<AnySyncEphemeralRoomEvent>)>> + 'a>;
+
 impl crate::Service for Service {
 	fn build(args: crate::Args<'_>) -> Result<Arc<Self>> {
 		Ok(Arc::new(Self {
@@ -44,7 +54,7 @@ impl Service {
 	#[tracing::instrument(skip(self), level = "debug")]
 	pub fn readreceipts_since<'a>(
 		&'a self, room_id: &RoomId, since: u64,
-	) -> impl Iterator<Item = Result<(OwnedUserId, u64, Raw<ruma::events::AnySyncEphemeralRoomEvent>)>> + 'a {
+	) -> impl Iterator<Item = Result<(OwnedUserId, u64, Raw<AnySyncEphemeralRoomEvent>)>> + 'a {
 		self.db.readreceipts_since(room_id, since)
 	}

@@ -65,3 +75,26 @@ impl Service {
 		self.db.last_privateread_update(user_id, room_id)
 	}
 }
+
+#[must_use]
+pub fn pack_receipts(receipts: AnySyncEphemeralRoomEventIter<'_>) -> Raw<SyncEphemeralRoomEvent<ReceiptEventContent>> {
+	let mut json = BTreeMap::new();
+	for (_user, _count, value) in receipts.flatten() {
+		let receipt = serde_json::from_str::<SyncEphemeralRoomEvent<ReceiptEventContent>>(value.json().get());
+		if let Ok(value) = receipt {
+			for (event, receipt) in value.content {
+				json.insert(event, receipt);
+			}
+		} else {
+			debug!("failed to parse receipt: {:?}", receipt);
+		}
+	}
+	let content = ReceiptEventContent::from_iter(json);
+
+	Raw::from_json(
+		serde_json::value::to_raw_value(&SyncEphemeralRoomEvent {
+			content,
+		})
+		.expect("received valid json"),
+	)
+}
@@ -15,7 +15,7 @@ pub(crate) async fn send_request<T>(
 where
 	T: OutgoingRequest + Debug + Send,
 {
-	const VERSIONS: [MatrixVersion; 1] = [MatrixVersion::V1_0];
+	const VERSIONS: [MatrixVersion; 1] = [MatrixVersion::V1_7];

 	let Some(dest) = registration.url else {
 		return Ok(None);
@@ -68,6 +68,13 @@ impl Service {
 	#[inline]
 	pub fn exists(&self, user_id: &UserId) -> Result<bool> { self.db.exists(user_id) }

+	pub fn remembered(&self, user_id: OwnedUserId, device_id: OwnedDeviceId, conn_id: String) -> bool {
+		self.connections
+			.lock()
+			.unwrap()
+			.contains_key(&(user_id, device_id, conn_id))
+	}
+
 	pub fn forget_sync_request_connection(&self, user_id: OwnedUserId, device_id: OwnedDeviceId, conn_id: String) {
 		self.connections
 			.lock()
Author	SHA1	Message	Date
strawberry	8f7ade4c22	document all the fancy admin room config options and arguments Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-09-01 12:44:24 -04:00
strawberry	8849a100fd	dont use HTML for initial welcome message Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-09-01 12:11:56 -04:00
strawberry	5dfda2d300	fix one header in readme Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-09-01 12:08:38 -04:00
strawberry	c13e9a7c2b	document `allow_legacy_media` config option Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-09-01 12:00:08 -04:00
morguldir	393eef431b	syncv3: avoid fetching timelines for invites	2024-08-31 18:58:39 +02:00
Jason Volk	4bac9b33cc	propagate config error for cidr range Signed-off-by: Jason Volk <jason@zemos.net>	2024-09-01 11:15:55 +00:00
strawberry	60605e9579	remove unnecessary loop/allocations on CIDR range init Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-09-01 00:59:43 -04:00
strawberry	27bfb67d75	add `--no-details` to admin rooms list command Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-09-01 00:56:49 -04:00
strawberry	fc1834d629	use codeblocks instead of HTML tables for some admin commands Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-09-01 00:44:22 -04:00
strawberry	2fcedad2b1	document ways to recovering admin room access Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-09-01 00:40:17 -04:00
strawberry	b362f0e0fa	fix some other markdown formatting Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-08-31 16:05:47 -04:00
strawberry	5530e7434a	notify admin room on new room directory publishes Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-08-31 13:18:48 -04:00
strawberry	bfb10cda26	slightly cleanup and simplify client /report endpoint Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-08-31 12:51:24 -04:00
strawberry	5dbb868936	remove unnecessary loops/allocations in client `/capabilities` Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-08-31 12:18:21 -04:00
Jason Volk	14b9511d2e	fix default capture EnvFilter in release mode Signed-off-by: Jason Volk <jason@zemos.net>	2024-08-31 12:24:11 +00:00
morguldir	7b852352e5	deploying: make traefik config self-sufficient, include well known	2024-08-31 14:09:16 +02:00
Jason Volk	b45df5f7bd	bump appservice requests to v1.7 Signed-off-by: Jason Volk <jason@zemos.net>	2024-08-31 09:55:26 +00:00
strawberry	4797183b43	remove unnecessary loop/allocations in `/joined_members` Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-08-30 19:52:55 -04:00
strawberry	d68b71a0aa	add appservice ping client endpoint (MSC2659) Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-08-30 19:38:15 -04:00
strawberry	922875477f	docs: fix some borked codeblocks Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-08-30 19:38:15 -04:00
strawberry	3a623dbdc3	add force_leave_room admin command Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-08-30 17:17:00 -04:00
strawberry	ae98610c50	docs: document new startup `--execute` admin cmd flag/argument Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-08-30 16:42:37 -04:00
strawberry	bceed3c829	dont debug print startup admin command content body Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-08-30 15:01:54 -04:00
strawberry	b89d2ceccd	bump syn, serde, and tokio Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-08-30 12:57:50 -04:00
renovate[bot]	eaa8997506	Update nixos/nix Docker tag to v2.24.4	2024-08-30 12:57:50 -04:00
strawberry	42a42b24a9	renovate: exclude rust deps we forked / cant easily bump or upgrade Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-08-30 12:57:50 -04:00
strawberry	8d7e5ca2bb	redirect/handle r0 media paths too Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-08-30 12:57:50 -04:00
strawberry	119cc2eec0	fix typo with reqwest builder for disabling zstd Signed-off-by: strawberry <strawberry@puppygock.gay>	2024-08-30 12:57:50 -04:00
morguldir	9fde835673	syncv3: read receipts extension (MSC3960)	2024-08-30 18:23:42 +02:00
morguldir	bf9d498621	syncv3: check timestamps of all the rooms in the timeline	2024-08-30 18:20:18 +02:00
morguldir	f8cf57c1fb	syncv3: fix bump types and only set timestamp if we find an event	2024-08-30 11:39:14 +02:00
morguldir	26a6d349dc	nix: fix toolchain splicing warning we load the toolchain from a file so not sure how we would create a toolchain based on pkgs 🤔	2024-08-30 10:35:05 +02:00
morguldir	77c0c13a83	syncv3: support per room account data	2024-08-30 10:31:08 +02:00
morguldir	36b8de1339	syncv3: include invited rooms in the count	2024-08-30 09:30:50 +02:00
morguldir	29a6065bae	syncv3: include latest timestamps, calculated from a default set of types List borrowed from synapse	2024-08-24 14:52:48 +02:00
morguldir	f4c8b77377	syncv3: include the invite_state in the response	2024-08-24 07:33:07 +02:00
morguldir	85400d15bc	syncv3: reset the connection after restarts	2024-08-24 06:57:31 +02:00
morguldir	13334a88ca	syncv3: handle empty conn_id by mapping it to a predefined string	2024-08-24 06:45:33 +02:00
morguldir	351062eb82	syncv3: add support for filtering invites and room types	2024-08-24 06:44:32 +02:00
morguldir	001523ec81	Avoid panicing during sliding sync if the user isn't in any rooms	2024-08-24 05:23:51 +02:00
morguldir	0a5f18ed83	reformat: make markdown files wrap at 80 chars	2024-08-24 05:13:43 +02:00
morguldir	16ce62302a	.editorconfig: use tabs for rust files	2024-08-24 05:11:38 +02:00