add admin query resolver commands

Signed-off-by: Jason Volk <jason@zemos.net>

.editorconfig

@@ -11,5 +11,10 @@ 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

.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/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

@@ -14,10 +14,11 @@ on:
           - 'docs/**'
           - 'debian/**'
           - 'docker/**'
-          - 'test_results/**'
         branches:
             - main
-            - dev
+            - change-ci-cache
+        tags:
+          - '*'
     # Allows you to run this workflow manually from the Actions tab
     workflow_dispatch:
 
@@ -30,11 +31,15 @@ env:
     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
@@ -45,11 +50,25 @@ jobs:
         name: Test
         runs-on: ubuntu-latest
         steps:
+            - name: Free Disk Space (Ubuntu)
+              uses: jlumbroso/free-disk-space@main
+
             - 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')
+              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@v28
 
             - name: Enable Cachix binary cache
               run: |
@@ -57,20 +76,38 @@ jobs:
                   cachix use crane
                   cachix use nix-community
 
-            - name: Configure Magic Nix Cache
-              uses: DeterminateSystems/magic-nix-cache-action@main
+            - 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: 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/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
+                  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
@@ -80,7 +117,13 @@ 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
+
+            - name: Cache CI dependencies
+              run: |
+                  bin/nix-build-and-cache ci
+
+            - uses: Swatinem/rust-cache@v2
 
             - name: Run CI tests
               run: |
@@ -95,6 +138,14 @@ jobs:
             - 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: 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,16 +162,11 @@ 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: |
+                  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 50 complement_test_output.log | sed 's/\x1b\[[0-9;]*m//g' >> $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
@@ -130,7 +176,7 @@ jobs:
                       echo '# ✅ completed suwuccessfully' >> $GITHUB_STEP_SUMMARY
                   else
                       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
                   fi
 
@@ -138,41 +184,55 @@ jobs:
         name: Build
         runs-on: ubuntu-latest
         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
         steps:
             - name: Sync repository
               uses: actions/checkout@v4
 
-            - name: Install Nix
-              uses: DeterminateSystems/nix-installer-action@main
+            - uses: nixbuild/nix-quick-install-action@v28
 
-            - name: Install and enable Cachix binary cache
+            - 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: 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: 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/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
+                  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 +242,22 @@ 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
 
             - 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 -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 }}
+                  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: actions/upload-artifact@v4
@@ -203,8 +270,9 @@ 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: Build OCI image ${{ matrix.target }}
               run: |
@@ -223,20 +291,21 @@ jobs:
         name: Docker publish
         runs-on: ubuntu-latest
         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') && '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') && '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') && '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 +337,8 @@ 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-*/*.tar.gz oci-image-amd64.tar.gz
+                  mv -v oci-image-aarch64-*/*.tar.gz oci-image-arm64v8.tar.gz
 
             - name: Load and push amd64 image
               if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}

.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,13 @@ 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
+  NIX_CONFIG: show-trace = 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,7 +33,6 @@ concurrency:
 jobs:
   docs:
     name: Documentation and GitHub Pages
-
     runs-on: ubuntu-latest
 
     permissions:
@@ -46,49 +51,65 @@ jobs:
         if: 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@v28
+
+      - name: Enable Cachix binary cache
+        run: |
+            nix profile install nixpkgs#cachix
+            cachix use crane
+            cachix use nix-community
+
+      - 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: |
-            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=
+      - 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/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: 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 --impure --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: |

.github/workflows/trivy.yml

@@ -5,6 +5,8 @@ on:
   push:
     branches:
       - main
+    tags:
+      - '*'
   schedule:
     - cron: '00 12 * * *'
 
@@ -24,7 +26,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Run Trivy code and vulnerability scanner on repo
-        uses: aquasecurity/trivy-action@0.19.0
+        uses: aquasecurity/trivy-action@0.23.0
         with:
           scan-type: repo
           format: sarif
@@ -32,9 +34,9 @@ jobs:
           severity: CRITICAL,HIGH,MEDIUM,LOW
 
       - name: Run Trivy code and vulnerability scanner on filesystem
-        uses: aquasecurity/trivy-action@0.19.0
+        uses: aquasecurity/trivy-action@0.23.0
         with:
           scan-type: fs
           format: sarif
           output: trivy-results.sarif
-          severity: CRITICAL,HIGH,MEDIUM,LOW
+          severity: CRITICAL,HIGH,MEDIUM,LOW

.gitignore

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

.gitlab-ci.yml

@@ -26,15 +26,19 @@ before_script:
 
   # 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
@@ -54,7 +58,7 @@ before_script:
 
 ci:
   stage: ci
-  image: nixos/nix:2.22.0
+  image: nixos/nix:2.23.1
   script:
     # Cache CI dependencies
     - ./bin/nix-build-and-cache ci
@@ -79,7 +83,7 @@ ci:
 
 artifacts:
   stage: artifacts
-  image: nixos/nix:2.22.0
+  image: nixos/nix:2.23.1
   script:
     - ./bin/nix-build-and-cache just .#static-x86_64-unknown-linux-musl
     - cp result/bin/conduit x86_64-unknown-linux-musl

.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,95 @@
+# 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]
+
+### 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](docs/development/testing.md) page.
+
+[Sytest][sytest] support will come soon.
+
+### Writing documentation
+
+conduwuit's website uses [`mdbook`][mdbook] and deployed via CI using GitHub Pages in the [`documentation.yml`][documentation.yml] workflow file with Nix's mdbook in the devshell. All documentation is in the `docs/` directory at the top level. The compiled mdbook website is also uploaded as an artifact.
+
+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.
+
+[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

@@ -2,8 +2,6 @@ # 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)
-
 <!-- ANCHOR: catchphrase -->
 ### a very cool, featureful fork of [Conduit](https://conduit.rs/)
 <!-- ANCHOR_END: catchphrase -->
@@ -28,6 +26,10 @@ #### 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))
 
+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
@@ -37,18 +39,11 @@ #### What is the current status?
 <!-- 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)
 
@@ -69,7 +64,8 @@ #### 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>

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

@@ -15,17 +15,20 @@ LOG_FILE="$2"
 # A `.jsonl` file to write test results to
 RESULTS_FILE="$3"
 
-OCI_IMAGE="complement-conduit:dev"
+OCI_IMAGE="complement-conduit:main"
+
+# Complement tests that are skipped due to flakiness/reliability issues (likely
+# Complement itself induced based on various open issues)
+#
+# According to Go docs, these are separated by forward slashes and not pipes (why)
+SKIPPED_COMPLEMENT_TESTS='-skip=TestClientSpacesSummary.*|TestJoinFederatedRoomFromApplicationServiceBridgeUser.*|TestJumpToDateEndpoint.*'
 
 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 .#static-complement
+
 docker load < result
 popd > /dev/null
 
@@ -34,7 +37,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,61 @@ 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 "$@")
+    cache=()
+    for derivation in "${derivations[@]}"; do
+        cache+=(
+            "$(nix-store --query --requisites --include-outputs "$derivation")"
+        )
+    done
+
+    # 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'
+        nix shell --inputs-from "$toplevel" attic -c xargs \
+            attic push conduit <<< "${cache[*]}"
+    )
+
+    # 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'
+        nix shell --inputs-from "$toplevel" attic -c xargs \
+            attic push conduwuit <<< "${cache[*]}"
+
+        # 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 +76,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,7 @@
-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 = 144000               # reduce me ALARA
+too-many-lines-threshold = 700              # TODO reduce me to <= 100
+type-complexity-threshold = 250             # reduce me to ~200

conduwuit-example.toml

@@ -60,12 +60,11 @@
 
 ### Database configuration
 
-# This is the only directory where conduwuit will save its data, including media
-database_path = "/var/lib/matrix-conduit/"
+# This is the only directory where conduwuit will save its data, including media.
+# Note: this was previously "/var/lib/matrix-conduit"
+database_path = "/var/lib/conduwuit"
 
-# Database backend: Only rocksdb and sqlite are supported. Please note that sqlite
-# will perform significantly worse than rocksdb as it is not intended to be used the
-# way it is by conduwuit. sqlite only exists for historical reasons.
+# Database backend: Only rocksdb is supported.
 database_backend = "rocksdb"
 
 
@@ -76,11 +75,16 @@ database_backend = "rocksdb"
 # forwarded to the conduwuit instance running on this port
 # Docker users: Don't change this, you'll need to map an external port to this.
 # To listen on multiple ports, specify a vector e.g. [8080, 8448]
+#
+# default if unspecified is 8008
 port = 6167
 
 # default address (IPv4 or IPv6) conduwuit will listen on. Generally you want this to be
 # localhost (127.0.0.1 / ::1). If you are using Docker or a container NAT networking setup, you
 # likely need this to be 0.0.0.0.
+# To listen multiple addresses, specify a vector e.g. ["127.0.0.1", "::1"]
+#
+# default if unspecified is both IPv4 and IPv6 localhost: ["127.0.0.1", "::1"]
 address = "127.0.0.1"
 
 # Max request size for file uploads
@@ -192,6 +196,11 @@ registration_token = "change this token for something specific to your server"
 # defaults to false
 # block_non_admin_invites = false
 
+# Allows admins to enter commands in rooms other than #admins by prefixing with \!admin. The reply
+# will be publicly visible to the room, originating from the sender.
+# defaults to true
+#admin_escape_commands = true
+
 # List of forbidden username patterns/strings. Values in this list are matched as *contains*.
 # This is checked upon username availability check, registration, and startup as warnings if any local users in your database
 # have a forbidden username.
@@ -269,6 +278,19 @@ url_preview_check_root_domain = false
 # Defaults to true
 allow_profile_lookup_federation_requests = true
 
+# Config option to automatically deactivate the account of any user who attempts to join a:
+# - banned room
+# - forbidden room alias
+# - room alias or ID with a forbidden server name
+#
+# This may be useful if all your banned lists consist of toxic rooms or servers that no good faith user would ever attempt to join, and
+# to automatically remediate the problem without any admin user intervention.
+#
+# This will also make the user leave all rooms. Federation (e.g. remote room invites) are ignored here.
+#
+# Defaults to false as rooms can be banned for non-moderation-related reasons
+#auto_deactivate_banned_room_attempts = false
+
 
 ### Misc
 
@@ -349,6 +371,42 @@ allow_profile_lookup_federation_requests = true
 # If 'tracing_flame' is enabled, set the path to write the generated profile.
 # tracing_flame_output_path = "./tracing.folded"
 
+# Enable the tokio-console. This option is only relevant to developers.
+# See: docs/development.md#debugging-with-tokio-console for more information.
+#tokio_console = false
+
+# Enable backward-compatibility with Conduit's media directory by creating symlinks of media. This
+# option is only necessary if you plan on using Conduit again. Otherwise setting this to false
+# reduces filesystem clutter and overhead for managing these symlinks in the directory.
+#
+# Enabled by default.
+#media_compat_file_link = true
+
+# Checks consistency of the media directory at startup:
+# 1. When `media_compat_file_link` is enbled, this check will upgrade media when switching back
+#    and forth between Conduit and Conduwuit. Both options must be enabled to handle this.
+# 2. When media is deleted from the directory, this check will also delete its database entry.
+#
+# If none of these checks apply to your use cases, and your media directory is significantly large
+# setting this to false may reduce startup time.
+#
+# Enabled by default.
+#media_statup_check = true
+
+# OpenID token expiration/TTL in seconds
+#
+# These are the OpenID tokens that are primarily used for Matrix account integrations, *not* OIDC/OpenID Connect/etc
+#
+# Defaults to 3600 (1 hour)
+#openid_token_ttl = 3600
+
+# Emergency password feature. This password set here will let you login to the server service account (e.g. `@conduit`)
+# and let you run admin commands, invite yourself to the admin room, etc.
+#
+# no default.
+#emergency_password = ""
+
+
 ### Generic database options
 
 # Set this to any float value to multiply conduwuit's in-memory LRU caches with.
@@ -361,15 +419,6 @@ allow_profile_lookup_federation_requests = true
 # Defaults to 256.0
 #db_cache_capacity_mb = 256.0
 
-# Interval in seconds when conduwuit will run database cleanup operations.
-#
-# For SQLite: this will flush the WAL by executing `PRAGMA wal_checkpoint(RESTART)` (https://www.sqlite.org/pragma.html#pragma_wal_checkpoint)
-# For RocksDB: this will run `flush_opt` to flush database memtables to SST files on disk (https://docs.rs/rocksdb/latest/rocksdb/struct.DBCommon.html#method.flush_opt)
-# These operations always run on shutdown.
-#
-# Defaults to 30 minutes (1800 seconds) to avoid IO amplification from too frequent cleanups
-#cleanup_second_interval = 1800
-
 
 ### RocksDB options
 
@@ -478,11 +527,6 @@ allow_profile_lookup_federation_requests = true
 # Defaults to 1 (TolerateCorruptedTailRecords)
 #rocksdb_recovery_mode = 1
 
-# Controls whether memory buffers are written to storage at the fixed interval set by `cleanup_period_interval`
-# even when they are not full. Setting this will increase load on the storage backplane and is never advised
-# under normal circumstances.
-#rocksdb_periodic_cleanup = false
-
 
 ### Domain Name Resolution and Caching
 
@@ -697,6 +741,44 @@ allow_profile_lookup_federation_requests = true
 #typing_client_timeout_max_s = 45
 
 
+### TURN / VoIP
+
+# vector list of TURN URIs/servers to use
+#
+# No default
+#turn_uris = ["turn:example.turn.uri?transport=udp", "turn:example.turn.uri?transport=tcp"]
+
+# TURN secret to use for generating the HMAC-SHA1 hash apart of username and password generation
+#
+# this is more secure, but if needed you can use traditional username/password below.
+#
+# no default
+#turn_secret = ""
+
+# TURN username to provide the client
+#
+# no default
+#turn_username = ""
+
+# TURN password to provide the client
+#
+# no default
+#turn_password = ""
+
+# TURN TTL
+#
+# Default is 86400 seconds
+#turn_ttl = 86400
+
+# allow guests/unauthenticated users to access TURN credentials
+#
+# this is the equivalent of Synapse's `turn_allow_guests` config option. this allows
+# any unauthenticated user to call `/_matrix/client/v3/voip/turnServer`.
+#
+# defaults to false
+#turn_allow_guests = false
+
+
 # Other options not in [global]:
 #
 #

debian/README.md

@@ -1,34 +1,22 @@
-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. At the minimum, you will need to change your `server_name` here.
 
-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=
 
@@ -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,44 @@
 #!/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
+        --verbose \
+        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 = ["snappy", "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/zaidoon1/rust-rocksdb"
+rev = "b4887edfb84771336930855727390edec07d63fa"
+#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();
+}

docs/SUMMARY.md

