add ignored user checks on /context and /event, misc cleanup

Signed-off-by: strawberry <strawberry@puppygock.gay>

.editorconfig

@@ -11,5 +11,13 @@ indent_style = space
 insert_final_newline = true
 max_line_length = 120
 
+[*.{md,txt}]
+indent_style = space
+indent_size = 4
+max_line_length = 80
+
 [*.nix]
-indent_size = 2
+indent_size = 2
+
+[*.rs]
+indent_style = tab

.envrc

@@ -1,5 +1,7 @@
 #!/usr/bin/env bash
 
-use flake
+dotenv_if_exists
+
+use flake ".#${DIRENV_DEVSHELL:-default}"
 
 PATH_add bin

.gitea/workflows/ci.yml

@@ -0,0 +1,264 @@
+name: CI and Artifacts
+
+on:
+    pull_request:
+    push:
+        # documentation workflow deals with this or is not relevant for this workflow
+        paths-ignore:
+          - '*.md'
+          - 'conduwuit-example.toml'
+          - 'book.toml'
+          - '.gitlab-ci.yml'
+          - '.gitignore'
+          - 'renovate.json'
+          - 'docs/**'
+          - 'debian/**'
+          - 'docker/**'
+        branches:
+            - main
+        tags:
+          - '*'
+    # Allows you to run this workflow manually from the Actions tab
+    #workflow_dispatch:
+
+#concurrency:
+#    group: ${{ gitea.head_ref || gitea.ref_name }}
+#    cancel-in-progress: true
+
+env:
+    # Required to make some things output color
+    TERM: ansi
+    # Publishing to my nix binary cache
+    ATTIC_TOKEN: ${{ secrets.ATTIC_TOKEN }}
+    # conduwuit.cachix.org
+    CACHIX_AUTH_TOKEN: ${{ secrets.CACHIX_AUTH_TOKEN }}
+    # Just in case incremental is still being set to true, speeds up CI
+    CARGO_INCREMENTAL: 0
+    # Custom nix binary cache if fork is being used
+    ATTIC_ENDPOINT: ${{ vars.ATTIC_ENDPOINT }}
+    ATTIC_PUBLIC_KEY: ${{ vars.ATTIC_PUBLIC_KEY }}
+    # Get error output from nix that we can actually use
+    NIX_CONFIG: show-trace = true
+
+#permissions:
+#    packages: write
+#    contents: read
+
+jobs:
+    tests:
+        name: Test
+        runs-on: ubuntu-latest
+        steps:
+            - name: Sync repository
+              uses: https://github.com/actions/checkout@v4
+
+            - name: Tag comparison check
+              if: startsWith(gitea.ref, 'refs/tags/v')
+              run: |
+                  # Tag mismatch with latest repo tag check to prevent potential downgrades
+                  LATEST_TAG=$(git describe --tags `git rev-list --tags --max-count=1`)
+
+                  if [ $LATEST_TAG != ${{ gitea.ref_name }} ]; then
+                    echo '# WARNING: Attempting to run this workflow for a tag that is not the latest repo tag. Aborting.'
+                    echo '# WARNING: Attempting to run this workflow for a tag that is not the latest repo tag. Aborting.' >> $GITHUB_STEP_SUMMARY
+                    exit 1
+                  fi
+
+            - name: Install Nix
+              uses: https://github.com/DeterminateSystems/nix-installer-action@main
+              with:
+                diagnostic-endpoint: ""
+                extra-conf: |
+                  experimental-features = nix-command flakes
+                  accept-flake-config = true
+
+            - name: Enable Cachix binary cache
+              run: |
+                  nix profile install nixpkgs#cachix
+                  cachix use crane
+                  cachix use nix-community
+
+            - name: Configure Magic Nix Cache
+              uses: https://github.com/DeterminateSystems/magic-nix-cache-action@main
+              with:
+                diagnostic-endpoint: ""
+                upstream-cache: "https://attic.kennel.juneis.dog/conduwuit"
+
+            - name: Apply Nix binary cache configuration
+              run: |
+                  sudo tee -a /etc/nix/nix.conf > /dev/null <<EOF
+                  extra-substituters = https://attic.kennel.juneis.dog/conduit https://attic.kennel.juneis.dog/conduwuit https://cache.lix.systems https://conduwuit.cachix.org
+                  extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk= conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o= conduwuit.cachix.org-1:MFRm6jcnfTf0jSAbmvLfhO3KBMt4px+1xaereWXp8Xg=
+                  EOF
+
+            - name: Use alternative Nix binary caches if specified
+              if: ${{ (env.ATTIC_ENDPOINT != '') && (env.ATTIC_PUBLIC_KEY != '') }}
+              run: |
+                  sudo tee -a /etc/nix/nix.conf > /dev/null <<EOF
+                  extra-substituters = ${{ env.ATTIC_ENDPOINT }}
+                  extra-trusted-public-keys = ${{ env.ATTIC_PUBLIC_KEY }}
+                  EOF
+
+            - name: Prepare build environment
+              run: |
+                  echo 'source $HOME/.nix-profile/share/nix-direnv/direnvrc' > "$HOME/.direnvrc"
+                  nix profile install --impure --inputs-from . nixpkgs#direnv nixpkgs#nix-direnv
+                  direnv allow
+                  nix develop .#all-features --command true
+
+            - name: Cache CI dependencies
+              run: |
+                  bin/nix-build-and-cache ci
+
+            - name: Run CI tests
+              run: |
+                  direnv exec . engage > >(tee -a test_output.log)
+
+            - name: Sync Complement repository
+              uses: https://github.com/actions/checkout@v4
+              with:
+                repository: 'matrix-org/complement'
+                path: complement_src
+
+            - name: Run Complement tests
+              run: |
+                  direnv exec . bin/complement 'complement_src' 'complement_test_logs.jsonl' 'complement_test_results.jsonl'
+                  cp -v -f result complement_oci_image.tar.gz
+
+            - name: Upload Complement OCI image
+              uses: https://github.com/actions/upload-artifact@v4
+              with:
+                name: complement_oci_image.tar.gz
+                path: complement_oci_image.tar.gz
+                if-no-files-found: error
+
+            - name: Upload Complement logs
+              uses: https://github.com/actions/upload-artifact@v4
+              with:
+                name: complement_test_logs.jsonl
+                path: complement_test_logs.jsonl
+                if-no-files-found: error
+
+            - name: Upload Complement results
+              uses: https://github.com/actions/upload-artifact@v4
+              with:
+                name: complement_test_results.jsonl
+                path: complement_test_results.jsonl
+                if-no-files-found: error
+
+            - name: Diff Complement results with checked-in repo results
+              run: |
+                  diff -u --color=always tests/test_results/complement/test_results.jsonl complement_test_results.jsonl > >(tee -a complement_test_output.log)
+                  echo '# Complement diff results' >> $GITHUB_STEP_SUMMARY
+                  echo '```diff' >> $GITHUB_STEP_SUMMARY
+                  tail -n 100 complement_test_output.log | sed 's/\x1b\[[0-9;]*m//g' >> $GITHUB_STEP_SUMMARY
+                  echo '```' >> $GITHUB_STEP_SUMMARY
+
+            - name: Update Job Summary
+              if: success() || failure()
+              run: |
+                  if [ ${{ job.status }} == 'success' ]; then
+                      echo '# ✅ completed suwuccessfully' >> $GITHUB_STEP_SUMMARY
+                  else
+                      echo '```' >> $GITHUB_STEP_SUMMARY
+                      tail -n 40 test_output.log | sed 's/\x1b\[[0-9;]*m//g' >> $GITHUB_STEP_SUMMARY
+                      echo '```' >> $GITHUB_STEP_SUMMARY
+                  fi
+
+    build:
+        name: Build
+        runs-on: ubuntu-latest
+        needs: tests
+        strategy:
+            matrix:
+                include:
+                    - target: aarch64-unknown-linux-musl
+                    - target: x86_64-unknown-linux-musl
+        steps:
+            - name: Sync repository
+              uses: https://github.com/actions/checkout@v4
+
+            - name: Install Nix
+              uses: https://github.com/DeterminateSystems/nix-installer-action@main
+              with:
+                diagnostic-endpoint: ""
+                extra-conf: |
+                  experimental-features = nix-command flakes
+                  accept-flake-config = true
+
+            - name: Install and enable Cachix binary cache
+              run: |
+                  nix profile install nixpkgs#cachix
+                  cachix use crane
+                  cachix use nix-community
+
+            - name: Configure Magic Nix Cache
+              uses: https://github.com/DeterminateSystems/magic-nix-cache-action@main
+              with:
+                diagnostic-endpoint: ""
+                upstream-cache: "https://attic.kennel.juneis.dog/conduwuit"
+
+            - name: Apply Nix binary cache configuration
+              run: |
+                  sudo tee -a /etc/nix/nix.conf > /dev/null <<EOF
+                  extra-substituters = https://attic.kennel.juneis.dog/conduit https://attic.kennel.juneis.dog/conduwuit https://cache.lix.systems https://conduwuit.cachix.org
+                  extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk= conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o= conduwuit.cachix.org-1:MFRm6jcnfTf0jSAbmvLfhO3KBMt4px+1xaereWXp8Xg=
+                  EOF
+
+            - name: Use alternative Nix binary caches if specified
+              if: ${{ (env.ATTIC_ENDPOINT != '') && (env.ATTIC_PUBLIC_KEY != '') }}
+              run: |
+                  sudo tee -a /etc/nix/nix.conf > /dev/null <<EOF
+                  extra-substituters = ${{ env.ATTIC_ENDPOINT }}
+                  extra-trusted-public-keys = ${{ env.ATTIC_PUBLIC_KEY }}
+                  EOF
+
+            - name: Prepare build environment
+              run: |
+                  echo 'source $HOME/.nix-profile/share/nix-direnv/direnvrc' > "$HOME/.direnvrc"
+                  nix profile install --impure --inputs-from . nixpkgs#direnv nixpkgs#nix-direnv
+                  direnv allow
+                  nix develop .#all-features --command true
+
+            - name: Build static ${{ matrix.target }}
+              run: |
+                  CARGO_DEB_TARGET_TUPLE=$(echo ${{ matrix.target }} | grep -o -E '^([^-]*-){3}[^-]*')
+                  SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct)
+
+                  bin/nix-build-and-cache just .#static-${{ matrix.target }}
+                  mkdir -v -p target/release/
+                  mkdir -v -p target/$CARGO_DEB_TARGET_TUPLE/release/
+                  cp -v -f result/bin/conduit target/release/conduwuit
+                  cp -v -f result/bin/conduit target/$CARGO_DEB_TARGET_TUPLE/release/conduwuit
+                  # -p conduit is the main crate name
+                  direnv exec . cargo deb --verbose --no-build --no-strip -p conduit --target=$CARGO_DEB_TARGET_TUPLE --output target/release/${{ matrix.target }}.deb
+                  mv -v target/release/conduwuit static-${{ matrix.target }}
+                  mv -v target/release/${{ matrix.target }}.deb ${{ matrix.target }}.deb
+
+            - name: Upload static-${{ matrix.target }}
+              uses: https://github.com/actions/upload-artifact@v4
+              with:
+                  name: static-${{ matrix.target }}
+                  path: static-${{ matrix.target }}
+                  if-no-files-found: error
+
+            - name: Upload deb ${{ matrix.target }}
+              uses: https://github.com/actions/upload-artifact@v4
+              with:
+                  name: deb-${{ matrix.target }}
+                  path: ${{ matrix.target }}.deb
+                  if-no-files-found: error
+                  compression-level: 0
+
+            - name: Build OCI image ${{ matrix.target }}
+              run: |
+                  bin/nix-build-and-cache just .#oci-image-${{ matrix.target }}
+                  cp -v -f result oci-image-${{ matrix.target }}.tar.gz
+
+            - name: Upload OCI image ${{ matrix.target }}
+              uses: https://github.com/actions/upload-artifact@v4
+              with:
+                  name: oci-image-${{ matrix.target }}
+                  path: oci-image-${{ matrix.target }}.tar.gz
+                  if-no-files-found: error
+                  compression-level: 0

.github/workflows/ci.yml

@@ -3,21 +3,16 @@ name: CI and Artifacts
 on:
     pull_request:
     push:
-        # documentation workflow deals with this or is not relevant for this workflow
         paths-ignore:
-          - '*.md'
-          - 'conduwuit-example.toml'
-          - 'book.toml'
           - '.gitlab-ci.yml'
           - '.gitignore'
           - 'renovate.json'
-          - 'docs/**'
           - 'debian/**'
           - 'docker/**'
-          - 'test_results/**'
         branches:
             - main
-            - dev
+        tags:
+          - '*'
     # Allows you to run this workflow manually from the Actions tab
     workflow_dispatch:
 
@@ -26,15 +21,37 @@ concurrency:
     cancel-in-progress: true
 
 env:
+    # sccache only on main repo
+    SCCACHE_GHA_ENABLED: "${{ (github.event.pull_request.draft != true) && (vars.DOCKER_USERNAME != '') && (vars.GITLAB_USERNAME != '') && (vars.SCCACHE_ENDPOINT != '') && (github.event.pull_request.user.login != 'renovate[bot]') && 'true' || 'false' }}"
+    RUSTC_WRAPPER: "${{ (github.event.pull_request.draft != true) && (vars.DOCKER_USERNAME != '') && (vars.GITLAB_USERNAME != '') && (vars.SCCACHE_ENDPOINT != '') && (github.event.pull_request.user.login != 'renovate[bot]') && 'sccache' || '' }}"
+    SCCACHE_BUCKET: "${{ (github.event.pull_request.draft != true) && (vars.DOCKER_USERNAME != '') && (vars.GITLAB_USERNAME != '') && (vars.SCCACHE_ENDPOINT != '') && (github.event.pull_request.user.login != 'renovate[bot]') && 'sccache' || '' }}"
+    SCCACHE_S3_USE_SSL: ${{ vars.SCCACHE_S3_USE_SSL }}
+    SCCACHE_REGION: ${{ vars.SCCACHE_REGION }}
+    SCCACHE_ENDPOINT: ${{ vars.SCCACHE_ENDPOINT }}
+    SCCACHE_CACHE_MULTIARCH: ${{ vars.SCCACHE_CACHE_MULTIARCH }}
+    AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+    AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
     # Required to make some things output color
     TERM: ansi
     # Publishing to my nix binary cache
     ATTIC_TOKEN: ${{ secrets.ATTIC_TOKEN }}
+    # conduwuit.cachix.org
+    CACHIX_AUTH_TOKEN: ${{ secrets.CACHIX_AUTH_TOKEN }}
     # Just in case incremental is still being set to true, speeds up CI
     CARGO_INCREMENTAL: 0
     # Custom nix binary cache if fork is being used
     ATTIC_ENDPOINT: ${{ vars.ATTIC_ENDPOINT }}
     ATTIC_PUBLIC_KEY: ${{ vars.ATTIC_PUBLIC_KEY }}
+    # Get error output from nix that we can actually use, and use our binary caches for the earlier CI steps
+    NIX_CONFIG: |
+      show-trace = true
+      extra-substituters = https://attic.kennel.juneis.dog/conduwuit https://attic.kennel.juneis.dog/conduit https://cache.lix.systems https://conduwuit.cachix.org https://aseipp-nix-cache.freetls.fastly.net
+      extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk= conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o= conduwuit.cachix.org-1:MFRm6jcnfTf0jSAbmvLfhO3KBMt4px+1xaereWXp8Xg=
+      experimental-features = nix-command flakes
+      extra-experimental-features = nix-command flakes
+      accept-flake-config = true
+    # complement uses libolm
+    NIXPKGS_ALLOW_INSECURE: 1
 
 permissions:
     packages: write
@@ -43,13 +60,58 @@ permissions:
 jobs:
     tests:
         name: Test
-        runs-on: ubuntu-latest
+        runs-on: ubuntu-24.04
         steps:
+            - name: Install liburing
+              run: |
+                  sudo apt install liburing-dev -y
+
+            - name: Free up a bit of runner space
+              run: |
+                  set +o pipefail
+                  sudo docker image prune --all --force || true
+                  sudo apt purge -y 'php.*' '^mongodb-.*' '^mysql-.*' azure-cli google-cloud-cli google-chrome-stable firefox powershell microsoft-edge-stable || true
+                  sudo apt clean
+                  sudo rm -v -rf /usr/local/games /usr/local/sqlpackage /usr/local/share/powershell /usr/local/share/edge_driver /usr/local/share/gecko_driver /usr/local/share/chromium /usr/local/share/chromedriver-linux64 /usr/lib/google-cloud-sdk /usr/lib/jvm /usr/lib/mono /usr/lib/heroku
+                  set -o pipefail
+
             - name: Sync repository
               uses: actions/checkout@v4
 
-            - name: Install Nix
-              uses: DeterminateSystems/nix-installer-action@main
+            - name: Tag comparison check
+              if: ${{ startsWith(github.ref, 'refs/tags/v') && !endsWith(github.ref, '-rc') }}
+              run: |
+                  # Tag mismatch with latest repo tag check to prevent potential downgrades
+                  LATEST_TAG=$(git describe --tags `git rev-list --tags --max-count=1`)
+
+                  if [ $LATEST_TAG != ${{ github.ref_name }} ]; then
+                    echo '# WARNING: Attempting to run this workflow for a tag that is not the latest repo tag. Aborting.'
+                    echo '# WARNING: Attempting to run this workflow for a tag that is not the latest repo tag. Aborting.' >> $GITHUB_STEP_SUMMARY
+                    exit 1
+                  fi
+
+            - uses: nixbuild/nix-quick-install-action@master
+
+            - name: Restore and cache Nix store
+              uses: nix-community/cache-nix-action@v5.1.0
+              with:
+                # restore and save a cache using this key
+                primary-key: nix-${{ runner.os }}-${{ hashFiles('**/*.nix', '**/.lock') }}
+                # if there's no cache hit, restore a cache by this prefix
+                restore-prefixes-first-match: nix-${{ runner.os }}-
+                # collect garbage until Nix store size (in bytes) is at most this number
+                # before trying to save a new cache
+                gc-max-store-size-linux: 2073741824
+                # do purge caches
+                purge: true
+                # purge all versions of the cache
+                purge-prefixes: nix-${{ runner.os }}-
+                # created more than this number of seconds ago relative to the start of the `Post Restore` phase
+                purge-last-accessed: 86400
+                # except the version with the `primary-key`, if it exists
+                purge-primary-key: never
+                # always save the cache
+                save-always: true
 
             - name: Enable Cachix binary cache
               run: |
@@ -57,20 +119,20 @@ jobs:
                   cachix use crane
                   cachix use nix-community
 
-            - name: Configure Magic Nix Cache
-              uses: DeterminateSystems/magic-nix-cache-action@main
-
             - name: Apply Nix binary cache configuration
               run: |
-                  sudo tee -a /etc/nix/nix.conf > /dev/null <<EOF
-                  extra-substituters = https://attic.kennel.juneis.dog/conduit https://attic.kennel.juneis.dog/conduwuit
-                  extra-trusted-public-keys = conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg= conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw=
+                  sudo tee -a "${XDG_CONFIG_HOME:-$HOME/.config}/nix/nix.conf" > /dev/null <<EOF
+                  extra-substituters = https://attic.kennel.juneis.dog/conduwuit https://attic.kennel.juneis.dog/conduit https://cache.lix.systems https://conduwuit.cachix.org https://aseipp-nix-cache.freetls.fastly.net
+                  extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk= conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o= conduwuit.cachix.org-1:MFRm6jcnfTf0jSAbmvLfhO3KBMt4px+1xaereWXp8Xg=
+                  experimental-features = nix-command flakes
+                  extra-experimental-features = nix-command flakes
+                  accept-flake-config = true
                   EOF
 
             - name: Use alternative Nix binary caches if specified
               if: ${{ (env.ATTIC_ENDPOINT != '') && (env.ATTIC_PUBLIC_KEY != '') }}
               run: |
-                  sudo tee -a /etc/nix/nix.conf > /dev/null <<EOF
+                  sudo tee -a "${XDG_CONFIG_HOME:-$HOME/.config}/nix/nix.conf" > /dev/null <<EOF
                   extra-substituters = ${{ env.ATTIC_ENDPOINT }}
                   extra-trusted-public-keys = ${{ env.ATTIC_PUBLIC_KEY }}
                   EOF
@@ -78,23 +140,47 @@ jobs:
             - name: Prepare build environment
               run: |
                   echo 'source $HOME/.nix-profile/share/nix-direnv/direnvrc' > "$HOME/.direnvrc"
-                  nix profile install --impure --inputs-from . nixpkgs#direnv nixpkgs#nix-direnv
+                  nix profile install --inputs-from . nixpkgs#direnv nixpkgs#nix-direnv
                   direnv allow
-                  nix develop --command true
+                  nix develop .#all-features --command true
+
+            - name: Cache CI dependencies
+              run: |
+                  bin/nix-build-and-cache ci
+                  bin/nix-build-and-cache just '.#devShells.x86_64-linux.default'
+                  bin/nix-build-and-cache just '.#devShells.x86_64-linux.all-features'
+                  bin/nix-build-and-cache just '.#devShells.x86_64-linux.dynamic'
+
+            # use sccache for Rust
+            - name: Run sccache-cache
+              if: (github.event.pull_request.draft != true) && (vars.DOCKER_USERNAME != '') && (vars.GITLAB_USERNAME != '') && (vars.SCCACHE_ENDPOINT != '') && (github.event.pull_request.user.login != 'renovate[bot]')
+              uses: mozilla-actions/sccache-action@main
+
+            # use rust-cache
+            - uses: Swatinem/rust-cache@v2
+              with:
+                cache-all-crates: "true"
 
             - name: Run CI tests
+              env:
+                CARGO_PROFILE: "test"
               run: |
                   direnv exec . engage > >(tee -a test_output.log)
 
-            - name: Sync Complement repository
-              uses: actions/checkout@v4
-              with:
-                repository: 'matrix-org/complement'
-                path: complement_src
-
             - name: Run Complement tests
+              env:
+                CARGO_PROFILE: "test"
               run: |
-                  direnv exec . bin/complement 'complement_src' 'complement_test_logs.jsonl' 'complement_test_results.jsonl'
+                  # the nix devshell sets $COMPLEMENT_SRC, so "/dev/null" is no-op
+                  direnv exec . bin/complement "/dev/null" complement_test_logs.jsonl complement_test_results.jsonl > >(tee -a test_output.log)
+                  cp -v -f result complement_oci_image.tar.gz
+
+            - name: Upload Complement OCI image
+              uses: actions/upload-artifact@v4
+              with:
+                name: complement_oci_image.tar.gz
+                path: complement_oci_image.tar.gz
+                if-no-files-found: error
 
             - name: Upload Complement logs
               uses: actions/upload-artifact@v4
@@ -111,17 +197,8 @@ jobs:
                 if-no-files-found: error
 
             - name: Diff Complement results with checked-in repo results
-            # TODO: figure out why our complement results are not 100% consistent so we don't need to allow failures
-              continue-on-error: true
               run: |
-                  diff -u --color=always complement_test_results.jsonl tests/test_results/complement/test_results.jsonl > >(tee -a complement_test_output.log)
-
-            - name: Add Complement diff result to Job Summary
-              run: |
-                  echo '# Complement diff results' >> $GITHUB_STEP_SUMMARY
-                  echo '```diff' >> $GITHUB_STEP_SUMMARY
-                  tail -n 50 complement_test_output.log | sed 's/\x1b\[[0-9;]*m//g' >> $GITHUB_STEP_SUMMARY
-                  echo '```' >> $GITHUB_STEP_SUMMARY
+                  diff -u --color=always tests/test_results/complement/test_results.jsonl complement_test_results.jsonl > >(tee -a complement_diff_output.log)
 
             - name: Update Job Summary
               if: success() || failure()
@@ -129,50 +206,77 @@ jobs:
                   if [ ${{ job.status }} == 'success' ]; then
                       echo '# ✅ completed suwuccessfully' >> $GITHUB_STEP_SUMMARY
                   else
+                      echo '# CI failure' >> $GITHUB_STEP_SUMMARY
                       echo '```' >> $GITHUB_STEP_SUMMARY
-                      tail -n 20 test_output.log | sed 's/\x1b\[[0-9;]*m//g' >> $GITHUB_STEP_SUMMARY
+                      tail -n 40 test_output.log | sed 's/\x1b\[[0-9;]*m//g' >> $GITHUB_STEP_SUMMARY
+                      echo '```' >> $GITHUB_STEP_SUMMARY
+
+                      echo '# Complement diff results' >> $GITHUB_STEP_SUMMARY
+                      echo '```diff' >> $GITHUB_STEP_SUMMARY
+                      tail -n 100 complement_diff_output.log | sed 's/\x1b\[[0-9;]*m//g' >>     $GITHUB_STEP_SUMMARY
                       echo '```' >> $GITHUB_STEP_SUMMARY
                   fi
 
+            - name: Run cargo clean test artifacts to free up space
+              run: |
+                  cargo clean --profile test
+
     build:
         name: Build
-        runs-on: ubuntu-latest
+        runs-on: ubuntu-24.04
         needs: tests
-        if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev'
         strategy:
             matrix:
                 include:
-                    - target: aarch64-unknown-linux-musl
-                    - target: aarch64-unknown-linux-musl-jemalloc
-                    - target: x86_64-unknown-linux-musl
-                    - target: x86_64-unknown-linux-musl-jemalloc
+                    - target: aarch64-linux-musl
+                    - target: x86_64-linux-musl
         steps:
             - name: Sync repository
               uses: actions/checkout@v4
 
-            - name: Install Nix
-              uses: DeterminateSystems/nix-installer-action@main
+            - uses: nixbuild/nix-quick-install-action@master
 
-            - name: Install and enable Cachix binary cache
+            - name: Restore and cache Nix store
+              uses: nix-community/cache-nix-action@v5.1.0
+              with:
+                # restore and save a cache using this key
+                primary-key: nix-${{ runner.os }}-${{ matrix.target }}-${{ hashFiles('**/*.nix', '**/.lock') }}
+                # if there's no cache hit, restore a cache by this prefix
+                restore-prefixes-first-match: nix-${{ runner.os }}-
+                # collect garbage until Nix store size (in bytes) is at most this number
+                # before trying to save a new cache
+                gc-max-store-size-linux: 2073741824
+                # do purge caches
+                purge: true
+                # purge all versions of the cache
+                purge-prefixes: nix-${{ runner.os }}-
+                # created more than this number of seconds ago relative to the start of the `Post Restore` phase
+                purge-last-accessed: 86400
+                # except the version with the `primary-key`, if it exists
+                purge-primary-key: never
+                # always save the cache
+                save-always: true
+
+            - name: Enable Cachix binary cache
               run: |
                   nix profile install nixpkgs#cachix
                   cachix use crane
                   cachix use nix-community
 
-            - name: Configure Magic Nix Cache
-              uses: DeterminateSystems/magic-nix-cache-action@main
-
             - name: Apply Nix binary cache configuration
               run: |
-                  sudo tee -a /etc/nix/nix.conf > /dev/null <<EOF
-                  extra-substituters = https://attic.kennel.juneis.dog/conduit https://attic.kennel.juneis.dog/conduwuit
-                  extra-trusted-public-keys = conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg= conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw=
+                  sudo tee -a "${XDG_CONFIG_HOME:-$HOME/.config}/nix/nix.conf" > /dev/null <<EOF
+                  extra-substituters = https://attic.kennel.juneis.dog/conduwuit https://attic.kennel.juneis.dog/conduit https://cache.lix.systems https://conduwuit.cachix.org https://aseipp-nix-cache.freetls.fastly.net
+                  extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk= conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o= conduwuit.cachix.org-1:MFRm6jcnfTf0jSAbmvLfhO3KBMt4px+1xaereWXp8Xg=
+                  experimental-features = nix-command flakes
+                  extra-experimental-features = nix-command flakes
+                  accept-flake-config = true
                   EOF
 
             - name: Use alternative Nix binary caches if specified
               if: ${{ (env.ATTIC_ENDPOINT != '') && (env.ATTIC_PUBLIC_KEY != '') }}
               run: |
-                  sudo tee -a /etc/nix/nix.conf > /dev/null <<EOF
+                  sudo tee -a "${XDG_CONFIG_HOME:-$HOME/.config}/nix/nix.conf" > /dev/null <<EOF
                   extra-substituters = ${{ env.ATTIC_ENDPOINT }}
                   extra-trusted-public-keys = ${{ env.ATTIC_PUBLIC_KEY }}
                   EOF
@@ -182,15 +286,91 @@ jobs:
                   echo 'source $HOME/.nix-profile/share/nix-direnv/direnvrc' > "$HOME/.direnvrc"
                   nix profile install --impure --inputs-from . nixpkgs#direnv nixpkgs#nix-direnv
                   direnv allow
-                  nix develop --command true
+                  nix develop .#all-features --command true --impure
+
+            # use sccache for Rust
+            - name: Run sccache-cache
+              if: (github.event.pull_request.draft != true) && (vars.DOCKER_USERNAME != '') && (vars.GITLAB_USERNAME != '') && (vars.SCCACHE_ENDPOINT != '') && (github.event.pull_request.user.login != 'renovate[bot]')
+              uses: mozilla-actions/sccache-action@main
+
+            # use rust-cache
+            - uses: Swatinem/rust-cache@v2
+              with:
+                cache-all-crates: "true"
 
             - name: Build static ${{ matrix.target }}
               run: |
-                  bin/nix-build-and-cache just .#static-${{ matrix.target }}
-                  mkdir -p target/release
-                  cp -v -f result/bin/conduit target/release/
-                  direnv exec . cargo deb --no-build --no-strip --output target/debian/${{ matrix.target }}.deb
-                  mv target/release/conduit static-${{ matrix.target }}
+                  if [[ ${{ matrix.target }} == "x86_64-linux-musl" ]]
+                  then
+                    CARGO_DEB_TARGET_TUPLE="x86_64-unknown-linux-musl"
+                  elif [[ ${{ matrix.target }} == "aarch64-linux-musl" ]]
+                  then
+                    CARGO_DEB_TARGET_TUPLE="aarch64-unknown-linux-musl"
+                  fi
+
+                  SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct)
+
+                  bin/nix-build-and-cache just .#static-${{ matrix.target }}-all-features
+
+                  mkdir -v -p target/release/
+                  mkdir -v -p target/$CARGO_DEB_TARGET_TUPLE/release/
+                  cp -v -f result/bin/conduit target/release/conduwuit
+                  cp -v -f result/bin/conduit target/$CARGO_DEB_TARGET_TUPLE/release/conduwuit
+                  # -p conduit is the main crate name
+                  direnv exec . cargo deb --verbose --no-build --no-strip -p conduit --target=$CARGO_DEB_TARGET_TUPLE --output target/release/${{ matrix.target }}.deb
+                  mv -v target/release/conduwuit static-${{ matrix.target }}
+                  mv -v target/release/${{ matrix.target }}.deb ${{ matrix.target }}.deb
+
+            # quick smoke test of the x86_64 static release binary
+            - name: Run x86_64 static release binary
+              run: |
+                  # GH actions default runners are x86_64 only
+                  if file result/bin/conduit | grep x86-64; then
+                    result/bin/conduit --version
+                  fi
+
+            - name: Build static debug ${{ matrix.target }}
+              run: |
+                  if [[ ${{ matrix.target }} == "x86_64-linux-musl" ]]
+                  then
+                    CARGO_DEB_TARGET_TUPLE="x86_64-unknown-linux-musl"
+                  elif [[ ${{ matrix.target }} == "aarch64-linux-musl" ]]
+                  then
+                    CARGO_DEB_TARGET_TUPLE="aarch64-unknown-linux-musl"
+                  fi
+
+                  SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct)
+
+                  bin/nix-build-and-cache just .#static-${{ matrix.target }}-all-features-debug
+
+                  # > warning: dev profile is not supported and will be a hard error in the future. cargo-deb is for making releases, and it doesn't make sense to use it with dev profiles.
+                  # so we need to coerce cargo-deb into thinking this is a release binary
+                  mkdir -v -p target/release/
+                  mkdir -v -p target/$CARGO_DEB_TARGET_TUPLE/release/
+                  cp -v -f result/bin/conduit target/release/conduwuit
+                  cp -v -f result/bin/conduit target/$CARGO_DEB_TARGET_TUPLE/release/conduwuit
+                  # -p conduit is the main crate name
+                  direnv exec . cargo deb --verbose --no-build --no-strip -p conduit --target=$CARGO_DEB_TARGET_TUPLE --output target/release/${{ matrix.target }}-debug.deb
+                  mv -v target/release/conduwuit static-${{ matrix.target }}-debug
+                  mv -v target/release/${{ matrix.target }}-debug.deb ${{ matrix.target }}-debug.deb
+
+            # quick smoke test of the x86_64 static debug binary
+            - name: Run x86_64 static debug binary
+              run: |
+                  # GH actions default runners are x86_64 only
+                  if file result/bin/conduit | grep x86-64; then
+                    result/bin/conduit --version
+                  fi
+
+            # check validity of produced deb package, invalid debs will error on these commands
+            - name: Validate produced deb package
+              run: |
+                  # List contents
+                  dpkg-deb --contents ${{ matrix.target }}.deb
+                  dpkg-deb --contents ${{ matrix.target }}-debug.deb
+                  # List info
+                  dpkg-deb --info ${{ matrix.target }}.deb
+                  dpkg-deb --info ${{ matrix.target }}-debug.deb
 
             - name: Upload static-${{ matrix.target }}
               uses: actions/upload-artifact@v4
@@ -203,14 +383,37 @@ jobs:
               uses: actions/upload-artifact@v4
               with:
                   name: deb-${{ matrix.target }}
-                  path: target/debian/${{ matrix.target }}.deb
+                  path: ${{ matrix.target }}.deb
                   if-no-files-found: error
+                  compression-level: 0
+
+            - name: Upload static-${{ matrix.target }}-debug
+              uses: actions/upload-artifact@v4
+              with:
+                  name: static-${{ matrix.target }}-debug
+                  path: static-${{ matrix.target }}-debug
+                  if-no-files-found: error
+
+            - name: Upload deb ${{ matrix.target }}-debug
+              uses: actions/upload-artifact@v4
+              with:
+                  name: deb-${{ matrix.target }}-debug
+                  path: ${{ matrix.target }}-debug.deb
+                  if-no-files-found: error
+                  compression-level: 0
 
             - name: Build OCI image ${{ matrix.target }}
               run: |
-                  bin/nix-build-and-cache just .#oci-image-${{ matrix.target }}
+                  bin/nix-build-and-cache just .#oci-image-${{ matrix.target }}-all-features
+
                   cp -v -f result oci-image-${{ matrix.target }}.tar.gz
 
+            - name: Build debug OCI image ${{ matrix.target }}
+              run: |
+                  bin/nix-build-and-cache just .#oci-image-${{ matrix.target }}-all-features-debug
+
+                  cp -v -f result oci-image-${{ matrix.target }}-debug.tar.gz
+
             - name: Upload OCI image ${{ matrix.target }}
               uses: actions/upload-artifact@v4
               with:
@@ -219,24 +422,107 @@ jobs:
                   if-no-files-found: error
                   compression-level: 0
 
+            - name: Upload OCI image ${{ matrix.target }}-debug
+              uses: actions/upload-artifact@v4
+              with:
+                  name: oci-image-${{ matrix.target }}-debug
+                  path: oci-image-${{ matrix.target }}-debug.tar.gz
+                  if-no-files-found: error
+                  compression-level: 0
+
+    build_mac_binaries:
+        name: Build MacOS Binaries
+        strategy:
+          matrix:
+            os: [macos-latest, macos-13]
+        runs-on: ${{ matrix.os }}
+        steps:
+            - name: Sync repository
+              uses: actions/checkout@v4
+
+            - name: Tag comparison check
+              if: ${{ startsWith(github.ref, 'refs/tags/v') && !endsWith(github.ref, '-rc') }}
+              run: |
+                  # Tag mismatch with latest repo tag check to prevent potential downgrades
+                  LATEST_TAG=$(git describe --tags `git rev-list --tags --max-count=1`)
+                  if [ $LATEST_TAG != ${{ github.ref_name }} ]; then
+                    echo '# WARNING: Attempting to run this workflow for a tag that is not the latest repo tag. Aborting.'
+                    echo '# WARNING: Attempting to run this workflow for a tag that is not the latest repo tag. Aborting.' >> $GITHUB_STEP_SUMMARY
+                    exit 1
+                  fi
+
+            # use sccache for Rust
+            - name: Run sccache-cache
+              if: (github.event.pull_request.draft != true) && (vars.DOCKER_USERNAME != '') && (vars.GITLAB_USERNAME != '') && (vars.SCCACHE_ENDPOINT != '') && (github.event.pull_request.user.login != 'renovate[bot]')
+              uses: mozilla-actions/sccache-action@main
+
+            # use rust-cache
+            - uses: Swatinem/rust-cache@v2
+              with:
+                cache-all-crates: "true"
+
+            # Nix can't do portable macOS builds yet
+            - name: Build macOS x86_64 binary
+              if: ${{ matrix.os == 'macos-13' }}
+              run: |
+                  CONDUWUIT_VERSION_EXTRA="$(git rev-parse --short HEAD)" cargo build --release
+                  cp -v -f target/release/conduit conduwuit-macos-x86_64
+                  otool -L conduwuit-macos-x86_64
+
+            # quick smoke test of the x86_64 macOS binary
+            - name: Run x86_64 macOS release binary
+              if: ${{ matrix.os == 'macos-13' }}
+              run: |
+                  ./conduwuit-macos-x86_64 --version
+
+            - name: Build macOS arm64 binary
+              if: ${{ matrix.os == 'macos-latest' }}
+              run: |
+                  CONDUWUIT_VERSION_EXTRA="$(git rev-parse --short HEAD)" cargo build --release
+                  cp -v -f target/release/conduit conduwuit-macos-arm64
+                  otool -L conduwuit-macos-arm64
+
+            # quick smoke test of the arm64 macOS binary
+            - name: Run arm64 macOS release binary
+              if: ${{ matrix.os == 'macos-latest' }}
+              run: |
+                  ./conduwuit-macos-arm64 --version
+
+            - name: Upload macOS x86_64 binary
+              if: ${{ matrix.os == 'macos-13' }}
+              uses: actions/upload-artifact@v4
+              with:
+                  name: conduwuit-macos-x86_64
+                  path: conduwuit-macos-x86_64
+                  if-no-files-found: error
+
+            - name: Upload macOS arm64 binary
+              if: ${{ matrix.os == 'macos-latest' }}
+              uses: actions/upload-artifact@v4
+              with:
+                  name: conduwuit-macos-arm64
+                  path: conduwuit-macos-arm64
+                  if-no-files-found: error
+
     docker:
         name: Docker publish
-        runs-on: ubuntu-latest
+        runs-on: ubuntu-24.04
         needs: build
-        if: (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev') && github.event_name != 'pull_request'
+        if: (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main' || (github.event.pull_request.draft != true)) && (vars.DOCKER_USERNAME != '') && (vars.GITLAB_USERNAME != '') && github.event.pull_request.user.login != 'renovate[bot]'
         env:
-            DOCKER_ARM64: docker.io/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}-arm64v8
-            DOCKER_AMD64: docker.io/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}-amd64
-            DOCKER_TAG: docker.io/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}
-            DOCKER_BRANCH: docker.io/${{ github.repository }}:${{ (github.ref == 'refs/heads/main' && 'latest') || github.ref_name }}
-            GHCR_ARM64: ghcr.io/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}-arm64v8
-            GHCR_AMD64: ghcr.io/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}-amd64
-            GHCR_TAG: ghcr.io/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}
-            GHCR_BRANCH: ghcr.io/${{ github.repository }}:${{ (github.ref == 'refs/heads/main' && 'latest') || github.ref_name }}
-            GLCR_ARM64: registry.gitlab.com/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}-arm64v8
-            GLCR_AMD64: registry.gitlab.com/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}-amd64
-            GLCR_TAG: registry.gitlab.com/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}
-            GLCR_BRANCH: registry.gitlab.com/${{ github.repository }}:${{ (github.ref == 'refs/heads/main' && 'latest') || github.ref_name }}
+            DOCKER_ARM64: docker.io/${{ github.repository }}:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}-arm64v8
+            DOCKER_AMD64: docker.io/${{ github.repository }}:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}-amd64
+            DOCKER_TAG: docker.io/${{ github.repository }}:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}
+            DOCKER_BRANCH: docker.io/${{ github.repository }}:${{ (startsWith(github.ref, 'refs/tags/v') && !endsWith(github.ref, '-rc') && 'latest') || (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}
+            GHCR_ARM64: ghcr.io/${{ github.repository }}:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}-arm64v8
+            GHCR_AMD64: ghcr.io/${{ github.repository }}:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}-amd64
+            GHCR_TAG: ghcr.io/${{ github.repository }}:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}
+            GHCR_BRANCH: ghcr.io/${{ github.repository }}:${{ (startsWith(github.ref, 'refs/tags/v') && !endsWith(github.ref, '-rc') && 'latest') || (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}
+            GLCR_ARM64: registry.gitlab.com/conduwuit/conduwuit:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}-arm64v8
+            GLCR_AMD64: registry.gitlab.com/conduwuit/conduwuit:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}-amd64
+            GLCR_TAG: registry.gitlab.com/conduwuit/conduwuit:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}
+            GLCR_BRANCH: registry.gitlab.com/conduwuit/conduwuit:${{ (startsWith(github.ref, 'refs/tags/v') && !endsWith(github.ref, '-rc') && 'latest') || (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}
+
             DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
             GITLAB_TOKEN: ${{ secrets.GITLAB_TOKEN }}
         steps:
@@ -268,8 +554,10 @@ jobs:
 
             - name: Move OCI images into position
               run: |
-                  mv oci-image-x86_64-*-jemalloc/*.tar.gz oci-image-amd64.tar.gz
-                  mv oci-image-aarch64-*-jemalloc/*.tar.gz oci-image-arm64v8.tar.gz
+                  mv -v oci-image-x86_64-linux-musl/*.tar.gz oci-image-amd64.tar.gz
+                  mv -v oci-image-aarch64-linux-musl/*.tar.gz oci-image-arm64v8.tar.gz
+                  mv -v oci-image-x86_64-linux-musl-debug/*.tar.gz oci-image-amd64-debug.tar.gz
+                  mv -v oci-image-aarch64-linux-musl-debug/*.tar.gz oci-image-arm64v8-debug.tar.gz
 
             - name: Load and push amd64 image
               if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
@@ -293,6 +581,28 @@ jobs:
                   docker push ${{ env.GHCR_ARM64 }}
                   docker push ${{ env.GLCR_ARM64 }}
 
+            - name: Load and push amd64 debug image
+              if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
+              run: |
+                  docker load -i oci-image-amd64-debug.tar.gz
+                  docker tag $(docker images -q conduit:main) ${{ env.DOCKER_AMD64 }}-debug
+                  docker tag $(docker images -q conduit:main) ${{ env.GHCR_AMD64 }}-debug
+                  docker tag $(docker images -q conduit:main) ${{ env.GLCR_AMD64 }}-debug
+                  docker push ${{ env.DOCKER_AMD64 }}-debug
+                  docker push ${{ env.GHCR_AMD64 }}-debug
+                  docker push ${{ env.GLCR_AMD64 }}-debug
+
+            - name: Load and push arm64 debug image
+              if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
+              run: |
+                  docker load -i oci-image-arm64v8-debug.tar.gz
+                  docker tag $(docker images -q conduit:main) ${{ env.DOCKER_ARM64 }}-debug
+                  docker tag $(docker images -q conduit:main) ${{ env.GHCR_ARM64 }}-debug
+                  docker tag $(docker images -q conduit:main) ${{ env.GLCR_ARM64 }}-debug
+                  docker push ${{ env.DOCKER_ARM64 }}-debug
+                  docker push ${{ env.GHCR_ARM64 }}-debug
+                  docker push ${{ env.GLCR_ARM64 }}-debug
+
             - name: Create Docker combined manifests
               run: |
                   # Dockerhub Container Registry
@@ -302,9 +612,21 @@ jobs:
                   docker manifest create ${{ env.GHCR_TAG }} --amend ${{ env.GHCR_ARM64 }} --amend ${{ env.GHCR_AMD64 }}
                   docker manifest create ${{ env.GHCR_BRANCH }} --amend ${{ env.GHCR_ARM64 }} --amend ${{ env.GHCR_AMD64 }}
                   # GitLab Container Registry
-                  docker manifest create ${{ env.GLCR_TAG }} --amend ${{ env.GLCR_ARM64 }} --amend ${{ env.GCCR_AMD64 }}
+                  docker manifest create ${{ env.GLCR_TAG }} --amend ${{ env.GLCR_ARM64 }} --amend ${{ env.GLCR_AMD64 }}
                   docker manifest create ${{ env.GLCR_BRANCH }} --amend ${{ env.GLCR_ARM64 }} --amend ${{ env.GLCR_AMD64 }}
 
+            - name: Create Docker combined debug manifests
+              run: |
+                  # Dockerhub Container Registry
+                  docker manifest create ${{ env.DOCKER_TAG }}-debug --amend ${{ env.DOCKER_ARM64 }}-debug --amend ${{ env.DOCKER_AMD64 }}-debug
+                  docker manifest create ${{ env.DOCKER_BRANCH }}-debug --amend ${{ env.DOCKER_ARM64 }}-debug --amend ${{ env.DOCKER_AMD64 }}-debug
+                  # GitHub Container Registry
+                  docker manifest create ${{ env.GHCR_TAG }}-debug --amend ${{ env.GHCR_ARM64 }}-debug --amend ${{ env.GHCR_AMD64 }}-debug
+                  docker manifest create ${{ env.GHCR_BRANCH }}-debug --amend ${{ env.GHCR_ARM64 }}-debug --amend ${{ env.GHCR_AMD64 }}-debug
+                  # GitLab Container Registry
+                  docker manifest create ${{ env.GLCR_TAG }}-debug --amend ${{ env.GLCR_ARM64 }}-debug --amend ${{ env.GLCR_AMD64 }}-debug
+                  docker manifest create ${{ env.GLCR_BRANCH }}-debug --amend ${{ env.GLCR_ARM64 }}-debug --amend ${{ env.GLCR_AMD64 }}-debug
+
             - name: Push manifests to Docker registries
               if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
               run: |
@@ -314,6 +636,12 @@ jobs:
                   docker manifest push ${{ env.GHCR_BRANCH }}
                   docker manifest push ${{ env.GLCR_TAG }}
                   docker manifest push ${{ env.GLCR_BRANCH }}
+                  docker manifest push ${{ env.DOCKER_TAG }}-debug
+                  docker manifest push ${{ env.DOCKER_BRANCH }}-debug
+                  docker manifest push ${{ env.GHCR_TAG }}-debug
+                  docker manifest push ${{ env.GHCR_BRANCH }}-debug
+                  docker manifest push ${{ env.GLCR_TAG }}-debug
+                  docker manifest push ${{ env.GLCR_BRANCH }}-debug
 
             - name: Add Image Links to Job Summary
               if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
@@ -321,3 +649,6 @@ jobs:
                   echo "- \`docker pull ${{ env.DOCKER_TAG }}\`" >> $GITHUB_STEP_SUMMARY
                   echo "- \`docker pull ${{ env.GHCR_TAG }}\`" >> $GITHUB_STEP_SUMMARY
                   echo "- \`docker pull ${{ env.GLCR_TAG }}\`" >> $GITHUB_STEP_SUMMARY
+                  echo "- \`docker pull ${{ env.DOCKER_TAG }}-debug\`" >> $GITHUB_STEP_SUMMARY
+                  echo "- \`docker pull ${{ env.GHCR_TAG }}-debug\`" >> $GITHUB_STEP_SUMMARY
+                  echo "- \`docker pull ${{ env.GLCR_TAG }}-debug\`" >> $GITHUB_STEP_SUMMARY

.github/workflows/documentation.yml

@@ -5,6 +5,8 @@ on:
   push:
     branches:
       - main
+    tags:
+      - '*'
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -14,9 +16,19 @@ env:
   TERM: ansi
   # Publishing to my nix binary cache
   ATTIC_TOKEN: ${{ secrets.ATTIC_TOKEN }}
+  # conduwuit.cachix.org
+  CACHIX_AUTH_TOKEN: ${{ secrets.CACHIX_AUTH_TOKEN }}
   # Custom nix binary cache if fork is being used
   ATTIC_ENDPOINT: ${{ vars.ATTIC_ENDPOINT }}
   ATTIC_PUBLIC_KEY: ${{ vars.ATTIC_PUBLIC_KEY }}
+  # Get error output from nix that we can actually use, and use our binary caches for the earlier CI steps
+  NIX_CONFIG: |
+    show-trace = true
+    extra-substituters = extra-substituters = https://attic.kennel.juneis.dog/conduwuit https://attic.kennel.juneis.dog/conduit https://cache.lix.systems https://conduwuit.cachix.org https://aseipp-nix-cache.freetls.fastly.net
+    extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk= conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o= conduwuit.cachix.org-1:MFRm6jcnfTf0jSAbmvLfhO3KBMt4px+1xaereWXp8Xg=
+    experimental-features = nix-command flakes
+    extra-experimental-features = nix-command flakes
+    accept-flake-config = true
 
 # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
 # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
@@ -27,8 +39,7 @@ concurrency:
 jobs:
   docs:
     name: Documentation and GitHub Pages
-
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
 
     permissions:
       pages: write
@@ -39,61 +50,91 @@ jobs:
       url: ${{ steps.deployment.outputs.page_url }}
 
     steps:
+      - name: Free up a bit of runner space
+        run: |
+            set +o pipefail
+            sudo docker image prune --all --force || true
+            sudo apt purge -y 'php.*' '^mongodb-.*' '^mysql-.*' azure-cli google-cloud-cli google-chrome-stable firefox powershell microsoft-edge-stable || true
+            sudo apt clean
+            sudo rm -v -rf /usr/local/games /usr/local/sqlpackage /usr/local/share/powershell /usr/local/share/edge_driver /usr/local/share/gecko_driver /usr/local/share/chromium /usr/local/share/chromedriver-linux64 /usr/lib/google-cloud-sdk /usr/lib/jvm /usr/lib/mono /usr/lib/heroku
+            set -o pipefail
+
       - name: Sync repository
         uses: actions/checkout@v4
 
       - name: Setup GitHub Pages
-        if: github.event_name != 'pull_request'
+        if: (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main') && (github.event_name != 'pull_request')
         uses: actions/configure-pages@v5
 
-      - name: Install Nix (with flakes and nix-command enabled)
-        uses: cachix/install-nix-action@v26
+      - uses: nixbuild/nix-quick-install-action@master
+
+      - name: Restore and cache Nix store
+        uses: nix-community/cache-nix-action@v5.1.0
         with:
-          nix_path: nixpkgs=channel:nixos-unstable
+          # restore and save a cache using this key
+          primary-key: nix-${{ runner.os }}-${{ hashFiles('**/*.nix', '**/.lock') }}
+          # if there's no cache hit, restore a cache by this prefix
+          restore-prefixes-first-match: nix-${{ runner.os }}-
+          # collect garbage until Nix store size (in bytes) is at most this number
+          # before trying to save a new cache
+          gc-max-store-size-linux: 2073741824
+          # do purge caches
+          purge: true
+          # purge all versions of the cache
+          purge-prefixes: nix-${{ runner.os }}-
+          # created more than this number of seconds ago relative to the start of the `Post Restore` phase
+          purge-last-accessed: 86400
+          # except the version with the `primary-key`, if it exists
+          purge-primary-key: never
+          # always save the cache
+          save-always: true
 
-          # Add `nix-community`, Crane, upstream Conduit, and conduwuit binary caches
-          extra_nix_config: |
+      - name: Enable Cachix binary cache
+        run: |
+            nix profile install nixpkgs#cachix
+            cachix use crane
+            cachix use nix-community
+
+      - name: Apply Nix binary cache configuration
+        run: |
+            sudo tee -a "${XDG_CONFIG_HOME:-$HOME/.config}/nix/nix.conf" > /dev/null <<EOF
+            extra-substituters = https://attic.kennel.juneis.dog/conduwuit https://attic.kennel.juneis.dog/conduit https://cache.lix.systems https://conduwuit.cachix.org https://aseipp-nix-cache.freetls.fastly.net
+            extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk= conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o= conduwuit.cachix.org-1:MFRm6jcnfTf0jSAbmvLfhO3KBMt4px+1xaereWXp8Xg=
             experimental-features = nix-command flakes
-            extra-substituters = https://nix-community.cachix.org
-            extra-trusted-public-keys = nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs=
-            extra-substituters = https://crane.cachix.org
-            extra-trusted-public-keys = crane.cachix.org-1:8Scfpmn9w+hGdXH/Q9tTLiYAE/2dnJYRJP7kl80GuRk=
-            extra-substituters = https://attic.kennel.juneis.dog/conduit
-            extra-trusted-public-keys = conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg=
-            extra-substituters = https://attic.kennel.juneis.dog/conduwuit
-            extra-trusted-public-keys = conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw=
+            extra-experimental-features = nix-command flakes
+            accept-flake-config = true
+            EOF
 
-      - name: Add alternative Nix binary caches if specified
+      - name: Use alternative Nix binary caches if specified
         if: ${{ (env.ATTIC_ENDPOINT != '') && (env.ATTIC_PUBLIC_KEY != '') }}
         run: |
-          echo "extra-substituters = ${{ env.ATTIC_ENDPOINT }}" >> /etc/nix/nix.conf
-          echo "extra-trusted-public-keys = ${{ env.ATTIC_PUBLIC_KEY }}" >> /etc/nix/nix.conf
+            sudo tee -a "${XDG_CONFIG_HOME:-$HOME/.config}/nix/nix.conf" > /dev/null <<EOF
+            extra-substituters = ${{ env.ATTIC_ENDPOINT }}
+            extra-trusted-public-keys = ${{ env.ATTIC_PUBLIC_KEY }}
+            EOF
 
-      - name: Pop/push Magic Nix Cache
-        uses: DeterminateSystems/magic-nix-cache-action@main
-
-      - name: Configure `nix-direnv`
+      - name: Prepare build environment
         run: |
-          echo 'source $HOME/.nix-profile/share/nix-direnv/direnvrc' > "$HOME/.direnvrc"
-
-      - name: Install `direnv` and `nix-direnv`
-        run: nix-env -f "<nixpkgs>" -iA direnv -iA nix-direnv
-
-      # Do this to shorten the logs for the real CI step
-      - name: Populate `/nix/store`
-        run: nix develop --command true
-
-      - name: Allow direnv
-        run: direnv allow
+            echo 'source $HOME/.nix-profile/share/nix-direnv/direnvrc' > "$HOME/.direnvrc"
+            nix profile install --inputs-from . nixpkgs#direnv nixpkgs#nix-direnv
+            direnv allow
+            nix develop --command true
 
       - name: Cache CI dependencies
         run: |
-          ./bin/nix-build-and-cache ci
+            bin/nix-build-and-cache ci
+
+      - name: Run lychee and markdownlint
+        run: |
+            direnv exec . engage just lints lychee
+            direnv exec . engage just lints markdownlint
 
       - name: Build documentation (book)
         run: |
-          ./bin/nix-build-and-cache just .#book
-          cp -r --dereference result public
+            bin/nix-build-and-cache just .#book
+
+            cp -r --dereference result public
+
       - name: Upload generated documentation (book) as normal artifact
         uses: actions/upload-artifact@v4
         with:
@@ -104,12 +145,12 @@ jobs:
           compression-level: 0
 
       - name: Upload generated documentation (book) as GitHub Pages artifact
-        if: github.event_name != 'pull_request'
+        if: (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main') && (github.event_name != 'pull_request')
         uses: actions/upload-pages-artifact@v3
         with:
           path: public
 
       - name: Deploy to GitHub Pages
-        if: github.event_name != 'pull_request'
+        if: (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main') && (github.event_name != 'pull_request')
         id: deployment
         uses: actions/deploy-pages@v4

.github/workflows/trivy.yml

@@ -1,40 +0,0 @@
-name: Trivy code and vulnerability scanning
-
-on:
-  pull_request:
-  push:
-    branches:
-      - main
-  schedule:
-    - cron: '00 12 * * *'
-
-permissions:
-  contents: read
-
-jobs:
-  trivy-scan:
-    name: Trivy Scan
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      security-events: write
-      actions: read
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Run Trivy code and vulnerability scanner on repo
-        uses: aquasecurity/trivy-action@0.19.0
-        with:
-          scan-type: repo
-          format: sarif
-          output: trivy-results.sarif
-          severity: CRITICAL,HIGH,MEDIUM,LOW
-
-      - name: Run Trivy code and vulnerability scanner on filesystem
-        uses: aquasecurity/trivy-action@0.19.0
-        with:
-          scan-type: fs
-          format: sarif
-          output: trivy-results.sarif
-          severity: CRITICAL,HIGH,MEDIUM,LOW

.gitignore

@@ -1,3 +1,6 @@
+# Local environment overrides
+/.env
+
 # CMake
 cmake-build-*/
 

.gitlab-ci.yml

@@ -10,6 +10,13 @@ variables:
   FF_USE_FASTZIP: true
   # Print progress reports for cache and artifact transfers
   TRANSFER_METER_FREQUENCY: 5s
+  NIX_CONFIG: |
+    show-trace = true
+    extra-substituters = https://attic.kennel.juneis.dog/conduit https://attic.kennel.juneis.dog/conduwuit https://cache.lix.systems https://conduwuit.cachix.org
+    extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk= conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o= conduwuit.cachix.org-1:MFRm6jcnfTf0jSAbmvLfhO3KBMt4px+1xaereWXp8Xg=
+    experimental-features = nix-command flakes
+    extra-experimental-features = nix-command flakes
+    accept-flake-config = true
 
 # Avoid duplicate pipelines
 # See: https://docs.gitlab.com/ee/ci/yaml/workflow.html#switch-between-branch-pipelines-and-merge-request-pipelines
@@ -23,18 +30,25 @@ workflow:
 before_script:
   # Enable nix-command and flakes
   - if command -v nix > /dev/null; then echo "experimental-features = nix-command flakes" >> /etc/nix/nix.conf; fi
+  - if command -v nix > /dev/null; then echo "extra-experimental-features = nix-command flakes" >> /etc/nix/nix.conf; fi
+  # Accept flake config from "untrusted" users
+  - if command -v nix > /dev/null; then echo "accept-flake-config = true" >> /etc/nix/nix.conf; fi
 
   # Add conduwuit binary cache
   - if command -v nix > /dev/null; then echo "extra-substituters = https://attic.kennel.juneis.dog/conduwuit" >> /etc/nix/nix.conf; fi
-  - if command -v nix > /dev/null; then echo "extra-trusted-public-keys = conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw=" >> /etc/nix/nix.conf; fi
+  - if command -v nix > /dev/null; then echo "extra-trusted-public-keys = conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE=" >> /etc/nix/nix.conf; fi
 
   - if command -v nix > /dev/null; then echo "extra-substituters = https://attic.kennel.juneis.dog/conduit" >> /etc/nix/nix.conf; fi
-  - if command -v nix > /dev/null; then echo "extra-trusted-public-keys = conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg=" >> /etc/nix/nix.conf; fi
+  - if command -v nix > /dev/null; then echo "extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk=" >> /etc/nix/nix.conf; fi
 
   # Add alternate binary cache
   - if command -v nix > /dev/null && [ -n "$ATTIC_ENDPOINT" ]; then echo "extra-substituters = $ATTIC_ENDPOINT" >> /etc/nix/nix.conf; fi
   - if command -v nix > /dev/null && [ -n "$ATTIC_PUBLIC_KEY" ]; then echo "extra-trusted-public-keys = $ATTIC_PUBLIC_KEY" >> /etc/nix/nix.conf; fi
 
+  # Add Lix binary cache
+  - if command -v nix > /dev/null; then echo "extra-substituters = https://cache.lix.systems" >> /etc/nix/nix.conf; fi
+  - if command -v nix > /dev/null; then echo "extra-trusted-public-keys = cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o=" >> /etc/nix/nix.conf; fi
+
   # Add crane binary cache
   - if command -v nix > /dev/null; then echo "extra-substituters = https://crane.cachix.org" >> /etc/nix/nix.conf; fi
   - if command -v nix > /dev/null; then echo "extra-trusted-public-keys = crane.cachix.org-1:8Scfpmn9w+hGdXH/Q9tTLiYAE/2dnJYRJP7kl80GuRk=" >> /etc/nix/nix.conf; fi
@@ -43,6 +57,8 @@ before_script:
   - if command -v nix > /dev/null; then echo "extra-substituters = https://nix-community.cachix.org" >> /etc/nix/nix.conf; fi
   - if command -v nix > /dev/null; then echo "extra-trusted-public-keys = nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs=" >> /etc/nix/nix.conf; fi
 
+  - if command -v nix > /dev/null; then echo "extra-substituters = https://aseipp-nix-cache.freetls.fastly.net" >> /etc/nix/nix.conf; fi
+
   # Install direnv and nix-direnv
   - if command -v nix > /dev/null; then nix-env -iA nixpkgs.direnv nixpkgs.nix-direnv; fi
 
@@ -54,7 +70,7 @@ before_script:
 
 ci:
   stage: ci
-  image: nixos/nix:2.22.0
+  image: nixos/nix:2.24.9
   script:
     # Cache CI dependencies
     - ./bin/nix-build-and-cache ci
@@ -79,31 +95,31 @@ ci:
 
 artifacts:
   stage: artifacts
-  image: nixos/nix:2.22.0
+  image: nixos/nix:2.24.9
   script:
-    - ./bin/nix-build-and-cache just .#static-x86_64-unknown-linux-musl
-    - cp result/bin/conduit x86_64-unknown-linux-musl
+    - ./bin/nix-build-and-cache just .#static-x86_64-linux-musl
+    - cp result/bin/conduit x86_64-linux-musl
 
     - mkdir -p target/release
     - cp result/bin/conduit target/release
     - direnv exec . cargo deb --no-build --no-strip
-    - mv target/debian/*.deb x86_64-unknown-linux-musl.deb
+    - mv target/debian/*.deb x86_64-linux-musl.deb
 
     # Since the OCI image package is based on the binary package, this has the
     # fun side effect of uploading the normal binary too. Conduit users who are
     # deploying with Nix can leverage this fact by adding our binary cache to
     # their systems.
     #
-    # Note that although we have an `oci-image-x86_64-unknown-linux-musl`
+    # Note that although we have an `oci-image-x86_64-linux-musl`
     # output, we don't build it because it would be largely redundant to this
     # one since it's all containerized anyway.
     - ./bin/nix-build-and-cache just .#oci-image
     - cp result oci-image-amd64.tar.gz
 
-    - ./bin/nix-build-and-cache just .#static-aarch64-unknown-linux-musl
-    - cp result/bin/conduit aarch64-unknown-linux-musl
+    - ./bin/nix-build-and-cache just .#static-aarch64-linux-musl
+    - cp result/bin/conduit aarch64-linux-musl
 
-    - ./bin/nix-build-and-cache just .#oci-image-aarch64-unknown-linux-musl
+    - ./bin/nix-build-and-cache just .#oci-image-aarch64-linux-musl
     - cp result oci-image-arm64v8.tar.gz
 
     - ./bin/nix-build-and-cache just .#book
@@ -111,9 +127,9 @@ artifacts:
     - cp -r --dereference result public
   artifacts:
     paths:
-      - x86_64-unknown-linux-musl
-      - aarch64-unknown-linux-musl
-      - x86_64-unknown-linux-musl.deb
+      - x86_64-linux-musl
+      - aarch64-linux-musl
+      - x86_64-linux-musl.deb
       - oci-image-amd64.tar.gz
       - oci-image-arm64v8.tar.gz
       - public

.markdownlintignore

@@ -0,0 +1 @@
+.gitignore

CODE_OF_CONDUCT.md

@@ -61,7 +61,7 @@ ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement over email at
-strawberry@puppygock.gay or over Matrix at @strawberry:puppygock.gay.
+<strawberry@puppygock.gay> or over Matrix at @strawberry:puppygock.gay.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
@@ -131,4 +131,3 @@ ## Attribution
 [Mozilla CoC]: https://github.com/mozilla/diversity
 [FAQ]: https://www.contributor-covenant.org/faq
 [translations]: https://www.contributor-covenant.org/translations
-

CONTRIBUTING.md

@@ -0,0 +1,149 @@
+# Contributing guide
+
+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.
+
+### 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.
+
+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.
+
+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`
+
+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`
+
+The following binaries are used in [`engage.toml`][engage.toml]:
+
+- [`engage`][engage]
+- `nix`
+- [`direnv`][direnv]
+- `rustc`
+- `cargo`
+- `cargo-fmt`
+- `rustdoc`
+- `cargo-clippy`
+- [`cargo-audit`][cargo-audit]
+- [`cargo-deb`][cargo-deb]
+- [`lychee`][lychee]
+- [`markdownlint-cli`][markdownlint-cli]
+- `dpkg`
+
+### 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.
+
+If you'd like to run Complement locally using Nix, see the
+[testing](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.
+
+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.
+
+### 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).
+
+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).
+
+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.
+
+### 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.
+
+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, and conduwuit's Code of Conduct.
+
+Contribution by users who violate either of these code of conducts will not have
+their contributions accepted. This includes users who have been banned from
+conduwuit Matrix rooms for Code of Conduct violations.
+
+[issues]: https://github.com/girlbossceo/conduwuit/issues
+[conduwuit-matrix]: https://matrix.to/#/#conduwuit:puppygock.gay
+[complement]: https://github.com/matrix-org/complement/
+[engage.toml]: https://github.com/girlbossceo/conduwuit/blob/main/engage.toml
+[engage]: https://charles.page.computer.surgery/engage/
+[sytest]: https://github.com/matrix-org/sytest/
+[cargo-deb]: https://github.com/kornelski/cargo-deb
+[lychee]: https://github.com/lycheeverse/lychee
+[markdownlint-cli]: https://github.com/igorshubovych/markdownlint-cli
+[cargo-audit]: https://github.com/RustSec/rustsec/tree/main/cargo-audit
+[direnv]: https://direnv.net/
+[mdbook]: https://rust-lang.github.io/mdBook/
+[documentation.yml]: https://github.com/girlbossceo/conduwuit/blob/main/.github/workflows/documentation.yml

README.md

@@ -1,16 +1,18 @@
 # 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)
-
-`dev`: [![CI and Artifacts](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml/badge.svg?branch=dev)](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml)
+[![conduwuit main room](https://img.shields.io/matrix/conduwuit%3Apuppygock.gay?server_fqdn=matrix.transfem.dev&style=flat&logo=matrix&logoColor=%23f5b3ff&label=%23conduwuit%3Apuppygock.gay&color=%23f652ff)](https://matrix.to/#/#conduwuit:puppygock.gay) [![conduwuit space](https://img.shields.io/matrix/conduwuit-space%3Apuppygock.gay?server_fqdn=matrix.transfem.dev&style=flat&logo=matrix&logoColor=%23f5b3ff&label=%23conduwuit-space%3Apuppygock.gay&color=%23f652ff)](https://matrix.to/#/#conduwuit-space:puppygock.gay) [![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 and how to deploy/setup conduwuit.
 
 <!-- ANCHOR: body -->
+
 #### What is Matrix?
 
 [Matrix](https://matrix.org) is an open network for secure and decentralized
@@ -20,47 +22,76 @@ #### What is Matrix?
 
 #### 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.
+A high-performance and 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 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 technically a hard fork of Conduit, which is in Beta. The Beta status
+initially was inherited from Conduit, however overtime this Beta status is rapidly
+becoming less and less relevant as our codebase significantly diverges more and more.
+
+conduwuit is quite stable and very usable as a daily driver and for a low-medium
+sized homeserver. There is still a lot of more work to be done, but it is in a far
+better place than the project was in early 2024.
+
+#### How is conduwuit funded? Is conduwuit sustainable?
+
+conduwuit has no external funding. This is made possible purely in my freetime with
+contributors, also in their free time, and only by user-curated donations.
+
+conduwuit has existed since around November 2023, but [only became more publicly known
+in March/April 2024](https://matrix.org/blog/2024/04/26/this-week-in-matrix-2024-04-26/#conduwuit-website)
+and we have no plans in stopping or slowing down any time soon!
+
+#### Can I migrate or switch from Conduit?
+
+conduwuit is a complete drop-in replacement for Conduit. As long as you are using RocksDB,
+the only "migration" you need to do is replace the binary or container image. There
+is no harm or additional steps required for using conduwuit. See the
+[Migrating from Conduit](https://conduwuit.puppyirl.gay/deploying/generic.html#migrating-from-conduit) section
+on the generic deploying guide.
 
 <!-- ANCHOR_END: body -->
 
 <!-- ANCHOR: footer -->
-#### How can I contribute?
-
-1. Look for an issue you would like to work on and make sure it's not assigned
-   to other users
-2. Ask someone to assign the issue to you (comment on the issue or chat in
-   [#conduwuit:puppygock.gay](https://matrix.to/#/#conduwuit:puppygock.gay))
-3. Fork the repo and work on the issue.
-4. Submit a PR (please keep contributions to the GitHub repo, main development is done here, not the GitLab repo which exists just as a mirror. If you are avoiding GitHub, feel free to join our Matrix chat to get your patch in.)
 
 #### Contact
 
 If you run into any question, feel free to
+
 - Ask us in `#conduwuit:puppygock.gay` on Matrix
 - [Open an issue on GitHub](https://github.com/girlbossceo/conduwuit/issues/new)
 
 #### Donate
 
+conduwuit development is purely made possible by myself and contributors. I do
+not get paid to work on this, and I work on it in my free time. Donations are
+heavily appreciated! 💜🥺
+
 - Liberapay: <https://liberapay.com/girlbossceo>
-- Ko-fi: <https://ko-fi.com/puppygock>
+- Ko-fi (note they take a fee): <https://ko-fi.com/puppygock>
 - GitHub Sponsors: <https://github.com/sponsors/girlbossceo>
 
 #### 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,8 +100,10 @@ #### Is it conduwuit or Conduwuit?
 #### Mirrors of conduwuit
 
 - GitHub: <https://github.com/girlbossceo/conduwuit>
-- GitLab: <https://gitlab.com/girlbossceo/conduwuit>
+- GitLab: <https://gitlab.com/conduwuit/conduwuit>
+- git.girlcock.ceo: <https://git.girlcock.ceo/strawberry/conduwuit>
 - git.gay: <https://git.gay/june/conduwuit>
 - Codeberg: <https://codeberg.org/girlbossceo/conduwuit>
 - sourcehut: <https://git.sr.ht/~girlbossceo/conduwuit>
+
 <!-- ANCHOR_END: footer -->

arch/conduwuit.service

@@ -0,0 +1,62 @@
+[Unit]
+Description=conduwuit Matrix homeserver
+After=network.target
+Documentation=https://conduwuit.puppyirl.gay/
+RequiresMountsFor=/var/lib/private/conduwuit
+
+[Service]
+DynamicUser=yes
+Type=notify
+
+AmbientCapabilities=
+CapabilityBoundingSet=
+
+DevicePolicy=closed
+LockPersonality=yes
+MemoryDenyWriteExecute=yes
+NoNewPrivileges=yes
+#ProcSubset=pid
+ProtectClock=yes
+ProtectControlGroups=yes
+ProtectHome=yes
+ProtectHostname=yes
+ProtectKernelLogs=yes
+ProtectKernelModules=yes
+ProtectKernelTunables=yes
+ProtectProc=invisible
+ProtectSystem=strict
+PrivateDevices=yes
+PrivateMounts=yes
+PrivateTmp=yes
+PrivateUsers=yes
+PrivateIPC=yes
+RemoveIPC=yes
+RestrictAddressFamilies=AF_INET AF_INET6 AF_UNIX
+RestrictNamespaces=yes
+RestrictRealtime=yes
+RestrictSUIDSGID=yes
+SystemCallArchitectures=native
+SystemCallFilter=@system-service @resources
+SystemCallFilter=~@clock @debug @module @mount @reboot @swap @cpu-emulation @obsolete @timer @chown @setuid @privileged @keyring @ipc
+SystemCallErrorNumber=EPERM
+StateDirectory=conduwuit
+
+RuntimeDirectory=conduwuit
+RuntimeDirectoryMode=0750
+
+Environment="CONDUWUIT_CONFIG=/etc/conduwuit/conduwuit.toml"
+BindPaths=/var/lib/private/conduwuit:/var/lib/matrix-conduit
+BindPaths=/var/lib/private/conduwuit:/var/lib/private/matrix-conduit
+
+ExecStart=/usr/bin/conduwuit
+Restart=on-failure
+RestartSec=5
+
+TimeoutStopSec=4m
+TimeoutStartSec=4m
+
+StartLimitInterval=1m
+StartLimitBurst=5
+
+[Install]
+WantedBy=multi-user.target

audit.toml

@@ -1,2 +0,0 @@
-[advisories]
-ignore = ["RUSTSEC-2020-0016"]

bin/complement

@@ -7,7 +7,7 @@ set -euo pipefail
 # The `COMPLEMENT_SRC` environment variable is set in the Nix dev shell, which
 # points to a store path containing the Complement source code. It's likely you
 # want to just pass that as the first argument to use it here.
-COMPLEMENT_SRC="$1"
+COMPLEMENT_SRC="${COMPLEMENT_SRC:-$1}"
 
 # A `.jsonl` file to write test logs to
 LOG_FILE="$2"
@@ -15,17 +15,27 @@ LOG_FILE="$2"
 # A `.jsonl` file to write test results to
 RESULTS_FILE="$3"
 
-OCI_IMAGE="complement-conduit:dev"
+OCI_IMAGE="complement-conduwuit:main"
+
+# Complement tests that are skipped due to flakiness/reliability issues
+SKIPPED_COMPLEMENT_TESTS='-skip=TestClientSpacesSummary.*|TestJoinFederatedRoomFromApplicationServiceBridgeUser.*|TestJumpToDateEndpoint.*|TestUnbanViaInvite.*'
+
+# $COMPLEMENT_SRC needs to be a directory to Complement source code
+if [ -f "$COMPLEMENT_SRC" ]; then
+    echo "\$COMPLEMENT_SRC must be a directory/path to Complement source code"
+    exit 1
+fi
+
+# quick test to make sure we can actually write to $LOG_FILE and $RESULTS_FILE
+touch $LOG_FILE && rm -v $LOG_FILE
+touch $RESULTS_FILE && rm -v $RESULTS_FILE
 
 toplevel="$(git rev-parse --show-toplevel)"
 
 pushd "$toplevel" > /dev/null
-# uses nix-output-monitor (nom) if available
-if command -v nom &> /dev/null; then
-    nom build .#complement
-else
-    nix build -L .#complement
-fi
+
+bin/nix-build-and-cache just .#linux-complement
+
 docker load < result
 popd > /dev/null
 
@@ -34,7 +44,7 @@ set +o pipefail
 env \
     -C "$COMPLEMENT_SRC" \
     COMPLEMENT_BASE_IMAGE="$OCI_IMAGE" \
-    go test -vet=off -timeout 1h -json ./tests | tee "$LOG_FILE"
+    go test -tags="conduwuit_blacklist" "$SKIPPED_COMPLEMENT_TESTS" -v -timeout 1h -json ./tests | tee "$LOG_FILE"
 set -o pipefail
 
 # Post-process the results into an easy-to-compare format, sorted by Test name for reproducible results

bin/nix-build-and-cache

@@ -13,41 +13,67 @@ just() {
         nix build -L "$@"
     fi
 
-    if [ ! -z "$ATTIC_TOKEN" ]; then
-        # historical "conduit" store for compatibility purposes, same as conduwuit
-        nix run --inputs-from "$toplevel" attic -- \
-            login \
-            conduit \
-            "${ATTIC_ENDPOINT:-https://attic.kennel.juneis.dog/conduit}" \
-            "$ATTIC_TOKEN"
-
-        readarray -t outputs < <(nix path-info "$@")
-        readarray -t derivations < <(nix path-info "$@" --derivation)
-
-        # Push the target installable and its build dependencies
-        nix run --inputs-from "$toplevel" attic -- \
-            push \
-            conduit \
-            "${outputs[@]}" \
-            "${derivations[@]}"
-
-        # main "conduwuit" store
-        nix run --inputs-from "$toplevel" attic -- \
-            login \
-            conduwuit \
-            "${ATTIC_ENDPOINT:-https://attic.kennel.juneis.dog/conduwuit}" \
-            "$ATTIC_TOKEN"
-
-        # Push the target installable and its build dependencies
-        nix run --inputs-from "$toplevel" attic -- \
-            push \
-            conduwuit \
-            "${outputs[@]}" \
-            "${derivations[@]}"
-    else
+    if [ -z "$ATTIC_TOKEN" ]; then
         echo "\$ATTIC_TOKEN is unset, skipping uploading to the binary cache"
+        return
     fi
 
+    # historical "conduit" store for compatibility purposes, same as conduwuit
+    nix run --inputs-from "$toplevel" attic -- \
+        login \
+        conduit \
+        "${ATTIC_ENDPOINT:-https://attic.kennel.juneis.dog/conduit}" \
+        "$ATTIC_TOKEN"
+
+    # Find all output paths of the installables and their build dependencies
+    #readarray -t derivations < <(nix path-info --derivation "$@")
+    derivations=()
+    while IFS=$'\n' read derivation; do
+        derivations+=("$derivation")
+    done < <(nix path-info --derivation "$@")
+
+    cache=()
+    for derivation in "${derivations[@]}"; do
+        cache+=(
+            "$(nix-store --query --requisites --include-outputs "$derivation")"
+        )
+    done
+
+    withattic() {
+        nix shell --inputs-from "$toplevel" attic --command xargs attic push "$@" <<< "${cache[*]}"
+    }
+    # Upload them to Attic (conduit store)
+    #
+    # Use `xargs` and a here-string because something would probably explode if
+    # several thousand arguments got passed to a command at once. Hopefully no
+    # store paths include a newline in them.
+    (
+        IFS=$'\n'
+        withattic conduit || withattic conduit || withattic conduit || true
+    )
+
+    # main "conduwuit" store
+    nix run --inputs-from "$toplevel" attic -- \
+        login \
+        conduwuit \
+        "${ATTIC_ENDPOINT:-https://attic.kennel.juneis.dog/conduwuit}" \
+        "$ATTIC_TOKEN"
+
+    # Upload them to Attic (conduwuit store) and Cachix
+    #
+    # Use `xargs` and a here-string because something would probably explode if
+    # several thousand arguments got passed to a command at once. Hopefully no
+    # store paths include a newline in them.
+    (
+        IFS=$'\n'
+        withattic conduwuit || withattic conduwuit || withattic conduwuit || true
+
+        # push to cachix if available
+        if [ "$CACHIX_AUTH_TOKEN" ]; then
+            nix shell --inputs-from "$toplevel" cachix -c xargs \
+            cachix push conduwuit <<< "${cache[*]}"
+        fi
+    )
 }
 
 # Build and cache things needed for CI
@@ -56,8 +82,10 @@ ci() {
         --inputs-from "$toplevel"
 
         # Keep sorted
-        "$toplevel#devShells.x86_64-linux.default.inputDerivation"
+        #"$toplevel#devShells.x86_64-linux.default"
+        #"$toplevel#devShells.x86_64-linux.all-features"
         attic#default
+        cachix#default
         nixpkgs#direnv
         nixpkgs#jq
         nixpkgs#nix-direnv

book.toml

@@ -1,13 +1,19 @@
 [book]
-title = "conduwuit"
+title = "conduwuit 🏳️‍⚧️ 💜 🦴"
 description = "conduwuit, which is a well-maintained fork of Conduit, is a simple, fast and reliable chat server for the Matrix protocol"
 language = "en"
+authors = ["strawberry (June)"]
+text-direction = "ltr"
 multilingual = false
 src = "docs"
 
 [build]
 build-dir = "public"
 create-missing = true
+extra-watch-dirs = ["debian", "docs"]
+
+[rust]
+edition = "2021"
 
 [output.html]
 git-repository-url = "https://github.com/girlbossceo/conduwuit"

clippy.toml

@@ -1 +1,15 @@
-too-many-lines-threshold = 700
+array-size-threshold = 4096
+cognitive-complexity-threshold = 94         # TODO reduce me ALARA
+excessive-nesting-threshold = 11            # TODO reduce me to 4 or 5
+future-size-threshold = 7745                # TODO reduce me ALARA
+stack-size-threshold = 196608               # reduce me ALARA
+too-many-lines-threshold = 700              # TODO reduce me to <= 100
+type-complexity-threshold = 250             # reduce me to ~200
+
+disallowed-macros = [
+	{ path = "log::error", reason = "use conduit_core::error" },
+	{ path = "log::warn", reason = "use conduit_core::warn" },
+	{ path = "log::info", reason = "use conduit_core::info" },
+	{ path = "log::debug", reason = "use conduit_core::debug" },
+	{ path = "log::trace", reason = "use conduit_core::trace" },
+]

debian/README.md

@@ -1,34 +1,27 @@
-conduwuit for Debian
-==================
+# conduwuit for Debian
 
-Installation
-------------
+Information about downloading and deploying the Debian package. This may also be
+referenced for other `apt`-based distros such as Ubuntu.
 
-Information about downloading, building and deploying the Debian package, see
-the "Installing conduwuit" section in the Deploying docs.
-All following sections until "Setting up the Reverse Proxy" be ignored because
-this is handled automatically by the packaging.
+### Installation
 
-Configuration
--------------
+It is recommended to see the [generic deployment guide](../deploying/generic.md)
+for further information if needed as usage of the Debian package is generally
+related.
 
-When installed, Debconf generates the configuration of the homeserver
-(host)name, the address and port it listens on. This configuration ends up in
-`/etc/conduwuit/conduwuit.toml`.
+### Configuration
 
-You can tweak more detailed settings by uncommenting and setting the variables
-in `/etc/conduwuit/conduwuit.toml`. This involves settings such as the maximum
-file size for download/upload, enabling federation, etc.
+When installed, the example config is placed at `/etc/conduwuit/conduwuit.toml`
+as the default config. The config mentions things required to be changed before
+starting.
 
-Running
--------
+You can tweak more detailed settings by uncommenting and setting the config
+options in `/etc/conduwuit/conduwuit.toml`.
 
-The package uses the `conduwuit.service` systemd unit file to start and
-stop conduwuit. It loads the configuration file mentioned above to set up the
-environment before running the server.
+### Running
 
-This package assumes by default that conduwuit will be placed behind a reverse
-proxy. This default deployment entails just listening
-on `127.0.0.1` and the free port `6167` and is reachable via a client using the URL
-<http://localhost:6167>. Matrix federation requires TLS, so you will need to set up
-some certificates and renewal, for it to work properly.
+The package uses the [`conduwuit.service`](../configuration/examples.md#example-systemd-unit-file) systemd unit file to start and stop conduwuit. The binary is installed at `/usr/sbin/conduwuit`.
+
+This package assumes by default that conduwuit will be placed behind a reverse proxy. The default config options apply (listening on `localhost` and TCP port `6167`). Matrix federation requires a valid domain name and TLS, so you will need to set up TLS certificates and renewal for it to work properly if you intend to federate.
+
+Consult various online documentation and guides on setting up a reverse proxy and TLS. Caddy is documented at the [generic deployment guide](../deploying/generic.md#setting-up-the-reverse-proxy) as it's the easiest and most user friendly.

debian/conduwuit.service

@@ -1,13 +1,20 @@
 [Unit]
 Description=conduwuit Matrix homeserver
+Documentation=https://conduwuit.puppyirl.gay/
 After=network-online.target
 
 [Service]
 DynamicUser=yes
-User=_conduwuit
-Group=_conduwuit
+User=conduwuit
+Group=conduwuit
 Type=notify
 
+Environment="CONDUWUIT_CONFIG=/etc/conduwuit/conduwuit.toml"
+
+ExecStart=/usr/sbin/conduwuit
+
+ReadWritePaths=/var/lib/conduwuit /etc/conduwuit
+
 AmbientCapabilities=
 CapabilityBoundingSet=
 
@@ -15,7 +22,7 @@ DevicePolicy=closed
 LockPersonality=yes
 MemoryDenyWriteExecute=yes
 NoNewPrivileges=yes
-ProcSubset=pid
+#ProcSubset=pid
 ProtectClock=yes
 ProtectControlGroups=yes
 ProtectHome=yes
@@ -39,19 +46,16 @@ SystemCallArchitectures=native
 SystemCallFilter=@system-service @resources
 SystemCallFilter=~@clock @debug @module @mount @reboot @swap @cpu-emulation @obsolete @timer @chown @setuid @privileged @keyring @ipc
 SystemCallErrorNumber=EPERM
-StateDirectory=matrix-conduit
+#StateDirectory=conduwuit
 
-RuntimeDirectory=conduit
+RuntimeDirectory=conduwuit
 RuntimeDirectoryMode=0750
 
-Environment="CONDUIT_CONFIG=/etc/conduwuit/conduwuit.toml"
-
-ExecStart=/usr/sbin/conduwuit
 Restart=on-failure
 RestartSec=5
 
-TimeoutStopSec=4m
-TimeoutStartSec=4m
+TimeoutStopSec=2m
+TimeoutStartSec=2m
 
 StartLimitInterval=1m
 StartLimitBurst=5

debian/config

@@ -1,17 +1,18 @@
 #!/bin/sh
 set -e
 
+# TODO: implement debconf support that is maintainable without duplicating the config
 # Source debconf library.
-. /usr/share/debconf/confmodule
-
-# Ask for the Matrix homeserver name, address and port.
-db_input high conduwuit/hostname || true
-db_go
-
-db_input low conduwuit/address || true
-db_go
-
-db_input medium conduwuit/port || true
-db_go
+#. /usr/share/debconf/confmodule
+#
+## Ask for the Matrix homeserver name, address and port.
+#db_input high conduwuit/hostname || true
+#db_go
+#
+#db_input low conduwuit/address || true
+#db_go
+#
+#db_input medium conduwuit/port || true
+#db_go
 
 exit 0

debian/postinst

@@ -1,28 +1,43 @@
 #!/bin/sh
 set -e
 
-. /usr/share/debconf/confmodule
+# TODO: implement debconf support that is maintainable without duplicating the config
+#. /usr/share/debconf/confmodule
 
-CONDUWUIT_DATABASE_PATH=/var/lib/conduwuit/
+CONDUWUIT_DATABASE_PATH=/var/lib/conduwuit
+CONDUWUIT_CONFIG_PATH=/etc/conduwuit
 
 case "$1" in
   configure)
-    # Create the `_conduwuit` user if it does not exist yet.
-    if ! getent passwd _conduwuit > /dev/null ; then
+    # Create the `conduwuit` user if it does not exist yet.
+    if ! getent passwd conduwuit > /dev/null ; then
       echo 'Adding system user for the conduwuit Matrix homeserver' 1>&2
       adduser --system --group --quiet \
         --home "$CONDUWUIT_DATABASE_PATH" \
         --disabled-login \
         --shell "/usr/sbin/nologin" \
-        --force-badname \
-        _conduwuit
+        conduwuit
     fi
 
     # Create the database path if it does not exist yet and fix up ownership
-    # and permissions.
-    mkdir -p "$CONDUWUIT_DATABASE_PATH"
-    chown _conduwuit:_conduwuit -R "$CONDUWUIT_DATABASE_PATH"
-    chmod 700 "$CONDUWUIT_DATABASE_PATH"
+    # and permissions for the config.
+    mkdir -v -p "$CONDUWUIT_DATABASE_PATH"
+
+    # symlink the previous location for compatibility if it does not exist yet.
+    if ! test -L "/var/lib/matrix-conduit" ; then
+        ln -s -v "$CONDUWUIT_DATABASE_PATH" "/var/lib/matrix-conduit"
+    fi
+
+    chown -v conduwuit:conduwuit -R "$CONDUWUIT_DATABASE_PATH"
+    chown -v conduwuit:conduwuit -R "$CONDUWUIT_CONFIG_PATH"
+
+    chmod -v 740 "$CONDUWUIT_DATABASE_PATH"
+
+    echo ''
+    echo 'Make sure you edit the example config at /etc/conduwuit/conduwuit.toml before starting!'
+    echo 'To start the server, run: systemctl start conduwuit.service'
+    echo ''
+
     ;;
 esac
 

debian/postrm

@@ -1,10 +1,11 @@
 #!/bin/sh
 set -e
 
-. /usr/share/debconf/confmodule
+#. /usr/share/debconf/confmodule
 
 CONDUWUIT_CONFIG_PATH=/etc/conduwuit
 CONDUWUIT_DATABASE_PATH=/var/lib/conduwuit
+CONDUWUIT_DATABASE_PATH_SYMLINK=/var/lib/matrix-conduit
 
 case $1 in
   purge)
@@ -15,11 +16,15 @@ case $1 in
     # "configuration files must be preserved when the package is removed, and
     #  only deleted when the package is purged."
     if [ -d "$CONDUWUIT_CONFIG_PATH" ]; then
-      rm -r "$CONDUWUIT_CONFIG_PATH"
+      rm -v -r "$CONDUWUIT_CONFIG_PATH"
     fi
 
     if [ -d "$CONDUWUIT_DATABASE_PATH" ]; then
-      rm -r "$CONDUWUIT_DATABASE_PATH"
+      rm -v -r "$CONDUWUIT_DATABASE_PATH"
+    fi
+
+    if [ -d "$CONDUWUIT_DATABASE_PATH_SYMLINK" ]; then
+      rm -v -r "$CONDUWUIT_DATABASE_PATH_SYMLINK"
     fi
     ;;
 esac

debian/templates

@@ -1,21 +0,0 @@
-Template: conduwuit/hostname
-Type: string
-Default: localhost
-Description: The server (host)name of the Matrix homeserver
- This is the hostname the homeserver will be reachable at via a client.
- .
- If set to "localhost", you can connect with a client locally and clients
- from other hosts and also other homeservers will not be able to reach you!
-
-Template: conduwuit/address
-Type: string
-Default: 127.0.0.1
-Description: The listen address of the Matrix homeserver
- This is the address the homeserver will listen on. Leave it set to 127.0.0.1
- when using a reverse proxy.
-
-Template: conduwuit/port
-Type: string
-Default: 6167
-Description: The port of the Matrix homeserver
- This port is most often just accessed by a reverse proxy.

deps/rust-rocksdb/Cargo.toml

@@ -0,0 +1,42 @@
+[package]
+name = "rust-rocksdb-uwu"
+categories.workspace = true
+description = "dylib wrapper for rust-rocksdb"
+edition = "2021"
+keywords.workspace = true
+license.workspace = true
+readme.workspace = true
+repository.workspace = true
+version = "0.0.1"
+
+[features]
+default = ["lz4", "zstd", "zlib", "bzip2"]
+jemalloc = ["rust-rocksdb/jemalloc"]
+io-uring = ["rust-rocksdb/io-uring"]
+valgrind = ["rust-rocksdb/valgrind"]
+snappy = ["rust-rocksdb/snappy"]
+lz4 = ["rust-rocksdb/lz4"]
+zstd = ["rust-rocksdb/zstd"]
+zlib = ["rust-rocksdb/zlib"]
+bzip2 = ["rust-rocksdb/bzip2"]
+rtti = ["rust-rocksdb/rtti"]
+mt_static = ["rust-rocksdb/mt_static"]
+multi-threaded-cf = ["rust-rocksdb/multi-threaded-cf"]
+serde1 = ["rust-rocksdb/serde1"]
+malloc-usable-size = ["rust-rocksdb/malloc-usable-size"]
+
+[dependencies.rust-rocksdb]
+git = "https://github.com/girlbossceo/rust-rocksdb-zaidoon1"
+rev = "4bce1bb97d8be6f0d47245c99d465ca9cef33aad"
+#branch = "master"
+default-features = false
+
+[lib]
+path = "lib.rs"
+crate-type = [
+	"rlib",
+#	"dylib"
+]
+
+[lints]
+workspace = true

deps/rust-rocksdb/lib.rs

@@ -0,0 +1,61 @@
+pub use rust_rocksdb::*;
+
+#[cfg_attr(not(conduit_mods), link(name = "rocksdb"))]
+#[cfg_attr(conduit_mods, link(name = "rocksdb", kind = "static"))]
+extern "C" {
+	pub fn rocksdb_list_column_families();
+	pub fn rocksdb_logger_create_stderr_logger();
+	pub fn rocksdb_options_set_info_log();
+	pub fn rocksdb_get_options_from_string();
+	pub fn rocksdb_writebatch_create();
+	pub fn rocksdb_writebatch_destroy();
+	pub fn rocksdb_writebatch_put_cf();
+	pub fn rocksdb_writebatch_delete_cf();
+	pub fn rocksdb_iter_value();
+	pub fn rocksdb_iter_seek_to_last();
+	pub fn rocksdb_iter_seek_for_prev();
+	pub fn rocksdb_iter_seek_to_first();
+	pub fn rocksdb_iter_next();
+	pub fn rocksdb_iter_prev();
+	pub fn rocksdb_iter_seek();
+	pub fn rocksdb_iter_valid();
+	pub fn rocksdb_iter_get_error();
+	pub fn rocksdb_iter_key();
+	pub fn rocksdb_iter_destroy();
+	pub fn rocksdb_livefiles();
+	pub fn rocksdb_livefiles_count();
+	pub fn rocksdb_livefiles_destroy();
+	pub fn rocksdb_livefiles_column_family_name();
+	pub fn rocksdb_livefiles_name();
+	pub fn rocksdb_livefiles_size();
+	pub fn rocksdb_livefiles_level();
+	pub fn rocksdb_livefiles_smallestkey();
+	pub fn rocksdb_livefiles_largestkey();
+	pub fn rocksdb_livefiles_entries();
+	pub fn rocksdb_livefiles_deletions();
+	pub fn rocksdb_put_cf();
+	pub fn rocksdb_delete_cf();
+	pub fn rocksdb_get_pinned_cf();
+	pub fn rocksdb_create_column_family();
+	pub fn rocksdb_get_latest_sequence_number();
+	pub fn rocksdb_batched_multi_get_cf();
+	pub fn rocksdb_cancel_all_background_work();
+	pub fn rocksdb_repair_db();
+	pub fn rocksdb_list_column_families_destroy();
+	pub fn rocksdb_flush();
+	pub fn rocksdb_flush_wal();
+	pub fn rocksdb_open_column_families();
+	pub fn rocksdb_open_for_read_only_column_families();
+	pub fn rocksdb_open_as_secondary_column_families();
+	pub fn rocksdb_open_column_families_with_ttl();
+	pub fn rocksdb_open();
+	pub fn rocksdb_open_for_read_only();
+	pub fn rocksdb_open_with_ttl();
+	pub fn rocksdb_open_as_secondary();
+	pub fn rocksdb_write();
+	pub fn rocksdb_create_iterator_cf();
+	pub fn rocksdb_backup_engine_create_new_backup_flush();
+	pub fn rocksdb_backup_engine_options_create();
+	pub fn rocksdb_write_buffer_manager_destroy();
+	pub fn rocksdb_options_set_ttl();
+}

development.md

@@ -0,0 +1 @@
+docs/development.md

docs/SUMMARY.md

@@ -2,14 +2,22 @@ # Summary
 
 - [Introduction](introduction.md)
 - [Differences from upstream Conduit](differences.md)
-
-- [Example configuration](configuration.md)
+- [Configuration](configuration.md)
+  - [Examples](configuration/examples.md)
 - [Deploying](deploying.md)
-    - [Generic](deploying/generic.md)
-    - [Debian](deploying/debian.md)
-    - [Docker](deploying/docker.md)
-    - [NixOS](deploying/nixos.md)
+  - [Generic](deploying/generic.md)
+  - [NixOS](deploying/nixos.md)
+  - [Docker](deploying/docker.md)
+  - [Kubernetes](deploying/kubernetes.md)
+  - [Arch Linux](deploying/arch-linux.md)
+  - [Debian](deploying/debian.md)
+  - [FreeBSD](deploying/freebsd.md)
 - [TURN](turn.md)
 - [Appservices](appservices.md)
+- [Maintenance](maintenance.md)
+- [Troubleshooting](troubleshooting.md)
 - [Development](development.md)
-    - [Testing](development/testing.md)
+  - [Contributing](contributing.md)
+  - [Testing](development/testing.md)
+  - [Hot Reloading ("Live" Development)](development/hot_reload.md)
+- [conduwuit Community Code of Conduct](conduwuit_coc.md)

docs/appservices.md

@@ -2,23 +2,25 @@ # Setting up Appservices
 
 ## 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
-homeserver.yaml, but in Conduit you can do this from within Matrix:
+homeserver.yaml, but in conduwuit you can do this from within Matrix:
 
-First, go into the #admins room of your homeserver. The first person that
+First, go into the `#admins` room of your homeserver. The first person that
 registered on the homeserver automatically joins it. Then send a message into
 the room like this:
 
-    @conduit:your.server.name: register-appservice
+    !admin appservices register
     ```
     paste
     the
@@ -31,13 +33,13 @@ ## Set up the appservice - general instructions
     ```
 
 You can confirm it worked by sending a message like this:
-`@conduit:your.server.name: appservices list`
+`!admin appservices list`
 
-The `@conduit` bot should answer with `Appservices (1): your-bridge`
+The server bot should answer with `Appservices (1): your-bridge`
 
-Then you are done. Conduit will send messages to the appservices and the
+Then you are done. conduwuit will send messages to the appservices and the
 appservice can send requests to the homeserver. You don't need to restart
-Conduit, but if it doesn't work, restarting while the appservice is running
+conduwuit, but if it doesn't work, restarting while the appservice is running
 could help.
 
 ## Appservice-specific instructions
@@ -46,16 +48,6 @@ ### Remove an appservice
 
 To remove an appservice go to your admin room and execute
 
-`@conduit:your.server.name: appservices unregister <name>`
+`!admin appservices unregister <name>`
 
 where `<name>` one of the output of `appservices list`.
-
-### Tested appservices
-
-These appservices have been tested and work with Conduit without any extra steps:
-
-- [matrix-appservice-discord](https://github.com/Half-Shot/matrix-appservice-discord)
-- [mautrix-hangouts](https://github.com/mautrix/hangouts/)
-- [mautrix-telegram](https://github.com/mautrix/telegram/)
-- [mautrix-signal](https://github.com/mautrix/signal/) from version `0.2.2` forward.
-- [heisenbridge](https://github.com/hifi/heisenbridge/)

docs/conduwuit_coc.md

@@ -0,0 +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.
+
+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).
+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.
+
+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.
+
+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.
+
+## Matrix Community
+
+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.
+
+### [#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.
+
+### [#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.
+
+## 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:
+
+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.
+
+Together, let’s build a community where everyone feels valued and respected.
+
+— The conduwuit Moderation Team

docs/configuration.md

@@ -1,5 +1,64 @@
-# Example configuration
+# Configuration
 
-``` toml
-{{#include ../conduwuit-example.toml}}
+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.
+
+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.
+
+## 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\"`.
+
+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_`.
+
+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`
+
+Conduit's environment variables are supported for backwards compatibility (e.g.
+`CONDUIT_SERVER_NAME`).

docs/configuration/examples.md

@@ -0,0 +1,32 @@
+## Example configuration
+
+<details>
+<summary>Example configuration</summary>
+
+```toml
+{{#include ../../conduwuit-example.toml}}
+```
+
+</details>
+
+## Debian systemd unit file
+
+<details>
+<summary>Debian systemd unit file</summary>
+
+```
+{{#include ../../debian/conduwuit.service}}
+```
+
+</details>
+
+## Arch Linux systemd unit file
+
+<details>
+<summary>Arch Linux systemd unit file</summary>
+
+```
+{{#include ../../arch/conduwuit.service}}
+```
+
+</details>

docs/contributing.md

@@ -0,0 +1 @@
+../CONTRIBUTING.md

docs/deploying.md

@@ -1,3 +1,3 @@
 # Deploying
 
-This chapter describes various ways to deploy Conduwuit.
+This chapter describes various ways to deploy conduwuit.

docs/deploying/arch-linux.md

@@ -0,0 +1,15 @@
+# conduwuit for Arch Linux
+
+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.
+
+- [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

docs/deploying/docker-compose.for-traefik.yml

@@ -1,54 +1,46 @@
-# Conduit - Behind Traefik Reverse Proxy
-version: '2.4' # uses '2.4' for cpuset
+# conduwuit - Behind Traefik Reverse Proxy
 
 services:
-    homeserver:
-        ### If you already built the Conduit image with 'docker build' or want to use the Docker Hub image,
-        ### then you are ready to go.
-        image: girlbossceo/conduwuit:latest
-        ### If you want to build a fresh image from the sources, then comment the image line and uncomment the
-        ### build lines. If you want meaningful labels in your built Conduit image, you should run docker compose like this:
-        ### CREATED=$(date -u +'%Y-%m-%dT%H:%M:%SZ') VERSION=$(grep -m1 -o '[0-9].[0-9].[0-9]' Cargo.toml) docker compose up -d
-        # build:
-        #     context: .
-        #     args:
-        #         CREATED: '2021-03-16T08:18:27Z'
-        #         VERSION: '0.1.0'
-        #         LOCAL: 'false'
-        #         GIT_REF: origin/master
-        restart: unless-stopped
-        volumes:
-            - db:/var/lib/matrix-conduit
-            #- ./conduwuit.toml:/etc/conduit.toml
-        networks:
-            - proxy
-        environment:
-            CONDUIT_SERVER_NAME: your.server.name # EDIT THIS
-            CONDUIT_DATABASE_PATH: /var/lib/matrix-conduit
-            CONDUIT_DATABASE_BACKEND: rocksdb
-            CONDUIT_PORT: 6167
-            CONDUIT_MAX_REQUEST_SIZE: 20_000_000 # in bytes, ~20 MB
-            CONDUIT_ALLOW_REGISTRATION: 'true'
-            CONDUIT_ALLOW_FEDERATION: 'true'
-            CONDUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
-            CONDUIT_TRUSTED_SERVERS: '["matrix.org"]'
-            #CONDUIT_LOG: warn,state_res=warn
-            CONDUIT_ADDRESS: 0.0.0.0
-            #CONDUIT_CONFIG: './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_PORT: 6167 # should match the loadbalancer traefik label
+      CONDUWUIT_MAX_REQUEST_SIZE: 20000000 # 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 Conduit
+    ###       Domain or Subdomain for the communication between Element and conduwuit
     ### Config-Docs: https://github.com/vector-im/element-web/blob/develop/docs/config.md
     # element-web:
     #     image: vectorim/element-web:latest
@@ -61,10 +53,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

docs/deploying/docker-compose.override.yml

@@ -1,45 +1,37 @@
-# Conduit - Traefik Reverse Proxy Labels
-version: '2.4' # uses '2.4' for cpuset
+# 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-conduit.rule=Host(`<SUBDOMAIN>.<DOMAIN>`)"  # Change to the address on which Conduit is hosted
-            - "traefik.http.routers.to-conduit.tls=true"
-            - "traefik.http.routers.to-conduit.tls.certresolver=letsencrypt"
-            - "traefik.http.routers.to-conduit.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"

docs/deploying/docker-compose.with-caddy.yml

@@ -0,0 +1,53 @@
+services:
+    caddy:
+    # This compose file uses caddy-docker-proxy as the reverse proxy for conduwuit!
+    # For more info, visit https://github.com/lucaslorentz/caddy-docker-proxy
+        image: lucaslorentz/caddy-docker-proxy:ci-alpine
+        ports:
+            - 80:80
+            - 443:443
+        environment:
+            - CADDY_INGRESS_NETWORKS=caddy
+        networks:
+            - caddy
+        volumes:
+            - /var/run/docker.sock:/var/run/docker.sock
+            - ./data:/data
+        restart: unless-stopped
+        labels:
+            caddy: example.com
+            caddy.0_respond: /.well-known/matrix/server {"m.server":"matrix.example.com:443"}
+            caddy.1_respond: /.well-known/matrix/client {"m.server":{"base_url":"https://matrix.example.com"},"m.homeserver":{"base_url":"https://matrix.example.com"},"org.matrix.msc3575.proxy":{"url":"https://matrix.example.com"}}
+
+    homeserver:
+        ### If you already built the conduwuit image with 'docker build' or want to use a registry image,
+        ### then you are ready to go.
+        image: girlbossceo/conduwuit:latest
+        restart: unless-stopped
+        volumes:
+            - db:/var/lib/conduwuit
+            #- ./conduwuit.toml:/etc/conduwuit.toml
+        environment:
+            CONDUWUIT_SERVER_NAME: example.com # EDIT THIS
+            CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit
+            CONDUWUIT_PORT: 6167
+            CONDUWUIT_MAX_REQUEST_SIZE: 20000000 # 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
+        networks:
+            - caddy
+        labels:
+            caddy: matrix.example.com
+            caddy.reverse_proxy: "{{upstreams 6167}}"
+
+volumes:
+    db:
+
+networks:
+    caddy:
+        external: true

docs/deploying/docker-compose.with-traefik.yml

@@ -1,59 +1,56 @@
-# Conduit - Behind Traefik Reverse Proxy
-version: '2.4' # uses '2.4' for cpuset
+# conduwuit - Behind Traefik Reverse Proxy
 
 services:
-    homeserver:
-        ### If you already built the Conduit image with 'docker build' or want to use the Docker Hub image,
-        ### then you are ready to go.
-        image: girlbossceo/conduwuit:latest
-        ### If you want to build a fresh image from the sources, then comment the image line and uncomment the
-        ### build lines. If you want meaningful labels in your built Conduit image, you should run docker compose like this:
-        ### CREATED=$(date -u +'%Y-%m-%dT%H:%M:%SZ') VERSION=$(grep -m1 -o '[0-9].[0-9].[0-9]' Cargo.toml) docker compose up -d
-        # build:
-        #     context: .
-        #     args:
-        #         CREATED: '2021-03-16T08:18:27Z'
-        #         VERSION: '0.1.0'
-        #         LOCAL: 'false'
-        #         GIT_REF: origin/master
-        restart: unless-stopped
-        volumes:
-            - db:/srv/conduit/.local/share/conduit
-            #- ./conduwuit.toml:/etc/conduit.toml
-        networks:
-            - proxy
-        environment:
-            CONDUIT_SERVER_NAME: your.server.name # EDIT THIS
-            CONDUIT_TRUSTED_SERVERS: '["matrix.org"]'
-            CONDUIT_ALLOW_REGISTRATION : 'true'
-            #CONDUIT_CONFIG: './conduwuit.toml' # Uncomment if you mapped config toml above
-            ### Uncomment and change values as desired
-            # CONDUIT_ADDRESS: 0.0.0.0
-            # CONDUIT_PORT: 6167
-            # Available levels are: error, warn, info, debug, trace - more info at: https://docs.rs/env_logger/*/env_logger/#enabling-logging
-            # CONDUIT_LOG: info  # default is: "warn,state_res=warn"
-            # CONDUIT_ALLOW_JAEGER: 'false'
-            # CONDUIT_ALLOW_ENCRYPTION: 'true'
-            # CONDUIT_ALLOW_FEDERATION: 'true'
-            # CONDUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
-            # CONDUIT_DATABASE_PATH: /srv/conduit/.local/share/conduit
-            # CONDUIT_WORKERS: 10
-            # CONDUIT_MAX_REQUEST_SIZE: 20_000_000  # in bytes, ~20 MB
-        #cpuset: "0-4" # Uncomment to limit to specific CPU cores
+  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_REGISTRATION_TOKEN_FILE: "" # Alternatively you can configure a path to a token file to read
+      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_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: 20000000  # 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
-    ###       Domain or Subdomain for the communication between Element and Conduit
+    ###       Domain or Subdomain for the communication between Element and conduwuit
     ### Config-Docs: https://github.com/vector-im/element-web/blob/develop/docs/config.md
     # element-web:
     #     image: vectorim/element-web:latest
@@ -65,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:
@@ -95,3 +142,5 @@ volumes:
 
 networks:
     proxy:
+
+# vim: ts=2:sw=2:expandtab

docs/deploying/docker-compose.yml

@@ -1,45 +1,32 @@
-# Conduit
-version: '2.4' # uses '2.4' for cpuset
+# conduwuit
 
 services:
     homeserver:
-        ### If you already built the Conduit image with 'docker build' or want to use a registry image,
+        ### If you already built the conduwuit image with 'docker build' or want to use a registry image,
         ### then you are ready to go.
         image: girlbossceo/conduwuit:latest
-        ### If you want to build a fresh image from the sources, then comment the image line and uncomment the
-        ### build lines. If you want meaningful labels in your built Conduit image, you should run docker compose like this:
-        ### CREATED=$(date -u +'%Y-%m-%dT%H:%M:%SZ') VERSION=$(grep -m1 -o '[0-9].[0-9].[0-9]' Cargo.toml) docker compose up -d
-        # build:
-        #     context: .
-        #     args:
-        #         CREATED: '2021-03-16T08:18:27Z'
-        #         VERSION: '0.1.0'
-        #         LOCAL: 'false'
-        #         GIT_REF: origin/master
         restart: unless-stopped
         ports:
             - 8448:6167
         volumes:
-            - db:/var/lib/matrix-conduit
-            #- ./conduwuit.toml:/etc/conduit.toml
+            - db:/var/lib/conduwuit
+            #- ./conduwuit.toml:/etc/conduwuit.toml
         environment:
-            CONDUIT_SERVER_NAME: your.server.name # EDIT THIS
-            CONDUIT_DATABASE_PATH: /var/lib/matrix-conduit
-            CONDUIT_DATABASE_BACKEND: rocksdb
-            CONDUIT_PORT: 6167
-            CONDUIT_MAX_REQUEST_SIZE: 20_000_000 # in bytes, ~20 MB
-            CONDUIT_ALLOW_REGISTRATION: 'true'
-            CONDUIT_ALLOW_FEDERATION: 'true'
-            CONDUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
-            CONDUIT_TRUSTED_SERVERS: '["matrix.org"]'
-            #CONDUIT_LOG: warn,state_res=warn
-            CONDUIT_ADDRESS: 0.0.0.0
-            #CONDUIT_CONFIG: './conduwuit.toml' # Uncomment if you mapped config toml above
-        #cpuset: "0-4" # Uncomment to limit to specific CPU cores
+            CONDUWUIT_SERVER_NAME: your.server.name # EDIT THIS
+            CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit
+            CONDUWUIT_PORT: 6167
+            CONDUWUIT_MAX_REQUEST_SIZE: 20000000 # 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
     #
     ### 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 Conduit
+    ###       Domain or Subdomain for the communication between Element and conduwuit
     ### Config-Docs: https://github.com/vector-im/element-web/blob/develop/docs/config.md
     # element-web:
     #     image: vectorim/element-web:latest

docs/deploying/docker.md

@@ -2,8 +2,8 @@ # conduwuit for Docker
 
 ## 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
 
@@ -11,31 +11,26 @@ ### Use a registry
 
 | Registry        | Image                                                           | Size                          | Notes                  |
 | --------------- | --------------------------------------------------------------- | ----------------------------- | ---------------------- |
-| GitHub Registry | [ghcr.io/girlbossceo/conduwuit:latest][gh] | ![Image Size][shield-latest]  | Stable tagged image.          |
-| GitLab Registry | [registry.gitlab.com/girlbossceo/conduwuit:latest][gl] | ![Image Size][shield-latest]  | Stable tagged image.          |
-| Docker Hub      | [docker.io/girlbossceo/conduwuit:latest][dh]             | ![Image Size][shield-latest]  | Stable tagged image.          |
+| GitHub Registry | [ghcr.io/girlbossceo/conduwuit:latest][gh] | ![Image Size][shield-latest]  | Stable latest tagged image.          |
+| GitLab Registry | [registry.gitlab.com/conduwuit/conduwuit:latest][gl] | ![Image Size][shield-latest]  | Stable latest tagged image.          |
+| Docker Hub      | [docker.io/girlbossceo/conduwuit:latest][dh]             | ![Image Size][shield-latest]  | Stable latest tagged image.          |
 | GitHub Registry | [ghcr.io/girlbossceo/conduwuit:main][gh]   | ![Image Size][shield-main]    | Stable main branch.   |
-| GitLab Registry | [registry.gitlab.com/girlbossceo/conduwuit:main][gl]   | ![Image Size][shield-main]    | Stable main branch.   |
+| GitLab Registry | [registry.gitlab.com/conduwuit/conduwuit:main][gl]   | ![Image Size][shield-main]    | Stable main branch.   |
 | Docker Hub      | [docker.io/girlbossceo/conduwuit:main][dh]               | ![Image Size][shield-main]    | Stable main branch.   |
-| GitHub Registry | [ghcr.io/girlbossceo/conduwuit:dev][gh]   | ![Image Size][shield-dev]    | Development version/branch.   |
-| GitLab Registry | [registry.gitlab.com/girlbossceo/conduwuit:dev][gl]   | ![Image Size][shield-dev]    | Development version/branch.   |
-| Docker Hub      | [docker.io/girlbossceo/conduwuit:dev][dh]               | ![Image Size][shield-dev]    | Development version/branch.   |
 
-
-[dh]: https://hub.docker.com/repository/docker/girlbossceo/conduwuit
+[dh]: https://hub.docker.com/r/girlbossceo/conduwuit
 [gh]: https://github.com/girlbossceo/conduwuit/pkgs/container/conduwuit
-[gl]: https://gitlab.com/girlbossceo/conduwuit/container_registry/6351657
+[gl]: https://gitlab.com/conduwuit/conduwuit/container_registry/6369729
 [shield-latest]: https://img.shields.io/docker/image-size/girlbossceo/conduwuit/latest
 [shield-main]: https://img.shields.io/docker/image-size/girlbossceo/conduwuit/main
-[shield-dev]: https://img.shields.io/docker/image-size/girlbossceo/conduwuit/dev
-
 
 Use
-```bash
-docker image pull <link>
-```
-to pull it to your machine.
 
+```bash
+docker image pull $LINK
+```
+
+to pull it to your machine.
 
 ### Run
 
@@ -43,53 +38,88 @@ ### Run
 
 ```bash
 docker run -d -p 8448:6167 \
-  -v db:/var/lib/conduwuit/ \
-  -e CONDUIT_SERVER_NAME="your.server.name" \
-  -e CONDUIT_DATABASE_BACKEND="rocksdb" \
-  -e CONDUIT_ALLOW_REGISTRATION=false \
-  -e CONDUIT_ALLOW_FEDERATION=true \
-  -e CONDUIT_MAX_REQUEST_SIZE="40000000" \
-  -e CONDUIT_TRUSTED_SERVERS="[\"matrix.org\"]" \
-  -e CONDUIT_LOG="warn,ruma_state_res=warn" \
-  --name conduit <link>
+    -v db:/var/lib/conduwuit/ \
+    -e CONDUWUIT_SERVER_NAME="your.server.name" \
+    -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, an example can be found [here](../configuration.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` 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 (or any other reverse proxy), use [`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)
+
+- 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:
+
+```bash
+docker network create caddy
+```
+
+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:
+Official conduwuit images are built using Nix's
+[`buildLayeredImage`][nix-buildlayeredimage]. This ensures all OCI images are
+repeatable and reproducible by anyone, keeps the images lightweight, and can be
+built offline.
 
-```bash
-docker compose up
-```
+This also ensures portability of our images because `buildLayeredImage` builds
+OCI images, not Docker images, and works with other container software.
 
-This will also start the container right afterwards, so if want it to run in detached mode, you also should use the `-d` flag.
+The OCI images are OS-less with only a very minimal environment of the `tini`
+init system, CA certificates, and the conduwuit binary. This does mean there is
+not a shell, but in theory you can get a shell by adding the necessary layers
+to the layered image. However it's very unlikely you will need a shell for any
+real troubleshooting.
+
+The flake file for the OCI image definition is at [`nix/pkgs/oci-image/default.nix`][oci-image-def].
+
+To build an OCI image using Nix, the following outputs can be built:
+- `nix build -L .#oci-image` (default features, x86_64 glibc)
+- `nix build -L .#oci-image-x86_64-linux-musl` (default features, x86_64 musl)
+- `nix build -L .#oci-image-aarch64-linux-musl` (default features, aarch64 musl)
+- `nix build -L .#oci-image-x86_64-linux-musl-all-features` (all features, x86_64 musl)
+- `nix build -L .#oci-image-aarch64-linux-musl-all-features` (all features, aarch64 musl)
 
 ### 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,105 +129,25 @@ ### Run
 
 ### 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`.
-
-With the service `well-known` we use a single `nginx` container that will serve those two files.
-
-So...step by step:
-
-1. Copy [`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) from the repository and remove `.for-traefik` (or `.with-traefik`) from the filename.
-2. Open both files and modify/adjust them to your needs. Meaning, change the `CONDUIT_SERVER_NAME` and the volume host mappings according to your needs.
-3. Create the `conduwuit.toml` config file, an example can be found [here](../configuration.md), or set `CONDUIT_CONFIG=""` and configure conduwuit per env vars.
-4. Uncomment the `element-web` service if you want to host your own Element Web Client and create a `element_config.json`.
-5. Create the files needed by the `well-known` service.
-
-   - `./nginx/matrix.conf` (relative to the compose file, you can change this, but then also need to change the volume mapping)
-
-     ```nginx
-     server {
-         server_name <SUBDOMAIN>.<DOMAIN>;
-         listen      80 default_server;
-
-         location /.well-known/matrix/server {
-            return 200 '{"m.server": "<SUBDOMAIN>.<DOMAIN>:443"}';
-            types { } default_type "application/json; charset=utf-8";
-         }
-
-        location /.well-known/matrix/client {
-            return 200 '{"m.homeserver": {"base_url": "https://<SUBDOMAIN>.<DOMAIN>"}}';
-            types { } default_type "application/json; charset=utf-8";
-            add_header "Access-Control-Allow-Origin" *;
-        }
-
-        location / {
-            return 404;
-        }
-     }
-     ```
-
-6. Run `docker compose up -d`
-7. Connect to your homeserver with your preferred client and create a user. You should do this immediately after starting Conduit, because the first created user is the admin.
-
-
+[`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.
 
 ## Voice communication
 
-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. Before proceeding with the software installation, it is essential to have the necessary configurations in place.
+See the [TURN](../turn.md) page.
 
-### Configuration
-
-Create a configuration file called `coturn.conf` containing:
-
-```conf
-use-auth-secret
-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`.
-
-These same values need to be set in conduwuit. You can either modify conduwuit.toml to include these lines:
-```
-turn_uris = ["turn:<your server domain>?transport=udp", "turn:<your server domain>?transport=tcp"]
-turn_secret = "<secret key from coturn configuration>"
-```
-or append the following to the docker environment variables dependig on which configuration method you used earlier:
-```yml
-CONDUIT_TURN_URIS: '["turn:<your server domain>?transport=udp", "turn:<your server domain>?transport=tcp"]'
-CONDUIT_TURN_SECRET: "<secret key from coturn configuration>"
-```
-Restart Conduit to apply these changes.
-
-### 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
-```
-
-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
-services:
-    turn:
-      container_name: coturn-server
-      image: docker.io/coturn/coturn
-      restart: unless-stopped
-      network_mode: "host"
-      volumes:
-        - ./coturn.conf:/etc/coturn/turnserver.conf
-```
-
-To understand why the host networking mode is used and explore alternative configuration options, please visit the following link: https://github.com/coturn/coturn/blob/master/docker/coturn/README.md.
-For security recommendations see Synapse's [Coturn documentation](https://github.com/matrix-org/synapse/blob/develop/docs/setup/turn/coturn.md#configuration).
+[nix-buildlayeredimage]: https://ryantm.github.io/nixpkgs/builders/images/dockertools/#ssec-pkgs-dockerTools-buildLayeredImage
+[oci-image-def]: https://github.com/girlbossceo/conduwuit/blob/main/nix/pkgs/oci-image/default.nix

docs/deploying/freebsd.md

@@ -0,0 +1,5 @@
+# conduwuit for FreeBSD
+
+conduwuit at the moment does not provide FreeBSD builds or have FreeBSD packaging, however conduwuit does build and work on FreeBSD using the system-provided RocksDB.
+
+Contributions for getting conduwuit packaged are welcome.

docs/deploying/generic.md

@@ -1,95 +1,118 @@
 # Generic deployment documentation
 
-### Please note that this documentation is not fully representative of conduwuit at the moment. Assume majority of it is outdated.
-
 > ## 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 binaries can be downloaded from the latest tagged release [here](https://github.com/girlbossceo/conduwuit/releases/latest).
+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/Ubuntu packages.
 
-Alternatively, you may compile the binary yourself. First, install any dependencies:
+These binaries have jemalloc and io_uring statically linked and included with
+them, so no additional dynamic dependencies need to be installed.
 
-```bash
-# Debian
-$ sudo apt install libclang-dev build-essential
+Alternatively, you may compile the binary yourself. We recommend using
+Nix (or [Lix](https://lix.systems)) to build conduwuit as this has the most guaranteed
+reproducibiltiy and easiest to get a build environment and output going. This also
+allows easy cross-compilation.
 
-# RHEL
-$ sudo dnf install clang
-```
-Then, `cd` into the source tree of conduwuit and run:
-```bash
-$ cargo build --release
-```
+You can run the `nix build -L .#static-x86_64-linux-musl-all-features` or
+`nix build -L .#static-aarch64-linux-musl-all-features` commands based
+on architecture to cross-compile the necessary static binary located at
+`result/bin/conduit`. This is reproducible with the static binaries produced in our CI.
+
+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).
+
+## Migrating from Conduit
+
+As mentioned in the README, there is little to no steps needed to migrate
+from Conduit. As long as you are using the RocksDB database backend, just
+replace the binary / container image / etc.
+
+**Note**: If you are relying on Conduit's "automatic delegation" feature,
+this will **NOT** work on conduwuit and you must configure delegation manually.
+This is not a mistake and no support for this feature will be added.
+
+If you are using SQLite, you **MUST** migrate to RocksDB. You can use this
+tool to migrate from SQLite to RocksDB: <https://github.com/ShadowJonathan/conduit_toolbox/>
+
+See the `[global.well_known]` config section, or configure your web server
+appropriately to send the delegation responses.
 
 ## Adding a conduwuit user
 
-While conduwuit can run as any user it is usually 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 RHEL, you can use this command to create a conduwuit user:
+In Debian, you can use this command to create a conduwuit user:
 
 ```bash
 sudo adduser --system conduwuit --group --disabled-login --no-create-home
 ```
 
+For distros without `adduser` (or where it's a symlink to `useradd`):
+
+```bash
+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.
+Matrix's default federation port is port 8448, and clients must be using port 443.
+If you would like to use only port 443, or a different port, you will need to setup
+delegation. conduwuit has config options for doing delegation, or you can configure
+your reverse proxy to manually serve the necessary JSON files to do delegation
+(see the `[global.well_known]` config section).
 
-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.
+
+Note for NAT users; if you have trouble connecting to your server from the inside
+of your network, you need to research your router and see if it supports "NAT
+hairpinning" or "NAT loopback".
+
+If your router does not support this feature, you need to research doing local
+DNS overrides and force your Matrix DNS records to use your local IP internally.
+This can be done at the host level using `/etc/hosts`. If you need this to be
+on the network level, consider something like NextDNS or Pi-Hole.
 
 ## Setting up a systemd service
 
-Now we'll set up a systemd service for conduwuit, so it's easy to start/stop conduwuit and set it to autostart when your
-server reboots. Simply paste the default systemd service you can find below into
-`/etc/systemd/system/conduwuit.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.
 
-```systemd
-[Unit]
-Description=conduwuit Matrix Server
-After=network.target
-
-[Service]
-Environment="CONDUWUIT_CONFIG=/etc/conduwuit/conduwuit.toml"
-User=conduwuit
-Group=conduwuit
-RuntimeDirectory=conduwuit
-RuntimeDirectoryMode=0750
-Restart=always
-ExecStart=/usr/local/bin/conduwuit
-
-[Install]
-WantedBy=multi-user.target
-```
-
-Finally, run
-
-```bash
-$ sudo systemctl daemon-reload
-```
+On systems where rsyslog is used alongside journald (i.e. Red Hat-based distros and OpenSUSE), put `$EscapeControlCharactersOnReceive off` inside `/etc/rsyslog.conf` to allow color in logs.
 
 ## Creating the conduwuit configuration file
 
-Now we need to create the conduwuit's config file in `/etc/conduwuit/conduwuit.toml`. Paste this in **and take a moment
-to read it. You need to change at least the server name.**
-RocksDB (`rocksdb`) is the only supported database backend. SQLite only exists for historical reasons and is not recommended. Any performance issues, storage issues, database issues, etc will not be assisted if using SQLite and you will be asked to migrate to RocksDB first.
+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).
 
-See the following example config at [conduwuit-example.toml](../configuration.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
 
-As we are using a conduwuit specific user we need to allow it to read the config. To do that you can run this command on
-Debian or RHEL:
+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 755 /etc/conduwuit
+sudo chmod -R 755 /etc/conduwuit
 ```
 
 If you use the default database path you also need to run this:
@@ -102,57 +125,103 @@ ## Setting the correct file permissions
 
 ## Setting up the Reverse Proxy
 
-Refer to the documentation or various guides online of your chosen reverse proxy software. A Caddy example will be provided as this is the recommended reverse proxy for new users and is very trivial.
+Refer to the documentation or various guides online of your chosen reverse proxy
+software. There are many examples of basic Apache/Nginx reverse proxy setups
+out there.
+
+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 a workaround is found, feel free to share to get it added to the documentation here.
+
+If using Apache, you need to use `nocanon` in your `ProxyPass` directive to prevent this (note that Apache isn't very good as a general reverse proxy and we discourage the usage of it if you can).
+
+If using Nginx, you need to give conduwuit the request URI using `$request_uri`, or like so:
+- `proxy_pass http://127.0.0.1:6167$request_uri;`
+- `proxy_pass http://127.0.0.1:6167;`
+
+Nginx users need to increase `client_max_body_size` (default is 1M) to match
+`max_request_size` defined in conduwuit.toml.
+
+You will need to reverse proxy everything under following routes:
+- `/_matrix/` - core Matrix C-S and S-S APIs
+- `/_conduwuit/` - ad-hoc conduwuit routes such as `/local_user_count` and
+`/server_version`
+
+You can optionally reverse proxy the following individual routes:
+- `/.well-known/matrix/client` and `/.well-known/matrix/server` if using
+conduwuit to perform delegation (see the `[global.well_known]` config section)
+- `/.well-known/matrix/support` if using conduwuit to send the homeserver admin
+contact and support page (formerly known as MSC1929)
+- `/` if you would like to see `hewwo from conduwuit woof!` at the root
+
+See the following spec pages for more details on these files:
+- [`/.well-known/matrix/server`](https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixserver)
+- [`/.well-known/matrix/client`](https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixclient)
+- [`/.well-known/matrix/support`](https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixsupport)
+
+Examples of delegation:
+- <https://puppygock.gay/.well-known/matrix/server>
+- <https://puppygock.gay/.well-known/matrix/client>
 
 ### 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
 }
 ```
 
-That's it! Just start or enable the service and you're set.
+That's it! Just start and enable the service and you're set.
 
 ```bash
-$ sudo systemctl enable caddy
+sudo systemctl enable --now caddy
 ```
 
-## You're done!
+## You're done
 
 Now you can start conduwuit with:
 
 ```bash
-$ sudo systemctl start conduwuit
+sudo systemctl start conduwuit
 ```
 
 Set it to start automatically when your system boots with:
 
 ```bash
-$ sudo systemctl enable conduwuit
+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.
+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
+
+# If federation is enabled
+curl https://your.server.name:8448/_matrix/federation/v1/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?
 
@@ -162,4 +231,5 @@ ## Audio/Video calls
 
 ## 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).

docs/deploying/kubernetes.md

@@ -0,0 +1,8 @@
+# conduwuit for Kubernetes
+
+conduwuit doesn't support horizontal scalability or distributed loading
+natively, however a community maintained Helm Chart is available here to run
+conduwuit on Kubernetes: <https://gitlab.cronce.io/charts/conduwuit>
+
+Should changes need to be made, please reach out to the maintainer in our
+Matrix room as this is not maintained/controlled by the conduwuit maintainers.

docs/deploying/nixos.md

@@ -1,30 +1,102 @@
 # conduwuit for NixOS
 
-conduwuit can be acquired by Nix from various places:
+conduwuit can be acquired by Nix (or [Lix][lix]) from various places:
 
 * The `flake.nix` at the root of the repo
 * The `default.nix` at the root of the repo
 * From conduwuit's binary cache
 
+A community maintained NixOS package is available at [`conduwuit`](https://search.nixos.org/packages?channel=unstable&show=conduwuit&from=0&size=50&sort=relevance&type=packages&query=conduwuit)
+
+### Binary cache
+
 A binary cache for conduwuit that the CI/CD publishes to is available at the
 following places (both are the same just different names):
+
 ```
 https://attic.kennel.juneis.dog/conduit
-conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg=
+conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk=
 
 https://attic.kennel.juneis.dog/conduwuit
+conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE=
+```
+
+The binary caches were recreated some months ago 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`
 
-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 specifying a Git remote URL in your flake, you can use any remotes that
+are specified on the README (the mirrors), such as the GitHub: `github:girlbossceo/conduwuit`
 
-If you want to run the latest code, you should get Conduwuit from the `flake.nix`
+### NixOS module
+
+The `flake.nix` and `default.nix` do not currently provide a NixOS module (contributions
+welcome!), so [`services.matrix-conduit`][module] from Nixpkgs can be used to configure
+conduwuit.
+
+### Conduit NixOS Config Module and SQLite
+
+Beware! The [`services.matrix-conduit`][module] module defaults to SQLite as a database backend.
+Conduwuit dropped SQLite support in favor of exclusively supporting the much faster RocksDB.
+Make sure that you are using the RocksDB backend before migrating!
+
+There is a [tool to  migrate a Conduit SQLite database to
+RocksDB](https://github.com/ShadowJonathan/conduit_toolbox/).
+
+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.
+appropriately to use conduwuit instead of Conduit.
 
+### UNIX sockets
+
+Due to the lack of a conduwuit NixOS module, when using the `services.matrix-conduit` module
+a workaround like the one below is necessary to use UNIX sockets. This is because the UNIX
+socket option does not exist in Conduit, and the module forcibly sets the `address` and 
+`port` config options.
+
+```nix
+options.services.matrix-conduit.settings = lib.mkOption {
+  apply = old: old // (
+    if (old.global ? "unix_socket_path")
+    then { global = builtins.removeAttrs old.global [ "address" "port" ]; }
+    else {  }
+  );
+};
+
+```
+
+Additionally, the [`matrix-conduit` systemd unit][systemd-unit] in the module does not allow
+the `AF_UNIX` socket address family in their systemd unit's `RestrictAddressFamilies=` which
+disallows the namespace from accessing or creating UNIX sockets and has to be enabled like so:
+
+```nix
+systemd.services.conduit.serviceConfig.RestrictAddressFamilies = [ "AF_UNIX" ];
+```
+
+Even though those workarounds are feasible a conduwuit NixOS configuration module, developed and
+published by the community, would be appreciated.
+
+### jemalloc and hardened profile
+
+conduwuit uses jemalloc by default. This may interfere with the [`hardened.nix` profile][hardened.nix]
+due to them using `scudo` by default. You must either disable/hide `scudo` from conduwuit, or
+disable jemalloc like so:
+
+```nix
+let
+    conduwuit = pkgs.unstable.conduwuit.override {
+      enableJemalloc = false;
+    };
+in
+```
+
+[lix]: https://lix.systems/
 [module]: https://search.nixos.org/options?channel=unstable&query=services.matrix-conduit
 [package]: https://search.nixos.org/options?channel=unstable&query=services.matrix-conduit.package
+[hardened.nix]: https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/profiles/hardened.nix#L22
+[systemd-unit]: https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/matrix/conduit.nix#L132

docs/development.md

@@ -1,22 +1,131 @@
 # Development
 
 Information about developing the project. If you are only interested in using
-it, you can safely ignore this section.
+it, you can safely ignore this page. If you plan on contributing, see the
+[contributor's guide](./contributing.md).
+
+## conduwuit project layout
+
+conduwuit uses a collection of sub-crates, packages, or workspace members
+that indicate what each general area of code is for. All of the workspace
+members are under `src/`. The workspace definition is at the top level / root
+`Cargo.toml`.
+
+The crate names are generally self-explanatory:
+- `admin` is the admin room
+- `api` is the HTTP API, Matrix C-S and S-S endpoints, etc
+- `core` is core conduwuit functionality like config loading, error definitions,
+global utilities, logging infrastructure, etc
+- `database` is RocksDB methods, helpers, RocksDB config, and general database definitions,
+utilities, or functions
+- `macros` are conduwuit Rust [macros][macros] like general helper macros, logging
+and error handling macros, and [syn][syn] and [procedural macros][proc-macro]
+used for admin room commands and others
+- `main` is the "primary" sub-crate. This is where the `main()` function lives,
+tokio worker and async initialisation, Sentry initialisation, [clap][clap] init,
+and signal handling. If you are adding new [Rust features][features], they *must*
+go here.
+- `router` is the webserver and request handling bits, using axum, tower, tower-http,
+hyper, etc, and the [global server state][state] to access `services`.
+- `service` is the high-level database definitions and functions for data,
+outbound/sending code, and other business logic such as media fetching.
+
+It is highly unlikely you will ever need to add a new workspace member, but
+if you truly find yourself needing to, we recommend reaching out to us in
+the Matrix room for discussions about it beforehand.
+
+The primary inspiration for this design was apart of hot reloadable development,
+to support "conduwuit as a library" where specific parts can simply be swapped out.
+There is evidence Conduit wanted to go this route too as `axum` is technically an
+optional feature in Conduit, and can be compiled without the binary or axum library
+for handling inbound web requests; but it was never completed or worked.
+
+See the Rust documentation on [Workspaces][workspaces] for general questions
+and information on Cargo workspaces.
+
+## Adding compile-time [features][features]
+
+If you'd like to add a compile-time feature, you must first define it in
+the `main` workspace crate located in `src/main/Cargo.toml`. The feature must
+enable a feature in the other workspace crate(s) you intend to use it in. Then
+the said workspace crate(s) must define the feature there in its `Cargo.toml`.
+
+So, if this is adding a feature to the API such as `woof`, you define the feature
+in the `api` crate's `Cargo.toml` as `woof = []`. The feature definition in `main`'s
+`Cargo.toml` will be `woof = ["conduit-api/woof"]`.
+
+The rationale for this is due to Rust / Cargo not supporting
+["workspace level features"][9], we must make a choice of; either scattering
+features all over the workspace crates, making it difficult for anyone to add
+or remove default features; or define all the features in one central workspace
+crate that propagate down/up to the other workspace crates. It is a Cargo pitfall,
+and we'd like to see better developer UX in Rust's Workspaces.
+
+Additionally, the definition of one single place makes "feature collection" in our
+Nix flake a million times easier instead of collecting and deduping them all from
+searching in all the workspace crates' `Cargo.toml`s. Though we wouldn't need to
+do this if Rust supported workspace-level features to begin with.
+
+## 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, better client/server interop
+hacks upstream won't accept, etc
+- [facebook/rocksdb][2]: <https://github.com/girlbossceo/rocksdb> - liburing
+build fixes and GCC debug build fix
+- [tikv/jemallocator][3]: <https://github.com/girlbossceo/jemallocator> - musl
+builds seem to be broken on upstream, fixes some broken/suspicious code in
+places, additional safety measures, and support redzones for Valgrind
+- [zyansheep/rustyline-async][4]:
+<https://github.com/girlbossceo/rustyline-async> - tab completion callback and
+`CTRL+\` signal quit event for conduwuit console CLI
+- [rust-rocksdb/rust-rocksdb][5]:
+<https://github.com/girlbossceo/rust-rocksdb-zaidoon1> - [`@zaidoon1`][8]'s fork
+has quicker updates, more up to date dependencies, etc. Our fork fixes musl build
+issues, removes unnecessary `gtest` include, and uses our RocksDB and jemallocator
+forks.
+- [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`][1] 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 \
+RUSTFLAGS="--cfg tokio_unstable" cargo +nightly build \
     --release \
     --no-default-features \
-    --features
-    backend_rocksdb,systemd,element_hacks,sentry_telemetry,gzip_compression,brotli_compression,zstd_compression,tokio_console
+    --features=systemd,element_hacks,gzip_compression,brotli_compression,zstd_compression,tokio_console
 ```
 
-[1]: https://docs.rs/tokio-console/latest/tokio_console/
+You will also need to enable the `tokio_console` config option in conduwuit when
+starting it. This was due to tokio-console causing gradual memory leak/usage
+if left enabled.
+
+[1]: https://github.com/ruma/ruma/
+[2]: https://github.com/facebook/rocksdb/
+[3]: https://github.com/tikv/jemallocator/
+[4]: https://github.com/zyansheep/rustyline-async/
+[5]: https://github.com/rust-rocksdb/rust-rocksdb/
+[6]: https://github.com/tokio-rs/tracing/
+[7]: https://docs.rs/tokio-console/latest/tokio_console/
+[8]: https://github.com/zaidoon1/
+[9]: https://github.com/rust-lang/cargo/issues/12162
+[workspaces]: https://doc.rust-lang.org/cargo/reference/workspaces.html
+[macros]: https://doc.rust-lang.org/book/ch19-06-macros.html
+[syn]: https://docs.rs/syn/latest/syn/
+[proc-macro]: https://doc.rust-lang.org/reference/procedural-macros.html
+[clap]: https://docs.rs/clap/latest/clap/
+[features]: https://doc.rust-lang.org/cargo/reference/features.html
+[state]: https://docs.rs/axum/latest/axum/extract/struct.State.html

docs/development/hot_reload.md

@@ -0,0 +1,197 @@
+# Hot Reloading ("Live" Development)
+
+### 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.
+
+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.
+
+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.
+
+### 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.
+
+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.
+
+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/`
+
+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.
+
+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.
+
+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.
+
+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.
+
+### 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.
+
+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.**
+
+![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.
+
+![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:
+
+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.
+
+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.
+
+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.
+
+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)
+
+[1]: https://github.com/girlbossceo/conduwuit/pull/387
+[2]: https://wiki.musl-libc.org/functional-differences-from-glibc.html#Unloading-libraries
+[3]: https://github.com/rust-lang/rust/issues/28794
+[4]: https://github.com/rust-lang/rust/issues/28794#issuecomment-368693049
+[5]: https://github.com/rust-lang/cargo/issues/12746
+[6]: https://crates.io/crates/hot-lib-reloader/
+[7]: https://matrix.to/#/#conduwuit:puppygock.gay
+[8]: https://crates.io/crates/libloading

docs/development/testing.md

@@ -5,13 +5,18 @@ ## Complement
 Have a look at [Complement's repository][complement] for an explanation of what
 it is.
 
-To test against Complement, with Nix and direnv installed and set up, you can
-either:
+To test against Complement, with Nix (or [Lix](https://lix.systems) 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
+* 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 image
+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]
 
+[ci-workflows]: https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml?query=event%3Apush+is%3Asuccess+actor%3Agirlbossceo
 [complement]: https://github.com/matrix-org/complement

docs/differences.md

@@ -1,152 +1,379 @@
-#### **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:
+### list of features, bug fixes, etc that conduwuit does that Conduit does not
 
 Outgoing typing indicators, outgoing read receipts, **and** outgoing presence!
 
-## Performance:
-- Concurrency support for 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 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
-- 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.
-- Add a Cargo build profile for aggressive build-time performance optimisations for release builds (1 codegen unit, no debug, fat LTO, etc, and optimise all crates with same)
+## 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
+- 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.
 - 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 building conduwuit with jemalloc (which extends to the RocksDB jemalloc feature for maximum gains) or hardened_malloc light variant, and produce CI builds with jemalloc 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)
-- 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)
+- 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
 
+## General Fixes/Features
 
-## General Fixes:
-- 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`)
-- Fixed spec compliance issue with room version 8 - 11 joins (https://github.com/matrix-org/synapse/issues/16717 / https://github.com/matrix-org/matrix-spec/issues/1708)
-- Safer and cleaner shutdowns on both database side as we run cleanup on shutdown and exits database loop better (no potential hanging issues in database loop), overall cleaner shutdown logic
-- 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)
-- Increased graceful shutdown timeout from a low 60 seconds to 180 seconds to avoid killing connections and let the remaining ones finish processing
-- 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 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)
-- 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`
-- Add workaround for [Out Of Your Element](https://gitdab.com/cadence/out-of-your-element) appservice bridge to make it functional on conduwuit (bug has already been reported)
+- 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`
+- 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
+- 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 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`)
+- Fix seeing empty status messages on user presences
 
+## Moderation
 
-## 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 `[well_known.support]` (MSC1929)
-- 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/v1.9/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
-- 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.
+- 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
 
-## 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
+- 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
 
-## 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 configurable RocksDB recovery modes to aid in recovering corrupted RocksDB databases
-- Support config options via `CONDUWUIT_` prefix
-- Add support for listening on multiple TCP ports
-- Disable update check by default as it's not useful for conduwuit
+- 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
+- Fix Conduit dropping some remote server federation response errors
 
+## Maintenance/Stability
 
-## Maintenance/Stability:
 - GitLab CI ported to GitHub Actions
-- Repo is mirrored to GitHub, GitLab, git.gay, sourcehut, and Codeberg (see README.md for their links)
-- 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
-- Has [Renovate](https://docs.renovatebot.com/), [Trivy](https://github.com/aquasecurity/trivy-action), and keeps ALL dependencies as up to date as possible
-- Attempts and interest in removing extreme and unnecessary panics/unwraps/expects that can lead to denial of service or such (upstream and upstream contributors want this unusual behaviour for some reason)
-- Purge unmaintained/irrelevant/broken database backends (heed, sled, persy) and other unnecessary code or overhead
+- Repo uses [Renovate](https://docs.renovatebot.com/) 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
-- CI tests with all features
-- Add timestamp by commit date support to building OCI images for keeping image build reproducibility and still have a meaningful "last modified date" for OCI image metadata
-- Update rusqlite/sqlite (not that you should be using it)
-- 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 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
+- 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
 
+## Admin Room
 
-## Admin Room:
-- 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 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
-- Add admin command to return a room's 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
+- 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 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
 - Add admin commands to output jemalloc memory stats and memory usage
-- Add admin command to get conduwuit's uptime
 - 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
 
+## Misc
 
-## Misc:
-- 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 **optional** feature flag to use SHA256 key names for media instead of base64 to overcome filesystem file name length limitations (OS error file name too long)
+- 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
-- Assume well-knowns are broken if they exceed past 10000 characters.
-- 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
-- Add support for listening on both HTTP and HTTPS if using direct TLS with conduwuit for usecases such as Complement
-- Implement running and diff'ing Complement results in CI
-- Interest in supporting other operating systems such as macOS, BSDs, and Windows, and getting them added into CI and doing builds for them
+- Implement unstable MSC3266 room summary API support
+- 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 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)
 - (Developers): Add support for tokio-console
 - (Developers): Add support for tracing flame graphs
-- Add `release-debuginfo` Cargo build profile
-- No cryptocurrency donations allowed, conduwuit is fully maintained by independent queer maintainers, and with a strong priority on inclusitivity and comfort for protected groups 🏳️‍⚧️
+- 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)

docs/introduction.md

@@ -1,4 +1,4 @@
-# Conduwuit
+# conduwuit
 
 {{#include ../README.md:catchphrase}}
 
@@ -6,12 +6,17 @@ # Conduwuit
 
 #### What's different about your fork than upstream Conduit?
 
-See [differences.md](differences.md)
+See the [differences](differences.md) page
 
 #### How can I deploy my own?
 
 - [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?
+
+See the [contributor's guide](contributing.md)
 
 {{#include ../README.md:footer}}

docs/maintenance.md

@@ -0,0 +1,97 @@
+# Maintaining your conduwuit setup
+
+## 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 admin commands for:
+
+- managing room aliases (`!admin rooms alias`)
+- managing room directory (`!admin rooms directory`)
+- 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`)
+- 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:
+
+```` !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.
+
+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).
+
+## 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.
+
+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
+- 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.
+
+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)
+- 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`)
+
+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.
+
+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.

docs/troubleshooting.md

@@ -0,0 +1,151 @@
+# Troubleshooting conduwuit
+
+> ## 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.
+>
+> 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.
+
+## 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.
+
+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`)
+
+## 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 and reduces system CPU
+usage, but at least FUSE and possibly ZFS are filesystems 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.
+
+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:
+
+- `TolerateCorruptedTailRecords`
+- `AbsoluteConsistency`
+- `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.
+
+`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
+
+## 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`.
+
+#### Debug/Trace log level
+
+conduwuit builds without debug or trace log levels at compile time by default
+for substantial performance gains in CPU usage and improved compile times. If
+you need to access debug/trace log levels, you will need to build without the
+`release_max_log_level` feature or use our provided static debug binaries.
+
+#### Changing log level dynamically
+
+conduwuit supports changing the tracing log environment filter on-the-fly using
+the admin command `!admin debug change-log-level <log env filter>`. This accepts
+a string **without quotes** the same format as the `log` config option.
+
+Example: `!admin debug change-log-level debug`
+
+This can also accept complex filters such as:
+`!admin debug change-log-level info,conduit_service[{dest="example.com"}]=trace,ruma_state_res=trace`
+`!admin debug change-log-level info,conduit_service[{dest="example.com"}]=trace,conduit_service[send{dest="example.org"}]=trace`
+
+And to reset the log level to the one that was set at startup / last config
+load, simply pass the `--reset` flag.
+
+`!admin debug change-log-level --reset`
+
+#### Pinging servers
+
+conduwuit can ping other servers using `!admin debug ping <server>`. This takes
+a server name and goes through the server discovery process and queries
+`/_matrix/federation/v1/version`. Errors are outputted.
+
+While it does measure the latency of the request, it is not indicative of
+server performance on either side as that endpoint is completely unauthenticated
+and simply fetches a string on a static JSON endpoint. It is very low cost both
+bandwidth and computationally.
+
+#### Allocator memory stats
+
+When using jemalloc with jemallocator's `stats` feature (`--enable-stats`), you
+can see conduwuit's high-level allocator stats by using
+`!admin server memory-usage` at the bottom.
+
+If you are a developer, you can also view the raw jemalloc statistics with
+`!admin debug memory-stats`. Please note that this output is extremely large
+which may only be visible in the conduwuit console CLI due to PDU size limits,
+and is not easy for non-developers to understand.

docs/turn.md

@@ -1,25 +1,70 @@
 # Setting up TURN/STURN
 
-## General instructions
+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.
 
-* It is assumed you have a [Coturn server](https://github.com/coturn/coturn) up and running. See [Synapse reference implementation](https://github.com/matrix-org/synapse/blob/develop/docs/turn-howto.md).
+### Configuration
 
-## Edit/Add a few settings to your existing conduit.toml
+Create a configuration file called `coturn.conf` containing:
 
-```
-# Refer to your Coturn settings. 
-# `your.turn.url` has to match the REALM setting of your Coturn as well as `transport`.
-turn_uris = ["turn:your.turn.url?transport=udp", "turn:your.turn.url?transport=tcp"]
-
-# static-auth-secret of your turnserver
-turn_secret = "ADD SECRET HERE"
-
-# If you have your TURN server configured to use a username and password
-# you can provide these information too. In this case comment out `turn_secret above`!
-#turn_username = ""
-#turn_password = ""
+```conf
+use-auth-secret
+static-auth-secret=<a secret key>
+realm=<your server domain>
 ```
 
-## Apply settings
+A common way to generate a suitable alphanumeric secret key is by using `pwgen
+-s 64 1`.
 
-Restart Conduit.
+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.
+
+`turn_secret` or a path to `turn_secret_file` must have a value of your
+coturn `static-auth-secret`, or use `turn_username` and `turn_password`
+if using legacy username:password TURN authentication (not preferred).
+
+`turn_uris` must be the list of TURN URIs you would like to send to the client.
+Typically you will just replace the example domain `example.turn.uri` with the
+`realm` you set from the example config.
+
+If you are using TURN over TLS, you can replace `turn:` with `turns:` in the
+`turn_uris` config option to instruct clients to attempt to connect to
+TURN over TLS. This is highly recommended.
+
+If you need unauthenticated access to the TURN URIs, or some clients may be
+having trouble, you can enable `turn_guest_access` in conduwuit which disables
+authentication for the TURN URI endpoint `/_matrix/client/v3/voip/turnServer`
+
+### 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
+```
+
+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
+services:
+    turn:
+      container_name: coturn-server
+      image: docker.io/coturn/coturn
+      restart: unless-stopped
+      network_mode: "host"
+      volumes:
+        - ./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).
+
+For security recommendations see Synapse's [Coturn
+documentation](https://element-hq.github.io/synapse/latest/turn-howto.html).

engage.toml

@@ -55,26 +55,42 @@ name = "lychee"
 group = "versions"
 script = "lychee --version"
 
+[[task]]
+name = "markdownlint"
+group = "versions"
+script = "markdownlint --version"
+
+[[task]]
+name = "dpkg"
+group = "versions"
+script = "dpkg --version"
+
 [[task]]
 name = "cargo-audit"
 group = "security"
-script = "cargo audit -D warnings -D unmaintained -D unsound -D yanked --ignore RUSTSEC-2020-0016"
+script = "cargo audit -D warnings -D unmaintained -D unsound -D yanked"
 
 [[task]]
 name = "cargo-fmt"
 group = "lints"
-script = "cargo fmt --check -- --color=always"
+script = """
+cargo fmt --check -- --color=always
+"""
 
 [[task]]
 name = "cargo-doc"
 group = "lints"
 script = """
-RUSTDOCFLAGS="-D warnings" cargo doc \
-    --workspace \
-    --all-features \
-    --no-deps \
-    --document-private-items \
-    --color always
+env DIRENV_DEVSHELL=all-features \
+    RUSTDOCFLAGS="-D warnings" \
+    direnv exec . \
+    cargo doc \
+        --workspace \
+        --profile test \
+        --all-features \
+        --no-deps \
+        --document-private-items \
+        --color always
 """
 
 [[task]]
@@ -83,6 +99,7 @@ group = "lints"
 script = """
 cargo clippy \
     --workspace \
+    --profile test \
     --all-targets \
     --color=always \
     -- \
@@ -93,13 +110,16 @@ cargo clippy \
 name = "clippy/all"
 group = "lints"
 script = """
-cargo clippy \
-    --workspace \
-    --all-targets \
-    --all-features \
-    --color=always \
-    -- \
-    -D warnings
+env DIRENV_DEVSHELL=all-features \
+    direnv exec . \
+    cargo clippy \
+        --workspace \
+        --profile test \
+        --all-targets \
+        --all-features \
+        --color=always \
+        -- \
+        -D warnings
 """
 
 [[task]]
@@ -108,6 +128,7 @@ group = "lints"
 script = """
 cargo clippy \
     --workspace \
+    --profile test \
     --features jemalloc \
     --all-targets \
     --color=always \
@@ -115,33 +136,83 @@ cargo clippy \
     -D warnings
 """
 
-[[task]]
-name = "clippy/hardened_malloc"
-group = "lints"
-script = """
-cargo clippy \
-    --workspace \
-    --features hardened_malloc \
-    --all-targets \
-    --color=always \
-    -- \
-    -D warnings
-"""
+#[[task]]
+#name = "clippy/hardened_malloc"
+#group = "lints"
+#script = """
+#cargo clippy \
+#    --workspace \
+#    --features hardened_malloc \
+#    --all-targets \
+#    --color=always \
+#    -- \
+#    -D warnings
+#"""
 
 [[task]]
 name = "lychee"
 group = "lints"
-script = "lychee --offline docs"
+script = "lychee --verbose --offline docs *.md --exclude development.md --exclude contributing.md --exclude testing.md"
 
 [[task]]
-name = "cargo"
+name = "markdownlint"
+group = "lints"
+script = "markdownlint docs *.md || true" # TODO: fix the ton of markdown lints so we can drop `|| true`
+
+[[task]]
+name = "cargo/all"
+group = "tests"
+script = """
+env DIRENV_DEVSHELL=all-features \
+    direnv exec . \
+    cargo test \
+        --workspace \
+        --profile test \
+        --all-targets \
+        --all-features \
+        --color=always \
+        -- \
+        --color=always
+"""
+
+[[task]]
+name = "cargo/default"
 group = "tests"
 script = """
 cargo test \
     --workspace \
+    --profile test \
     --all-targets \
-    --all-features \
     --color=always \
     -- \
     --color=always
 """
+
+# Checks if the generated example config differs from the checked in repo's
+# example config.
+[[task]]
+name = "example-config"
+group = "tests"
+depends = ["cargo/default"]
+script = """
+git diff --exit-code conduwuit-example.toml
+"""
+
+# Ensure that the flake's default output can build and run without crashing
+#
+# This is a dynamically-linked jemalloc build, which is a case not covered by
+# our other tests. We've had linking problems in the past with dynamic
+# jemalloc builds that usually show up as an immediate segfault or "invalid free"
+[[task]]
+name = "nix-default"
+group = "tests"
+script = """
+env DIRENV_DEVSHELL=dynamic \
+    CARGO_PROFILE="test" \
+    direnv exec . \
+    bin/nix-build-and-cache just .#default-test
+env DIRENV_DEVSHELL=dynamic \
+    CARGO_PROFILE="test" \
+    direnv exec . \
+    nix run -L .#default-test -- --help && nix run -L .#default-test -- --version
+"""

flake.lock

@@ -4,16 +4,16 @@
       "inputs": {
         "crane": "crane",
         "flake-compat": "flake-compat",
-        "flake-utils": "flake-utils",
+        "flake-parts": "flake-parts",
         "nixpkgs": "nixpkgs",
         "nixpkgs-stable": "nixpkgs-stable"
       },
       "locked": {
-        "lastModified": 1711742460,
-        "narHash": "sha256-0O4v6e4a1toxXZ2gf5INhg4WPE5C5T+SVvsBt+45Mcc=",
+        "lastModified": 1729116596,
+        "narHash": "sha256-NnLMLIXGZtAscUF4dCShksuQ1nOGF6Y2dEeyj0rBbUg=",
         "owner": "zhaofengli",
         "repo": "attic",
-        "rev": "4dbdbee45728d8ce5788db6461aaaa89d98081f0",
+        "rev": "2b05b7d986cf6009b1c1ef7daa4961cd1a658782",
         "type": "github"
       },
       "original": {
@@ -23,14 +23,108 @@
         "type": "github"
       }
     },
+    "cachix": {
+      "inputs": {
+        "devenv": "devenv",
+        "flake-compat": "flake-compat_3",
+        "git-hooks": "git-hooks",
+        "nixpkgs": "nixpkgs_4"
+      },
+      "locked": {
+        "lastModified": 1728672398,
+        "narHash": "sha256-KxuGSoVUFnQLB2ZcYODW7AVPAh9JqRlD5BrfsC/Q4qs=",
+        "owner": "cachix",
+        "repo": "cachix",
+        "rev": "aac51f698309fd0f381149214b7eee213c66ef0a",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "ref": "master",
+        "repo": "cachix",
+        "type": "github"
+      }
+    },
+    "cachix_2": {
+      "inputs": {
+        "devenv": "devenv_2",
+        "flake-compat": [
+          "cachix",
+          "devenv",
+          "flake-compat"
+        ],
+        "git-hooks": [
+          "cachix",
+          "devenv",
+          "pre-commit-hooks"
+        ],
+        "nixpkgs": [
+          "cachix",
+          "devenv",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1726520618,
+        "narHash": "sha256-jOsaBmJ/EtX5t/vbylCdS7pWYcKGmWOKg4QKUzKr6dA=",
+        "owner": "cachix",
+        "repo": "cachix",
+        "rev": "695525f9086542dfb09fde0871dbf4174abbf634",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "cachix",
+        "type": "github"
+      }
+    },
+    "cachix_3": {
+      "inputs": {
+        "devenv": "devenv_3",
+        "flake-compat": [
+          "cachix",
+          "devenv",
+          "cachix",
+          "devenv",
+          "flake-compat"
+        ],
+        "nixpkgs": [
+          "cachix",
+          "devenv",
+          "cachix",
+          "devenv",
+          "nixpkgs"
+        ],
+        "pre-commit-hooks": [
+          "cachix",
+          "devenv",
+          "cachix",
+          "devenv",
+          "pre-commit-hooks"
+        ]
+      },
+      "locked": {
+        "lastModified": 1712055811,
+        "narHash": "sha256-7FcfMm5A/f02yyzuavJe06zLa9hcMHsagE28ADcmQvk=",
+        "owner": "cachix",
+        "repo": "cachix",
+        "rev": "02e38da89851ec7fec3356a5c04bc8349cae0e30",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "cachix",
+        "type": "github"
+      }
+    },
     "complement": {
       "flake": false,
       "locked": {
-        "lastModified": 1714472853,
-        "narHash": "sha256-CNRHSZe3TE+3tFj2dHNyxTMjDqL0MKY3P/3jqUgA7YE=",
+        "lastModified": 1724347376,
+        "narHash": "sha256-y0e/ULDJ92IhNQZsS/06g0s+AYZ82aJfrIO9qEse94c=",
         "owner": "matrix-org",
         "repo": "complement",
-        "rev": "891d18872c153d39a9ce63b545045efddb845738",
+        "rev": "39733c1b2f8314800776748cc7164f9a34650686",
         "type": "github"
       },
       "original": {
@@ -48,11 +142,11 @@
         ]
       },
       "locked": {
-        "lastModified": 1702918879,
-        "narHash": "sha256-tWJqzajIvYcaRWxn+cLUB9L9Pv4dQ3Bfit/YjU5ze3g=",
+        "lastModified": 1722960479,
+        "narHash": "sha256-NhCkJJQhD5GUib8zN9JrmYGMwt4lCRp6ZVNzIiYCl0Y=",
         "owner": "ipetkov",
         "repo": "crane",
-        "rev": "7195c00c272fdd92fc74e7d5a0a2844b9fadb2fb",
+        "rev": "4c6c77920b8d44cd6660c1621dea6b3fc4b4c4f4",
         "type": "github"
       },
       "original": {
@@ -62,17 +156,12 @@
       }
     },
     "crane_2": {
-      "inputs": {
-        "nixpkgs": [
-          "nixpkgs"
-        ]
-      },
       "locked": {
-        "lastModified": 1713738183,
-        "narHash": "sha256-qd/MuLm7OfKQKyd4FAMqV4H6zYyOfef5lLzRrmXwKJM=",
+        "lastModified": 1729741221,
+        "narHash": "sha256-8AHZZXs1lFkERfBY0C8cZGElSo33D/et7NKEpLRmvzo=",
         "owner": "ipetkov",
         "repo": "crane",
-        "rev": "f6c6a2fb1b8bd9b65d65ca9342dd0eb180a63f11",
+        "rev": "f235b656ee5b2bfd6d94c3bfd67896a575d4a6ed",
         "type": "github"
       },
       "original": {
@@ -82,6 +171,111 @@
         "type": "github"
       }
     },
+    "devenv": {
+      "inputs": {
+        "cachix": "cachix_2",
+        "flake-compat": [
+          "cachix",
+          "flake-compat"
+        ],
+        "nix": "nix_3",
+        "nixpkgs": [
+          "cachix",
+          "nixpkgs"
+        ],
+        "pre-commit-hooks": [
+          "cachix",
+          "git-hooks"
+        ]
+      },
+      "locked": {
+        "lastModified": 1727963652,
+        "narHash": "sha256-os0EDjn7QVXL6RtHNb9TrZLXVm2Tc5/nZKk3KpbTzd8=",
+        "owner": "cachix",
+        "repo": "devenv",
+        "rev": "cb0052e25dbcc8267b3026160dc73cddaac7d5fd",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "devenv",
+        "type": "github"
+      }
+    },
+    "devenv_2": {
+      "inputs": {
+        "cachix": "cachix_3",
+        "flake-compat": [
+          "cachix",
+          "devenv",
+          "cachix",
+          "flake-compat"
+        ],
+        "nix": "nix_2",
+        "nixpkgs": [
+          "cachix",
+          "devenv",
+          "cachix",
+          "nixpkgs"
+        ],
+        "pre-commit-hooks": [
+          "cachix",
+          "devenv",
+          "cachix",
+          "git-hooks"
+        ]
+      },
+      "locked": {
+        "lastModified": 1723156315,
+        "narHash": "sha256-0JrfahRMJ37Rf1i0iOOn+8Z4CLvbcGNwa2ChOAVrp/8=",
+        "owner": "cachix",
+        "repo": "devenv",
+        "rev": "ff5eb4f2accbcda963af67f1a1159e3f6c7f5f91",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "devenv",
+        "type": "github"
+      }
+    },
+    "devenv_3": {
+      "inputs": {
+        "flake-compat": [
+          "cachix",
+          "devenv",
+          "cachix",
+          "devenv",
+          "cachix",
+          "flake-compat"
+        ],
+        "nix": "nix",
+        "nixpkgs": "nixpkgs_2",
+        "poetry2nix": "poetry2nix",
+        "pre-commit-hooks": [
+          "cachix",
+          "devenv",
+          "cachix",
+          "devenv",
+          "cachix",
+          "pre-commit-hooks"
+        ]
+      },
+      "locked": {
+        "lastModified": 1708704632,
+        "narHash": "sha256-w+dOIW60FKMaHI1q5714CSibk99JfYxm0CzTinYWr+Q=",
+        "owner": "cachix",
+        "repo": "devenv",
+        "rev": "2ee4450b0f4b95a1b90f2eb5ffea98b90e48c196",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "ref": "python-rewrite",
+        "repo": "devenv",
+        "type": "github"
+      }
+    },
     "fenix": {
       "inputs": {
         "nixpkgs": [
@@ -90,11 +284,11 @@
         "rust-analyzer-src": "rust-analyzer-src"
       },
       "locked": {
-        "lastModified": 1714544767,
-        "narHash": "sha256-kF1bX+YFMedf1g0PAJYwGUkzh22JmULtj8Rm4IXAQKs=",
+        "lastModified": 1729751566,
+        "narHash": "sha256-99u/hrgBdi8bxSXZc9ZbNkR5EL1htrkbd3lsbKzS60g=",
         "owner": "nix-community",
         "repo": "fenix",
-        "rev": "73124e1356bde9411b163d636b39fe4804b7ca45",
+        "rev": "f32a2d484091a6dc98220b1f4a2c2d60b7c97c64",
         "type": "github"
       },
       "original": {
@@ -105,6 +299,22 @@
       }
     },
     "flake-compat": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1696426674,
+        "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=",
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "flake-compat_2": {
       "flake": false,
       "locked": {
         "lastModified": 1673956053,
@@ -120,7 +330,23 @@
         "type": "github"
       }
     },
-    "flake-compat_2": {
+    "flake-compat_3": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1696426674,
+        "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=",
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "flake-compat_4": {
       "flake": false,
       "locked": {
         "lastModified": 1696426674,
@@ -137,7 +363,69 @@
         "type": "github"
       }
     },
+    "flake-parts": {
+      "inputs": {
+        "nixpkgs-lib": [
+          "attic",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1722555600,
+        "narHash": "sha256-XOQkdLafnb/p9ij77byFQjDf5m5QYl9b2REiVClC+x4=",
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
+        "rev": "8471fe90ad337a8074e957b69ca4d0089218391d",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
+        "type": "github"
+      }
+    },
+    "flake-parts_2": {
+      "inputs": {
+        "nixpkgs-lib": [
+          "cachix",
+          "devenv",
+          "nix",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1712014858,
+        "narHash": "sha256-sB4SWl2lX95bExY2gMFG5HIzvva5AVMJd4Igm+GpZNw=",
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
+        "rev": "9126214d0a59633752a136528f5f3b9aa8565b7d",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
+        "type": "github"
+      }
+    },
     "flake-utils": {
+      "inputs": {
+        "systems": "systems"
+      },
+      "locked": {
+        "lastModified": 1689068808,
+        "narHash": "sha256-6ixXo3wt24N/melDWjq70UuHQLxGV8jZvooRanIHXw0=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "919d646de7be200f3bf08cb76ae1f09402b6f9b4",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "flake-utils_2": {
       "locked": {
         "lastModified": 1667395993,
         "narHash": "sha256-nuEHfE/LcWyuSWnS8t12N1wc105Qtau+/OdUAjtQ0rA=",
@@ -152,9 +440,9 @@
         "type": "github"
       }
     },
-    "flake-utils_2": {
+    "flake-utils_3": {
       "inputs": {
-        "systems": "systems"
+        "systems": "systems_2"
       },
       "locked": {
         "lastModified": 1710146030,
@@ -171,6 +459,117 @@
         "type": "github"
       }
     },
+    "git-hooks": {
+      "inputs": {
+        "flake-compat": [
+          "cachix",
+          "flake-compat"
+        ],
+        "gitignore": "gitignore",
+        "nixpkgs": [
+          "cachix",
+          "nixpkgs"
+        ],
+        "nixpkgs-stable": "nixpkgs-stable_2"
+      },
+      "locked": {
+        "lastModified": 1727854478,
+        "narHash": "sha256-/odH2nUMAwkMgOS2nG2z0exLQNJS4S2LfMW0teqU7co=",
+        "owner": "cachix",
+        "repo": "git-hooks.nix",
+        "rev": "5f58871c9657b5fc0a7f65670fe2ba99c26c1d79",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "git-hooks.nix",
+        "type": "github"
+      }
+    },
+    "gitignore": {
+      "inputs": {
+        "nixpkgs": [
+          "cachix",
+          "git-hooks",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1709087332,
+        "narHash": "sha256-HG2cCnktfHsKV0s4XW83gU3F57gaTljL9KNSuG6bnQs=",
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "rev": "637db329424fd7e46cf4185293b9cc8c88c95394",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "type": "github"
+      }
+    },
+    "libgit2": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1697646580,
+        "narHash": "sha256-oX4Z3S9WtJlwvj0uH9HlYcWv+x1hqp8mhXl7HsLu2f0=",
+        "owner": "libgit2",
+        "repo": "libgit2",
+        "rev": "45fd9ed7ae1a9b74b957ef4f337bc3c8b3df01b5",
+        "type": "github"
+      },
+      "original": {
+        "owner": "libgit2",
+        "repo": "libgit2",
+        "type": "github"
+      }
+    },
+    "liburing": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1725659644,
+        "narHash": "sha256-WjnpmopfvFoUbubIu9bki+Y6P4YXDfvnW4+72hniq3g=",
+        "owner": "axboe",
+        "repo": "liburing",
+        "rev": "0fe5c09195c0918f89582dd6ff098a58a0bdf62a",
+        "type": "github"
+      },
+      "original": {
+        "owner": "axboe",
+        "ref": "master",
+        "repo": "liburing",
+        "type": "github"
+      }
+    },
+    "nix": {
+      "inputs": {
+        "flake-compat": "flake-compat_2",
+        "nixpkgs": [
+          "cachix",
+          "devenv",
+          "cachix",
+          "devenv",
+          "cachix",
+          "devenv",
+          "nixpkgs"
+        ],
+        "nixpkgs-regression": "nixpkgs-regression"
+      },
+      "locked": {
+        "lastModified": 1712911606,
+        "narHash": "sha256-BGvBhepCufsjcUkXnEEXhEVjwdJAwPglCC2+bInc794=",
+        "owner": "domenkozar",
+        "repo": "nix",
+        "rev": "b24a9318ea3f3600c1e24b4a00691ee912d4de12",
+        "type": "github"
+      },
+      "original": {
+        "owner": "domenkozar",
+        "ref": "devenv-2.21",
+        "repo": "nix",
+        "type": "github"
+      }
+    },
     "nix-filter": {
       "locked": {
         "lastModified": 1710156097,
@@ -187,13 +586,102 @@
         "type": "github"
       }
     },
+    "nix-github-actions": {
+      "inputs": {
+        "nixpkgs": [
+          "cachix",
+          "devenv",
+          "cachix",
+          "devenv",
+          "cachix",
+          "devenv",
+          "poetry2nix",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1688870561,
+        "narHash": "sha256-4UYkifnPEw1nAzqqPOTL2MvWtm3sNGw1UTYTalkTcGY=",
+        "owner": "nix-community",
+        "repo": "nix-github-actions",
+        "rev": "165b1650b753316aa7f1787f3005a8d2da0f5301",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-community",
+        "repo": "nix-github-actions",
+        "type": "github"
+      }
+    },
+    "nix_2": {
+      "inputs": {
+        "flake-compat": [
+          "cachix",
+          "devenv",
+          "cachix",
+          "devenv",
+          "flake-compat"
+        ],
+        "nixpkgs": [
+          "cachix",
+          "devenv",
+          "cachix",
+          "devenv",
+          "nixpkgs"
+        ],
+        "nixpkgs-regression": "nixpkgs-regression_2"
+      },
+      "locked": {
+        "lastModified": 1712911606,
+        "narHash": "sha256-BGvBhepCufsjcUkXnEEXhEVjwdJAwPglCC2+bInc794=",
+        "owner": "domenkozar",
+        "repo": "nix",
+        "rev": "b24a9318ea3f3600c1e24b4a00691ee912d4de12",
+        "type": "github"
+      },
+      "original": {
+        "owner": "domenkozar",
+        "ref": "devenv-2.21",
+        "repo": "nix",
+        "type": "github"
+      }
+    },
+    "nix_3": {
+      "inputs": {
+        "flake-compat": [
+          "cachix",
+          "devenv",
+          "flake-compat"
+        ],
+        "flake-parts": "flake-parts_2",
+        "libgit2": "libgit2",
+        "nixpkgs": "nixpkgs_3",
+        "nixpkgs-23-11": "nixpkgs-23-11",
+        "nixpkgs-regression": "nixpkgs-regression_3",
+        "pre-commit-hooks": "pre-commit-hooks"
+      },
+      "locked": {
+        "lastModified": 1727438425,
+        "narHash": "sha256-X8ES7I1cfNhR9oKp06F6ir4Np70WGZU5sfCOuNBEwMg=",
+        "owner": "domenkozar",
+        "repo": "nix",
+        "rev": "f6c5ae4c1b2e411e6b1e6a8181cc84363d6a7546",
+        "type": "github"
+      },
+      "original": {
+        "owner": "domenkozar",
+        "ref": "devenv-2.24",
+        "repo": "nix",
+        "type": "github"
+      }
+    },
     "nixpkgs": {
       "locked": {
-        "lastModified": 1711401922,
-        "narHash": "sha256-QoQqXoj8ClGo0sqD/qWKFWezgEwUL0SUh37/vY2jNhc=",
+        "lastModified": 1726042813,
+        "narHash": "sha256-LnNKCCxnwgF+575y0pxUdlGZBO/ru1CtGHIqQVfvjlA=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "07262b18b97000d16a4bdb003418bd2fb067a932",
+        "rev": "159be5db480d1df880a0135ca0bfed84c2f88353",
         "type": "github"
       },
       "original": {
@@ -203,29 +691,141 @@
         "type": "github"
       }
     },
-    "nixpkgs-stable": {
+    "nixpkgs-23-11": {
       "locked": {
-        "lastModified": 1711460390,
-        "narHash": "sha256-akSgjDZL6pVHEfSE6sz1DNSXuYX6hq+P/1Z5IoYWs7E=",
+        "lastModified": 1717159533,
+        "narHash": "sha256-oamiKNfr2MS6yH64rUn99mIZjc45nGJlj9eGth/3Xuw=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "44733514b72e732bd49f5511bd0203dea9b9a434",
+        "rev": "a62e6edd6d5e1fa0329b8653c801147986f8d446",
         "type": "github"
       },
       "original": {
         "owner": "NixOS",
-        "ref": "nixos-23.11",
+        "repo": "nixpkgs",
+        "rev": "a62e6edd6d5e1fa0329b8653c801147986f8d446",
+        "type": "github"
+      }
+    },
+    "nixpkgs-regression": {
+      "locked": {
+        "lastModified": 1643052045,
+        "narHash": "sha256-uGJ0VXIhWKGXxkeNnq4TvV3CIOkUJ3PAoLZ3HMzNVMw=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
+        "type": "github"
+      }
+    },
+    "nixpkgs-regression_2": {
+      "locked": {
+        "lastModified": 1643052045,
+        "narHash": "sha256-uGJ0VXIhWKGXxkeNnq4TvV3CIOkUJ3PAoLZ3HMzNVMw=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
+        "type": "github"
+      }
+    },
+    "nixpkgs-regression_3": {
+      "locked": {
+        "lastModified": 1643052045,
+        "narHash": "sha256-uGJ0VXIhWKGXxkeNnq4TvV3CIOkUJ3PAoLZ3HMzNVMw=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
+        "type": "github"
+      }
+    },
+    "nixpkgs-stable": {
+      "locked": {
+        "lastModified": 1724316499,
+        "narHash": "sha256-Qb9MhKBUTCfWg/wqqaxt89Xfi6qTD3XpTzQ9eXi3JmE=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "797f7dc49e0bc7fab4b57c021cdf68f595e47841",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-24.05",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs-stable_2": {
+      "locked": {
+        "lastModified": 1720386169,
+        "narHash": "sha256-NGKVY4PjzwAa4upkGtAMz1npHGoRzWotlSnVlqI40mo=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "194846768975b7ad2c4988bdb82572c00222c0d7",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-24.05",
         "repo": "nixpkgs",
         "type": "github"
       }
     },
     "nixpkgs_2": {
       "locked": {
-        "lastModified": 1713537308,
-        "narHash": "sha256-XtTSSIB2DA6tOv+l0FhvfDMiyCmhoRbNB+0SeInZkbk=",
+        "lastModified": 1692808169,
+        "narHash": "sha256-x9Opq06rIiwdwGeK2Ykj69dNc2IvUH1fY55Wm7atwrE=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "5c24cf2f0a12ad855f444c30b2421d044120c66f",
+        "rev": "9201b5ff357e781bf014d0330d18555695df7ba8",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs_3": {
+      "locked": {
+        "lastModified": 1717432640,
+        "narHash": "sha256-+f9c4/ZX5MWDOuB1rKoWj+lBNm0z0rs4CK47HBLxy1o=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "88269ab3044128b7c2f4c7d68448b2fb50456870",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "release-24.05",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs_4": {
+      "locked": {
+        "lastModified": 1727802920,
+        "narHash": "sha256-HP89HZOT0ReIbI7IJZJQoJgxvB2Tn28V6XS3MNKnfLs=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "27e30d177e57d912d614c88c622dcfdb2e6e6515",
         "type": "github"
       },
       "original": {
@@ -235,19 +835,103 @@
         "type": "github"
       }
     },
-    "rocksdb": {
-      "flake": false,
+    "nixpkgs_5": {
       "locked": {
-        "lastModified": 1713810944,
-        "narHash": "sha256-/Xf0bzNJPclH9IP80QNaABfhj4IAR5LycYET18VFCXc=",
-        "owner": "facebook",
-        "repo": "rocksdb",
-        "rev": "6f7cabeac80a3a6150be2c8a8369fcecb107bf43",
+        "lastModified": 1725534445,
+        "narHash": "sha256-Yd0FK9SkWy+ZPuNqUgmVPXokxDgMJoGuNpMEtkfcf84=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "9bb1e7571aadf31ddb4af77fc64b2d59580f9a39",
         "type": "github"
       },
       "original": {
-        "owner": "facebook",
-        "ref": "v9.1.1",
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "poetry2nix": {
+      "inputs": {
+        "flake-utils": "flake-utils",
+        "nix-github-actions": "nix-github-actions",
+        "nixpkgs": [
+          "cachix",
+          "devenv",
+          "cachix",
+          "devenv",
+          "cachix",
+          "devenv",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1692876271,
+        "narHash": "sha256-IXfZEkI0Mal5y1jr6IRWMqK8GW2/f28xJenZIPQqkY0=",
+        "owner": "nix-community",
+        "repo": "poetry2nix",
+        "rev": "d5006be9c2c2417dafb2e2e5034d83fabd207ee3",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-community",
+        "repo": "poetry2nix",
+        "type": "github"
+      }
+    },
+    "pre-commit-hooks": {
+      "inputs": {
+        "flake-compat": [
+          "cachix",
+          "devenv",
+          "nix"
+        ],
+        "flake-utils": "flake-utils_2",
+        "gitignore": [
+          "cachix",
+          "devenv",
+          "nix"
+        ],
+        "nixpkgs": [
+          "cachix",
+          "devenv",
+          "nix",
+          "nixpkgs"
+        ],
+        "nixpkgs-stable": [
+          "cachix",
+          "devenv",
+          "nix",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1712897695,
+        "narHash": "sha256-nMirxrGteNAl9sWiOhoN5tIHyjBbVi5e2tgZUgZlK3Y=",
+        "owner": "cachix",
+        "repo": "pre-commit-hooks.nix",
+        "rev": "40e6053ecb65fcbf12863338a6dcefb3f55f1bf8",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "pre-commit-hooks.nix",
+        "type": "github"
+      }
+    },
+    "rocksdb": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1731690620,
+        "narHash": "sha256-Xd4TJYqPERMJLXaGa6r6Ny1Wlw8Uy5Cyf/8q7nS58QM=",
+        "owner": "girlbossceo",
+        "repo": "rocksdb",
+        "rev": "292446aa2bc41699204d817a1e4b091679a886eb",
+        "type": "github"
+      },
+      "original": {
+        "owner": "girlbossceo",
+        "ref": "v9.7.4",
         "repo": "rocksdb",
         "type": "github"
       }
@@ -255,24 +939,26 @@
     "root": {
       "inputs": {
         "attic": "attic",
+        "cachix": "cachix",
         "complement": "complement",
         "crane": "crane_2",
         "fenix": "fenix",
-        "flake-compat": "flake-compat_2",
-        "flake-utils": "flake-utils_2",
+        "flake-compat": "flake-compat_4",
+        "flake-utils": "flake-utils_3",
+        "liburing": "liburing",
         "nix-filter": "nix-filter",
-        "nixpkgs": "nixpkgs_2",
+        "nixpkgs": "nixpkgs_5",
         "rocksdb": "rocksdb"
       }
     },
     "rust-analyzer-src": {
       "flake": false,
       "locked": {
-        "lastModified": 1713628977,
-        "narHash": "sha256-iN5QUlUq527lswmBC+RopfXdu6Xx7mmTaBSH2l59FtM=",
+        "lastModified": 1729715509,
+        "narHash": "sha256-jUDN4e1kObbksb4sc+57NEeujBEDRdLCOu9wiE3RZdM=",
         "owner": "rust-lang",
         "repo": "rust-analyzer",
-        "rev": "55d9a533b309119c8acd13061581b43ae8840823",
+        "rev": "40492e15d49b89cf409e2c5536444131fac49429",
         "type": "github"
       },
       "original": {
@@ -296,6 +982,21 @@
         "repo": "default",
         "type": "github"
       }
+    },
+    "systems_2": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
     }
   },
   "root": "root",

flake.nix

@@ -1,57 +1,247 @@
 {
   inputs = {
     attic.url = "github:zhaofengli/attic?ref=main";
+    cachix.url = "github:cachix/cachix?ref=master";
     complement = { url = "github:matrix-org/complement?ref=main"; flake = false; };
-    crane = { url = "github:ipetkov/crane?ref=master"; inputs.nixpkgs.follows = "nixpkgs"; };
+    crane = { url = "github:ipetkov/crane?ref=master"; };
     fenix = { url = "github:nix-community/fenix?ref=main"; inputs.nixpkgs.follows = "nixpkgs"; };
     flake-compat = { url = "github:edolstra/flake-compat?ref=master"; flake = false; };
     flake-utils.url = "github:numtide/flake-utils?ref=main";
     nix-filter.url = "github:numtide/nix-filter?ref=main";
-    nixpkgs.url = "github:NixOS/nixpkgs?ref=nixos-unstable";
-    rocksdb = { url = "github:facebook/rocksdb?ref=v9.1.1"; flake = false; };
+    nixpkgs.url = "github:NixOS/nixpkgs?ref=nixpkgs-unstable";
+    rocksdb = { url = "github:girlbossceo/rocksdb?ref=v9.7.4"; flake = false; };
+    liburing = { url = "github:axboe/liburing?ref=master"; flake = false; };
   };
 
   outputs = inputs:
     inputs.flake-utils.lib.eachDefaultSystem (system:
     let
-      pkgsHost = inputs.nixpkgs.legacyPackages.${system};
+      pkgsHost = import inputs.nixpkgs{
+        inherit system;
+        config.permittedInsecurePackages = [ "olm-3.2.16" ];
+      };
+      pkgsHostStatic = pkgsHost.pkgsStatic;
 
       # The Rust toolchain to use
       toolchain = inputs.fenix.packages.${system}.fromToolchainFile {
         file = ./rust-toolchain.toml;
 
         # See also `rust-toolchain.toml`
-        sha256 = "sha256-e4mlaJehWBymYxJGgnbuCObVlqMlQSilZ8FljG9zPHY=";
+        sha256 = "sha256-s1RPtyvDGJaX/BisLT+ifVfuhDT1nZkZ1NcK8sbwELM=";
       };
 
-      scope = pkgs: pkgs.lib.makeScope pkgs.newScope (self: {
+      mkScope = pkgs: pkgs.lib.makeScope pkgs.newScope (self: {
+        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 {};
-        rocksdb = pkgs.rocksdb.overrideAttrs (old: {
+        tini = pkgs.tini.overrideAttrs {
+            # newer clang/gcc is unhappy with tini-static: <https://3.dog/~strawberry/pb/c8y4>
+            patches = [ (pkgs.fetchpatch {
+                url = "https://patch-diff.githubusercontent.com/raw/krallin/tini/pull/224.patch";
+                hash = "sha256-4bTfAhRyIT71VALhHY13hUgbjLEUyvgkIJMt3w9ag3k=";
+              })
+            ];
+        };
+        liburing = pkgs.liburing.overrideAttrs {
+          # Tests weren't building
+          outputs = [ "out" "dev" "man" ];
+          buildFlags = [ "library" ];
+          src = inputs.liburing;
+        };
+        rocksdb = (pkgs.rocksdb.override {
+          liburing = self.liburing;
+        }).overrideAttrs (old: {
           src = inputs.rocksdb;
           version = pkgs.lib.removePrefix
             "v"
             (builtins.fromJSON (builtins.readFile ./flake.lock))
               .nodes.rocksdb.original.ref;
+          # we have this already at https://github.com/girlbossceo/rocksdb/commit/a935c0273e1ba44eacf88ce3685a9b9831486155
+          # unsetting this so i don't have to revert it and make this nix exclusive
+          patches = [];
+          cmakeFlags = pkgs.lib.subtractLists
+            [
+              # no real reason to have snappy, no one uses this
+              "-DWITH_SNAPPY=1"
+              # we dont need to use ldb or sst_dump (core_tools)
+              "-DWITH_CORE_TOOLS=1"
+              # we dont need to build rocksdb tests
+              "-DWITH_TESTS=1"
+              # we use rust-rocksdb via C interface and dont need C++ RTTI
+              "-DUSE_RTTI=1"
+            ]
+            old.cmakeFlags
+            ++ [
+              # we dont need to use ldb or sst_dump (core_tools)
+              "-DWITH_CORE_TOOLS=0"
+              # we dont need trace tools
+              "-DWITH_TRACE_TOOLS=0"
+              # we dont need to build rocksdb tests
+              "-DWITH_TESTS=0"
+              # we use rust-rocksdb via C interface and dont need C++ RTTI
+              "-DUSE_RTTI=0"
+            ];
+
+          # outputs has "tools" which we dont need or use
+          outputs = [ "out" ];
+
+          # preInstall hooks has stuff for messing with ldb/sst_dump which we dont need or use
+          preInstall = "";
         });
       });
 
-      scopeHost = (scope pkgsHost);
+      scopeHost = mkScope pkgsHost;
+      scopeHostStatic = mkScope pkgsHostStatic;
+      scopeCrossLinux = mkScope pkgsHost.pkgsLinux.pkgsStatic;
+      mkCrossScope = crossSystem:
+        let pkgsCrossStatic = (import inputs.nixpkgs {
+          inherit system;
+          crossSystem = {
+           config = crossSystem;
+          };
+        }).pkgsStatic;
+         in
+        mkScope pkgsCrossStatic;
+
+      mkDevShell = scope: scope.pkgs.mkShell {
+        env = scope.main.env // {
+          # Rust Analyzer needs to be able to find the path to default crate
+          # sources, and it can read this environment variable to do so. The
+          # `rust-src` component is required in order for this to work.
+          RUST_SRC_PATH = "${toolchain}/lib/rustlib/src/rust/library";
+
+          # Convenient way to access a pinned version of Complement's source
+          # code.
+          COMPLEMENT_SRC = inputs.complement.outPath;
+
+          # Needed for Complement
+          CGO_CFLAGS = "-I${scope.pkgs.olm}/include";
+          CGO_LDFLAGS = "-L${scope.pkgs.olm}/lib";
+        };
+
+        # Development tools
+        packages = [
+          # Always use nightly rustfmt because most of its options are unstable
+          #
+          # This needs to come before `toolchain` in this list, otherwise
+          # `$PATH` will have stable rustfmt instead.
+          inputs.fenix.packages.${system}.latest.rustfmt
+
+          toolchain
+        ]
+        ++ (with pkgsHost.pkgs; [
+          engage
+          cargo-audit
+
+          # Required by hardened-malloc.rs dep
+          binutils
+
+          # Needed for producing Debian packages
+          cargo-deb
+
+          # Needed for CI to check validity of produced Debian packages (dpkg-deb)
+          dpkg
+
+          # Needed for Complement
+          go
+
+          # Needed for our script for Complement
+          jq
+
+          # Needed for finding broken markdown links
+          lychee
+
+          # Needed for linting markdown files
+          markdownlint-cli
+
+          # Useful for editing the book locally
+          mdbook
+
+          # used for rust caching in CI to speed it up
+          sccache
+
+          # needed so we can get rid of gcc and other unused deps that bloat OCI images
+          removeReferencesTo
+        ]
+        # liburing is Linux-exclusive
+        ++ lib.optional stdenv.hostPlatform.isLinux liburing
+        # needed to build Rust applications on macOS
+        ++ lib.optionals stdenv.hostPlatform.isDarwin [
+            # https://github.com/NixOS/nixpkgs/issues/206242
+            # ld: library not found for -liconv
+            libiconv
+            # https://stackoverflow.com/questions/69869574/properly-adding-darwin-apple-sdk-to-a-nix-shell
+            # https://discourse.nixos.org/t/compile-a-rust-binary-on-macos-dbcrossbar/8612
+            pkgsBuildHost.darwin.apple_sdk.frameworks.Security
+            ])
+        ++ scope.main.buildInputs
+        ++ scope.main.propagatedBuildInputs
+        ++ scope.main.nativeBuildInputs;
+      };
     in
     {
       packages = {
         default = scopeHost.main;
-        jemalloc = scopeHost.main.override { features = ["jemalloc"]; };
+        default-debug = scopeHost.main.override {
+            profile = "dev";
+            # debug build users expect full logs
+            disable_release_max_log_level = true;
+        };
+        default-test = scopeHost.main.override {
+            profile = "test";
+            disable_release_max_log_level = true;
+        };
+        all-features = scopeHost.main.override {
+            all_features = true;
+            disable_features = [
+                # this is non-functional on nix for some reason
+                "hardened_malloc"
+                # dont include experimental features
+                "experimental"
+            ];
+        };
+        all-features-debug = scopeHost.main.override {
+            profile = "dev";
+            all_features = true;
+            # debug build users expect full logs
+            disable_release_max_log_level = true;
+            disable_features = [
+                # this is non-functional on nix for some reason
+                "hardened_malloc"
+                # dont include experimental features
+                "experimental"
+            ];
+        };
         hmalloc = scopeHost.main.override { features = ["hardened_malloc"]; };
 
         oci-image = scopeHost.oci-image;
-        oci-image-jemalloc = scopeHost.oci-image.override {
+        oci-image-all-features = scopeHost.oci-image.override {
           main = scopeHost.main.override {
-            features = ["jemalloc"];
+            all_features = true;
+            disable_features = [
+                # this is non-functional on nix for some reason
+                "hardened_malloc"
+                # dont include experimental features
+                "experimental"
+            ];
+          };
+        };
+        oci-image-all-features-debug = scopeHost.oci-image.override {
+          main = scopeHost.main.override {
+            profile = "dev";
+            all_features = true;
+            # debug build users expect full logs
+            disable_release_max_log_level = true;
+            disable_features = [
+                # this is non-functional on nix for some reason
+                "hardened_malloc"
+                # dont include experimental features
+                "experimental"
+            ];
           };
         };
         oci-image-hmalloc = scopeHost.oci-image.override {
@@ -63,6 +253,9 @@
         book = scopeHost.book;
 
         complement = scopeHost.complement;
+        static-complement = scopeHostStatic.complement;
+        # macOS containers don't exist, so the complement images must be forced to linux
+        linux-complement = (mkCrossScope "${pkgsHost.hostPlatform.qemuArch}-linux-musl").complement;
       }
       //
       builtins.listToAttrs
@@ -71,14 +264,7 @@
             (crossSystem:
               let
                 binaryName = "static-${crossSystem}";
-                pkgsCrossStatic =
-                  (import inputs.nixpkgs {
-                    inherit system;
-                    crossSystem = {
-                      config = crossSystem;
-                    };
-                  }).pkgsStatic;
-                scopeCrossStatic = scope pkgsCrossStatic;
+                scopeCrossStatic = mkCrossScope crossSystem;
               in
               [
                 # An output for a statically-linked binary
@@ -87,11 +273,54 @@
                   value = scopeCrossStatic.main;
                 }
 
-                # An output for a statically-linked binary with jemalloc
+                # An output for a statically-linked unstripped debug ("dev") binary
                 {
-                  name = "${binaryName}-jemalloc";
+                  name = "${binaryName}-debug";
                   value = scopeCrossStatic.main.override {
-                    features = ["jemalloc"];
+                    profile = "dev";
+                    # debug build users expect full logs
+                    disable_release_max_log_level = true;
+                  };
+                }
+
+                # An output for a statically-linked unstripped debug binary with the
+                # "test" profile (for CI usage only)
+                {
+                  name = "${binaryName}-test";
+                  value = scopeCrossStatic.main.override {
+                    profile = "test";
+                    disable_release_max_log_level = true;
+                  };
+                }
+
+                # An output for a statically-linked binary with `--all-features`
+                {
+                  name = "${binaryName}-all-features";
+                  value = scopeCrossStatic.main.override {
+                    all_features = true;
+                    disable_features = [
+                        # this is non-functional on nix for some reason
+                        "hardened_malloc"
+                        # dont include experimental features
+                        "experimental"
+                    ];
+                  };
+                }
+
+                # An output for a statically-linked unstripped debug ("dev") binary with `--all-features`
+                {
+                  name = "${binaryName}-all-features-debug";
+                  value = scopeCrossStatic.main.override {
+                    profile = "dev";
+                    all_features = true;
+                    # debug build users expect full logs
+                    disable_release_max_log_level = true;
+                    disable_features = [
+                        # this is non-functional on nix for some reason
+                        "hardened_malloc"
+                        # dont include experimental features
+                        "experimental"
+                    ];
                   };
                 }
 
@@ -109,12 +338,49 @@
                   value = scopeCrossStatic.oci-image;
                 }
 
-                # An output for an OCI image based on that binary with jemalloc
+                # An output for an OCI image based on that unstripped debug ("dev") binary
                 {
-                  name = "oci-image-${crossSystem}-jemalloc";
+                  name = "oci-image-${crossSystem}-debug";
                   value = scopeCrossStatic.oci-image.override {
                     main = scopeCrossStatic.main.override {
-                      features = ["jemalloc"];
+                        profile = "dev";
+                        # debug build users expect full logs
+                        disable_release_max_log_level = true;
+                    };
+                  };
+                }
+
+                # An output for an OCI image based on that binary with `--all-features`
+                {
+                  name = "oci-image-${crossSystem}-all-features";
+                  value = scopeCrossStatic.oci-image.override {
+                    main = scopeCrossStatic.main.override {
+                      all_features = true;
+                      disable_features = [
+                          # this is non-functional on nix for some reason
+                          "hardened_malloc"
+                          # dont include experimental features
+                          "experimental"
+                      ];
+                    };
+                  };
+                }
+
+                # An output for an OCI image based on that unstripped debug ("dev") binary with `--all-features`
+                {
+                  name = "oci-image-${crossSystem}-all-features-debug";
+                  value = scopeCrossStatic.oci-image.override {
+                    main = scopeCrossStatic.main.override {
+                        profile = "dev";
+                        all_features = true;
+                        # debug build users expect full logs
+                        disable_release_max_log_level = true;
+                        disable_features = [
+                            # this is non-functional on nix for some reason
+                            "hardened_malloc"
+                            # dont include experimental features
+                            "experimental"
+                        ];
                     };
                   };
                 }
@@ -128,59 +394,41 @@
                     };
                   };
                 }
+
+                # An output for a complement OCI image for the specified platform
+                {
+                  name = "complement-${crossSystem}";
+                  value = scopeCrossStatic.complement;
+                }
               ]
             )
             [
-              "x86_64-unknown-linux-musl"
-              "aarch64-unknown-linux-musl"
+              #"x86_64-apple-darwin"
+              #"aarch64-apple-darwin"
+              "x86_64-linux-gnu"
+              "x86_64-linux-musl"
+              "aarch64-linux-musl"
             ]
           )
         );
 
-      devShells.default = pkgsHost.mkShell {
-        env = scopeHost.main.env // {
-          # Rust Analyzer needs to be able to find the path to default crate
-          # sources, and it can read this environment variable to do so. The
-          # `rust-src` component is required in order for this to work.
-          RUST_SRC_PATH = "${toolchain}/lib/rustlib/src/rust/library";
-
-          # Convenient way to access a pinned version of Complement's source
-          # code.
-          COMPLEMENT_SRC = inputs.complement.outPath;
+      devShells.default = mkDevShell scopeHostStatic;
+      devShells.all-features = mkDevShell
+        (scopeHostStatic.overrideScope (final: prev: {
+          main = prev.main.override {
+            all_features = true;
+            disable_features = [
+                # this is non-functional on nix for some reason
+                "hardened_malloc"
+                # dont include experimental features
+                "experimental"
+            ];
         };
-
-        # Development tools
-        packages = [
-          # Always use nightly rustfmt because most of its options are unstable
-          #
-          # This needs to come before `toolchain` in this list, otherwise
-          # `$PATH` will have stable rustfmt instead.
-          inputs.fenix.packages.${system}.latest.rustfmt
-
-          toolchain
-        ]
-        ++ (with pkgsHost; [
-          engage
-          cargo-audit
-
-          # Needed for producing Debian packages
-          cargo-deb
-
-          # Needed for Complement
-          go
-          olm
-
-          # Needed for our script for Complement
-          jq
-
-          # Needed for finding broken markdown links
-          lychee
-
-          # Useful for editing the book locally
-          mdbook
-        ])
-        ++
-        scopeHost.main.nativeBuildInputs;
-      };
+        }));
+      devShells.no-features = mkDevShell
+        (scopeHostStatic.overrideScope (final: prev: {
+          main = prev.main.override { default_features = false; };
+        }));
+      devShells.dynamic = mkDevShell scopeHost;
     });
 }

nix/pkgs/book/default.nix

@@ -14,9 +14,15 @@ stdenv.mkDerivation {
     include = [
       "book.toml"
       "conduwuit-example.toml"
+      "CODE_OF_CONDUCT.md"
+      "CONTRIBUTING.md"
       "README.md"
+      "development.md"
+      "debian/conduwuit.service"
       "debian/README.md"
+      "arch/conduwuit.service"
       "docs"
+      "theme"
     ];
   };
 
@@ -25,7 +31,6 @@ stdenv.mkDerivation {
   ];
 
   buildPhase = ''
-    mdbook build
-    mv public $out
+    mdbook build -d $out
   '';
 }

nix/pkgs/complement/config.toml

@@ -5,13 +5,18 @@ allow_guest_registration = true
 allow_public_room_directory_over_federation = true
 allow_public_room_directory_without_auth = true
 allow_registration = true
-allow_unstable_room_versions = true
-database_backend = "rocksdb"
 database_path = "/database"
-log = "trace"
+log = "trace,h2=warn,hyper=warn"
 port = [8008, 8448]
 trusted_servers = []
+query_trusted_key_servers_first = false
 yes_i_am_very_very_sure_i_want_an_open_registration_server_prone_to_abuse = true
+ip_range_denylist = []
+url_preview_domain_contains_allowlist = ["*"]
+media_compat_file_link = false
+media_startup_check = false
+rocksdb_direct_io = false
+log_colors = false
 
 [global.tls]
 certs = "/certificate.crt"

nix/pkgs/complement/default.nix

@@ -14,8 +14,25 @@
 
 let
   main' = main.override {
-    profile = "dev";
-    features = ["axum_dual_protocol"];
+    profile = "test";
+    all_features = true;
+    disable_release_max_log_level = true;
+    disable_features = [
+        # no reason to use jemalloc for complement, just has compatibility/build issues
+        "jemalloc"
+        # console/CLI stuff isn't used or relevant for complement
+        "console"
+        "tokio_console"
+        # sentry telemetry isn't useful for complement, disabled by default anyways
+        "sentry_telemetry"
+        "perf_measurements"
+        # the containers don't use or need systemd signal support
+        "systemd"
+        # this is non-functional on nix for some reason
+        "hardened_malloc"
+        # dont include experimental features
+        "experimental"
+    ];
   };
 
   start = writeShellScriptBin "start" ''
@@ -44,16 +61,14 @@ let
       -sha256
 
     ${lib.getExe' coreutils "env"} \
-      CONDUIT_SERVER_NAME="$SERVER_NAME" \
-      CONDUIT_WELL_KNOWN_SERVER="$SERVER_NAME:8448" \
-      CONDUIT_WELL_KNOWN_SERVER="$SERVER_NAME:8008" \
+      CONDUWUIT_SERVER_NAME="$SERVER_NAME" \
       ${lib.getExe main'}
   '';
 in
 
 dockerTools.buildImage {
-  name = "complement-${main.pname}";
-  tag = "dev";
+  name = "complement-conduwuit";
+  tag = "main";
 
   copyToRoot = buildEnv {
     name = "root";
@@ -73,7 +88,7 @@ dockerTools.buildImage {
       "${lib.getExe start}"
     ];
 
-    Entrypoint = if !stdenv.isDarwin
+    Entrypoint = if !stdenv.hostPlatform.isDarwin
       # Use the `tini` init system so that signals (e.g. ctrl+c/SIGINT)
       # are handled as expected
       then [ "${lib.getExe' tini "tini"}" "--" ]
@@ -81,7 +96,8 @@ dockerTools.buildImage {
 
     Env = [
       "SSL_CERT_FILE=/complement/ca/ca.crt"
-      "CONDUIT_CONFIG=${./config.toml}"
+      "CONDUWUIT_CONFIG=${./config.toml}"
+      "RUST_BACKTRACE=full"
     ];
 
     ExposedPorts = {

nix/pkgs/main/cross-compilation-env.nix

@@ -1,5 +1,6 @@
 { lib
 , pkgsBuildHost
+, pkgsBuildTarget
 , rust
 , stdenv
 }:
@@ -35,7 +36,7 @@ lib.optionalAttrs stdenv.hostPlatform.isStatic {
             # including it here. Linkers are weird.
             (stdenv.hostPlatform.isAarch64 || stdenv.hostPlatform.isx86_64)
               && stdenv.hostPlatform.isStatic
-              && !stdenv.isDarwin
+              && !stdenv.hostPlatform.isDarwin
               && !stdenv.cc.bintools.isLLVM
           )
           [
@@ -52,11 +53,12 @@ lib.optionalAttrs stdenv.hostPlatform.isStatic {
 # even covers the case of build scripts that need native code compiled and
 # run on the build platform (I think).
 #
-# [0]: https://github.com/NixOS/nixpkgs/blob/5cdb38bb16c6d0a38779db14fcc766bc1b2394d6/pkgs/build-support/rust/lib/default.nix#L57-L80
+# [0]: https://github.com/NixOS/nixpkgs/blob/nixpkgs-unstable/pkgs/build-support/rust/lib/default.nix#L48-L68
 //
 (
   let
     inherit (rust.lib) envVars;
+    shouldUseLLD = platform: platform.isAarch64 && platform.isStatic && !stdenv.hostPlatform.isDarwin;
   in
   lib.optionalAttrs
     (stdenv.targetPlatform.rust.rustcTarget
@@ -64,23 +66,30 @@ lib.optionalAttrs stdenv.hostPlatform.isStatic {
     (
       let
         inherit (stdenv.targetPlatform.rust) cargoEnvVarTarget;
+        linkerForTarget = if shouldUseLLD stdenv.targetPlatform
+          && !stdenv.cc.bintools.isLLVM # whether stdenv's linker is lld already
+          then "${pkgsBuildTarget.llvmPackages.bintools}/bin/${stdenv.cc.targetPrefix}ld.lld"
+          else envVars.ccForTarget;
       in
       {
         "CC_${cargoEnvVarTarget}" = envVars.ccForTarget;
         "CXX_${cargoEnvVarTarget}" = envVars.cxxForTarget;
-        "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" =
-          envVars.linkerForTarget;
+        "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" = linkerForTarget;
       }
     )
   //
   (
     let
       inherit (stdenv.hostPlatform.rust) cargoEnvVarTarget rustcTarget;
+      linkerForHost = if shouldUseLLD stdenv.targetPlatform
+        && !stdenv.cc.bintools.isLLVM
+        then "${pkgsBuildHost.llvmPackages.bintools}/bin/${stdenv.cc.targetPrefix}ld.lld"
+        else envVars.ccForHost;
     in
     {
       "CC_${cargoEnvVarTarget}" = envVars.ccForHost;
       "CXX_${cargoEnvVarTarget}" = envVars.cxxForHost;
-      "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" = envVars.linkerForHost;
+      "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" = linkerForHost;
       CARGO_BUILD_TARGET = rustcTarget;
     }
   )
@@ -92,7 +101,7 @@ lib.optionalAttrs stdenv.hostPlatform.isStatic {
     {
       "CC_${cargoEnvVarTarget}" = envVars.ccForBuild;
       "CXX_${cargoEnvVarTarget}" = envVars.cxxForBuild;
-      "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" = envVars.linkerForBuild;
+      "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" = envVars.ccForBuild;
       HOST_CC = "${pkgsBuildHost.stdenv.cc}/bin/cc";
       HOST_CXX = "${pkgsBuildHost.stdenv.cc}/bin/c++";
     }

nix/pkgs/main/default.nix

@@ -1,27 +1,91 @@
 # Dependencies (keep sorted)
 { craneLib
 , inputs
+, jq
 , lib
 , libiconv
+, liburing
 , pkgsBuildHost
+, pkgsBuildTarget
 , rocksdb
+, removeReferencesTo
 , rust
+, rust-jemalloc-sys
 , stdenv
 
 # Options (keep sorted)
 , default_features ? true
+, disable_release_max_log_level ? false
+, all_features ? false
+, disable_features ? []
 , features ? []
 , profile ? "release"
 }:
 
 let
+# We perform default-feature unification in nix, because some of the dependencies
+# on the nix side depend on feature values.
+crateFeatures = path:
+  let manifest = lib.importTOML "${path}/Cargo.toml"; in
+  lib.remove "default" (lib.attrNames manifest.features);
+crateDefaultFeatures = path:
+  (lib.importTOML "${path}/Cargo.toml").features.default;
+allDefaultFeatures = crateDefaultFeatures "${inputs.self}/src/main";
+allFeatures = crateFeatures "${inputs.self}/src/main";
+features' = lib.unique
+  (features ++
+    lib.optionals default_features allDefaultFeatures ++
+    lib.optionals all_features allFeatures);
+disable_features' = disable_features ++ lib.optionals disable_release_max_log_level ["release_max_log_level"];
+features'' = lib.subtractLists disable_features' features';
+
+featureEnabled = feature : builtins.elem feature features'';
+
+enableLiburing = featureEnabled "io_uring" && !stdenv.hostPlatform.isDarwin;
+
+# This derivation will set the JEMALLOC_OVERRIDE variable, causing the
+# tikv-jemalloc-sys crate to use the nixpkgs jemalloc instead of building it's
+# own. In order for this to work, we need to set flags on the build that match
+# whatever flags tikv-jemalloc-sys was going to use. These are dependent on
+# which features we enable in tikv-jemalloc-sys.
+rust-jemalloc-sys' = (rust-jemalloc-sys.override {
+  # tikv-jemalloc-sys/unprefixed_malloc_on_supported_platforms feature
+  unprefixed = true;
+}).overrideAttrs (old: {
+  configureFlags = old.configureFlags ++
+    # we dont need docs
+    [ "--disable-doc" ] ++
+    # we dont need cxx/C++ integration
+    [ "--disable-cxx" ] ++
+    # tikv-jemalloc-sys/profiling feature
+    lib.optional (featureEnabled "jemalloc_prof") "--enable-prof" ++
+    # tikv-jemalloc-sys/stats feature
+    (if (featureEnabled "jemalloc_stats") then [ "--enable-stats" ] else [ "--disable-stats" ]);
+});
+
 buildDepsOnlyEnv =
   let
-    rocksdb' = rocksdb.override {
-      enableJemalloc = builtins.elem "jemalloc" features;
-    };
+    rocksdb' = (rocksdb.override {
+      jemalloc = rust-jemalloc-sys';
+      # rocksdb fails to build with prefixed jemalloc, which is required on
+      # darwin due to [1]. In this case, fall back to building rocksdb with
+      # libc malloc. This should not cause conflicts, because all of the
+      # jemalloc symbols are prefixed.
+      #
+      # [1]: https://github.com/tikv/jemallocator/blob/ab0676d77e81268cd09b059260c75b38dbef2d51/jemalloc-sys/src/env.rs#L17
+      enableJemalloc = featureEnabled "jemalloc" && !stdenv.hostPlatform.isDarwin;
+
+      # for some reason enableLiburing in nixpkgs rocksdb is default true
+      # which breaks Darwin entirely
+      enableLiburing = enableLiburing;
+    }).overrideAttrs (old: {
+      enableLiburing = enableLiburing;
+    });
   in
   {
+    # https://crane.dev/faq/rebuilds-bindgen.html
+    NIX_OUTPATH_USED_AS_RANDOM_SEED = "aaaaaaaaaa";
+
     CARGO_PROFILE = profile;
     ROCKSDB_INCLUDE_DIR = "${rocksdb'}/include";
     ROCKSDB_LIB_DIR = "${rocksdb'}/lib";
@@ -32,13 +96,21 @@ buildDepsOnlyEnv =
     inherit
       lib
       pkgsBuildHost
+      pkgsBuildTarget
       rust
       stdenv;
   });
 
 buildPackageEnv = {
-  CONDUWUIT_VERSION_EXTRA = inputs.self.shortRev or inputs.self.dirtyShortRev;
-} // buildDepsOnlyEnv;
+  CONDUWUIT_VERSION_EXTRA = inputs.self.shortRev or inputs.self.dirtyShortRev or "";
+} // buildDepsOnlyEnv // {
+  # Only needed in static stdenv because these are transitive dependencies of rocksdb
+  CARGO_BUILD_RUSTFLAGS = buildDepsOnlyEnv.CARGO_BUILD_RUSTFLAGS
+    + lib.optionalString (enableLiburing && stdenv.hostPlatform.isStatic)
+      " -L${lib.getLib liburing}/lib -luring";
+};
+
+
 
 commonAttrs = {
   inherit
@@ -55,18 +127,57 @@ commonAttrs = {
       include = [
         "Cargo.lock"
         "Cargo.toml"
-        "hot_lib"
+        "deps"
         "src"
       ];
     };
 
+    dontStrip = profile == "dev" || profile == "test";
+    dontPatchELF = profile == "dev" || profile == "test";
+
+    buildInputs = lib.optional (featureEnabled "jemalloc") rust-jemalloc-sys'
+    # needed to build Rust applications on macOS
+    ++ lib.optionals stdenv.hostPlatform.isDarwin [
+        # https://github.com/NixOS/nixpkgs/issues/206242
+        # ld: library not found for -liconv
+        libiconv
+        # https://stackoverflow.com/questions/69869574/properly-adding-darwin-apple-sdk-to-a-nix-shell
+        # https://discourse.nixos.org/t/compile-a-rust-binary-on-macos-dbcrossbar/8612
+        pkgsBuildHost.darwin.apple_sdk.frameworks.Security
+      ];
+
     nativeBuildInputs = [
       # bindgen needs the build platform's libclang. Apparently due to "splicing
       # weirdness", pkgs.rustPlatform.bindgenHook on its own doesn't quite do the
       # right thing here.
       pkgsBuildHost.rustPlatform.bindgenHook
+
+      # We don't actually depend on `jq`, but crane's `buildPackage` does, but
+      # its `buildDepsOnly` doesn't. This causes those two derivations to have
+      # differing values for `NIX_CFLAGS_COMPILE`, which contributes to spurious
+      # rebuilds of bindgen and its depedents.
+      jq
+
+      # needed so we can get rid of gcc and other unused deps that bloat OCI images
+      removeReferencesTo
   ]
-  ++ lib.optionals stdenv.isDarwin [ libiconv ];
+  # needed to build Rust applications on macOS
+  ++ lib.optionals stdenv.hostPlatform.isDarwin [
+      # https://github.com/NixOS/nixpkgs/issues/206242
+      # ld: library not found for -liconv
+      libiconv
+
+      # https://stackoverflow.com/questions/69869574/properly-adding-darwin-apple-sdk-to-a-nix-shell
+      # https://discourse.nixos.org/t/compile-a-rust-binary-on-macos-dbcrossbar/8612
+      pkgsBuildHost.darwin.apple_sdk.frameworks.Security
+    ];
+
+    # for some reason gcc and other weird deps are added to OCI images and bloats it up
+    #
+    # <https://github.com/input-output-hk/haskell.nix/issues/829>
+    postInstall = with pkgsBuildHost; ''
+        find "$out" -type f -exec remove-references-to -t ${stdenv.cc} -t ${gcc} -t ${libgcc} -t ${llvm} -t ${libllvm} -t ${rustc.unwrapped} -t ${rustc} -t ${libidn2} -t ${libunistring} '{}' +
+    '';
  };
 in
 
@@ -75,15 +186,14 @@ craneLib.buildPackage ( commonAttrs // {
     env = buildDepsOnlyEnv;
   });
 
-  cargoExtraArgs = ""
+  cargoExtraArgs = "--no-default-features "
     + lib.optionalString
-      (!default_features)
-      "--no-default-features "
-    + lib.optionalString
-      (features != [])
-      "--features " + (builtins.concatStringsSep "," features);
+      (features'' != [])
+      "--features " + (builtins.concatStringsSep "," features'');
 
   # This is redundant with CI
+  cargoTestCommand = "";
+  cargoCheckCommand = "";
   doCheck = false;
 
   env = buildPackageEnv;

nix/pkgs/oci-image/default.nix

@@ -14,9 +14,10 @@ dockerTools.buildLayeredImage {
   created = "@${toString inputs.self.lastModified}";
   contents = [
     dockerTools.caCertificates
+    main
   ];
   config = {
-    Entrypoint = if !stdenv.isDarwin
+    Entrypoint = if !stdenv.hostPlatform.isDarwin
       # Use the `tini` init system so that signals (e.g. ctrl+c/SIGINT)
       # are handled as expected
       then [ "${lib.getExe' tini "tini"}" "--" ]
@@ -24,5 +25,8 @@ dockerTools.buildLayeredImage {
     Cmd = [
       "${lib.getExe main}"
     ];
+    Env = [
+      "RUST_BACKTRACE=full"
+    ];
   };
 }

renovate.json

@@ -11,5 +11,16 @@
   },
   "nix": {
     "enabled": true
-  }
+  },
+  "labels": [
+    "dependencies",
+    "github_actions"
+  ],
+  "ignoreDeps": [
+    "tikv-jemllocator",
+    "tikv-jemalloc-sys",
+    "tikv-jemalloc-ctl",
+    "opentelemetry-rust",
+    "tracing-opentelemetry"
+  ]
 }

rust-toolchain.toml

@@ -2,8 +2,6 @@
 #
 # Other files that need upkeep when this changes:
 #
-# * `.gitlab-ci.yml`
-# * `.github/workflows/ci.yml`
 # * `Cargo.toml`
 # * `flake.nix`
 #
@@ -11,13 +9,20 @@
 # If you're having trouble making the relevant changes, bug a maintainer.
 
 [toolchain]
-channel = "1.76.0"
+channel = "1.83.0"
+profile = "minimal"
 components = [
     # For rust-analyzer
     "rust-src",
+    "rust-analyzer",
+    # For CI and editors
+    "rustfmt",
+    "clippy",
 ]
 targets = [
+    #"x86_64-apple-darwin",
     "x86_64-unknown-linux-gnu",
     "x86_64-unknown-linux-musl",
     "aarch64-unknown-linux-musl",
+    #"aarch64-apple-darwin",
 ]

rustfmt.toml

@@ -1,28 +1,27 @@
-edition = "2021"
-
+array_width = 80
+chain_width = 60
+comment_width = 80
 condense_wildcard_suffixes = true
+edition = "2021"
+fn_call_width = 80
+fn_params_layout = "Compressed"
+fn_single_line = true
 format_code_in_doc_comments = true
 format_macro_bodies = true
 format_macro_matchers = true
 format_strings = true
-hex_literal_case = "Upper"
-max_width = 120
-tab_spaces = 4
-array_width = 80
-comment_width = 80
-wrap_comments = true
-fn_params_layout = "Compressed"
-fn_call_width = 80
-fn_single_line = true
+group_imports = "StdExternalCrate"
 hard_tabs = true
-match_block_trailing_comma = true
+hex_literal_case = "Upper"
 imports_granularity = "Crate"
+match_block_trailing_comma = true
+max_width = 120
+newline_style = "Unix"
 normalize_comments = false
 reorder_impl_items = true
 reorder_imports = true
-group_imports = "StdExternalCrate"
-newline_style = "Unix"
+tab_spaces = 4
 use_field_init_shorthand = true
 use_small_heuristics = "Off"
 use_try_shorthand = true
-chain_width = 60
+wrap_comments = true

src/admin/Cargo.toml

@@ -0,0 +1,46 @@
+[package]
+name = "conduit_admin"
+categories.workspace = true
+description.workspace = true
+edition.workspace = true
+keywords.workspace = true
+license.workspace = true
+readme.workspace = true
+repository.workspace = true
+version.workspace = true
+
+[lib]
+path = "mod.rs"
+crate-type = [
+	"rlib",
+#	"dylib",
+]
+
+[features]
+#dev_release_log_level = []
+release_max_log_level = [
+	"tracing/max_level_trace",
+	"tracing/release_max_level_info",
+	"log/max_level_trace",
+	"log/release_max_level_info",
+]
+
+[dependencies]
+clap.workspace = true
+conduit-api.workspace = true
+conduit-core.workspace = true
+conduit-database.workspace = true
+conduit-macros.workspace = true
+conduit-service.workspace = true
+const-str.workspace = true
+futures.workspace = true
+log.workspace = true
+ruma.workspace = true
+serde_json.workspace = true
+serde_yaml.workspace = true
+tokio.workspace = true
+tracing-subscriber.workspace = true
+tracing.workspace = true
+
+[lints]
+workspace = true

src/admin/admin.rs

@@ -0,0 +1,66 @@
+use clap::Parser;
+use conduit::Result;
+use ruma::events::room::message::RoomMessageEventContent;
+
+use crate::{
+	appservice, appservice::AppserviceCommand, check, check::CheckCommand, command::Command, debug,
+	debug::DebugCommand, federation, federation::FederationCommand, media, media::MediaCommand, query,
+	query::QueryCommand, room, room::RoomCommand, server, server::ServerCommand, user, user::UserCommand,
+};
+
+#[derive(Debug, Parser)]
+#[command(name = "conduwuit", version = conduit::version())]
+pub(super) enum AdminCommand {
+	#[command(subcommand)]
+	/// - Commands for managing appservices
+	Appservices(AppserviceCommand),
+
+	#[command(subcommand)]
+	/// - Commands for managing local users
+	Users(UserCommand),
+
+	#[command(subcommand)]
+	/// - Commands for managing rooms
+	Rooms(RoomCommand),
+
+	#[command(subcommand)]
+	/// - Commands for managing federation
+	Federation(FederationCommand),
+
+	#[command(subcommand)]
+	/// - Commands for managing the server
+	Server(ServerCommand),
+
+	#[command(subcommand)]
+	/// - Commands for managing media
+	Media(MediaCommand),
+
+	#[command(subcommand)]
+	/// - Commands for checking integrity
+	Check(CheckCommand),
+
+	#[command(subcommand)]
+	/// - Commands for debugging things
+	Debug(DebugCommand),
+
+	#[command(subcommand)]
+	/// - Low-level queries for database getters and iterators
+	Query(QueryCommand),
+}
+
+#[tracing::instrument(skip_all, name = "command")]
+pub(super) async fn process(command: AdminCommand, context: &Command<'_>) -> Result<RoomMessageEventContent> {
+	use AdminCommand::*;
+
+	Ok(match command {
+		Appservices(command) => appservice::process(command, context).await?,
+		Media(command) => media::process(command, context).await?,
+		Users(command) => user::process(command, context).await?,
+		Rooms(command) => room::process(command, context).await?,
+		Federation(command) => federation::process(command, context).await?,
+		Server(command) => server::process(command, context).await?,
+		Debug(command) => debug::process(command, context).await?,
+		Query(command) => query::process(command, context).await?,
+		Check(command) => check::process(command, context).await?,
+	})
+}

src/admin/appservice/commands.rs

@@ -0,0 +1,74 @@
+use ruma::{api::appservice::Registration, events::room::message::RoomMessageEventContent};
+
+use crate::{admin_command, Result};
+
+#[admin_command]
+pub(super) async fn register(&self) -> Result<RoomMessageEventContent> {
+	if self.body.len() < 2 || !self.body[0].trim().starts_with("```") || self.body.last().unwrap_or(&"").trim() != "```"
+	{
+		return Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		));
+	}
+
+	let appservice_config_body = self.body[1..self.body.len().checked_sub(1).unwrap()].join("\n");
+	let parsed_config = serde_yaml::from_str::<Registration>(&appservice_config_body);
+	match parsed_config {
+		Ok(registration) => match self
+			.services
+			.appservice
+			.register_appservice(&registration, &appservice_config_body)
+			.await
+		{
+			Ok(()) => Ok(RoomMessageEventContent::text_plain(format!(
+				"Appservice registered with ID: {}",
+				registration.id
+			))),
+			Err(e) => Ok(RoomMessageEventContent::text_plain(format!(
+				"Failed to register appservice: {e}"
+			))),
+		},
+		Err(e) => Ok(RoomMessageEventContent::text_plain(format!(
+			"Could not parse appservice config as YAML: {e}"
+		))),
+	}
+}
+
+#[admin_command]
+pub(super) async fn unregister(&self, appservice_identifier: String) -> Result<RoomMessageEventContent> {
+	match self
+		.services
+		.appservice
+		.unregister_appservice(&appservice_identifier)
+		.await
+	{
+		Ok(()) => Ok(RoomMessageEventContent::text_plain("Appservice unregistered.")),
+		Err(e) => Ok(RoomMessageEventContent::text_plain(format!(
+			"Failed to unregister appservice: {e}"
+		))),
+	}
+}
+
+#[admin_command]
+pub(super) async fn show_appservice_config(&self, appservice_identifier: String) -> Result<RoomMessageEventContent> {
+	match self
+		.services
+		.appservice
+		.get_registration(&appservice_identifier)
+		.await
+	{
+		Some(config) => {
+			let config_str = serde_yaml::to_string(&config).expect("config should've been validated on register");
+			let output = format!("Config for {appservice_identifier}:\n\n```yaml\n{config_str}\n```",);
+			Ok(RoomMessageEventContent::notice_markdown(output))
+		},
+		None => Ok(RoomMessageEventContent::text_plain("Appservice does not exist.")),
+	}
+}
+
+#[admin_command]
+pub(super) async fn list_registered(&self) -> Result<RoomMessageEventContent> {
+	let appservices = self.services.appservice.iter_ids().await;
+	let output = format!("Appservices ({}): {}", appservices.len(), appservices.join(", "));
+	Ok(RoomMessageEventContent::text_plain(output))
+}

src/admin/appservice/mod.rs

@@ -1,14 +1,13 @@
+mod commands;
+
 use clap::Subcommand;
-use ruma::events::room::message::RoomMessageEventContent;
+use conduit::Result;
 
-use self::appservice_command::{list, register, show, unregister};
-use crate::Result;
+use crate::admin_command_dispatch;
 
-pub(crate) mod appservice_command;
-
-#[cfg_attr(test, derive(Debug))]
-#[derive(Subcommand)]
-pub(crate) enum AppserviceCommand {
+#[derive(Debug, Subcommand)]
+#[admin_command_dispatch]
+pub(super) enum AppserviceCommand {
 	/// - Register an appservice using its registration YAML
 	///
 	/// This command needs a YAML generated by an appservice (such as a bridge),
@@ -29,24 +28,13 @@ pub(crate) enum AppserviceCommand {
 	/// - Show an appservice's config using its ID
 	///
 	/// You can find the ID using the `list-appservices` command.
-	Show {
+	#[clap(alias("show"))]
+	ShowAppserviceConfig {
 		/// The appservice to show
 		appservice_identifier: String,
 	},
 
 	/// - List all the currently registered appservices
-	List,
-}
-
-pub(crate) async fn process(command: AppserviceCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
-	Ok(match command {
-		AppserviceCommand::Register => register(body).await?,
-		AppserviceCommand::Unregister {
-			appservice_identifier,
-		} => unregister(body, appservice_identifier).await?,
-		AppserviceCommand::Show {
-			appservice_identifier,
-		} => show(body, appservice_identifier).await?,
-		AppserviceCommand::List => list(body).await?,
-	})
+	#[clap(alias("list"))]
+	ListRegistered,
 }

src/admin/check/commands.rs

@@ -0,0 +1,27 @@
+use conduit::Result;
+use conduit_macros::implement;
+use futures::StreamExt;
+use ruma::events::room::message::RoomMessageEventContent;
+
+use crate::Command;
+
+/// Uses the iterator in `src/database/key_value/users.rs` to iterator over
+/// every user in our database (remote and local). Reports total count, any
+/// errors if there were any, etc
+#[implement(Command, params = "<'_>")]
+pub(super) async fn check_all_users(&self) -> Result<RoomMessageEventContent> {
+	let timer = tokio::time::Instant::now();
+	let users = self.services.users.iter().collect::<Vec<_>>().await;
+	let query_time = timer.elapsed();
+
+	let total = users.len();
+	let err_count = users.iter().filter(|_user| false).count();
+	let ok_count = users.iter().filter(|_user| true).count();
+
+	let message = format!(
+		"Database query completed in {query_time:?}:\n\n```\nTotal entries: {total:?}\nFailure/Invalid user count: \
+		 {err_count:?}\nSuccess/Valid user count: {ok_count:?}\n```"
+	);
+
+	Ok(RoomMessageEventContent::notice_markdown(message))
+}

src/admin/check/mod.rs

@@ -0,0 +1,18 @@
+mod commands;
+
+use clap::Subcommand;
+use conduit::Result;
+use ruma::events::room::message::RoomMessageEventContent;
+
+use crate::Command;
+
+#[derive(Debug, Subcommand)]
+pub(super) enum CheckCommand {
+	AllUsers,
+}
+
+pub(super) async fn process(command: CheckCommand, context: &Command<'_>) -> Result<RoomMessageEventContent> {
+	Ok(match command {
+		CheckCommand::AllUsers => context.check_all_users().await?,
+	})
+}

src/admin/command.rs

@@ -0,0 +1,11 @@
+use std::time::SystemTime;
+
+use conduit_service::Services;
+use ruma::EventId;
+
+pub(crate) struct Command<'a> {
+	pub(crate) services: &'a Services,
+	pub(crate) body: &'a [&'a str],
+	pub(crate) timer: SystemTime,
+	pub(crate) reply_id: Option<&'a EventId>,
+}

src/admin/debug/commands.rs

@@ -0,0 +1,859 @@
+use std::{
+	collections::HashMap,
+	fmt::Write,
+	iter::once,
+	sync::Arc,
+	time::{Instant, SystemTime},
+};
+
+use conduit::{debug_error, err, info, trace, utils, utils::string::EMPTY, warn, Error, PduEvent, Result};
+use futures::{FutureExt, StreamExt};
+use ruma::{
+	api::{client::error::ErrorKind, federation::event::get_room_state},
+	events::room::message::RoomMessageEventContent,
+	CanonicalJsonObject, EventId, OwnedRoomOrAliasId, RoomId, RoomVersionId, ServerName,
+};
+use service::rooms::state_compressor::HashSetCompressStateEvent;
+use tracing_subscriber::EnvFilter;
+
+use crate::admin_command;
+
+#[admin_command]
+pub(super) async fn echo(&self, message: Vec<String>) -> Result<RoomMessageEventContent> {
+	let message = message.join(" ");
+
+	Ok(RoomMessageEventContent::notice_plain(message))
+}
+
+#[admin_command]
+pub(super) async fn get_auth_chain(&self, event_id: Box<EventId>) -> Result<RoomMessageEventContent> {
+	let Ok(event) = self.services.rooms.timeline.get_pdu_json(&event_id).await else {
+		return Ok(RoomMessageEventContent::notice_plain("Event not found."));
+	};
+
+	let room_id_str = event
+		.get("room_id")
+		.and_then(|val| val.as_str())
+		.ok_or_else(|| Error::bad_database("Invalid event in database"))?;
+
+	let room_id = <&RoomId>::try_from(room_id_str)
+		.map_err(|_| Error::bad_database("Invalid room id field in event in database"))?;
+
+	let start = Instant::now();
+	let count = self
+		.services
+		.rooms
+		.auth_chain
+		.event_ids_iter(room_id, once(event_id.as_ref()))
+		.await?
+		.count()
+		.await;
+
+	let elapsed = start.elapsed();
+	Ok(RoomMessageEventContent::text_plain(format!(
+		"Loaded auth chain with length {count} in {elapsed:?}"
+	)))
+}
+
+#[admin_command]
+pub(super) async fn parse_pdu(&self) -> Result<RoomMessageEventContent> {
+	if self.body.len() < 2
+		|| !self.body[0].trim().starts_with("```")
+		|| self.body.last().unwrap_or(&EMPTY).trim() != "```"
+	{
+		return Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		));
+	}
+
+	let string = self.body[1..self.body.len().saturating_sub(1)].join("\n");
+	match serde_json::from_str(&string) {
+		Ok(value) => match ruma::signatures::reference_hash(&value, &RoomVersionId::V6) {
+			Ok(hash) => {
+				let event_id = EventId::parse(format!("${hash}"));
+
+				match serde_json::from_value::<PduEvent>(serde_json::to_value(value).expect("value is json")) {
+					Ok(pdu) => Ok(RoomMessageEventContent::text_plain(format!("EventId: {event_id:?}\n{pdu:#?}"))),
+					Err(e) => Ok(RoomMessageEventContent::text_plain(format!(
+						"EventId: {event_id:?}\nCould not parse event: {e}"
+					))),
+				}
+			},
+			Err(e) => Ok(RoomMessageEventContent::text_plain(format!("Could not parse PDU JSON: {e:?}"))),
+		},
+		Err(e) => Ok(RoomMessageEventContent::text_plain(format!(
+			"Invalid json in command body: {e}"
+		))),
+	}
+}
+
+#[admin_command]
+pub(super) async fn get_pdu(&self, event_id: Box<EventId>) -> Result<RoomMessageEventContent> {
+	let mut outlier = false;
+	let mut pdu_json = self
+		.services
+		.rooms
+		.timeline
+		.get_non_outlier_pdu_json(&event_id)
+		.await;
+
+	if pdu_json.is_err() {
+		outlier = true;
+		pdu_json = self.services.rooms.timeline.get_pdu_json(&event_id).await;
+	}
+
+	match pdu_json {
+		Ok(json) => {
+			let json_text = serde_json::to_string_pretty(&json).expect("canonical json is valid json");
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"{}\n```json\n{}\n```",
+				if outlier {
+					"Outlier (Rejected / Soft Failed) PDU found in our database"
+				} else {
+					"PDU found in our database"
+				},
+				json_text
+			)))
+		},
+		Err(_) => Ok(RoomMessageEventContent::text_plain("PDU not found locally.")),
+	}
+}
+
+#[admin_command]
+pub(super) async fn get_remote_pdu_list(
+	&self, server: Box<ServerName>, force: bool,
+) -> Result<RoomMessageEventContent> {
+	if !self.services.globals.config.allow_federation {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Federation is disabled on this homeserver.",
+		));
+	}
+
+	if server == self.services.globals.server_name() {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Not allowed to send federation requests to ourselves. Please use `get-pdu` for fetching local PDUs from \
+			 the database.",
+		));
+	}
+
+	if self.body.len() < 2
+		|| !self.body[0].trim().starts_with("```")
+		|| self.body.last().unwrap_or(&EMPTY).trim() != "```"
+	{
+		return Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		));
+	}
+
+	let list = self
+		.body
+		.iter()
+		.collect::<Vec<_>>()
+		.drain(1..self.body.len().saturating_sub(1))
+		.filter_map(|pdu| EventId::parse(pdu).ok())
+		.collect::<Vec<_>>();
+
+	let mut failed_count: usize = 0;
+	let mut success_count: usize = 0;
+
+	for pdu in list {
+		if force {
+			if let Err(e) = self.get_remote_pdu(Box::from(pdu), server.clone()).await {
+				failed_count = failed_count.saturating_add(1);
+				self.services
+					.admin
+					.send_message(RoomMessageEventContent::text_plain(format!(
+						"Failed to get remote PDU, ignoring error: {e}"
+					)))
+					.await
+					.ok();
+				warn!("Failed to get remote PDU, ignoring error: {e}");
+			} else {
+				success_count = success_count.saturating_add(1);
+			}
+		} else {
+			self.get_remote_pdu(Box::from(pdu), server.clone()).await?;
+			success_count = success_count.saturating_add(1);
+		}
+	}
+
+	Ok(RoomMessageEventContent::text_plain(format!(
+		"Fetched {success_count} remote PDUs successfully with {failed_count} failures"
+	)))
+}
+
+#[admin_command]
+pub(super) async fn get_remote_pdu(
+	&self, event_id: Box<EventId>, server: Box<ServerName>,
+) -> Result<RoomMessageEventContent> {
+	if !self.services.globals.config.allow_federation {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Federation is disabled on this homeserver.",
+		));
+	}
+
+	if server == self.services.globals.server_name() {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Not allowed to send federation requests to ourselves. Please use `get-pdu` for fetching local PDUs.",
+		));
+	}
+
+	match self
+		.services
+		.sending
+		.send_federation_request(
+			&server,
+			ruma::api::federation::event::get_event::v1::Request {
+				event_id: event_id.clone().into(),
+				include_unredacted_content: None,
+			},
+		)
+		.await
+	{
+		Ok(response) => {
+			let json: CanonicalJsonObject = serde_json::from_str(response.pdu.get()).map_err(|e| {
+				warn!(
+					"Requested event ID {event_id} from server but failed to convert from RawValue to \
+					 CanonicalJsonObject (malformed event/response?): {e}"
+				);
+				Error::BadRequest(ErrorKind::Unknown, "Received response from server but failed to parse PDU")
+			})?;
+
+			trace!("Attempting to parse PDU: {:?}", &response.pdu);
+			let _parsed_pdu = {
+				let parsed_result = self
+					.services
+					.rooms
+					.event_handler
+					.parse_incoming_pdu(&response.pdu)
+					.await;
+
+				let (event_id, value, room_id) = match parsed_result {
+					Ok(t) => t,
+					Err(e) => {
+						warn!("Failed to parse PDU: {e}");
+						info!("Full PDU: {:?}", &response.pdu);
+						return Ok(RoomMessageEventContent::text_plain(format!(
+							"Failed to parse PDU remote server {server} sent us: {e}"
+						)));
+					},
+				};
+
+				vec![(event_id, value, room_id)]
+			};
+
+			info!("Attempting to handle event ID {event_id} as backfilled PDU");
+			self.services
+				.rooms
+				.timeline
+				.backfill_pdu(&server, response.pdu)
+				.boxed()
+				.await?;
+
+			let json_text = serde_json::to_string_pretty(&json).expect("canonical json is valid json");
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"{}\n```json\n{}\n```",
+				"Got PDU from specified server and handled as backfilled PDU successfully. Event body:", json_text
+			)))
+		},
+		Err(e) => Ok(RoomMessageEventContent::text_plain(format!(
+			"Remote server did not have PDU or failed sending request to remote server: {e}"
+		))),
+	}
+}
+
+#[admin_command]
+pub(super) async fn get_room_state(&self, room: OwnedRoomOrAliasId) -> Result<RoomMessageEventContent> {
+	let room_id = self.services.rooms.alias.resolve(&room).await?;
+	let room_state: Vec<_> = self
+		.services
+		.rooms
+		.state_accessor
+		.room_state_full(&room_id)
+		.await?
+		.values()
+		.map(PduEvent::to_state_event)
+		.collect();
+
+	if room_state.is_empty() {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Unable to find room state in our database (vector is empty)",
+		));
+	}
+
+	let json = serde_json::to_string_pretty(&room_state).map_err(|e| {
+		warn!("Failed converting room state vector in our database to pretty JSON: {e}");
+		Error::bad_database(
+			"Failed to convert room state events to pretty JSON, possible invalid room state events in our database",
+		)
+	})?;
+
+	Ok(RoomMessageEventContent::notice_markdown(format!("```json\n{json}\n```")))
+}
+
+#[admin_command]
+pub(super) async fn ping(&self, server: Box<ServerName>) -> Result<RoomMessageEventContent> {
+	if server == self.services.globals.server_name() {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Not allowed to send federation requests to ourselves.",
+		));
+	}
+
+	let timer = tokio::time::Instant::now();
+
+	match self
+		.services
+		.sending
+		.send_federation_request(&server, ruma::api::federation::discovery::get_server_version::v1::Request {})
+		.await
+	{
+		Ok(response) => {
+			let ping_time = timer.elapsed();
+
+			let json_text_res = serde_json::to_string_pretty(&response.server);
+
+			if let Ok(json) = json_text_res {
+				return Ok(RoomMessageEventContent::notice_markdown(format!(
+					"Got response which took {ping_time:?} time:\n```json\n{json}\n```"
+				)));
+			}
+
+			Ok(RoomMessageEventContent::text_plain(format!(
+				"Got non-JSON response which took {ping_time:?} time:\n{response:?}"
+			)))
+		},
+		Err(e) => {
+			warn!("Failed sending federation request to specified server from ping debug command: {e}");
+			Ok(RoomMessageEventContent::text_plain(format!(
+				"Failed sending federation request to specified server:\n\n{e}",
+			)))
+		},
+	}
+}
+
+#[admin_command]
+pub(super) async fn force_device_list_updates(&self) -> Result<RoomMessageEventContent> {
+	// Force E2EE device list updates for all users
+	self.services
+		.users
+		.stream()
+		.for_each(|user_id| self.services.users.mark_device_key_update(user_id))
+		.await;
+
+	Ok(RoomMessageEventContent::text_plain(
+		"Marked all devices for all users as having new keys to update",
+	))
+}
+
+#[admin_command]
+pub(super) async fn change_log_level(&self, filter: Option<String>, reset: bool) -> Result<RoomMessageEventContent> {
+	let handles = &["console"];
+
+	if reset {
+		let old_filter_layer = match EnvFilter::try_new(&self.services.globals.config.log) {
+			Ok(s) => s,
+			Err(e) => {
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"Log level from config appears to be invalid now: {e}"
+				)));
+			},
+		};
+
+		match self
+			.services
+			.server
+			.log
+			.reload
+			.reload(&old_filter_layer, Some(handles))
+		{
+			Ok(()) => {
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"Successfully changed log level back to config value {}",
+					self.services.globals.config.log
+				)));
+			},
+			Err(e) => {
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"Failed to modify and reload the global tracing log level: {e}"
+				)));
+			},
+		}
+	}
+
+	if let Some(filter) = filter {
+		let new_filter_layer = match EnvFilter::try_new(filter) {
+			Ok(s) => s,
+			Err(e) => {
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"Invalid log level filter specified: {e}"
+				)));
+			},
+		};
+
+		match self
+			.services
+			.server
+			.log
+			.reload
+			.reload(&new_filter_layer, Some(handles))
+		{
+			Ok(()) => {
+				return Ok(RoomMessageEventContent::text_plain("Successfully changed log level"));
+			},
+			Err(e) => {
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"Failed to modify and reload the global tracing log level: {e}"
+				)));
+			},
+		}
+	}
+
+	Ok(RoomMessageEventContent::text_plain("No log level was specified."))
+}
+
+#[admin_command]
+pub(super) async fn sign_json(&self) -> Result<RoomMessageEventContent> {
+	if self.body.len() < 2 || !self.body[0].trim().starts_with("```") || self.body.last().unwrap_or(&"").trim() != "```"
+	{
+		return Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		));
+	}
+
+	let string = self.body[1..self.body.len().checked_sub(1).unwrap()].join("\n");
+	match serde_json::from_str(&string) {
+		Ok(mut value) => {
+			self.services
+				.server_keys
+				.sign_json(&mut value)
+				.expect("our request json is what ruma expects");
+			let json_text = serde_json::to_string_pretty(&value).expect("canonical json is valid json");
+			Ok(RoomMessageEventContent::text_plain(json_text))
+		},
+		Err(e) => Ok(RoomMessageEventContent::text_plain(format!("Invalid json: {e}"))),
+	}
+}
+
+#[admin_command]
+pub(super) async fn verify_json(&self) -> Result<RoomMessageEventContent> {
+	if self.body.len() < 2 || !self.body[0].trim().starts_with("```") || self.body.last().unwrap_or(&"").trim() != "```"
+	{
+		return Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		));
+	}
+
+	let string = self.body[1..self.body.len().checked_sub(1).unwrap()].join("\n");
+	match serde_json::from_str::<CanonicalJsonObject>(&string) {
+		Ok(value) => match self.services.server_keys.verify_json(&value, None).await {
+			Ok(()) => Ok(RoomMessageEventContent::text_plain("Signature correct")),
+			Err(e) => Ok(RoomMessageEventContent::text_plain(format!(
+				"Signature verification failed: {e}"
+			))),
+		},
+		Err(e) => Ok(RoomMessageEventContent::text_plain(format!("Invalid json: {e}"))),
+	}
+}
+
+#[admin_command]
+pub(super) async fn verify_pdu(&self, event_id: Box<EventId>) -> Result<RoomMessageEventContent> {
+	let mut event = self.services.rooms.timeline.get_pdu_json(&event_id).await?;
+
+	event.remove("event_id");
+	let msg = match self.services.server_keys.verify_event(&event, None).await {
+		Ok(ruma::signatures::Verified::Signatures) => "signatures OK, but content hash failed (redaction).",
+		Ok(ruma::signatures::Verified::All) => "signatures and hashes OK.",
+		Err(e) => return Err(e),
+	};
+
+	Ok(RoomMessageEventContent::notice_plain(msg))
+}
+
+#[admin_command]
+#[tracing::instrument(skip(self))]
+pub(super) async fn first_pdu_in_room(&self, room_id: Box<RoomId>) -> Result<RoomMessageEventContent> {
+	if !self
+		.services
+		.rooms
+		.state_cache
+		.server_in_room(&self.services.globals.config.server_name, &room_id)
+		.await
+	{
+		return Ok(RoomMessageEventContent::text_plain(
+			"We are not participating in the room / we don't know about the room ID.",
+		));
+	}
+
+	let first_pdu = self
+		.services
+		.rooms
+		.timeline
+		.first_pdu_in_room(&room_id)
+		.await
+		.map_err(|_| Error::bad_database("Failed to find the first PDU in database"))?;
+
+	Ok(RoomMessageEventContent::text_plain(format!("{first_pdu:?}")))
+}
+
+#[admin_command]
+#[tracing::instrument(skip(self))]
+pub(super) async fn latest_pdu_in_room(&self, room_id: Box<RoomId>) -> Result<RoomMessageEventContent> {
+	if !self
+		.services
+		.rooms
+		.state_cache
+		.server_in_room(&self.services.globals.config.server_name, &room_id)
+		.await
+	{
+		return Ok(RoomMessageEventContent::text_plain(
+			"We are not participating in the room / we don't know about the room ID.",
+		));
+	}
+
+	let latest_pdu = self
+		.services
+		.rooms
+		.timeline
+		.latest_pdu_in_room(&room_id)
+		.await
+		.map_err(|_| Error::bad_database("Failed to find the latest PDU in database"))?;
+
+	Ok(RoomMessageEventContent::text_plain(format!("{latest_pdu:?}")))
+}
+
+#[admin_command]
+#[tracing::instrument(skip(self))]
+pub(super) async fn force_set_room_state_from_server(
+	&self, room_id: Box<RoomId>, server_name: Box<ServerName>,
+) -> Result<RoomMessageEventContent> {
+	if !self
+		.services
+		.rooms
+		.state_cache
+		.server_in_room(&self.services.globals.config.server_name, &room_id)
+		.await
+	{
+		return Ok(RoomMessageEventContent::text_plain(
+			"We are not participating in the room / we don't know about the room ID.",
+		));
+	}
+
+	let first_pdu = self
+		.services
+		.rooms
+		.timeline
+		.latest_pdu_in_room(&room_id)
+		.await
+		.map_err(|_| Error::bad_database("Failed to find the latest PDU in database"))?;
+
+	let room_version = self.services.rooms.state.get_room_version(&room_id).await?;
+
+	let mut state: HashMap<u64, Arc<EventId>> = HashMap::new();
+
+	let remote_state_response = self
+		.services
+		.sending
+		.send_federation_request(
+			&server_name,
+			get_room_state::v1::Request {
+				room_id: room_id.clone().into(),
+				event_id: first_pdu.event_id.clone().into(),
+			},
+		)
+		.await?;
+
+	for pdu in remote_state_response.pdus.clone() {
+		match self
+			.services
+			.rooms
+			.event_handler
+			.parse_incoming_pdu(&pdu)
+			.await
+		{
+			Ok(t) => t,
+			Err(e) => {
+				warn!("Could not parse PDU, ignoring: {e}");
+				continue;
+			},
+		};
+	}
+
+	info!("Going through room_state response PDUs");
+	for result in remote_state_response.pdus.iter().map(|pdu| {
+		self.services
+			.server_keys
+			.validate_and_add_event_id(pdu, &room_version)
+	}) {
+		let Ok((event_id, value)) = result.await else {
+			continue;
+		};
+
+		let pdu = PduEvent::from_id_val(&event_id, value.clone()).map_err(|e| {
+			debug_error!("Invalid PDU in fetching remote room state PDUs response: {value:#?}");
+			err!(BadServerResponse(debug_error!("Invalid PDU in send_join response: {e:?}")))
+		})?;
+
+		self.services
+			.rooms
+			.outlier
+			.add_pdu_outlier(&event_id, &value);
+
+		if let Some(state_key) = &pdu.state_key {
+			let shortstatekey = self
+				.services
+				.rooms
+				.short
+				.get_or_create_shortstatekey(&pdu.kind.to_string().into(), state_key)
+				.await;
+
+			state.insert(shortstatekey, pdu.event_id.clone());
+		}
+	}
+
+	info!("Going through auth_chain response");
+	for result in remote_state_response.auth_chain.iter().map(|pdu| {
+		self.services
+			.server_keys
+			.validate_and_add_event_id(pdu, &room_version)
+	}) {
+		let Ok((event_id, value)) = result.await else {
+			continue;
+		};
+
+		self.services
+			.rooms
+			.outlier
+			.add_pdu_outlier(&event_id, &value);
+	}
+
+	let new_room_state = self
+		.services
+		.rooms
+		.event_handler
+		.resolve_state(room_id.clone().as_ref(), &room_version, state)
+		.await?;
+
+	info!("Forcing new room state");
+	let HashSetCompressStateEvent {
+		shortstatehash: short_state_hash,
+		added,
+		removed,
+	} = self
+		.services
+		.rooms
+		.state_compressor
+		.save_state(room_id.clone().as_ref(), new_room_state)
+		.await?;
+
+	let state_lock = self.services.rooms.state.mutex.lock(&room_id).await;
+	self.services
+		.rooms
+		.state
+		.force_state(room_id.clone().as_ref(), short_state_hash, added, removed, &state_lock)
+		.await?;
+
+	info!(
+		"Updating joined counts for room just in case (e.g. we may have found a difference in the room's \
+		 m.room.member state"
+	);
+	self.services
+		.rooms
+		.state_cache
+		.update_joined_count(&room_id)
+		.await;
+
+	drop(state_lock);
+
+	Ok(RoomMessageEventContent::text_plain(
+		"Successfully forced the room state from the requested remote server.",
+	))
+}
+
+#[admin_command]
+pub(super) async fn get_signing_keys(
+	&self, server_name: Option<Box<ServerName>>, notary: Option<Box<ServerName>>, query: bool,
+) -> Result<RoomMessageEventContent> {
+	let server_name = server_name.unwrap_or_else(|| self.services.server.config.server_name.clone().into());
+
+	if let Some(notary) = notary {
+		let signing_keys = self
+			.services
+			.server_keys
+			.notary_request(&notary, &server_name)
+			.await?;
+
+		return Ok(RoomMessageEventContent::notice_markdown(format!(
+			"```rs\n{signing_keys:#?}\n```"
+		)));
+	}
+
+	let signing_keys = if query {
+		self.services
+			.server_keys
+			.server_request(&server_name)
+			.await?
+	} else {
+		self.services
+			.server_keys
+			.signing_keys_for(&server_name)
+			.await?
+	};
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"```rs\n{signing_keys:#?}\n```"
+	)))
+}
+
+#[admin_command]
+pub(super) async fn get_verify_keys(&self, server_name: Option<Box<ServerName>>) -> Result<RoomMessageEventContent> {
+	let server_name = server_name.unwrap_or_else(|| self.services.server.config.server_name.clone().into());
+
+	let keys = self
+		.services
+		.server_keys
+		.verify_keys_for(&server_name)
+		.await;
+
+	let mut out = String::new();
+	writeln!(out, "| Key ID | Public Key |")?;
+	writeln!(out, "| --- | --- |")?;
+	for (key_id, key) in keys {
+		writeln!(out, "| {key_id} | {key:?} |")?;
+	}
+
+	Ok(RoomMessageEventContent::notice_markdown(out))
+}
+
+#[admin_command]
+pub(super) async fn resolve_true_destination(
+	&self, server_name: Box<ServerName>, no_cache: bool,
+) -> Result<RoomMessageEventContent> {
+	if !self.services.globals.config.allow_federation {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Federation is disabled on this homeserver.",
+		));
+	}
+
+	if server_name == self.services.globals.config.server_name {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Not allowed to send federation requests to ourselves. Please use `get-pdu` for fetching local PDUs.",
+		));
+	}
+
+	let actual = self
+		.services
+		.resolver
+		.resolve_actual_dest(&server_name, !no_cache)
+		.await?;
+
+	let msg = format!("Destination: {}\nHostname URI: {}", actual.dest, actual.host,);
+
+	Ok(RoomMessageEventContent::text_markdown(msg))
+}
+
+#[admin_command]
+pub(super) async fn memory_stats(&self) -> Result<RoomMessageEventContent> {
+	let html_body = conduit::alloc::memory_stats();
+
+	if html_body.is_none() {
+		return Ok(RoomMessageEventContent::text_plain(
+			"malloc stats are not supported on your compiled malloc.",
+		));
+	}
+
+	Ok(RoomMessageEventContent::text_html(
+		"This command's output can only be viewed by clients that render HTML.".to_owned(),
+		html_body.expect("string result"),
+	))
+}
+
+#[cfg(tokio_unstable)]
+#[admin_command]
+pub(super) async fn runtime_metrics(&self) -> Result<RoomMessageEventContent> {
+	let out = self.services.server.metrics.runtime_metrics().map_or_else(
+		|| "Runtime metrics are not available.".to_owned(),
+		|metrics| format!("```rs\n{metrics:#?}\n```"),
+	);
+
+	Ok(RoomMessageEventContent::text_markdown(out))
+}
+
+#[cfg(not(tokio_unstable))]
+#[admin_command]
+pub(super) async fn runtime_metrics(&self) -> Result<RoomMessageEventContent> {
+	Ok(RoomMessageEventContent::text_markdown(
+		"Runtime metrics require building with `tokio_unstable`.",
+	))
+}
+
+#[cfg(tokio_unstable)]
+#[admin_command]
+pub(super) async fn runtime_interval(&self) -> Result<RoomMessageEventContent> {
+	let out = self.services.server.metrics.runtime_interval().map_or_else(
+		|| "Runtime metrics are not available.".to_owned(),
+		|metrics| format!("```rs\n{metrics:#?}\n```"),
+	);
+
+	Ok(RoomMessageEventContent::text_markdown(out))
+}
+
+#[cfg(not(tokio_unstable))]
+#[admin_command]
+pub(super) async fn runtime_interval(&self) -> Result<RoomMessageEventContent> {
+	Ok(RoomMessageEventContent::text_markdown(
+		"Runtime metrics require building with `tokio_unstable`.",
+	))
+}
+
+#[admin_command]
+pub(super) async fn time(&self) -> Result<RoomMessageEventContent> {
+	let now = SystemTime::now();
+	Ok(RoomMessageEventContent::text_markdown(utils::time::format(now, "%+")))
+}
+
+#[admin_command]
+pub(super) async fn list_dependencies(&self, names: bool) -> Result<RoomMessageEventContent> {
+	if names {
+		let out = info::cargo::dependencies_names().join(" ");
+		return Ok(RoomMessageEventContent::notice_markdown(out));
+	}
+
+	let deps = info::cargo::dependencies();
+	let mut out = String::new();
+	writeln!(out, "| name | version | features |")?;
+	writeln!(out, "| ---- | ------- | -------- |")?;
+	for (name, dep) in deps {
+		let version = dep.try_req().unwrap_or("*");
+		let feats = dep.req_features();
+		let feats = if !feats.is_empty() {
+			feats.join(" ")
+		} else {
+			String::new()
+		};
+		writeln!(out, "{name} | {version} | {feats}")?;
+	}
+
+	Ok(RoomMessageEventContent::notice_markdown(out))
+}
+
+#[admin_command]
+pub(super) async fn database_stats(
+	&self, property: Option<String>, map: Option<String>,
+) -> Result<RoomMessageEventContent> {
+	let property = property.unwrap_or_else(|| "rocksdb.stats".to_owned());
+	let map_name = map.as_ref().map_or(EMPTY, String::as_str);
+
+	let mut out = String::new();
+	for (name, map) in self.services.db.iter() {
+		if !map_name.is_empty() && *map_name != *name {
+			continue;
+		}
+
+		let res = map.property(&property)?;
+		let res = res.trim();
+		writeln!(out, "##### {name}:\n```\n{res}\n```")?;
+	}
+
+	Ok(RoomMessageEventContent::notice_markdown(out))
+}

src/admin/debug/mod.rs

@@ -0,0 +1,215 @@
+mod commands;
+pub(crate) mod tester;
+
+use clap::Subcommand;
+use conduit::Result;
+use ruma::{EventId, OwnedRoomOrAliasId, RoomId, ServerName};
+
+use self::tester::TesterCommand;
+use crate::admin_command_dispatch;
+
+#[admin_command_dispatch]
+#[derive(Debug, Subcommand)]
+pub(super) enum DebugCommand {
+	/// - Echo input of admin command
+	Echo {
+		message: Vec<String>,
+	},
+
+	/// - Get the auth_chain of a PDU
+	GetAuthChain {
+		/// An event ID (the $ character followed by the base64 reference hash)
+		event_id: Box<EventId>,
+	},
+
+	/// - Parse and print a PDU from a JSON
+	///
+	/// The PDU event is only checked for validity and is not added to the
+	/// database.
+	///
+	/// This command needs a JSON blob provided in a Markdown code block below
+	/// the command.
+	ParsePdu,
+
+	/// - Retrieve and print a PDU by ID from the conduwuit database
+	GetPdu {
+		/// An event ID (a $ followed by the base64 reference hash)
+		event_id: Box<EventId>,
+	},
+
+	/// - Attempts to retrieve a PDU from a remote server. Inserts it into our
+	///   database/timeline if found and we do not have this PDU already
+	///   (following normal event auth rules, handles it as an incoming PDU).
+	GetRemotePdu {
+		/// An event ID (a $ followed by the base64 reference hash)
+		event_id: Box<EventId>,
+
+		/// Argument for us to attempt to fetch the event from the
+		/// specified remote server.
+		server: Box<ServerName>,
+	},
+
+	/// - Same as `get-remote-pdu` but accepts a codeblock newline delimited
+	///   list of PDUs and a single server to fetch from
+	GetRemotePduList {
+		/// Argument for us to attempt to fetch all the events from the
+		/// specified remote server.
+		server: Box<ServerName>,
+
+		/// If set, ignores errors, else stops at the first error/failure.
+		#[arg(short, long)]
+		force: bool,
+	},
+
+	/// - Gets all the room state events for the specified room.
+	///
+	/// This is functionally equivalent to `GET
+	/// /_matrix/client/v3/rooms/{roomid}/state`, except the admin command does
+	/// *not* check if the sender user is allowed to see state events. This is
+	/// done because it's implied that server admins here have database access
+	/// and can see/get room info themselves anyways if they were malicious
+	/// admins.
+	///
+	/// Of course the check is still done on the actual client API.
+	GetRoomState {
+		/// Room ID
+		room_id: OwnedRoomOrAliasId,
+	},
+
+	/// - Get and display signing keys from local cache or remote server.
+	GetSigningKeys {
+		server_name: Option<Box<ServerName>>,
+
+		#[arg(long)]
+		notary: Option<Box<ServerName>>,
+
+		#[arg(short, long)]
+		query: bool,
+	},
+
+	/// - Get and display signing keys from local cache or remote server.
+	GetVerifyKeys {
+		server_name: Option<Box<ServerName>>,
+	},
+
+	/// - Sends a federation request to the remote server's
+	///   `/_matrix/federation/v1/version` endpoint and measures the latency it
+	///   took for the server to respond
+	Ping {
+		server: Box<ServerName>,
+	},
+
+	/// - Forces device lists for all local and remote users to be updated (as
+	///   having new keys available)
+	ForceDeviceListUpdates,
+
+	/// - Change tracing log level/filter on the fly
+	///
+	/// This accepts the same format as the `log` config option.
+	ChangeLogLevel {
+		/// Log level/filter
+		filter: Option<String>,
+
+		/// Resets the log level/filter to the one in your config
+		#[arg(short, long)]
+		reset: bool,
+	},
+
+	/// - Verify json signatures
+	///
+	/// This command needs a JSON blob provided in a Markdown code block below
+	/// the command.
+	SignJson,
+
+	/// - Verify json signatures
+	///
+	/// This command needs a JSON blob provided in a Markdown code block below
+	/// the command.
+	VerifyJson,
+
+	/// - Verify PDU
+	///
+	/// This re-verifies a PDU existing in the database found by ID.
+	VerifyPdu {
+		event_id: Box<EventId>,
+	},
+
+	/// - Prints the very first PDU in the specified room (typically
+	///   m.room.create)
+	FirstPduInRoom {
+		/// The room ID
+		room_id: Box<RoomId>,
+	},
+
+	/// - Prints the latest ("last") PDU in the specified room (typically a
+	///   message)
+	LatestPduInRoom {
+		/// The room ID
+		room_id: Box<RoomId>,
+	},
+
+	/// - Forcefully replaces the room state of our local copy of the specified
+	///   room, with the copy (auth chain and room state events) the specified
+	///   remote server says.
+	///
+	/// A common desire for room deletion is to simply "reset" our copy of the
+	/// room. While this admin command is not a replacement for that, if you
+	/// know you have split/broken room state and you know another server in the
+	/// room that has the best/working room state, this command can let you use
+	/// their room state. Such example is your server saying users are in a
+	/// room, but other servers are saying they're not in the room in question.
+	///
+	/// This command will get the latest PDU in the room we know about, and
+	/// request the room state at that point in time via
+	/// `/_matrix/federation/v1/state/{roomId}`.
+	ForceSetRoomStateFromServer {
+		/// The impacted room ID
+		room_id: Box<RoomId>,
+		/// The server we will use to query the room state for
+		server_name: Box<ServerName>,
+	},
+
+	/// - Runs a server name through conduwuit's true destination resolution
+	///   process
+	///
+	/// Useful for debugging well-known issues
+	ResolveTrueDestination {
+		server_name: Box<ServerName>,
+
+		#[arg(short, long)]
+		no_cache: bool,
+	},
+
+	/// - Print extended memory usage
+	MemoryStats,
+
+	/// - Print general tokio runtime metric totals.
+	RuntimeMetrics,
+
+	/// - Print detailed tokio runtime metrics accumulated since last command
+	///   invocation.
+	RuntimeInterval,
+
+	/// - Print the current time
+	Time,
+
+	/// - List dependencies
+	ListDependencies {
+		#[arg(short, long)]
+		names: bool,
+	},
+
+	/// - Get database statistics
+	DatabaseStats {
+		property: Option<String>,
+
+		#[arg(short, long, alias("column"))]
+		map: Option<String>,
+	},
+
+	/// - Developer test stubs
+	#[command(subcommand)]
+	#[allow(non_snake_case)]
+	#[clap(hide(true))]
+	Tester(TesterCommand),
+}

src/admin/debug/tester.rs

@@ -0,0 +1,53 @@
+use conduit::Err;
+use ruma::events::room::message::RoomMessageEventContent;
+
+use crate::{admin_command, admin_command_dispatch, Result};
+
+#[admin_command_dispatch]
+#[derive(Debug, clap::Subcommand)]
+pub(crate) enum TesterCommand {
+	Panic,
+	Failure,
+	Tester,
+	Timer,
+}
+
+#[rustfmt::skip]
+#[admin_command]
+async fn panic(&self) -> Result<RoomMessageEventContent> {
+
+	panic!("panicked")
+}
+
+#[rustfmt::skip]
+#[admin_command]
+async fn failure(&self) -> Result<RoomMessageEventContent> {
+
+	Err!("failed")
+}
+
+#[inline(never)]
+#[rustfmt::skip]
+#[admin_command]
+async fn tester(&self) -> Result<RoomMessageEventContent> {
+
+	Ok(RoomMessageEventContent::notice_plain("completed"))
+}
+
+#[inline(never)]
+#[rustfmt::skip]
+#[admin_command]
+async fn timer(&self) -> Result<RoomMessageEventContent> {
+	let started = std::time::Instant::now();
+	timed(self.body);
+
+	let elapsed = started.elapsed();
+	Ok(RoomMessageEventContent::notice_plain(format!("completed in {elapsed:#?}")))
+}
+
+#[inline(never)]
+#[rustfmt::skip]
+#[allow(unused_variables)]
+fn timed(body: &[&str]) {
+
+}

src/admin/federation/commands.rs

@@ -0,0 +1,122 @@
+use std::fmt::Write;
+
+use conduit::Result;
+use futures::StreamExt;
+use ruma::{events::room::message::RoomMessageEventContent, OwnedRoomId, RoomId, ServerName, UserId};
+
+use crate::{admin_command, get_room_info};
+
+#[admin_command]
+pub(super) async fn disable_room(&self, room_id: Box<RoomId>) -> Result<RoomMessageEventContent> {
+	self.services.rooms.metadata.disable_room(&room_id, true);
+	Ok(RoomMessageEventContent::text_plain("Room disabled."))
+}
+
+#[admin_command]
+pub(super) async fn enable_room(&self, room_id: Box<RoomId>) -> Result<RoomMessageEventContent> {
+	self.services.rooms.metadata.disable_room(&room_id, false);
+	Ok(RoomMessageEventContent::text_plain("Room enabled."))
+}
+
+#[admin_command]
+pub(super) async fn incoming_federation(&self) -> Result<RoomMessageEventContent> {
+	let map = self
+		.services
+		.rooms
+		.event_handler
+		.federation_handletime
+		.read()
+		.expect("locked");
+	let mut msg = format!("Handling {} incoming pdus:\n", map.len());
+
+	for (r, (e, i)) in map.iter() {
+		let elapsed = i.elapsed();
+		writeln!(msg, "{} {}: {}m{}s", r, e, elapsed.as_secs() / 60, elapsed.as_secs() % 60)?;
+	}
+
+	Ok(RoomMessageEventContent::text_plain(&msg))
+}
+
+#[admin_command]
+pub(super) async fn fetch_support_well_known(&self, server_name: Box<ServerName>) -> Result<RoomMessageEventContent> {
+	let response = self
+		.services
+		.client
+		.default
+		.get(format!("https://{server_name}/.well-known/matrix/support"))
+		.send()
+		.await?;
+
+	let text = response.text().await?;
+
+	if text.is_empty() {
+		return Ok(RoomMessageEventContent::text_plain("Response text/body is empty."));
+	}
+
+	if text.len() > 1500 {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Response text/body is over 1500 characters, assuming no support well-known.",
+		));
+	}
+
+	let json: serde_json::Value = match serde_json::from_str(&text) {
+		Ok(json) => json,
+		Err(_) => {
+			return Ok(RoomMessageEventContent::text_plain("Response text/body is not valid JSON."));
+		},
+	};
+
+	let pretty_json: String = match serde_json::to_string_pretty(&json) {
+		Ok(json) => json,
+		Err(_) => {
+			return Ok(RoomMessageEventContent::text_plain("Response text/body is not valid JSON."));
+		},
+	};
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Got JSON response:\n\n```json\n{pretty_json}\n```"
+	)))
+}
+
+#[admin_command]
+pub(super) async fn remote_user_in_rooms(&self, user_id: Box<UserId>) -> Result<RoomMessageEventContent> {
+	if user_id.server_name() == self.services.globals.config.server_name {
+		return Ok(RoomMessageEventContent::text_plain(
+			"User belongs to our server, please use `list-joined-rooms` user admin command instead.",
+		));
+	}
+
+	if !self.services.users.exists(&user_id).await {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Remote user does not exist in our database.",
+		));
+	}
+
+	let mut rooms: Vec<(OwnedRoomId, u64, String)> = self
+		.services
+		.rooms
+		.state_cache
+		.rooms_joined(&user_id)
+		.then(|room_id| get_room_info(self.services, room_id))
+		.collect()
+		.await;
+
+	if rooms.is_empty() {
+		return Ok(RoomMessageEventContent::text_plain("User is not in any rooms."));
+	}
+
+	rooms.sort_by_key(|r| r.1);
+	rooms.reverse();
+
+	let output = format!(
+		"Rooms {user_id} shares with us ({}):\n```\n{}\n```",
+		rooms.len(),
+		rooms
+			.iter()
+			.map(|(id, members, name)| format!("{id} | Members: {members} | Name: {name}"))
+			.collect::<Vec<_>>()
+			.join("\n")
+	);
+
+	Ok(RoomMessageEventContent::text_markdown(output))
+}

src/admin/federation/mod.rs

@@ -0,0 +1,42 @@
+mod commands;
+
+use clap::Subcommand;
+use conduit::Result;
+use ruma::{RoomId, ServerName, UserId};
+
+use crate::admin_command_dispatch;
+
+#[admin_command_dispatch]
+#[derive(Debug, Subcommand)]
+pub(super) enum FederationCommand {
+	/// - List all rooms we are currently handling an incoming pdu from
+	IncomingFederation,
+
+	/// - Disables incoming federation handling for a room.
+	DisableRoom {
+		room_id: Box<RoomId>,
+	},
+
+	/// - Enables incoming federation handling for a room again.
+	EnableRoom {
+		room_id: Box<RoomId>,
+	},
+
+	/// - Fetch `/.well-known/matrix/support` from the specified server
+	///
+	/// Despite the name, this is not a federation endpoint and does not go
+	/// through the federation / server resolution process as per-spec this is
+	/// supposed to be served at the server_name.
+	///
+	/// Respecting homeservers put this file here for listing administration,
+	/// moderation, and security inquiries. This command provides a way to
+	/// easily fetch that information.
+	FetchSupportWellKnown {
+		server_name: Box<ServerName>,
+	},
+
+	/// - Lists all the rooms we share/track with the specified *remote* user
+	RemoteUserInRooms {
+		user_id: Box<UserId>,
+	},
+}

src/admin/media/commands.rs

@@ -0,0 +1,347 @@
+use std::time::Duration;
+
+use conduit::{debug, debug_info, debug_warn, error, info, trace, utils::time::parse_timepoint_ago, Result};
+use conduit_service::media::Dim;
+use ruma::{
+	events::room::message::RoomMessageEventContent, EventId, Mxc, MxcUri, OwnedMxcUri, OwnedServerName, ServerName,
+};
+
+use crate::{admin_command, utils::parse_local_user_id};
+
+#[admin_command]
+pub(super) async fn delete(
+	&self, mxc: Option<Box<MxcUri>>, event_id: Option<Box<EventId>>,
+) -> Result<RoomMessageEventContent> {
+	if event_id.is_some() && mxc.is_some() {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Please specify either an MXC or an event ID, not both.",
+		));
+	}
+
+	if let Some(mxc) = mxc {
+		trace!("Got MXC URL: {mxc}");
+		self.services
+			.media
+			.delete(&mxc.as_str().try_into()?)
+			.await?;
+
+		return Ok(RoomMessageEventContent::text_plain(
+			"Deleted the MXC from our database and on our filesystem.",
+		));
+	}
+
+	if let Some(event_id) = event_id {
+		trace!("Got event ID to delete media from: {event_id}");
+
+		let mut mxc_urls = Vec::with_capacity(4);
+
+		// parsing the PDU for any MXC URLs begins here
+		if let Ok(event_json) = self.services.rooms.timeline.get_pdu_json(&event_id).await {
+			if let Some(content_key) = event_json.get("content") {
+				debug!("Event ID has \"content\".");
+				let content_obj = content_key.as_object();
+
+				if let Some(content) = content_obj {
+					// 1. attempts to parse the "url" key
+					debug!("Attempting to go into \"url\" key for main media file");
+					if let Some(url) = content.get("url") {
+						debug!("Got a URL in the event ID {event_id}: {url}");
+
+						if url.to_string().starts_with("\"mxc://") {
+							debug!("Pushing URL {url} to list of MXCs to delete");
+							let final_url = url.to_string().replace('"', "");
+							mxc_urls.push(final_url);
+						} else {
+							info!("Found a URL in the event ID {event_id} but did not start with mxc://, ignoring");
+						}
+					}
+
+					// 2. attempts to parse the "info" key
+					debug!("Attempting to go into \"info\" key for thumbnails");
+					if let Some(info_key) = content.get("info") {
+						debug!("Event ID has \"info\".");
+						let info_obj = info_key.as_object();
+
+						if let Some(info) = info_obj {
+							if let Some(thumbnail_url) = info.get("thumbnail_url") {
+								debug!("Found a thumbnail_url in info key: {thumbnail_url}");
+
+								if thumbnail_url.to_string().starts_with("\"mxc://") {
+									debug!("Pushing thumbnail URL {thumbnail_url} to list of MXCs to delete");
+									let final_thumbnail_url = thumbnail_url.to_string().replace('"', "");
+									mxc_urls.push(final_thumbnail_url);
+								} else {
+									info!(
+										"Found a thumbnail URL in the event ID {event_id} but did not start with \
+										 mxc://, ignoring"
+									);
+								}
+							} else {
+								info!("No \"thumbnail_url\" key in \"info\" key, assuming no thumbnails.");
+							}
+						}
+					}
+
+					// 3. attempts to parse the "file" key
+					debug!("Attempting to go into \"file\" key");
+					if let Some(file_key) = content.get("file") {
+						debug!("Event ID has \"file\".");
+						let file_obj = file_key.as_object();
+
+						if let Some(file) = file_obj {
+							if let Some(url) = file.get("url") {
+								debug!("Found url in file key: {url}");
+
+								if url.to_string().starts_with("\"mxc://") {
+									debug!("Pushing URL {url} to list of MXCs to delete");
+									let final_url = url.to_string().replace('"', "");
+									mxc_urls.push(final_url);
+								} else {
+									info!(
+										"Found a URL in the event ID {event_id} but did not start with mxc://, \
+										 ignoring"
+									);
+								}
+							} else {
+								info!("No \"url\" key in \"file\" key.");
+							}
+						}
+					}
+				} else {
+					return Ok(RoomMessageEventContent::text_plain(
+						"Event ID does not have a \"content\" key or failed parsing the event ID JSON.",
+					));
+				}
+			} else {
+				return Ok(RoomMessageEventContent::text_plain(
+					"Event ID does not have a \"content\" key, this is not a message or an event type that contains \
+					 media.",
+				));
+			}
+		} else {
+			return Ok(RoomMessageEventContent::text_plain(
+				"Event ID does not exist or is not known to us.",
+			));
+		}
+
+		if mxc_urls.is_empty() {
+			info!("Parsed event ID {event_id} but did not contain any MXC URLs.");
+			return Ok(RoomMessageEventContent::text_plain("Parsed event ID but found no MXC URLs."));
+		}
+
+		let mut mxc_deletion_count: usize = 0;
+
+		for mxc_url in mxc_urls {
+			match self
+				.services
+				.media
+				.delete(&mxc_url.as_str().try_into()?)
+				.await
+			{
+				Ok(()) => {
+					debug_info!("Successfully deleted {mxc_url} from filesystem and database");
+					mxc_deletion_count = mxc_deletion_count.saturating_add(1);
+				},
+				Err(e) => {
+					debug_warn!("Failed to delete {mxc_url}, ignoring error and skipping: {e}");
+					continue;
+				},
+			}
+		}
+
+		return Ok(RoomMessageEventContent::text_plain(format!(
+			"Deleted {mxc_deletion_count} total MXCs from our database and the filesystem from event ID {event_id}."
+		)));
+	}
+
+	Ok(RoomMessageEventContent::text_plain(
+		"Please specify either an MXC using --mxc or an event ID using --event-id of the message containing an image. \
+		 See --help for details.",
+	))
+}
+
+#[admin_command]
+pub(super) async fn delete_list(&self) -> Result<RoomMessageEventContent> {
+	if self.body.len() < 2 || !self.body[0].trim().starts_with("```") || self.body.last().unwrap_or(&"").trim() != "```"
+	{
+		return Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		));
+	}
+
+	let mut failed_parsed_mxcs: usize = 0;
+
+	let mxc_list = self
+		.body
+		.to_vec()
+		.drain(1..self.body.len().checked_sub(1).unwrap())
+		.filter_map(|mxc_s| {
+			mxc_s
+				.try_into()
+				.inspect_err(|e| {
+					debug_warn!("Failed to parse user-provided MXC URI: {e}");
+
+					failed_parsed_mxcs = failed_parsed_mxcs.saturating_add(1);
+				})
+				.ok()
+		})
+		.collect::<Vec<Mxc<'_>>>();
+
+	let mut mxc_deletion_count: usize = 0;
+
+	for mxc in &mxc_list {
+		trace!(%failed_parsed_mxcs, %mxc_deletion_count, "Deleting MXC {mxc} in bulk");
+		match self.services.media.delete(mxc).await {
+			Ok(()) => {
+				debug_info!("Successfully deleted {mxc} from filesystem and database");
+				mxc_deletion_count = mxc_deletion_count.saturating_add(1);
+			},
+			Err(e) => {
+				debug_warn!("Failed to delete {mxc}, ignoring error and skipping: {e}");
+				continue;
+			},
+		}
+	}
+
+	Ok(RoomMessageEventContent::text_plain(format!(
+		"Finished bulk MXC deletion, deleted {mxc_deletion_count} total MXCs from our database and the filesystem. \
+		 {failed_parsed_mxcs} MXCs failed to be parsed from the database.",
+	)))
+}
+
+#[admin_command]
+pub(super) async fn delete_past_remote_media(
+	&self, duration: String, before: bool, after: bool, yes_i_want_to_delete_local_media: bool,
+) -> Result<RoomMessageEventContent> {
+	if before && after {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Please only pick one argument, --before or --after.",
+		));
+	}
+	assert!(!(before && after), "--before and --after should not be specified together");
+
+	let duration = parse_timepoint_ago(&duration)?;
+	let deleted_count = self
+		.services
+		.media
+		.delete_all_remote_media_at_after_time(duration, before, after, yes_i_want_to_delete_local_media)
+		.await?;
+
+	Ok(RoomMessageEventContent::text_plain(format!(
+		"Deleted {deleted_count} total files.",
+	)))
+}
+
+#[admin_command]
+pub(super) async fn delete_all_from_user(&self, username: String) -> Result<RoomMessageEventContent> {
+	let user_id = parse_local_user_id(self.services, &username)?;
+
+	let deleted_count = self.services.media.delete_from_user(&user_id).await?;
+
+	Ok(RoomMessageEventContent::text_plain(format!(
+		"Deleted {deleted_count} total files.",
+	)))
+}
+
+#[admin_command]
+pub(super) async fn delete_all_from_server(
+	&self, server_name: Box<ServerName>, yes_i_want_to_delete_local_media: bool,
+) -> Result<RoomMessageEventContent> {
+	if server_name == self.services.globals.server_name() && !yes_i_want_to_delete_local_media {
+		return Ok(RoomMessageEventContent::text_plain(
+			"This command only works for remote media by default.",
+		));
+	}
+
+	let Ok(all_mxcs) = self
+		.services
+		.media
+		.get_all_mxcs()
+		.await
+		.inspect_err(|e| error!("Failed to get MXC URIs from our database: {e}"))
+	else {
+		return Ok(RoomMessageEventContent::text_plain("Failed to get MXC URIs from our database"));
+	};
+
+	let mut deleted_count: usize = 0;
+
+	for mxc in all_mxcs {
+		let Ok(mxc_server_name) = mxc.server_name().inspect_err(|e| {
+			debug_warn!("Failed to parse MXC {mxc} server name from database, ignoring error and skipping: {e}");
+		}) else {
+			continue;
+		};
+
+		if mxc_server_name != server_name
+			|| (self.services.globals.server_is_ours(mxc_server_name) && !yes_i_want_to_delete_local_media)
+		{
+			trace!("skipping MXC URI {mxc}");
+			continue;
+		}
+
+		let mxc: Mxc<'_> = mxc.as_str().try_into()?;
+
+		match self.services.media.delete(&mxc).await {
+			Ok(()) => {
+				deleted_count = deleted_count.saturating_add(1);
+			},
+			Err(e) => {
+				debug_warn!("Failed to delete {mxc}, ignoring error and skipping: {e}");
+				continue;
+			},
+		}
+	}
+
+	Ok(RoomMessageEventContent::text_plain(format!(
+		"Deleted {deleted_count} total files.",
+	)))
+}
+
+#[admin_command]
+pub(super) async fn get_file_info(&self, mxc: OwnedMxcUri) -> Result<RoomMessageEventContent> {
+	let mxc: Mxc<'_> = mxc.as_str().try_into()?;
+	let metadata = self.services.media.get_metadata(&mxc).await;
+
+	Ok(RoomMessageEventContent::notice_markdown(format!("```\n{metadata:#?}\n```")))
+}
+
+#[admin_command]
+pub(super) async fn get_remote_file(
+	&self, mxc: OwnedMxcUri, server: Option<OwnedServerName>, timeout: u32,
+) -> Result<RoomMessageEventContent> {
+	let mxc: Mxc<'_> = mxc.as_str().try_into()?;
+	let timeout = Duration::from_millis(timeout.into());
+	let mut result = self
+		.services
+		.media
+		.fetch_remote_content(&mxc, None, server.as_deref(), timeout)
+		.await?;
+
+	// Grab the length of the content before clearing it to not flood the output
+	let len = result.content.as_ref().expect("content").len();
+	result.content.as_mut().expect("content").clear();
+
+	let out = format!("```\n{result:#?}\nreceived {len} bytes for file content.\n```");
+	Ok(RoomMessageEventContent::notice_markdown(out))
+}
+
+#[admin_command]
+pub(super) async fn get_remote_thumbnail(
+	&self, mxc: OwnedMxcUri, server: Option<OwnedServerName>, timeout: u32, width: u32, height: u32,
+) -> Result<RoomMessageEventContent> {
+	let mxc: Mxc<'_> = mxc.as_str().try_into()?;
+	let timeout = Duration::from_millis(timeout.into());
+	let dim = Dim::new(width, height, None);
+	let mut result = self
+		.services
+		.media
+		.fetch_remote_thumbnail(&mxc, None, server.as_deref(), timeout, &dim)
+		.await?;
+
+	// Grab the length of the content before clearing it to not flood the output
+	let len = result.content.as_ref().expect("content").len();
+	result.content.as_mut().expect("content").clear();
+
+	let out = format!("```\n{result:#?}\nreceived {len} bytes for file content.\n```");
+	Ok(RoomMessageEventContent::notice_markdown(out))
+}

src/admin/media/mod.rs

@@ -0,0 +1,98 @@
+mod commands;
+
+use clap::Subcommand;
+use conduit::Result;
+use ruma::{EventId, MxcUri, OwnedMxcUri, OwnedServerName, ServerName};
+
+use crate::admin_command_dispatch;
+
+#[admin_command_dispatch]
+#[derive(Debug, Subcommand)]
+pub(super) enum MediaCommand {
+	/// - Deletes a single media file from our database and on the filesystem
+	///   via a single MXC URL or event ID (not redacted)
+	Delete {
+		/// The MXC URL to delete
+		#[arg(long)]
+		mxc: Option<Box<MxcUri>>,
+
+		/// - The message event ID which contains the media and thumbnail MXC
+		///   URLs
+		#[arg(long)]
+		event_id: Option<Box<EventId>>,
+	},
+
+	/// - Deletes a codeblock list of MXC URLs from our database and on the
+	///   filesystem. This will always ignore errors.
+	DeleteList,
+
+	/// - Deletes all remote media in the last/after "X" time using filesystem
+	///   metadata first created at date, or fallback to last modified date.
+	///   This will always ignore errors by default.
+	///
+	/// Synapse
+	DeletePastRemoteMedia {
+		/// - The duration (at or after/before), e.g. "5m" to delete all media
+		///   in the past or up to 5 minutes
+		duration: String,
+
+		#[arg(long, short)]
+		before: bool,
+
+		#[arg(long, short)]
+		after: bool,
+
+		/// Long argument to delete local media
+		#[arg(long)]
+		yes_i_want_to_delete_local_media: bool,
+	},
+
+	/// - Deletes all the local media from a local user on our server. This will
+	///   always ignore errors by default.
+	DeleteAllFromUser {
+		username: String,
+	},
+
+	/// - Deletes all remote media from the specified remote server. This will
+	///   always ignore errors by default.
+	DeleteAllFromServer {
+		server_name: Box<ServerName>,
+
+		/// Long argument to delete local media
+		#[arg(long)]
+		yes_i_want_to_delete_local_media: bool,
+	},
+
+	GetFileInfo {
+		/// The MXC URL to lookup info for.
+		mxc: OwnedMxcUri,
+	},
+
+	GetRemoteFile {
+		/// The MXC URL to fetch
+		mxc: OwnedMxcUri,
+
+		#[arg(short, long)]
+		server: Option<OwnedServerName>,
+
+		#[arg(short, long, default_value("10000"))]
+		timeout: u32,
+	},
+
+	GetRemoteThumbnail {
+		/// The MXC URL to fetch
+		mxc: OwnedMxcUri,
+
+		#[arg(short, long)]
+		server: Option<OwnedServerName>,
+
+		#[arg(short, long, default_value("10000"))]
+		timeout: u32,
+
+		#[arg(short, long, default_value("800"))]
+		width: u32,
+
+		#[arg(short, long, default_value("800"))]
+		height: u32,
+	},
+}

src/admin/mod.rs

@@ -0,0 +1,61 @@
+#![recursion_limit = "192"]
+#![allow(clippy::wildcard_imports)]
+#![allow(clippy::enum_glob_use)]
+
+pub(crate) mod admin;
+pub(crate) mod command;
+pub(crate) mod processor;
+mod tests;
+pub(crate) mod utils;
+
+pub(crate) mod appservice;
+pub(crate) mod check;
+pub(crate) mod debug;
+pub(crate) mod federation;
+pub(crate) mod media;
+pub(crate) mod query;
+pub(crate) mod room;
+pub(crate) mod server;
+pub(crate) mod user;
+
+extern crate conduit_api as api;
+extern crate conduit_core as conduit;
+extern crate conduit_service as service;
+
+pub(crate) use conduit::Result;
+pub(crate) use conduit_macros::{admin_command, admin_command_dispatch};
+
+pub(crate) use crate::{
+	command::Command,
+	utils::{escape_html, get_room_info},
+};
+
+pub(crate) const PAGE_SIZE: usize = 100;
+
+conduit::mod_ctor! {}
+conduit::mod_dtor! {}
+conduit::rustc_flags_capture! {}
+
+/// Install the admin command processor
+pub async fn init(admin_service: &service::admin::Service) {
+	_ = admin_service
+		.complete
+		.write()
+		.expect("locked for writing")
+		.insert(processor::complete);
+	_ = admin_service
+		.handle
+		.write()
+		.await
+		.insert(processor::dispatch);
+}
+
+/// Uninstall the admin command handler
+pub async fn fini(admin_service: &service::admin::Service) {
+	_ = admin_service.handle.write().await.take();
+	_ = admin_service
+		.complete
+		.write()
+		.expect("locked for writing")
+		.take();
+}

src/admin/processor.rs

@@ -0,0 +1,266 @@
+use std::{
+	fmt::Write,
+	panic::AssertUnwindSafe,
+	sync::{Arc, Mutex},
+	time::SystemTime,
+};
+
+use clap::{CommandFactory, Parser};
+use conduit::{
+	debug, error,
+	log::{
+		capture,
+		capture::Capture,
+		fmt::{markdown_table, markdown_table_head},
+	},
+	trace,
+	utils::string::{collect_stream, common_prefix},
+	warn, Error, Result,
+};
+use futures::future::FutureExt;
+use ruma::{
+	events::{
+		relation::InReplyTo,
+		room::message::{Relation::Reply, RoomMessageEventContent},
+	},
+	EventId,
+};
+use service::{
+	admin::{CommandInput, CommandOutput, ProcessorFuture, ProcessorResult},
+	Services,
+};
+use tracing::Level;
+use tracing_subscriber::{filter::LevelFilter, EnvFilter};
+
+use crate::{admin, admin::AdminCommand, Command};
+
+#[must_use]
+pub(super) fn complete(line: &str) -> String { complete_command(AdminCommand::command(), line) }
+
+#[must_use]
+pub(super) fn dispatch(services: Arc<Services>, command: CommandInput) -> ProcessorFuture {
+	Box::pin(handle_command(services, command))
+}
+
+#[tracing::instrument(skip_all, name = "admin")]
+async fn handle_command(services: Arc<Services>, command: CommandInput) -> ProcessorResult {
+	AssertUnwindSafe(Box::pin(process_command(services, &command)))
+		.catch_unwind()
+		.await
+		.map_err(Error::from_panic)
+		.unwrap_or_else(|error| handle_panic(&error, &command))
+}
+
+async fn process_command(services: Arc<Services>, input: &CommandInput) -> ProcessorResult {
+	let (command, args, body) = match parse(&services, input) {
+		Err(error) => return Err(error),
+		Ok(parsed) => parsed,
+	};
+
+	let context = Command {
+		services: &services,
+		body: &body,
+		timer: SystemTime::now(),
+		reply_id: input.reply_id.as_deref(),
+	};
+
+	process(&context, command, &args).await
+}
+
+fn handle_panic(error: &Error, command: &CommandInput) -> ProcessorResult {
+	let link = "Please submit a [bug report](https://github.com/girlbossceo/conduwuit/issues/new). 🥺";
+	let msg = format!("Panic occurred while processing command:\n```\n{error:#?}\n```\n{link}");
+	let content = RoomMessageEventContent::notice_markdown(msg);
+	error!("Panic while processing command: {error:?}");
+	Err(reply(content, command.reply_id.as_deref()))
+}
+
+// Parse and process a message from the admin room
+async fn process(context: &Command<'_>, command: AdminCommand, args: &[String]) -> ProcessorResult {
+	let (capture, logs) = capture_create(context);
+
+	let capture_scope = capture.start();
+	let result = Box::pin(admin::process(command, context)).await;
+	drop(capture_scope);
+
+	debug!(
+		ok = result.is_ok(),
+		elapsed = ?context.timer.elapsed(),
+		command = ?args,
+		"command processed"
+	);
+
+	let mut output = String::new();
+
+	// Prepend the logs only if any were captured
+	let logs = logs.lock().expect("locked");
+	if logs.lines().count() > 2 {
+		writeln!(&mut output, "{logs}").expect("failed to format logs to command output");
+	}
+	drop(logs);
+
+	match result {
+		Ok(content) => {
+			write!(&mut output, "{0}", content.body()).expect("failed to format command result to output buffer");
+			Ok(Some(reply(RoomMessageEventContent::notice_markdown(output), context.reply_id)))
+		},
+		Err(error) => {
+			write!(&mut output, "Command failed with error:\n```\n{error:#?}\n```")
+				.expect("failed to format command result to output");
+			Err(reply(RoomMessageEventContent::notice_markdown(output), context.reply_id))
+		},
+	}
+}
+
+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(|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)
+		.unwrap_or(Level::DEBUG);
+
+	let filter =
+		move |data: capture::Data<'_>| data.level() <= log_level && data.our_modules() && data.scope.contains(&"admin");
+
+	let logs = Arc::new(Mutex::new(
+		collect_stream(|s| markdown_table_head(s)).expect("markdown table header"),
+	));
+
+	let capture = Capture::new(
+		&context.services.server.log.capture,
+		Some(filter),
+		capture::fmt(markdown_table, logs.clone()),
+	);
+
+	(capture, logs)
+}
+
+// Parse chat messages from the admin room into an AdminCommand object
+fn parse<'a>(
+	services: &Arc<Services>, input: &'a CommandInput,
+) -> Result<(AdminCommand, Vec<String>, Vec<&'a str>), CommandOutput> {
+	let lines = input.command.lines().filter(|line| !line.trim().is_empty());
+	let command_line = lines.clone().next().expect("command missing first line");
+	let body = lines.skip(1).collect();
+	match parse_command(command_line) {
+		Ok((command, args)) => Ok((command, args, body)),
+		Err(error) => {
+			let message = error
+				.to_string()
+				.replace("server.name", services.globals.server_name().as_str());
+			Err(reply(RoomMessageEventContent::notice_plain(message), input.reply_id.as_deref()))
+		},
+	}
+}
+
+fn parse_command(line: &str) -> Result<(AdminCommand, Vec<String>)> {
+	let argv = parse_line(line);
+	let command = AdminCommand::try_parse_from(&argv)?;
+	Ok((command, argv))
+}
+
+fn complete_command(mut cmd: clap::Command, line: &str) -> String {
+	let argv = parse_line(line);
+	let mut ret = Vec::<String>::with_capacity(argv.len().saturating_add(1));
+
+	'token: for token in argv.into_iter().skip(1) {
+		let cmd_ = cmd.clone();
+		let mut choice = Vec::new();
+
+		for sub in cmd_.get_subcommands() {
+			let name = sub.get_name();
+			if *name == token {
+				// token already complete; recurse to subcommand
+				ret.push(token);
+				cmd.clone_from(sub);
+				continue 'token;
+			} else if name.starts_with(&token) {
+				// partial match; add to choices
+				choice.push(name);
+			}
+		}
+
+		if choice.len() == 1 {
+			// One choice. Add extra space because it's complete
+			let choice = *choice.first().expect("only choice");
+			ret.push(choice.to_owned());
+			ret.push(String::new());
+		} else if choice.is_empty() {
+			// Nothing found, return original string
+			ret.push(token);
+		} else {
+			// Find the common prefix
+			ret.push(common_prefix(&choice).into());
+		}
+
+		// Return from completion
+		return ret.join(" ");
+	}
+
+	// Return from no completion. Needs a space though.
+	ret.push(String::new());
+	ret.join(" ")
+}
+
+// Parse chat messages from the admin room into an AdminCommand object
+fn parse_line(command_line: &str) -> Vec<String> {
+	let mut argv = command_line
+		.split_whitespace()
+		.map(str::to_owned)
+		.collect::<Vec<String>>();
+
+	// Remove any escapes that came with a server-side escape command
+	if !argv.is_empty() && argv[0].ends_with("admin") {
+		argv[0] = argv[0].trim_start_matches('\\').into();
+	}
+
+	// First indice has to be "admin" but for console convenience we add it here
+	if !argv.is_empty() && !argv[0].ends_with("admin") && !argv[0].starts_with('@') {
+		argv.insert(0, "admin".to_owned());
+	}
+
+	// Replace `help command` with `command --help`
+	// Clap has a help subcommand, but it omits the long help description.
+	if argv.len() > 1 && argv[1] == "help" {
+		argv.remove(1);
+		argv.push("--help".to_owned());
+	}
+
+	// Backwards compatibility with `register_appservice`-style commands
+	if argv.len() > 1 && argv[1].contains('_') {
+		argv[1] = argv[1].replace('_', "-");
+	}
+
+	// Backwards compatibility with `register_appservice`-style commands
+	if argv.len() > 2 && argv[2].contains('_') {
+		argv[2] = argv[2].replace('_', "-");
+	}
+
+	// if the user is using the `query` command (argv[1]), replace the database
+	// function/table calls with underscores to match the codebase
+	if argv.len() > 3 && argv[1].eq("query") {
+		argv[3] = argv[3].replace('_', "-");
+	}
+
+	trace!(?command_line, ?argv, "parse");
+	argv
+}
+
+fn reply(mut content: RoomMessageEventContent, reply_id: Option<&EventId>) -> RoomMessageEventContent {
+	content.relates_to = reply_id.map(|event_id| Reply {
+		in_reply_to: InReplyTo {
+			event_id: event_id.to_owned(),
+		},
+	});
+
+	content
+}

src/admin/query/account_data.rs

@@ -0,0 +1,71 @@
+use clap::Subcommand;
+use conduit::Result;
+use futures::StreamExt;
+use ruma::{events::room::message::RoomMessageEventContent, RoomId, UserId};
+
+use crate::Command;
+
+#[derive(Debug, Subcommand)]
+/// All the getters and iterators from src/database/key_value/account_data.rs
+pub(crate) enum AccountDataCommand {
+	/// - Returns all changes to the account data that happened after `since`.
+	ChangesSince {
+		/// Full user ID
+		user_id: Box<UserId>,
+		/// UNIX timestamp since (u64)
+		since: u64,
+		/// Optional room ID of the account data
+		room_id: Option<Box<RoomId>>,
+	},
+
+	/// - Searches the account data for a specific kind.
+	Get {
+		/// Full user ID
+		user_id: Box<UserId>,
+		/// Account data event type
+		kind: String,
+		/// Optional room ID of the account data
+		room_id: Option<Box<RoomId>>,
+	},
+}
+
+/// All the getters and iterators from src/database/key_value/account_data.rs
+pub(super) async fn process(subcommand: AccountDataCommand, context: &Command<'_>) -> Result<RoomMessageEventContent> {
+	let services = context.services;
+
+	match subcommand {
+		AccountDataCommand::ChangesSince {
+			user_id,
+			since,
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Vec<_> = services
+				.account_data
+				.changes_since(room_id.as_deref(), &user_id, since)
+				.collect()
+				.await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		AccountDataCommand::Get {
+			user_id,
+			kind,
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services
+				.account_data
+				.get_raw(room_id.as_deref(), &user_id, &kind)
+				.await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+	}
+}

src/admin/query/appservice.rs

@@ -0,0 +1,47 @@
+use clap::Subcommand;
+use conduit::Result;
+use ruma::events::room::message::RoomMessageEventContent;
+
+use crate::Command;
+
+#[derive(Debug, Subcommand)]
+/// All the getters and iterators from src/database/key_value/appservice.rs
+pub(crate) enum AppserviceCommand {
+	/// - Gets the appservice registration info/details from the ID as a string
+	GetRegistration {
+		/// Appservice registration ID
+		appservice_id: Box<str>,
+	},
+
+	/// - Gets all appservice registrations with their ID and registration info
+	All,
+}
+
+/// All the getters and iterators from src/database/key_value/appservice.rs
+pub(super) async fn process(subcommand: AppserviceCommand, context: &Command<'_>) -> Result<RoomMessageEventContent> {
+	let services = context.services;
+
+	match subcommand {
+		AppserviceCommand::GetRegistration {
+			appservice_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services.appservice.get_registration(&appservice_id).await;
+
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		AppserviceCommand::All => {
+			let timer = tokio::time::Instant::now();
+			let results = services.appservice.all().await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+	}
+}

src/admin/query/globals.rs

@@ -0,0 +1,67 @@
+use clap::Subcommand;
+use conduit::Result;
+use ruma::{events::room::message::RoomMessageEventContent, ServerName};
+
+use crate::Command;
+
+#[derive(Debug, Subcommand)]
+/// All the getters and iterators from src/database/key_value/globals.rs
+pub(crate) enum GlobalsCommand {
+	DatabaseVersion,
+
+	CurrentCount,
+
+	LastCheckForUpdatesId,
+
+	/// - This returns an empty `Ok(BTreeMap<..>)` when there are no keys found
+	///   for the server.
+	SigningKeysFor {
+		origin: Box<ServerName>,
+	},
+}
+
+/// All the getters and iterators from src/database/key_value/globals.rs
+pub(super) async fn process(subcommand: GlobalsCommand, context: &Command<'_>) -> Result<RoomMessageEventContent> {
+	let services = context.services;
+
+	match subcommand {
+		GlobalsCommand::DatabaseVersion => {
+			let timer = tokio::time::Instant::now();
+			let results = services.globals.db.database_version().await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		GlobalsCommand::CurrentCount => {
+			let timer = tokio::time::Instant::now();
+			let results = services.globals.db.current_count();
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		GlobalsCommand::LastCheckForUpdatesId => {
+			let timer = tokio::time::Instant::now();
+			let results = services.updates.last_check_for_updates_id().await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		GlobalsCommand::SigningKeysFor {
+			origin,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services.server_keys.verify_keys_for(&origin).await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+	}
+}

src/admin/query/mod.rs

@@ -0,0 +1,65 @@
+mod account_data;
+mod appservice;
+mod globals;
+mod presence;
+mod pusher;
+mod resolver;
+mod room_alias;
+mod room_state_cache;
+mod sending;
+mod users;
+
+use clap::Subcommand;
+use conduit::Result;
+
+use self::{
+	account_data::AccountDataCommand, appservice::AppserviceCommand, globals::GlobalsCommand,
+	presence::PresenceCommand, pusher::PusherCommand, resolver::ResolverCommand, room_alias::RoomAliasCommand,
+	room_state_cache::RoomStateCacheCommand, sending::SendingCommand, users::UsersCommand,
+};
+use crate::admin_command_dispatch;
+
+#[admin_command_dispatch]
+#[derive(Debug, Subcommand)]
+/// Query tables from database
+pub(super) enum QueryCommand {
+	/// - account_data.rs iterators and getters
+	#[command(subcommand)]
+	AccountData(AccountDataCommand),
+
+	/// - appservice.rs iterators and getters
+	#[command(subcommand)]
+	Appservice(AppserviceCommand),
+
+	/// - presence.rs iterators and getters
+	#[command(subcommand)]
+	Presence(PresenceCommand),
+
+	/// - rooms/alias.rs iterators and getters
+	#[command(subcommand)]
+	RoomAlias(RoomAliasCommand),
+
+	/// - rooms/state_cache iterators and getters
+	#[command(subcommand)]
+	RoomStateCache(RoomStateCacheCommand),
+
+	/// - globals.rs iterators and getters
+	#[command(subcommand)]
+	Globals(GlobalsCommand),
+
+	/// - sending.rs iterators and getters
+	#[command(subcommand)]
+	Sending(SendingCommand),
+
+	/// - users.rs iterators and getters
+	#[command(subcommand)]
+	Users(UsersCommand),
+
+	/// - resolver service
+	#[command(subcommand)]
+	Resolver(ResolverCommand),
+
+	/// - pusher service
+	#[command(subcommand)]
+	Pusher(PusherCommand),
+}

src/admin/query/presence.rs

@@ -0,0 +1,58 @@
+use clap::Subcommand;
+use conduit::Result;
+use futures::StreamExt;
+use ruma::{events::room::message::RoomMessageEventContent, UserId};
+
+use crate::Command;
+
+#[derive(Debug, Subcommand)]
+/// All the getters and iterators from src/database/key_value/presence.rs
+pub(crate) enum PresenceCommand {
+	/// - Returns the latest presence event for the given user.
+	GetPresence {
+		/// Full user ID
+		user_id: Box<UserId>,
+	},
+
+	/// - Iterator of the most recent presence updates that happened after the
+	///   event with id `since`.
+	PresenceSince {
+		/// UNIX timestamp since (u64)
+		since: u64,
+	},
+}
+
+/// All the getters and iterators in key_value/presence.rs
+pub(super) async fn process(subcommand: PresenceCommand, context: &Command<'_>) -> Result<RoomMessageEventContent> {
+	let services = context.services;
+
+	match subcommand {
+		PresenceCommand::GetPresence {
+			user_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services.presence.db.get_presence(&user_id).await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		PresenceCommand::PresenceSince {
+			since,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Vec<(_, _, _)> = services
+				.presence
+				.presence_since(since)
+				.map(|(user_id, count, bytes)| (user_id.to_owned(), count, bytes.to_vec()))
+				.collect()
+				.await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+	}
+}

src/admin/query/pusher.rs

@@ -0,0 +1,32 @@
+use clap::Subcommand;
+use conduit::Result;
+use ruma::{events::room::message::RoomMessageEventContent, UserId};
+
+use crate::Command;
+
+#[derive(Debug, Subcommand)]
+pub(crate) enum PusherCommand {
+	/// - Returns all the pushers for the user.
+	GetPushers {
+		/// Full user ID
+		user_id: Box<UserId>,
+	},
+}
+
+pub(super) async fn process(subcommand: PusherCommand, context: &Command<'_>) -> Result<RoomMessageEventContent> {
+	let services = context.services;
+
+	match subcommand {
+		PusherCommand::GetPushers {
+			user_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services.pusher.get_pushers(&user_id).await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+	}
+}

src/admin/query/resolver.rs

@@ -0,0 +1,94 @@
+use std::fmt::Write;
+
+use clap::Subcommand;
+use conduit::{utils::time, Result};
+use ruma::{events::room::message::RoomMessageEventContent, OwnedServerName};
+
+use crate::{admin_command, admin_command_dispatch};
+
+#[admin_command_dispatch]
+#[derive(Debug, Subcommand)]
+/// Resolver service and caches
+pub(crate) enum ResolverCommand {
+	/// Query the destinations cache
+	DestinationsCache {
+		server_name: Option<OwnedServerName>,
+	},
+
+	/// Query the overrides cache
+	OverridesCache {
+		name: Option<String>,
+	},
+}
+
+#[admin_command]
+async fn destinations_cache(&self, server_name: Option<OwnedServerName>) -> Result<RoomMessageEventContent> {
+	use service::resolver::cache::CachedDest;
+
+	let mut out = String::new();
+	writeln!(out, "| Server Name | Destination | Hostname | Expires |")?;
+	writeln!(out, "| ----------- | ----------- | -------- | ------- |")?;
+	let row = |(
+		name,
+		&CachedDest {
+			ref dest,
+			ref host,
+			expire,
+		},
+	)| {
+		let expire = time::format(expire, "%+");
+		writeln!(out, "| {name} | {dest} | {host} | {expire} |").expect("wrote line");
+	};
+
+	let map = self
+		.services
+		.resolver
+		.cache
+		.destinations
+		.read()
+		.expect("locked");
+
+	if let Some(server_name) = server_name.as_ref() {
+		map.get_key_value(server_name).map(row);
+	} else {
+		map.iter().for_each(row);
+	}
+
+	Ok(RoomMessageEventContent::notice_markdown(out))
+}
+
+#[admin_command]
+async fn overrides_cache(&self, server_name: Option<String>) -> Result<RoomMessageEventContent> {
+	use service::resolver::cache::CachedOverride;
+
+	let mut out = String::new();
+	writeln!(out, "| Server Name | IP  | Port | Expires |")?;
+	writeln!(out, "| ----------- | --- | ----:| ------- |")?;
+	let row = |(
+		name,
+		&CachedOverride {
+			ref ips,
+			port,
+			expire,
+		},
+	)| {
+		let expire = time::format(expire, "%+");
+		writeln!(out, "| {name} | {ips:?} | {port} | {expire} |").expect("wrote line");
+	};
+
+	let map = self
+		.services
+		.resolver
+		.cache
+		.overrides
+		.read()
+		.expect("locked");
+
+	if let Some(server_name) = server_name.as_ref() {
+		map.get_key_value(server_name).map(row);
+	} else {
+		map.iter().for_each(row);
+	}
+
+	Ok(RoomMessageEventContent::notice_markdown(out))
+}

src/admin/query/room_alias.rs

@@ -0,0 +1,75 @@
+use clap::Subcommand;
+use conduit::Result;
+use futures::StreamExt;
+use ruma::{events::room::message::RoomMessageEventContent, RoomAliasId, RoomId};
+
+use crate::Command;
+
+#[derive(Debug, Subcommand)]
+/// All the getters and iterators from src/database/key_value/rooms/alias.rs
+pub(crate) enum RoomAliasCommand {
+	ResolveLocalAlias {
+		/// Full room alias
+		alias: Box<RoomAliasId>,
+	},
+
+	/// - Iterator of all our local room aliases for the room ID
+	LocalAliasesForRoom {
+		/// Full room ID
+		room_id: Box<RoomId>,
+	},
+
+	/// - Iterator of all our local aliases in our database with their room IDs
+	AllLocalAliases,
+}
+
+/// All the getters and iterators in src/database/key_value/rooms/alias.rs
+pub(super) async fn process(subcommand: RoomAliasCommand, context: &Command<'_>) -> Result<RoomMessageEventContent> {
+	let services = context.services;
+
+	match subcommand {
+		RoomAliasCommand::ResolveLocalAlias {
+			alias,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services.rooms.alias.resolve_local_alias(&alias).await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomAliasCommand::LocalAliasesForRoom {
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let aliases: Vec<_> = services
+				.rooms
+				.alias
+				.local_aliases_for_room(&room_id)
+				.map(ToOwned::to_owned)
+				.collect()
+				.await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{aliases:#?}\n```"
+			)))
+		},
+		RoomAliasCommand::AllLocalAliases => {
+			let timer = tokio::time::Instant::now();
+			let aliases = services
+				.rooms
+				.alias
+				.all_local_aliases()
+				.map(|(room_id, alias)| (room_id.to_owned(), alias.to_owned()))
+				.collect::<Vec<_>>()
+				.await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{aliases:#?}\n```"
+			)))
+		},
+	}
+}

src/admin/query/room_state_cache.rs

@@ -0,0 +1,344 @@
+use clap::Subcommand;
+use conduit::Result;
+use futures::StreamExt;
+use ruma::{events::room::message::RoomMessageEventContent, RoomId, ServerName, UserId};
+
+use crate::Command;
+
+#[derive(Debug, Subcommand)]
+pub(crate) enum RoomStateCacheCommand {
+	ServerInRoom {
+		server: Box<ServerName>,
+		room_id: Box<RoomId>,
+	},
+
+	RoomServers {
+		room_id: Box<RoomId>,
+	},
+
+	ServerRooms {
+		server: Box<ServerName>,
+	},
+
+	RoomMembers {
+		room_id: Box<RoomId>,
+	},
+
+	LocalUsersInRoom {
+		room_id: Box<RoomId>,
+	},
+
+	ActiveLocalUsersInRoom {
+		room_id: Box<RoomId>,
+	},
+
+	RoomJoinedCount {
+		room_id: Box<RoomId>,
+	},
+
+	RoomInvitedCount {
+		room_id: Box<RoomId>,
+	},
+
+	RoomUserOnceJoined {
+		room_id: Box<RoomId>,
+	},
+
+	RoomMembersInvited {
+		room_id: Box<RoomId>,
+	},
+
+	GetInviteCount {
+		room_id: Box<RoomId>,
+		user_id: Box<UserId>,
+	},
+
+	GetLeftCount {
+		room_id: Box<RoomId>,
+		user_id: Box<UserId>,
+	},
+
+	RoomsJoined {
+		user_id: Box<UserId>,
+	},
+
+	RoomsLeft {
+		user_id: Box<UserId>,
+	},
+
+	RoomsInvited {
+		user_id: Box<UserId>,
+	},
+
+	InviteState {
+		user_id: Box<UserId>,
+		room_id: Box<RoomId>,
+	},
+}
+
+pub(super) async fn process(
+	subcommand: RoomStateCacheCommand, context: &Command<'_>,
+) -> Result<RoomMessageEventContent> {
+	let services = context.services;
+
+	match subcommand {
+		RoomStateCacheCommand::ServerInRoom {
+			server,
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let result = services
+				.rooms
+				.state_cache
+				.server_in_room(&server, &room_id)
+				.await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{result:#?}\n```"
+			)))
+		},
+		RoomStateCacheCommand::RoomServers {
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Vec<_> = services
+				.rooms
+				.state_cache
+				.room_servers(&room_id)
+				.map(ToOwned::to_owned)
+				.collect()
+				.await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCacheCommand::ServerRooms {
+			server,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Vec<_> = services
+				.rooms
+				.state_cache
+				.server_rooms(&server)
+				.map(ToOwned::to_owned)
+				.collect()
+				.await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCacheCommand::RoomMembers {
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Vec<_> = services
+				.rooms
+				.state_cache
+				.room_members(&room_id)
+				.map(ToOwned::to_owned)
+				.collect()
+				.await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCacheCommand::LocalUsersInRoom {
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Vec<_> = services
+				.rooms
+				.state_cache
+				.local_users_in_room(&room_id)
+				.map(ToOwned::to_owned)
+				.collect()
+				.await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCacheCommand::ActiveLocalUsersInRoom {
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Vec<_> = services
+				.rooms
+				.state_cache
+				.active_local_users_in_room(&room_id)
+				.map(ToOwned::to_owned)
+				.collect()
+				.await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCacheCommand::RoomJoinedCount {
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services.rooms.state_cache.room_joined_count(&room_id).await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCacheCommand::RoomInvitedCount {
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services
+				.rooms
+				.state_cache
+				.room_invited_count(&room_id)
+				.await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCacheCommand::RoomUserOnceJoined {
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Vec<_> = services
+				.rooms
+				.state_cache
+				.room_useroncejoined(&room_id)
+				.map(ToOwned::to_owned)
+				.collect()
+				.await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCacheCommand::RoomMembersInvited {
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Vec<_> = services
+				.rooms
+				.state_cache
+				.room_members_invited(&room_id)
+				.map(ToOwned::to_owned)
+				.collect()
+				.await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCacheCommand::GetInviteCount {
+			room_id,
+			user_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services
+				.rooms
+				.state_cache
+				.get_invite_count(&room_id, &user_id)
+				.await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCacheCommand::GetLeftCount {
+			room_id,
+			user_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services
+				.rooms
+				.state_cache
+				.get_left_count(&room_id, &user_id)
+				.await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCacheCommand::RoomsJoined {
+			user_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Vec<_> = services
+				.rooms
+				.state_cache
+				.rooms_joined(&user_id)
+				.map(ToOwned::to_owned)
+				.collect()
+				.await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCacheCommand::RoomsInvited {
+			user_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Vec<_> = services
+				.rooms
+				.state_cache
+				.rooms_invited(&user_id)
+				.collect()
+				.await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCacheCommand::RoomsLeft {
+			user_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Vec<_> = services
+				.rooms
+				.state_cache
+				.rooms_left(&user_id)
+				.collect()
+				.await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCacheCommand::InviteState {
+			user_id,
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services
+				.rooms
+				.state_cache
+				.invite_state(&user_id, &room_id)
+				.await;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+	}
+}

src/admin/query/sending.rs

@@ -1,27 +1,82 @@
-use ruma::events::room::message::RoomMessageEventContent;
+use clap::Subcommand;
+use conduit::Result;
+use futures::StreamExt;
+use ruma::{events::room::message::RoomMessageEventContent, ServerName, UserId};
+use service::sending::Destination;
 
-use super::Sending;
-use crate::{service::sending::Destination, services, Result};
+use crate::Command;
+
+#[derive(Debug, Subcommand)]
+/// All the getters and iterators from src/database/key_value/sending.rs
+pub(crate) enum SendingCommand {
+	/// - Queries database for all `servercurrentevent_data`
+	ActiveRequests,
+
+	/// - Queries database for `servercurrentevent_data` but for a specific
+	///   destination
+	///
+	/// This command takes only *one* format of these arguments:
+	///
+	/// appservice_id
+	/// server_name
+	/// user_id AND push_key
+	///
+	/// See src/service/sending/mod.rs for the definition of the `Destination`
+	/// enum
+	ActiveRequestsFor {
+		#[arg(short, long)]
+		appservice_id: Option<String>,
+		#[arg(short, long)]
+		server_name: Option<Box<ServerName>>,
+		#[arg(short, long)]
+		user_id: Option<Box<UserId>>,
+		#[arg(short, long)]
+		push_key: Option<String>,
+	},
+
+	/// - Queries database for `servernameevent_data` which are the queued up
+	///   requests that will eventually be sent
+	///
+	/// This command takes only *one* format of these arguments:
+	///
+	/// appservice_id
+	/// server_name
+	/// user_id AND push_key
+	///
+	/// See src/service/sending/mod.rs for the definition of the `Destination`
+	/// enum
+	QueuedRequests {
+		#[arg(short, long)]
+		appservice_id: Option<String>,
+		#[arg(short, long)]
+		server_name: Option<Box<ServerName>>,
+		#[arg(short, long)]
+		user_id: Option<Box<UserId>>,
+		#[arg(short, long)]
+		push_key: Option<String>,
+	},
+
+	GetLatestEduCount {
+		server_name: Box<ServerName>,
+	},
+}
 
 /// All the getters and iterators in key_value/sending.rs
-pub(crate) async fn sending(subcommand: Sending) -> Result<RoomMessageEventContent> {
+pub(super) async fn process(subcommand: SendingCommand, context: &Command<'_>) -> Result<RoomMessageEventContent> {
+	let services = context.services;
+
 	match subcommand {
-		Sending::ActiveRequests => {
+		SendingCommand::ActiveRequests => {
 			let timer = tokio::time::Instant::now();
-			let results = services().sending.db.active_requests();
+			let results = services.sending.db.active_requests();
+			let active_requests = results.collect::<Vec<_>>().await;
 			let query_time = timer.elapsed();
 
-			let active_requests: Result<Vec<(_, _, _)>> = results.collect();
-
-			Ok(RoomMessageEventContent::text_html(
-				format!("Query completed in {query_time:?}:\n\n```\n{:?}```", active_requests),
-				format!(
-					"<p>Query completed in {query_time:?}:</p>\n<pre><code>{:?}\n</code></pre>",
-					active_requests
-				),
-			))
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{active_requests:#?}\n```"
+			)))
 		},
-		Sending::QueuedRequests {
+		SendingCommand::QueuedRequests {
 			appservice_id,
 			server_name,
 			user_id,
@@ -33,8 +88,8 @@ pub(crate) async fn sending(subcommand: Sending) -> Result<RoomMessageEventConte
 					 --help for more details.",
 				));
 			}
-
-			let (results, query_time) = match (appservice_id, server_name, user_id, push_key) {
+			let timer = tokio::time::Instant::now();
+			let results = match (appservice_id, server_name, user_id, push_key) {
 				(Some(appservice_id), None, None, None) => {
 					if appservice_id.is_empty() {
 						return Ok(RoomMessageEventContent::text_plain(
@@ -43,25 +98,15 @@ pub(crate) async fn sending(subcommand: Sending) -> Result<RoomMessageEventConte
 						));
 					}
 
-					let timer = tokio::time::Instant::now();
-					let results = services()
+					services
 						.sending
 						.db
-						.queued_requests(&Destination::Appservice(appservice_id));
-					let query_time = timer.elapsed();
-
-					(results, query_time)
-				},
-				(None, Some(server_name), None, None) => {
-					let timer = tokio::time::Instant::now();
-					let results = services()
-						.sending
-						.db
-						.queued_requests(&Destination::Normal(server_name.into()));
-					let query_time = timer.elapsed();
-
-					(results, query_time)
+						.queued_requests(&Destination::Appservice(appservice_id))
 				},
+				(None, Some(server_name), None, None) => services
+					.sending
+					.db
+					.queued_requests(&Destination::Normal(server_name.into())),
 				(None, None, Some(user_id), Some(push_key)) => {
 					if push_key.is_empty() {
 						return Ok(RoomMessageEventContent::text_plain(
@@ -70,14 +115,10 @@ pub(crate) async fn sending(subcommand: Sending) -> Result<RoomMessageEventConte
 						));
 					}
 
-					let timer = tokio::time::Instant::now();
-					let results = services()
+					services
 						.sending
 						.db
-						.queued_requests(&Destination::Push(user_id.into(), push_key));
-					let query_time = timer.elapsed();
-
-					(results, query_time)
+						.queued_requests(&Destination::Push(user_id.into(), push_key))
 				},
 				(Some(_), Some(_), Some(_), Some(_)) => {
 					return Ok(RoomMessageEventContent::text_plain(
@@ -93,17 +134,14 @@ pub(crate) async fn sending(subcommand: Sending) -> Result<RoomMessageEventConte
 				},
 			};
 
-			let queued_requests = results.collect::<Result<Vec<(_, _)>>>();
+			let queued_requests = results.collect::<Vec<_>>().await;
+			let query_time = timer.elapsed();
 
-			Ok(RoomMessageEventContent::text_html(
-				format!("Query completed in {query_time:?}:\n\n```\n{:?}```", queued_requests),
-				format!(
-					"<p>Query completed in {query_time:?}:</p>\n<pre><code>{:?}\n</code></pre>",
-					queued_requests
-				),
-			))
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{queued_requests:#?}\n```"
+			)))
 		},
-		Sending::ActiveRequestsFor {
+		SendingCommand::ActiveRequestsFor {
 			appservice_id,
 			server_name,
 			user_id,
@@ -116,7 +154,8 @@ pub(crate) async fn sending(subcommand: Sending) -> Result<RoomMessageEventConte
 				));
 			}
 
-			let (results, query_time) = match (appservice_id, server_name, user_id, push_key) {
+			let timer = tokio::time::Instant::now();
+			let results = match (appservice_id, server_name, user_id, push_key) {
 				(Some(appservice_id), None, None, None) => {
 					if appservice_id.is_empty() {
 						return Ok(RoomMessageEventContent::text_plain(
@@ -125,25 +164,15 @@ pub(crate) async fn sending(subcommand: Sending) -> Result<RoomMessageEventConte
 						));
 					}
 
-					let timer = tokio::time::Instant::now();
-					let results = services()
+					services
 						.sending
 						.db
-						.active_requests_for(&Destination::Appservice(appservice_id));
-					let query_time = timer.elapsed();
-
-					(results, query_time)
-				},
-				(None, Some(server_name), None, None) => {
-					let timer = tokio::time::Instant::now();
-					let results = services()
-						.sending
-						.db
-						.active_requests_for(&Destination::Normal(server_name.into()));
-					let query_time = timer.elapsed();
-
-					(results, query_time)
+						.active_requests_for(&Destination::Appservice(appservice_id))
 				},
+				(None, Some(server_name), None, None) => services
+					.sending
+					.db
+					.active_requests_for(&Destination::Normal(server_name.into())),
 				(None, None, Some(user_id), Some(push_key)) => {
 					if push_key.is_empty() {
 						return Ok(RoomMessageEventContent::text_plain(
@@ -152,14 +181,10 @@ pub(crate) async fn sending(subcommand: Sending) -> Result<RoomMessageEventConte
 						));
 					}
 
-					let timer = tokio::time::Instant::now();
-					let results = services()
+					services
 						.sending
 						.db
-						.active_requests_for(&Destination::Push(user_id.into(), push_key));
-					let query_time = timer.elapsed();
-
-					(results, query_time)
+						.active_requests_for(&Destination::Push(user_id.into(), push_key))
 				},
 				(Some(_), Some(_), Some(_), Some(_)) => {
 					return Ok(RoomMessageEventContent::text_plain(
@@ -175,30 +200,23 @@ pub(crate) async fn sending(subcommand: Sending) -> Result<RoomMessageEventConte
 				},
 			};
 
-			let active_requests = results.collect::<Result<Vec<(_, _)>>>();
+			let active_requests = results.collect::<Vec<_>>().await;
+			let query_time = timer.elapsed();
 
-			Ok(RoomMessageEventContent::text_html(
-				format!("Query completed in {query_time:?}:\n\n```\n{:?}```", active_requests),
-				format!(
-					"<p>Query completed in {query_time:?}:</p>\n<pre><code>{:?}\n</code></pre>",
-					active_requests
-				),
-			))
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{active_requests:#?}\n```"
+			)))
 		},
-		Sending::GetLatestEduCount {
+		SendingCommand::GetLatestEduCount {
 			server_name,
 		} => {
 			let timer = tokio::time::Instant::now();
-			let results = services().sending.db.get_latest_educount(&server_name);
+			let results = services.sending.db.get_latest_educount(&server_name).await;
 			let query_time = timer.elapsed();
 
-			Ok(RoomMessageEventContent::text_html(
-				format!("Query completed in {query_time:?}:\n\n```\n{:?}```", results),
-				format!(
-					"<p>Query completed in {query_time:?}:</p>\n<pre><code>{:?}\n</code></pre>",
-					results
-				),
-			))
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
 		},
 	}
 }

src/admin/query/users.rs

@@ -0,0 +1,344 @@
+use clap::Subcommand;
+use conduit::Result;
+use futures::stream::StreamExt;
+use ruma::{events::room::message::RoomMessageEventContent, OwnedDeviceId, OwnedRoomId, OwnedUserId};
+
+use crate::{admin_command, admin_command_dispatch};
+
+#[admin_command_dispatch]
+#[derive(Debug, Subcommand)]
+/// All the getters and iterators from src/database/key_value/users.rs
+pub(crate) enum UsersCommand {
+	CountUsers,
+
+	IterUsers,
+
+	PasswordHash {
+		user_id: OwnedUserId,
+	},
+
+	ListDevices {
+		user_id: OwnedUserId,
+	},
+
+	ListDevicesMetadata {
+		user_id: OwnedUserId,
+	},
+
+	GetDeviceMetadata {
+		user_id: OwnedUserId,
+		device_id: OwnedDeviceId,
+	},
+
+	GetDevicesVersion {
+		user_id: OwnedUserId,
+	},
+
+	CountOneTimeKeys {
+		user_id: OwnedUserId,
+		device_id: OwnedDeviceId,
+	},
+
+	GetDeviceKeys {
+		user_id: OwnedUserId,
+		device_id: OwnedDeviceId,
+	},
+
+	GetUserSigningKey {
+		user_id: OwnedUserId,
+	},
+
+	GetMasterKey {
+		user_id: OwnedUserId,
+	},
+
+	GetToDeviceEvents {
+		user_id: OwnedUserId,
+		device_id: OwnedDeviceId,
+	},
+
+	GetLatestBackup {
+		user_id: OwnedUserId,
+	},
+
+	GetLatestBackupVersion {
+		user_id: OwnedUserId,
+	},
+
+	GetBackupAlgorithm {
+		user_id: OwnedUserId,
+		version: String,
+	},
+
+	GetAllBackups {
+		user_id: OwnedUserId,
+		version: String,
+	},
+
+	GetRoomBackups {
+		user_id: OwnedUserId,
+		version: String,
+		room_id: OwnedRoomId,
+	},
+
+	GetBackupSession {
+		user_id: OwnedUserId,
+		version: String,
+		room_id: OwnedRoomId,
+		session_id: String,
+	},
+}
+
+#[admin_command]
+async fn get_backup_session(
+	&self, user_id: OwnedUserId, version: String, room_id: OwnedRoomId, session_id: String,
+) -> Result<RoomMessageEventContent> {
+	let timer = tokio::time::Instant::now();
+	let result = self
+		.services
+		.key_backups
+		.get_session(&user_id, &version, &room_id, &session_id)
+		.await;
+	let query_time = timer.elapsed();
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Query completed in {query_time:?}:\n\n```rs\n{result:#?}\n```"
+	)))
+}
+
+#[admin_command]
+async fn get_room_backups(
+	&self, user_id: OwnedUserId, version: String, room_id: OwnedRoomId,
+) -> Result<RoomMessageEventContent> {
+	let timer = tokio::time::Instant::now();
+	let result = self
+		.services
+		.key_backups
+		.get_room(&user_id, &version, &room_id)
+		.await;
+	let query_time = timer.elapsed();
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Query completed in {query_time:?}:\n\n```rs\n{result:#?}\n```"
+	)))
+}
+
+#[admin_command]
+async fn get_all_backups(&self, user_id: OwnedUserId, version: String) -> Result<RoomMessageEventContent> {
+	let timer = tokio::time::Instant::now();
+	let result = self.services.key_backups.get_all(&user_id, &version).await;
+	let query_time = timer.elapsed();
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Query completed in {query_time:?}:\n\n```rs\n{result:#?}\n```"
+	)))
+}
+
+#[admin_command]
+async fn get_backup_algorithm(&self, user_id: OwnedUserId, version: String) -> Result<RoomMessageEventContent> {
+	let timer = tokio::time::Instant::now();
+	let result = self
+		.services
+		.key_backups
+		.get_backup(&user_id, &version)
+		.await;
+	let query_time = timer.elapsed();
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Query completed in {query_time:?}:\n\n```rs\n{result:#?}\n```"
+	)))
+}
+
+#[admin_command]
+async fn get_latest_backup_version(&self, user_id: OwnedUserId) -> Result<RoomMessageEventContent> {
+	let timer = tokio::time::Instant::now();
+	let result = self
+		.services
+		.key_backups
+		.get_latest_backup_version(&user_id)
+		.await;
+	let query_time = timer.elapsed();
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Query completed in {query_time:?}:\n\n```rs\n{result:#?}\n```"
+	)))
+}
+
+#[admin_command]
+async fn get_latest_backup(&self, user_id: OwnedUserId) -> Result<RoomMessageEventContent> {
+	let timer = tokio::time::Instant::now();
+	let result = self.services.key_backups.get_latest_backup(&user_id).await;
+	let query_time = timer.elapsed();
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Query completed in {query_time:?}:\n\n```rs\n{result:#?}\n```"
+	)))
+}
+
+#[admin_command]
+async fn iter_users(&self) -> Result<RoomMessageEventContent> {
+	let timer = tokio::time::Instant::now();
+	let result: Vec<OwnedUserId> = self.services.users.stream().map(Into::into).collect().await;
+
+	let query_time = timer.elapsed();
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Query completed in {query_time:?}:\n\n```rs\n{result:#?}\n```"
+	)))
+}
+
+#[admin_command]
+async fn count_users(&self) -> Result<RoomMessageEventContent> {
+	let timer = tokio::time::Instant::now();
+	let result = self.services.users.count().await;
+	let query_time = timer.elapsed();
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Query completed in {query_time:?}:\n\n```rs\n{result:#?}\n```"
+	)))
+}
+
+#[admin_command]
+async fn password_hash(&self, user_id: OwnedUserId) -> Result<RoomMessageEventContent> {
+	let timer = tokio::time::Instant::now();
+	let result = self.services.users.password_hash(&user_id).await;
+	let query_time = timer.elapsed();
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Query completed in {query_time:?}:\n\n```rs\n{result:#?}\n```"
+	)))
+}
+
+#[admin_command]
+async fn list_devices(&self, user_id: OwnedUserId) -> Result<RoomMessageEventContent> {
+	let timer = tokio::time::Instant::now();
+	let devices = self
+		.services
+		.users
+		.all_device_ids(&user_id)
+		.map(ToOwned::to_owned)
+		.collect::<Vec<_>>()
+		.await;
+
+	let query_time = timer.elapsed();
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Query completed in {query_time:?}:\n\n```rs\n{devices:#?}\n```"
+	)))
+}
+
+#[admin_command]
+async fn list_devices_metadata(&self, user_id: OwnedUserId) -> Result<RoomMessageEventContent> {
+	let timer = tokio::time::Instant::now();
+	let devices = self
+		.services
+		.users
+		.all_devices_metadata(&user_id)
+		.collect::<Vec<_>>()
+		.await;
+	let query_time = timer.elapsed();
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Query completed in {query_time:?}:\n\n```rs\n{devices:#?}\n```"
+	)))
+}
+
+#[admin_command]
+async fn get_device_metadata(&self, user_id: OwnedUserId, device_id: OwnedDeviceId) -> Result<RoomMessageEventContent> {
+	let timer = tokio::time::Instant::now();
+	let device = self
+		.services
+		.users
+		.get_device_metadata(&user_id, &device_id)
+		.await;
+	let query_time = timer.elapsed();
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Query completed in {query_time:?}:\n\n```rs\n{device:#?}\n```"
+	)))
+}
+
+#[admin_command]
+async fn get_devices_version(&self, user_id: OwnedUserId) -> Result<RoomMessageEventContent> {
+	let timer = tokio::time::Instant::now();
+	let device = self.services.users.get_devicelist_version(&user_id).await;
+	let query_time = timer.elapsed();
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Query completed in {query_time:?}:\n\n```rs\n{device:#?}\n```"
+	)))
+}
+
+#[admin_command]
+async fn count_one_time_keys(&self, user_id: OwnedUserId, device_id: OwnedDeviceId) -> Result<RoomMessageEventContent> {
+	let timer = tokio::time::Instant::now();
+	let result = self
+		.services
+		.users
+		.count_one_time_keys(&user_id, &device_id)
+		.await;
+	let query_time = timer.elapsed();
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Query completed in {query_time:?}:\n\n```rs\n{result:#?}\n```"
+	)))
+}
+
+#[admin_command]
+async fn get_device_keys(&self, user_id: OwnedUserId, device_id: OwnedDeviceId) -> Result<RoomMessageEventContent> {
+	let timer = tokio::time::Instant::now();
+	let result = self
+		.services
+		.users
+		.get_device_keys(&user_id, &device_id)
+		.await;
+	let query_time = timer.elapsed();
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Query completed in {query_time:?}:\n\n```rs\n{result:#?}\n```"
+	)))
+}
+
+#[admin_command]
+async fn get_user_signing_key(&self, user_id: OwnedUserId) -> Result<RoomMessageEventContent> {
+	let timer = tokio::time::Instant::now();
+	let result = self.services.users.get_user_signing_key(&user_id).await;
+	let query_time = timer.elapsed();
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Query completed in {query_time:?}:\n\n```rs\n{result:#?}\n```"
+	)))
+}
+
+#[admin_command]
+async fn get_master_key(&self, user_id: OwnedUserId) -> Result<RoomMessageEventContent> {
+	let timer = tokio::time::Instant::now();
+	let result = self
+		.services
+		.users
+		.get_master_key(None, &user_id, &|_| true)
+		.await;
+	let query_time = timer.elapsed();
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Query completed in {query_time:?}:\n\n```rs\n{result:#?}\n```"
+	)))
+}
+
+#[admin_command]
+async fn get_to_device_events(
+	&self, user_id: OwnedUserId, device_id: OwnedDeviceId,
+) -> Result<RoomMessageEventContent> {
+	let timer = tokio::time::Instant::now();
+	let result = self
+		.services
+		.users
+		.get_to_device_events(&user_id, &device_id)
+		.collect::<Vec<_>>()
+		.await;
+	let query_time = timer.elapsed();
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Query completed in {query_time:?}:\n\n```rs\n{result:#?}\n```"
+	)))
+}

src/admin/room/alias.rs

@@ -0,0 +1,182 @@
+use std::fmt::Write;
+
+use clap::Subcommand;
+use conduit::Result;
+use futures::StreamExt;
+use ruma::{events::room::message::RoomMessageEventContent, OwnedRoomAliasId, OwnedRoomId, RoomAliasId, RoomId};
+
+use crate::{escape_html, Command};
+
+#[derive(Debug, Subcommand)]
+pub(crate) enum RoomAliasCommand {
+	/// - Make an alias point to a room.
+	Set {
+		#[arg(short, long)]
+		/// Set the alias even if a room is already using it
+		force: bool,
+
+		/// The room id to set the alias on
+		room_id: Box<RoomId>,
+
+		/// The alias localpart to use (`alias`, not `#alias:servername.tld`)
+		room_alias_localpart: String,
+	},
+
+	/// - Remove a local alias
+	Remove {
+		/// The alias localpart to remove (`alias`, not `#alias:servername.tld`)
+		room_alias_localpart: String,
+	},
+
+	/// - Show which room is using an alias
+	Which {
+		/// The alias localpart to look up (`alias`, not
+		/// `#alias:servername.tld`)
+		room_alias_localpart: String,
+	},
+
+	/// - List aliases currently being used
+	List {
+		/// If set, only list the aliases for this room
+		room_id: Option<Box<RoomId>>,
+	},
+}
+
+pub(super) async fn process(command: RoomAliasCommand, context: &Command<'_>) -> Result<RoomMessageEventContent> {
+	let services = context.services;
+	let server_user = &services.globals.server_user;
+
+	match command {
+		RoomAliasCommand::Set {
+			ref room_alias_localpart,
+			..
+		}
+		| RoomAliasCommand::Remove {
+			ref room_alias_localpart,
+		}
+		| RoomAliasCommand::Which {
+			ref room_alias_localpart,
+		} => {
+			let room_alias_str = format!("#{}:{}", room_alias_localpart, services.globals.server_name());
+			let room_alias = match RoomAliasId::parse_box(room_alias_str) {
+				Ok(alias) => alias,
+				Err(err) => return Ok(RoomMessageEventContent::text_plain(format!("Failed to parse alias: {err}"))),
+			};
+			match command {
+				RoomAliasCommand::Set {
+					force,
+					room_id,
+					..
+				} => match (force, services.rooms.alias.resolve_local_alias(&room_alias).await) {
+					(true, Ok(id)) => match services
+						.rooms
+						.alias
+						.set_alias(&room_alias, &room_id, server_user)
+					{
+						Ok(()) => Ok(RoomMessageEventContent::text_plain(format!(
+							"Successfully overwrote alias (formerly {id})"
+						))),
+						Err(err) => Ok(RoomMessageEventContent::text_plain(format!("Failed to remove alias: {err}"))),
+					},
+					(false, Ok(id)) => Ok(RoomMessageEventContent::text_plain(format!(
+						"Refusing to overwrite in use alias for {id}, use -f or --force to overwrite"
+					))),
+					(_, Err(_)) => match services
+						.rooms
+						.alias
+						.set_alias(&room_alias, &room_id, server_user)
+					{
+						Ok(()) => Ok(RoomMessageEventContent::text_plain("Successfully set alias")),
+						Err(err) => Ok(RoomMessageEventContent::text_plain(format!("Failed to remove alias: {err}"))),
+					},
+				},
+				RoomAliasCommand::Remove {
+					..
+				} => match services.rooms.alias.resolve_local_alias(&room_alias).await {
+					Ok(id) => match services
+						.rooms
+						.alias
+						.remove_alias(&room_alias, server_user)
+						.await
+					{
+						Ok(()) => Ok(RoomMessageEventContent::text_plain(format!("Removed alias from {id}"))),
+						Err(err) => Ok(RoomMessageEventContent::text_plain(format!("Failed to remove alias: {err}"))),
+					},
+					Err(_) => Ok(RoomMessageEventContent::text_plain("Alias isn't in use.")),
+				},
+				RoomAliasCommand::Which {
+					..
+				} => match services.rooms.alias.resolve_local_alias(&room_alias).await {
+					Ok(id) => Ok(RoomMessageEventContent::text_plain(format!("Alias resolves to {id}"))),
+					Err(_) => Ok(RoomMessageEventContent::text_plain("Alias isn't in use.")),
+				},
+				RoomAliasCommand::List {
+					..
+				} => unreachable!(),
+			}
+		},
+		RoomAliasCommand::List {
+			room_id,
+		} => {
+			if let Some(room_id) = room_id {
+				let aliases: Vec<OwnedRoomAliasId> = services
+					.rooms
+					.alias
+					.local_aliases_for_room(&room_id)
+					.map(Into::into)
+					.collect()
+					.await;
+
+				let plain_list = aliases.iter().fold(String::new(), |mut output, alias| {
+					writeln!(output, "- {alias}").expect("should be able to write to string buffer");
+					output
+				});
+
+				let html_list = aliases.iter().fold(String::new(), |mut output, alias| {
+					writeln!(output, "<li>{}</li>", escape_html(alias.as_ref()))
+						.expect("should be able to write to string buffer");
+					output
+				});
+
+				let plain = format!("Aliases for {room_id}:\n{plain_list}");
+				let html = format!("Aliases for {room_id}:\n<ul>{html_list}</ul>");
+				Ok(RoomMessageEventContent::text_html(plain, html))
+			} else {
+				let aliases = services
+					.rooms
+					.alias
+					.all_local_aliases()
+					.map(|(room_id, localpart)| (room_id.into(), localpart.into()))
+					.collect::<Vec<(OwnedRoomId, String)>>()
+					.await;
+
+				let server_name = services.globals.server_name();
+				let plain_list = aliases
+					.iter()
+					.fold(String::new(), |mut output, (alias, id)| {
+						writeln!(output, "- `{alias}` -> #{id}:{server_name}")
+							.expect("should be able to write to string buffer");
+						output
+					});
+
+				let html_list = aliases
+					.iter()
+					.fold(String::new(), |mut output, (alias, id)| {
+						writeln!(
+							output,
+							"<li><code>{}</code> -> #{}:{}</li>",
+							escape_html(alias.as_ref()),
+							escape_html(id),
+							server_name
+						)
+						.expect("should be able to write to string buffer");
+						output
+					});
+
+				let plain = format!("Aliases:\n{plain_list}");
+				let html = format!("Aliases:\n<ul>{html_list}</ul>");
+				Ok(RoomMessageEventContent::text_html(plain, html))
+			}
+		},
+	}
+}

src/admin/room/commands.rs

@@ -0,0 +1,63 @@
+use conduit::Result;
+use futures::StreamExt;
+use ruma::{events::room::message::RoomMessageEventContent, OwnedRoomId};
+
+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, 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);
+	let mut rooms = self
+		.services
+		.rooms
+		.metadata
+		.iter_ids()
+		.filter_map(|room_id| async move {
+			(!exclude_disabled || !self.services.rooms.metadata.is_disabled(room_id).await).then_some(room_id)
+		})
+		.filter_map(|room_id| async move {
+			(!exclude_banned || !self.services.rooms.metadata.is_banned(room_id).await).then_some(room_id)
+		})
+		.then(|room_id| get_room_info(self.services, room_id))
+		.collect::<Vec<_>>()
+		.await;
+
+	rooms.sort_by_key(|r| r.1);
+	rooms.reverse();
+
+	let rooms = rooms
+		.into_iter()
+		.skip(page.saturating_sub(1).saturating_mul(PAGE_SIZE))
+		.take(PAGE_SIZE)
+		.collect::<Vec<_>>();
+
+	if rooms.is_empty() {
+		return Ok(RoomMessageEventContent::text_plain("No more rooms."));
+	};
+
+	let output_plain = format!(
+		"Rooms ({}):\n```\n{}\n```",
+		rooms.len(),
+		rooms
+			.iter()
+			.map(|(id, members, name)| if no_details {
+				format!("{id}")
+			} else {
+				format!("{id}\tMembers: {members}\tName: {name}")
+			})
+			.collect::<Vec<_>>()
+			.join("\n")
+	);
+
+	Ok(RoomMessageEventContent::notice_markdown(output_plain))
+}
+
+#[admin_command]
+pub(super) async fn exists(&self, room_id: OwnedRoomId) -> Result<RoomMessageEventContent> {
+	let result = self.services.rooms.metadata.exists(&room_id).await;
+
+	Ok(RoomMessageEventContent::notice_markdown(format!("{result}")))
+}

src/admin/room/directory.rs

@@ -0,0 +1,80 @@
+use clap::Subcommand;
+use conduit::Result;
+use futures::StreamExt;
+use ruma::{events::room::message::RoomMessageEventContent, RoomId};
+
+use crate::{get_room_info, Command, PAGE_SIZE};
+
+#[derive(Debug, Subcommand)]
+pub(crate) enum RoomDirectoryCommand {
+	/// - Publish a room to the room directory
+	Publish {
+		/// The room id of the room to publish
+		room_id: Box<RoomId>,
+	},
+
+	/// - Unpublish a room to the room directory
+	Unpublish {
+		/// The room id of the room to unpublish
+		room_id: Box<RoomId>,
+	},
+
+	/// - List rooms that are published
+	List {
+		page: Option<usize>,
+	},
+}
+
+pub(super) async fn process(command: RoomDirectoryCommand, context: &Command<'_>) -> Result<RoomMessageEventContent> {
+	let services = context.services;
+	match command {
+		RoomDirectoryCommand::Publish {
+			room_id,
+		} => {
+			services.rooms.directory.set_public(&room_id);
+			Ok(RoomMessageEventContent::notice_plain("Room published"))
+		},
+		RoomDirectoryCommand::Unpublish {
+			room_id,
+		} => {
+			services.rooms.directory.set_not_public(&room_id);
+			Ok(RoomMessageEventContent::notice_plain("Room unpublished"))
+		},
+		RoomDirectoryCommand::List {
+			page,
+		} => {
+			// 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);
+			let mut rooms: Vec<_> = services
+				.rooms
+				.directory
+				.public_rooms()
+				.then(|room_id| get_room_info(services, room_id))
+				.collect()
+				.await;
+
+			rooms.sort_by_key(|r| r.1);
+			rooms.reverse();
+
+			let rooms: Vec<_> = rooms
+				.into_iter()
+				.skip(page.saturating_sub(1).saturating_mul(PAGE_SIZE))
+				.take(PAGE_SIZE)
+				.collect();
+
+			if rooms.is_empty() {
+				return Ok(RoomMessageEventContent::text_plain("No more rooms."));
+			};
+
+			let output = format!(
+				"Rooms (page {page}):\n```\n{}\n```",
+				rooms
+					.iter()
+					.map(|(id, members, name)| format!("{id} | Members: {members} | Name: {name}"))
+					.collect::<Vec<_>>()
+					.join("\n")
+			);
+			Ok(RoomMessageEventContent::text_markdown(output))
+		},
+	}
+}