@@ -2,14 +2,20 @@ # 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)
+  - [Arch Linux](deploying/arch-linux.md)
+  - [Debian](deploying/debian.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

@@ -12,13 +12,13 @@ ## Set up the appservice - general instructions
 
 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 +31,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 +46,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,77 @@
+# 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 foundational rules, please refer to the [Matrix.org Code of Conduct](https://matrix.org/legal/code-of-conduct/)
+and 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,18 @@
-# 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. Please refer to the
+[example config file](./configuration/examples.md#example-configuration) for all of those settings.
+The config file to use can either be specified on the command line 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.
+
+## 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`.

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 @@
+{{#include ../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,9 @@
+# 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,40 +1,30 @@
-# Conduit - Behind Traefik Reverse Proxy
+# conduwuit - Behind Traefik Reverse Proxy
 version: '2.4' # uses '2.4' for cpuset
 
 services:
     homeserver:
-        ### If you already built the Conduit image with 'docker build' or want to use the Docker Hub image,
+        ### 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
-        ### 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
+            - db:/var/lib/conduwuit
+            #- ./conduwuit.toml:/etc/conduwuit.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
+            CONDUWUIT_SERVER_NAME: your.server.name # EDIT THIS
+            CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit
+            CONDUWUIT_DATABASE_BACKEND: rocksdb
+            CONDUWUIT_PORT: 6167
+            CONDUWUIT_MAX_REQUEST_SIZE: 20_000_000 # in bytes, ~20 MB
+            CONDUWUIT_ALLOW_REGISTRATION: 'true'
+            CONDUWUIT_ALLOW_FEDERATION: 'true'
+            CONDUWUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
+            CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
+            #CONDUWUIT_LOG: warn,state_res=warn
+            CONDUWUIT_ADDRESS: 0.0.0.0
+            #CONDUWUIT_CONFIG: './conduwuit.toml' # Uncomment if you mapped config toml above
         #cpuset: "0-4" # Uncomment to limit to specific CPU cores
 
     # We need some way to server the client and server .well-known json. The simplest way is to use a nginx container
@@ -48,7 +38,7 @@ services:
             - ./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

docs/deploying/docker-compose.override.yml

@@ -1,4 +1,4 @@
-# Conduit - Traefik Reverse Proxy Labels
+# conduwuit - Traefik Reverse Proxy Labels
 version: '2.4' # uses '2.4' for cpuset
 
 services:
@@ -7,10 +7,10 @@ services:
             - "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.middlewares.cors-headers.headers.accessControlAllowOriginList=*"
             - "traefik.http.middlewares.cors-headers.headers.accessControlAllowHeaders=Origin, X-Requested-With, Content-Type, Accept, Authorization"

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

@@ -1,44 +1,33 @@
-# Conduit - Behind Traefik Reverse Proxy
+# conduwuit - Behind Traefik Reverse Proxy
 version: '2.4' # uses '2.4' for cpuset
 
 services:
     homeserver:
-        ### If you already built the Conduit image with 'docker build' or want to use the Docker Hub image,
+        ### 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
-        ### 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
+            - db:/srv/conduwuit/.local/share/conduwuit
+            #- ./conduwuit.toml:/etc/conduwuit.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
+            CONDUWUIT_SERVER_NAME: your.server.name # EDIT THIS
+            CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
+            CONDUWUIT_ALLOW_REGISTRATION : 'true'
+            #CONDUWUIT_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
+            # CONDUWUIT_ADDRESS: 0.0.0.0
+            # CONDUWUIT_PORT: 6167
+            # CONDUWUIT_LOG: info  # default is: "warn,state_res=warn"
+            # CONDUWUIT_ALLOW_JAEGER: 'false'
+            # CONDUWUIT_ALLOW_ENCRYPTION: 'true'
+            # CONDUWUIT_ALLOW_FEDERATION: 'true'
+            # CONDUWUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
+            # CONDUWUIT_DATABASE_PATH: /srv/conduwuit/.local/share/conduwuit
+            # CONDUWUIT_WORKERS: 10
+            # CONDUWUIT_MAX_REQUEST_SIZE: 20000000  # in bytes, ~20 MB
         #cpuset: "0-4" # Uncomment to limit to specific CPU cores
 
     # We need some way to server the client and server .well-known json. The simplest way is to use a nginx container
@@ -53,7 +42,7 @@ services:
 
     ### 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-compose.yml

@@ -1,45 +1,35 @@
-# Conduit
+# conduwuit
 version: '2.4' # uses '2.4' for cpuset
 
 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
+            CONDUWUIT_SERVER_NAME: your.server.name # EDIT THIS
+            CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit
+            CONDUWUIT_DATABASE_BACKEND: rocksdb
+            CONDUWUIT_PORT: 6167
+            CONDUWUIT_MAX_REQUEST_SIZE: 20_000_000 # in bytes, ~20 MB
+            CONDUWUIT_ALLOW_REGISTRATION: 'true'
+            CONDUWUIT_ALLOW_FEDERATION: 'true'
+            CONDUWUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
+            CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
+            #CONDUWUIT_LOG: warn,state_res=warn
+            CONDUWUIT_ADDRESS: 0.0.0.0
+            #CONDUWUIT_CONFIG: './conduwuit.toml' # Uncomment if you mapped config toml above
         #cpuset: "0-4" # Uncomment to limit to specific CPU cores
     #
     ### 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

@@ -4,7 +4,6 @@ ## Docker
 
 To run conduwuit with Docker you can either build the image yourself or pull it from a registry.
 
-
 ### Use a registry
 
 OCI images for conduwuit are available in the registries listed below.
@@ -12,30 +11,25 @@ ### 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.          |
+| GitLab Registry | [registry.gitlab.com/conduwuit/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: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
 [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/6351657
 [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.
 
+to pull it to your machine.
 
 ### Run
 
@@ -44,21 +38,17 @@ ### 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" \
+  -e CONDUWUIT_SERVER_NAME="your.server.name" \
+  -e CONDUWUIT_DATABASE_BACKEND="rocksdb" \
+  -e CONDUWUIT_ALLOW_REGISTRATION=false \
   --name conduit <link>
 ```
 
 or you can use [docker compose](#docker-compose).
 
-The `-d` flag lets the container run in detached mode. You may supply an optional `conduwuit.toml` config file, an example can be found [here](../configuration.md).
+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` file.
+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.
 
@@ -67,6 +57,7 @@ ### 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.
 
 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)
 - For any other reverse proxy, use [`docker-compose.yml`](docker-compose.yml)
@@ -112,92 +103,6 @@ ### Use Traefik as Proxy
 
 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.
-
-
-
-
 ## 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.
-
-### 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).
+See the [TURN](../turn.md) page.

docs/deploying/generic.md

@@ -1,7 +1,5 @@
 # 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
@@ -13,23 +11,16 @@ ## Installing conduwuit
 
 Prebuilt binaries can be downloaded from the latest tagged release [here](https://github.com/girlbossceo/conduwuit/releases/latest).
 
-Alternatively, you may compile the binary yourself. First, install any dependencies:
+The latest tagged release also includes the Debian packages.
 
-```bash
-# Debian
-$ sudo apt install libclang-dev build-essential
+Alternatively, you may compile the binary yourself. We recommend using [Lix](https://lix.systems) to build conduwuit as this has the most guaranteed
+reproducibiltiy and easiest to get a build environment and output going.
 
-# RHEL
-$ sudo dnf install clang
-```
-Then, `cd` into the source tree of conduwuit and run:
-```bash
-$ cargo build --release
-```
+Otherwise, follow standard Rust project build guides (installing git and cloning the repo, getting the Rust toolchain via rustup, installing LLVM toolchain + libclang, installing liburing for io_uring and RocksDB, etc).
 
 ## 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
+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:
@@ -38,6 +29,12 @@ ## Adding a conduwuit user
 sudo adduser --system conduwuit --group --disabled-login --no-create-home
 ```
 
+For distros without `adduser`:
+
+```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.
@@ -46,45 +43,18 @@ ## Forwarding ports in the firewall or the router
 
 ## 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`.
-
-```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
-```
+The systemd unit for conduwuit can be found [here](../configuration/examples.md#example-systemd-unit-file). You may need to change the `ExecStart=` path to where you placed the conduwuit binary.
 
 ## Creating the conduwuit configuration file
 
-Now we need to create the conduwuit's config file in `/etc/conduwuit/conduwuit.toml`. 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).**Please take a moment to read it. You need to change at least the server name.**
 
-See the following example config at [conduwuit-example.toml](../configuration.md)
+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
+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 command on
+
 Debian or RHEL:
 
 ```bash
@@ -102,7 +72,9 @@ ## 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. A [Caddy](https://caddyserver.com/) example will be provided as this is the recommended reverse proxy for new users and is very trivial to use (handles TLS, reverse proxy headers, etc transparently with proper defaults).
+
+Lighttpd is not supported as it seems to mess with the `X-Matrix` Authorization header, making federation non-functional. If using Apache, you need to use `nocanon` to prevent this.
 
 ### Caddy
 
@@ -118,31 +90,31 @@ ### Caddy
 }
 ```
 
-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 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

docs/deploying/nixos.md

@@ -1,6 +1,6 @@
 # conduwuit for NixOS
 
-conduwuit can be acquired by Nix from various places:
+conduwuit can be acquired by [Lix][lix] from various places:
 
 * The `flake.nix` at the root of the repo
 * The `default.nix` at the root of the repo
@@ -8,11 +8,20 @@ # conduwuit for NixOS
 
 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 have been recreated recently due to attic issues. The old public keys were:
+
+```
+conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg=
+
 conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw=
 ```
 
@@ -22,9 +31,10 @@ # conduwuit for NixOS
 (for now) [`services.matrix-conduit`][module] from Nixpkgs should be used to
 configure conduwuit.
 
-If you want to run the latest code, you should get Conduwuit from the `flake.nix`
+If you want to run the latest code, you should get conduwuit from the `flake.nix`
 or `default.nix` and set [`services.matrix-conduit.package`][package]
 appropriately.
 
+[lix]: https://lix.systems/
 [module]: https://search.nixos.org/options?channel=unstable&query=services.matrix-conduit
 [package]: https://search.nixos.org/options?channel=unstable&query=services.matrix-conduit.package

docs/development.md

@@ -1,12 +1,13 @@
 # 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 section. If you plan on contributing, see the
+[contributor's guide](contributing.md).
 
 ## 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,
+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:
@@ -15,8 +16,7 @@ ## Debugging with `tokio-console`
 RUSTFLAGS="--cfg tokio_unstable" cargo 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/

docs/development/hot_reload.md

@@ -0,0 +1,96 @@
+# 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,16 @@ ## 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 [Lix][lix] and direnv installed and set up, you can:
 
 * Run `./bin/complement "$COMPLEMENT_SRC" ./path/to/logs.jsonl ./path/to/results.jsonl`
   to build a Complement image, run the tests, and output the logs and results
-  to the specified paths
+  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]
 
+[lix]: https://lix.systems/
+[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,63 +1,82 @@
 #### **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
+## 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.
-- 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)
 - 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)
+- 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:
+- 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
+- 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)
-- 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)
+- 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`
-- 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)
+- 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!)
 - Add support for room banning/blocking by ID using admin command
-- Add support for serving `support` well-known from `[well_known.support]` (MSC1929)
+- 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/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.
+- 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
+- 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
@@ -67,44 +86,59 @@ ## Privacy/Security:
 - 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`
 - 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 🏳️‍⚧️
+- Replace the lightning bolt emoji option with support for setting any arbitrary text (e.g. another emoji) to suffix to all new user registrations, with a conduwuit default of "🏳️‍⚧️"
 - Implement config option to auto join rooms upon registration
 - Warn on unknown config options specified
 - Add `/_conduwuit/server_version` route to return the version of conduwuit without relying on the federation API `/_matrix/federation/v1/version`
+- Add `/_conduwuit/local_user_count` route to return the amount of registered active local users on your homeserver *if federation is enabled*
 - Add configurable RocksDB recovery modes to aid in recovering corrupted RocksDB databases
-- Support config options via `CONDUWUIT_` prefix
-- Add support for listening on multiple TCP ports
-- Disable update check by default as it's not useful for conduwuit
+- 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)
+- 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)
+- Repo uses [Renovate](https://docs.renovatebot.com/), [Trivy](https://github.com/aquasecurity/trivy-action), and keeps ALL dependencies as up to date as possible
 - Purge unmaintained/irrelevant/broken database backends (heed, sled, persy) and other unnecessary code or overhead
 - webp support for images
 - Add cargo audit support to CI
-- 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)
+- 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:
+- 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
@@ -118,20 +152,28 @@ ## Admin Room:
 - 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 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
+- 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:
+- Add guest support for accessing TURN servers via `turn_allow_guests` like Synapse
 - Support for creating rooms with custom room IDs like Maunium Synapse (`room_id` request body field to `/createRoom`)
-- Query parameter `?format=event|content` for returning either the room state event's content (default) for the full room state event on ` /_matrix/client/v3/rooms/{roomId}/state/{eventType}[/{stateKey}]` requests (see https://github.com/matrix-org/matrix-spec/issues/1047)
-- Add **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)
+- 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]`
@@ -140,13 +182,16 @@ ## Misc:
 - 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
+- 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
-- 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
 - 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 🏳️‍⚧️
+- [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,16 @@ # 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,66 @@
+# 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,61 @@
+# 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.
+
+## Rocksdb / database issues
+
+#### Direct IO
+
+Some filesystems may not like RocksDB using [Direct IO](https://github.com/facebook/rocksdb/wiki/Direct-IO). Direct IO is for non-buffered I/O which improves conduwuit performance, but at least FUSE is a filesystem potentially known to not like this. See the [example config](configuration/examples.md) for disabling it if needed. Issues from Direct IO on unsupported filesystems are usually shown as startup errors.
+
+#### 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
+
+## Media
+
+## 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 by default for at least performance reasons. This may change in the future and/or binaries providing such configurations may be provided. If you need to access debug/trace log levels, you will need to build without the `release_max_log_level` feature.
+
+#### Changing log level dynamically
+
+conduwuit supports changing the tracing log environment filter on-the-fly using the admin command `!admin debug change-log-level`. This accepts a string **without quotes** the same format as the `log` config option.
+
+#### Pinging servers
+
+conduwuit can ping other servers using `!admin debug ping`. This takes a server name and goes through the server discovery process and queries `/_matrix/federation/v1/version`. Errors are outputted.
+
+#### Allocator memory stats
+
+When using jemalloc with jemallocator's `stats` feature, you can see conduwuit's jemalloc memory stats by using `!admin debug memory-stats`

docs/turn.md

@@ -1,25 +1,44 @@
 # 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.
+
+### 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,10 +55,15 @@ name = "lychee"
 group = "versions"
 script = "lychee --version"
 
+[[task]]
+name = "markdownlint"
+group = "versions"
+script = "markdownlint --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"
@@ -69,12 +74,15 @@ script = "cargo fmt --check -- --color=always"
 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 \
+        --all-features \
+        --no-deps \
+        --document-private-items \
+        --color always
 """
 
 [[task]]
@@ -93,13 +101,15 @@ 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 \
+        --all-targets \
+        --all-features \
+        --color=always \
+        -- \
+        -D warnings
 """
 
 [[task]]
@@ -115,33 +125,64 @@ 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"
 
 [[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 \
+        --all-targets \
+        --all-features \
+        --color=always \
+        -- \
+        --color=always
+"""
+
+[[task]]
+name = "cargo/default"
 group = "tests"
 script = """
 cargo test \
     --workspace \
     --all-targets \
-    --all-features \
     --color=always \
     -- \
     --color=always
 """
+
+# 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 = """
+nix run .#default -- --help
+"""

flake.lock

@@ -9,11 +9,11 @@
         "nixpkgs-stable": "nixpkgs-stable"
       },
       "locked": {
-        "lastModified": 1711742460,
-        "narHash": "sha256-0O4v6e4a1toxXZ2gf5INhg4WPE5C5T+SVvsBt+45Mcc=",
+        "lastModified": 1717279440,
+        "narHash": "sha256-kH04ReTjxOpQumgWnqy40vvQLSnLGxWP6RF3nq5Esrk=",
         "owner": "zhaofengli",
         "repo": "attic",
-        "rev": "4dbdbee45728d8ce5788db6461aaaa89d98081f0",
+        "rev": "717cc95983cdc357bc347d70be20ced21f935843",
         "type": "github"
       },
       "original": {
@@ -23,14 +23,69 @@
         "type": "github"
       }
     },
+    "cachix": {
+      "inputs": {
+        "devenv": "devenv",
+        "flake-compat": "flake-compat_3",
+        "nixpkgs": "nixpkgs_3",
+        "pre-commit-hooks": "pre-commit-hooks"
+      },
+      "locked": {
+        "lastModified": 1719923519,
+        "narHash": "sha256-7Rhljj2fsklFRsu+eq7N683Z9qukmreMEj5C1GqCrSA=",
+        "owner": "cachix",
+        "repo": "cachix",
+        "rev": "4e9e71f78b9500fa6210cf1eaa4d75bdbab777c3",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "ref": "master",
+        "repo": "cachix",
+        "type": "github"
+      }
+    },
+    "cachix_2": {
+      "inputs": {
+        "devenv": "devenv_2",
+        "flake-compat": [
+          "cachix",
+          "devenv",
+          "flake-compat"
+        ],
+        "nixpkgs": [
+          "cachix",
+          "devenv",
+          "nixpkgs"
+        ],
+        "pre-commit-hooks": [
+          "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": 1719903368,
+        "narHash": "sha256-PPzgxM4Bir+Zh9FUV/v+RBxEYeJxYVmi/BYo3uqt268=",
         "owner": "matrix-org",
         "repo": "complement",
-        "rev": "891d18872c153d39a9ce63b545045efddb845738",
+        "rev": "bc97f1ddc1cd7485faf80c8935ee2641f3e1b57c",
         "type": "github"
       },
       "original": {
@@ -48,11 +103,11 @@
         ]
       },
       "locked": {
-        "lastModified": 1702918879,
-        "narHash": "sha256-tWJqzajIvYcaRWxn+cLUB9L9Pv4dQ3Bfit/YjU5ze3g=",
+        "lastModified": 1717025063,
+        "narHash": "sha256-dIubLa56W9sNNz0e8jGxrX3CAkPXsq7snuFA/Ie6dn8=",
         "owner": "ipetkov",
         "repo": "crane",
-        "rev": "7195c00c272fdd92fc74e7d5a0a2844b9fadb2fb",
+        "rev": "480dff0be03dac0e51a8dfc26e882b0d123a450e",
         "type": "github"
       },
       "original": {
@@ -68,11 +123,11 @@
         ]
       },
       "locked": {
-        "lastModified": 1713738183,
-        "narHash": "sha256-qd/MuLm7OfKQKyd4FAMqV4H6zYyOfef5lLzRrmXwKJM=",
+        "lastModified": 1716569590,
+        "narHash": "sha256-5eDbq8TuXFGGO3mqJFzhUbt5zHVTf5zilQoyW5jnJwo=",
         "owner": "ipetkov",
         "repo": "crane",
-        "rev": "f6c6a2fb1b8bd9b65d65ca9342dd0eb180a63f11",
+        "rev": "109987da061a1bf452f435f1653c47511587d919",
         "type": "github"
       },
       "original": {
@@ -82,6 +137,70 @@
         "type": "github"
       }
     },
+    "devenv": {
+      "inputs": {
+        "cachix": "cachix_2",
+        "flake-compat": [
+          "cachix",
+          "flake-compat"
+        ],
+        "nix": "nix_2",
+        "nixpkgs": [
+          "cachix",
+          "nixpkgs"
+        ],
+        "pre-commit-hooks": [
+          "cachix",
+          "pre-commit-hooks"
+        ]
+      },
+      "locked": {
+        "lastModified": 1719759336,
+        "narHash": "sha256-3a34VL/QnHprl5gMy9xlx6d8J+iNp+W88Ex8smkgH9M=",
+        "owner": "cachix",
+        "repo": "devenv",
+        "rev": "bb32aa986f2f695385e54428d0eaf7d05b31466e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "devenv",
+        "type": "github"
+      }
+    },
+    "devenv_2": {
+      "inputs": {
+        "flake-compat": [
+          "cachix",
+          "devenv",
+          "cachix",
+          "flake-compat"
+        ],
+        "nix": "nix",
+        "nixpkgs": "nixpkgs_2",
+        "poetry2nix": "poetry2nix",
+        "pre-commit-hooks": [
+          "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 +209,11 @@
         "rust-analyzer-src": "rust-analyzer-src"
       },
       "locked": {
-        "lastModified": 1714544767,
-        "narHash": "sha256-kF1bX+YFMedf1g0PAJYwGUkzh22JmULtj8Rm4IXAQKs=",
+        "lastModified": 1716359173,
+        "narHash": "sha256-pYcjP6Gy7i6jPWrjiWAVV0BCQp+DdmGaI/k65lBb/kM=",
         "owner": "nix-community",
         "repo": "fenix",
-        "rev": "73124e1356bde9411b163d636b39fe4804b7ca45",
+        "rev": "b6fc5035b28e36a98370d0eac44f4ef3fd323df6",
         "type": "github"
       },
       "original": {
@@ -121,6 +240,54 @@
       }
     },
     "flake-compat_2": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1673956053,
+        "narHash": "sha256-4gtG9iQuiKITOjNQQeQIpoIB6b16fm+504Ch3sNKLd8=",
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "35bb57c0c8d8b62bbfd284272c928ceb64ddbde9",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "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,
+        "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=",
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "flake-compat_5": {
       "flake": false,
       "locked": {
         "lastModified": 1696426674,
@@ -156,6 +323,24 @@
       "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_3": {
+      "inputs": {
+        "systems": "systems_2"
+      },
       "locked": {
         "lastModified": 1710146030,
         "narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=",
@@ -171,6 +356,72 @@
         "type": "github"
       }
     },
+    "gitignore": {
+      "inputs": {
+        "nixpkgs": [
+          "cachix",
+          "pre-commit-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"
+      }
+    },
+    "liburing": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1719025212,
+        "narHash": "sha256-kD0yhjNStqC6uFqC1AxBwUpc/HlSFtiKrV+gwDyroDc=",
+        "owner": "axboe",
+        "repo": "liburing",
+        "rev": "7b3245583069bd481190c9da18f22e9fc8c3a805",
+        "type": "github"
+      },
+      "original": {
+        "owner": "axboe",
+        "ref": "master",
+        "repo": "liburing",
+        "type": "github"
+      }
+    },
+    "nix": {
+      "inputs": {
+        "flake-compat": "flake-compat_2",
+        "nixpkgs": [
+          "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,6 +438,60 @@
         "type": "github"
       }
     },
+    "nix-github-actions": {
+      "inputs": {
+        "nixpkgs": [
+          "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",
+          "flake-compat"
+        ],
+        "nixpkgs": [
+          "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"
+      }
+    },
     "nixpkgs": {
       "locked": {
         "lastModified": 1711401922,
@@ -203,6 +508,38 @@
         "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-stable": {
       "locked": {
         "lastModified": 1711460390,
@@ -219,13 +556,45 @@
         "type": "github"
       }
     },
-    "nixpkgs_2": {
+    "nixpkgs-stable_2": {
       "locked": {
-        "lastModified": 1713537308,
-        "narHash": "sha256-XtTSSIB2DA6tOv+l0FhvfDMiyCmhoRbNB+0SeInZkbk=",
+        "lastModified": 1718811006,
+        "narHash": "sha256-0Y8IrGhRmBmT7HHXlxxepg2t8j1X90++qRN3lukGaIk=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "5c24cf2f0a12ad855f444c30b2421d044120c66f",
+        "rev": "03d771e513ce90147b65fe922d87d3a0356fc125",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-23.11",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs_2": {
+      "locked": {
+        "lastModified": 1692808169,
+        "narHash": "sha256-x9Opq06rIiwdwGeK2Ykj69dNc2IvUH1fY55Wm7atwrE=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "9201b5ff357e781bf014d0330d18555695df7ba8",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs_3": {
+      "locked": {
+        "lastModified": 1719848872,
+        "narHash": "sha256-H3+EC5cYuq+gQW8y0lSrrDZfH71LB4DAf+TDFyvwCNA=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "00d80d13810dbfea8ab4ed1009b09100cca86ba8",
         "type": "github"
       },
       "original": {
@@ -235,19 +604,85 @@
         "type": "github"
       }
     },
-    "rocksdb": {
-      "flake": false,
+    "nixpkgs_4": {
       "locked": {
-        "lastModified": 1713810944,
-        "narHash": "sha256-/Xf0bzNJPclH9IP80QNaABfhj4IAR5LycYET18VFCXc=",
-        "owner": "facebook",
-        "repo": "rocksdb",
-        "rev": "6f7cabeac80a3a6150be2c8a8369fcecb107bf43",
+        "lastModified": 1716330097,
+        "narHash": "sha256-8BO3B7e3BiyIDsaKA0tY8O88rClYRTjvAp66y+VBUeU=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "5710852ba686cc1fd0d3b8e22b3117d43ba374c2",
         "type": "github"
       },
       "original": {
-        "owner": "facebook",
-        "ref": "v9.1.1",
+        "owner": "NixOS",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "poetry2nix": {
+      "inputs": {
+        "flake-utils": "flake-utils_2",
+        "nix-github-actions": "nix-github-actions",
+        "nixpkgs": [
+          "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": "flake-compat_4",
+        "gitignore": "gitignore",
+        "nixpkgs": [
+          "cachix",
+          "nixpkgs"
+        ],
+        "nixpkgs-stable": "nixpkgs-stable_2"
+      },
+      "locked": {
+        "lastModified": 1719259945,
+        "narHash": "sha256-F1h+XIsGKT9TkGO3omxDLEb/9jOOsI6NnzsXFsZhry4=",
+        "owner": "cachix",
+        "repo": "pre-commit-hooks.nix",
+        "rev": "0ff4381bbb8f7a52ca4a851660fc7a437a4c6e07",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "pre-commit-hooks.nix",
+        "type": "github"
+      }
+    },
+    "rocksdb": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1719949653,
+        "narHash": "sha256-DYx7XHH2GEh17GukKhXs6laM6l+eugCmRkF0adpi9wk=",
+        "owner": "girlbossceo",
+        "repo": "rocksdb",
+        "rev": "a935c0273e1ba44eacf88ce3685a9b9831486155",
+        "type": "github"
+      },
+      "original": {
+        "owner": "girlbossceo",
+        "ref": "v9.3.1",
         "repo": "rocksdb",
         "type": "github"
       }
@@ -255,24 +690,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_5",
+        "flake-utils": "flake-utils_3",
+        "liburing": "liburing",
         "nix-filter": "nix-filter",
-        "nixpkgs": "nixpkgs_2",
+        "nixpkgs": "nixpkgs_4",
         "rocksdb": "rocksdb"
       }
     },
     "rust-analyzer-src": {
       "flake": false,
       "locked": {
-        "lastModified": 1713628977,
-        "narHash": "sha256-iN5QUlUq527lswmBC+RopfXdu6Xx7mmTaBSH2l59FtM=",
+        "lastModified": 1716107283,
+        "narHash": "sha256-NJgrwLiLGHDrCia5AeIvZUHUY7xYGVryee0/9D3Ir1I=",
         "owner": "rust-lang",
         "repo": "rust-analyzer",
-        "rev": "55d9a533b309119c8acd13061581b43ae8840823",
+        "rev": "21ec8f523812b88418b2bfc64240c62b3dd967bd",
         "type": "github"
       },
       "original": {
@@ -296,6 +733,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,6 +1,7 @@
 {
   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"; };
     fenix = { url = "github:nix-community/fenix?ref=main"; inputs.nixpkgs.follows = "nixpkgs"; };
@@ -8,23 +9,27 @@
     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; };
+    # https://github.com/girlbossceo/rocksdb/commit/db6df0b185774778457dabfcbd822cb81760cade
+    rocksdb = { url = "github:girlbossceo/rocksdb?ref=v9.3.1"; 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};
+      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-+syqAd2kX8KVa8/U2gz3blIQTTsYYt3U63xBWaGOSc8";
       };
 
-      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);
@@ -38,22 +43,90 @@
             (builtins.fromJSON (builtins.readFile ./flake.lock))
               .nodes.rocksdb.original.ref;
         });
+        # TODO: remove once https://github.com/NixOS/nixpkgs/pull/314945 is available
+        liburing = pkgs.liburing.overrideAttrs (old: {
+          # the configure script doesn't support these, and unconditionally
+          # builds both static and dynamic libraries.
+          configureFlags = pkgs.lib.subtractLists
+            [ "--enable-static" "--disable-shared" ]
+            old.configureFlags;
+
+          postInstall = old.postInstall + ''
+            # we remove the extra outputs
+            #
+            # we need to do this to prevent rocksdb from trying to link the
+            # static library in a dynamic stdenv
+            rm $out/lib/liburing*${
+              if pkgs.stdenv.hostPlatform.isStatic then ".so*" else ".a"
+            }
+          '';
+        });
       });
 
-      scopeHost = (scope pkgsHost);
+      scopeHost = mkScope pkgsHost;
+      scopeHostStatic = mkScope pkgsHostStatic;
+
+      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
+
+          # Needed for producing Debian packages
+          cargo-deb
+
+          # 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
+        ])
+        ++ scope.main.buildInputs
+        ++ scope.main.propagatedBuildInputs
+        ++ scope.main.nativeBuildInputs;
+
+        meta.broken = scope.main.meta.broken;
+      };
     in
     {
       packages = {
         default = scopeHost.main;
-        jemalloc = scopeHost.main.override { features = ["jemalloc"]; };
         hmalloc = scopeHost.main.override { features = ["hardened_malloc"]; };
 
         oci-image = scopeHost.oci-image;
-        oci-image-jemalloc = scopeHost.oci-image.override {
-          main = scopeHost.main.override {
-            features = ["jemalloc"];
-          };
-        };
         oci-image-hmalloc = scopeHost.oci-image.override {
           main = scopeHost.main.override {
             features = ["hardened_malloc"];
@@ -63,6 +136,7 @@
         book = scopeHost.book;
 
         complement = scopeHost.complement;
+        static-complement = scopeHostStatic.complement;
       }
       //
       builtins.listToAttrs
@@ -78,7 +152,7 @@
                       config = crossSystem;
                     };
                   }).pkgsStatic;
-                scopeCrossStatic = scope pkgsCrossStatic;
+                scopeCrossStatic = mkScope pkgsCrossStatic;
               in
               [
                 # An output for a statically-linked binary
@@ -87,14 +161,6 @@
                   value = scopeCrossStatic.main;
                 }
 
-                # An output for a statically-linked binary with jemalloc
-                {
-                  name = "${binaryName}-jemalloc";
-                  value = scopeCrossStatic.main.override {
-                    features = ["jemalloc"];
-                  };
-                }
-
                 # An output for a statically-linked binary with hardened_malloc
                 {
                   name = "${binaryName}-hmalloc";
@@ -109,16 +175,6 @@
                   value = scopeCrossStatic.oci-image;
                 }
 
-                # An output for an OCI image based on that binary with jemalloc
-                {
-                  name = "oci-image-${crossSystem}-jemalloc";
-                  value = scopeCrossStatic.oci-image.override {
-                    main = scopeCrossStatic.main.override {
-                      features = ["jemalloc"];
-                    };
-                  };
-                }
-
                 # An output for an OCI image based on that binary with hardened_malloc
                 {
                   name = "oci-image-${crossSystem}-hmalloc";
@@ -137,50 +193,15 @@
           )
         );
 
-      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;
-        };
-
-        # 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.default = mkDevShell scopeHostStatic;
+      devShells.all-features = mkDevShell
+        (scopeHostStatic.overrideScope (final: prev: {
+          main = prev.main.override { all_features = true; };
+        }));
+      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,13 @@ stdenv.mkDerivation {
     include = [
       "book.toml"
       "conduwuit-example.toml"
+      "CONTRIBUTING.md"
       "README.md"
+      "debian/conduwuit.service"
       "debian/README.md"
+      "arch/conduwuit.service"
       "docs"
+      "theme"
     ];
   };
 
@@ -25,7 +29,6 @@ stdenv.mkDerivation {
   ];
 
   buildPhase = ''
-    mdbook build
-    mv public $out
+    mdbook build -d $out
   '';
 }

nix/pkgs/complement/default.nix

@@ -44,16 +44,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";
+  tag = "main";
 
   copyToRoot = buildEnv {
     name = "root";
@@ -81,7 +79,7 @@ dockerTools.buildImage {
 
     Env = [
       "SSL_CERT_FILE=/complement/ca/ca.crt"
-      "CONDUIT_CONFIG=${./config.toml}"
+      "CONDUWUIT_CONFIG=${./config.toml}"
     ];
 
     ExposedPorts = {

nix/pkgs/main/default.nix

@@ -1,27 +1,87 @@
 # Dependencies (keep sorted)
 { craneLib
 , inputs
+, jq
 , lib
 , libiconv
+, liburing
 , pkgsBuildHost
 , rocksdb
 , 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) ++
+  lib.attrNames
+    (lib.filterAttrs
+      (_: dependency: dependency.optional or false)
+      manifest.dependencies);
+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.isLinux;
+
+# 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 ++
+    # tikv-jemalloc-sys/profiling feature
+    lib.optional (featureEnabled "jemalloc_prof") "--enable-prof";
+});
+
 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.isDarwin;
+    }).overrideAttrs (old: {
+      # TODO: static rocksdb fails to build on darwin
+      # build log at <https://girlboss.ceo/~strawberry/pb/JjGH>
+      meta.broken = stdenv.hostPlatform.isStatic && stdenv.isDarwin;
+      # TODO: switch to enableUring option once https://github.com/NixOS/nixpkgs/pull/314945 is available
+      buildInputs = old.buildInputs ++ lib.optional enableLiburing liburing;
+    });
   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";
@@ -37,8 +97,15 @@ buildDepsOnlyEnv =
   });
 
 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 +122,33 @@ commonAttrs = {
       include = [
         "Cargo.lock"
         "Cargo.toml"
-        "hot_lib"
+        "deps"
         "src"
       ];
     };
 
+    buildInputs = lib.optional (featureEnabled "jemalloc") rust-jemalloc-sys';
+
     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
   ]
-  ++ lib.optionals stdenv.isDarwin [ libiconv ];
+  ++ lib.optionals stdenv.isDarwin [
+      # https://github.com/NixOS/nixpkgs/issues/206242
+      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
+    ];
  };
 in
 
@@ -75,15 +157,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;

renovate.json

@@ -11,5 +11,6 @@
   },
   "nix": {
     "enabled": true
-  }
+  },
+  "labels": ["dependencies", "github_actions"]
 }

rust-toolchain.toml

@@ -11,7 +11,7 @@
 # If you're having trouble making the relevant changes, bug a maintainer.
 
 [toolchain]
-channel = "1.76.0"
+channel = "1.77.0"
 components = [
     # For rust-analyzer
     "rust-src",

src/admin/Cargo.toml

@@ -0,0 +1,47 @@
+[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-service.workspace = true
+futures-util.workspace = true
+log.workspace = true
+loole.workspace = true
+regex.workspace = true
+ruma.workspace = true
+serde_json.workspace = true
+serde.workspace = true
+serde_yaml.workspace = true
+tokio.workspace = true
+tracing-subscriber.workspace = true
+tracing.workspace = true
+
+[lints]
+workspace = true

src/admin/appservice/commands.rs

@@ -0,0 +1,61 @@
+use ruma::{api::appservice::Registration, events::room::message::RoomMessageEventContent};
+
+use crate::{services, Result};
+
+pub(super) async fn register(body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	if body.len() < 2 || !body[0].trim().starts_with("```") || body.last().unwrap_or(&"").trim() != "```" {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		));
+	}
+
+	let appservice_config = body[1..body.len().checked_sub(1).unwrap()].join("\n");
+	let parsed_config = serde_yaml::from_str::<Registration>(&appservice_config);
+	match parsed_config {
+		Ok(yaml) => match services().appservice.register_appservice(yaml).await {
+			Ok(id) => Ok(RoomMessageEventContent::text_plain(format!(
+				"Appservice registered with ID: {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: {e}"
+		))),
+	}
+}
+
+pub(super) async fn unregister(_body: Vec<&str>, appservice_identifier: String) -> Result<RoomMessageEventContent> {
+	match 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}"
+		))),
+	}
+}
+
+pub(super) async fn show(_body: Vec<&str>, appservice_identifier: String) -> Result<RoomMessageEventContent> {
+	match 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.")),
+	}
+}
+
+pub(super) async fn list(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	let appservices = 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,14 @@
+mod commands;
+
 use clap::Subcommand;
+use conduit::Result;
 use ruma::events::room::message::RoomMessageEventContent;
 
-use self::appservice_command::{list, register, show, unregister};
-use crate::Result;
-
-pub(crate) mod appservice_command;
+use self::commands::*;
 
 #[cfg_attr(test, derive(Debug))]
 #[derive(Subcommand)]
-pub(crate) enum AppserviceCommand {
+pub(super) enum AppserviceCommand {
 	/// - Register an appservice using its registration YAML
 	///
 	/// This command needs a YAML generated by an appservice (such as a bridge),
@@ -38,7 +38,7 @@ pub(crate) enum AppserviceCommand {
 	List,
 }
 
-pub(crate) async fn process(command: AppserviceCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
+pub(super) async fn process(command: AppserviceCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
 	Ok(match command {
 		AppserviceCommand::Register => register(body).await?,
 		AppserviceCommand::Unregister {

src/admin/check/commands.rs

@@ -1,11 +1,12 @@
+use conduit::Result;
 use ruma::events::room::message::RoomMessageEventContent;
 
-use crate::{services, Result};
+use crate::services;
 
 /// 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
-pub(crate) async fn check_all_users(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+pub(super) async fn check_all_users(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
 	let timer = tokio::time::Instant::now();
 	let results = services().users.db.iter();
 	let query_time = timer.elapsed();
@@ -17,10 +18,9 @@ pub(crate) async fn check_all_users(_body: Vec<&str>) -> Result<RoomMessageEvent
 	let ok_count = users.iter().filter(|user| user.is_ok()).count();
 
 	let message = format!(
-		"Database query completed in {query_time:?}:\n\n```\nTotal entries: {:?}\nFailure/Invalid user count: \
-		 {:?}\nSuccess/Valid user count: {:?}```",
-		total, err_count, ok_count
+		"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_html(message, String::new()))
+	Ok(RoomMessageEventContent::notice_markdown(message))
 }

src/admin/check/mod.rs

@@ -0,0 +1,19 @@
+mod commands;
+
+use clap::Subcommand;
+use conduit::Result;
+use ruma::events::room::message::RoomMessageEventContent;
+
+use self::commands::*;
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+pub(super) enum CheckCommand {
+	AllUsers,
+}
+
+pub(super) async fn process(command: CheckCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	Ok(match command {
+		CheckCommand::AllUsers => check_all_users(body).await?,
+	})
+}

src/admin/debug/commands.rs

@@ -0,0 +1,643 @@
+use std::{
+	collections::{BTreeMap, HashMap},
+	sync::{Arc, Mutex},
+	time::Instant,
+};
+
+use api::client::validate_and_add_event_id;
+use conduit::{
+	debug, info, log,
+	log::{capture, Capture},
+	warn, Error, Result,
+};
+use ruma::{
+	api::{client::error::ErrorKind, federation::event::get_room_state},
+	events::room::message::RoomMessageEventContent,
+	CanonicalJsonObject, EventId, OwnedRoomOrAliasId, RoomId, RoomVersionId, ServerName,
+};
+use service::{rooms::event_handler::parse_incoming_pdu, sending::resolve_actual_dest, services, PduEvent};
+use tokio::sync::RwLock;
+use tracing_subscriber::EnvFilter;
+
+pub(super) async fn echo(_body: Vec<&str>, message: Vec<String>) -> Result<RoomMessageEventContent> {
+	let message = message.join(" ");
+
+	Ok(RoomMessageEventContent::notice_plain(message))
+}
+
+pub(super) async fn get_auth_chain(_body: Vec<&str>, event_id: Box<EventId>) -> Result<RoomMessageEventContent> {
+	let event_id = Arc::<EventId>::from(event_id);
+	if let Some(event) = services().rooms.timeline.get_pdu_json(&event_id)? {
+		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 = services()
+			.rooms
+			.auth_chain
+			.event_ids_iter(room_id, vec![event_id])
+			.await?
+			.count();
+		let elapsed = start.elapsed();
+		Ok(RoomMessageEventContent::text_plain(format!(
+			"Loaded auth chain with length {count} in {elapsed:?}"
+		)))
+	} else {
+		Ok(RoomMessageEventContent::text_plain("Event not found."))
+	}
+}
+
+pub(super) async fn parse_pdu(body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	if body.len() < 2 || !body[0].trim().starts_with("```") || body.last().unwrap_or(&"").trim() != "```" {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		));
+	}
+
+	let string = body[1..body.len() - 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}"
+		))),
+	}
+}
+
+pub(super) async fn get_pdu(_body: Vec<&str>, event_id: Box<EventId>) -> Result<RoomMessageEventContent> {
+	let mut outlier = false;
+	let mut pdu_json = services()
+		.rooms
+		.timeline
+		.get_non_outlier_pdu_json(&event_id)?;
+	if pdu_json.is_none() {
+		outlier = true;
+		pdu_json = services().rooms.timeline.get_pdu_json(&event_id)?;
+	}
+	match pdu_json {
+		Some(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 PDU found in our database"
+				} else {
+					"PDU found in our database"
+				},
+				json_text
+			)))
+		},
+		None => Ok(RoomMessageEventContent::text_plain("PDU not found locally.")),
+	}
+}
+
+pub(super) async fn get_remote_pdu_list(
+	body: Vec<&str>, server: Box<ServerName>, force: bool,
+) -> Result<RoomMessageEventContent> {
+	if !services().globals.config.allow_federation {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Federation is disabled on this homeserver.",
+		));
+	}
+
+	if server == 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 body.len() < 2 || !body[0].trim().starts_with("```") || body.last().unwrap_or(&"").trim() != "```" {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		));
+	}
+
+	let list = body
+		.clone()
+		.drain(1..body.len().checked_sub(1).unwrap())
+		.filter_map(|pdu| EventId::parse(pdu).ok())
+		.collect::<Vec<_>>();
+
+	for pdu in list {
+		if force {
+			if let Err(e) = get_remote_pdu(Vec::new(), Box::from(pdu), server.clone()).await {
+				services()
+					.admin
+					.send_message(RoomMessageEventContent::text_plain(format!(
+						"Failed to get remote PDU, ignoring error: {e}"
+					)))
+					.await;
+				warn!(%e, "Failed to get remote PDU, ignoring error");
+			}
+		} else {
+			get_remote_pdu(Vec::new(), Box::from(pdu), server.clone()).await?;
+		}
+	}
+
+	Ok(RoomMessageEventContent::text_plain("Fetched list of remote PDUs."))
+}
+
+pub(super) async fn get_remote_pdu(
+	_body: Vec<&str>, event_id: Box<EventId>, server: Box<ServerName>,
+) -> Result<RoomMessageEventContent> {
+	if !services().globals.config.allow_federation {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Federation is disabled on this homeserver.",
+		));
+	}
+
+	if server == 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 services()
+		.sending
+		.send_federation_request(
+			&server,
+			ruma::api::federation::event::get_event::v1::Request {
+				event_id: event_id.clone().into(),
+			},
+		)
+		.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")
+			})?;
+
+			debug!("Attempting to parse PDU: {:?}", &response.pdu);
+			let parsed_pdu = {
+				let parsed_result = parse_incoming_pdu(&response.pdu);
+				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)]
+			};
+
+			let pub_key_map = RwLock::new(BTreeMap::new());
+
+			debug!("Attempting to fetch homeserver signing keys for {server}");
+			services()
+				.rooms
+				.event_handler
+				.fetch_required_signing_keys(parsed_pdu.iter().map(|(_event_id, event, _room_id)| event), &pub_key_map)
+				.await
+				.unwrap_or_else(|e| {
+					warn!("Could not fetch all signatures for PDUs from {server}: {e:?}");
+				});
+
+			info!("Attempting to handle event ID {event_id} as backfilled PDU");
+			services()
+				.rooms
+				.timeline
+				.backfill_pdu(&server, response.pdu, &pub_key_map)
+				.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}"
+		))),
+	}
+}
+
+pub(super) async fn get_room_state(_body: Vec<&str>, room: OwnedRoomOrAliasId) -> Result<RoomMessageEventContent> {
+	let room_id = services().rooms.alias.resolve(&room).await?;
+	let room_state = services()
+		.rooms
+		.state_accessor
+		.room_state_full(&room_id)
+		.await?
+		.values()
+		.map(|pdu| pdu.to_state_event())
+		.collect::<Vec<_>>();
+
+	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```")))
+}
+
+pub(super) async fn ping(_body: Vec<&str>, server: Box<ServerName>) -> Result<RoomMessageEventContent> {
+	if server == services().globals.server_name() {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Not allowed to send federation requests to ourselves.",
+		));
+	}
+
+	let timer = tokio::time::Instant::now();
+
+	match 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}",
+			)))
+		},
+	}
+}
+
+pub(super) async fn force_device_list_updates(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	// Force E2EE device list updates for all users
+	for user_id in services().users.iter().filter_map(Result::ok) {
+		services().users.mark_device_key_update(&user_id)?;
+	}
+	Ok(RoomMessageEventContent::text_plain(
+		"Marked all devices for all users as having new keys to update",
+	))
+}
+
+pub(super) async fn change_log_level(
+	_body: Vec<&str>, filter: Option<String>, reset: bool,
+) -> Result<RoomMessageEventContent> {
+	if reset {
+		let old_filter_layer = match EnvFilter::try_new(&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 services().server.log.reload.reload(&old_filter_layer) {
+			Ok(()) => {
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"Successfully changed log level back to config value {}",
+					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 services().server.log.reload.reload(&new_filter_layer) {
+			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."))
+}
+
+pub(super) async fn sign_json(body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	if body.len() < 2 || !body[0].trim().starts_with("```") || body.last().unwrap_or(&"").trim() != "```" {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		));
+	}
+
+	let string = body[1..body.len().checked_sub(1).unwrap()].join("\n");
+	match serde_json::from_str(&string) {
+		Ok(mut value) => {
+			ruma::signatures::sign_json(
+				services().globals.server_name().as_str(),
+				services().globals.keypair(),
+				&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}"))),
+	}
+}
+
+pub(super) async fn verify_json(body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	if body.len() < 2 || !body[0].trim().starts_with("```") || body.last().unwrap_or(&"").trim() != "```" {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		));
+	}
+
+	let string = body[1..body.len().checked_sub(1).unwrap()].join("\n");
+	match serde_json::from_str(&string) {
+		Ok(value) => {
+			let pub_key_map = RwLock::new(BTreeMap::new());
+
+			services()
+				.rooms
+				.event_handler
+				.fetch_required_signing_keys([&value], &pub_key_map)
+				.await?;
+
+			let pub_key_map = pub_key_map.read().await;
+			match ruma::signatures::verify_json(&pub_key_map, &value) {
+				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}"))),
+	}
+}
+
+#[tracing::instrument(skip(_body))]
+pub(super) async fn first_pdu_in_room(_body: Vec<&str>, room_id: Box<RoomId>) -> Result<RoomMessageEventContent> {
+	if !services()
+		.rooms
+		.state_cache
+		.server_in_room(&services().globals.config.server_name, &room_id)?
+	{
+		return Ok(RoomMessageEventContent::text_plain(
+			"We are not participating in the room / we don't know about the room ID.",
+		));
+	}
+
+	let first_pdu = services()
+		.rooms
+		.timeline
+		.first_pdu_in_room(&room_id)?
+		.ok_or_else(|| Error::bad_database("Failed to find the first PDU in database"))?;
+
+	Ok(RoomMessageEventContent::text_plain(format!("{first_pdu:?}")))
+}
+
+#[tracing::instrument(skip(_body))]
+pub(super) async fn latest_pdu_in_room(_body: Vec<&str>, room_id: Box<RoomId>) -> Result<RoomMessageEventContent> {
+	if !services()
+		.rooms
+		.state_cache
+		.server_in_room(&services().globals.config.server_name, &room_id)?
+	{
+		return Ok(RoomMessageEventContent::text_plain(
+			"We are not participating in the room / we don't know about the room ID.",
+		));
+	}
+
+	let latest_pdu = services()
+		.rooms
+		.timeline
+		.latest_pdu_in_room(&room_id)?
+		.ok_or_else(|| Error::bad_database("Failed to find the latest PDU in database"))?;
+
+	Ok(RoomMessageEventContent::text_plain(format!("{latest_pdu:?}")))
+}
+
+#[tracing::instrument(skip(_body))]
+pub(super) async fn force_set_room_state_from_server(
+	_body: Vec<&str>, server_name: Box<ServerName>, room_id: Box<RoomId>,
+) -> Result<RoomMessageEventContent> {
+	if !services()
+		.rooms
+		.state_cache
+		.server_in_room(&services().globals.config.server_name, &room_id)?
+	{
+		return Ok(RoomMessageEventContent::text_plain(
+			"We are not participating in the room / we don't know about the room ID.",
+		));
+	}
+
+	let first_pdu = services()
+		.rooms
+		.timeline
+		.latest_pdu_in_room(&room_id)?
+		.ok_or_else(|| Error::bad_database("Failed to find the latest PDU in database"))?;
+
+	let room_version = services().rooms.state.get_room_version(&room_id)?;
+
+	let mut state: HashMap<u64, Arc<EventId>> = HashMap::new();
+	let pub_key_map = RwLock::new(BTreeMap::new());
+
+	let remote_state_response = 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?;
+
+	let mut events = Vec::with_capacity(remote_state_response.pdus.len());
+
+	for pdu in remote_state_response.pdus.clone() {
+		events.push(match parse_incoming_pdu(&pdu) {
+			Ok(t) => t,
+			Err(e) => {
+				warn!("Could not parse PDU, ignoring: {e}");
+				continue;
+			},
+		});
+	}
+
+	info!("Fetching required signing keys for all the state events we got");
+	services()
+		.rooms
+		.event_handler
+		.fetch_required_signing_keys(events.iter().map(|(_event_id, event, _room_id)| event), &pub_key_map)
+		.await?;
+
+	info!("Going through room_state response PDUs");
+	for result in remote_state_response
+		.pdus
+		.iter()
+		.map(|pdu| validate_and_add_event_id(pdu, &room_version, &pub_key_map))
+	{
+		let Ok((event_id, value)) = result.await else {
+			continue;
+		};
+
+		let pdu = PduEvent::from_id_val(&event_id, value.clone()).map_err(|e| {
+			warn!("Invalid PDU in fetching remote room state PDUs response: {} {:?}", e, value);
+			Error::BadServerResponse("Invalid PDU in send_join response.")
+		})?;
+
+		services()
+			.rooms
+			.outlier
+			.add_pdu_outlier(&event_id, &value)?;
+		if let Some(state_key) = &pdu.state_key {
+			let shortstatekey = services()
+				.rooms
+				.short
+				.get_or_create_shortstatekey(&pdu.kind.to_string().into(), state_key)?;
+			state.insert(shortstatekey, pdu.event_id.clone());
+		}
+	}
+
+	info!("Going through auth_chain response");
+	for result in remote_state_response
+		.auth_chain
+		.iter()
+		.map(|pdu| validate_and_add_event_id(pdu, &room_version, &pub_key_map))
+	{
+		let Ok((event_id, value)) = result.await else {
+			continue;
+		};
+
+		services()
+			.rooms
+			.outlier
+			.add_pdu_outlier(&event_id, &value)?;
+	}
+
+	let new_room_state = services()
+		.rooms
+		.event_handler
+		.resolve_state(room_id.clone().as_ref(), &room_version, state)
+		.await?;
+
+	info!("Forcing new room state");
+	let (short_state_hash, new, removed) = services()
+		.rooms
+		.state_compressor
+		.save_state(room_id.clone().as_ref(), new_room_state)?;
+
+	let state_lock = services().globals.roomid_mutex_state.lock(&room_id).await;
+	services()
+		.rooms
+		.state
+		.force_state(room_id.clone().as_ref(), short_state_hash, new, 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"
+	);
+	services().rooms.state_cache.update_joined_count(&room_id)?;
+
+	drop(state_lock);
+
+	Ok(RoomMessageEventContent::text_plain(
+		"Successfully forced the room state from the requested remote server.",
+	))
+}
+
+pub(super) async fn resolve_true_destination(
+	_body: Vec<&str>, server_name: Box<ServerName>, no_cache: bool,
+) -> Result<RoomMessageEventContent> {
+	if !services().globals.config.allow_federation {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Federation is disabled on this homeserver.",
+		));
+	}
+
+	if server_name == 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 filter: &capture::Filter = &|data| {
+		data.level() <= log::Level::DEBUG
+			&& data.mod_name().starts_with("conduit")
+			&& matches!(data.span_name(), "actual" | "well-known" | "srv")
+	};
+
+	let state = &services().server.log.capture;
+	let logs = Arc::new(Mutex::new(String::new()));
+	let capture = Capture::new(state, Some(filter), capture::fmt_markdown(logs.clone()));
+
+	let capture_scope = capture.start();
+	let actual = resolve_actual_dest(&server_name, !no_cache).await?;
+	drop(capture_scope);
+
+	let msg = format!(
+		"{}\nDestination: {}\nHostname URI: {}",
+		logs.lock().expect("locked"),
+		actual.dest,
+		actual.host,
+	);
+	Ok(RoomMessageEventContent::text_markdown(msg))
+}
+
+#[must_use]
+pub(super) fn memory_stats() -> RoomMessageEventContent {
+	let html_body = conduit::alloc::memory_stats();
+
+	if html_body.is_empty() {
+		return RoomMessageEventContent::text_plain("malloc stats are not supported on your compiled malloc.");
+	}
+
+	RoomMessageEventContent::text_html(
+		"This command's output can only be viewed by clients that render HTML.".to_owned(),
+		html_body,
+	)
+}

src/admin/debug/mod.rs

@@ -1,17 +1,21 @@
+mod commands;
+pub(crate) mod tester;
+
 use clap::Subcommand;
-use ruma::{events::room::message::RoomMessageEventContent, EventId, RoomId, ServerName};
+use conduit::Result;
+use ruma::{events::room::message::RoomMessageEventContent, EventId, OwnedRoomOrAliasId, RoomId, ServerName};
+use tester::TesterCommand;
 
-use self::debug_commands::{
-	change_log_level, force_device_list_updates, get_auth_chain, get_pdu, get_remote_pdu, get_remote_pdu_list,
-	get_room_state, memory_stats, parse_pdu, ping, resolve_true_destination, sign_json, verify_json,
-};
-use crate::Result;
-
-pub(crate) mod debug_commands;
+use self::commands::*;
 
 #[cfg_attr(test, derive(Debug))]
 #[derive(Subcommand)]
-pub(crate) enum DebugCommand {
+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)
@@ -34,8 +38,8 @@ pub(crate) enum DebugCommand {
 	},
 
 	/// - 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).
+	///   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>,
@@ -45,8 +49,8 @@ pub(crate) enum DebugCommand {
 		server: Box<ServerName>,
 	},
 
-	/// Same as `get-remote-pdu` but accepts a codeblock newline delimited list
-	/// of PDUs and a single server to fetch from
+	/// - 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.
@@ -69,7 +73,7 @@ pub(crate) enum DebugCommand {
 	/// Of course the check is still done on the actual client API.
 	GetRoomState {
 		/// Room ID
-		room_id: Box<RoomId>,
+		room_id: OwnedRoomOrAliasId,
 	},
 
 	/// - Sends a federation request to the remote server's
@@ -107,6 +111,41 @@ pub(crate) enum DebugCommand {
 	/// the command.
 	VerifyJson,
 
+	/// - 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
 	///
@@ -120,10 +159,17 @@ pub(crate) enum DebugCommand {
 
 	/// - Print extended memory usage
 	MemoryStats,
+
+	/// - Developer test stubs
+	#[command(subcommand)]
+	Tester(TesterCommand),
 }
 
-pub(crate) async fn process(command: DebugCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
+pub(super) async fn process(command: DebugCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
 	Ok(match command {
+		DebugCommand::Echo {
+			message,
+		} => echo(body, message).await?,
 		DebugCommand::GetAuthChain {
 			event_id,
 		} => get_auth_chain(body, event_id).await?,
@@ -148,14 +194,25 @@ pub(crate) async fn process(command: DebugCommand, body: Vec<&str>) -> Result<Ro
 		} => change_log_level(body, filter, reset).await?,
 		DebugCommand::SignJson => sign_json(body).await?,
 		DebugCommand::VerifyJson => verify_json(body).await?,
+		DebugCommand::FirstPduInRoom {
+			room_id,
+		} => first_pdu_in_room(body, room_id).await?,
+		DebugCommand::LatestPduInRoom {
+			room_id,
+		} => latest_pdu_in_room(body, room_id).await?,
 		DebugCommand::GetRemotePduList {
 			server,
 			force,
 		} => get_remote_pdu_list(body, server, force).await?,
+		DebugCommand::ForceSetRoomStateFromServer {
+			room_id,
+			server_name,
+		} => force_set_room_state_from_server(body, server_name, room_id).await?,
 		DebugCommand::ResolveTrueDestination {
 			server_name,
 			no_cache,
 		} => resolve_true_destination(body, server_name, no_cache).await?,
 		DebugCommand::MemoryStats => memory_stats(),
+		DebugCommand::Tester(command) => tester::process(command, body).await?,
 	})
 }

src/admin/debug/tester.rs

@@ -0,0 +1,42 @@
+use ruma::events::room::message::RoomMessageEventContent;
+
+use crate::Result;
+
+#[derive(clap::Subcommand)]
+#[cfg_attr(test, derive(Debug))]
+pub(crate) enum TesterCommand {
+	Tester,
+	Timer,
+}
+
+pub(super) async fn process(command: TesterCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	match command {
+		TesterCommand::Tester => tester(body).await,
+		TesterCommand::Timer => timer(body).await,
+	}
+}
+
+#[inline(never)]
+#[rustfmt::skip]
+#[allow(unused_variables)]
+async fn tester(body: Vec<&str>) -> Result<RoomMessageEventContent> {
+
+	Ok(RoomMessageEventContent::notice_plain("completed"))
+}
+
+#[inline(never)]
+#[rustfmt::skip]
+async fn timer(body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	let started = std::time::Instant::now();
+	timed(&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

@@ -1,36 +1,36 @@
-use std::fmt::Write as _;
+use std::fmt::Write;
 
 use ruma::{events::room::message::RoomMessageEventContent, OwnedRoomId, RoomId, ServerName, UserId};
 
-use crate::{
-	service::admin::{escape_html, get_room_info},
-	services,
-	utils::HtmlEscape,
-	Result,
-};
+use crate::{escape_html, get_room_info, services, Result};
 
-pub(crate) async fn disable_room(_body: Vec<&str>, room_id: Box<RoomId>) -> Result<RoomMessageEventContent> {
+pub(super) async fn disable_room(_body: Vec<&str>, room_id: Box<RoomId>) -> Result<RoomMessageEventContent> {
 	services().rooms.metadata.disable_room(&room_id, true)?;
 	Ok(RoomMessageEventContent::text_plain("Room disabled."))
 }
 
-pub(crate) async fn enable_room(_body: Vec<&str>, room_id: Box<RoomId>) -> Result<RoomMessageEventContent> {
+pub(super) async fn enable_room(_body: Vec<&str>, room_id: Box<RoomId>) -> Result<RoomMessageEventContent> {
 	services().rooms.metadata.disable_room(&room_id, false)?;
 	Ok(RoomMessageEventContent::text_plain("Room enabled."))
 }
 
-pub(crate) async fn incoming_federeation(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
-	let map = services().globals.roomid_federationhandletime.read().await;
+pub(super) async fn incoming_federation(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	let map = services()
+		.globals
+		.roomid_federationhandletime
+		.read()
+		.expect("locked");
 	let mut msg = format!("Handling {} incoming pdus:\n", map.len());
 
 	for (r, (e, i)) in map.iter() {
 		let elapsed = i.elapsed();
-		let _ = writeln!(msg, "{} {}: {}m{}s", r, e, elapsed.as_secs() / 60, elapsed.as_secs() % 60);
+		writeln!(msg, "{} {}: {}m{}s", r, e, elapsed.as_secs() / 60, elapsed.as_secs() % 60)?;
 	}
+
 	Ok(RoomMessageEventContent::text_plain(&msg))
 }
 
-pub(crate) async fn fetch_support_well_known(
+pub(super) async fn fetch_support_well_known(
 	_body: Vec<&str>, server_name: Box<ServerName>,
 ) -> Result<RoomMessageEventContent> {
 	let response = services()
@@ -67,16 +67,12 @@ pub(crate) async fn fetch_support_well_known(
 		},
 	};
 
-	Ok(RoomMessageEventContent::text_html(
-		format!("Got JSON response:\n\n```json\n{pretty_json}\n```"),
-		format!(
-			"<p>Got JSON response:</p>\n<pre><code class=\"language-json\">{}\n</code></pre>\n",
-			HtmlEscape(&pretty_json)
-		),
-	))
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Got JSON response:\n\n```json\n{pretty_json}\n```"
+	)))
 }
 
-pub(crate) async fn remote_user_in_rooms(_body: Vec<&str>, user_id: Box<UserId>) -> Result<RoomMessageEventContent> {
+pub(super) async fn remote_user_in_rooms(_body: Vec<&str>, user_id: Box<UserId>) -> Result<RoomMessageEventContent> {
 	if user_id.server_name() == services().globals.config.server_name {
 		return Ok(RoomMessageEventContent::text_plain(
 			"User belongs to our server, please use `list-joined-rooms` user admin command instead.",
@@ -105,7 +101,8 @@ pub(crate) async fn remote_user_in_rooms(_body: Vec<&str>, user_id: Box<UserId>)
 	rooms.reverse();
 
 	let output_plain = format!(
-		"Rooms {user_id} shares with us:\n{}",
+		"Rooms {user_id} shares with us ({}):\n{}",
+		rooms.len(),
 		rooms
 			.iter()
 			.map(|(id, members, name)| format!("{id}\tMembers: {members}\tName: {name}"))
@@ -113,19 +110,20 @@ pub(crate) async fn remote_user_in_rooms(_body: Vec<&str>, user_id: Box<UserId>)
 			.join("\n")
 	);
 	let output_html = format!(
-		"<table><caption>Rooms {user_id} shares with \
-		 us</caption>\n<tr><th>id</th>\t<th>members</th>\t<th>name</th></tr>\n{}</table>",
+		"<table><caption>Rooms {user_id} shares with us \
+		 ({})</caption>\n<tr><th>id</th>\t<th>members</th>\t<th>name</th></tr>\n{}</table>",
+		rooms.len(),
 		rooms
 			.iter()
 			.fold(String::new(), |mut output, (id, members, name)| {
 				writeln!(
 					output,
 					"<tr><td>{}</td>\t<td>{}</td>\t<td>{}</td></tr>",
-					escape_html(id.as_ref()),
+					id,
 					members,
 					escape_html(name)
 				)
-				.unwrap();
+				.expect("should be able to write to string buffer");
 				output
 			})
 	);

src/admin/federation/mod.rs

@@ -1,16 +1,14 @@
+mod commands;
+
 use clap::Subcommand;
+use conduit::Result;
 use ruma::{events::room::message::RoomMessageEventContent, RoomId, ServerName, UserId};
 
-use self::federation_commands::{
-	disable_room, enable_room, fetch_support_well_known, incoming_federeation, remote_user_in_rooms,
-};
-use crate::Result;
-
-pub(crate) mod federation_commands;
+use self::commands::*;
 
 #[cfg_attr(test, derive(Debug))]
 #[derive(Subcommand)]
-pub(crate) enum FederationCommand {
+pub(super) enum FederationCommand {
 	/// - List all rooms we are currently handling an incoming pdu from
 	IncomingFederation,
 
@@ -43,7 +41,7 @@ pub(crate) enum FederationCommand {
 	},
 }
 
-pub(crate) async fn process(command: FederationCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
+pub(super) async fn process(command: FederationCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
 	Ok(match command {
 		FederationCommand::DisableRoom {
 			room_id,
@@ -51,7 +49,7 @@ pub(crate) async fn process(command: FederationCommand, body: Vec<&str>) -> Resu
 		FederationCommand::EnableRoom {
 			room_id,
 		} => enable_room(body, room_id).await?,
-		FederationCommand::IncomingFederation => incoming_federeation(body).await?,
+		FederationCommand::IncomingFederation => incoming_federation(body).await?,
 		FederationCommand::FetchSupportWellKnown {
 			server_name,
 		} => fetch_support_well_known(body, server_name).await?,

src/admin/handler.rs

@@ -0,0 +1,171 @@
+use std::time::Instant;
+
+use clap::Parser;
+use conduit::trace;
+use ruma::events::{
+	relation::InReplyTo,
+	room::message::{Relation::Reply, RoomMessageEventContent},
+};
+
+extern crate conduit_service as service;
+
+use conduit::Result;
+pub(crate) use service::admin::{Command, Service};
+use service::admin::{CommandOutput, CommandResult, HandlerResult};
+
+use crate::{
+	appservice, appservice::AppserviceCommand, check, check::CheckCommand, debug, debug::DebugCommand, federation,
+	federation::FederationCommand, media, media::MediaCommand, query, query::QueryCommand, room, room::RoomCommand,
+	server, server::ServerCommand, services, user, user::UserCommand,
+};
+pub(crate) const PAGE_SIZE: usize = 100;
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Parser)]
+#[command(name = "admin", version = env!("CARGO_PKG_VERSION"))]
+pub(crate) 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),
+}
+
+#[must_use]
+pub fn handle(command: Command) -> HandlerResult { Box::pin(handle_command(command)) }
+
+#[tracing::instrument(skip_all, name = "admin")]
+async fn handle_command(command: Command) -> CommandResult {
+	let Some(mut content) = process_admin_message(command.command).await else {
+		return Ok(None);
+	};
+
+	content.relates_to = command.reply_id.map(|event_id| Reply {
+		in_reply_to: InReplyTo {
+			event_id,
+		},
+	});
+
+	Ok(Some(content))
+}
+
+// Parse and process a message from the admin room
+async fn process_admin_message(msg: String) -> CommandOutput {
+	let mut lines = msg.lines().filter(|l| !l.trim().is_empty());
+	let command = lines.next().expect("each string has at least one line");
+	let body = lines.collect::<Vec<_>>();
+	let parsed = match parse_admin_command(command) {
+		Ok(parsed) => parsed,
+		Err(error) => {
+			let server_name = services().globals.server_name();
+			let message = error.replace("server.name", server_name.as_str());
+			return Some(RoomMessageEventContent::notice_markdown(message));
+		},
+	};
+
+	let timer = Instant::now();
+	let result = process_admin_command(parsed, body).await;
+	let elapsed = timer.elapsed();
+	conduit::debug!(?command, ok = result.is_ok(), "command processed in {elapsed:?}");
+	match result {
+		Ok(reply) => Some(reply),
+		Err(error) => Some(RoomMessageEventContent::notice_markdown(format!(
+			"Encountered an error while handling the command:\n```\n{error}\n```"
+		))),
+	}
+}
+
+// Parse chat messages from the admin room into an AdminCommand object
+fn parse_admin_command(command_line: &str) -> Result<AdminCommand, String> {
+	let mut argv = command_line.split_whitespace().collect::<Vec<_>>();
+
+	// 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('\\');
+	}
+
+	// First indice has to be "admin" but for console convenience we add it here
+	let server_user = services().globals.server_user.as_str();
+	if !argv.is_empty() && !argv[0].ends_with("admin") && !argv[0].starts_with(server_user) {
+		argv.insert(0, "admin");
+	}
+
+	// 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");
+	}
+
+	// Backwards compatibility with `register_appservice`-style commands
+	let command_with_dashes_argv1;
+	if argv.len() > 1 && argv[1].contains('_') {
+		command_with_dashes_argv1 = argv[1].replace('_', "-");
+		argv[1] = &command_with_dashes_argv1;
+	}
+
+	// Backwards compatibility with `register_appservice`-style commands
+	let command_with_dashes_argv2;
+	if argv.len() > 2 && argv[2].contains('_') {
+		command_with_dashes_argv2 = argv[2].replace('_', "-");
+		argv[2] = &command_with_dashes_argv2;
+	}
+
+	// if the user is using the `query` command (argv[1]), replace the database
+	// function/table calls with underscores to match the codebase
+	let command_with_dashes_argv3;
+	if argv.len() > 3 && argv[1].eq("query") {
+		command_with_dashes_argv3 = argv[3].replace('_', "-");
+		argv[3] = &command_with_dashes_argv3;
+	}
+
+	trace!(?command_line, ?argv, "parse");
+	AdminCommand::try_parse_from(argv).map_err(|error| error.to_string())
+}
+
+#[tracing::instrument(skip_all, name = "command")]
+async fn process_admin_command(command: AdminCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	let reply_message_content = match command {
+		AdminCommand::Appservices(command) => appservice::process(command, body).await?,
+		AdminCommand::Media(command) => media::process(command, body).await?,
+		AdminCommand::Users(command) => user::process(command, body).await?,
+		AdminCommand::Rooms(command) => room::process(command, body).await?,
+		AdminCommand::Federation(command) => federation::process(command, body).await?,
+		AdminCommand::Server(command) => server::process(command, body).await?,
+		AdminCommand::Debug(command) => debug::process(command, body).await?,
+		AdminCommand::Query(command) => query::process(command, body).await?,
+		AdminCommand::Check(command) => check::process(command, body).await?,
+	};
+
+	Ok(reply_message_content)
+}

src/admin/media/commands.rs

@@ -1,9 +1,10 @@
-use ruma::{events::room::message::RoomMessageEventContent, EventId};
+use conduit::Result;
+use ruma::{events::room::message::RoomMessageEventContent, EventId, MxcUri};
 use tracing::{debug, info};
 
-use crate::{service::admin::MxcUri, services, Result};
+use crate::services;
 
-pub(crate) async fn delete(
+pub(super) async fn delete(
 	_body: Vec<&str>, mxc: Option<Box<MxcUri>>, event_id: Option<Box<EventId>>,
 ) -> Result<RoomMessageEventContent> {
 	if event_id.is_some() && mxc.is_some() {
@@ -14,7 +15,7 @@ pub(crate) async fn delete(
 
 	if let Some(mxc) = mxc {
 		debug!("Got MXC URL: {mxc}");
-		services().media.delete(mxc.to_string()).await?;
+		services().media.delete(mxc.as_ref()).await?;
 
 		return Ok(RoomMessageEventContent::text_plain(
 			"Deleted the MXC from our database and on our filesystem.",
@@ -23,7 +24,7 @@ pub(crate) async fn delete(
 		debug!("Got event ID to delete media from: {event_id}");
 
 		let mut mxc_urls = vec![];
-		let mut mxc_deletion_count = 0;
+		let mut mxc_deletion_count: usize = 0;
 
 		// parsing the PDU for any MXC URLs begins here
 		if let Some(event_json) = services().rooms.timeline.get_pdu_json(&event_id)? {
@@ -122,8 +123,8 @@ pub(crate) async fn delete(
 		}
 
 		for mxc_url in mxc_urls {
-			services().media.delete(mxc_url).await?;
-			mxc_deletion_count += 1;
+			services().media.delete(&mxc_url).await?;
+			mxc_deletion_count = mxc_deletion_count.saturating_add(1);
 		}
 
 		return Ok(RoomMessageEventContent::text_plain(format!(
@@ -137,32 +138,39 @@ pub(crate) async fn delete(
 	))
 }
 
-pub(crate) async fn delete_list(body: Vec<&str>) -> Result<RoomMessageEventContent> {
-	if body.len() > 2 && body[0].trim().starts_with("```") && body.last().unwrap().trim() == "```" {
-		let mxc_list = body.clone().drain(1..body.len() - 1).collect::<Vec<_>>();
-
-		let mut mxc_deletion_count = 0;
-
-		for mxc in mxc_list {
-			debug!("Deleting MXC {mxc} in bulk");
-			services().media.delete(mxc.to_owned()).await?;
-			mxc_deletion_count += 1;
-		}
-
-		return Ok(RoomMessageEventContent::text_plain(format!(
-			"Finished bulk MXC deletion, deleted {mxc_deletion_count} total MXCs from our database and the filesystem.",
-		)));
+pub(super) async fn delete_list(body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	if body.len() < 2 || !body[0].trim().starts_with("```") || body.last().unwrap_or(&"").trim() != "```" {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		));
 	}
 
-	Ok(RoomMessageEventContent::text_plain(
-		"Expected code block in command body. Add --help for details.",
-	))
+	let mxc_list = body
+		.clone()
+		.drain(1..body.len().checked_sub(1).unwrap())
+		.collect::<Vec<_>>();
+
+	let mut mxc_deletion_count: usize = 0;
+
+	for mxc in mxc_list {
+		debug!("Deleting MXC {mxc} in bulk");
+		services().media.delete(mxc).await?;
+		mxc_deletion_count = mxc_deletion_count
+			.checked_add(1)
+			.expect("mxc_deletion_count should not get this high");
+	}
+
+	Ok(RoomMessageEventContent::text_plain(format!(
+		"Finished bulk MXC deletion, deleted {mxc_deletion_count} total MXCs from our database and the filesystem.",
+	)))
 }
 
-pub(crate) async fn delete_past_remote_media(_body: Vec<&str>, duration: String) -> Result<RoomMessageEventContent> {
+pub(super) async fn delete_past_remote_media(
+	_body: Vec<&str>, duration: String, force: bool,
+) -> Result<RoomMessageEventContent> {
 	let deleted_count = services()
 		.media
-		.delete_all_remote_media_at_after_time(duration)
+		.delete_all_remote_media_at_after_time(duration, force)
 		.await?;
 
 	Ok(RoomMessageEventContent::text_plain(format!(

src/admin/media/mod.rs

@@ -1,14 +1,14 @@
+mod commands;
+
 use clap::Subcommand;
-use ruma::{events::room::message::RoomMessageEventContent, EventId};
+use conduit::Result;
+use ruma::{events::room::message::RoomMessageEventContent, EventId, MxcUri};
 
-use self::media_commands::{delete, delete_list, delete_past_remote_media};
-use crate::{service::admin::MxcUri, Result};
-
-pub(crate) mod media_commands;
+use self::commands::*;
 
 #[cfg_attr(test, derive(Debug))]
 #[derive(Subcommand)]
-pub(crate) enum MediaCommand {
+pub(super) enum MediaCommand {
 	/// - Deletes a single media file from our database and on the filesystem
 	///   via a single MXC URL
 	Delete {
@@ -32,10 +32,13 @@ pub(crate) enum MediaCommand {
 		/// - The duration (at or after), e.g. "5m" to delete all media in the
 		///   past 5 minutes
 		duration: String,
+		/// Continues deleting remote media if an undeletable object is found
+		#[arg(short, long)]
+		force: bool,
 	},
 }
 
-pub(crate) async fn process(command: MediaCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
+pub(super) async fn process(command: MediaCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
 	Ok(match command {
 		MediaCommand::Delete {
 			mxc,
@@ -44,6 +47,7 @@ pub(crate) async fn process(command: MediaCommand, body: Vec<&str>) -> Result<Ro
 		MediaCommand::DeleteList => delete_list(body).await?,
 		MediaCommand::DeletePastRemoteMedia {
 			duration,
-		} => delete_past_remote_media(body, duration).await?,
+			force,
+		} => delete_past_remote_media(body, duration, force).await?,
 	})
 }

src/admin/mod.rs

@@ -0,0 +1,56 @@
+#![allow(clippy::wildcard_imports)]
+
+pub(crate) mod appservice;
+pub(crate) mod check;
+pub(crate) mod debug;
+pub(crate) mod federation;
+pub(crate) mod handler;
+pub(crate) mod media;
+pub(crate) mod query;
+pub(crate) mod room;
+pub(crate) mod server;
+pub(crate) mod user;
+pub(crate) mod utils;
+
+extern crate conduit_api as api;
+extern crate conduit_core as conduit;
+extern crate conduit_service as service;
+
+pub(crate) use conduit::{mod_ctor, mod_dtor, Result};
+pub use handler::handle;
+pub(crate) use service::{services, user_is_local};
+
+pub(crate) use crate::{
+	handler::Service,
+	utils::{escape_html, get_room_info},
+};
+
+mod_ctor! {}
+mod_dtor! {}
+
+#[cfg(test)]
+mod test {
+	use clap::Parser;
+
+	use crate::handler::AdminCommand;
+
+	#[test]
+	fn get_help_short() { get_help_inner("-h"); }
+
+	#[test]
+	fn get_help_long() { get_help_inner("--help"); }
+
+	#[test]
+	fn get_help_subcommand() { get_help_inner("help"); }
+
+	fn get_help_inner(input: &str) {
+		let error = AdminCommand::try_parse_from(["argv[0] doesn't matter", input])
+			.unwrap_err()
+			.to_string();
+
+		// Search for a handful of keywords that suggest the help printed properly
+		assert!(error.contains("Usage:"));
+		assert!(error.contains("Commands:"));
+		assert!(error.contains("Options:"));
+	}
+}

src/admin/query/account_data.rs

@@ -4,7 +4,7 @@
 use crate::{services, Result};
 
 /// All the getters and iterators from src/database/key_value/account_data.rs
-pub(crate) async fn account_data(subcommand: AccountData) -> Result<RoomMessageEventContent> {
+pub(super) async fn account_data(subcommand: AccountData) -> Result<RoomMessageEventContent> {
 	match subcommand {
 		AccountData::ChangesSince {
 			user_id,
@@ -14,17 +14,12 @@ pub(crate) async fn account_data(subcommand: AccountData) -> Result<RoomMessageE
 			let timer = tokio::time::Instant::now();
 			let results = services()
 				.account_data
-				.db
 				.changes_since(room_id.as_deref(), &user_id, since)?;
 			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```"
+			)))
 		},
 		AccountData::Get {
 			user_id,
@@ -34,17 +29,12 @@ pub(crate) async fn account_data(subcommand: AccountData) -> Result<RoomMessageE
 			let timer = tokio::time::Instant::now();
 			let results = services()
 				.account_data
-				.db
 				.get(room_id.as_deref(), &user_id, kind)?;
 			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/appservice.rs

@@ -4,7 +4,7 @@
 use crate::{services, Result};
 
 /// All the getters and iterators from src/database/key_value/appservice.rs
-pub(crate) async fn appservice(subcommand: Appservice) -> Result<RoomMessageEventContent> {
+pub(super) async fn appservice(subcommand: Appservice) -> Result<RoomMessageEventContent> {
 	match subcommand {
 		Appservice::GetRegistration {
 			appservice_id,
@@ -16,26 +16,18 @@ pub(crate) async fn appservice(subcommand: Appservice) -> Result<RoomMessageEven
 				.get_registration(appservice_id.as_ref());
 			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```"
+			)))
 		},
 		Appservice::All => {
 			let timer = tokio::time::Instant::now();
-			let results = services().appservice.db.all();
+			let results = services().appservice.all();
 			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/globals.rs

@@ -0,0 +1,57 @@
+use ruma::events::room::message::RoomMessageEventContent;
+
+use super::Globals;
+use crate::{services, Result};
+
+/// All the getters and iterators from src/database/key_value/globals.rs
+pub(super) async fn globals(subcommand: Globals) -> Result<RoomMessageEventContent> {
+	match subcommand {
+		Globals::DatabaseVersion => {
+			let timer = tokio::time::Instant::now();
+			let results = services().globals.db.database_version();
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		Globals::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```"
+			)))
+		},
+		Globals::LastCheckForUpdatesId => {
+			let timer = tokio::time::Instant::now();
+			let results = services().globals.db.last_check_for_updates_id();
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		Globals::LoadKeypair => {
+			let timer = tokio::time::Instant::now();
+			let results = services().globals.db.load_keypair();
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		Globals::SigningKeysFor {
+			origin,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services().globals.db.signing_keys_for(&origin);
+			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

@@ -1,27 +1,30 @@
-pub(crate) mod account_data;
-pub(crate) mod appservice;
-pub(crate) mod globals;
-pub(crate) mod presence;
-pub(crate) mod room_alias;
-pub(crate) mod sending;
-pub(crate) mod users;
+mod account_data;
+mod appservice;
+mod globals;
+mod presence;
+mod resolver;
+mod room_alias;
+mod room_state_cache;
+mod sending;
+mod users;
 
 use clap::Subcommand;
+use conduit::Result;
+use room_state_cache::room_state_cache;
 use ruma::{
 	events::{room::message::RoomMessageEventContent, RoomAccountDataEventType},
-	RoomAliasId, RoomId, ServerName, UserId,
+	OwnedServerName, RoomAliasId, RoomId, ServerName, UserId,
 };
 
 use self::{
-	account_data::account_data, appservice::appservice, globals::globals, presence::presence, room_alias::room_alias,
-	sending::sending, users::users,
+	account_data::account_data, appservice::appservice, globals::globals, presence::presence, resolver::resolver,
+	room_alias::room_alias, sending::sending, users::users,
 };
-use crate::Result;
 
 #[cfg_attr(test, derive(Debug))]
 #[derive(Subcommand)]
 /// Query tables from database
-pub(crate) enum QueryCommand {
+pub(super) enum QueryCommand {
 	/// - account_data.rs iterators and getters
 	#[command(subcommand)]
 	AccountData(AccountData),
@@ -38,6 +41,10 @@ pub(crate) enum QueryCommand {
 	#[command(subcommand)]
 	RoomAlias(RoomAlias),
 
+	/// - rooms/state_cache iterators and getters
+	#[command(subcommand)]
+	RoomStateCache(RoomStateCache),
+
 	/// - globals.rs iterators and getters
 	#[command(subcommand)]
 	Globals(Globals),
@@ -49,12 +56,16 @@ pub(crate) enum QueryCommand {
 	/// - users.rs iterators and getters
 	#[command(subcommand)]
 	Users(Users),
+
+	/// - resolver service
+	#[command(subcommand)]
+	Resolver(Resolver),
 }
 
 #[cfg_attr(test, derive(Debug))]
 #[derive(Subcommand)]
 /// All the getters and iterators from src/database/key_value/account_data.rs
-pub(crate) enum AccountData {
+pub(super) enum AccountData {
 	/// - Returns all changes to the account data that happened after `since`.
 	ChangesSince {
 		/// Full user ID
@@ -79,7 +90,7 @@ pub(crate) enum AccountData {
 #[cfg_attr(test, derive(Debug))]
 #[derive(Subcommand)]
 /// All the getters and iterators from src/database/key_value/appservice.rs
-pub(crate) enum Appservice {
+pub(super) enum Appservice {
 	/// - Gets the appservice registration info/details from the ID as a string
 	GetRegistration {
 		/// Appservice registration ID
@@ -93,7 +104,7 @@ pub(crate) enum Appservice {
 #[cfg_attr(test, derive(Debug))]
 #[derive(Subcommand)]
 /// All the getters and iterators from src/database/key_value/presence.rs
-pub(crate) enum Presence {
+pub(super) enum Presence {
 	/// - Returns the latest presence event for the given user.
 	GetPresence {
 		/// Full user ID
@@ -111,7 +122,7 @@ pub(crate) enum Presence {
 #[cfg_attr(test, derive(Debug))]
 #[derive(Subcommand)]
 /// All the getters and iterators from src/database/key_value/rooms/alias.rs
-pub(crate) enum RoomAlias {
+pub(super) enum RoomAlias {
 	ResolveLocalAlias {
 		/// Full room alias
 		alias: Box<RoomAliasId>,
@@ -127,10 +138,82 @@ pub(crate) enum RoomAlias {
 	AllLocalAliases,
 }
 
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+pub(super) enum RoomStateCache {
+	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>,
+	},
+}
+
 #[cfg_attr(test, derive(Debug))]
 #[derive(Subcommand)]
 /// All the getters and iterators from src/database/key_value/globals.rs
-pub(crate) enum Globals {
+pub(super) enum Globals {
 	DatabaseVersion,
 
 	CurrentCount,
@@ -149,7 +232,7 @@ pub(crate) enum Globals {
 #[cfg_attr(test, derive(Debug))]
 #[derive(Subcommand)]
 /// All the getters and iterators from src/database/key_value/sending.rs
-pub(crate) enum Sending {
+pub(super) enum Sending {
 	/// - Queries database for all `servercurrentevent_data`
 	ActiveRequests,
 
@@ -205,19 +288,36 @@ pub(crate) enum Sending {
 #[cfg_attr(test, derive(Debug))]
 #[derive(Subcommand)]
 /// All the getters and iterators from src/database/key_value/users.rs
-pub(crate) enum Users {
+pub(super) enum Users {
 	Iter,
 }
 
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+/// Resolver service and caches
+pub(super) enum Resolver {
+	/// Query the destinations cache
+	DestinationsCache {
+		server_name: Option<OwnedServerName>,
+	},
+
+	/// Query the overrides cache
+	OverridesCache {
+		name: Option<String>,
+	},
+}
+
 /// Processes admin query commands
-pub(crate) async fn process(command: QueryCommand, _body: Vec<&str>) -> Result<RoomMessageEventContent> {
+pub(super) async fn process(command: QueryCommand, _body: Vec<&str>) -> Result<RoomMessageEventContent> {
 	Ok(match command {
 		QueryCommand::AccountData(command) => account_data(command).await?,
 		QueryCommand::Appservice(command) => appservice(command).await?,
 		QueryCommand::Presence(command) => presence(command).await?,
 		QueryCommand::RoomAlias(command) => room_alias(command).await?,
+		QueryCommand::RoomStateCache(command) => room_state_cache(command).await?,
 		QueryCommand::Globals(command) => globals(command).await?,
 		QueryCommand::Sending(command) => sending(command).await?,
 		QueryCommand::Users(command) => users(command).await?,
+		QueryCommand::Resolver(command) => resolver(command).await?,
 	})
 }

src/admin/query/presence.rs

@@ -4,7 +4,7 @@
 use crate::{services, Result};
 
 /// All the getters and iterators in key_value/presence.rs
-pub(crate) async fn presence(subcommand: Presence) -> Result<RoomMessageEventContent> {
+pub(super) async fn presence(subcommand: Presence) -> Result<RoomMessageEventContent> {
 	match subcommand {
 		Presence::GetPresence {
 			user_id,
@@ -13,30 +13,21 @@ pub(crate) async fn presence(subcommand: Presence) -> Result<RoomMessageEventCon
 			let results = services().presence.db.get_presence(&user_id)?;
 			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```"
+			)))
 		},
 		Presence::PresenceSince {
 			since,
 		} => {
 			let timer = tokio::time::Instant::now();
 			let results = services().presence.db.presence_since(since);
+			let presence_since: Vec<(_, _, _)> = results.collect();
 			let query_time = timer.elapsed();
 
-			let presence_since: Vec<(_, _, _)> = results.collect();
-
-			Ok(RoomMessageEventContent::text_html(
-				format!("Query completed in {query_time:?}:\n\n```\n{:?}```", presence_since),
-				format!(
-					"<p>Query completed in {query_time:?}:</p>\n<pre><code>{:?}\n</code></pre>",
-					presence_since
-				),
-			))
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{presence_since:#?}\n```"
+			)))
 		},
 	}
 }

src/admin/query/resolver.rs

@@ -0,0 +1,87 @@
+use std::fmt::Write;
+
+use conduit::{utils::time, Result};
+use ruma::{events::room::message::RoomMessageEventContent, OwnedServerName};
+
+use super::Resolver;
+use crate::services;
+
+/// All the getters and iterators in key_value/users.rs
+pub(super) async fn resolver(subcommand: Resolver) -> Result<RoomMessageEventContent> {
+	match subcommand {
+		Resolver::DestinationsCache {
+			server_name,
+		} => destinations_cache(server_name).await,
+		Resolver::OverridesCache {
+			name,
+		} => overrides_cache(name).await,
+	}
+}
+
+async fn destinations_cache(server_name: Option<OwnedServerName>) -> Result<RoomMessageEventContent> {
+	use service::sending::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 = services()
+		.globals
+		.resolver
+		.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))
+}
+
+async fn overrides_cache(server_name: Option<String>) -> Result<RoomMessageEventContent> {
+	use service::sending::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 = services()
+		.globals
+		.resolver
+		.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,43 @@
+use ruma::events::room::message::RoomMessageEventContent;
+
+use super::RoomAlias;
+use crate::{services, Result};
+
+/// All the getters and iterators in src/database/key_value/rooms/alias.rs
+pub(super) async fn room_alias(subcommand: RoomAlias) -> Result<RoomMessageEventContent> {
+	match subcommand {
+		RoomAlias::ResolveLocalAlias {
+			alias,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services().rooms.alias.resolve_local_alias(&alias);
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomAlias::LocalAliasesForRoom {
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services().rooms.alias.local_aliases_for_room(&room_id);
+			let aliases: Vec<_> = results.collect();
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{aliases:#?}\n```"
+			)))
+		},
+		RoomAlias::AllLocalAliases => {
+			let timer = tokio::time::Instant::now();
+			let results = services().rooms.alias.all_local_aliases();
+			let aliases: Vec<_> = results.collect();
+			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,233 @@
+use ruma::events::room::message::RoomMessageEventContent;
+
+use super::RoomStateCache;
+use crate::{services, Result};
+
+pub(super) async fn room_state_cache(subcommand: RoomStateCache) -> Result<RoomMessageEventContent> {
+	match subcommand {
+		RoomStateCache::ServerInRoom {
+			server,
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let result = services()
+				.rooms
+				.state_cache
+				.server_in_room(&server, &room_id);
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{result:#?}\n```"
+			)))
+		},
+		RoomStateCache::RoomServers {
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Result<Vec<_>> = services()
+				.rooms
+				.state_cache
+				.room_servers(&room_id)
+				.collect();
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCache::ServerRooms {
+			server,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Result<Vec<_>> = services().rooms.state_cache.server_rooms(&server).collect();
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCache::RoomMembers {
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Result<Vec<_>> = services()
+				.rooms
+				.state_cache
+				.room_members(&room_id)
+				.collect();
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCache::LocalUsersInRoom {
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Vec<_> = services()
+				.rooms
+				.state_cache
+				.local_users_in_room(&room_id)
+				.collect();
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCache::ActiveLocalUsersInRoom {
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Vec<_> = services()
+				.rooms
+				.state_cache
+				.active_local_users_in_room(&room_id)
+				.collect();
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCache::RoomJoinedCount {
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services().rooms.state_cache.room_joined_count(&room_id);
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCache::RoomInvitedCount {
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services().rooms.state_cache.room_invited_count(&room_id);
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCache::RoomUserOnceJoined {
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Result<Vec<_>> = services()
+				.rooms
+				.state_cache
+				.room_useroncejoined(&room_id)
+				.collect();
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCache::RoomMembersInvited {
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Result<Vec<_>> = services()
+				.rooms
+				.state_cache
+				.room_members_invited(&room_id)
+				.collect();
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCache::GetInviteCount {
+			room_id,
+			user_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services()
+				.rooms
+				.state_cache
+				.get_invite_count(&room_id, &user_id);
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCache::GetLeftCount {
+			room_id,
+			user_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services()
+				.rooms
+				.state_cache
+				.get_left_count(&room_id, &user_id);
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCache::RoomsJoined {
+			user_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Result<Vec<_>> = services()
+				.rooms
+				.state_cache
+				.rooms_joined(&user_id)
+				.collect();
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCache::RoomsInvited {
+			user_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Result<Vec<_>> = services()
+				.rooms
+				.state_cache
+				.rooms_invited(&user_id)
+				.collect();
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCache::RoomsLeft {
+			user_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results: Result<Vec<_>> = services().rooms.state_cache.rooms_left(&user_id).collect();
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		RoomStateCache::InviteState {
+			user_id,
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services()
+				.rooms
+				.state_cache
+				.invite_state(&user_id, &room_id);
+			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

@@ -4,22 +4,17 @@
 use crate::{service::sending::Destination, services, Result};
 
 /// All the getters and iterators in key_value/sending.rs
-pub(crate) async fn sending(subcommand: Sending) -> Result<RoomMessageEventContent> {
+pub(super) async fn sending(subcommand: Sending) -> Result<RoomMessageEventContent> {
 	match subcommand {
 		Sending::ActiveRequests => {
 			let timer = tokio::time::Instant::now();
 			let results = services().sending.db.active_requests();
+			let active_requests: Result<Vec<(_, _, _)>> = results.collect();
 			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 {
 			appservice_id,
@@ -33,8 +28,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 +38,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 +55,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(
@@ -94,14 +75,11 @@ pub(crate) async fn sending(subcommand: Sending) -> Result<RoomMessageEventConte
 			};
 
 			let queued_requests = results.collect::<Result<Vec<(_, _)>>>();
+			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 {
 			appservice_id,
@@ -116,7 +94,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 +104,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 +121,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(
@@ -176,14 +141,11 @@ pub(crate) async fn sending(subcommand: Sending) -> Result<RoomMessageEventConte
 			};
 
 			let active_requests = results.collect::<Result<Vec<(_, _)>>>();
+			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 {
 			server_name,
@@ -192,13 +154,9 @@ pub(crate) async fn sending(subcommand: Sending) -> Result<RoomMessageEventConte
 			let results = services().sending.db.get_latest_educount(&server_name);
 			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

@@ -4,22 +4,17 @@
 use crate::{services, Result};
 
 /// All the getters and iterators in key_value/users.rs
-pub(crate) async fn users(subcommand: Users) -> Result<RoomMessageEventContent> {
+pub(super) async fn users(subcommand: Users) -> Result<RoomMessageEventContent> {
 	match subcommand {
 		Users::Iter => {
 			let timer = tokio::time::Instant::now();
 			let results = services().users.db.iter();
+			let users = results.collect::<Vec<_>>();
 			let query_time = timer.elapsed();
 
-			let users = results.collect::<Vec<_>>();
-
-			Ok(RoomMessageEventContent::text_html(
-				format!("Query completed in {query_time:?}:\n\n```\n{:?}```", users),
-				format!(
-					"<p>Query completed in {query_time:?}:</p>\n<pre><code>{:?}\n</code></pre>",
-					users
-				),
-			))
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{users:#?}\n```"
+			)))
 		},
 	}
 }

src/admin/room/mod.rs

@@ -1,22 +1,27 @@
+mod room_alias_commands;
+mod room_commands;
+mod room_directory_commands;
+mod room_info_commands;
+mod room_moderation_commands;
+
 use clap::Subcommand;
+use conduit::Result;
 use ruma::{events::room::message::RoomMessageEventContent, RoomId, RoomOrAliasId};
 
 use self::room_commands::list;
-use crate::Result;
-
-pub(crate) mod room_alias_commands;
-pub(crate) mod room_commands;
-pub(crate) mod room_directory_commands;
-pub(crate) mod room_moderation_commands;
 
 #[cfg_attr(test, derive(Debug))]
 #[derive(Subcommand)]
-pub(crate) enum RoomCommand {
+pub(super) enum RoomCommand {
 	/// - List all rooms the server knows about
 	List {
 		page: Option<usize>,
 	},
 
+	#[command(subcommand)]
+	/// - View information about a room we know about
+	Info(RoomInfoCommand),
+
 	#[command(subcommand)]
 	/// - Manage moderation of remote or local rooms
 	Moderation(RoomModerationCommand),
@@ -32,7 +37,24 @@ pub(crate) enum RoomCommand {
 
 #[cfg_attr(test, derive(Debug))]
 #[derive(Subcommand)]
-pub(crate) enum RoomAliasCommand {
+pub(super) enum RoomInfoCommand {
+	/// - List joined members in a room
+	ListJoinedMembers {
+		room_id: Box<RoomId>,
+	},
+
+	/// - Displays room topic
+	///
+	/// Room topics can be huge, so this is in its
+	/// own separate command
+	ViewRoomTopic {
+		room_id: Box<RoomId>,
+	},
+}
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+pub(super) enum RoomAliasCommand {
 	/// - Make an alias point to a room.
 	Set {
 		#[arg(short, long)]
@@ -46,7 +68,7 @@ pub(crate) enum RoomAliasCommand {
 		room_alias_localpart: String,
 	},
 
-	/// - Remove an alias
+	/// - Remove a local alias
 	Remove {
 		/// The alias localpart to remove (`alias`, not `#alias:servername.tld`)
 		room_alias_localpart: String,
@@ -68,7 +90,7 @@ pub(crate) enum RoomAliasCommand {
 
 #[cfg_attr(test, derive(Debug))]
 #[derive(Subcommand)]
-pub(crate) enum RoomDirectoryCommand {
+pub(super) enum RoomDirectoryCommand {
 	/// - Publish a room to the room directory
 	Publish {
 		/// The room id of the room to publish
@@ -89,7 +111,7 @@ pub(crate) enum RoomDirectoryCommand {
 
 #[cfg_attr(test, derive(Debug))]
 #[derive(Subcommand)]
-pub(crate) enum RoomModerationCommand {
+pub(super) enum RoomModerationCommand {
 	/// - Bans a room from local users joining and evicts all our local users
 	///   from the room. Also blocks any invites (local and remote) for the
 	///   banned room.
@@ -145,8 +167,10 @@ pub(crate) enum RoomModerationCommand {
 	ListBannedRooms,
 }
 
-pub(crate) async fn process(command: RoomCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
+pub(super) async fn process(command: RoomCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
 	Ok(match command {
+		RoomCommand::Info(command) => room_info_commands::process(command, body).await?,
+
 		RoomCommand::Alias(command) => room_alias_commands::process(command, body).await?,
 
 		RoomCommand::Directory(command) => room_directory_commands::process(command, body).await?,

src/admin/room/room_alias_commands.rs

@@ -1,11 +1,13 @@
-use std::fmt::Write as _;
+use std::fmt::Write;
 
 use ruma::{events::room::message::RoomMessageEventContent, RoomAliasId};
 
 use super::RoomAliasCommand;
-use crate::{service::admin::escape_html, services, Result};
+use crate::{escape_html, services, Result};
+
+pub(super) async fn process(command: RoomAliasCommand, _body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	let server_user = &services().globals.server_user;
 
-pub(crate) async fn process(command: RoomAliasCommand, _body: Vec<&str>) -> Result<RoomMessageEventContent> {
 	match command {
 		RoomAliasCommand::Set {
 			ref room_alias_localpart,
@@ -20,7 +22,7 @@ pub(crate) async fn process(command: RoomAliasCommand, _body: Vec<&str>) -> Resu
 			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))),
+				Err(err) => return Ok(RoomMessageEventContent::text_plain(format!("Failed to parse alias: {err}"))),
 			};
 			match command {
 				RoomAliasCommand::Set {
@@ -28,18 +30,24 @@ pub(crate) async fn process(command: RoomAliasCommand, _body: Vec<&str>) -> Resu
 					room_id,
 					..
 				} => match (force, services().rooms.alias.resolve_local_alias(&room_alias)) {
-					(true, Ok(Some(id))) => match services().rooms.alias.set_alias(&room_alias, &room_id) {
+					(true, Ok(Some(id))) => match services()
+						.rooms
+						.alias
+						.set_alias(&room_alias, &room_id, server_user)
+					{
 						Ok(()) => Ok(RoomMessageEventContent::text_plain(format!(
-							"Successfully overwrote alias (formerly {})",
-							id
+							"Successfully overwrote alias (formerly {id})"
 						))),
-						Err(err) => Ok(RoomMessageEventContent::text_plain(format!("Failed to remove alias: {}", err))),
+						Err(err) => Ok(RoomMessageEventContent::text_plain(format!("Failed to remove alias: {err}"))),
 					},
 					(false, Ok(Some(id))) => Ok(RoomMessageEventContent::text_plain(format!(
-						"Refusing to overwrite in use alias for {}, use -f or --force to overwrite",
-						id
+						"Refusing to overwrite in use alias for {id}, use -f or --force to overwrite"
 					))),
-					(_, Ok(None)) => match services().rooms.alias.set_alias(&room_alias, &room_id) {
+					(_, Ok(None)) => 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}"))),
 					},
@@ -48,19 +56,24 @@ pub(crate) async fn process(command: RoomAliasCommand, _body: Vec<&str>) -> Resu
 				RoomAliasCommand::Remove {
 					..
 				} => match services().rooms.alias.resolve_local_alias(&room_alias) {
-					Ok(Some(id)) => match services().rooms.alias.remove_alias(&room_alias) {
-						Ok(()) => Ok(RoomMessageEventContent::text_plain(format!("Removed alias from {}", id))),
-						Err(err) => Ok(RoomMessageEventContent::text_plain(format!("Failed to remove alias: {}", err))),
+					Ok(Some(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}"))),
 					},
 					Ok(None) => Ok(RoomMessageEventContent::text_plain("Alias isn't in use.")),
-					Err(err) => Ok(RoomMessageEventContent::text_plain(format!("Unable to lookup alias: {}", err))),
+					Err(err) => Ok(RoomMessageEventContent::text_plain(format!("Unable to lookup alias: {err}"))),
 				},
 				RoomAliasCommand::Which {
 					..
 				} => match services().rooms.alias.resolve_local_alias(&room_alias) {
-					Ok(Some(id)) => Ok(RoomMessageEventContent::text_plain(format!("Alias resolves to {}", id))),
+					Ok(Some(id)) => Ok(RoomMessageEventContent::text_plain(format!("Alias resolves to {id}"))),
 					Ok(None) => Ok(RoomMessageEventContent::text_plain("Alias isn't in use.")),
-					Err(err) => Ok(RoomMessageEventContent::text_plain(format!("Unable to lookup alias: {}", err))),
+					Err(err) => Ok(RoomMessageEventContent::text_plain(format!("Unable to lookup alias: {err}"))),
 				},
 				RoomAliasCommand::List {
 					..
@@ -79,12 +92,13 @@ pub(crate) async fn process(command: RoomAliasCommand, _body: Vec<&str>) -> Resu
 				match aliases {
 					Ok(aliases) => {
 						let plain_list = aliases.iter().fold(String::new(), |mut output, alias| {
-							writeln!(output, "- {alias}").unwrap();
+							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())).unwrap();
+							writeln!(output, "<li>{}</li>", escape_html(alias.as_ref()))
+								.expect("should be able to write to string buffer");
 							output
 						});
 
@@ -92,7 +106,7 @@ pub(crate) async fn process(command: RoomAliasCommand, _body: Vec<&str>) -> Resu
 						let html = format!("Aliases for {room_id}:\n<ul>{html_list}</ul>");
 						Ok(RoomMessageEventContent::text_html(plain, html))
 					},
-					Err(err) => Ok(RoomMessageEventContent::text_plain(format!("Unable to list aliases: {}", err))),
+					Err(err) => Ok(RoomMessageEventContent::text_plain(format!("Unable to list aliases: {err}"))),
 				}
 			} else {
 				let aliases = services()
@@ -106,7 +120,8 @@ pub(crate) async fn process(command: RoomAliasCommand, _body: Vec<&str>) -> Resu
 						let plain_list = aliases
 							.iter()
 							.fold(String::new(), |mut output, (alias, id)| {
-								writeln!(output, "- `{alias}` -> #{id}:{server_name}").unwrap();
+								writeln!(output, "- `{alias}` -> #{id}:{server_name}")
+									.expect("should be able to write to string buffer");
 								output
 							});
 
@@ -120,7 +135,7 @@ pub(crate) async fn process(command: RoomAliasCommand, _body: Vec<&str>) -> Resu
 									escape_html(id.as_ref()),
 									server_name
 								)
-								.unwrap();
+								.expect("should be able to write to string buffer");
 								output
 							});
 

src/admin/room/room_commands.rs

@@ -1,13 +1,10 @@
-use std::fmt::Write as _;
+use std::fmt::Write;
 
 use ruma::{events::room::message::RoomMessageEventContent, OwnedRoomId};
 
-use crate::{
-	service::admin::{escape_html, get_room_info, PAGE_SIZE},
-	services, Result,
-};
+use crate::{escape_html, get_room_info, handler::PAGE_SIZE, services, Result};
 
-pub(crate) async fn list(_body: Vec<&str>, page: Option<usize>) -> Result<RoomMessageEventContent> {
+pub(super) async fn list(_body: Vec<&str>, page: Option<usize>) -> 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 = services()
@@ -22,7 +19,7 @@ pub(crate) async fn list(_body: Vec<&str>, page: Option<usize>) -> Result<RoomMe
 
 	let rooms = rooms
 		.into_iter()
-		.skip(page.saturating_sub(1) * PAGE_SIZE)
+		.skip(page.saturating_sub(1).saturating_mul(PAGE_SIZE))
 		.take(PAGE_SIZE)
 		.collect::<Vec<_>>();
 
@@ -51,7 +48,7 @@ pub(crate) async fn list(_body: Vec<&str>, page: Option<usize>) -> Result<RoomMe
 					members,
 					escape_html(name)
 				)
-				.unwrap();
+				.expect("should be able to write to string buffer");
 				output
 			})
 	);

src/admin/room/room_directory_commands.rs

@@ -1,14 +1,11 @@
-use std::fmt::Write as _;
+use std::fmt::Write;
 
 use ruma::{events::room::message::RoomMessageEventContent, OwnedRoomId};
 
 use super::RoomDirectoryCommand;
-use crate::{
-	service::admin::{escape_html, get_room_info, PAGE_SIZE},
-	services, Result,
-};
+use crate::{escape_html, get_room_info, handler::PAGE_SIZE, services, Result};
 
-pub(crate) async fn process(command: RoomDirectoryCommand, _body: Vec<&str>) -> Result<RoomMessageEventContent> {
+pub(super) async fn process(command: RoomDirectoryCommand, _body: Vec<&str>) -> Result<RoomMessageEventContent> {
 	match command {
 		RoomDirectoryCommand::Publish {
 			room_id,
@@ -39,7 +36,7 @@ pub(crate) async fn process(command: RoomDirectoryCommand, _body: Vec<&str>) ->
 
 			let rooms = rooms
 				.into_iter()
-				.skip(page.saturating_sub(1) * PAGE_SIZE)
+				.skip(page.saturating_sub(1).saturating_mul(PAGE_SIZE))
 				.take(PAGE_SIZE)
 				.collect::<Vec<_>>();
 
@@ -68,7 +65,7 @@ pub(crate) async fn process(command: RoomDirectoryCommand, _body: Vec<&str>) ->
 							members,
 							escape_html(name.as_ref())
 						)
-						.unwrap();
+						.expect("should be able to write to string buffer");
 						output
 					})
 			);

src/admin/room/room_info_commands.rs

@@ -0,0 +1,69 @@
+use ruma::{events::room::message::RoomMessageEventContent, RoomId};
+use service::services;
+
+use super::RoomInfoCommand;
+use crate::Result;
+
+pub(super) async fn process(command: RoomInfoCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	match command {
+		RoomInfoCommand::ListJoinedMembers {
+			room_id,
+		} => list_joined_members(body, room_id).await,
+		RoomInfoCommand::ViewRoomTopic {
+			room_id,
+		} => view_room_topic(body, room_id).await,
+	}
+}
+
+async fn list_joined_members(_body: Vec<&str>, room_id: Box<RoomId>) -> Result<RoomMessageEventContent> {
+	let room_name = services()
+		.rooms
+		.state_accessor
+		.get_name(&room_id)
+		.ok()
+		.flatten()
+		.unwrap_or_else(|| room_id.to_string());
+
+	let members = services()
+		.rooms
+		.state_cache
+		.room_members(&room_id)
+		.filter_map(Result::ok);
+
+	let member_info = members
+		.into_iter()
+		.map(|user_id| {
+			(
+				user_id.clone(),
+				services()
+					.users
+					.displayname(&user_id)
+					.unwrap_or(None)
+					.unwrap_or_else(|| user_id.to_string()),
+			)
+		})
+		.collect::<Vec<_>>();
+
+	let output_plain = format!(
+		"{} Members in Room \"{}\":\n```\n{}\n```",
+		member_info.len(),
+		room_name,
+		member_info
+			.iter()
+			.map(|(mxid, displayname)| format!("{mxid} | {displayname}"))
+			.collect::<Vec<_>>()
+			.join("\n")
+	);
+
+	Ok(RoomMessageEventContent::notice_markdown(output_plain))
+}
+
+async fn view_room_topic(_body: Vec<&str>, room_id: Box<RoomId>) -> Result<RoomMessageEventContent> {
+	let Some(room_topic) = services().rooms.state_accessor.get_room_topic(&room_id)? else {
+		return Ok(RoomMessageEventContent::text_plain("Room does not have a room topic set."));
+	};
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"Room topic:\n\n```{room_topic}\n```"
+	)))
+}

src/admin/room/room_moderation_commands.rs

@@ -0,0 +1,516 @@
+use api::client::leave_room;
+use ruma::{
+	events::room::message::RoomMessageEventContent, OwnedRoomId, OwnedUserId, RoomAliasId, RoomId, RoomOrAliasId,
+};
+use tracing::{debug, error, info, warn};
+
+use super::{super::Service, RoomModerationCommand};
+use crate::{get_room_info, services, user_is_local, Result};
+
+pub(super) async fn process(command: RoomModerationCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	match command {
+		RoomModerationCommand::BanRoom {
+			force,
+			room,
+			disable_federation,
+		} => ban_room(body, force, room, disable_federation).await,
+		RoomModerationCommand::BanListOfRooms {
+			force,
+			disable_federation,
+		} => ban_list_of_rooms(body, force, disable_federation).await,
+		RoomModerationCommand::UnbanRoom {
+			room,
+			enable_federation,
+		} => unban_room(body, room, enable_federation).await,
+		RoomModerationCommand::ListBannedRooms => list_banned_rooms(body).await,
+	}
+}
+
+async fn ban_room(
+	_body: Vec<&str>, force: bool, room: Box<RoomOrAliasId>, disable_federation: bool,
+) -> Result<RoomMessageEventContent> {
+	debug!("Got room alias or ID: {}", room);
+
+	let admin_room_alias = &services().globals.admin_alias;
+
+	if let Some(admin_room_id) = Service::get_admin_room()? {
+		if room.to_string().eq(&admin_room_id) || room.to_string().eq(admin_room_alias) {
+			return Ok(RoomMessageEventContent::text_plain("Not allowed to ban the admin room."));
+		}
+	}
+
+	let room_id = if room.is_room_id() {
+		let room_id = match RoomId::parse(&room) {
+			Ok(room_id) => room_id,
+			Err(e) => {
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"Failed to parse room ID {room}. Please note that this requires a full room ID \
+					 (`!awIh6gGInaS5wLQJwa:example.com`) or a room alias (`#roomalias:example.com`): {e}"
+				)))
+			},
+		};
+
+		debug!("Room specified is a room ID, banning room ID");
+
+		services().rooms.metadata.ban_room(&room_id, true)?;
+
+		room_id
+	} else if room.is_room_alias_id() {
+		let room_alias = match RoomAliasId::parse(&room) {
+			Ok(room_alias) => room_alias,
+			Err(e) => {
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"Failed to parse room ID {room}. Please note that this requires a full room ID \
+					 (`!awIh6gGInaS5wLQJwa:example.com`) or a room alias (`#roomalias:example.com`): {e}"
+				)))
+			},
+		};
+
+		debug!(
+			"Room specified is not a room ID, attempting to resolve room alias to a room ID locally, if not using \
+			 get_alias_helper to fetch room ID remotely"
+		);
+
+		let room_id = if let Some(room_id) = services().rooms.alias.resolve_local_alias(&room_alias)? {
+			room_id
+		} else {
+			debug!("We don't have this room alias to a room ID locally, attempting to fetch room ID over federation");
+
+			match services()
+				.rooms
+				.alias
+				.resolve_alias(&room_alias, None)
+				.await
+			{
+				Ok((room_id, servers)) => {
+					debug!(?room_id, ?servers, "Got federation response fetching room ID for {room}");
+					room_id
+				},
+				Err(e) => {
+					return Ok(RoomMessageEventContent::notice_plain(format!(
+						"Failed to resolve room alias {room} to a room ID: {e}"
+					)));
+				},
+			}
+		};
+
+		services().rooms.metadata.ban_room(&room_id, true)?;
+
+		room_id
+	} else {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Room specified is not a room ID or room alias. Please note that this requires a full room ID \
+			 (`!awIh6gGInaS5wLQJwa:example.com`) or a room alias (`#roomalias:example.com`)",
+		));
+	};
+
+	debug!("Making all users leave the room {}", &room);
+	if force {
+		for local_user in services()
+			.rooms
+			.state_cache
+			.room_members(&room_id)
+			.filter_map(|user| {
+				user.ok().filter(|local_user| {
+					user_is_local(local_user)
+								// additional wrapped check here is to avoid adding remote users
+								// who are in the admin room to the list of local users (would
+								// fail auth check)
+								&& (user_is_local(local_user)
+									// since this is a force operation, assume user is an admin
+									// if somehow this fails
+									&& services()
+										.users
+										.is_admin(local_user)
+										.unwrap_or(true))
+				})
+			})
+			.collect::<Vec<OwnedUserId>>()
+		{
+			debug!(
+				"Attempting leave for user {} in room {} (forced, ignoring all errors, evicting admins too)",
+				&local_user, &room_id
+			);
+
+			if let Err(e) = leave_room(&local_user, &room_id, None).await {
+				warn!(%e, "Failed to leave room");
+			}
+		}
+	} else {
+		for local_user in services()
+			.rooms
+			.state_cache
+			.room_members(&room_id)
+			.filter_map(|user| {
+				user.ok().filter(|local_user| {
+					local_user.server_name() == services().globals.server_name()
+								// additional wrapped check here is to avoid adding remote users
+								// who are in the admin room to the list of local users (would fail auth check)
+								&& (local_user.server_name()
+									== services().globals.server_name()
+									&& !services()
+										.users
+										.is_admin(local_user)
+										.unwrap_or(false))
+				})
+			})
+			.collect::<Vec<OwnedUserId>>()
+		{
+			debug!("Attempting leave for user {} in room {}", &local_user, &room_id);
+			if let Err(e) = leave_room(&local_user, &room_id, None).await {
+				error!(
+					"Error attempting to make local user {} leave room {} during room banning: {}",
+					&local_user, &room_id, e
+				);
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"Error attempting to make local user {} leave room {} during room banning (room is still banned \
+					 but not removing any more users): {}\nIf you would like to ignore errors, use --force",
+					&local_user, &room_id, e
+				)));
+			}
+		}
+	}
+
+	if disable_federation {
+		services().rooms.metadata.disable_room(&room_id, true)?;
+		return Ok(RoomMessageEventContent::text_plain(
+			"Room banned, removed all our local users, and disabled incoming federation with room.",
+		));
+	}
+
+	Ok(RoomMessageEventContent::text_plain(
+		"Room banned and removed all our local users, use `!admin federation disable-room` to stop receiving new \
+		 inbound federation events as well if needed.",
+	))
+}
+
+async fn ban_list_of_rooms(body: Vec<&str>, force: bool, disable_federation: bool) -> Result<RoomMessageEventContent> {
+	if body.len() < 2 || !body[0].trim().starts_with("```") || body.last().unwrap_or(&"").trim() != "```" {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		));
+	}
+
+	let rooms_s = body.clone().drain(1..body.len() - 1).collect::<Vec<_>>();
+
+	let admin_room_alias = &services().globals.admin_alias;
+
+	let mut room_ban_count: usize = 0;
+	let mut room_ids: Vec<OwnedRoomId> = Vec::new();
+
+	for &room in &rooms_s {
+		match <&RoomOrAliasId>::try_from(room) {
+			Ok(room_alias_or_id) => {
+				if let Some(admin_room_id) = Service::get_admin_room()? {
+					if room.to_owned().eq(&admin_room_id) || room.to_owned().eq(admin_room_alias) {
+						info!("User specified admin room in bulk ban list, ignoring");
+						continue;
+					}
+				}
+
+				if room_alias_or_id.is_room_id() {
+					let room_id = match RoomId::parse(room_alias_or_id) {
+						Ok(room_id) => room_id,
+						Err(e) => {
+							if force {
+								// ignore rooms we failed to parse if we're force banning
+								warn!(
+									"Error parsing room \"{room}\" during bulk room banning, ignoring error and \
+									 logging here: {e}"
+								);
+								continue;
+							}
+
+							return Ok(RoomMessageEventContent::text_plain(format!(
+								"{room} is not a valid room ID or room alias, please fix the list and try again: {e}"
+							)));
+						},
+					};
+
+					room_ids.push(room_id);
+				}
+
+				if room_alias_or_id.is_room_alias_id() {
+					match RoomAliasId::parse(room_alias_or_id) {
+						Ok(room_alias) => {
+							let room_id =
+								if let Some(room_id) = services().rooms.alias.resolve_local_alias(&room_alias)? {
+									room_id
+								} else {
+									debug!(
+										"We don't have this room alias to a room ID locally, attempting to fetch room \
+										 ID over federation"
+									);
+
+									match services()
+										.rooms
+										.alias
+										.resolve_alias(&room_alias, None)
+										.await
+									{
+										Ok((room_id, servers)) => {
+											debug!(
+												?room_id,
+												?servers,
+												"Got federation response fetching room ID for {room}",
+											);
+											room_id
+										},
+										Err(e) => {
+											// don't fail if force blocking
+											if force {
+												warn!("Failed to resolve room alias {room} to a room ID: {e}");
+												continue;
+											}
+
+											return Ok(RoomMessageEventContent::text_plain(format!(
+												"Failed to resolve room alias {room} to a room ID: {e}"
+											)));
+										},
+									}
+								};
+
+							room_ids.push(room_id);
+						},
+						Err(e) => {
+							if force {
+								// ignore rooms we failed to parse if we're force deleting
+								error!(
+									"Error parsing room \"{room}\" during bulk room banning, ignoring error and \
+									 logging here: {e}"
+								);
+								continue;
+							}
+
+							return Ok(RoomMessageEventContent::text_plain(format!(
+								"{room} is not a valid room ID or room alias, please fix the list and try again: {e}"
+							)));
+						},
+					}
+				}
+			},
+			Err(e) => {
+				if force {
+					// ignore rooms we failed to parse if we're force deleting
+					error!(
+						"Error parsing room \"{room}\" during bulk room banning, ignoring error and logging here: {e}"
+					);
+					continue;
+				}
+
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"{room} is not a valid room ID or room alias, please fix the list and try again: {e}"
+				)));
+			},
+		}
+	}
+
+	for room_id in room_ids {
+		if services().rooms.metadata.ban_room(&room_id, true).is_ok() {
+			debug!("Banned {room_id} successfully");
+			room_ban_count = room_ban_count.saturating_add(1);
+		}
+
+		debug!("Making all users leave the room {}", &room_id);
+		if force {
+			for local_user in services()
+				.rooms
+				.state_cache
+				.room_members(&room_id)
+				.filter_map(|user| {
+					user.ok().filter(|local_user| {
+						local_user.server_name() == services().globals.server_name()
+										// additional wrapped check here is to avoid adding remote
+										// users who are in the admin room to the list of local
+										// users (would fail auth check)
+										&& (local_user.server_name()
+											== services().globals.server_name()
+											// since this is a force operation, assume user is an
+											// admin if somehow this fails
+											&& services()
+												.users
+												.is_admin(local_user)
+												.unwrap_or(true))
+					})
+				})
+				.collect::<Vec<OwnedUserId>>()
+			{
+				debug!(
+					"Attempting leave for user {} in room {} (forced, ignoring all errors, evicting admins too)",
+					&local_user, room_id
+				);
+				if let Err(e) = leave_room(&local_user, &room_id, None).await {
+					warn!(%e, "Failed to leave room");
+				}
+			}
+		} else {
+			for local_user in services()
+				.rooms
+				.state_cache
+				.room_members(&room_id)
+				.filter_map(|user| {
+					user.ok().filter(|local_user| {
+						local_user.server_name() == services().globals.server_name()
+										// additional wrapped check here is to avoid adding remote
+										// users who are in the admin room to the list of local
+										// users (would fail auth check)
+										&& (local_user.server_name()
+											== services().globals.server_name()
+											&& !services()
+												.users
+												.is_admin(local_user)
+												.unwrap_or(false))
+					})
+				})
+				.collect::<Vec<OwnedUserId>>()
+			{
+				debug!("Attempting leave for user {} in room {}", &local_user, &room_id);
+				if let Err(e) = leave_room(&local_user, &room_id, None).await {
+					error!(
+						"Error attempting to make local user {} leave room {} during bulk room banning: {}",
+						&local_user, &room_id, e
+					);
+					return Ok(RoomMessageEventContent::text_plain(format!(
+						"Error attempting to make local user {} leave room {} during room banning (room is still \
+						 banned but not removing any more users and not banning any more rooms): {}\nIf you would \
+						 like to ignore errors, use --force",
+						&local_user, &room_id, e
+					)));
+				}
+			}
+		}
+
+		if disable_federation {
+			services().rooms.metadata.disable_room(&room_id, true)?;
+		}
+	}
+
+	if disable_federation {
+		Ok(RoomMessageEventContent::text_plain(format!(
+			"Finished bulk room ban, banned {room_ban_count} total rooms, evicted all users, and disabled incoming \
+			 federation with the room."
+		)))
+	} else {
+		Ok(RoomMessageEventContent::text_plain(format!(
+			"Finished bulk room ban, banned {room_ban_count} total rooms and evicted all users."
+		)))
+	}
+}
+
+async fn unban_room(
+	_body: Vec<&str>, room: Box<RoomOrAliasId>, enable_federation: bool,
+) -> Result<RoomMessageEventContent> {
+	let room_id = if room.is_room_id() {
+		let room_id = match RoomId::parse(&room) {
+			Ok(room_id) => room_id,
+			Err(e) => {
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"Failed to parse room ID {room}. Please note that this requires a full room ID \
+					 (`!awIh6gGInaS5wLQJwa:example.com`) or a room alias (`#roomalias:example.com`): {e}"
+				)))
+			},
+		};
+
+		debug!("Room specified is a room ID, unbanning room ID");
+
+		services().rooms.metadata.ban_room(&room_id, false)?;
+
+		room_id
+	} else if room.is_room_alias_id() {
+		let room_alias = match RoomAliasId::parse(&room) {
+			Ok(room_alias) => room_alias,
+			Err(e) => {
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"Failed to parse room ID {room}. Please note that this requires a full room ID \
+					 (`!awIh6gGInaS5wLQJwa:example.com`) or a room alias (`#roomalias:example.com`): {e}"
+				)))
+			},
+		};
+
+		debug!(
+			"Room specified is not a room ID, attempting to resolve room alias to a room ID locally, if not using \
+			 get_alias_helper to fetch room ID remotely"
+		);
+
+		let room_id = if let Some(room_id) = services().rooms.alias.resolve_local_alias(&room_alias)? {
+			room_id
+		} else {
+			debug!("We don't have this room alias to a room ID locally, attempting to fetch room ID over federation");
+
+			match services()
+				.rooms
+				.alias
+				.resolve_alias(&room_alias, None)
+				.await
+			{
+				Ok((room_id, servers)) => {
+					debug!(?room_id, ?servers, "Got federation response fetching room ID for room {room}");
+					room_id
+				},
+				Err(e) => {
+					return Ok(RoomMessageEventContent::text_plain(format!(
+						"Failed to resolve room alias {room} to a room ID: {e}"
+					)));
+				},
+			}
+		};
+
+		services().rooms.metadata.ban_room(&room_id, false)?;
+
+		room_id
+	} else {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Room specified is not a room ID or room alias. Please note that this requires a full room ID \
+			 (`!awIh6gGInaS5wLQJwa:example.com`) or a room alias (`#roomalias:example.com`)",
+		));
+	};
+
+	if enable_federation {
+		services().rooms.metadata.disable_room(&room_id, false)?;
+		return Ok(RoomMessageEventContent::text_plain("Room unbanned."));
+	}
+
+	Ok(RoomMessageEventContent::text_plain(
+		"Room unbanned, you may need to re-enable federation with the room using enable-room if this is a remote room \
+		 to make it fully functional.",
+	))
+}
+
+async fn list_banned_rooms(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	let rooms = services()
+		.rooms
+		.metadata
+		.list_banned_rooms()
+		.collect::<Result<Vec<_>, _>>();
+
+	match rooms {
+		Ok(room_ids) => {
+			if room_ids.is_empty() {
+				return Ok(RoomMessageEventContent::text_plain("No rooms are banned."));
+			}
+
+			let mut rooms = room_ids
+				.into_iter()
+				.map(|room_id| get_room_info(&room_id))
+				.collect::<Vec<_>>();
+			rooms.sort_by_key(|r| r.1);
+			rooms.reverse();
+
+			let output_plain = format!(
+				"Rooms Banned ({}):\n```\n{}```",
+				rooms.len(),
+				rooms
+					.iter()
+					.map(|(id, members, name)| format!("{id}\tMembers: {members}\tName: {name}"))
+					.collect::<Vec<_>>()
+					.join("\n")
+			);
+
+			Ok(RoomMessageEventContent::notice_markdown(output_plain))
+		},
+		Err(e) => {
+			error!("Failed to list banned rooms: {}", e);
+			Ok(RoomMessageEventContent::text_plain(format!("Unable to list banned rooms: {e}")))
+		},
+	}
+}

src/admin/server/commands.rs

@@ -0,0 +1,120 @@
+use conduit::{warn, Error, Result};
+use ruma::events::room::message::RoomMessageEventContent;
+
+use crate::services;
+
+pub(super) async fn uptime(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	let seconds = services()
+		.server
+		.started
+		.elapsed()
+		.expect("standard duration")
+		.as_secs();
+	let result = format!(
+		"up {} days, {} hours, {} minutes, {} seconds.",
+		seconds / 86400,
+		(seconds % 86400) / 60 / 60,
+		(seconds % 3600) / 60,
+		seconds % 60,
+	);
+
+	Ok(RoomMessageEventContent::notice_plain(result))
+}
+
+pub(super) async fn show_config(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	// Construct and send the response
+	Ok(RoomMessageEventContent::text_plain(format!("{}", services().globals.config)))
+}
+
+pub(super) async fn memory_usage(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	let response0 = services().memory_usage().await?;
+	let response1 = services().db.db.memory_usage()?;
+	let response2 = conduit::alloc::memory_usage();
+
+	Ok(RoomMessageEventContent::text_plain(format!(
+		"Services:\n{response0}\nDatabase:\n{response1}\n{}",
+		if !response2.is_empty() {
+			format!("Allocator:\n {response2}")
+		} else {
+			String::new()
+		}
+	)))
+}
+
+pub(super) async fn clear_caches(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	services().clear_cache().await;
+
+	Ok(RoomMessageEventContent::text_plain("Done."))
+}
+
+pub(super) async fn list_backups(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	let result = services().globals.db.backup_list()?;
+
+	if result.is_empty() {
+		Ok(RoomMessageEventContent::text_plain("No backups found."))
+	} else {
+		Ok(RoomMessageEventContent::text_plain(result))
+	}
+}
+
+pub(super) async fn backup_database(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	let mut result = services()
+		.server
+		.runtime()
+		.spawn_blocking(move || match services().globals.db.backup() {
+			Ok(()) => String::new(),
+			Err(e) => (*e).to_string(),
+		})
+		.await
+		.unwrap();
+
+	if result.is_empty() {
+		result = services().globals.db.backup_list()?;
+	}
+
+	Ok(RoomMessageEventContent::text_plain(&result))
+}
+
+pub(super) async fn list_database_files(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	let result = services().globals.db.file_list()?;
+
+	Ok(RoomMessageEventContent::notice_markdown(result))
+}
+
+pub(super) async fn admin_notice(_body: Vec<&str>, message: Vec<String>) -> Result<RoomMessageEventContent> {
+	let message = message.join(" ");
+	services().admin.send_text(&message).await;
+
+	Ok(RoomMessageEventContent::notice_plain("Notice was sent to #admins"))
+}
+
+#[cfg(conduit_mods)]
+pub(super) async fn reload(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	services().server.reload()?;
+
+	Ok(RoomMessageEventContent::notice_plain("Reloading server..."))
+}
+
+#[cfg(unix)]
+pub(super) async fn restart(_body: Vec<&str>, force: bool) -> Result<RoomMessageEventContent> {
+	use conduit::utils::sys::current_exe_deleted;
+
+	if !force && current_exe_deleted() {
+		return Err(Error::Err(
+			"The server cannot be restarted because the executable was tampered with. If this is expected use --force \
+			 to override."
+				.to_owned(),
+		));
+	}
+
+	services().server.restart()?;
+
+	Ok(RoomMessageEventContent::notice_plain("Restarting server..."))
+}
+
+pub(super) async fn shutdown(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	warn!("shutdown command");
+	services().server.shutdown()?;
+
+	Ok(RoomMessageEventContent::notice_plain("Shutting down server..."))
+}

src/admin/server/mod.rs

@@ -1,17 +1,14 @@
-pub(crate) mod server_commands;
+mod commands;
 
 use clap::Subcommand;
+use conduit::Result;
 use ruma::events::room::message::RoomMessageEventContent;
 
-use self::server_commands::{
-	backup_database, clear_database_caches, clear_service_caches, list_backups, list_database_files, memory_usage,
-	show_config, uptime,
-};
-use crate::Result;
+use self::commands::*;
 
 #[cfg_attr(test, derive(Debug))]
 #[derive(Subcommand)]
-pub(crate) enum ServerCommand {
+pub(super) enum ServerCommand {
 	/// - Time elapsed since startup
 	Uptime,
 
@@ -21,17 +18,8 @@ pub(crate) enum ServerCommand {
 	/// - Print database memory usage statistics
 	MemoryUsage,
 
-	/// - Clears all of Conduit's database caches with index smaller than the
-	///   amount
-	ClearDatabaseCaches {
-		amount: u32,
-	},
-
-	/// - Clears all of Conduit's service caches with index smaller than the
-	///   amount
-	ClearServiceCaches {
-		amount: u32,
-	},
+	/// - Clears all of Conduwuit's caches
+	ClearCaches,
 
 	/// - Performs an online backup of the database (only available for RocksDB
 	///   at the moment)
@@ -42,21 +30,45 @@ pub(crate) enum ServerCommand {
 
 	/// - List database files
 	ListDatabaseFiles,
+
+	/// - Send a message to the admin room.
+	AdminNotice {
+		message: Vec<String>,
+	},
+
+	#[cfg(conduit_mods)]
+	/// - Hot-reload the server
+	Reload,
+
+	#[cfg(unix)]
+	/// - Restart the server
+	Restart {
+		#[arg(short, long)]
+		force: bool,
+	},
+
+	/// - Shutdown the server
+	Shutdown,
 }
 
-pub(crate) async fn process(command: ServerCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
+pub(super) async fn process(command: ServerCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
 	Ok(match command {
 		ServerCommand::Uptime => uptime(body).await?,
 		ServerCommand::ShowConfig => show_config(body).await?,
 		ServerCommand::MemoryUsage => memory_usage(body).await?,
-		ServerCommand::ClearDatabaseCaches {
-			amount,
-		} => clear_database_caches(body, amount).await?,
-		ServerCommand::ClearServiceCaches {
-			amount,
-		} => clear_service_caches(body, amount).await?,
+		ServerCommand::ClearCaches => clear_caches(body).await?,
 		ServerCommand::ListBackups => list_backups(body).await?,
 		ServerCommand::BackupDatabase => backup_database(body).await?,
 		ServerCommand::ListDatabaseFiles => list_database_files(body).await?,
+		ServerCommand::AdminNotice {
+			message,
+		} => admin_notice(body, message).await?,
+		#[cfg(conduit_mods)]
+		ServerCommand::Reload => reload(body).await?,
+		#[cfg(unix)]
+		ServerCommand::Restart {
+			force,
+		} => restart(body, force).await?,
+		ServerCommand::Shutdown => shutdown(body).await?,
 	})
 }

src/admin/user/commands.rs

@@ -0,0 +1,423 @@
+use std::{collections::BTreeMap, fmt::Write as _};
+
+use api::client::{join_room_by_id_helper, leave_all_rooms, update_avatar_url, update_displayname};
+use conduit::{utils, Result};
+use ruma::{
+	events::{
+		room::message::RoomMessageEventContent,
+		tag::{TagEvent, TagEventContent, TagInfo},
+		RoomAccountDataEventType,
+	},
+	OwnedRoomId, OwnedUserId, RoomId,
+};
+use tracing::{error, info, warn};
+
+use crate::{
+	escape_html, get_room_info, services,
+	utils::{parse_active_local_user_id, parse_local_user_id},
+};
+
+const AUTO_GEN_PASSWORD_LENGTH: usize = 25;
+
+pub(super) async fn list(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	match services().users.list_local_users() {
+		Ok(users) => {
+			let mut plain_msg = format!("Found {} local user account(s):\n```\n", users.len());
+			plain_msg += &users.join("\n");
+			plain_msg += "\n```";
+
+			Ok(RoomMessageEventContent::notice_markdown(plain_msg))
+		},
+		Err(e) => Ok(RoomMessageEventContent::text_plain(e.to_string())),
+	}
+}
+
+pub(super) async fn create(
+	_body: Vec<&str>, username: String, password: Option<String>,
+) -> Result<RoomMessageEventContent> {
+	// Validate user id
+	let user_id = parse_local_user_id(&username)?;
+
+	if services().users.exists(&user_id)? {
+		return Ok(RoomMessageEventContent::text_plain(format!("Userid {user_id} already exists")));
+	}
+
+	let password = password.unwrap_or_else(|| utils::random_string(AUTO_GEN_PASSWORD_LENGTH));
+
+	// Create user
+	services().users.create(&user_id, Some(password.as_str()))?;
+
+	// Default to pretty displayname
+	let mut displayname = user_id.localpart().to_owned();
+
+	// If `new_user_displayname_suffix` is set, registration will push whatever
+	// content is set to the user's display name with a space before it
+	if !services()
+		.globals
+		.config
+		.new_user_displayname_suffix
+		.is_empty()
+	{
+		write!(displayname, " {}", services().globals.config.new_user_displayname_suffix)
+			.expect("should be able to write to string buffer");
+	}
+
+	services()
+		.users
+		.set_displayname(&user_id, Some(displayname))
+		.await?;
+
+	// Initial account data
+	services().account_data.update(
+		None,
+		&user_id,
+		ruma::events::GlobalAccountDataEventType::PushRules
+			.to_string()
+			.into(),
+		&serde_json::to_value(ruma::events::push_rules::PushRulesEvent {
+			content: ruma::events::push_rules::PushRulesEventContent {
+				global: ruma::push::Ruleset::server_default(&user_id),
+			},
+		})
+		.expect("to json value always works"),
+	)?;
+
+	if !services().globals.config.auto_join_rooms.is_empty() {
+		for room in &services().globals.config.auto_join_rooms {
+			if !services()
+				.rooms
+				.state_cache
+				.server_in_room(services().globals.server_name(), room)?
+			{
+				warn!("Skipping room {room} to automatically join as we have never joined before.");
+				continue;
+			}
+
+			if let Some(room_id_server_name) = room.server_name() {
+				match join_room_by_id_helper(
+					Some(&user_id),
+					room,
+					Some("Automatically joining this room upon registration".to_owned()),
+					&[room_id_server_name.to_owned(), services().globals.server_name().to_owned()],
+					None,
+				)
+				.await
+				{
+					Ok(_response) => {
+						info!("Automatically joined room {room} for user {user_id}");
+					},
+					Err(e) => {
+						// don't return this error so we don't fail registrations
+						error!("Failed to automatically join room {room} for user {user_id}: {e}");
+					},
+				};
+			}
+		}
+	}
+
+	// we dont add a device since we're not the user, just the creator
+
+	// Inhibit login does not work for guests
+	Ok(RoomMessageEventContent::text_plain(format!(
+		"Created user with user_id: {user_id} and password: `{password}`"
+	)))
+}
+
+pub(super) async fn deactivate(
+	_body: Vec<&str>, no_leave_rooms: bool, user_id: String,
+) -> Result<RoomMessageEventContent> {
+	// Validate user id
+	let user_id = parse_local_user_id(&user_id)?;
+
+	// don't deactivate the server service account
+	if user_id == services().globals.server_user {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Not allowed to deactivate the server service account.",
+		));
+	}
+
+	services().users.deactivate_account(&user_id)?;
+
+	if !no_leave_rooms {
+		services()
+			.admin
+			.send_message(RoomMessageEventContent::text_plain(format!(
+				"Making {user_id} leave all rooms after deactivation..."
+			)))
+			.await;
+
+		let all_joined_rooms: Vec<OwnedRoomId> = services()
+			.rooms
+			.state_cache
+			.rooms_joined(&user_id)
+			.filter_map(Result::ok)
+			.collect();
+		update_displayname(user_id.clone(), None, all_joined_rooms.clone()).await?;
+		update_avatar_url(user_id.clone(), None, None, all_joined_rooms).await?;
+		leave_all_rooms(&user_id).await;
+	}
+
+	Ok(RoomMessageEventContent::text_plain(format!(
+		"User {user_id} has been deactivated"
+	)))
+}
+
+pub(super) async fn reset_password(_body: Vec<&str>, username: String) -> Result<RoomMessageEventContent> {
+	let user_id = parse_local_user_id(&username)?;
+
+	if user_id == services().globals.server_user {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Not allowed to set the password for the server account. Please use the emergency password config option.",
+		));
+	}
+
+	let new_password = utils::random_string(AUTO_GEN_PASSWORD_LENGTH);
+
+	match services()
+		.users
+		.set_password(&user_id, Some(new_password.as_str()))
+	{
+		Ok(()) => Ok(RoomMessageEventContent::text_plain(format!(
+			"Successfully reset the password for user {user_id}: `{new_password}`"
+		))),
+		Err(e) => Ok(RoomMessageEventContent::text_plain(format!(
+			"Couldn't reset the password for user {user_id}: {e}"
+		))),
+	}
+}
+
+pub(super) async fn deactivate_all(
+	body: Vec<&str>, no_leave_rooms: bool, force: bool,
+) -> Result<RoomMessageEventContent> {
+	if body.len() < 2 || !body[0].trim().starts_with("```") || body.last().unwrap_or(&"").trim() != "```" {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		));
+	}
+
+	let usernames = body.clone().drain(1..body.len() - 1).collect::<Vec<_>>();
+
+	let mut user_ids: Vec<OwnedUserId> = Vec::with_capacity(usernames.len());
+	let mut admins = Vec::new();
+
+	for username in usernames {
+		match parse_active_local_user_id(username) {
+			Ok(user_id) => {
+				if services().users.is_admin(&user_id)? && !force {
+					services()
+						.admin
+						.send_message(RoomMessageEventContent::text_plain(format!(
+							"{username} is an admin and --force is not set, skipping over"
+						)))
+						.await;
+					admins.push(username);
+					continue;
+				}
+
+				// don't deactivate the server service account
+				if user_id == services().globals.server_user {
+					services()
+						.admin
+						.send_message(RoomMessageEventContent::text_plain(format!(
+							"{username} is the server service account, skipping over"
+						)))
+						.await;
+					continue;
+				}
+
+				user_ids.push(user_id);
+			},
+			Err(e) => {
+				services()
+					.admin
+					.send_message(RoomMessageEventContent::text_plain(format!(
+						"{username} is not a valid username, skipping over: {e}"
+					)))
+					.await;
+				continue;
+			},
+		}
+	}
+
+	let mut deactivation_count: usize = 0;
+
+	for user_id in user_ids {
+		match services().users.deactivate_account(&user_id) {
+			Ok(()) => {
+				deactivation_count = deactivation_count.saturating_add(1);
+				if !no_leave_rooms {
+					info!("Forcing user {user_id} to leave all rooms apart of deactivate-all");
+					let all_joined_rooms: Vec<OwnedRoomId> = services()
+						.rooms
+						.state_cache
+						.rooms_joined(&user_id)
+						.filter_map(Result::ok)
+						.collect();
+					update_displayname(user_id.clone(), None, all_joined_rooms.clone()).await?;
+					update_avatar_url(user_id.clone(), None, None, all_joined_rooms).await?;
+					leave_all_rooms(&user_id).await;
+				}
+			},
+			Err(e) => {
+				services()
+					.admin
+					.send_message(RoomMessageEventContent::text_plain(format!("Failed deactivating user: {e}")))
+					.await;
+			},
+		}
+	}
+
+	if admins.is_empty() {
+		Ok(RoomMessageEventContent::text_plain(format!(
+			"Deactivated {deactivation_count} accounts."
+		)))
+	} else {
+		Ok(RoomMessageEventContent::text_plain(format!(
+			"Deactivated {deactivation_count} accounts.\nSkipped admin accounts: {}. Use --force to deactivate admin \
+			 accounts",
+			admins.join(", ")
+		)))
+	}
+}
+
+pub(super) async fn list_joined_rooms(_body: Vec<&str>, user_id: String) -> Result<RoomMessageEventContent> {
+	// Validate user id
+	let user_id = parse_local_user_id(&user_id)?;
+
+	let mut rooms: Vec<(OwnedRoomId, u64, String)> = services()
+		.rooms
+		.state_cache
+		.rooms_joined(&user_id)
+		.filter_map(Result::ok)
+		.map(|room_id| get_room_info(&room_id))
+		.collect();
+
+	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_plain = format!(
+		"Rooms {user_id} Joined ({}):\n{}",
+		rooms.len(),
+		rooms
+			.iter()
+			.map(|(id, members, name)| format!("{id}\tMembers: {members}\tName: {name}"))
+			.collect::<Vec<_>>()
+			.join("\n")
+	);
+
+	let output_html = format!(
+		"<table><caption>Rooms {user_id} Joined \
+		 ({})</caption>\n<tr><th>id</th>\t<th>members</th>\t<th>name</th></tr>\n{}</table>",
+		rooms.len(),
+		rooms
+			.iter()
+			.fold(String::new(), |mut output, (id, members, name)| {
+				writeln!(
+					output,
+					"<tr><td>{}</td>\t<td>{}</td>\t<td>{}</td></tr>",
+					escape_html(id.as_ref()),
+					members,
+					escape_html(name)
+				)
+				.unwrap();
+				output
+			})
+	);
+
+	Ok(RoomMessageEventContent::text_html(output_plain, output_html))
+}
+
+pub(super) async fn put_room_tag(
+	_body: Vec<&str>, user_id: String, room_id: Box<RoomId>, tag: String,
+) -> Result<RoomMessageEventContent> {
+	let user_id = parse_active_local_user_id(&user_id)?;
+
+	let event = services()
+		.account_data
+		.get(Some(&room_id), &user_id, RoomAccountDataEventType::Tag)?;
+
+	let mut tags_event = event.map_or_else(
+		|| TagEvent {
+			content: TagEventContent {
+				tags: BTreeMap::new(),
+			},
+		},
+		|e| serde_json::from_str(e.get()).expect("Bad account data in database for user {user_id}"),
+	);
+
+	tags_event
+		.content
+		.tags
+		.insert(tag.clone().into(), TagInfo::new());
+
+	services().account_data.update(
+		Some(&room_id),
+		&user_id,
+		RoomAccountDataEventType::Tag,
+		&serde_json::to_value(tags_event).expect("to json value always works"),
+	)?;
+
+	Ok(RoomMessageEventContent::text_plain(format!(
+		"Successfully updated room account data for {user_id} and room {room_id} with tag {tag}"
+	)))
+}
+
+pub(super) async fn delete_room_tag(
+	_body: Vec<&str>, user_id: String, room_id: Box<RoomId>, tag: String,
+) -> Result<RoomMessageEventContent> {
+	let user_id = parse_active_local_user_id(&user_id)?;
+
+	let event = services()
+		.account_data
+		.get(Some(&room_id), &user_id, RoomAccountDataEventType::Tag)?;
+
+	let mut tags_event = event.map_or_else(
+		|| TagEvent {
+			content: TagEventContent {
+				tags: BTreeMap::new(),
+			},
+		},
+		|e| serde_json::from_str(e.get()).expect("Bad account data in database for user {user_id}"),
+	);
+
+	tags_event.content.tags.remove(&tag.clone().into());
+
+	services().account_data.update(
+		Some(&room_id),
+		&user_id,
+		RoomAccountDataEventType::Tag,
+		&serde_json::to_value(tags_event).expect("to json value always works"),
+	)?;
+
+	Ok(RoomMessageEventContent::text_plain(format!(
+		"Successfully updated room account data for {user_id} and room {room_id}, deleting room tag {tag}"
+	)))
+}
+
+pub(super) async fn get_room_tags(
+	_body: Vec<&str>, user_id: String, room_id: Box<RoomId>,
+) -> Result<RoomMessageEventContent> {
+	let user_id = parse_active_local_user_id(&user_id)?;
+
+	let event = services()
+		.account_data
+		.get(Some(&room_id), &user_id, RoomAccountDataEventType::Tag)?;
+
+	let tags_event = event.map_or_else(
+		|| TagEvent {
+			content: TagEventContent {
+				tags: BTreeMap::new(),
+			},
+		},
+		|e| serde_json::from_str(e.get()).expect("Bad account data in database for user {user_id}"),
+	);
+
+	Ok(RoomMessageEventContent::notice_markdown(format!(
+		"```\n{:#?}\n```",
+		tags_event.content.tags
+	)))
+}

src/admin/user/mod.rs

@@ -0,0 +1,131 @@
+mod commands;
+
+use clap::Subcommand;
+use conduit::Result;
+use ruma::{events::room::message::RoomMessageEventContent, RoomId};
+
+use self::commands::*;
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+pub(super) enum UserCommand {
+	/// - Create a new user
+	Create {
+		/// Username of the new user
+		username: String,
+		/// Password of the new user, if unspecified one is generated
+		password: Option<String>,
+	},
+
+	/// - Reset user password
+	ResetPassword {
+		/// Username of the user for whom the password should be reset
+		username: String,
+	},
+
+	/// - Deactivate a user
+	///
+	/// User will be removed from all rooms by default.
+	/// Use --no-leave-rooms to not leave all rooms by default.
+	Deactivate {
+		#[arg(short, long)]
+		no_leave_rooms: bool,
+		user_id: String,
+	},
+
+	/// - Deactivate a list of users
+	///
+	/// Recommended to use in conjunction with list-local-users.
+	///
+	/// Users will be removed from joined rooms by default.
+	///
+	/// Can be overridden with --no-leave-rooms.
+	///
+	/// Removing a mass amount of users from a room may cause a significant
+	/// amount of leave events. The time to leave rooms may depend significantly
+	/// on joined rooms and servers.
+	///
+	/// This command needs a newline separated list of users provided in a
+	/// Markdown code block below the command.
+	DeactivateAll {
+		#[arg(short, long)]
+		/// Remove users from their joined rooms
+		no_leave_rooms: bool,
+		#[arg(short, long)]
+		/// Also deactivate admin accounts and will assume leave all rooms too
+		force: bool,
+	},
+
+	/// - List local users in the database
+	List,
+
+	/// - Lists all the rooms (local and remote) that the specified user is
+	///   joined in
+	ListJoinedRooms {
+		user_id: String,
+	},
+
+	/// - Puts a room tag for the specified user and room ID.
+	///
+	/// This is primarily useful if you'd like to set your admin room
+	/// to the special "System Alerts" section in Element as a way to
+	/// permanently see your admin room without it being buried away in your
+	/// favourites or rooms. To do this, you would pass your user, your admin
+	/// room's internal ID, and the tag name `m.server_notice`.
+	PutRoomTag {
+		user_id: String,
+		room_id: Box<RoomId>,
+		tag: String,
+	},
+
+	/// - Deletes the room tag for the specified user and room ID
+	DeleteRoomTag {
+		user_id: String,
+		room_id: Box<RoomId>,
+		tag: String,
+	},
+
+	/// - Gets all the room tags for the specified user and room ID
+	GetRoomTags {
+		user_id: String,
+		room_id: Box<RoomId>,
+	},
+}
+
+pub(super) async fn process(command: UserCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	Ok(match command {
+		UserCommand::List => list(body).await?,
+		UserCommand::Create {
+			username,
+			password,
+		} => create(body, username, password).await?,
+		UserCommand::Deactivate {
+			no_leave_rooms,
+			user_id,
+		} => deactivate(body, no_leave_rooms, user_id).await?,
+		UserCommand::ResetPassword {
+			username,
+		} => reset_password(body, username).await?,
+		UserCommand::DeactivateAll {
+			no_leave_rooms,
+			force,
+		} => deactivate_all(body, no_leave_rooms, force).await?,
+		UserCommand::ListJoinedRooms {
+			user_id,
+		} => list_joined_rooms(body, user_id).await?,
+		UserCommand::PutRoomTag {
+			user_id,
+			room_id,
+			tag,
+		} => put_room_tag(body, user_id, room_id, tag).await?,
+		UserCommand::DeleteRoomTag {
+			user_id,
+			room_id,
+			tag,
+		} => delete_room_tag(body, user_id, room_id, tag).await?,
+		UserCommand::GetRoomTags {
+			user_id,
+			room_id,
+		} => get_room_tags(body, user_id, room_id).await?,
+	})
+}

src/admin/utils.rs

@@ -0,0 +1,63 @@
+use conduit_core::Error;
+use ruma::{OwnedRoomId, OwnedUserId, RoomId, UserId};
+use service::user_is_local;
+
+use crate::{services, Result};
+
+pub(crate) fn escape_html(s: &str) -> String {
+	s.replace('&', "&")
+		.replace('<', "&lt;")
+		.replace('>', "&gt;")
+}
+
+pub(crate) fn get_room_info(id: &RoomId) -> (OwnedRoomId, u64, String) {
+	(
+		id.into(),
+		services()
+			.rooms
+			.state_cache
+			.room_joined_count(id)
+			.ok()
+			.flatten()
+			.unwrap_or(0),
+		services()
+			.rooms
+			.state_accessor
+			.get_name(id)
+			.ok()
+			.flatten()
+			.unwrap_or_else(|| id.to_string()),
+	)
+}
+
+/// Parses user ID
+pub(crate) fn parse_user_id(user_id: &str) -> Result<OwnedUserId> {
+	UserId::parse_with_server_name(user_id.to_lowercase(), services().globals.server_name())
+		.map_err(|e| Error::Err(format!("The supplied username is not a valid username: {e}")))
+}
+
+/// Parses user ID as our local user
+pub(crate) fn parse_local_user_id(user_id: &str) -> Result<OwnedUserId> {
+	let user_id = parse_user_id(user_id)?;
+
+	if !user_is_local(&user_id) {
+		return Err(Error::Err(String::from("User does not belong to our server.")));
+	}
+
+	Ok(user_id)
+}
+
+/// Parses user ID that is an active (not guest or deactivated) local user
+pub(crate) fn parse_active_local_user_id(user_id: &str) -> Result<OwnedUserId> {
+	let user_id = parse_local_user_id(user_id)?;
+
+	if !services().users.exists(&user_id)? {
+		return Err(Error::Err(String::from("User does not exist on this server.")));
+	}
+
+	if services().users.is_deactivated(&user_id)? {
+		return Err(Error::Err(String::from("User is deactivated.")));
+	}
+
+	Ok(user_id)
+}

src/alloc/default.rs

@@ -1,7 +0,0 @@
-//! Default allocator with no special features
-
-/// Always returns the empty string
-pub(crate) fn memory_stats() -> String { Default::default() }
-
-/// Always returns the empty string
-pub(crate) fn memory_usage() -> String { Default::default() }

src/alloc/hardened.rs

@@ -1,8 +0,0 @@
-#[global_allocator]
-static HMALLOC: hardened_malloc_rs::HardenedMalloc = hardened_malloc_rs::HardenedMalloc;
-
-pub(crate) fn memory_usage() -> String {
-	String::default() //TODO: get usage
-}
-
-pub(crate) fn memory_stats() -> String { "Extended statistics are not available from hardened_malloc.".to_owned() }

src/alloc/mod.rs

@@ -1,25 +0,0 @@
-//! Integration with allocators
-
-// jemalloc
-#[cfg(all(not(target_env = "msvc"), feature = "jemalloc", not(feature = "hardened_malloc")))]
-mod je;
-#[cfg(all(not(target_env = "msvc"), feature = "jemalloc", not(feature = "hardened_malloc")))]
-pub(crate) use je::{memory_stats, memory_usage};
-
-// hardened_malloc
-#[cfg(all(not(target_env = "msvc"), feature = "hardened_malloc", target_os = "linux", not(feature = "jemalloc")))]
-mod hardened;
-#[cfg(all(not(target_env = "msvc"), feature = "hardened_malloc", target_os = "linux", not(feature = "jemalloc")))]
-pub(crate) use hardened::{memory_stats, memory_usage};
-
-// default, enabled when none or multiple of the above are enabled
-#[cfg(any(
-	not(any(feature = "jemalloc", feature = "hardened_malloc")),
-	all(feature = "jemalloc", feature = "hardened_malloc"),
-))]
-mod default;
-#[cfg(any(
-	not(any(feature = "jemalloc", feature = "hardened_malloc")),
-	all(feature = "jemalloc", feature = "hardened_malloc"),
-))]
-pub(crate) use default::{memory_stats, memory_usage};