Bump 0.4.1

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

.dockerignore

@@ -4,7 +4,6 @@ tests
 
 # Docker files
 Dockerfile*
-docker-compose*
 
 # IDE files
 .vscode

.envrc

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

.github/workflows/ci.yml

@@ -1,266 +1,356 @@
 name: CI and Artifacts
 
 on:
-  pull_request:
-  push:
-    branches:
-      - main
-      - dev
+    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:
 
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
+concurrency:
+    group: ${{ github.head_ref || github.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 }}
-  # 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 }}
+    # Required to make some things output color
+    TERM: ansi
+    # Publishing to my nix binary cache
+    ATTIC_TOKEN: ${{ secrets.ATTIC_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 }}
+    # Use the all-features devshell instead of default, to ensure that features
+    # match between nix and cargo
+    DIRENV_DEVSHELL: all-features
+    # Get error output from nix that we can actually use
+    NIX_CONFIG: show-trace = true
 
 permissions:
-  packages: write
-  contents: read
+    packages: write
+    contents: read
 
 jobs:
-  setup:
-    name: CI Setup
-    runs-on: ubuntu-latest
-    steps:
-      - name: Sync repository
-        uses: actions/checkout@v4
+    tests:
+        name: Test
+        runs-on: ubuntu-latest
+        steps:
+            - name: Sync repository
+              uses: actions/checkout@v4
 
-      - name: Install Nix (with flakes and nix-command enabled)
-        uses: cachix/install-nix-action@v26
-        with:
-          nix_path: nixpkgs=channel:nixos-unstable
+            - 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`)
 
-          # 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://nix.computer.surgery/conduit
-            extra-trusted-public-keys = conduit:ZGAf6P6LhNvnoJJ3Me3PRg7tlLSrPxcQ2RiE5LIppjo=
-            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=
+                  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
 
-      - name: Add 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
+            - name: Install Nix
+              uses: DeterminateSystems/nix-installer-action@main
 
-      - name: Pop/push Magic Nix Cache
-        uses: DeterminateSystems/magic-nix-cache-action@main
+            - name: Enable Cachix binary cache
+              run: |
+                  nix profile install nixpkgs#cachix
+                  cachix use crane
+                  cachix use nix-community
 
-      - name: Configure `nix-direnv`
-        run: |
-          echo 'source $HOME/.nix-profile/share/nix-direnv/direnvrc' > "$HOME/.direnvrc"
+            - name: Configure Magic Nix Cache
+              uses: DeterminateSystems/magic-nix-cache-action@main
 
-      - name: Install `direnv` and `nix-direnv`
-        run: nix-env -f "<nixpkgs>" -iA direnv -iA nix-direnv
+            - 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
+                  extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk= conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o=
+                  EOF
 
-      - name: Pop/push downloaded crate cache
-        uses: actions/cache@v4
-        with:
-          key: downloaded-crates
-          path: ~/.cargo
+            - 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: Pop/push compiled crate cache
-        uses: actions/cache@v4
-        with:
-          key: compiled-crates-${{runner.os}}
-          path: target
+            - 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
 
-      # Do this to shorten the logs for the real CI step
-      - name: Populate `/nix/store`
-        run: nix develop --command true
+            - name: Cache CI dependencies
+              run: |
+                  bin/nix-build-and-cache ci
 
-      - name: Allow direnv
-        run: direnv allow
+            - name: Run CI tests
+              run: |
+                  direnv exec . engage > >(tee -a test_output.log)
 
-      - name: Cache x86_64 inputs for devShell
-        run: |
-          ./bin/nix-build-and-cache .#devShells.x86_64-linux.default.inputDerivation
+            - name: Sync Complement repository
+              uses: 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
 
-  build-and-test:
-    name: CI and Artifacts
-    needs: setup
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        target: [
-          "static-x86_64-unknown-linux-musl",
-          "static-x86_64-unknown-linux-musl-jemalloc",
-          "static-x86_64-unknown-linux-musl-hmalloc",
-          "static-aarch64-unknown-linux-musl",
-          "static-aarch64-unknown-linux-musl-jemalloc",
-          "static-aarch64-unknown-linux-musl-hmalloc",
-          ]
-        oci-target: [
-          "x86_64-unknown-linux-gnu",
-          "x86_64-unknown-linux-musl",
-          "x86_64-unknown-linux-musl-jemalloc",
-          "x86_64-unknown-linux-musl-hmalloc",
-          "aarch64-unknown-linux-musl",
-          "aarch64-unknown-linux-musl-jemalloc",
-          "aarch64-unknown-linux-musl-hmalloc",
-          ]
+            - 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
 
-    steps:
-      - name: Perform continuous integration
-        run: direnv exec . engage
+            - name: Upload Complement logs
+              uses: 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: actions/upload-artifact@v4
+              with:
+                name: complement_test_results.jsonl
+                path: complement_test_results.jsonl
+                if-no-files-found: error
 
-      - name: Build static artifacts
-        run: |
-          ./bin/nix-build-and-cache .#${{ matrix.target }}
-          mkdir -p target/release
-          cp -v -f result/bin/conduit target/release
-          direnv exec . cargo deb --no-build --output target/debian/${{ matrix.target }}.deb
+            - 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)
 
-      - name: Upload static artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: ${{ matrix.target }}
-          path: result/bin/conduit
-          if-no-files-found: error
+            - name: Add Complement diff result to Job Summary
+              run: |
+                  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: Upload static deb artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: ${{ matrix.target }}.deb
-          path: target/debian/${{ matrix.target }}.deb
-          if-no-files-found: error
+            - 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 20 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
+        if: github.event.pull_request.draft != true
+        strategy:
+            matrix:
+                include:
+                    - target: aarch64-unknown-linux-musl
+                    - target: x86_64-unknown-linux-musl
+        steps:
+            - name: Sync repository
+              uses: actions/checkout@v4
 
-      - name: Build OCI images
-        run: |
-          ./bin/nix-build-and-cache .#oci-image-${{ matrix.oci-target }}
-          cp -v -f result oci-image-${{ matrix.oci-target }}.tar.gz
+            - name: Install Nix
+              uses: DeterminateSystems/nix-installer-action@main
 
-      - name: Upload OCI image artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: oci-image-${{ matrix.oci-target }}
-          path: oci-image-${{ matrix.oci-target }}.tar.gz
-          if-no-files-found: error
-          # don't compress again
-          compression-level: 0
+            - 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: DeterminateSystems/magic-nix-cache-action@main
 
+            - name: Apply Nix binary cache configuration
+              run: |
+                  sudo tee -a /etc/nix/nix.conf > /dev/null <<EOF
+                  extra-substituters = https://attic.kennel.juneis.dog/conduit https://attic.kennel.juneis.dog/conduwuit https://cache.lix.systems
+                  extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk= conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o=
+                  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
 
-  publish:
-    needs: build-and-test
-    runs-on: ubuntu-latest
-    steps:
-    - name: Extract metadata for Dockerhub
-      env:
-        REGISTRY: registry.hub.docker.com
-        IMAGE_NAME: ${{ github.repository }}
-      id: meta-dockerhub
-      uses: docker/metadata-action@v5
-      with:
-        images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+            - 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: Extract metadata for GitHub Container Registry
-      env:
-        REGISTRY: ghcr.io
-        IMAGE_NAME: ${{ github.repository }}
-      id: meta-ghcr
-      uses: docker/metadata-action@v5
-      with:
-        images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+            - name: Build static ${{ matrix.target }}
+              run: |
+                  CARGO_DEB_TARGET_TUPLE=$(echo ${{ matrix.target }} | grep -o -E '^([^-]*-){3}[^-]*')
 
+                  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: Login to Dockerhub
-      env:
-        DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
-        DOCKER_USERNAME: ${{ vars.DOCKER_USERNAME }}
-      if: ${{ (github.event_name != 'pull_request') && (env.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
-      uses: docker/login-action@v3
-      with:
-        # username is not really a secret
-        username: ${{ vars.DOCKER_USERNAME }}
-        password: ${{ secrets.DOCKERHUB_TOKEN }}
+            - name: Upload static-${{ matrix.target }}
+              uses: actions/upload-artifact@v4
+              with:
+                  name: static-${{ matrix.target }}
+                  path: static-${{ matrix.target }}
+                  if-no-files-found: error
 
-    - name: Login to GitHub Container Registry
-      if: github.event_name != 'pull_request'
-      uses: docker/login-action@v3
-      env:
-        REGISTRY: ghcr.io
-      with:
-        registry: ${{ env.REGISTRY }}
-        username: ${{ github.repository_owner }}
-        password: ${{ secrets.GITHUB_TOKEN }}
+            - name: Upload deb ${{ matrix.target }}
+              uses: 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: Publish to Dockerhub
-      env:
-        DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
-        DOCKER_USERNAME: ${{ vars.DOCKER_USERNAME }}
-        IMAGE_NAME: docker.io/${{ github.repository }}
-        IMAGE_SUFFIX_AMD64: amd64
-        IMAGE_SUFFIX_ARM64V8: arm64v8
-      if: ${{ (github.event_name != 'pull_request') && (env.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
-      run: |
-        docker load -i oci-image-amd64.tar.gz
-        IMAGE_ID_AMD64=$(docker images -q conduit:main)
-        docker load -i oci-image-arm64v8.tar.gz
-        IMAGE_ID_ARM64V8=$(docker images -q conduit:main)
+            - name: Upload OCI image ${{ matrix.target }}
+              uses: 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
 
-        # Tag and push the architecture specific images
-        docker tag $IMAGE_ID_AMD64 $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_AMD64
-        docker tag $IMAGE_ID_ARM64V8 $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_ARM64V8
-        docker push $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_AMD64
-        docker push $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_ARM64V8
-        # Tag the multi-arch image
-        docker manifest create $IMAGE_NAME:$GITHUB_SHA --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_AMD64 --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_ARM64V8
-        docker manifest push $IMAGE_NAME:$GITHUB_SHA
-        # Tag and push the git ref
-        docker manifest create $IMAGE_NAME:$GITHUB_REF_NAME --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_AMD64 --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_ARM64V8
-        docker manifest push $IMAGE_NAME:$GITHUB_REF_NAME
-        # Tag "main" as latest (stable branch)
-        if [[ "$GITHUB_REF_NAME" = "main" ]]; then
-          docker manifest create $IMAGE_NAME:latest --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_AMD64 --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_ARM64V8
-          docker manifest push $IMAGE_NAME:latest
-        fi
+    docker:
+        name: Docker publish
+        runs-on: ubuntu-latest
+        needs: build
+        if: (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main' || (github.event.pull_request.draft != true)) && (vars.DOCKER_USERNAME != '') && (vars.GITLAB_USERNAME != '')
+        env:
+            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 }}
 
-    - name: Publish to GitHub Container Registry
-      if: github.event_name != 'pull_request'
-      env:
-        IMAGE_NAME: ghcr.io/${{ github.repository }}
-        IMAGE_SUFFIX_AMD64: amd64
-        IMAGE_SUFFIX_ARM64V8: arm64v8
-      run: |
-        docker load -i oci-image-amd64.tar.gz
-        IMAGE_ID_AMD64=$(docker images -q conduit:main)
-        docker load -i oci-image-arm64v8.tar.gz
-        IMAGE_ID_ARM64V8=$(docker images -q conduit:main)
+            DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
+            GITLAB_TOKEN: ${{ secrets.GITLAB_TOKEN }}
+        steps:
+            - name: Login to GitHub Container Registry
+              uses: docker/login-action@v3
+              with:
+                  registry: ghcr.io
+                  username: ${{ github.actor }}
+                  password: ${{ secrets.GITHUB_TOKEN }}
 
-        # Tag and push the architecture specific images
-        docker tag $IMAGE_ID_AMD64 $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_AMD64
-        docker tag $IMAGE_ID_ARM64V8 $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_ARM64V8
-        docker push $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_AMD64
-        docker push $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_ARM64V8
-        # Tag the multi-arch image
-        docker manifest create $IMAGE_NAME:$GITHUB_SHA --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_AMD64 --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_ARM64V8
-        docker manifest push $IMAGE_NAME:$GITHUB_SHA
-        # Tag and push the git ref
-        docker manifest create $IMAGE_NAME:$GITHUB_REF_NAME --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_AMD64 --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_ARM64V8
-        docker manifest push $IMAGE_NAME:$GITHUB_REF_NAME
-        # Tag "main" as latest (stable branch)
-        if [[ "$GITHUB_REF_NAME" = "main" ]]; then
-          docker manifest create $IMAGE_NAME:latest --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_AMD64 --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_ARM64V8
-          docker manifest push $IMAGE_NAME:latest
-        fi
+            - name: Login to Docker Hub
+              if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
+              uses: docker/login-action@v3
+              with:
+                  registry: docker.io
+                  username: ${{ vars.DOCKER_USERNAME }}
+                  password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+            - name: Login to GitLab Container Registry
+              if: ${{ (vars.GITLAB_USERNAME != '') && (env.GITLAB_TOKEN != '') }}
+              uses: docker/login-action@v3
+              with:
+                  registry: registry.gitlab.com
+                  username: ${{ vars.GITLAB_USERNAME }}
+                  password: ${{ secrets.GITLAB_TOKEN }}
+
+            - name: Download artifacts
+              uses: actions/download-artifact@v4
+
+            - name: Move OCI images into position
+              run: |
+                  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 != '') }}
+              run: |
+                  docker load -i oci-image-amd64.tar.gz
+                  docker tag $(docker images -q conduit:main) ${{ env.DOCKER_AMD64 }}
+                  docker tag $(docker images -q conduit:main) ${{ env.GHCR_AMD64 }}
+                  docker tag $(docker images -q conduit:main) ${{ env.GLCR_AMD64 }}
+                  docker push ${{ env.DOCKER_AMD64 }}
+                  docker push ${{ env.GHCR_AMD64 }}
+                  docker push ${{ env.GLCR_AMD64 }}
+
+            - name: Load and push arm64 image
+              if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
+              run: |
+                  docker load -i oci-image-arm64v8.tar.gz
+                  docker tag $(docker images -q conduit:main) ${{ env.DOCKER_ARM64 }}
+                  docker tag $(docker images -q conduit:main) ${{ env.GHCR_ARM64 }}
+                  docker tag $(docker images -q conduit:main) ${{ env.GLCR_ARM64 }}
+                  docker push ${{ env.DOCKER_ARM64 }}
+                  docker push ${{ env.GHCR_ARM64 }}
+                  docker push ${{ env.GLCR_ARM64 }}
+
+            - name: Create Docker combined manifests
+              run: |
+                  # Dockerhub Container Registry
+                  docker manifest create ${{ env.DOCKER_TAG }} --amend ${{ env.DOCKER_ARM64 }} --amend ${{ env.DOCKER_AMD64 }}
+                  docker manifest create ${{ env.DOCKER_BRANCH }} --amend ${{ env.DOCKER_ARM64 }} --amend ${{ env.DOCKER_AMD64 }}
+                  # GitHub Container Registry
+                  docker manifest create ${{ env.GHCR_TAG }} --amend ${{ env.GHCR_ARM64 }} --amend ${{ env.GHCR_AMD64 }}
+                  docker manifest create ${{ env.GHCR_BRANCH }} --amend ${{ env.GHCR_ARM64 }} --amend ${{ env.GHCR_AMD64 }}
+                  # GitLab Container Registry
+                  docker manifest create ${{ env.GLCR_TAG }} --amend ${{ env.GLCR_ARM64 }} --amend ${{ env.GCCR_AMD64 }}
+                  docker manifest create ${{ env.GLCR_BRANCH }} --amend ${{ env.GLCR_ARM64 }} --amend ${{ env.GLCR_AMD64 }}
+
+            - name: Push manifests to Docker registries
+              if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
+              run: |
+                  docker manifest push ${{ env.DOCKER_TAG }}
+                  docker manifest push ${{ env.DOCKER_BRANCH }}
+                  docker manifest push ${{ env.GHCR_TAG }}
+                  docker manifest push ${{ env.GHCR_BRANCH }}
+                  docker manifest push ${{ env.GLCR_TAG }}
+                  docker manifest push ${{ env.GLCR_BRANCH }}
+
+            - name: Add Image Links to Job Summary
+              if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
+              run: |
+                  echo "- \`docker pull ${{ env.DOCKER_TAG }}\`" >> $GITHUB_STEP_SUMMARY
+                  echo "- \`docker pull ${{ env.GHCR_TAG }}\`" >> $GITHUB_STEP_SUMMARY
+                  echo "- \`docker pull ${{ env.GLCR_TAG }}\`" >> $GITHUB_STEP_SUMMARY

.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:
@@ -47,7 +49,7 @@ jobs:
         uses: actions/configure-pages@v5
 
       - name: Install Nix (with flakes and nix-command enabled)
-        uses: cachix/install-nix-action@v26
+        uses: cachix/install-nix-action@v27
         with:
           nix_path: nixpkgs=channel:nixos-unstable
 
@@ -58,12 +60,10 @@ jobs:
             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://nix.computer.surgery/conduit
-            extra-trusted-public-keys = conduit:ZGAf6P6LhNvnoJJ3Me3PRg7tlLSrPxcQ2RiE5LIppjo=
             extra-substituters = https://attic.kennel.juneis.dog/conduit
-            extra-trusted-public-keys = conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg=
+            extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk=
             extra-substituters = https://attic.kennel.juneis.dog/conduwuit
-            extra-trusted-public-keys = conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw=
+            extra-trusted-public-keys = conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE=
 
       - name: Add alternative Nix binary caches if specified
         if: ${{ (env.ATTIC_ENDPOINT != '') && (env.ATTIC_PUBLIC_KEY != '') }}
@@ -88,13 +88,13 @@ jobs:
       - name: Allow direnv
         run: direnv allow
 
-      - name: Cache x86_64 inputs for devShell
+      - name: Cache CI dependencies
         run: |
-          ./bin/nix-build-and-cache .#devShells.x86_64-linux.default.inputDerivation
+          ./bin/nix-build-and-cache ci
 
       - name: Build documentation (book)
         run: |
-          ./bin/nix-build-and-cache .#book
+          ./bin/nix-build-and-cache just .#book
           cp -r --dereference result public
       - name: Upload generated documentation (book) as normal artifact
         uses: actions/upload-artifact@v4

.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.21.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.21.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-*/
 
@@ -81,5 +84,14 @@ public/
 # macOS
 .DS_Store
 
+# VS Code
+.vscode/
+
 # Zed
 .zed/
+
+# idk where you're coming from, but i'm tired of you
+rustc-ice-*
+
+# complement test logs are huge
+tests/test_results/complement/test_logs.jsonl

.gitlab-ci.yml

@@ -6,6 +6,10 @@ stages:
 variables:
   # Makes some things print in color
   TERM: ansi
+  # Faster cache and artifact compression / decompression
+  FF_USE_FASTZIP: true
+  # Print progress reports for cache and artifact transfers
+  TRANSFER_METER_FREQUENCY: 5s
 
 # Avoid duplicate pipelines
 # See: https://docs.gitlab.com/ee/ci/yaml/workflow.html#switch-between-branch-pipelines-and-merge-request-pipelines
@@ -22,19 +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
-
-  # Add upstream Conduit binary cache
-  - if command -v nix > /dev/null; then echo "extra-substituters = https://nix.computer.surgery/conduit" >> /etc/nix/nix.conf; fi
-  - if command -v nix > /dev/null; then echo "extra-trusted-public-keys = conduit:ZGAf6P6LhNvnoJJ3Me3PRg7tlLSrPxcQ2RiE5LIppjo=" >> /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,10 +58,10 @@ before_script:
 
 ci:
   stage: ci
-  image: nixos/nix:2.21.2
+  image: nixos/nix:2.22.1
   script:
-    # Cache the inputs required for the devShell
-    - ./bin/nix-build-and-cache .#devShells.x86_64-linux.default.inputDerivation
+    # Cache CI dependencies
+    - ./bin/nix-build-and-cache ci
 
     - direnv exec . engage
   cache:
@@ -79,14 +83,14 @@ ci:
 
 artifacts:
   stage: artifacts
-  image: nixos/nix:2.21.2
+  image: nixos/nix:2.22.1
   script:
-    - ./bin/nix-build-and-cache .#static-x86_64-unknown-linux-musl
+    - ./bin/nix-build-and-cache just .#static-x86_64-unknown-linux-musl
     - cp result/bin/conduit x86_64-unknown-linux-musl
 
     - mkdir -p target/release
     - cp result/bin/conduit target/release
-    - direnv exec . cargo deb --no-build
+    - direnv exec . cargo deb --no-build --no-strip
     - mv target/debian/*.deb x86_64-unknown-linux-musl.deb
 
     # Since the OCI image package is based on the binary package, this has the
@@ -97,16 +101,16 @@ artifacts:
     # Note that although we have an `oci-image-x86_64-unknown-linux-musl`
     # output, we don't build it because it would be largely redundant to this
     # one since it's all containerized anyway.
-    - ./bin/nix-build-and-cache .#oci-image
+    - ./bin/nix-build-and-cache just .#oci-image
     - cp result oci-image-amd64.tar.gz
 
-    - ./bin/nix-build-and-cache .#static-aarch64-unknown-linux-musl
+    - ./bin/nix-build-and-cache just .#static-aarch64-unknown-linux-musl
     - cp result/bin/conduit aarch64-unknown-linux-musl
 
-    - ./bin/nix-build-and-cache .#oci-image-aarch64-unknown-linux-musl
+    - ./bin/nix-build-and-cache just .#oci-image-aarch64-unknown-linux-musl
     - cp result oci-image-arm64v8.tar.gz
 
-    - ./bin/nix-build-and-cache .#book
+    - ./bin/nix-build-and-cache just .#book
     # We can't just copy the symlink, we need to dereference it https://gitlab.com/gitlab-org/gitlab/-/issues/19746
     - cp -r --dereference result public
   artifacts:
@@ -127,49 +131,6 @@ artifacts:
     - if: $CI
   interruptible: true
 
-.push-oci-image:
-  stage: publish
-  image: docker:26.0.1
-  services:
-    - docker:26.0.1-dind
-  variables:
-    IMAGE_SUFFIX_AMD64: amd64
-    IMAGE_SUFFIX_ARM64V8: arm64v8
-  script:
-    - docker load -i oci-image-amd64.tar.gz
-    - IMAGE_ID_AMD64=$(docker images -q conduit:main)
-    - docker load -i oci-image-arm64v8.tar.gz
-    - IMAGE_ID_ARM64V8=$(docker images -q conduit:main)
-    # Tag and push the architecture specific images
-    - docker tag $IMAGE_ID_AMD64 $IMAGE_NAME:$CI_COMMIT_SHA-$IMAGE_SUFFIX_AMD64
-    - docker tag $IMAGE_ID_ARM64V8 $IMAGE_NAME:$CI_COMMIT_SHA-$IMAGE_SUFFIX_ARM64V8
-    - docker push $IMAGE_NAME:$CI_COMMIT_SHA-$IMAGE_SUFFIX_AMD64
-    - docker push $IMAGE_NAME:$CI_COMMIT_SHA-$IMAGE_SUFFIX_ARM64V8
-    # Tag the multi-arch image
-    - docker manifest create $IMAGE_NAME:$CI_COMMIT_SHA --amend $IMAGE_NAME:$CI_COMMIT_SHA-$IMAGE_SUFFIX_AMD64 --amend $IMAGE_NAME:$CI_COMMIT_SHA-$IMAGE_SUFFIX_ARM64V8
-    - docker manifest push $IMAGE_NAME:$CI_COMMIT_SHA
-    # Tag and push the git ref
-    - docker manifest create $IMAGE_NAME:$CI_COMMIT_REF_NAME --amend $IMAGE_NAME:$CI_COMMIT_SHA-$IMAGE_SUFFIX_AMD64 --amend $IMAGE_NAME:$CI_COMMIT_SHA-$IMAGE_SUFFIX_ARM64V8
-    - docker manifest push $IMAGE_NAME:$CI_COMMIT_REF_NAME
-    # Tag git tags as 'latest'
-    - |
-      if [[ -n "$CI_COMMIT_TAG" ]]; then
-        docker manifest create $IMAGE_NAME:latest --amend $IMAGE_NAME:$CI_COMMIT_SHA-$IMAGE_SUFFIX_AMD64 --amend $IMAGE_NAME:$CI_COMMIT_SHA-$IMAGE_SUFFIX_ARM64V8
-        docker manifest push $IMAGE_NAME:latest
-      fi
-  dependencies:
-    - artifacts
-  only:
-    - main
-    - tags
-
-oci-image:push-gitlab:
-  extends: .push-oci-image
-  variables:
-    IMAGE_NAME: $CI_REGISTRY_IMAGE/conduwuit
-  before_script:
-    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
-
 pages:
   stage: publish
   dependencies:

.vscode/extensions.json

@@ -1,11 +0,0 @@
-{
-    "recommendations": [
-        "rust-lang.rust-analyzer",
-        "editorconfig.editorconfig",
-        "ms-azuretools.vscode-docker",
-        "eamodio.gitlens",
-        "serayuzgur.crates",
-        "vadimcn.vscode-lldb",
-        "timonwong.shellcheck"
-    ]
-}

.vscode/launch.json

@@ -1,35 +0,0 @@
-{
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "type": "lldb",
-            "request": "launch",
-            "name": "Debug conduit",
-            "sourceLanguages": ["rust"],
-            "cargo": {
-                "args": [
-                    "build",
-                    "--bin=conduit",
-                    "--package=conduit"
-                ],
-                "filter": {
-                    "name": "conduit",
-                    "kind": "bin"
-                }
-            },
-            "args": [],
-            "env": {
-                "RUST_BACKTRACE": "1",
-                "CONDUIT_DATABASE_PATH": "/tmp/awawawa",
-                "CONDUIT_ADDRESS": "0.0.0.0",
-                "CONDUIT_PORT": "55551",
-                "CONDUIT_SERVER_NAME": "your.server.name",
-                "CONDUIT_LOG": "debug"
-            },
-            "cwd": "${workspaceFolder}"
-        }
-    ]
-}

CONTRIBUTING.md

@@ -0,0 +1,92 @@
+# Contributing guide
+
+This page is for about contributing to conduwuit. The [development](docs/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]
+
+### 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
+[cargo-audit]: https://github.com/RustSec/rustsec/tree/main/cargo-audit
+[direnv]: https://direnv.net/
+[mdbook]: https://rust-lang.github.io/mdBook/
+[documentation.yml]: https://github.com/girlbossceo/conduwuit/blob/main/.github/workflows/documentation.yml

README.md

@@ -1,13 +1,12 @@
 # conduwuit
 
-[![CI and Artifacts](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml)
+`main` / 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)
 
 <!-- ANCHOR: catchphrase -->
-### a well maintained fork of [Conduit](https://conduit.rs/)
+### a very cool, featureful fork of [Conduit](https://conduit.rs/)
 <!-- ANCHOR_END: catchphrase -->
 
 Visit the [Conduwuit documentation](https://conduwuit.puppyirl.gay/) for more information.
-Alternatively you can open [docs/introduction.md](docs/introduction.md) in this repository.
 
 <!-- ANCHOR: body -->
 #### What is Matrix?
@@ -27,35 +26,19 @@ #### 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 fork of Conduit which is in beta, meaning you can join and participate in most
+conduwuit is a hard fork of Conduit which is in beta, meaning you can join and participate in most
 Matrix rooms, but not all features are supported and you might run into bugs
 from time to time.
 
-#### Why does this fork exist? Why don't you contribute back upstream?
-
-I now intend on contributing back as time and mental energy sees fit, but my fork still exists as a way to:
-- avoid unnecessary Matrix and general developer politics
-- avoid bikeshedding unnecessary or irrelevant things in upstream MRs
-- Fast tracked bug fixes, performance improvements, security improvements, and new features
-- Have early access to MRs that may not be suitable/acceptable for Conduit (e.g. too niche, too advanced for general users, only being blocked due to pending on contributor actions that we can fix ourselves downstream, pending Matrix spec stuff, etc)
-- Support unspecced or WIP features
-- Have official support for other OS's like Windows, macOS, and BSD.
-- Have a **stable** testing ground for some MRs or new features and bug fixes
-
-And various other reasons that may not be listed here.
 <!-- 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
 
@@ -71,16 +54,17 @@ #### Donate
 
 #### Logo
 
-No official conduwuit logo exists. Repo and Matrix room picture is from bran (<3). Banner image is directly from [this cohost post](https://cohost.org/RatBaby/post/1028290-finally-a-flag-for).
+Original repo and Matrix room picture was from bran (<3). Current banner image and logo is directly from [this cohost post](https://cohost.org/RatBaby/post/1028290-finally-a-flag-for).
 
 #### Is it conduwuit or Conduwuit?
 
-Both.
+Both, but I prefer 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>

bin/complement

@@ -3,6 +3,10 @@
 set -euo pipefail
 
 # Path to Complement's source code
+#
+# The `COMPLEMENT_SRC` environment variable is set in the Nix dev shell, which
+# points to a store path containing the Complement source code. It's likely you
+# want to just pass that as the first argument to use it here.
 COMPLEMENT_SRC="$1"
 
 # A `.jsonl` file to write test logs to
@@ -11,27 +15,35 @@ LOG_FILE="$2"
 # A `.jsonl` file to write test results to
 RESULTS_FILE="$3"
 
-OCI_IMAGE="complement-conduit:dev"
+OCI_IMAGE="complement-conduit:main"
 
-env \
-    -C "$(git rev-parse --show-toplevel)" \
-    docker build \
-        --tag "$OCI_IMAGE" \
-        --file tests/complement/Dockerfile \
-        .
+# 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=TestJumpToDateEndpoint.*|TestJoinFederatedRoomFromApplicationServiceBridgeUser.*|TestFederationRoomsInvite.*|TestClientSpacesSummary.*'
+
+toplevel="$(git rev-parse --show-toplevel)"
+
+pushd "$toplevel" > /dev/null
+
+bin/nix-build-and-cache just .#static-complement
+
+docker load < result
+popd > /dev/null
 
 # It's okay (likely, even) that `go test` exits nonzero
 set +o pipefail
 env \
     -C "$COMPLEMENT_SRC" \
     COMPLEMENT_BASE_IMAGE="$OCI_IMAGE" \
-    go test -vet=all -timeout 30m -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
-cat "$LOG_FILE" | jq -c '
+# Post-process the results into an easy-to-compare format, sorted by Test name for reproducible results
+cat "$LOG_FILE" | jq -s -c 'sort_by(.Test)[]' | jq -c '
     select(
         (.Action == "pass" or .Action == "fail" or .Action == "skip")
         and .Test != null
     ) | {Action: .Action, Test: .Test}
-    ' | sort > "$RESULTS_FILE"
+    ' > "$RESULTS_FILE"

bin/nix-build-and-cache

@@ -2,40 +2,95 @@
 
 set -eo pipefail
 
-# The first argument must be the desired installable
-INSTALLABLE="$1"
+toplevel="$(git rev-parse --show-toplevel)"
 
-# Build the installable and forward any other arguments too
-nix build -L "$@"
+# Build just the single installable and forward any other arguments too
+just() {
+    # uses nix-output-monitor (nom) if available
+    if command -v nom &> /dev/null; then
+        nom build "$@"
+    else
+        nix build -L "$@"
+    fi
 
-if [ ! -z "$ATTIC_TOKEN" ]; then
-    nix run --inputs-from . attic -- \
+    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"
 
-    # Push the target installable and its build dependencies
-    nix run --inputs-from . attic -- \
-        push \
-        conduit \
-        "$(nix path-info "$INSTALLABLE" --derivation)" \
-        "$(nix path-info "$INSTALLABLE")"
+    # 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[*]}"
+    )
 
-    # push to "conduwuit" too
-    nix run --inputs-from . attic -- \
+    # 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 . attic -- \
-        push \
-        conduwuit \
-        "$(nix path-info "$INSTALLABLE" --derivation)" \
-        "$(nix path-info "$INSTALLABLE")"
-else
-    echo "\$ATTIC_TOKEN is unset, skipping uploading to the binary cache"
-fi
+    # Upload them to Attic (conduwuit 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 conduwuit <<< "${cache[*]}"
+    )
+}
+
+# Build and cache things needed for CI
+ci() {
+    cache=(
+        --inputs-from "$toplevel"
+
+        # Keep sorted
+        "$toplevel#devShells.x86_64-linux.all-features"
+        attic#default
+        nixpkgs#direnv
+        nixpkgs#jq
+        nixpkgs#nix-direnv
+    )
+
+    just "${cache[@]}"
+}
+
+# Build and cache *all* the package outputs from the flake.nix
+packages() {
+    declare -a cache="($(
+        nix flake show --json 2> /dev/null |
+            nix run --inputs-from "$toplevel" nixpkgs#jq -- \
+            -r \
+            '.packages."x86_64-linux" | keys | map("'"$toplevel"'#" + .) | @sh'
+    ))"
+
+    just "${cache[@]}"
+}
+
+
+eval "$@"

book.toml

@@ -1,6 +1,6 @@
 [book]
 title = "conduwuit"
-description = "conduwuit, which is a fork of Conduit, is a simple, fast and reliable chat server for the Matrix protocol"
+description = "conduwuit, which is a well-maintained fork of Conduit, is a simple, fast and reliable chat server for the Matrix protocol"
 language = "en"
 multilingual = false
 src = "docs"

conduwuit-example.toml

@@ -34,12 +34,17 @@
 # Defaults to `matrix.org`
 # trusted_servers = ["matrix.org"]
 
-# Sentry.io crash/panic reporting, performance monitoring/metrics, etc.
-# Conduwuit's Sentry reporting endpoint is o4506996327251968.ingest.us.sentry.io
+# Sentry.io crash/panic reporting, performance monitoring/metrics, etc. This is NOT enabled by default.
+# conduwuit's default Sentry reporting endpoint is o4506996327251968.ingest.us.sentry.io
 #
-# Defaults to false
+# Defaults to *false*
 #sentry = false
 
+# Sentry reporting URL if a custom one is desired
+#
+# Defaults to conduwuit's default Sentry endpoint: "https://fe2eb4536aa04949e28eff3128d64757@o4506996327251968.ingest.us.sentry.io/4506996334657536"
+#sentry_endpoint = ""
+
 # Report your Conduwuit server_name in Sentry.io crash reports and metrics
 #
 # Defaults to false
@@ -55,8 +60,9 @@
 
 ### 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
@@ -78,21 +84,6 @@ port = 6167
 # likely need this to be 0.0.0.0.
 address = "127.0.0.1"
 
-# How many requests conduwuit sends to other servers at the same time concurrently. Default is 500
-# Note that because conduwuit is very fast unlike other homeserver implementations, setting this too
-# high could inadvertently result in ratelimits kicking in, or overloading lower-end homeservers out there.
-#
-# A valid use-case for enabling this is if you have a significant amount of overall federation activity
-# such as many rooms joined/tracked, and many servers in the true destination cache caused by that. Upon
-# rebooting conduwuit, depending on how fast your resources are, client and incoming federation requests
-# may timeout or be "stalled" for a period of time due to hitting the max concurrent requests limit from
-# refreshing federation/destination caches and such.
-#
-# If you have a lot of active users on your homeserver, you will definitely need to raise this.
-#
-# No this will not speed up room joins.
-#max_concurrent_requests = 500
-
 # Max request size for file uploads
 max_request_size = 20_000_000 # in bytes
 
@@ -279,6 +270,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
 
@@ -288,8 +292,8 @@ allow_profile_lookup_federation_requests = true
 # For release builds, the tracing crate is configured to only implement levels higher than error to avoid unnecessary overhead in the compiled binary from trace macros.
 # For debug builds, this restriction is not applied.
 #
-# Defaults to "warn"
-#log = "warn"
+# Defaults to "info"
+#log = "info"
 
 # controls whether encrypted rooms and events are allowed (default true)
 #allow_encryption = false
@@ -346,6 +350,18 @@ allow_profile_lookup_federation_requests = true
 # messages without any attempt at redelivery.
 #startup_netburst_keep = 50
 
+# If the 'perf_measurements' feature is enabled, enables collecting folded stack trace profile of tracing spans using
+# tracing_flame. The resulting profile can be visualized with inferno[1], speedscope[2], or a number of other tools.
+# [1]: https://github.com/jonhoo/inferno
+# [2]: www.speedscope.app
+# tracing_flame = false
+
+# If 'tracing_flame' is enabled, sets a filter for which events will be included in the profile.
+# Supported syntax is documented at https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives
+# tracing_flame_filter = "trace,h2=off"
+
+# If 'tracing_flame' is enabled, set the path to write the generated profile.
+# tracing_flame_output_path = "./tracing.folded"
 
 ### Generic database options
 
@@ -382,6 +398,10 @@ allow_profile_lookup_federation_requests = true
 # Defaults to false
 #rocksdb_optimize_for_spinning_disks = false
 
+# Enables direct-io to increase database performance. This is enabled by default. Set this option to false if the
+# database resides on a filesystem which does not support direct-io.
+#rocksdb_direct_io = true
+
 # RocksDB log level. This is not the same as conduwuit's log level. This is the log level for the RocksDB engine/library
 # which show up in your database folder/path as `LOG` files. Defaults to error. conduwuit will typically log RocksDB errors as normal.
 #rocksdb_log_level = "error"
@@ -392,21 +412,31 @@ allow_profile_lookup_federation_requests = true
 # Time in seconds before RocksDB will forcibly rotate logs. Defaults to 0.
 #rocksdb_log_time_to_roll = 0
 
-# Amount of threads that RocksDB will use for parallelism on database operatons such as cleanup, sync, flush, compaction, etc. Set to 0 to use all your physical cores.
+# Amount of threads that RocksDB will use for parallelism on database operatons such as cleanup, sync, flush, compaction, etc. Set to 0 to use all your logical threads.
 #
-# Defaults to your CPU physical core count (not logical threads).
+# Defaults to your CPU logical thread count.
 #rocksdb_parallelism_threads = 0
 
+# Enables idle IO priority for compaction thread. This prevents any unexpected lag in the server's operation and
+# is usually a good idea. Enabled by default.
+#rocksdb_compaction_ioprio_idle = true
+
+# Enables idle CPU priority for compaction thread. This is not enabled by default to prevent compaction from
+# falling too far behind on busy systems.
+#rocksdb_compaction_prio_idle = false
+
 # Maximum number of LOG files RocksDB will keep. This must *not* be set to 0. It must be at least 1.
 # Defaults to 3 as these are not very useful.
 #rocksdb_max_log_files = 3
 
 # Type of RocksDB database compression to use.
-# Available options are "zstd", "zlib", "bz2" and "lz4"
+# Available options are "zstd", "zlib", "bz2", "lz4", or "none"
 # It is best to use ZSTD as an overall good balance between speed/performance, storage, IO amplification, and CPU usage.
 # For more performance but less compression (more storage used) and less CPU usage, use LZ4.
 # See https://github.com/facebook/rocksdb/wiki/Compression for more details.
 #
+# "none" will disable compression.
+#
 # Defaults to "zstd"
 #rocksdb_compression_algo = "zstd"
 
@@ -473,7 +503,7 @@ allow_profile_lookup_federation_requests = true
 # Maximum entries stored in DNS memory-cache. The size of an entry may vary so please take care if
 # raising this value excessively. Only decrease this when using an external DNS cache. Please note
 # that systemd does *not* count as an external cache, even when configured to do so.
-#dns_cache_entries = 12288
+#dns_cache_entries = 32768
 
 # Minimum time-to-live in seconds for entries in the DNS cache. The default may appear high to most
 # administrators; this is by design. Only decrease this if you are using an external DNS cache.
@@ -482,7 +512,9 @@ allow_profile_lookup_federation_requests = true
 # Minimum time-to-live in seconds for NXDOMAIN entries in the DNS cache. This value is critical for
 # the server to federate efficiently. NXDOMAIN's are assumed to not be returning to the federation
 # and aggressively cached rather than constantly rechecked.
-#dns_min_ttl_nxdomain = 86400
+#
+# Defaults to 3 days as these are *very rarely* false negatives.
+#dns_min_ttl_nxdomain = 259200
 
 # The number of seconds to wait for a reply to a DNS query. Please note that recursive queries can
 # take up to several seconds for some domains, so this value should not be too low.
@@ -500,6 +532,27 @@ allow_profile_lookup_federation_requests = true
 # The default is to query one nameserver and stop (false).
 #query_all_nameservers = true
 
+# Enables using *only* TCP for querying your specified nameservers instead of UDP.
+#
+# You very likely do *not* want this. hickory-resolver already falls back to TCP on UDP errors.
+# Defaults to false
+#query_over_tcp_only = false
+
+# DNS A/AAAA record lookup strategy
+#
+# Takes a number of one of the following options:
+# 1 - Ipv4Only (Only query for A records, no AAAA/IPv6)
+# 2 - Ipv6Only (Only query for AAAA records, no A/IPv4)
+# 3 - Ipv4AndIpv6 (Query for A and AAAA records in parallel, uses whatever returns a successful response first)
+# 4 - Ipv6thenIpv4 (Query for AAAA record, if that fails then query the A record)
+# 5 - Ipv4thenIpv6 (Query for A record, if that fails then query the AAAA record)
+#
+# If you don't have IPv6 networking, then for better performance it may be suitable to set this to Ipv4Only (1) as
+# you will never ever use the AAAA record contents even if the AAAA record is successful instead of the A record.
+#
+# Defaults to 5 - Ipv4ThenIpv6 as this is the most compatible and IPv4 networking is currently the most prevalent.
+#ip_lookup_strategy = 5
+
 
 ### Request Timeouts, Connection Timeouts, and Connection Pooling
 
@@ -512,23 +565,24 @@ allow_profile_lookup_federation_requests = true
 ##
 ## Generally these defaults are the best, but if you find a reason to need to change these they are here.
 
-# Default/base connection timeout
+# Default/base connection timeout.
 # This is used only by URL previews and update/news endpoint checks
 #
 # Defaults to 10 seconds
 #request_conn_timeout = 10
 
-# Default/base request timeout
-# This is used only by URL previews and update/news endpoint checks
+# Default/base request timeout. The time waiting to receive more data from another server.
+# This is used only by URL previews, update/news, and misc endpoint checks
 #
 # Defaults to 35 seconds
 #request_timeout = 35
 
-# Default/base max idle connections per host
+# Default/base request total timeout. The time limit for a whole request. This is set very high to not
+# cancel healthy requests while serving as a backstop.
 # This is used only by URL previews and update/news endpoint checks
 #
-# Defaults to 1 as generally the same open connection can be re-used
-#request_idle_per_host = 1
+# Defaults to 320 seconds
+#request_total_timeout = 320
 
 # Default/base idle connection pool timeout
 # This is used only by URL previews and update/news endpoint checks
@@ -536,6 +590,12 @@ allow_profile_lookup_federation_requests = true
 # Defaults to 5 seconds
 #request_idle_timeout = 5
 
+# Default/base max idle connections per host
+# This is used only by URL previews and update/news endpoint checks
+#
+# Defaults to 1 as generally the same open connection can be re-used
+#request_idle_per_host = 1
+
 # Federation well-known resolution connection timeout
 #
 # Defaults to 6 seconds
@@ -546,26 +606,42 @@ allow_profile_lookup_federation_requests = true
 # Defaults to 10 seconds
 #well_known_timeout = 10
 
-# Federation client/server request timeout
+# Federation client request timeout
 # You most definitely want this to be high to account for extremely large room joins, slow homeservers, your own resources etc.
 #
 # Defaults to 300 seconds
 #federation_timeout = 300
 
-# Federation client/sender max idle connections per host
-#
-# Defaults to 1 as generally the same open connection can be re-used
-#federation_idle_per_host = 1
-
-# Federation client/sender idle connection pool timeout
+# Federation client idle connection pool timeout
 #
 # Defaults to 25 seconds
 #federation_idle_timeout = 25
 
+# Federation client max idle connections per host
+#
+# Defaults to 1 as generally the same open connection can be re-used
+#federation_idle_per_host = 1
+
+# Federation sender request timeout
+# The time it takes for the remote server to process sent transactions can take a while.
+#
+# Defaults to 180 seconds
+#sender_timeout = 180
+
+# Federation sender idle connection pool timeout
+#
+# Defaults to 180 seconds
+#sender_idle_timeout = 180
+
+# Federation sender transaction retry backoff limit
+#
+# Defaults to 86400 seconds
+#sender_retry_backoff_limit = 86400
+
 # Appservice URL request connection timeout
 #
-# Defaults to 120 seconds
-#appservice_timeout = 120
+# Defaults to 35 seconds as generally appservices are hosted within the same network
+#appservice_timeout = 35
 
 # Appservice URL idle connection pool timeout
 #
@@ -599,6 +675,11 @@ allow_profile_lookup_federation_requests = true
 #
 #allow_outgoing_presence = true
 
+# Config option to enable the presence idle timer for remote users. Disabling is offered as an optimization for
+# servers participating in many large rooms or when resources are limited. Disabling it may cause incorrect
+# presence states (i.e. stuck online) to be seen for some remote users. Defaults to true.
+#presence_timeout_remote_users = true
+
 # Config option to control how many seconds before presence updates that you are idle. Defaults to 5 minutes.
 #presence_idle_timeout_s = 300
 

debian/README.md

@@ -1,37 +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 Conduit" 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/matrix-conduit/conduit.toml`.
+### Configuration
 
-You can tweak more detailed settings by uncommenting and setting the variables
-in `/etc/matrix-conduit/conduit.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 `matrix-conduit.service` systemd unit file to start and
-stop Conduit. It loads the configuration file mentioned above to set up the
-environment before running the server.
+### Running
 
-This package assumes by default that Conduit will be placed behind a reverse
-proxy such as Apache or nginx. 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>.
+The package uses the [`conduwuit.service`](../configuration.md#example-systemd-unit-file) systemd unit file to start and stop conduwuit. The binary is installed at `/usr/sbin/conduwuit`.
 
-At a later stage this packaging may support also setting up TLS and running
-stand-alone.  In this case, however, you need to set up some certificates and
-renewal, for it to work properly.
+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=_matrix-conduit
-Group=_matrix-conduit
+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=
 
@@ -36,22 +43,19 @@ RestrictNamespaces=yes
 RestrictRealtime=yes
 RestrictSUIDSGID=yes
 SystemCallArchitectures=native
-SystemCallFilter=@system-service
-SystemCallFilter=~@clock @debug @module @mount @reboot @swap @cpu-emulation @obsolete @timer @chown @setuid @resources @privileged @keyring @ipc
+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/matrix-conduit/conduit.toml"
-
-ExecStart=/usr/sbin/matrix-conduit
 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 matrix-conduit/hostname || true
-db_go
-
-db_input low matrix-conduit/address || true
-db_go
-
-db_input medium matrix-conduit/port || true
-db_go
+#. /usr/share/debconf/confmodule
+#
+## Ask for the Matrix homeserver name, address and port.
+#db_input high conduwuit/hostname || true
+#db_go
+#
+#db_input low conduwuit/address || true
+#db_go
+#
+#db_input medium conduwuit/port || true
+#db_go
 
 exit 0

debian/postinst

@@ -1,28 +1,43 @@
 #!/bin/sh
 set -e
 
-. /usr/share/debconf/confmodule
+# TODO: implement debconf support that is maintainable without duplicating the config
+#. /usr/share/debconf/confmodule
 
-CONDUIT_DATABASE_PATH=/var/lib/matrix-conduit/
+CONDUWUIT_DATABASE_PATH=/var/lib/conduwuit
+CONDUWUIT_CONFIG_PATH=/etc/conduwuit
+CONDUWUIT_CONFIG_FILE="${CONDUWUIT_CONFIG_PATH}/conduwuit.toml"
 
 case "$1" in
   configure)
-    # Create the `_matrix-conduit` user if it does not exist yet.
-    if ! getent passwd _matrix-conduit > /dev/null ; then
-      echo 'Adding system user for the Conduwuit Matrix homeserver' 1>&2
+    # 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 "$CONDUIT_DATABASE_PATH" \
+        --home "$CONDUWUIT_DATABASE_PATH" \
         --disabled-login \
         --shell "/usr/sbin/nologin" \
-        --force-badname \
-        _matrix-conduit
+        --verbose \
+        conduwuit
     fi
 
     # Create the database path if it does not exist yet and fix up ownership
-    # and permissions.
-    mkdir -p "$CONDUIT_DATABASE_PATH"
-    chown _matrix-conduit:_matrix-conduit -R "$CONDUIT_DATABASE_PATH"
-    chmod 700 "$CONDUIT_DATABASE_PATH"
+    # and permissions for the config.
+    mkdir -v -p "$CONDUWUIT_DATABASE_PATH"
+
+    # symlink the previous location for compatibility
+    ln -s -v "$CONDUWUIT_DATABASE_PATH" "/var/lib/matrix-conduit"
+
+    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
 
-CONDUIT_CONFIG_PATH=/etc/matrix-conduit
-CONDUIT_DATABASE_PATH=/var/lib/matrix-conduit
+CONDUWUIT_CONFIG_PATH=/etc/conduwuit
+CONDUWUIT_DATABASE_PATH=/var/lib/conduwuit
+CONDUWUIT_DATABASE_PATH_SYMLINK=/var/lib/matrix-conduit
 
 case $1 in
   purge)
@@ -14,12 +15,16 @@ case $1 in
     # Per https://www.debian.org/doc/debian-policy/ch-files.html#behavior
     # "configuration files must be preserved when the package is removed, and
     #  only deleted when the package is purged."
-    if [ -d "$CONDUIT_CONFIG_PATH" ]; then
-      rm -r "$CONDUIT_CONFIG_PATH"
+    if [ -d "$CONDUWUIT_CONFIG_PATH" ]; then
+      rm -v -r "$CONDUWUIT_CONFIG_PATH"
     fi
 
-    if [ -d "$CONDUIT_DATABASE_PATH" ]; then
-      rm -r "$CONDUIT_DATABASE_PATH"
+    if [ -d "$CONDUWUIT_DATABASE_PATH" ]; then
+      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: matrix-conduit/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: matrix-conduit/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: matrix-conduit/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,35 @@
+[package]
+name = "rust-rocksdb-uwu"
+version = "0.0.1"
+edition = "2021"
+
+[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"
+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();
+}

docker/healthcheck.sh

@@ -1,19 +0,0 @@
-#!/bin/sh
-
-# If the config file does not contain a default port and the CONDUIT_PORT env is not set, create
-# try to get port from process list
-if [ -z "${CONDUIT_PORT}" ]; then
-  CONDUIT_PORT=$(ss -tlpn | grep conduit | grep -m1 -o ':[0-9]*' | grep -m1 -o '[0-9]*')
-fi
-
-# If CONDUIT_ADDRESS is not set try to get the address from the process list
-if [ -z "${CONDUIT_ADDRESS}" ]; then
-  CONDUIT_ADDRESS=$(ss -tlpn | awk -F ' +|:' '/conduit/ { print $4 }')
-fi
-
-# The actual health check.
-# We try to first get a response on HTTP and when that fails on HTTPS and when that fails, we exit with code 1.
-# TODO: Change this to a single wget call. Do we have a config value that we can check for that?
-wget --no-verbose --tries=1 --spider "http://${CONDUIT_ADDRESS}:${CONDUIT_PORT}/_matrix/client/versions" || \
-    wget --no-verbose --tries=1 --spider "https://${CONDUIT_ADDRESS}:${CONDUIT_PORT}/_matrix/client/versions" || \
-    exit 1

docs/SUMMARY.md

@@ -2,12 +2,18 @@ # Summary
 
 - [Introduction](introduction.md)
 - [Differences from upstream Conduit](differences.md)
-
 - [Example configuration](configuration.md)
 - [Deploying](deploying.md)
     - [Generic](deploying/generic.md)
-    - [Debian](deploying/debian.md)
-    - [Docker](deploying/docker.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)
+    - [Contributing](contributing.md)
+    - [Testing](development/testing.md)
+    - [Hot Reloading ("Live" Development)](development/hot_reload.md)

docs/configuration.md

@@ -3,3 +3,9 @@ # Example configuration
 ``` toml
 {{#include ../conduwuit-example.toml}}
 ```
+
+# Example systemd unit file
+
+```
+{{#include ../debian/conduwuit.service}}
+```

docs/contributing.md

@@ -0,0 +1 @@
+{{#include ../CONTRIBUTING.md}}

docs/deploying/arch-linux.md

@@ -0,0 +1,8 @@
+# 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

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

@@ -1,46 +1,35 @@
-# 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_MAX_CONCURRENT_REQUESTS: 100
-            #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
     # to serve those two as static files. If you want to use a different way, delete or comment the below service, here
-    # and in the docker-compose override file.
+    # and in the docker compose override file.
     well-known:
         image: nginx:latest
         restart: unless-stopped
@@ -49,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"
@@ -18,7 +18,7 @@ services:
 
     # We need some way to server the client and server .well-known json. The simplest way is to use a nginx container
     # to serve those two as static files. If you want to use a different way, delete or comment the below service, here
-    # and in the docker-compose file.
+    # and in the docker compose file.
     well-known:
         labels:
             - "traefik.enable=true"

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

@@ -1,49 +1,38 @@
-# 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
     # to serve those two as static files. If you want to use a different way, delete or comment the below service, here
-    # and in the docker-compose override file.
+    # and in the docker compose override file.
     well-known:
         image: nginx:latest
         restart: unless-stopped
@@ -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
@@ -94,4 +83,4 @@ volumes:
     acme:
 
 networks:
-    proxy:
+    proxy:

docs/deploying/docker-compose.yml

@@ -1,46 +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_MAX_CONCURRENT_REQUESTS: 400
-            #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

@@ -1,4 +1,4 @@
-# Conduwuit for Docker
+# conduwuit for Docker
 
 ## Docker
 
@@ -11,68 +11,51 @@ ### Use a registry
 
 | Registry        | Image                                                           | Size                          | Notes                  |
 | --------------- | --------------------------------------------------------------- | ----------------------------- | ---------------------- |
-| GitHub Registry | [ghcr.io/girlbossceo/conduwuit:latest][gh] | ![Image Size][shield-latest]  | Stable image.          |
-| Docker Hub      | [docker.io/girlbossceo/conduwuit:latest][dh]             | ![Image Size][shield-latest]  | Stable image.          |
-| GitHub Registry | [ghcr.io/girlbossceo/conduwuit:main][gh]   | ![Image Size][shield-main]    | Development version.   |
-| Docker Hub      | [docker.io/girlbossceo/conduwuit:main][dh]               | ![Image Size][shield-main]    | Development version.   |
-
+| GitHub Registry | [ghcr.io/girlbossceo/conduwuit:latest][gh] | ![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/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.   |
 
 [dh]: https://hub.docker.com/repository/docker/girlbossceo/conduwuit
 [gh]: https://github.com/girlbossceo/conduwuit/pkgs/container/conduwuit
+[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
 
 
-Use 
+Use
 ```bash
 docker image pull <link>
 ```
 to pull it to your machine.
 
 
-
-### Build using a Dockerfile
-
-The Dockerfile provided by Conduit has two stages, each of which creates an image.
-
-1. **Builder:** Builds the binary from local context or by cloning a git revision from the official repository.
-2. **Runner:** Copies the built binary from **Builder** and sets up the runtime environment, like creating a volume to persist the database and applying the correct permissions.
-
-To build the image you can use the following command
-
-```bash
-docker build --tag girlbossceo/conduwuit:main .
-```
-
-which also will tag the resulting image as `girlbossceo/conduwuit:main`.
-
-
-
 ### Run
 
 When you have the image you can simply run it with
 
 ```bash
 docker run -d -p 8448:6167 \
-  -v db:/var/lib/matrix-conduit/ \
+  -v db:/var/lib/conduwuit/ \
   -e CONDUIT_SERVER_NAME="your.server.name" \
   -e CONDUIT_DATABASE_BACKEND="rocksdb" \
-  -e CONDUIT_ALLOW_REGISTRATION=true \
+  -e CONDUIT_ALLOW_REGISTRATION=false \
   -e CONDUIT_ALLOW_FEDERATION=true \
-  -e CONDUIT_MAX_REQUEST_SIZE="20000000" \
+  -e CONDUIT_MAX_REQUEST_SIZE="40000000" \
   -e CONDUIT_TRUSTED_SERVERS="[\"matrix.org\"]" \
-  -e CONDUIT_MAX_CONCURRENT_REQUESTS="500" \
   -e CONDUIT_LOG="warn,ruma_state_res=warn" \
   --name conduit <link>
 ```
 
-or you can use [docker-compose](#docker-compose).
+or you can use [docker compose](#docker-compose).
 
-The `-d` flag lets the container run in detached mode. You now need to supply a `conduit.toml` config file, an example can be found [here](../configuration.md).
-You can pass in different env vars to change config values on the fly. You can even configure Conduit completely by using env vars, but for that you need
-to pass `-e CONDUIT_CONFIG=""` into your container. For an overview of possible values, please take a look at the `docker-compose.yml` file.
+The `-d` flag lets the container run in detached mode. You may supply an optional `conduwuit.toml` config file, the example config can be found [here](../configuration.md).
+You can pass in different env vars to change config values on the fly. You can even configure conduwuit completely by using env vars. For an overview of possible
+values, please take a look at the [`docker-compose.yml`](docker-compose.yml) file.
 
-If you just want to test Conduit for a short time, you can use the `--rm` flag, which will clean up everything related to your container after you stop it.
+If you just want to test conduwuit for a short time, you can use the `--rm` flag, which will clean up everything related to your container after you stop it.
 
 ### Docker-compose
 
@@ -87,14 +70,14 @@ ### Docker-compose
 rename the override file to `docker-compose.override.yml`. Edit the latter with the values you want
 for your server.
 
-Additional info about deploying Conduit can be found [here](generic.md).
+Additional info about deploying conduwuit can be found [here](generic.md).
 
 ### Build
 
-To build the Conduit image with docker-compose, you first need to open and modify the `docker-compose.yml` file. There you need to comment the `image:` option and uncomment the `build:` option. Then call docker-compose with:
+To build the conduwuit image with docker-compose, you first need to open and modify the `docker-compose.yml` file. There you need to comment the `image:` option and uncomment the `build:` option. Then call docker compose with:
 
 ```bash
-docker-compose up
+docker compose up
 ```
 
 This will also start the container right afterwards, so if want it to run in detached mode, you also should use the `-d` flag.
@@ -104,7 +87,7 @@ ### Run
 If you already have built the image or want to use one from the registries, you can just start the container and everything else in the compose file in detached mode with:
 
 ```bash
-docker-compose up -d
+docker compose up -d
 ```
 
 > **Note:** Don't forget to modify and adjust the compose file to your needs.
@@ -116,101 +99,15 @@ ### Use Traefik as Proxy
 [`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml) (or
 [`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)) and
 [`docker-compose.override.yml`](docker-compose.override.yml), it is equally easy to deploy
-and use Conduit, with a little caveat. If you already took a look at the files, then you should have
+and use conduwuit, with a little caveat. If you already took a look at the files, then you should have
 seen the `well-known` service, and that is the little caveat. Traefik is simply a proxy and
-loadbalancer and is not able to serve any kind of content, but for Conduit to federate, we need to
+loadbalancer and is not able to serve any kind of content, but for conduwuit to federate, we need to
 either expose ports `443` and `8448` or serve two endpoints `.well-known/matrix/client` and
 `.well-known/matrix/server`.
 
 With the service `well-known` we use a single `nginx` container that will serve those two files.
 
-So...step by step:
-
-1. Copy [`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml) (or
-[`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)) and [`docker-compose.override.yml`](docker-compose.override.yml) from the repository and remove `.for-traefik` (or `.with-traefik`) from the filename.
-2. Open both files and modify/adjust them to your needs. Meaning, change the `CONDUIT_SERVER_NAME` and the volume host mappings according to your needs.
-3. Create the `conduit.toml` config file, an example can be found [here](../configuration.md), or set `CONDUIT_CONFIG=""` and configure Conduit 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. Conduit 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 conduit. You can either modify conduit.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
@@ -11,98 +9,70 @@ ## Installing conduwuit
 
 You may simply download the binary that fits your machine. Run `uname -m` to see what you need.
 
-Prebuilt binaries can be downloaded from the latest successful CI workflow on the main branch here: https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml?query=branch%3Amain+actor%3Agirlbossceo+is%3Asuccess+event%3Apush
+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 conduit-next 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 Conduit user
+## Adding a conduwuit user
 
-While Conduit 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 Conduit user:
+In Debian or RHEL, you can use this command to create a conduwuit user:
 
 ```bash
-sudo adduser --system conduit --group --disabled-login --no-create-home
+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
 
-Conduit uses the ports 443 and 8448 both of which need to be open in the firewall.
+conduwuit uses the ports 443 and 8448 both of which need to be open in the firewall.
 
-If Conduit runs behind a router or in a container and has a different public IP address than the host system these public ports need to be forwarded directly or indirectly to the port mentioned in the config.
+If conduwuit runs behind a router or in a container and has a different public IP address than the host system these public ports need to be forwarded directly or indirectly to the port mentioned in the config.
 
 ## Setting up a systemd service
 
-Now we'll set up a systemd service for Conduit, so it's easy to start/stop Conduit and set it to autostart when your
-server reboots. Simply paste the default systemd service you can find below into
-`/etc/systemd/system/conduit.service`.
+The systemd unit for conduwuit can be found [here](../configuration.md#example-systemd-unit-file). You may need to change the `ExecStart=` path to where you placed the conduwuit binary.
 
-```systemd
-[Unit]
-Description=Conduwuit Matrix Server
-After=network.target
+## Creating the conduwuit configuration file
 
-[Service]
-Environment="CONDUIT_CONFIG=/etc/matrix-conduit/conduit.toml"
-User=conduit
-Group=conduit
-RuntimeDirectory=conduit
-RuntimeDirectoryMode=0750
-Restart=always
-ExecStart=/usr/local/bin/matrix-conduit
+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.md).**Please take a moment to read it. You need to change at least the server name.**
 
-[Install]
-WantedBy=multi-user.target
-```
-
-Finally, run
-
-```bash
-$ sudo systemctl daemon-reload
-```
-
-## Creating the Conduit configuration file
-
-Now we need to create the Conduit'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.
 
-See the following example config at [conduwuit-example.toml](../configuration.md)
-
 ## Setting the correct file permissions
 
-As we are using a Conduit 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
-sudo chown -R root:root /etc/matrix-conduit
-sudo chmod 755 /etc/matrix-conduit
+sudo chown -R root:root /etc/conduwuit
+sudo chmod 755 /etc/conduwuit
 ```
 
 If you use the default database path you also need to run this:
 
 ```bash
-sudo mkdir -p /var/lib/matrix-conduit/
-sudo chown -R conduit:conduit /var/lib/matrix-conduit/
-sudo chmod 700 /var/lib/matrix-conduit/
+sudo mkdir -p /var/lib/conduwuit/
+sudo chown -R conduwuit:conduwuit /var/lib/conduwuit/
+sudo chmod 700 /var/lib/conduwuit/
 ```
 
 ## Setting up the Reverse Proxy
 
-Refer to the documentation or various guides online of your chosen reverse proxy software. A Caddy 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).
 
 ### Caddy
 
@@ -114,28 +84,28 @@ ### Caddy
         reverse_proxy 127.0.0.1:6167
 
         # UNIX socket
-        #reverse_proxy unix//run/conduit/conduit.sock
+        #reverse_proxy unix//run/conduwuit/conduwuit.sock
 }
 ```
 
-That's it! Just start or enable the service and you're set.
+That's it! Just start and enable the service and you're set.
 
 ```bash
-$ sudo systemctl enable caddy
+$ sudo systemctl enable --now caddy
 ```
 
 ## You're done!
 
-Now you can start Conduit with:
+Now you can start conduwuit with:
 
 ```bash
-$ sudo systemctl start conduit
+$ sudo systemctl start conduwuit
 ```
 
 Set it to start automatically when your system boots with:
 
 ```bash
-$ sudo systemctl enable conduit
+$ sudo systemctl enable conduwuit
 ```
 
 ## How do I know it works?

docs/deploying/nixos.md

@@ -1,18 +1,26 @@
-# Conduwuit for NixOS
+# 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
-* From Conduwuit's binary cache
+* From conduwuit's binary cache
 
 A binary cache for conduwuit that the CI/CD publishes to is available at the
 following places (both are the same just different names):
 ```
 https://attic.kennel.juneis.dog/conduit
-conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg=
+conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk=
 
 https://attic.kennel.juneis.dog/conduwuit
+conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE=
+```
+
+The binary caches have been recreated recently due to attic issues. The old public keys were:
+
+```
+conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg=
+
 conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw=
 ```
 
@@ -20,11 +28,12 @@ # Conduwuit for NixOS
 
 The `flake.nix` and `default.nix` do not (currently) provide a NixOS module, so
 (for now) [`services.matrix-conduit`][module] from Nixpkgs should be used to
-configure Conduit.
+configure conduwuit.
 
 If you want to run the latest code, you should get Conduwuit from the `flake.nix`
 or `default.nix` and set [`services.matrix-conduit.package`][package]
 appropriately.
 
+[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

@@ -0,0 +1,22 @@
+# Development
+
+Information about developing the project. If you are only interested in using
+it, you can safely ignore this section. If you plan on contributing, see the
+[contributor's guide](contributing.md).
+
+## Debugging with `tokio-console`
+
+[`tokio-console`][1] can be a useful tool for debugging and profiling. To make
+a `tokio-console`-enabled build of Conduwuit, enable the `tokio_console` feature,
+disable the default `release_max_log_level` feature, and set the
+`--cfg tokio_unstable` flag to enable experimental tokio APIs. A build might
+look like this:
+
+```bash
+RUSTFLAGS="--cfg tokio_unstable" cargo build \
+    --release \
+    --no-default-features \
+    --features=rocksdb,systemd,element_hacks,sentry_telemetry,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,93 @@
+# 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

@@ -0,0 +1,20 @@
+# Testing
+
+## Complement
+
+Have a look at [Complement's repository][complement] for an explanation of what
+it is.
+
+To test against Complement, with [Lix][lix] and direnv installed and set up, you can:
+
+* Run `./bin/complement "$COMPLEMENT_SRC" ./path/to/logs.jsonl ./path/to/results.jsonl`
+  to build a Complement image, run the tests, and output the logs and results
+  to the specified paths. This will also output the OCI image at `result`
+* Run `nix build .#complement` from the root of the repository to just build a
+  Complement OCI image outputted to `result` (it's a `.tar.gz` file)
+* Or download the latest Complement OCI image from the CI workflow artifacts output
+  from the commit/revision you want to test (e.g. from main) [here][ci-workflows]
+
+[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,109 +1,160 @@
-#### **Note: This list is not up to date. There are rapidly more and more improvements, fixes, changes, etc being made that it is becoming more difficult to maintain this list. I recommend that you give Conduwuit a try and see the differences for yourself. If you have any concerns, feel free to join the Conduwuit Matrix room and ask any pre-usage questions.**
+#### **Note: This list may not up to date. There are rapidly more and more improvements, fixes, changes, etc being made that it is becoming more difficult to maintain this list. I recommend that you give conduwuit a try and see the differences for yourself. If you have any concerns, feel free to join the conduwuit Matrix room and ask any pre-usage questions.**
 
-### list of features, bug fixes, etc that conduwuit does that upstream does not:
+### list of features, bug fixes, etc that conduwuit does that Conduit does not:
 
-- GitLab CI ported to GitHub Actions
-- 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 and significantly updates all dependencies possible
-- Uses proper argon2 crate instead of questionable rust-argon2 crate
-- Improved and cleaned up logging (less noisy dead server logging, registration attempts, more useful troubleshooting logging, etc)
-- 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)
-- Merged and cleaned up upstream MRs that have been sitting for 6-12 months
-- Configurable RocksDB logging (`LOG` files) with proper defaults (rotate, max size, verbosity, etc) to stop LOG files from accumulating so much
-- Concurrency support for key fetching for faster remote room joins and room joins that will error less frequently (via upstream MR)
-- Room version 11 support (via upstream MR)
-- Explicit startup error/warning if your configuration allows open registration without a token or such like Synapse
-- Improved RocksDB defaults 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.
-- Revamped admin room infrastructure and commands (via upstream MR)
-- Admin room commands to delete room aliases and unpublish rooms from our room directory (via upstream MR)
-- Make spaces/hierarchy cache use cache_capacity_modifier instead of hardcoded small value
-- 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) (via upstream MR)
+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 (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)
-- Add support for querying both Matrix SRV records, the deprecated `_matrix` record and `_matrix-fed` record if necessary
+- Eliminate all usage of the thread-blocking `getaddrinfo(3)` call upon DNS queries, significantly improving federation latency/ping and cache DNS results (NXDOMAINs, successful queries, etc) using hickory-dns / hickory-resolver
+- Vastly improve RocksDB default settings to use new features that help with performance significantly, uses settings tailored to SSDs, various ways to tweak RocksDB, and a conduwuit setting to tell RocksDB to use settings that are tailored to HDDs or slow spinning rust storage or buggy filesystems.
+- Add a Cargo build profile for aggressive build-time performance optimisations for release builds (1 codegen unit, no debug, fat LTO, etc, and optimise all crates with same)
+- Implement database flush and cleanup conduwuit operations when using RocksDB
+- Implement RocksDB write buffer corking and coalescing in database write-heavy areas
+- Perform connection pooling and keepalives where necessary to significantly improve federation performance and latency
+- Various config options to tweak connection pooling, request timeouts, connection timeouts, DNS timeouts and settings, etc with good defaults which also help huge with performance via reusing connections and retrying where needed
+- Implement building conduwuit with jemalloc (which extends to the RocksDB jemalloc feature for maximum gains) or hardened_malloc light variant, and produce CI builds with jemalloc for performance (Nix doesn't seem to build [hardened_malloc-rs](https://github.com/girlbossceo/hardened_malloc-rs) properly)
+- Add support for caching DNS results with hickory-dns / hickory-resolver in conduwuit (not a replacement for a proper resolver cache, but still far better than nothing)
+- Add config option for using DNS over TCP, and config option for controlling A/AAAA record lookup strategy (e.g. don't query AAAA records if you don't have IPv6 connectivity)
+- Overall significant database, Client-Server, and federation performance and latency improvements (check out the ping room leaderboards if you don't believe me :>)
+- Add config options for RocksDB compression and bottommost compression, including choosing the algorithm and compression level
+- Use [loole](https://github.com/mahdi-shojaee/loole) MPSC channels instead of tokio MPSC channels for huge performance boosts in sending channels (mainly relevant for federation) and presence channels
+- Use `tracing`/`log`'s `release_max_level_info` feature to improve performance, build speeds, binary size, and CPU usage in release builds by avoid compiling debug/trace log level macros that users will generally never use (can be disabled with a build-time feature flag)
+- Enable RocksDB async read I/O via `io_uring` by default
+
+
+## General Fixes:
+- Raise and improve all the various request timeouts making some things like room joins and client bugs error less or none at all than they should, and make them all user configurable
+- Add missing `reason` field to user ban events (`/ban`)
+- Fixed spec compliance issue with room version 8 - 11 joins (https://github.com/matrix-org/synapse/issues/16717 / https://github.com/matrix-org/matrix-spec/issues/1708)
+- Safer and cleaner shutdowns on both database side as we run cleanup on shutdown and exits database loop better (no potential hanging issues in database loop), overall cleaner shutdown logic
+- Stop sending `make_join` requests on room joins if 15 servers respond with `M_UNSUPPORTED_ROOM_VERSION` or `M_INVALID_ROOM_VERSION`
+- Stop sending `make_join` requests if 50 servers cannot provide `make_join` for us
+- Respect *most* client parameters for `/media/` requests (`allow_redirect` still needs work)
+- Increased graceful shutdown timeout from a low 60 seconds to 180 seconds to avoid killing connections and let the remaining ones finish processing
+- Return joined member count of rooms for push rules/conditions instead of a hardcoded value of 10
+- Make `CONDUIT_CONFIG` optional, relevant for container users that configure only by environment variables and no longer need to set `CONDUIT_CONFIG` to an empty string.
+- Allow HEAD 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)
+- 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)
+
+
+## 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)
+- 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.
+- Support blocking servers from downloading remote media from, returning a 404
+- Don't allow `m.call.invite` events to be sent in public rooms (prevents calling the entire room)
+- On new public room creations, only allow moderators to send `m.call.invite`, `org.matrix.msc3401.call`, and `org.matrix.msc3401.call.member` events
+- Add support for a "global ACLs" feature (`forbidden_remote_server_names`) that blocks inbound remote room invites, room joins by room ID on server name, room joins by room alias on server name, incoming federated joins, and incoming federated room directory requests. This is very helpful for blocking servers that are purely toxic/bad and serve no value in allowing our users to suffer from things like room invite spam or such. Please note that this is not a substitute for room ACLs.
+- Add support for a config option to forbid our local users from sending federated room directory requests for (`forbidden_remote_room_directory_server_names`). Similar to above, useful for blocking servers that help prevent our users from wandering into bad areas of Matrix via room directories of those malicious servers.
+- Add config option for auto remediating/deactivating local non-admin users who attempt to join bad/forbidden rooms (`auto_deactivate_banned_room_attempts`)
+
+
+## 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
-- Add support for listening on a UNIX socket for performance and host security with proper default permissions (660)
-- Add missing `destination` key to all `X-Matrix` `Authorization` requests (spec compliance issue)
-- Use aggressive build-time performance optimisations for release builds (1 codegen unit, no debug, fat LTO, etc, and optimise all crates with same)
-- Raise various hardcoded timeouts in codebase that were way too short, making some things like room joins and client bugs error less or none at all than they should
-- Add debug admin command to force update user device lists (could potentially resolve some E2EE flukes) (`ForceDeviceListUpdates`)
-- Declare various missing Matrix versions and features at `/_matrix/client/versions`
-- Add support for serving server and client well-known files from conduwuit using `well_known_client` and `well_known_server` options
-- Send a User-Agent on all of our requests (`conduwuit/0.7.0-alpha+conduwuit-0.1.1`) which strangely was not done upstream since forever. Some providers consider no User-Agent suspicious and block said requests.
-- 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
-- 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)
-- Purge unmaintained/irrelevant/broken database backends (heed, sled, persy)
-- webp support for images
-- Support for suggesting servers to join at `/_matrix/client/v3/directory/room/{roomAlias}`
-- Prevent admin credential commands like reset password and deactivate user from modifying non-local users (https://gitlab.com/famedly/conduit/-/issues/377)
-- 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)
-- Add basic cache eviction for true destinations when requests fail if we use a cached destination (e.g. a server has modified their well-known and we're still connecting to the old destination)
+- Uses proper `argon2` crate by RustCrypto instead of questionable `rust-argon2` crate
 - Generate passwords with 25 characters instead of 15
-- Add missing `reason` field to user ban events (`/ban`)
-- 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.
-- Support blocking servers from downloading remote media from
-- Support sending `well_known` response to client logins if using config option `well_known_client`
-- Send `avatar_url` on invite room membership events/changes
-- Revamp example config, adding a lot of config options available (still some missing)
-- Return joined member count of rooms for push rules/conditions instead of a hardcoded value of 10
-- Respect *most* client parameters for `/media/` requests (`allow_redirect` still needs work)
 - Config option `ip_range_denylist` to support refusing to send requests (typically federation) to specific IP ranges, typically RFC 1918, non-routable, testnet, etc addresses like Synapse for security (note: this is not a guaranteed protection, and you should be using a firewall with zones if you want guaranteed protection as doing this on the application level is prone to bypasses).
-- Support for creating rooms with custom room IDs like Maunium Synapse (`room_id` request body field to `/createRoom`)
-- Assume well-knowns are broken if they exceed past 10000 characters.
-- Basic validation/checks on user-specified room aliases and custom room ID creations
+- 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
+- Sanitise file names for the `Content-Disposition` header for all media requests (thumbnails, downloads, uploads)
+- Return `inline` or `attachment` based on the detected file MIME type for the `Content-Disposition` and only allow images/videos/text/audio to be `inline`
+- Send secure default HTTP headers such as a strong restrictive CSP, deny iframes, disable `X-XSS-Protection`, disable interest cohort in `Permission-Policy`, etc to mitigate any potential attack surface such as from untrusted media
+
+
+## Administration/Logging:
+- Commandline argument to specify the path to a config file instead of relying on `CONDUIT_CONFIG`
+- 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 🏳️‍⚧️
+- Implement config option to auto join rooms upon registration
 - Warn on unknown config options specified
-- URL preview support (via upstream MR) with various improvements
-- Increased graceful shutdown timeout from a low 60 seconds to 180 seconds to avoid killing connections and let the remaining ones finish processing
-- 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 admin commands for banning (blocking) room IDs from our local users joining (admins are always allowed) and evicts all our local users from that room, in addition to bulk room banning support, and blocks room invites (remote and local) to the banned room, as a moderation feature
-- Add admin command to delete media via a specific MXC. This deletes the MXC from our database, and the file locally.
-- Replace the lightning bolt emoji option with support for setting any arbitrary text (e.g. another emoji) to suffix to all new user registrations
+- Add `/_conduwuit/server_version` route to return the version of conduwuit without relying on the federation API `/_matrix/federation/v1/version`
+- Add configurable RocksDB recovery modes to aid in recovering corrupted RocksDB databases
+- Support config options via `CONDUWUIT_` prefix and accessing non-global struct config options with the `__` split (e.g. `CONDUWUIT_WELL_KNOWN__SERVER`)
+- Add support for listening on multiple TCP ports
+- Disable update check by default as it's not useful for conduwuit
+- **Opt-in** Sentry.io telemetry and metrics, mainly used for crash reporting
+
+
+## Maintenance/Stability:
+- GitLab CI ported to GitHub Actions
+- Repo is mirrored to GitHub, GitLab, git.gay, git.girlcock.ceo, sourcehut, and Codeberg (see README.md for their links)
+- Docker container images published to GitLab Container Registry, GitHub Container Registry, and Dockerhub
+- Extensively revamp the example config to be extremely helpful and useful to both new users and power users
+- Fixed every single clippy (default lints) and rustc warnings, including some that were performance related or potential safety issues / unsoundness
+- Add a **lot** of other clippy and rustc lints and a rustfmt.toml file
+- Has [Renovate](https://docs.renovatebot.com/), [Trivy](https://github.com/aquasecurity/trivy-action), and keeps ALL dependencies as up to date as possible
+- Attempts and interest in removing extreme and unnecessary panics/unwraps/expects that can lead to denial of service or such (upstream and upstream contributors want this unusual behaviour for some reason)
+- Purge unmaintained/irrelevant/broken database backends (heed, sled, persy) and other unnecessary code or overhead
+- webp support for images
+- Add cargo audit support to CI
+- CI tests with all features
+- Add timestamp by commit date support to building OCI images for keeping image build reproducibility and still have a meaningful "last modified date" for OCI image metadata
+- Update rusqlite/sqlite (not that you should be using it)
+- Startup check if conduwuit running in a container and is listening on 127.0.0.1 (generally containers are using NAT networking and 0.0.0.0 is the intended listening address)
+
+
+## Admin Room:
+- Fix admin room handler to not panic/crash if the admin room command response fails (e.g. too large message)
+- Add command to dynamically change conduwuit's tracing log level filter on the fly
+- Add admin command to fetch a server's `/.well-known/matrix/support` file
+- Add debug admin command to force update user device lists (could potentially resolve some E2EE flukes)
+- Implement **RocksDB online backups**, listing RocksDB backups, and listing database file counts all via admin commands
+- Add various database visibility commands such as being able to query the getters and iterators used in conduwuit, a very helpful online debugging utility
+- Forbid the admin room from being made public or world readable history
+- Add `!admin` as a way to call the admin bot
+- Extend clear cache admin command to support clearing more caches such as DNS and TLS name overrides
+- Admin debug command to send a federation request/ping to a server's `/_matrix/federation/v1/version` endpoint and measures the latency it took
 - 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` as a way to call the Conduit admin bot
-- Add support for listening on multiple TCP ports
 - 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
-- Config option to block non-admin users from sending room invites or receiving remote room invites. Admin users are still allowed.
-- Startup check if conduwuit running in a container and is listening on 127.0.0.1
-- 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.
-- 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.
-- Implement database flush and cleanup Conduit operations when using RocksDB
-- Implement legacy Matrix `/v1/` media endpoints that some clients and servers may still call
-- Commandline argument to specify the path to a config file
-- Admin debug command to fetch a PDU from a remote server and inserts it into our database/timeline
-- Update rusqlite/sqlite (not that you should be using it)
-- Disable update check by default as it's not useful for conduwuit
-- Config option to disable incoming remote read receipts if desired
-- Extend clear cache admin command to support clearing DNS and TLS name override caches
-- Responsive outgoing read receipt EDU support
-- Eliminate all usage of the thread-blocking `getaddrinfo(3)` call upon DNS queries, significantly improving federation latency/ping and cache DNS results using hickory-dns / hickory-resolver
-- Store the sender user with the MXC URL for all media uploads (`/upload`) (not for thumbnails or media requests which are unauthenticated)
-- Perform connection pooling and keepalives where necessary to significantly improve federation performance and latency
-- Implement RocksDB online backups via admin command
-- Implement RocksDB write buffer corking and coalescing in database write-heavy areas
-- Various config options to tweak connection pooling, request timeouts, connection timeouts, DNS timeouts and settings, etc with good defaults
-- Implement config option to auto join rooms upon registration
-- Overall significant database, Client-Server, and federation performance and latency improvements
-- Outgoing read receipt and private read receipt support (EDU)
-- Outgoing typing indicator support (EDU)
-- Outgoing and local presence support (EDU)
-- **Opt-in** Sentry.io telemetry and metrics, mainly used for crash reporting
-- Add `/_conduwuit/server_version` route to return the version of Conduwuit without relying on the federation API `/_matrix/federation/v1/version`
-- Add configurable RocksDB recovery modes to aid in recovering corrupte RocksDB database
-- Config option to forbid publishing rooms to the room directory (`lockdown_public_room_directory`) except for admins
-- 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
-- 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
-- Admin debug command to send a federation request/ping to a server's `/_matrix/federation/v1/version` endpoint and measures the latency it took
-- Implement building Conduwuit with jemalloc or hardened_malloc light variant, and produce CI builds with jemalloc or hardened_malloc, for performance and/or security
-- Significant RocksDB tuning and improvements tailored to maximising Conduwuit performance with RocksDB
-- Implement unstable MSC2666 support for querying mutual rooms with a user
-- Add admin command to fetch a server's `/.well-known/matrix/support` file
-- 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
-- Forbid the admin room from being made public
-- Fix admin room handler to not panic/crash if the admin room command response fails (e.g. too large message)
+- Add admin command to return a room's state
+- Admin debug command to fetch a PDU from a remote server and inserts it into our database/timeline as backfill
+- Add admin command to delete media via a specific MXC. This deletes the MXC from our database, and the file locally.
+- Add admin commands for banning (blocking) room IDs from our local users joining (admins are always allowed) and evicts all our local users from that room, in addition to bulk room banning support, and blocks room invites (remote and local) to the banned room, as a moderation feature
+- Add admin 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
+
+
+## Misc:
+- Support for creating rooms with custom room IDs like Maunium Synapse (`room_id` request body field to `/createRoom`)
+- Query parameter `?format=event|content` for returning either the room state event's content (default) for the full room state event on ` /_matrix/client/v3/rooms/{roomId}/state/{eventType}[/{stateKey}]` requests (see https://github.com/matrix-org/matrix-spec/issues/1047)
+- Add **optional** feature flag to use SHA256 key names for media instead of base64 to overcome filesystem file name length limitations (OS error file name too long)
+- Send a User-Agent on all of our requests
+- Send `avatar_url` on invite room membership events/changes
+- Support sending [`well_known` response to client login responses](https://spec.matrix.org/v1.10/client-server-api/#post_matrixclientv3login) if using config option `[well_known.client]`
 - Implement `include_state` search criteria support for `/search` requests (response now can include room states)
+- Declare various missing Matrix versions and features at `/_matrix/client/versions`
+- Implement legacy Matrix `/v1/` media endpoints that some clients and servers may still call
+- Config option to change Conduit's behaviour of homeserver key fetching (`query_trusted_key_servers_first`). This option sets whether conduwuit will query trusted notary key servers first before the individual homeserver(s), or vice versa which may help in joining certain rooms.
+- Implement unstable MSC2666 support for querying mutual rooms with a user
+- Assume well-knowns are broken if they exceed past 10000 characters.
+- Add support for the Matrix spec compliance test suite [Complement](https://github.com/matrix-org/complement/) via the Nix flake and various other fixes for it
+- Add support for listening on both HTTP and HTTPS if using direct TLS with conduwuit for usecases such as Complement
+- Implement running and diff'ing Complement results in CI
+- Interest in supporting other operating systems such as macOS, BSDs, and Windows, and getting them added into CI and doing builds for them
+- 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, 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 🏳️‍⚧️

docs/introduction.md

@@ -6,7 +6,7 @@ # 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?
 
@@ -14,4 +14,8 @@ #### How can I deploy my own?
 
 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,63 @@
+# 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.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` 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
+- Delete list of MXC URIs
+- Delete remote media in the past `N` seconds/minutes
+
+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.

docs/troubleshooting.md

@@ -0,0 +1,62 @@
+# 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.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.
+
+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.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
+
+#### "File name too long"
+
+If you are running into the "file name is too long" OS error for media requests, your filesystem cannot handle file name lengths >=255 characters. This is unfortuntely due to Conduit (upstream) using base64 for file name keys which is very problematic for some filesystems as the base64 input is untrusted and long file names or specific inputs can cause this. If you would like to avoid this, you may build conduwuit yourself with the `sha256_media` feature. **This will lose database compatibility with upstream**.
+
+## 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,55 @@
 # 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:
+
+```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:
 
 ```
-# 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 = ""
+turn_uris = ["turn:<your server domain>?transport=udp", "turn:<your server domain>?transport=tcp"]
+turn_secret = "<secret key from coturn configuration>"
 ```
 
-## Apply settings
+or append the following to the docker environment variables dependig on which configuration method you used earlier:
 
-Restart Conduit.
+```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 conduwuit 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 [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

@@ -78,14 +78,60 @@ RUSTDOCFLAGS="-D warnings" cargo doc \
 """
 
 [[task]]
-name = "cargo-clippy"
+name = "clippy/default"
 group = "lints"
-script = "cargo clippy --workspace --all-targets --all-features --color=always -- -D warnings"
+script = """
+cargo clippy \
+    --workspace \
+    --all-targets \
+    --color=always \
+    -- \
+    -D warnings
+"""
+
+[[task]]
+name = "clippy/all"
+group = "lints"
+script = """
+cargo clippy \
+    --workspace \
+    --all-targets \
+    --all-features \
+    --color=always \
+    -- \
+    -D warnings
+"""
+
+[[task]]
+name = "clippy/jemalloc"
+group = "lints"
+script = """
+cargo clippy \
+    --workspace \
+    --features jemalloc \
+    --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"
 
 [[task]]
 name = "cargo"
@@ -99,3 +145,15 @@ cargo test \
     -- \
     --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": 1707922053,
-        "narHash": "sha256-wSZjK+rOXn+UQiP1NbdNn5/UW6UcBxjvlqr2wh++MbM=",
+        "lastModified": 1711742460,
+        "narHash": "sha256-0O4v6e4a1toxXZ2gf5INhg4WPE5C5T+SVvsBt+45Mcc=",
         "owner": "zhaofengli",
         "repo": "attic",
-        "rev": "6eabc3f02fae3683bffab483e614bebfcd476b21",
+        "rev": "4dbdbee45728d8ce5788db6461aaaa89d98081f0",
         "type": "github"
       },
       "original": {
@@ -23,6 +23,23 @@
         "type": "github"
       }
     },
+    "complement": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1715700731,
+        "narHash": "sha256-cie+b5N/TQAFD8vF/XbqfyFJkFU0qUPDbtJQDm/TfQc=",
+        "owner": "matrix-org",
+        "repo": "complement",
+        "rev": "8587fb3cbe746754b2c883ff6c818ca4d987d0a5",
+        "type": "github"
+      },
+      "original": {
+        "owner": "matrix-org",
+        "ref": "main",
+        "repo": "complement",
+        "type": "github"
+      }
+    },
     "crane": {
       "inputs": {
         "nixpkgs": [
@@ -51,17 +68,17 @@
         ]
       },
       "locked": {
-        "lastModified": 1707685877,
-        "narHash": "sha256-XoXRS+5whotelr1rHiZle5t5hDg9kpguS5yk8c8qzOc=",
+        "lastModified": 1716569590,
+        "narHash": "sha256-5eDbq8TuXFGGO3mqJFzhUbt5zHVTf5zilQoyW5jnJwo=",
         "owner": "ipetkov",
         "repo": "crane",
-        "rev": "2c653e4478476a52c6aa3ac0495e4dea7449ea0e",
+        "rev": "109987da061a1bf452f435f1653c47511587d919",
         "type": "github"
       },
       "original": {
         "owner": "ipetkov",
+        "ref": "master",
         "repo": "crane",
-        "rev": "2c653e4478476a52c6aa3ac0495e4dea7449ea0e",
         "type": "github"
       }
     },
@@ -73,15 +90,16 @@
         "rust-analyzer-src": "rust-analyzer-src"
       },
       "locked": {
-        "lastModified": 1711606966,
-        "narHash": "sha256-nTaO7ZDL4D02dVC5ktqnXNiNuODBUHyE4qEcFjAUCQY=",
+        "lastModified": 1716359173,
+        "narHash": "sha256-pYcjP6Gy7i6jPWrjiWAVV0BCQp+DdmGaI/k65lBb/kM=",
         "owner": "nix-community",
         "repo": "fenix",
-        "rev": "aa45c3e901ea42d6633af083c0c555efaf948b17",
+        "rev": "b6fc5035b28e36a98370d0eac44f4ef3fd323df6",
         "type": "github"
       },
       "original": {
         "owner": "nix-community",
+        "ref": "main",
         "repo": "fenix",
         "type": "github"
       }
@@ -114,6 +132,7 @@
       },
       "original": {
         "owner": "edolstra",
+        "ref": "master",
         "repo": "flake-compat",
         "type": "github"
       }
@@ -147,10 +166,28 @@
       },
       "original": {
         "owner": "numtide",
+        "ref": "main",
         "repo": "flake-utils",
         "type": "github"
       }
     },
+    "liburing": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1716565485,
+        "narHash": "sha256-4R19aJNQYs6vb0/Hz4bWT56YN1P1DkFL/sxdE4Yj0CE=",
+        "owner": "axboe",
+        "repo": "liburing",
+        "rev": "b90c0e670a93caabbebe2d9e24ff85cece4cfe0e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "axboe",
+        "ref": "master",
+        "repo": "liburing",
+        "type": "github"
+      }
+    },
     "nix-filter": {
       "locked": {
         "lastModified": 1710156097,
@@ -162,17 +199,18 @@
       },
       "original": {
         "owner": "numtide",
+        "ref": "main",
         "repo": "nix-filter",
         "type": "github"
       }
     },
     "nixpkgs": {
       "locked": {
-        "lastModified": 1702539185,
-        "narHash": "sha256-KnIRG5NMdLIpEkZTnN5zovNYc0hhXjAgv6pfd5Z4c7U=",
+        "lastModified": 1711401922,
+        "narHash": "sha256-QoQqXoj8ClGo0sqD/qWKFWezgEwUL0SUh37/vY2jNhc=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "aa9d4729cbc99dabacb50e3994dcefb3ea0f7447",
+        "rev": "07262b18b97000d16a4bdb003418bd2fb067a932",
         "type": "github"
       },
       "original": {
@@ -184,11 +222,11 @@
     },
     "nixpkgs-stable": {
       "locked": {
-        "lastModified": 1702780907,
-        "narHash": "sha256-blbrBBXjjZt6OKTcYX1jpe9SRof2P9ZYWPzq22tzXAA=",
+        "lastModified": 1711460390,
+        "narHash": "sha256-akSgjDZL6pVHEfSE6sz1DNSXuYX6hq+P/1Z5IoYWs7E=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "1e2e384c5b7c50dbf8e9c441a9e58d85f408b01f",
+        "rev": "44733514b72e732bd49f5511bd0203dea9b9a434",
         "type": "github"
       },
       "original": {
@@ -200,11 +238,11 @@
     },
     "nixpkgs_2": {
       "locked": {
-        "lastModified": 1711523803,
-        "narHash": "sha256-UKcYiHWHQynzj6CN/vTcix4yd1eCu1uFdsuarupdCQQ=",
+        "lastModified": 1716330097,
+        "narHash": "sha256-8BO3B7e3BiyIDsaKA0tY8O88rClYRTjvAp66y+VBUeU=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "2726f127c15a4cc9810843b96cad73c7eb39e443",
+        "rev": "5710852ba686cc1fd0d3b8e22b3117d43ba374c2",
         "type": "github"
       },
       "original": {
@@ -214,25 +252,45 @@
         "type": "github"
       }
     },
+    "rocksdb": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1716773462,
+        "narHash": "sha256-5kUH+XK+2lbFfUgbxuNy3YMLHbp6scfWPdtc8za1wDM=",
+        "owner": "girlbossceo",
+        "repo": "rocksdb",
+        "rev": "c8a1450231e9c608edf535538dbe8ca1a8d2f3bc",
+        "type": "github"
+      },
+      "original": {
+        "owner": "girlbossceo",
+        "ref": "v9.2.1",
+        "repo": "rocksdb",
+        "type": "github"
+      }
+    },
     "root": {
       "inputs": {
         "attic": "attic",
+        "complement": "complement",
         "crane": "crane_2",
         "fenix": "fenix",
         "flake-compat": "flake-compat_2",
         "flake-utils": "flake-utils_2",
+        "liburing": "liburing",
         "nix-filter": "nix-filter",
-        "nixpkgs": "nixpkgs_2"
+        "nixpkgs": "nixpkgs_2",
+        "rocksdb": "rocksdb"
       }
     },
     "rust-analyzer-src": {
       "flake": false,
       "locked": {
-        "lastModified": 1711562745,
-        "narHash": "sha256-s/YOyBM0vumhkqCFi8CnV5imFlC5JJrGia8CmEXyQkM=",
+        "lastModified": 1716107283,
+        "narHash": "sha256-NJgrwLiLGHDrCia5AeIvZUHUY7xYGVryee0/9D3Ir1I=",
         "owner": "rust-lang",
         "repo": "rust-analyzer",
-        "rev": "ad51a17c627b4ca57f83f0dc1f3bb5f3f17e6d0b",
+        "rev": "21ec8f523812b88418b2bfc64240c62b3dd967bd",
         "type": "github"
       },
       "original": {

flake.nix

@@ -1,357 +1,105 @@
 {
   inputs = {
-    nixpkgs.url = "github:NixOS/nixpkgs?ref=nixos-unstable";
-    flake-utils.url = "github:numtide/flake-utils";
-    nix-filter.url = "github:numtide/nix-filter";
-    flake-compat = {
-      url = "github:edolstra/flake-compat";
-      flake = false;
-    };
-
-    fenix = {
-      url = "github:nix-community/fenix";
-      inputs.nixpkgs.follows = "nixpkgs";
-    };
-    crane = {
-      # Pin latest crane that's not affected by the following bugs:
-      #
-      # * <https://github.com/ipetkov/crane/issues/527#issuecomment-1978079140>
-      # * <https://github.com/toml-rs/toml/issues/691>
-      # * <https://github.com/toml-rs/toml/issues/267>
-      url = "github:ipetkov/crane?rev=2c653e4478476a52c6aa3ac0495e4dea7449ea0e";
-      inputs.nixpkgs.follows = "nixpkgs";
-    };
     attic.url = "github:zhaofengli/attic?ref=main";
+    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"; };
+    flake-compat = { url = "github:edolstra/flake-compat?ref=master"; flake = false; };
+    flake-utils.url = "github:numtide/flake-utils?ref=main";
+    nix-filter.url = "github:numtide/nix-filter?ref=main";
+    nixpkgs.url = "github:NixOS/nixpkgs?ref=nixos-unstable";
+    # https://github.com/girlbossceo/rocksdb/commit/db6df0b185774778457dabfcbd822cb81760cade
+    rocksdb = { url = "github:girlbossceo/rocksdb?ref=v9.2.1"; flake = false; };
+    liburing = { url = "github:axboe/liburing?ref=master"; flake = false; };
   };
 
-  outputs =
-    { self
-    , nixpkgs
-    , flake-utils
-    , nix-filter
-
-    , fenix
-    , crane
-    , ...
-    }: flake-utils.lib.eachDefaultSystem (system:
+  outputs = inputs:
+    inputs.flake-utils.lib.eachDefaultSystem (system:
     let
-      pkgsHost = nixpkgs.legacyPackages.${system};
-      allocator = null;
-
-      rocksdb' = pkgs:
-        let
-          version = "9.0.0";
-        in
-        (pkgs.rocksdb.overrideAttrs (old: {
-          inherit version;
-          src = pkgs.fetchFromGitHub {
-            owner = "girlbossceo";
-            repo = "rocksdb";
-            rev = "449768a833b79c267c584b5ab1d50e73db6faf9d";
-            hash = "sha256-MjmGfAlZ5WC2+hFH6nEUprqBjO8xiTQh2HJIqQ5mIg8=";
-          };
-        }));
-
-      # Nix-accessible `Cargo.toml`
-      cargoToml = builtins.fromTOML (builtins.readFile ./Cargo.toml);
+      pkgsHost = inputs.nixpkgs.legacyPackages.${system};
+      pkgsHostStatic = pkgsHost.pkgsStatic;
 
       # The Rust toolchain to use
-      toolchain = fenix.packages.${system}.fromToolchainFile {
+      toolchain = inputs.fenix.packages.${system}.fromToolchainFile {
         file = ./rust-toolchain.toml;
 
         # See also `rust-toolchain.toml`
-        sha256 = "sha256-SXRtAuO4IqNOQq+nLbrsDFbVk+3aVA8NNpSZsKlVH/8=";
+        sha256 = "sha256-+syqAd2kX8KVa8/U2gz3blIQTTsYYt3U63xBWaGOSc8";
       };
 
-      builder = pkgs:
-        ((crane.mkLib pkgs).overrideToolchain toolchain).buildPackage;
+      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);
+        inherit inputs;
+        main = self.callPackage ./nix/pkgs/main {};
+        oci-image = self.callPackage ./nix/pkgs/oci-image {};
+        rocksdb = pkgs.rocksdb.overrideAttrs (old: {
+          src = inputs.rocksdb;
+          version = pkgs.lib.removePrefix
+            "v"
+            (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;
 
-      nativeBuildInputs = pkgs: [
-        # 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.
-        pkgs.pkgsBuildHost.rustPlatform.bindgenHook
-      ];
-
-      env = pkgs: {
-        CONDUIT_VERSION_EXTRA = self.shortRev or self.dirtyShortRev;
-        ROCKSDB_INCLUDE_DIR = "${rocksdb' pkgs}/include";
-        ROCKSDB_LIB_DIR = "${rocksdb' pkgs}/lib";
-      }
-      // pkgs.lib.optionalAttrs pkgs.stdenv.hostPlatform.isStatic {
-        ROCKSDB_STATIC = "";
-      }
-      // {
-        CARGO_BUILD_RUSTFLAGS = let inherit (pkgs) lib stdenv; in
-          lib.concatStringsSep " " ([ ]
-            ++ lib.optionals
-            # This disables PIE for static builds, which isn't great in terms
-            # of security. Unfortunately, my hand is forced because nixpkgs'
-            # `libstdc++.a` is built without `-fPIE`, which precludes us from
-            # leaving PIE enabled.
-            stdenv.hostPlatform.isStatic
-            [ "-C" "relocation-model=static" ]
-            ++ lib.optionals
-            (stdenv.buildPlatform.config != stdenv.hostPlatform.config)
-            [ "-l" "c" ]
-            ++ lib.optionals
-            # This check has to match the one [here][0]. We only need to set
-            # these flags when using a different linker. Don't ask me why,
-            # though, because I don't know. All I know is it breaks otherwise.
+          postInstall = old.postInstall + ''
+            # we remove the extra outputs
             #
-            # [0]: https://github.com/NixOS/nixpkgs/blob/5cdb38bb16c6d0a38779db14fcc766bc1b2394d6/pkgs/build-support/rust/lib/default.nix#L37-L40
-            (
-              # Nixpkgs doesn't check for x86_64 here but we do, because I
-              # observed a failure building statically for x86_64 without
-              # including it here. Linkers are weird.
-              (stdenv.hostPlatform.isAarch64 || stdenv.hostPlatform.isx86_64)
-                && stdenv.hostPlatform.isStatic
-                && !stdenv.isDarwin
-                && !stdenv.cc.bintools.isLLVM
-            )
-            [
-              "-l"
-              "stdc++"
-              "-L"
-              "${stdenv.cc.cc.lib}/${stdenv.hostPlatform.config}/lib"
-            ]
-          );
-      }
-
-      # What follows is stolen from [here][0]. Its purpose is to properly
-      # configure compilers and linkers for various stages of the build, and
-      # even covers the case of build scripts that need native code compiled and
-      # run on the build platform (I think).
-      #
-      # [0]: https://github.com/NixOS/nixpkgs/blob/5cdb38bb16c6d0a38779db14fcc766bc1b2394d6/pkgs/build-support/rust/lib/default.nix#L57-L80
-      // (
-        let
-          inherit (pkgs.rust.lib) envVars;
-        in
-        pkgs.lib.optionalAttrs
-          (pkgs.stdenv.targetPlatform.rust.rustcTarget
-            != pkgs.stdenv.hostPlatform.rust.rustcTarget)
-          (
-            let
-              inherit (pkgs.stdenv.targetPlatform.rust) cargoEnvVarTarget;
-            in
-            {
-              "CC_${cargoEnvVarTarget}" = envVars.ccForTarget;
-              "CXX_${cargoEnvVarTarget}" = envVars.cxxForTarget;
-              "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" =
-                envVars.linkerForTarget;
+            # 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"
             }
-          )
-        // (
-          let
-            inherit (pkgs.stdenv.hostPlatform.rust) cargoEnvVarTarget rustcTarget;
-          in
-          {
-            "CC_${cargoEnvVarTarget}" = envVars.ccForHost;
-            "CXX_${cargoEnvVarTarget}" = envVars.cxxForHost;
-            "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" = envVars.linkerForHost;
-            CARGO_BUILD_TARGET = rustcTarget;
-          }
-        )
-        // (
-          let
-            inherit (pkgs.stdenv.buildPlatform.rust) cargoEnvVarTarget;
-          in
-          {
-            "CC_${cargoEnvVarTarget}" = envVars.ccForBuild;
-            "CXX_${cargoEnvVarTarget}" = envVars.cxxForBuild;
-            "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" = envVars.linkerForBuild;
-            HOST_CC = "${pkgs.pkgsBuildHost.stdenv.cc}/bin/cc";
-            HOST_CXX = "${pkgs.pkgsBuildHost.stdenv.cc}/bin/c++";
-          }
-        )
-      );
+          '';
+        });
+      });
 
-      mkPackage = pkgs: allocator: builder pkgs {
-        src = nix-filter {
-          root = ./.;
-          include = [
-            "src"
-            "Cargo.toml"
-            "Cargo.lock"
-          ];
-        };
+      scopeHost = mkScope pkgsHost;
+      scopeHostStatic = mkScope pkgsHostStatic;
 
-        buildFeatures = [ ]
-          ++ (if allocator == "jemalloc" then [ "jemalloc" ] else [ ])
-          ++ (if allocator == "hmalloc" then [ "hardened_malloc" ] else [ ])
-        ;
-
-        rocksdb' = (if allocator == "jemalloc" then (pkgs.rocksdb.override { enableJemalloc = true; }) else (rocksdb' pkgs));
-
-        # This is redundant with CI
-        doCheck = false;
-
-        env = env pkgs;
-        nativeBuildInputs = nativeBuildInputs pkgs;
-
-        meta.mainProgram = cargoToml.package.name;
-      };
-
-      mkOciImage = pkgs: package: allocator:
-        pkgs.dockerTools.buildLayeredImage {
-          name = package.pname;
-          tag = "main";
-          # Debian makes builds reproducible through using the HEAD commit's date
-          created = "@${toString self.lastModified}";
-          contents = [
-            pkgs.dockerTools.caCertificates
-          ];
-          config = {
-            # Use the `tini` init system so that signals (e.g. ctrl+c/SIGINT)
-            # are handled as expected
-            Entrypoint = [
-              "${pkgs.lib.getExe' pkgs.tini "tini"}"
-              "--"
-            ];
-            Cmd = [
-              "${pkgs.lib.getExe package}"
-            ];
-          };
-        };
-    in
-    {
-      packages = {
-        default = mkPackage pkgsHost null;
-        jemalloc = mkPackage pkgsHost "jemalloc";
-        hmalloc = mkPackage pkgsHost "hmalloc";
-        oci-image = mkOciImage pkgsHost self.packages.${system}.default null;
-        oci-image-jemalloc = mkOciImage pkgsHost self.packages.${system}.default "jemalloc";
-        oci-image-hmalloc = mkOciImage pkgsHost self.packages.${system}.default "hmalloc";
-
-        book =
-          let
-            package = self.packages.${system}.default;
-          in
-          pkgsHost.stdenv.mkDerivation {
-            pname = "${package.pname}-book";
-            version = package.version;
-
-            src = nix-filter {
-              root = ./.;
-              include = [
-                "book.toml"
-                "conduwuit-example.toml"
-                "README.md"
-                "debian/README.md"
-                "docs"
-              ];
-            };
-
-            nativeBuildInputs = (with pkgsHost; [
-              mdbook
-            ]);
-
-            buildPhase = ''
-              mdbook build
-              mv public $out
-            '';
-          };
-      }
-      //
-      builtins.listToAttrs
-        (builtins.concatLists
-          (builtins.map
-            (crossSystem:
-              let
-                binaryName = "static-${crossSystem}";
-                pkgsCrossStatic =
-                  (import nixpkgs {
-                    inherit system;
-                    crossSystem = {
-                      config = crossSystem;
-                    };
-                  }).pkgsStatic;
-              in
-              [
-                # An output for a statically-linked binary
-                {
-                  name = binaryName;
-                  value = mkPackage pkgsCrossStatic null;
-                }
-
-                # An output for a statically-linked binary with jemalloc
-                {
-                  name = "${binaryName}-jemalloc";
-                  value = mkPackage pkgsCrossStatic "jemalloc";
-                }
-
-                # An output for a statically-linked binary with hardened_malloc
-                {
-                  name = "${binaryName}-hmalloc";
-                  value = mkPackage pkgsCrossStatic "hmalloc";
-                }
-
-                # An output for an OCI image based on that binary
-                {
-                  name = "oci-image-${crossSystem}";
-                  value = mkOciImage
-                    pkgsCrossStatic
-                    self.packages.${system}.${binaryName}
-                    null;
-                }
-
-                # An output for an OCI image based on that binary with jemalloc
-                {
-                  name = "oci-image-${crossSystem}-jemalloc";
-                  value = mkOciImage
-                    pkgsCrossStatic
-                    self.packages.${system}.${binaryName}
-                    "jemalloc";
-                }
-
-                # An output for an OCI image based on that binary with hardened_malloc
-                {
-                  name = "oci-image-${crossSystem}-hmalloc";
-                  value = mkOciImage
-                    pkgsCrossStatic
-                    self.packages.${system}.${binaryName}
-                    "hmalloc";
-                }
-              ]
-            )
-            [
-              "x86_64-unknown-linux-musl"
-              "x86_64-unknown-linux-musl-jemalloc"
-              "x86_64-unknown-linux-musl-hmalloc"
-              "aarch64-unknown-linux-musl"
-              "aarch64-unknown-linux-musl-jemalloc"
-              "aarch64-unknown-linux-musl-hmalloc"
-            ]
-          )
-        );
-
-      devShells.default = pkgsHost.mkShell {
-        env = env pkgsHost // {
+      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
-        nativeBuildInputs = nativeBuildInputs pkgsHost ++ [
+        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.
-          fenix.packages.${system}.latest.rustfmt
+          inputs.fenix.packages.${system}.latest.rustfmt
 
           toolchain
-        ] ++ (with pkgsHost; [
+        ]
+        ++ (with pkgsHost.pkgs; [
           engage
+          cargo-audit
 
           # Needed for producing Debian packages
           cargo-deb
 
           # Needed for Complement
           go
-          olm
 
           # Needed for our script for Complement
           jq
@@ -361,7 +109,95 @@
 
           # 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;
+        hmalloc = scopeHost.main.override { features = ["hardened_malloc"]; };
+
+        oci-image = scopeHost.oci-image;
+        oci-image-hmalloc = scopeHost.oci-image.override {
+          main = scopeHost.main.override {
+            features = ["hardened_malloc"];
+          };
+        };
+
+        book = scopeHost.book;
+
+        complement = scopeHost.complement;
+        static-complement = scopeHostStatic.complement;
+      }
+      //
+      builtins.listToAttrs
+        (builtins.concatLists
+          (builtins.map
+            (crossSystem:
+              let
+                binaryName = "static-${crossSystem}";
+                pkgsCrossStatic =
+                  (import inputs.nixpkgs {
+                    inherit system;
+                    crossSystem = {
+                      config = crossSystem;
+                    };
+                  }).pkgsStatic;
+                scopeCrossStatic = mkScope pkgsCrossStatic;
+              in
+              [
+                # An output for a statically-linked binary
+                {
+                  name = binaryName;
+                  value = scopeCrossStatic.main;
+                }
+
+                # An output for a statically-linked binary with hardened_malloc
+                {
+                  name = "${binaryName}-hmalloc";
+                  value = scopeCrossStatic.main.override {
+                    features = ["hardened_malloc"];
+                  };
+                }
+
+                # An output for an OCI image based on that binary
+                {
+                  name = "oci-image-${crossSystem}";
+                  value = scopeCrossStatic.oci-image;
+                }
+
+                # An output for an OCI image based on that binary with hardened_malloc
+                {
+                  name = "oci-image-${crossSystem}-hmalloc";
+                  value = scopeCrossStatic.oci-image.override {
+                    main = scopeCrossStatic.main.override {
+                      features = ["hardened_malloc"];
+                    };
+                  };
+                }
+              ]
+            )
+            [
+              "x86_64-unknown-linux-musl"
+              "aarch64-unknown-linux-musl"
+            ]
+          )
+        );
+
+      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

@@ -0,0 +1,33 @@
+{ inputs
+
+# Dependencies
+, main
+, mdbook
+, stdenv
+}:
+
+stdenv.mkDerivation {
+  inherit (main) pname version;
+
+  src = inputs.nix-filter {
+    root = inputs.self;
+    include = [
+      "book.toml"
+      "conduwuit-example.toml"
+      "CONTRIBUTING.md"
+      "README.md"
+      "debian/conduwuit.service"
+      "debian/README.md"
+      "docs"
+    ];
+  };
+
+  nativeBuildInputs = [
+    mdbook
+  ];
+
+  buildPhase = ''
+    mdbook build
+    mv public $out
+  '';
+}

nix/pkgs/complement/config.toml

@@ -0,0 +1,19 @@
+[global]
+address = "0.0.0.0"
+allow_device_name_federation = true
+allow_guest_registration = true
+allow_public_room_directory_over_federation = true
+allow_public_room_directory_without_auth = true
+allow_registration = true
+allow_unstable_room_versions = true
+database_backend = "rocksdb"
+database_path = "/database"
+log = "trace"
+port = [8008, 8448]
+trusted_servers = []
+yes_i_am_very_very_sure_i_want_an_open_registration_server_prone_to_abuse = true
+
+[global.tls]
+certs = "/certificate.crt"
+dual_protocol = true
+key = "/private_key.key"

nix/pkgs/complement/default.nix

@@ -0,0 +1,90 @@
+# Dependencies
+{ bashInteractive
+, buildEnv
+, coreutils
+, dockerTools
+, gawk
+, lib
+, main
+, openssl
+, stdenv
+, tini
+, writeShellScriptBin
+}:
+
+let
+  main' = main.override {
+    profile = "dev";
+    features = ["axum_dual_protocol"];
+  };
+
+  start = writeShellScriptBin "start" ''
+    set -euxo pipefail
+
+    ${lib.getExe openssl} genrsa -out private_key.key 2048
+    ${lib.getExe openssl} req \
+      -new \
+      -sha256 \
+      -key private_key.key \
+      -subj "/C=US/ST=CA/O=MyOrg, Inc./CN=$SERVER_NAME" \
+      -out signing_request.csr
+    cp ${./v3.ext} v3.ext
+    echo "DNS.1 = $SERVER_NAME" >> v3.ext
+    echo "IP.1 = $(${lib.getExe gawk} 'END{print $1}' /etc/hosts)" \
+      >> v3.ext
+    ${lib.getExe openssl} x509 \
+      -req \
+      -extfile v3.ext \
+      -in signing_request.csr \
+      -CA /complement/ca/ca.crt \
+      -CAkey /complement/ca/ca.key \
+      -CAcreateserial \
+      -out certificate.crt \
+      -days 1 \
+      -sha256
+
+    ${lib.getExe' coreutils "env"} \
+      CONDUWUIT_SERVER_NAME="$SERVER_NAME" \
+      ${lib.getExe main'}
+  '';
+in
+
+dockerTools.buildImage {
+  name = "complement-${main.pname}";
+  tag = "main";
+
+  copyToRoot = buildEnv {
+    name = "root";
+    pathsToLink = [
+      "/bin"
+    ];
+    paths = [
+      bashInteractive
+      coreutils
+      main'
+      start
+    ];
+  };
+
+  config = {
+    Cmd = [
+      "${lib.getExe start}"
+    ];
+
+    Entrypoint = if !stdenv.isDarwin
+      # Use the `tini` init system so that signals (e.g. ctrl+c/SIGINT)
+      # are handled as expected
+      then [ "${lib.getExe' tini "tini"}" "--" ]
+      else [];
+
+    Env = [
+      "SSL_CERT_FILE=/complement/ca/ca.crt"
+      "CONDUWUIT_CONFIG=${./config.toml}"
+    ];
+
+    ExposedPorts = {
+      "8008/tcp" = {};
+      "8448/tcp" = {};
+    };
+  };
+}

nix/pkgs/complement/v3.ext

@@ -0,0 +1,6 @@
+authorityKeyIdentifier=keyid,issuer
+basicConstraints=CA:FALSE
+keyUsage = digitalSignature, nonRepudiation, keyEncipherment, dataEncipherment
+subjectAltName = @alt_names
+
+[alt_names]

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

@@ -0,0 +1,100 @@
+{ lib
+, pkgsBuildHost
+, rust
+, stdenv
+}:
+
+lib.optionalAttrs stdenv.hostPlatform.isStatic {
+  ROCKSDB_STATIC = "";
+}
+//
+{
+  CARGO_BUILD_RUSTFLAGS =
+    lib.concatStringsSep
+      " "
+      ([]
+        # This disables PIE for static builds, which isn't great in terms
+        # of security. Unfortunately, my hand is forced because nixpkgs'
+        # `libstdc++.a` is built without `-fPIE`, which precludes us from
+        # leaving PIE enabled.
+        ++ lib.optionals
+          stdenv.hostPlatform.isStatic
+          [ "-C" "relocation-model=static" ]
+        ++ lib.optionals
+          (stdenv.buildPlatform.config != stdenv.hostPlatform.config)
+          [ "-l" "c" ]
+        ++ lib.optionals
+          # This check has to match the one [here][0]. We only need to set
+          # these flags when using a different linker. Don't ask me why,
+          # though, because I don't know. All I know is it breaks otherwise.
+          #
+          # [0]: https://github.com/NixOS/nixpkgs/blob/5cdb38bb16c6d0a38779db14fcc766bc1b2394d6/pkgs/build-support/rust/lib/default.nix#L37-L40
+          (
+            # Nixpkgs doesn't check for x86_64 here but we do, because I
+            # observed a failure building statically for x86_64 without
+            # including it here. Linkers are weird.
+            (stdenv.hostPlatform.isAarch64 || stdenv.hostPlatform.isx86_64)
+              && stdenv.hostPlatform.isStatic
+              && !stdenv.isDarwin
+              && !stdenv.cc.bintools.isLLVM
+          )
+          [
+            "-l"
+            "stdc++"
+            "-L"
+            "${stdenv.cc.cc.lib}/${stdenv.hostPlatform.config}/lib"
+          ]
+      );
+}
+
+# What follows is stolen from [here][0]. Its purpose is to properly
+# configure compilers and linkers for various stages of the build, and
+# even covers the case of build scripts that need native code compiled and
+# run on the build platform (I think).
+#
+# [0]: https://github.com/NixOS/nixpkgs/blob/5cdb38bb16c6d0a38779db14fcc766bc1b2394d6/pkgs/build-support/rust/lib/default.nix#L57-L80
+//
+(
+  let
+    inherit (rust.lib) envVars;
+  in
+  lib.optionalAttrs
+    (stdenv.targetPlatform.rust.rustcTarget
+      != stdenv.hostPlatform.rust.rustcTarget)
+    (
+      let
+        inherit (stdenv.targetPlatform.rust) cargoEnvVarTarget;
+      in
+      {
+        "CC_${cargoEnvVarTarget}" = envVars.ccForTarget;
+        "CXX_${cargoEnvVarTarget}" = envVars.cxxForTarget;
+        "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" =
+          envVars.linkerForTarget;
+      }
+    )
+  //
+  (
+    let
+      inherit (stdenv.hostPlatform.rust) cargoEnvVarTarget rustcTarget;
+    in
+    {
+      "CC_${cargoEnvVarTarget}" = envVars.ccForHost;
+      "CXX_${cargoEnvVarTarget}" = envVars.cxxForHost;
+      "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" = envVars.linkerForHost;
+      CARGO_BUILD_TARGET = rustcTarget;
+    }
+  )
+  //
+  (
+    let
+      inherit (stdenv.buildPlatform.rust) cargoEnvVarTarget;
+    in
+    {
+      "CC_${cargoEnvVarTarget}" = envVars.ccForBuild;
+      "CXX_${cargoEnvVarTarget}" = envVars.cxxForBuild;
+      "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" = envVars.linkerForBuild;
+      HOST_CC = "${pkgsBuildHost.stdenv.cc}/bin/cc";
+      HOST_CXX = "${pkgsBuildHost.stdenv.cc}/bin/c++";
+    }
+  )
+)

nix/pkgs/main/default.nix

@@ -0,0 +1,181 @@
+# 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.
+workspaceMembers = builtins.map (member: "${inputs.self}/src/${member}")
+  (builtins.attrNames (builtins.readDir "${inputs.self}/src"));
+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 = lib.unique
+  (lib.flatten (builtins.map crateDefaultFeatures workspaceMembers));
+allFeatures = lib.unique
+  (lib.flatten (builtins.map crateFeatures workspaceMembers));
+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 {
+      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";
+  }
+  //
+  (import ./cross-compilation-env.nix {
+    # Keep sorted
+    inherit
+      lib
+      pkgsBuildHost
+      rust
+      stdenv;
+  });
+
+buildPackageEnv = {
+  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
+    (craneLib.crateNameFromCargoToml {
+      cargoToml = "${inputs.self}/Cargo.toml";
+    })
+    pname
+    version;
+
+    src = let filter = inputs.nix-filter.lib; in filter {
+      root = inputs.self;
+
+      # Keep sorted
+      include = [
+        "Cargo.lock"
+        "Cargo.toml"
+        "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 [
+      # 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
+
+craneLib.buildPackage ( commonAttrs // {
+  cargoArtifacts = craneLib.buildDepsOnly (commonAttrs // {
+    env = buildDepsOnlyEnv;
+  });
+
+  cargoExtraArgs = "--no-default-features "
+    + lib.optionalString
+      (features'' != [])
+      "--features " + (builtins.concatStringsSep "," features'');
+
+  # This is redundant with CI
+  cargoTestCommand = "";
+  cargoCheckCommand = "";
+  doCheck = false;
+
+  env = buildPackageEnv;
+
+  passthru = {
+    env = buildPackageEnv;
+  };
+
+  meta.mainProgram = commonAttrs.pname;
+})

nix/pkgs/oci-image/default.nix

@@ -0,0 +1,28 @@
+{ inputs
+
+# Dependencies
+, dockerTools
+, lib
+, main
+, stdenv
+, tini
+}:
+
+dockerTools.buildLayeredImage {
+  name = main.pname;
+  tag = "main";
+  created = "@${toString inputs.self.lastModified}";
+  contents = [
+    dockerTools.caCertificates
+  ];
+  config = {
+    Entrypoint = if !stdenv.isDarwin
+      # Use the `tini` init system so that signals (e.g. ctrl+c/SIGINT)
+      # are handled as expected
+      then [ "${lib.getExe' tini "tini"}" "--" ]
+      else [];
+    Cmd = [
+      "${lib.getExe main}"
+    ];
+  };
+}

renovate.json

@@ -12,5 +12,5 @@
   "nix": {
     "enabled": true
   },
-  "ignoreDeps": ["tower-http", "axum-server", "hyper", "axum", "http"]
+  "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.75.0"
+channel = "1.77.0"
 components = [
     # For rust-analyzer
     "rust-src",
@@ -20,4 +20,4 @@ targets = [
     "x86_64-unknown-linux-gnu",
     "x86_64-unknown-linux-musl",
     "aarch64-unknown-linux-musl",
-]
+]

src/admin/Cargo.toml

@@ -0,0 +1,63 @@
+[package]
+name = "conduit_admin"
+version.workspace = true
+edition.workspace = true
+
+[lib]
+path = "mod.rs"
+crate-type = [
+	"rlib",
+#	"dylib",
+]
+
+[features]
+default = [
+	"rocksdb",
+	"io_uring",
+	"jemalloc",
+	"zstd_compression",
+	"release_max_log_level",
+]
+
+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",
+]
+rocksdb = [
+	"dep:rust-rocksdb",
+]
+jemalloc = [
+	"rust-rocksdb/jemalloc",
+]
+io_uring = [
+	"rust-rocksdb/io-uring",
+]
+zstd_compression = [
+	"rust-rocksdb/zstd",
+]
+
+[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
+rust-rocksdb.optional = true
+rust-rocksdb.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/appservice_command.rs

@@ -0,0 +1,66 @@
+use ruma::{api::appservice::Registration, events::room::message::RoomMessageEventContent};
+
+use crate::{escape_html, services, Result};
+
+pub(crate) async fn register(body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	if body.len() > 2 && body[0].trim().starts_with("```") && body.last().unwrap().trim() == "```" {
+		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}"
+			))),
+		}
+	} else {
+		Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		))
+	}
+}
+
+pub(crate) 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(crate) 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 {}:\n\n```yaml\n{}\n```", appservice_identifier, config_str,);
+			let output_html = format!(
+				"Config for {}:\n\n<pre><code class=\"language-yaml\">{}</code></pre>",
+				escape_html(&appservice_identifier),
+				escape_html(&config_str),
+			);
+			Ok(RoomMessageEventContent::text_html(output, output_html))
+		},
+		None => Ok(RoomMessageEventContent::text_plain("Appservice does not exist.")),
+	}
+}
+
+pub(crate) 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

@@ -0,0 +1,52 @@
+use clap::Subcommand;
+use conduit::Result;
+use ruma::events::room::message::RoomMessageEventContent;
+
+use self::appservice_command::{list, register, show, unregister};
+
+pub(crate) mod appservice_command;
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+pub(crate) enum AppserviceCommand {
+	/// - Register an appservice using its registration YAML
+	///
+	/// This command needs a YAML generated by an appservice (such as a bridge),
+	/// which must be provided in a Markdown code block below the command.
+	///
+	/// Registering a new bridge using the ID of an existing bridge will replace
+	/// the old one.
+	Register,
+
+	/// - Unregister an appservice using its ID
+	///
+	/// You can find the ID using the `list-appservices` command.
+	Unregister {
+		/// The appservice to unregister
+		appservice_identifier: String,
+	},
+
+	/// - Show an appservice's config using its ID
+	///
+	/// You can find the ID using the `list-appservices` command.
+	Show {
+		/// The appservice to show
+		appservice_identifier: String,
+	},
+
+	/// - List all the currently registered appservices
+	List,
+}
+
+pub(crate) async fn process(command: AppserviceCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	Ok(match command {
+		AppserviceCommand::Register => register(body).await?,
+		AppserviceCommand::Unregister {
+			appservice_identifier,
+		} => unregister(body, appservice_identifier).await?,
+		AppserviceCommand::Show {
+			appservice_identifier,
+		} => show(body, appservice_identifier).await?,
+		AppserviceCommand::List => list(body).await?,
+	})
+}

src/admin/debug/debug_commands.rs

@@ -0,0 +1,468 @@
+use std::{collections::BTreeMap, sync::Arc, time::Instant};
+
+use conduit::{utils::HtmlEscape, Error, Result};
+use ruma::{
+	api::client::error::ErrorKind, events::room::message::RoomMessageEventContent, CanonicalJsonObject, EventId,
+	RoomId, RoomVersionId, ServerName,
+};
+use service::{rooms::event_handler::parse_incoming_pdu, sending::send::resolve_actual_dest, services, PduEvent};
+use tokio::sync::RwLock;
+use tracing::{debug, info, warn};
+use tracing_subscriber::EnvFilter;
+
+pub(crate) 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(crate) async fn parse_pdu(body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	if body.len() > 2 && body[0].trim().starts_with("```") && body.last().unwrap().trim() == "```" {
+		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}"
+			))),
+		}
+	} else {
+		Ok(RoomMessageEventContent::text_plain("Expected code block in command body."))
+	}
+}
+
+pub(crate) 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::text_html(
+				format!(
+					"{}\n```json\n{}\n```",
+					if outlier {
+						"Outlier PDU found in our database"
+					} else {
+						"PDU found in our database"
+					},
+					json_text
+				),
+				format!(
+					"<p>{}</p>\n<pre><code class=\"language-json\">{}\n</code></pre>\n",
+					if outlier {
+						"Outlier PDU found in our database"
+					} else {
+						"PDU found in our database"
+					},
+					HtmlEscape(&json_text)
+				),
+			))
+		},
+		None => Ok(RoomMessageEventContent::text_plain("PDU not found locally.")),
+	}
+}
+
+pub(crate) 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.",
+		));
+	}
+
+	if body.len() > 2 && body[0].trim().starts_with("```") && body.last().unwrap().trim() == "```" {
+		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 {
+					warn!(%e, "Failed to get remote PDU, ignoring error");
+				}
+			} else {
+				get_remote_pdu(Vec::new(), Box::from(pdu), server.clone()).await?;
+			}
+		}
+
+		return Ok(RoomMessageEventContent::text_plain("Fetched list of remote PDUs."));
+	}
+
+	Ok(RoomMessageEventContent::text_plain(
+		"Expected code block in command body. Add --help for details.",
+	))
+}
+
+pub(crate) 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::text_html(
+				format!(
+					"{}\n```json\n{}\n```",
+					"Got PDU from specified server and handled as backfilled PDU successfully. Event body:", json_text
+				),
+				format!(
+					"<p>{}</p>\n<pre><code class=\"language-json\">{}\n</code></pre>\n",
+					"Got PDU from specified server and handled as backfilled PDU successfully. Event body:",
+					HtmlEscape(&json_text)
+				),
+			))
+		},
+		Err(e) => Ok(RoomMessageEventContent::text_plain(format!(
+			"Remote server did not have PDU or failed sending request to remote server: {e}"
+		))),
+	}
+}
+
+pub(crate) async fn get_room_state(_body: Vec<&str>, room_id: Box<RoomId>) -> Result<RoomMessageEventContent> {
+	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_text = 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::text_html(
+		format!("{}\n```json\n{}\n```", "Found full room state", json_text),
+		format!(
+			"<p>{}</p>\n<pre><code class=\"language-json\">{}\n</code></pre>\n",
+			"Found full room state",
+			HtmlEscape(&json_text)
+		),
+	))
+}
+
+pub(crate) 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::text_html(
+					format!("Got response which took {ping_time:?} time:\n```json\n{json}\n```"),
+					format!(
+						"<p>Got response which took {ping_time:?} time:</p>\n<pre><code \
+						 class=\"language-json\">{}\n</code></pre>\n",
+						HtmlEscape(&json)
+					),
+				));
+			}
+
+			Ok(RoomMessageEventContent::text_plain(format!(
+				"Got non-JSON response which took {ping_time:?} time:\n{0:?}",
+				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(crate) 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(crate) 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
+			.tracing_reload_handle
+			.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
+			.tracing_reload_handle
+			.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(crate) async fn sign_json(body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	if body.len() > 2 && body[0].trim().starts_with("```") && body.last().unwrap().trim() == "```" {
+		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}"))),
+		}
+	} else {
+		Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		))
+	}
+}
+
+pub(crate) async fn verify_json(body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	if body.len() > 2 && body[0].trim().starts_with("```") && body.last().unwrap().trim() == "```" {
+		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}"))),
+		}
+	} else {
+		Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		))
+	}
+}
+
+pub(crate) 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 (actual_dest, hostname_uri) = resolve_actual_dest(&server_name, no_cache).await?;
+
+	Ok(RoomMessageEventContent::text_plain(format!(
+		"Actual destination: {actual_dest:?} | Hostname URI: {hostname_uri}"
+	)))
+}
+
+#[must_use]
+pub(crate) 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

@@ -0,0 +1,161 @@
+use clap::Subcommand;
+use ruma::{events::room::message::RoomMessageEventContent, EventId, RoomId, ServerName};
+
+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;
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+pub(crate) enum DebugCommand {
+	/// - Get the auth_chain of a PDU
+	GetAuthChain {
+		/// An event ID (the $ character followed by the base64 reference hash)
+		event_id: Box<EventId>,
+	},
+
+	/// - Parse and print a PDU from a JSON
+	///
+	/// The PDU event is only checked for validity and is not added to the
+	/// database.
+	///
+	/// This command needs a JSON blob provided in a Markdown code block below
+	/// the command.
+	ParsePdu,
+
+	/// - Retrieve and print a PDU by ID from the conduwuit database
+	GetPdu {
+		/// An event ID (a $ followed by the base64 reference hash)
+		event_id: Box<EventId>,
+	},
+
+	/// - Attempts to retrieve a PDU from a remote server. Inserts it into our
+	/// database/timeline if found and we do not have this PDU already
+	/// (following normal event auth rules, handles it as an incoming PDU).
+	GetRemotePdu {
+		/// An event ID (a $ followed by the base64 reference hash)
+		event_id: Box<EventId>,
+
+		/// Argument for us to attempt to fetch the event from the
+		/// specified remote server.
+		server: Box<ServerName>,
+	},
+
+	/// Same as `get-remote-pdu` but accepts a codeblock newline delimited list
+	/// of PDUs and a single server to fetch from
+	GetRemotePduList {
+		/// Argument for us to attempt to fetch all the events from the
+		/// specified remote server.
+		server: Box<ServerName>,
+
+		/// If set, ignores errors, else stops at the first error/failure.
+		#[arg(short, long)]
+		force: bool,
+	},
+
+	/// - Gets all the room state events for the specified room.
+	///
+	/// This is functionally equivalent to `GET
+	/// /_matrix/client/v3/rooms/{roomid}/state`, except the admin command does
+	/// *not* check if the sender user is allowed to see state events. This is
+	/// done because it's implied that server admins here have database access
+	/// and can see/get room info themselves anyways if they were malicious
+	/// admins.
+	///
+	/// Of course the check is still done on the actual client API.
+	GetRoomState {
+		/// Room ID
+		room_id: Box<RoomId>,
+	},
+
+	/// - Sends a federation request to the remote server's
+	///   `/_matrix/federation/v1/version` endpoint and measures the latency it
+	///   took for the server to respond
+	Ping {
+		server: Box<ServerName>,
+	},
+
+	/// - Forces device lists for all local and remote users to be updated (as
+	///   having new keys available)
+	ForceDeviceListUpdates,
+
+	/// - Change tracing log level/filter on the fly
+	///
+	/// This accepts the same format as the `log` config option.
+	ChangeLogLevel {
+		/// Log level/filter
+		filter: Option<String>,
+
+		/// Resets the log level/filter to the one in your config
+		#[arg(short, long)]
+		reset: bool,
+	},
+
+	/// - Verify json signatures
+	///
+	/// This command needs a JSON blob provided in a Markdown code block below
+	/// the command.
+	SignJson,
+
+	/// - Verify json signatures
+	///
+	/// This command needs a JSON blob provided in a Markdown code block below
+	/// the command.
+	VerifyJson,
+
+	/// - Runs a server name through conduwuit's true destination resolution
+	///   process
+	///
+	/// Useful for debugging well-known issues
+	ResolveTrueDestination {
+		server_name: Box<ServerName>,
+
+		#[arg(short, long)]
+		no_cache: bool,
+	},
+
+	/// - Print extended memory usage
+	MemoryStats,
+}
+
+pub(crate) async fn process(command: DebugCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	Ok(match command {
+		DebugCommand::GetAuthChain {
+			event_id,
+		} => get_auth_chain(body, event_id).await?,
+		DebugCommand::ParsePdu => parse_pdu(body).await?,
+		DebugCommand::GetPdu {
+			event_id,
+		} => get_pdu(body, event_id).await?,
+		DebugCommand::GetRemotePdu {
+			event_id,
+			server,
+		} => get_remote_pdu(body, event_id, server).await?,
+		DebugCommand::GetRoomState {
+			room_id,
+		} => get_room_state(body, room_id).await?,
+		DebugCommand::Ping {
+			server,
+		} => ping(body, server).await?,
+		DebugCommand::ForceDeviceListUpdates => force_device_list_updates(body).await?,
+		DebugCommand::ChangeLogLevel {
+			filter,
+			reset,
+		} => change_log_level(body, filter, reset).await?,
+		DebugCommand::SignJson => sign_json(body).await?,
+		DebugCommand::VerifyJson => verify_json(body).await?,
+		DebugCommand::GetRemotePduList {
+			server,
+			force,
+		} => get_remote_pdu_list(body, server, force).await?,
+		DebugCommand::ResolveTrueDestination {
+			server_name,
+			no_cache,
+		} => resolve_true_destination(body, server_name, no_cache).await?,
+		DebugCommand::MemoryStats => memory_stats(),
+	})
+}

src/admin/federation/federation_commands.rs

@@ -0,0 +1,130 @@
+use std::fmt::Write;
+
+use ruma::{events::room::message::RoomMessageEventContent, OwnedRoomId, RoomId, ServerName, UserId};
+
+use crate::{escape_html, get_room_info, services, utils::HtmlEscape, Result};
+
+pub(crate) 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> {
+	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;
+	let mut msg = format!("Handling {} incoming pdus:\n", map.len());
+
+	for (r, (e, i)) in map.iter() {
+		let elapsed = i.elapsed();
+		writeln!(msg, "{} {}: {}m{}s", r, e, elapsed.as_secs() / 60, elapsed.as_secs() % 60,)
+			.expect("should be able to write to string buffer");
+	}
+	Ok(RoomMessageEventContent::text_plain(&msg))
+}
+
+pub(crate) async fn fetch_support_well_known(
+	_body: Vec<&str>, server_name: Box<ServerName>,
+) -> Result<RoomMessageEventContent> {
+	let response = services()
+		.globals
+		.client
+		.default
+		.get(format!("https://{server_name}/.well-known/matrix/support"))
+		.send()
+		.await?;
+
+	let text = response.text().await?;
+
+	if text.is_empty() {
+		return Ok(RoomMessageEventContent::text_plain("Response text/body is empty."));
+	}
+
+	if text.len() > 1500 {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Response text/body is over 1500 characters, assuming no support well-known.",
+		));
+	}
+
+	let json: serde_json::Value = match serde_json::from_str(&text) {
+		Ok(json) => json,
+		Err(_) => {
+			return Ok(RoomMessageEventContent::text_plain("Response text/body is not valid JSON."));
+		},
+	};
+
+	let pretty_json: String = match serde_json::to_string_pretty(&json) {
+		Ok(json) => json,
+		Err(_) => {
+			return Ok(RoomMessageEventContent::text_plain("Response text/body is not valid JSON."));
+		},
+	};
+
+	Ok(RoomMessageEventContent::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)
+		),
+	))
+}
+
+pub(crate) 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.",
+		));
+	}
+
+	if !services().users.exists(&user_id)? {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Remote user does not exist in our database.",
+		));
+	}
+
+	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} shares with us:\n{}",
+		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} shares with \
+		 us</caption>\n<tr><th>id</th>\t<th>members</th>\t<th>name</th></tr>\n{}</table>",
+		rooms
+			.iter()
+			.fold(String::new(), |mut output, (id, members, name)| {
+				writeln!(
+					output,
+					"<tr><td>{}</td>\t<td>{}</td>\t<td>{}</td></tr>",
+					escape_html(id.as_ref()),
+					members,
+					escape_html(name)
+				)
+				.expect("should be able to write to string buffer");
+				output
+			})
+	);
+
+	Ok(RoomMessageEventContent::text_html(output_plain, output_html))
+}

src/admin/federation/mod.rs

@@ -0,0 +1,62 @@
+use clap::Subcommand;
+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;
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+pub(crate) enum FederationCommand {
+	/// - List all rooms we are currently handling an incoming pdu from
+	IncomingFederation,
+
+	/// - Disables incoming federation handling for a room.
+	DisableRoom {
+		room_id: Box<RoomId>,
+	},
+
+	/// - Enables incoming federation handling for a room again.
+	EnableRoom {
+		room_id: Box<RoomId>,
+	},
+
+	/// - Fetch `/.well-known/matrix/support` from the specified server
+	///
+	/// Despite the name, this is not a federation endpoint and does not go
+	/// through the federation / server resolution process as per-spec this is
+	/// supposed to be served at the server_name.
+	///
+	/// Respecting homeservers put this file here for listing administration,
+	/// moderation, and security inquiries. This command provides a way to
+	/// easily fetch that information.
+	FetchSupportWellKnown {
+		server_name: Box<ServerName>,
+	},
+
+	/// - Lists all the rooms we share/track with the specified *remote* user
+	RemoteUserInRooms {
+		user_id: Box<UserId>,
+	},
+}
+
+pub(crate) async fn process(command: FederationCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	Ok(match command {
+		FederationCommand::DisableRoom {
+			room_id,
+		} => disable_room(body, room_id).await?,
+		FederationCommand::EnableRoom {
+			room_id,
+		} => enable_room(body, room_id).await?,
+		FederationCommand::IncomingFederation => incoming_federeation(body).await?,
+		FederationCommand::FetchSupportWellKnown {
+			server_name,
+		} => fetch_support_well_known(body, server_name).await?,
+		FederationCommand::RemoteUserInRooms {
+			user_id,
+		} => remote_user_in_rooms(body, user_id).await?,
+	})
+}

src/admin/fsck/fsck_commands.rs

@@ -0,0 +1,26 @@
+use ruma::events::room::message::RoomMessageEventContent;
+
+use crate::{services, Result};
+
+/// 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> {
+	let timer = tokio::time::Instant::now();
+	let results = services().users.db.iter();
+	let query_time = timer.elapsed();
+
+	let users = results.collect::<Vec<_>>();
+
+	let total = users.len();
+	let err_count = users.iter().filter(|user| user.is_err()).count();
+	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
+	);
+
+	Ok(RoomMessageEventContent::notice_html(message, String::new()))
+}

src/admin/fsck/mod.rs

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

src/admin/handler.rs

@@ -0,0 +1,305 @@
+use std::sync::Arc;
+
+use clap::Parser;
+use regex::Regex;
+use ruma::{
+	events::{
+		relation::InReplyTo,
+		room::message::{Relation::Reply, RoomMessageEventContent},
+		TimelineEventType,
+	},
+	OwnedRoomId, OwnedUserId, ServerName, UserId,
+};
+use serde_json::value::to_raw_value;
+use tokio::sync::MutexGuard;
+use tracing::error;
+
+extern crate conduit_service as service;
+
+use conduit::{Error, Result};
+pub(crate) use service::admin::{AdminRoomEvent, Service};
+use service::{admin::HandlerResult, pdu::PduBuilder};
+
+use self::{fsck::FsckCommand, tester::TesterCommands};
+use crate::{
+	appservice, appservice::AppserviceCommand, debug, debug::DebugCommand, escape_html, federation,
+	federation::FederationCommand, fsck, media, media::MediaCommand, query, query::QueryCommand, room,
+	room::RoomCommand, server, server::ServerCommand, services, tester, user, user::UserCommand,
+};
+pub(crate) const PAGE_SIZE: usize = 100;
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Parser)]
+#[command(name = "@conduit:server.name:", 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 debugging things
+	Debug(DebugCommand),
+
+	#[command(subcommand)]
+	/// - Query all the database getters and iterators
+	Query(QueryCommand),
+
+	#[command(subcommand)]
+	/// - Query all the database getters and iterators
+	Fsck(FsckCommand),
+
+	#[command(subcommand)]
+	Tester(TesterCommands),
+}
+
+#[must_use]
+pub fn handle(event: AdminRoomEvent, room: OwnedRoomId, user: OwnedUserId) -> HandlerResult {
+	Box::pin(handle_event(event, room, user))
+}
+
+async fn handle_event(event: AdminRoomEvent, admin_room: OwnedRoomId, server_user: OwnedUserId) -> Result<()> {
+	let (mut message_content, reply) = match event {
+		AdminRoomEvent::SendMessage(content) => (content, None),
+		AdminRoomEvent::ProcessMessage(room_message, reply_id) => {
+			(process_admin_message(room_message).await, Some(reply_id))
+		},
+	};
+
+	let mutex_state = Arc::clone(
+		services()
+			.globals
+			.roomid_mutex_state
+			.write()
+			.await
+			.entry(admin_room.clone())
+			.or_default(),
+	);
+	let state_lock = mutex_state.lock().await;
+
+	if let Some(reply) = reply {
+		message_content.relates_to = Some(Reply {
+			in_reply_to: InReplyTo {
+				event_id: reply.into(),
+			},
+		});
+	}
+
+	let response_pdu = PduBuilder {
+		event_type: TimelineEventType::RoomMessage,
+		content: to_raw_value(&message_content).expect("event is valid, we just created it"),
+		unsigned: None,
+		state_key: None,
+		redacts: None,
+	};
+
+	if let Err(e) = services()
+		.rooms
+		.timeline
+		.build_and_append_pdu(response_pdu, &server_user, &admin_room, &state_lock)
+		.await
+	{
+		handle_response_error(&e, &admin_room, &server_user, &state_lock).await?;
+	}
+
+	Ok(())
+}
+
+async fn handle_response_error(
+	e: &Error, admin_room: &OwnedRoomId, server_user: &UserId, state_lock: &MutexGuard<'_, ()>,
+) -> Result<()> {
+	error!("Failed to build and append admin room response PDU: \"{e}\"");
+	let error_room_message = RoomMessageEventContent::text_plain(format!(
+		"Failed to build and append admin room PDU: \"{e}\"\n\nThe original admin command may have finished \
+		 successfully, but we could not return the output."
+	));
+
+	let response_pdu = PduBuilder {
+		event_type: TimelineEventType::RoomMessage,
+		content: to_raw_value(&error_room_message).expect("event is valid, we just created it"),
+		unsigned: None,
+		state_key: None,
+		redacts: None,
+	};
+
+	services()
+		.rooms
+		.timeline
+		.build_and_append_pdu(response_pdu, server_user, admin_room, state_lock)
+		.await?;
+
+	Ok(())
+}
+
+// Parse and process a message from the admin room
+async fn process_admin_message(room_message: String) -> RoomMessageEventContent {
+	let mut lines = room_message.lines().filter(|l| !l.trim().is_empty());
+	let command_line = lines.next().expect("each string has at least one line");
+	let body = lines.collect::<Vec<_>>();
+
+	let admin_command = match parse_admin_command(command_line) {
+		Ok(command) => command,
+		Err(error) => {
+			let server_name = services().globals.server_name();
+			let message = error.replace("server.name", server_name.as_str());
+			let html_message = usage_to_html(&message, server_name);
+
+			return RoomMessageEventContent::text_html(message, html_message);
+		},
+	};
+
+	match process_admin_command(admin_command, body).await {
+		Ok(reply_message) => reply_message,
+		Err(error) => {
+			let markdown_message = format!("Encountered an error while handling the command:\n```\n{error}\n```",);
+			let html_message = format!("Encountered an error while handling the command:\n<pre>\n{error}\n</pre>",);
+
+			RoomMessageEventContent::text_html(markdown_message, html_message)
+		},
+	}
+}
+
+// Parse chat messages from the admin room into an AdminCommand object
+fn parse_admin_command(command_line: &str) -> Result<AdminCommand, String> {
+	// Note: argv[0] is `@conduit:servername:`, which is treated as the main command
+	let mut argv = command_line.split_whitespace().collect::<Vec<_>>();
+
+	// 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;
+	}
+
+	AdminCommand::try_parse_from(argv).map_err(|error| error.to_string())
+}
+
+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::Fsck(command) => fsck::process(command, body).await?,
+		AdminCommand::Tester(command) => tester::process(command, body).await?,
+	};
+
+	Ok(reply_message_content)
+}
+
+// Utility to turn clap's `--help` text to HTML.
+fn usage_to_html(text: &str, server_name: &ServerName) -> String {
+	// Replace `@conduit:servername:-subcmdname` with `@conduit:servername:
+	// subcmdname`
+	let text = text.replace(&format!("@conduit:{server_name}:-"), &format!("@conduit:{server_name}: "));
+
+	// For the conduit admin room, subcommands become main commands
+	let text = text.replace("SUBCOMMAND", "COMMAND");
+	let text = text.replace("subcommand", "command");
+
+	// Escape option names (e.g. `<element-id>`) since they look like HTML tags
+	let text = escape_html(&text);
+
+	// Italicize the first line (command name and version text)
+	let re = Regex::new("^(.*?)\n").expect("Regex compilation should not fail");
+	let text = re.replace_all(&text, "<em>$1</em>\n");
+
+	// Unmerge wrapped lines
+	let text = text.replace("\n            ", "  ");
+
+	// Wrap option names in backticks. The lines look like:
+	//     -V, --version  Prints version information
+	// And are converted to:
+	// <code>-V, --version</code>: Prints version information
+	// (?m) enables multi-line mode for ^ and $
+	let re = Regex::new("(?m)^ {4}(([a-zA-Z_&;-]+(, )?)+)  +(.*)$").expect("Regex compilation should not fail");
+	let text = re.replace_all(&text, "<code>$1</code>: $4");
+
+	// Look for a `[commandbody]` tag. If it exists, use all lines below it that
+	// start with a `#` in the USAGE section.
+	let mut text_lines = text.lines().collect::<Vec<&str>>();
+	let mut command_body = String::new();
+
+	if let Some(line_index) = text_lines.iter().position(|line| *line == "[commandbody]") {
+		text_lines.remove(line_index);
+
+		while text_lines
+			.get(line_index)
+			.is_some_and(|line| line.starts_with('#'))
+		{
+			command_body += if text_lines[line_index].starts_with("# ") {
+				&text_lines[line_index][2..]
+			} else {
+				&text_lines[line_index][1..]
+			};
+			command_body += "[nobr]\n";
+			text_lines.remove(line_index);
+		}
+	}
+
+	let text = text_lines.join("\n");
+
+	// Improve the usage section
+	let text = if command_body.is_empty() {
+		// Wrap the usage line in code tags
+		let re = Regex::new("(?m)^USAGE:\n {4}(@conduit:.*)$").expect("Regex compilation should not fail");
+		re.replace_all(&text, "USAGE:\n<code>$1</code>").to_string()
+	} else {
+		// Wrap the usage line in a code block, and add a yaml block example
+		// This makes the usage of e.g. `register-appservice` more accurate
+		let re = Regex::new("(?m)^USAGE:\n {4}(.*?)\n\n").expect("Regex compilation should not fail");
+		re.replace_all(&text, "USAGE:\n<pre>$1[nobr]\n[commandbodyblock]</pre>")
+			.replace("[commandbodyblock]", &command_body)
+	};
+
+	// Add HTML line-breaks
+
+	text.replace("\n\n\n", "\n\n")
+		.replace('\n', "<br>\n")
+		.replace("[nobr]<br>", "")
+}

src/admin/media/media_commands.rs

@@ -0,0 +1,176 @@
+use ruma::{events::room::message::RoomMessageEventContent, EventId, MxcUri};
+use tracing::{debug, info};
+
+use crate::{services, Result};
+
+pub(crate) 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() {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Please specify either an MXC or an event ID, not both.",
+		));
+	}
+
+	if let Some(mxc) = mxc {
+		debug!("Got MXC URL: {mxc}");
+		services().media.delete(mxc.to_string()).await?;
+
+		return Ok(RoomMessageEventContent::text_plain(
+			"Deleted the MXC from our database and on our filesystem.",
+		));
+	} else if let Some(event_id) = event_id {
+		debug!("Got event ID to delete media from: {event_id}");
+
+		let mut mxc_urls = vec![];
+		let mut mxc_deletion_count = 0;
+
+		// parsing the PDU for any MXC URLs begins here
+		if let Some(event_json) = services().rooms.timeline.get_pdu_json(&event_id)? {
+			if let Some(content_key) = event_json.get("content") {
+				debug!("Event ID has \"content\".");
+				let content_obj = content_key.as_object();
+
+				if let Some(content) = content_obj {
+					// 1. attempts to parse the "url" key
+					debug!("Attempting to go into \"url\" key for main media file");
+					if let Some(url) = content.get("url") {
+						debug!("Got a URL in the event ID {event_id}: {url}");
+
+						if url.to_string().starts_with("\"mxc://") {
+							debug!("Pushing URL {url} to list of MXCs to delete");
+							let final_url = url.to_string().replace('"', "");
+							mxc_urls.push(final_url);
+						} else {
+							info!("Found a URL in the event ID {event_id} but did not start with mxc://, ignoring");
+						}
+					}
+
+					// 2. attempts to parse the "info" key
+					debug!("Attempting to go into \"info\" key for thumbnails");
+					if let Some(info_key) = content.get("info") {
+						debug!("Event ID has \"info\".");
+						let info_obj = info_key.as_object();
+
+						if let Some(info) = info_obj {
+							if let Some(thumbnail_url) = info.get("thumbnail_url") {
+								debug!("Found a thumbnail_url in info key: {thumbnail_url}");
+
+								if thumbnail_url.to_string().starts_with("\"mxc://") {
+									debug!("Pushing thumbnail URL {thumbnail_url} to list of MXCs to delete");
+									let final_thumbnail_url = thumbnail_url.to_string().replace('"', "");
+									mxc_urls.push(final_thumbnail_url);
+								} else {
+									info!(
+										"Found a thumbnail URL in the event ID {event_id} but did not start with \
+										 mxc://, ignoring"
+									);
+								}
+							} else {
+								info!("No \"thumbnail_url\" key in \"info\" key, assuming no thumbnails.");
+							}
+						}
+					}
+
+					// 3. attempts to parse the "file" key
+					debug!("Attempting to go into \"file\" key");
+					if let Some(file_key) = content.get("file") {
+						debug!("Event ID has \"file\".");
+						let file_obj = file_key.as_object();
+
+						if let Some(file) = file_obj {
+							if let Some(url) = file.get("url") {
+								debug!("Found url in file key: {url}");
+
+								if url.to_string().starts_with("\"mxc://") {
+									debug!("Pushing URL {url} to list of MXCs to delete");
+									let final_url = url.to_string().replace('"', "");
+									mxc_urls.push(final_url);
+								} else {
+									info!(
+										"Found a URL in the event ID {event_id} but did not start with mxc://, \
+										 ignoring"
+									);
+								}
+							} else {
+								info!("No \"url\" key in \"file\" key.");
+							}
+						}
+					}
+				} else {
+					return Ok(RoomMessageEventContent::text_plain(
+						"Event ID does not have a \"content\" key or failed parsing the event ID JSON.",
+					));
+				}
+			} else {
+				return Ok(RoomMessageEventContent::text_plain(
+					"Event ID does not have a \"content\" key, this is not a message or an event type that contains \
+					 media.",
+				));
+			}
+		} else {
+			return Ok(RoomMessageEventContent::text_plain(
+				"Event ID does not exist or is not known to us.",
+			));
+		}
+
+		if mxc_urls.is_empty() {
+			// we shouldn't get here (should have errored earlier) but just in case for
+			// whatever reason we do...
+			info!("Parsed event ID {event_id} but did not contain any MXC URLs.");
+			return Ok(RoomMessageEventContent::text_plain("Parsed event ID but found no MXC URLs."));
+		}
+
+		for mxc_url in mxc_urls {
+			services().media.delete(mxc_url).await?;
+			mxc_deletion_count += 1;
+		}
+
+		return Ok(RoomMessageEventContent::text_plain(format!(
+			"Deleted {mxc_deletion_count} total MXCs from our database and the filesystem from event ID {event_id}."
+		)));
+	}
+
+	Ok(RoomMessageEventContent::text_plain(
+		"Please specify either an MXC using --mxc or an event ID using --event-id of the message containing an image. \
+		 See --help for details.",
+	))
+}
+
+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().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.to_owned()).await?;
+			mxc_deletion_count = mxc_deletion_count
+				.checked_add(1)
+				.expect("mxc_deletion_count should not get this high");
+		}
+
+		return Ok(RoomMessageEventContent::text_plain(format!(
+			"Finished bulk MXC deletion, deleted {mxc_deletion_count} total MXCs from our database and the filesystem.",
+		)));
+	}
+
+	Ok(RoomMessageEventContent::text_plain(
+		"Expected code block in command body. Add --help for details.",
+	))
+}
+
+pub(crate) async fn delete_past_remote_media(_body: Vec<&str>, duration: String) -> Result<RoomMessageEventContent> {
+	let deleted_count = services()
+		.media
+		.delete_all_remote_media_at_after_time(duration)
+		.await?;
+
+	Ok(RoomMessageEventContent::text_plain(format!(
+		"Deleted {deleted_count} total files.",
+	)))
+}

src/admin/media/mod.rs

@@ -0,0 +1,49 @@
+use clap::Subcommand;
+use ruma::{events::room::message::RoomMessageEventContent, EventId, MxcUri};
+
+use self::media_commands::{delete, delete_list, delete_past_remote_media};
+use crate::Result;
+
+pub(crate) mod media_commands;
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+pub(crate) enum MediaCommand {
+	/// - Deletes a single media file from our database and on the filesystem
+	///   via a single MXC URL
+	Delete {
+		/// The MXC URL to delete
+		#[arg(long)]
+		mxc: Option<Box<MxcUri>>,
+
+		/// - The message event ID which contains the media and thumbnail MXC
+		///   URLs
+		#[arg(long)]
+		event_id: Option<Box<EventId>>,
+	},
+
+	/// - Deletes a codeblock list of MXC URLs from our database and on the
+	///   filesystem
+	DeleteList,
+
+	/// - Deletes all remote media in the last X amount of time using filesystem
+	///   metadata first created at date.
+	DeletePastRemoteMedia {
+		/// - The duration (at or after), e.g. "5m" to delete all media in the
+		///   past 5 minutes
+		duration: String,
+	},
+}
+
+pub(crate) async fn process(command: MediaCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	Ok(match command {
+		MediaCommand::Delete {
+			mxc,
+			event_id,
+		} => delete(body, mxc, event_id).await?,
+		MediaCommand::DeleteList => delete_list(body).await?,
+		MediaCommand::DeletePastRemoteMedia {
+			duration,
+		} => delete_past_remote_media(body, duration).await?,
+	})
+}

src/admin/mod.rs

@@ -0,0 +1,55 @@
+pub(crate) mod appservice;
+pub(crate) mod debug;
+pub(crate) mod federation;
+pub(crate) mod fsck;
+pub(crate) mod handler;
+pub(crate) mod media;
+pub(crate) mod query;
+pub(crate) mod room;
+pub(crate) mod server;
+pub(crate) mod tester;
+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

@@ -0,0 +1,50 @@
+use ruma::events::room::message::RoomMessageEventContent;
+
+use super::AccountData;
+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> {
+	match subcommand {
+		AccountData::ChangesSince {
+			user_id,
+			since,
+			room_id,
+		} => {
+			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
+				),
+			))
+		},
+		AccountData::Get {
+			user_id,
+			kind,
+			room_id,
+		} => {
+			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
+				),
+			))
+		},
+	}
+}

src/admin/query/appservice.rs

@@ -0,0 +1,41 @@
+use ruma::events::room::message::RoomMessageEventContent;
+
+use super::Appservice;
+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> {
+	match subcommand {
+		Appservice::GetRegistration {
+			appservice_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services()
+				.appservice
+				.db
+				.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
+				),
+			))
+		},
+		Appservice::All => {
+			let timer = tokio::time::Instant::now();
+			let results = services().appservice.db.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
+				),
+			))
+		},
+	}
+}

src/admin/query/globals.rs

@@ -0,0 +1,77 @@
+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(crate) 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::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
+				),
+			))
+		},
+		Globals::CurrentCount => {
+			let timer = tokio::time::Instant::now();
+			let results = services().globals.db.current_count();
+			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
+				),
+			))
+		},
+		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::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
+				),
+			))
+		},
+		Globals::LoadKeypair => {
+			let timer = tokio::time::Instant::now();
+			let results = services().globals.db.load_keypair();
+			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
+				),
+			))
+		},
+		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::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
+				),
+			))
+		},
+	}
+}

src/admin/query/mod.rs

@@ -0,0 +1,223 @@
+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;
+
+use clap::Subcommand;
+use ruma::{
+	events::{room::message::RoomMessageEventContent, RoomAccountDataEventType},
+	RoomAliasId, RoomId, ServerName, UserId,
+};
+
+use self::{
+	account_data::account_data, appservice::appservice, globals::globals, presence::presence, 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 {
+	/// - account_data.rs iterators and getters
+	#[command(subcommand)]
+	AccountData(AccountData),
+
+	/// - appservice.rs iterators and getters
+	#[command(subcommand)]
+	Appservice(Appservice),
+
+	/// - presence.rs iterators and getters
+	#[command(subcommand)]
+	Presence(Presence),
+
+	/// - rooms/alias.rs iterators and getters
+	#[command(subcommand)]
+	RoomAlias(RoomAlias),
+
+	/// - globals.rs iterators and getters
+	#[command(subcommand)]
+	Globals(Globals),
+
+	/// - sending.rs iterators and getters
+	#[command(subcommand)]
+	Sending(Sending),
+
+	/// - users.rs iterators and getters
+	#[command(subcommand)]
+	Users(Users),
+}
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+/// All the getters and iterators from src/database/key_value/account_data.rs
+pub(crate) enum AccountData {
+	/// - Returns all changes to the account data that happened after `since`.
+	ChangesSince {
+		/// Full user ID
+		user_id: Box<UserId>,
+		/// UNIX timestamp since (u64)
+		since: u64,
+		/// Optional room ID of the account data
+		room_id: Option<Box<RoomId>>,
+	},
+
+	/// - Searches the account data for a specific kind.
+	Get {
+		/// Full user ID
+		user_id: Box<UserId>,
+		/// Account data event type
+		kind: RoomAccountDataEventType,
+		/// Optional room ID of the account data
+		room_id: Option<Box<RoomId>>,
+	},
+}
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+/// All the getters and iterators from src/database/key_value/appservice.rs
+pub(crate) enum Appservice {
+	/// - Gets the appservice registration info/details from the ID as a string
+	GetRegistration {
+		/// Appservice registration ID
+		appservice_id: Box<str>,
+	},
+
+	/// - Gets all appservice registrations with their ID and registration info
+	All,
+}
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+/// All the getters and iterators from src/database/key_value/presence.rs
+pub(crate) enum Presence {
+	/// - Returns the latest presence event for the given user.
+	GetPresence {
+		/// Full user ID
+		user_id: Box<UserId>,
+	},
+
+	/// - Iterator of the most recent presence updates that happened after the
+	///   event with id `since`.
+	PresenceSince {
+		/// UNIX timestamp since (u64)
+		since: u64,
+	},
+}
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+/// All the getters and iterators from src/database/key_value/rooms/alias.rs
+pub(crate) enum RoomAlias {
+	ResolveLocalAlias {
+		/// Full room alias
+		alias: Box<RoomAliasId>,
+	},
+
+	/// - Iterator of all our local room aliases for the room ID
+	LocalAliasesForRoom {
+		/// Full room ID
+		room_id: Box<RoomId>,
+	},
+
+	/// - Iterator of all our local aliases in our database with their room IDs
+	AllLocalAliases,
+}
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+/// All the getters and iterators from src/database/key_value/globals.rs
+pub(crate) enum Globals {
+	DatabaseVersion,
+
+	CurrentCount,
+
+	LastCheckForUpdatesId,
+
+	LoadKeypair,
+
+	/// - This returns an empty `Ok(BTreeMap<..>)` when there are no keys found
+	///   for the server.
+	SigningKeysFor {
+		origin: Box<ServerName>,
+	},
+}
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+/// All the getters and iterators from src/database/key_value/sending.rs
+pub(crate) enum Sending {
+	/// - Queries database for all `servercurrentevent_data`
+	ActiveRequests,
+
+	/// - Queries database for `servercurrentevent_data` but for a specific
+	///   destination
+	///
+	/// This command takes only *one* format of these arguments:
+	///
+	/// appservice_id
+	/// server_name
+	/// user_id AND push_key
+	///
+	/// See src/service/sending/mod.rs for the definition of the `Destination`
+	/// enum
+	ActiveRequestsFor {
+		#[arg(short, long)]
+		appservice_id: Option<String>,
+		#[arg(short, long)]
+		server_name: Option<Box<ServerName>>,
+		#[arg(short, long)]
+		user_id: Option<Box<UserId>>,
+		#[arg(short, long)]
+		push_key: Option<String>,
+	},
+
+	/// - Queries database for `servernameevent_data` which are the queued up
+	///   requests that will eventually be sent
+	///
+	/// This command takes only *one* format of these arguments:
+	///
+	/// appservice_id
+	/// server_name
+	/// user_id AND push_key
+	///
+	/// See src/service/sending/mod.rs for the definition of the `Destination`
+	/// enum
+	QueuedRequests {
+		#[arg(short, long)]
+		appservice_id: Option<String>,
+		#[arg(short, long)]
+		server_name: Option<Box<ServerName>>,
+		#[arg(short, long)]
+		user_id: Option<Box<UserId>>,
+		#[arg(short, long)]
+		push_key: Option<String>,
+	},
+
+	GetLatestEduCount {
+		server_name: Box<ServerName>,
+	},
+}
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+/// All the getters and iterators from src/database/key_value/users.rs
+pub(crate) enum Users {
+	Iter,
+}
+
+/// Processes admin query commands
+pub(crate) 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::Globals(command) => globals(command).await?,
+		QueryCommand::Sending(command) => sending(command).await?,
+		QueryCommand::Users(command) => users(command).await?,
+	})
+}

src/admin/query/presence.rs

@@ -0,0 +1,42 @@
+use ruma::events::room::message::RoomMessageEventContent;
+
+use super::Presence;
+use crate::{services, Result};
+
+/// All the getters and iterators in key_value/presence.rs
+pub(crate) async fn presence(subcommand: Presence) -> Result<RoomMessageEventContent> {
+	match subcommand {
+		Presence::GetPresence {
+			user_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			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
+				),
+			))
+		},
+		Presence::PresenceSince {
+			since,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services().presence.db.presence_since(since);
+			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
+				),
+			))
+		},
+	}
+}

src/admin/query/room_alias.rs

@@ -0,0 +1,57 @@
+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(crate) async fn room_alias(subcommand: RoomAlias) -> Result<RoomMessageEventContent> {
+	match subcommand {
+		RoomAlias::ResolveLocalAlias {
+			alias,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services().rooms.alias.db.resolve_local_alias(&alias);
+			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
+				),
+			))
+		},
+		RoomAlias::LocalAliasesForRoom {
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services().rooms.alias.db.local_aliases_for_room(&room_id);
+			let query_time = timer.elapsed();
+
+			let aliases: Vec<_> = results.collect();
+
+			Ok(RoomMessageEventContent::text_html(
+				format!("Query completed in {query_time:?}:\n\n```\n{:?}```", aliases),
+				format!(
+					"<p>Query completed in {query_time:?}:</p>\n<pre><code>{:?}\n</code></pre>",
+					aliases
+				),
+			))
+		},
+		RoomAlias::AllLocalAliases => {
+			let timer = tokio::time::Instant::now();
+			let results = services().rooms.alias.db.all_local_aliases();
+			let query_time = timer.elapsed();
+
+			let aliases: Vec<_> = results.collect();
+
+			Ok(RoomMessageEventContent::text_html(
+				format!("Query completed in {query_time:?}:\n\n```\n{:?}```", aliases),
+				format!(
+					"<p>Query completed in {query_time:?}:</p>\n<pre><code>{:?}\n</code></pre>",
+					aliases
+				),
+			))
+		},
+	}
+}

src/admin/query/sending.rs

@@ -0,0 +1,204 @@
+use ruma::events::room::message::RoomMessageEventContent;
+
+use super::Sending;
+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> {
+	match subcommand {
+		Sending::ActiveRequests => {
+			let timer = tokio::time::Instant::now();
+			let results = services().sending.db.active_requests();
+			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
+				),
+			))
+		},
+		Sending::QueuedRequests {
+			appservice_id,
+			server_name,
+			user_id,
+			push_key,
+		} => {
+			if appservice_id.is_none() && server_name.is_none() && user_id.is_none() && push_key.is_none() {
+				return Ok(RoomMessageEventContent::text_plain(
+					"An appservice ID, server name, or a user ID with push key must be specified via arguments. See \
+					 --help for more details.",
+				));
+			}
+
+			let (results, query_time) = 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(
+							"An appservice ID, server name, or a user ID with push key must be specified via \
+							 arguments. See --help for more details.",
+						));
+					}
+
+					let timer = tokio::time::Instant::now();
+					let results = 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)
+				},
+				(None, None, Some(user_id), Some(push_key)) => {
+					if push_key.is_empty() {
+						return Ok(RoomMessageEventContent::text_plain(
+							"An appservice ID, server name, or a user ID with push key must be specified via \
+							 arguments. See --help for more details.",
+						));
+					}
+
+					let timer = tokio::time::Instant::now();
+					let results = services()
+						.sending
+						.db
+						.queued_requests(&Destination::Push(user_id.into(), push_key));
+					let query_time = timer.elapsed();
+
+					(results, query_time)
+				},
+				(Some(_), Some(_), Some(_), Some(_)) => {
+					return Ok(RoomMessageEventContent::text_plain(
+						"An appservice ID, server name, or a user ID with push key must be specified via arguments. \
+						 Not all of them See --help for more details.",
+					));
+				},
+				_ => {
+					return Ok(RoomMessageEventContent::text_plain(
+						"An appservice ID, server name, or a user ID with push key must be specified via arguments. \
+						 See --help for more details.",
+					));
+				},
+			};
+
+			let queued_requests = results.collect::<Result<Vec<(_, _)>>>();
+
+			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
+				),
+			))
+		},
+		Sending::ActiveRequestsFor {
+			appservice_id,
+			server_name,
+			user_id,
+			push_key,
+		} => {
+			if appservice_id.is_none() && server_name.is_none() && user_id.is_none() && push_key.is_none() {
+				return Ok(RoomMessageEventContent::text_plain(
+					"An appservice ID, server name, or a user ID with push key must be specified via arguments. See \
+					 --help for more details.",
+				));
+			}
+
+			let (results, query_time) = 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(
+							"An appservice ID, server name, or a user ID with push key must be specified via \
+							 arguments. See --help for more details.",
+						));
+					}
+
+					let timer = tokio::time::Instant::now();
+					let results = 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)
+				},
+				(None, None, Some(user_id), Some(push_key)) => {
+					if push_key.is_empty() {
+						return Ok(RoomMessageEventContent::text_plain(
+							"An appservice ID, server name, or a user ID with push key must be specified via \
+							 arguments. See --help for more details.",
+						));
+					}
+
+					let timer = tokio::time::Instant::now();
+					let results = services()
+						.sending
+						.db
+						.active_requests_for(&Destination::Push(user_id.into(), push_key));
+					let query_time = timer.elapsed();
+
+					(results, query_time)
+				},
+				(Some(_), Some(_), Some(_), Some(_)) => {
+					return Ok(RoomMessageEventContent::text_plain(
+						"An appservice ID, server name, or a user ID with push key must be specified via arguments. \
+						 Not all of them See --help for more details.",
+					));
+				},
+				_ => {
+					return Ok(RoomMessageEventContent::text_plain(
+						"An appservice ID, server name, or a user ID with push key must be specified via arguments. \
+						 See --help for more details.",
+					));
+				},
+			};
+
+			let active_requests = results.collect::<Result<Vec<(_, _)>>>();
+
+			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
+				),
+			))
+		},
+		Sending::GetLatestEduCount {
+			server_name,
+		} => {
+			let timer = tokio::time::Instant::now();
+			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
+				),
+			))
+		},
+	}
+}

src/admin/query/users.rs

@@ -0,0 +1,25 @@
+use ruma::events::room::message::RoomMessageEventContent;
+
+use super::Users;
+use crate::{services, Result};
+
+/// All the getters and iterators in key_value/users.rs
+pub(crate) async fn users(subcommand: Users) -> Result<RoomMessageEventContent> {
+	match subcommand {
+		Users::Iter => {
+			let timer = tokio::time::Instant::now();
+			let results = services().users.db.iter();
+			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
+				),
+			))
+		},
+	}
+}

src/admin/room/mod.rs

@@ -0,0 +1,160 @@
+use clap::Subcommand;
+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 {
+	/// - List all rooms the server knows about
+	List {
+		page: Option<usize>,
+	},
+
+	#[command(subcommand)]
+	/// - Manage moderation of remote or local rooms
+	Moderation(RoomModerationCommand),
+
+	#[command(subcommand)]
+	/// - Manage rooms' aliases
+	Alias(RoomAliasCommand),
+
+	#[command(subcommand)]
+	/// - Manage the room directory
+	Directory(RoomDirectoryCommand),
+}
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+pub(crate) enum RoomAliasCommand {
+	/// - Make an alias point to a room.
+	Set {
+		#[arg(short, long)]
+		/// Set the alias even if a room is already using it
+		force: bool,
+
+		/// The room id to set the alias on
+		room_id: Box<RoomId>,
+
+		/// The alias localpart to use (`alias`, not `#alias:servername.tld`)
+		room_alias_localpart: String,
+	},
+
+	/// - Remove a local alias
+	Remove {
+		/// The alias localpart to remove (`alias`, not `#alias:servername.tld`)
+		room_alias_localpart: String,
+	},
+
+	/// - Show which room is using an alias
+	Which {
+		/// The alias localpart to look up (`alias`, not
+		/// `#alias:servername.tld`)
+		room_alias_localpart: String,
+	},
+
+	/// - List aliases currently being used
+	List {
+		/// If set, only list the aliases for this room
+		room_id: Option<Box<RoomId>>,
+	},
+}
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+pub(crate) enum RoomDirectoryCommand {
+	/// - Publish a room to the room directory
+	Publish {
+		/// The room id of the room to publish
+		room_id: Box<RoomId>,
+	},
+
+	/// - Unpublish a room to the room directory
+	Unpublish {
+		/// The room id of the room to unpublish
+		room_id: Box<RoomId>,
+	},
+
+	/// - List rooms that are published
+	List {
+		page: Option<usize>,
+	},
+}
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+pub(crate) 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.
+	///
+	/// Server admins (users in the conduwuit admin room) will not be evicted
+	/// and server admins can still join the room. To evict admins too, use
+	/// --force (also ignores errors) To disable incoming federation of the
+	/// room, use --disable-federation
+	BanRoom {
+		#[arg(short, long)]
+		/// Evicts admins out of the room and ignores any potential errors when
+		/// making our local users leave the room
+		force: bool,
+
+		#[arg(long)]
+		/// Disables incoming federation of the room after banning and evicting
+		/// users
+		disable_federation: bool,
+
+		/// The room in the format of `!roomid:example.com` or a room alias in
+		/// the format of `#roomalias:example.com`
+		room: Box<RoomOrAliasId>,
+	},
+
+	/// - Bans a list of rooms (room IDs and room aliases) from a newline
+	///   delimited codeblock similar to `user deactivate-all`
+	BanListOfRooms {
+		#[arg(short, long)]
+		/// Evicts admins out of the room and ignores any potential errors when
+		/// making our local users leave the room
+		force: bool,
+
+		#[arg(long)]
+		/// Disables incoming federation of the room after banning and evicting
+		/// users
+		disable_federation: bool,
+	},
+
+	/// - Unbans a room to allow local users to join again
+	///
+	/// To re-enable incoming federation of the room, use --enable-federation
+	UnbanRoom {
+		#[arg(long)]
+		/// Enables incoming federation of the room after unbanning
+		enable_federation: bool,
+
+		/// The room in the format of `!roomid:example.com` or a room alias in
+		/// the format of `#roomalias:example.com`
+		room: Box<RoomOrAliasId>,
+	},
+
+	/// - List of all rooms we have banned
+	ListBannedRooms,
+}
+
+pub(crate) async fn process(command: RoomCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	Ok(match command {
+		RoomCommand::Alias(command) => room_alias_commands::process(command, body).await?,
+
+		RoomCommand::Directory(command) => room_directory_commands::process(command, body).await?,
+
+		RoomCommand::Moderation(command) => room_moderation_commands::process(command, body).await?,
+
+		RoomCommand::List {
+			page,
+		} => list(body, page).await?,
+	})
+}

src/admin/room/room_alias_commands.rs

@@ -1,45 +1,9 @@
-use std::fmt::Write as _;
+use std::fmt::Write;
 
-use clap::Subcommand;
-use ruma::{events::room::message::RoomMessageEventContent, RoomAliasId, RoomId};
+use ruma::{events::room::message::RoomMessageEventContent, RoomAliasId};
 
-use crate::{service::admin::escape_html, services, Result};
-
-#[cfg_attr(test, derive(Debug))]
-#[derive(Subcommand)]
-pub(crate) enum RoomAliasCommand {
-	/// - Make an alias point to a room.
-	Set {
-		#[arg(short, long)]
-		/// Set the alias even if a room is already using it
-		force: bool,
-
-		/// The room id to set the alias on
-		room_id: Box<RoomId>,
-
-		/// The alias localpart to use (`alias`, not `#alias:servername.tld`)
-		room_alias_localpart: String,
-	},
-
-	/// - Remove an alias
-	Remove {
-		/// The alias localpart to remove (`alias`, not `#alias:servername.tld`)
-		room_alias_localpart: String,
-	},
-
-	/// - Show which room is using an alias
-	Which {
-		/// The alias localpart to look up (`alias`, not
-		/// `#alias:servername.tld`)
-		room_alias_localpart: String,
-	},
-
-	/// - List aliases currently being used
-	List {
-		/// If set, only list the aliases for this room
-		room_id: Option<Box<RoomId>>,
-	},
-}
+use super::RoomAliasCommand;
+use crate::{escape_html, services, Result};
 
 pub(crate) async fn process(command: RoomAliasCommand, _body: Vec<&str>) -> Result<RoomMessageEventContent> {
 	match command {
@@ -115,12 +79,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
 						});
 
@@ -142,7 +107,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
 							});
 
@@ -156,7 +122,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

@@ -0,0 +1,56 @@
+use std::fmt::Write;
+
+use ruma::{events::room::message::RoomMessageEventContent, OwnedRoomId};
+
+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> {
+	// 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()
+		.rooms
+		.metadata
+		.iter_ids()
+		.filter_map(Result::ok)
+		.map(|id: OwnedRoomId| get_room_info(&id))
+		.collect::<Vec<_>>();
+	rooms.sort_by_key(|r| r.1);
+	rooms.reverse();
+
+	let rooms = rooms
+		.into_iter()
+		.skip(page.saturating_sub(1).saturating_mul(PAGE_SIZE))
+		.take(PAGE_SIZE)
+		.collect::<Vec<_>>();
+
+	if rooms.is_empty() {
+		return Ok(RoomMessageEventContent::text_plain("No more rooms."));
+	};
+
+	let output_plain = format!(
+		"Rooms:\n{}",
+		rooms
+			.iter()
+			.map(|(id, members, name)| format!("{id}\tMembers: {members}\tName: {name}"))
+			.collect::<Vec<_>>()
+			.join("\n")
+	);
+	let output_html = format!(
+		"<table><caption>Room list - page \
+		 {page}</caption>\n<tr><th>id</th>\t<th>members</th>\t<th>name</th></tr>\n{}</table>",
+		rooms
+			.iter()
+			.fold(String::new(), |mut output, (id, members, name)| {
+				writeln!(
+					output,
+					"<tr><td>{}</td>\t<td>{}</td>\t<td>{}</td></tr>",
+					escape_html(id.as_ref()),
+					members,
+					escape_html(name)
+				)
+				.expect("should be able to write to string buffer");
+				output
+			})
+	);
+	Ok(RoomMessageEventContent::text_html(output_plain, output_html))
+}

src/admin/room/room_directory_commands.rs

@@ -1,33 +1,9 @@
-use std::fmt::Write as _;
+use std::fmt::Write;
 
-use clap::Subcommand;
-use ruma::{events::room::message::RoomMessageEventContent, OwnedRoomId, RoomId};
+use ruma::{events::room::message::RoomMessageEventContent, OwnedRoomId};
 
-use crate::{
-	service::admin::{escape_html, get_room_info, PAGE_SIZE},
-	services, Result,
-};
-
-#[cfg_attr(test, derive(Debug))]
-#[derive(Subcommand)]
-pub(crate) enum RoomDirectoryCommand {
-	/// - Publish a room to the room directory
-	Publish {
-		/// The room id of the room to publish
-		room_id: Box<RoomId>,
-	},
-
-	/// - Unpublish a room to the room directory
-	Unpublish {
-		/// The room id of the room to unpublish
-		room_id: Box<RoomId>,
-	},
-
-	/// - List rooms that are published
-	List {
-		page: Option<usize>,
-	},
-}
+use super::RoomDirectoryCommand;
+use crate::{escape_html, get_room_info, handler::PAGE_SIZE, services, Result};
 
 pub(crate) async fn process(command: RoomDirectoryCommand, _body: Vec<&str>) -> Result<RoomMessageEventContent> {
 	match command {
@@ -35,13 +11,13 @@ pub(crate) async fn process(command: RoomDirectoryCommand, _body: Vec<&str>) ->
 			room_id,
 		} => match services().rooms.directory.set_public(&room_id) {
 			Ok(()) => Ok(RoomMessageEventContent::text_plain("Room published")),
-			Err(err) => Ok(RoomMessageEventContent::text_plain(format!("Unable to update room: {}", err))),
+			Err(err) => Ok(RoomMessageEventContent::text_plain(format!("Unable to update room: {err}"))),
 		},
 		RoomDirectoryCommand::Unpublish {
 			room_id,
 		} => match services().rooms.directory.set_not_public(&room_id) {
 			Ok(()) => Ok(RoomMessageEventContent::text_plain("Room unpublished")),
-			Err(err) => Ok(RoomMessageEventContent::text_plain(format!("Unable to update room: {}", err))),
+			Err(err) => Ok(RoomMessageEventContent::text_plain(format!("Unable to update room: {err}"))),
 		},
 		RoomDirectoryCommand::List {
 			page,
@@ -60,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<_>>();
 
@@ -89,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_moderation_commands.rs

@@ -1,74 +1,16 @@
-use std::fmt::Write as _;
+use std::fmt::Write;
 
-use clap::Subcommand;
+use api::client_server::{get_alias_helper, leave_room};
 use ruma::{
 	events::room::message::RoomMessageEventContent, OwnedRoomId, OwnedUserId, RoomAliasId, RoomId, RoomOrAliasId,
 };
 use tracing::{debug, error, info, warn};
 
-use crate::{
-	api::client_server::{get_alias_helper, leave_room},
-	service::admin::{escape_html, Service},
-	services, Result,
+use super::{
+	super::{escape_html, Service},
+	RoomModerationCommand,
 };
-
-#[cfg_attr(test, derive(Debug))]
-#[derive(Subcommand)]
-pub(crate) 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.
-	///
-	/// Server admins (users in the conduwuit admin room) will not be evicted
-	/// and server admins can still join the room. To evict admins too, use
-	/// --force (also ignores errors) To disable incoming federation of the
-	/// room, use --disable-federation
-	BanRoom {
-		#[arg(short, long)]
-		/// Evicts admins out of the room and ignores any potential errors when
-		/// making our local users leave the room
-		force: bool,
-
-		#[arg(long)]
-		/// Disables incoming federation of the room after banning and evicting
-		/// users
-		disable_federation: bool,
-
-		/// The room in the format of `!roomid:example.com` or a room alias in
-		/// the format of `#roomalias:example.com`
-		room: Box<RoomOrAliasId>,
-	},
-
-	/// - Bans a list of rooms (room IDs and room aliases) from a newline
-	///   delimited codeblock similar to `user deactivate-all`
-	BanListOfRooms {
-		#[arg(short, long)]
-		/// Evicts admins out of the room and ignores any potential errors when
-		/// making our local users leave the room
-		force: bool,
-
-		#[arg(long)]
-		/// Disables incoming federation of the room after banning and evicting
-		/// users
-		disable_federation: bool,
-	},
-
-	/// - Unbans a room to allow local users to join again
-	///
-	/// To re-enable incoming federation of the room, use --enable-federation
-	UnbanRoom {
-		#[arg(long)]
-		/// Enables incoming federation of the room after unbanning
-		enable_federation: bool,
-
-		/// The room in the format of `!roomid:example.com` or a room alias in
-		/// the format of `#roomalias:example.com`
-		room: Box<RoomOrAliasId>,
-	},
-
-	/// - List of all rooms we have banned
-	ListBannedRooms,
-}
+use crate::{services, user_is_local, Result};
 
 pub(crate) async fn process(command: RoomModerationCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
 	match command {
@@ -83,7 +25,7 @@ pub(crate) async fn process(command: RoomModerationCommand, body: Vec<&str>) ->
 				.try_into()
 				.expect("#admins:server_name is a valid alias name");
 
-			if let Some(admin_room_id) = Service::get_admin_room()? {
+			if let Some(admin_room_id) = Service::get_admin_room().await? {
 				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."));
 				}
@@ -129,7 +71,7 @@ pub(crate) async fn process(command: RoomModerationCommand, body: Vec<&str>) ->
 						 federation"
 					);
 
-					match get_alias_helper(room_alias).await {
+					match get_alias_helper(room_alias, None).await {
 						Ok(response) => {
 							debug!("Got federation response fetching room ID for room {room}: {:?}", response);
 							response.room_id
@@ -160,18 +102,17 @@ pub(crate) async fn process(command: RoomModerationCommand, body: Vec<&str>) ->
 					.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(true)) // since this is a force
-							                          // operation, assume user
-							                          // is an admin if somehow
-							                          // this fails
+							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)
+									&& services()
+										.users
+										.is_admin(local_user)
+										.unwrap_or(true)) // since this is a force
+							 // operation, assume user
+							 // is an admin if somehow
+							 // this fails
 						})
 					})
 					.collect::<Vec<OwnedUserId>>()
@@ -181,7 +122,9 @@ pub(crate) async fn process(command: RoomModerationCommand, body: Vec<&str>) ->
 						&local_user, &room_id
 					);
 
-					_ = leave_room(&local_user, &room_id, None).await;
+					if let Err(e) = leave_room(&local_user, &room_id, None).await {
+						warn!(%e, "Failed to leave room");
+					}
 				}
 			} else {
 				for local_user in services()
@@ -191,14 +134,14 @@ pub(crate) async fn process(command: RoomModerationCommand, body: Vec<&str>) ->
 					.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))
+								// 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>>()
@@ -227,8 +170,8 @@ pub(crate) async fn process(command: RoomModerationCommand, body: Vec<&str>) ->
 			}
 
 			Ok(RoomMessageEventContent::text_plain(
-				"Room banned and removed all our local users, use disable-room to stop receiving new inbound \
-				 federation events as well if needed.",
+				"Room banned and removed all our local users, use `!admin federation disable-room` to stop receiving \
+				 new inbound federation events as well if needed.",
 			))
 		},
 		RoomModerationCommand::BanListOfRooms {
@@ -248,7 +191,7 @@ pub(crate) async fn process(command: RoomModerationCommand, body: Vec<&str>) ->
 				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 let Some(admin_room_id) = Service::get_admin_room().await? {
 								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;
@@ -291,7 +234,7 @@ pub(crate) async fn process(command: RoomModerationCommand, body: Vec<&str>) ->
 												 fetch room ID over federation"
 											);
 
-											match get_alias_helper(room_alias).await {
+											match get_alias_helper(room_alias, None).await {
 												Ok(response) => {
 													debug!(
 														"Got federation response fetching room ID for room {room}: \
@@ -366,19 +309,19 @@ pub(crate) async fn process(command: RoomModerationCommand, body: Vec<&str>) ->
 							.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(true)) // since this is a
-									                          // force operation,
-									                          // assume user is
-									                          // an admin if
-									                          // somehow this
-									                          // fails
+										// 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(true)) // since this is a
+									 // force operation,
+									 // assume user is
+									 // an admin if
+									 // somehow this
+									 // fails
 								})
 							})
 							.collect::<Vec<OwnedUserId>>()
@@ -388,7 +331,9 @@ pub(crate) async fn process(command: RoomModerationCommand, body: Vec<&str>) ->
 								 admins too)",
 								&local_user, room_id
 							);
-							_ = leave_room(&local_user, &room_id, None).await;
+							if let Err(e) = leave_room(&local_user, &room_id, None).await {
+								warn!(%e, "Failed to leave room");
+							}
 						}
 					} else {
 						for local_user in services()
@@ -398,14 +343,14 @@ pub(crate) async fn process(command: RoomModerationCommand, body: Vec<&str>) ->
 							.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))
+										// 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>>()
@@ -490,7 +435,7 @@ pub(crate) async fn process(command: RoomModerationCommand, body: Vec<&str>) ->
 						 federation"
 					);
 
-					match get_alias_helper(room_alias).await {
+					match get_alias_helper(room_alias, None).await {
 						Ok(response) => {
 							debug!("Got federation response fetching room ID for room {room}: {:?}", response);
 							response.room_id

src/admin/server/mod.rs

@@ -0,0 +1,62 @@
+pub(crate) mod server_commands;
+
+use clap::Subcommand;
+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;
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+pub(crate) enum ServerCommand {
+	/// - Time elapsed since startup
+	Uptime,
+
+	/// - Show configuration values
+	ShowConfig,
+
+	/// - 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,
+	},
+
+	/// - Performs an online backup of the database (only available for RocksDB
+	///   at the moment)
+	BackupDatabase,
+
+	/// - List database backups
+	ListBackups,
+
+	/// - List database files
+	ListDatabaseFiles,
+}
+
+pub(crate) 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::ListBackups => list_backups(body).await?,
+		ServerCommand::BackupDatabase => backup_database(body).await?,
+		ServerCommand::ListDatabaseFiles => list_database_files(body).await?,
+	})
+}

src/admin/server/server_commands.rs

@@ -0,0 +1,98 @@
+use ruma::events::room::message::RoomMessageEventContent;
+
+use crate::{services, Result};
+
+pub(crate) 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_html(String::new(), result))
+}
+
+pub(crate) async fn show_config(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	// Construct and send the response
+	Ok(RoomMessageEventContent::text_plain(format!("{}", services().globals.config)))
+}
+
+pub(crate) async fn memory_usage(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	let response0 = services().memory_usage().await;
+	let response1 = services().globals.db.memory_usage();
+	let response2 = conduit::alloc::memory_usage();
+
+	Ok(RoomMessageEventContent::text_plain(format!(
+		"Services:\n{response0}\n\nDatabase:\n{response1}\n{}",
+		if !response2.is_empty() {
+			format!("Allocator:\n {response2}")
+		} else {
+			String::new()
+		}
+	)))
+}
+
+pub(crate) async fn clear_database_caches(_body: Vec<&str>, amount: u32) -> Result<RoomMessageEventContent> {
+	services().globals.db.clear_caches(amount);
+
+	Ok(RoomMessageEventContent::text_plain("Done."))
+}
+
+pub(crate) async fn clear_service_caches(_body: Vec<&str>, amount: u32) -> Result<RoomMessageEventContent> {
+	services().clear_caches(amount).await;
+
+	Ok(RoomMessageEventContent::text_plain("Done."))
+}
+
+pub(crate) 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(crate) async fn backup_database(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	if !cfg!(feature = "rocksdb") {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Only RocksDB supports online backups in conduwuit.",
+		));
+	}
+
+	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(crate) async fn list_database_files(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	if !cfg!(feature = "rocksdb") {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Only RocksDB supports listing files in conduwuit.",
+		));
+	}
+
+	let result = services().globals.db.file_list()?;
+	Ok(RoomMessageEventContent::notice_html(String::new(), result))
+}

src/admin/tester/mod.rs

@@ -0,0 +1,14 @@
+use ruma::events::room::message::RoomMessageEventContent;
+
+use crate::Result;
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(clap::Subcommand)]
+pub(crate) enum TesterCommands {
+	Tester,
+}
+pub(crate) async fn process(command: TesterCommands, _body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	Ok(match command {
+		TesterCommands::Tester => RoomMessageEventContent::notice_plain(String::from("completed")),
+	})
+}

src/admin/user/mod.rs

@@ -0,0 +1,89 @@
+pub(crate) mod user_commands;
+
+use clap::Subcommand;
+use ruma::events::room::message::RoomMessageEventContent;
+
+use self::user_commands::{create, deactivate, deactivate_all, list, list_joined_rooms, reset_password};
+use crate::Result;
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+pub(crate) 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 not be removed from all rooms by default.
+	/// Use --leave-rooms to force the user to leave all rooms
+	Deactivate {
+		#[arg(short, long)]
+		leave_rooms: bool,
+		user_id: String,
+	},
+
+	/// - Deactivate a list of users
+	///
+	/// Recommended to use in conjunction with list-local-users.
+	///
+	/// Users will not be removed from joined rooms by default.
+	/// Can be overridden with --leave-rooms flag.
+	/// 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
+		leave_rooms: bool,
+		#[arg(short, long)]
+		/// Also deactivate admin accounts
+		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,
+	},
+}
+
+pub(crate) 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 {
+			leave_rooms,
+			user_id,
+		} => deactivate(body, leave_rooms, user_id).await?,
+		UserCommand::ResetPassword {
+			username,
+		} => reset_password(body, username).await?,
+		UserCommand::DeactivateAll {
+			leave_rooms,
+			force,
+		} => deactivate_all(body, leave_rooms, force).await?,
+		UserCommand::ListJoinedRooms {
+			user_id,
+		} => list_joined_rooms(body, user_id).await?,
+	})
+}

src/admin/user/user_commands.rs

@@ -0,0 +1,369 @@
+use std::{fmt::Write as _, sync::Arc};
+
+use api::client_server::{join_room_by_id_helper, leave_all_rooms};
+use conduit::utils;
+use ruma::{events::room::message::RoomMessageEventContent, OwnedRoomId, UserId};
+use tracing::{error, info, warn};
+
+use crate::{escape_html, get_room_info, services, user_is_local, Result};
+
+const AUTO_GEN_PASSWORD_LENGTH: usize = 25;
+
+pub(crate) async fn list(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	match services().users.list_local_users() {
+		Ok(users) => {
+			let mut msg = format!("Found {} local user account(s):\n", users.len());
+			msg += &users.join("\n");
+			Ok(RoomMessageEventContent::text_plain(&msg))
+		},
+		Err(e) => Ok(RoomMessageEventContent::text_plain(e.to_string())),
+	}
+}
+
+pub(crate) async fn create(
+	_body: Vec<&str>, username: String, password: Option<String>,
+) -> Result<RoomMessageEventContent> {
+	let password = password.unwrap_or_else(|| utils::random_string(AUTO_GEN_PASSWORD_LENGTH));
+
+	// Validate user id
+	let user_id =
+		match UserId::parse_with_server_name(username.as_str().to_lowercase(), services().globals.server_name()) {
+			Ok(id) => id,
+			Err(e) => {
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"The supplied username is not a valid username: {e}"
+				)))
+			},
+		};
+
+	if !user_is_local(&user_id) {
+		return Ok(RoomMessageEventContent::text_plain(format!(
+			"User {user_id} does not belong to our server."
+		)));
+	}
+
+	if user_id.is_historical() {
+		return Ok(RoomMessageEventContent::text_plain(format!(
+			"Userid {user_id} is not allowed due to historical"
+		)));
+	}
+
+	if services().users.exists(&user_id)? {
+		return Ok(RoomMessageEventContent::text_plain(format!("Userid {user_id} already exists")));
+	}
+	// 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(crate) async fn deactivate(
+	_body: Vec<&str>, leave_rooms: bool, user_id: String,
+) -> Result<RoomMessageEventContent> {
+	// Validate user id
+	let user_id =
+		match UserId::parse_with_server_name(user_id.as_str().to_lowercase(), services().globals.server_name()) {
+			Ok(id) => Arc::<UserId>::from(id),
+			Err(e) => {
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"The supplied username is not a valid username: {e}"
+				)))
+			},
+		};
+
+	// check if user belongs to our server
+	if user_id.server_name() != services().globals.server_name() {
+		return Ok(RoomMessageEventContent::text_plain(format!(
+			"User {user_id} does not belong to our server."
+		)));
+	}
+
+	// don't deactivate the conduit service account
+	if user_id
+		== UserId::parse_with_server_name("conduit", services().globals.server_name()).expect("conduit user exists")
+	{
+		return Ok(RoomMessageEventContent::text_plain(
+			"Not allowed to deactivate the Conduit service account.",
+		));
+	}
+
+	if services().users.exists(&user_id)? {
+		RoomMessageEventContent::text_plain(format!("Making {user_id} leave all rooms before deactivation..."));
+
+		services().users.deactivate_account(&user_id)?;
+
+		if leave_rooms {
+			leave_all_rooms(&user_id).await;
+		}
+
+		Ok(RoomMessageEventContent::text_plain(format!(
+			"User {user_id} has been deactivated"
+		)))
+	} else {
+		Ok(RoomMessageEventContent::text_plain(format!(
+			"User {user_id} doesn't exist on this server"
+		)))
+	}
+}
+
+pub(crate) async fn reset_password(_body: Vec<&str>, username: String) -> Result<RoomMessageEventContent> {
+	// Validate user id
+	let user_id =
+		match UserId::parse_with_server_name(username.as_str().to_lowercase(), services().globals.server_name()) {
+			Ok(id) => Arc::<UserId>::from(id),
+			Err(e) => {
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"The supplied username is not a valid username: {e}"
+				)))
+			},
+		};
+
+	// check if user belongs to our server
+	if user_id.server_name() != services().globals.server_name() {
+		return Ok(RoomMessageEventContent::text_plain(format!(
+			"User {user_id} does not belong to our server."
+		)));
+	}
+
+	// Check if the specified user is valid
+	if !services().users.exists(&user_id)?
+		|| user_id
+			== UserId::parse_with_server_name("conduit", services().globals.server_name()).expect("conduit user exists")
+	{
+		return Ok(RoomMessageEventContent::text_plain("The specified user does not exist!"));
+	}
+
+	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(crate) async fn deactivate_all(body: Vec<&str>, leave_rooms: bool, force: bool) -> Result<RoomMessageEventContent> {
+	if body.len() > 2 && body[0].trim().starts_with("```") && body.last().unwrap().trim() == "```" {
+		let usernames = body.clone().drain(1..body.len() - 1).collect::<Vec<_>>();
+
+		let mut user_ids: Vec<&UserId> = Vec::new();
+
+		for &username in &usernames {
+			match <&UserId>::try_from(username) {
+				Ok(user_id) => user_ids.push(user_id),
+				Err(e) => {
+					return Ok(RoomMessageEventContent::text_plain(format!(
+						"{username} is not a valid username: {e}"
+					)))
+				},
+			}
+		}
+
+		let mut deactivation_count: u16 = 0;
+		let mut admins = Vec::new();
+
+		if !force {
+			user_ids.retain(|&user_id| match services().users.is_admin(user_id) {
+				Ok(is_admin) => {
+					if is_admin {
+						admins.push(user_id.localpart());
+						false
+					} else {
+						true
+					}
+				},
+				Err(_) => false,
+			});
+		}
+
+		for &user_id in &user_ids {
+			// check if user belongs to our server and skips over non-local users
+			if user_id.server_name() != services().globals.server_name() {
+				continue;
+			}
+
+			// don't deactivate the conduit service account
+			if user_id
+				== UserId::parse_with_server_name("conduit", services().globals.server_name())
+					.expect("conduit user exists")
+			{
+				continue;
+			}
+
+			// user does not exist on our server
+			if !services().users.exists(user_id)? {
+				continue;
+			}
+
+			if services().users.deactivate_account(user_id).is_ok() {
+				deactivation_count = deactivation_count.saturating_add(1);
+			}
+		}
+
+		if leave_rooms {
+			for &user_id in &user_ids {
+				leave_all_rooms(user_id).await;
+			}
+		}
+
+		if admins.is_empty() {
+			Ok(RoomMessageEventContent::text_plain(format!(
+				"Deactivated {deactivation_count} accounts."
+			)))
+		} else {
+			Ok(RoomMessageEventContent::text_plain(format!(
+				"Deactivated {} accounts.\nSkipped admin accounts: {:?}. Use --force to deactivate admin accounts",
+				deactivation_count,
+				admins.join(", ")
+			)))
+		}
+	} else {
+		Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		))
+	}
+}
+
+pub(crate) async fn list_joined_rooms(_body: Vec<&str>, user_id: String) -> Result<RoomMessageEventContent> {
+	// Validate user id
+	let user_id =
+		match UserId::parse_with_server_name(user_id.as_str().to_lowercase(), services().globals.server_name()) {
+			Ok(id) => Arc::<UserId>::from(id),
+			Err(e) => {
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"The supplied username is not a valid username: {e}"
+				)))
+			},
+		};
+
+	if !user_is_local(&user_id) {
+		return Ok(RoomMessageEventContent::text_plain("User does not belong to our server."));
+	}
+
+	if !services().users.exists(&user_id)? {
+		return Ok(RoomMessageEventContent::text_plain("User does not exist on this server."));
+	}
+
+	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))
+}

src/admin/utils.rs

@@ -0,0 +1,30 @@
+pub(crate) use conduit::utils::HtmlEscape;
+use ruma::OwnedRoomId;
+
+use crate::services;
+
+pub(crate) fn escape_html(s: &str) -> String {
+	s.replace('&', "&")
+		.replace('<', "&lt;")
+		.replace('>', "&gt;")
+}
+
+pub(crate) fn get_room_info(id: &OwnedRoomId) -> (OwnedRoomId, u64, String) {
+	(
+		id.clone(),
+		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()),
+	)
+}

src/api/Cargo.toml

@@ -0,0 +1,66 @@
+[package]
+name = "conduit_api"
+version.workspace = true
+edition.workspace = true
+
+[lib]
+path = "mod.rs"
+crate-type = [
+	"rlib",
+#	"dylib",
+]
+
+[features]
+default = [
+	"element_hacks",
+	"gzip_compression",
+	"brotli_compression",
+	"release_max_log_level",
+]
+
+element_hacks = []
+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",
+]
+gzip_compression = [
+	"reqwest/gzip",
+]
+brotli_compression = [
+	"reqwest/brotli",
+]
+
+[dependencies]
+argon2.workspace = true
+axum-extra.workspace = true
+axum.workspace = true
+base64.workspace = true
+bytes.workspace = true
+conduit-core.workspace = true
+conduit-database.workspace = true
+conduit-service.workspace = true
+futures-util.workspace = true
+hmac.workspace = true
+http.workspace = true
+hyper.workspace = true
+image.workspace = true
+ipaddress.workspace = true
+jsonwebtoken.workspace = true
+log.workspace = true
+rand.workspace = true
+reqwest.workspace = true
+ruma.workspace = true
+serde_html_form.workspace = true
+serde_json.workspace = true
+serde.workspace = true
+sha-1.workspace = true
+thiserror.workspace = true
+tokio.workspace = true
+tracing.workspace = true
+webpage.workspace = true
+
+[lints]
+workspace = true

src/api/client_server/account.rs

@@ -1,8 +1,11 @@
+use std::fmt::Write;
+
+use conduit::debug_info;
 use register::RegistrationKind;
 use ruma::{
 	api::client::{
 		account::{
-			change_password, deactivate, get_3pids, get_username_availability,
+			change_password, check_registration_token_validity, deactivate, get_3pids, get_username_availability,
 			register::{self, LoginType},
 			request_3pid_management_token_via_email, request_3pid_management_token_via_msisdn, whoami,
 			ThirdPartyIdRemovalStatus,
@@ -17,8 +20,11 @@
 
 use super::{DEVICE_ID_LENGTH, SESSION_ID_LENGTH, TOKEN_LENGTH};
 use crate::{
-	api::client_server::{self, join_room_by_id_helper},
-	service, services, utils, Error, Result, Ruma,
+	client_server::{self, join_room_by_id_helper},
+	service::user_is_local,
+	services,
+	utils::{self},
+	Error, Result, Ruma,
 };
 
 const RANDOM_USER_ID_LENGTH: usize = 10;
@@ -34,13 +40,13 @@
 ///
 /// Note: This will not reserve the username, so the username might become
 /// invalid when trying to register
-pub async fn get_register_available_route(
+pub(crate) async fn get_register_available_route(
 	body: Ruma<get_username_availability::v3::Request>,
 ) -> Result<get_username_availability::v3::Response> {
 	// Validate user id
 	let user_id = UserId::parse_with_server_name(body.username.to_lowercase(), services().globals.server_name())
 		.ok()
-		.filter(|user_id| !user_id.is_historical() && user_id.server_name() == services().globals.server_name())
+		.filter(|user_id| !user_id.is_historical() && user_is_local(user_id))
 		.ok_or(Error::BadRequest(ErrorKind::InvalidUsername, "Username is invalid."))?;
 
 	// Check if username is creative enough
@@ -82,7 +88,7 @@ pub async fn get_register_available_route(
 /// - If `inhibit_login` is false: Creates a device and returns device id and
 ///   access_token
 #[allow(clippy::doc_markdown)]
-pub async fn register_route(body: Ruma<register::v3::Request>) -> Result<register::v3::Response> {
+pub(crate) async fn register_route(body: Ruma<register::v3::Request>) -> Result<register::v3::Response> {
 	if !services().globals.allow_registration() && body.appservice_info.is_none() {
 		info!(
 			"Registration disabled and request not from known appservice, rejecting registration attempt for username \
@@ -125,9 +131,7 @@ pub async fn register_route(body: Ruma<register::v3::Request>) -> Result<registe
 			let proposed_user_id =
 				UserId::parse_with_server_name(username.to_lowercase(), services().globals.server_name())
 					.ok()
-					.filter(|user_id| {
-						!user_id.is_historical() && user_id.server_name() == services().globals.server_name()
-					})
+					.filter(|user_id| !user_id.is_historical() && user_is_local(user_id))
 					.ok_or(Error::BadRequest(ErrorKind::InvalidUsername, "Username is invalid."))?;
 
 			if services().users.exists(&proposed_user_id)? {
@@ -238,7 +242,8 @@ pub async fn register_route(body: Ruma<register::v3::Request>) -> Result<registe
 	// 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.new_user_displayname_suffix().is_empty() {
-		displayname.push_str(&(" ".to_owned() + services().globals.new_user_displayname_suffix()));
+		write!(displayname, " {}", services().globals.config.new_user_displayname_suffix)
+			.expect("should be able to write to string buffer");
 	}
 
 	services()
@@ -286,19 +291,23 @@ pub async fn register_route(body: Ruma<register::v3::Request>) -> Result<registe
 		.users
 		.create_device(&user_id, &device_id, &token, body.initial_device_display_name.clone())?;
 
-	info!("New user \"{}\" registered on this server.", user_id);
+	debug_info!(%user_id, %device_id, "User account was created");
 
 	// log in conduit admin channel if a non-guest user registered
 	if body.appservice_info.is_none() && !is_guest {
+		info!("New user \"{user_id}\" registered on this server.");
 		services()
 			.admin
 			.send_message(RoomMessageEventContent::notice_plain(format!(
 				"New user \"{user_id}\" registered on this server."
-			)));
+			)))
+			.await;
 	}
 
 	// log in conduit admin channel if a guest registered
 	if body.appservice_info.is_none() && is_guest && services().globals.log_guest_registrations() {
+		info!("New guest user \"{user_id}\" registered on this server.");
+
 		if let Some(device_display_name) = &body.initial_device_display_name {
 			if body
 				.initial_device_display_name
@@ -310,27 +319,30 @@ pub async fn register_route(body: Ruma<register::v3::Request>) -> Result<registe
 					.send_message(RoomMessageEventContent::notice_plain(format!(
 						"Guest user \"{user_id}\" with device display name `{device_display_name}` registered on this \
 						 server."
-					)));
+					)))
+					.await;
 			} else {
 				services()
 					.admin
 					.send_message(RoomMessageEventContent::notice_plain(format!(
 						"Guest user \"{user_id}\" with no device display name registered on this server.",
-					)));
+					)))
+					.await;
 			}
 		} else {
 			services()
 				.admin
 				.send_message(RoomMessageEventContent::notice_plain(format!(
 					"Guest user \"{user_id}\" with no device display name registered on this server.",
-				)));
+				)))
+				.await;
 		}
 	}
 
 	// If this is the first real user, grant them admin privileges except for guest
 	// users Note: the server user, @conduit:servername, is generated first
 	if !is_guest {
-		if let Some(admin_room) = service::admin::Service::get_admin_room()? {
+		if let Some(admin_room) = service::admin::Service::get_admin_room().await? {
 			if services()
 				.rooms
 				.state_cache
@@ -406,7 +418,9 @@ pub async fn register_route(body: Ruma<register::v3::Request>) -> Result<registe
 ///   last seen ts)
 /// - Forgets to-device events
 /// - Triggers device list updates
-pub async fn change_password_route(body: Ruma<change_password::v3::Request>) -> Result<change_password::v3::Response> {
+pub(crate) async fn change_password_route(
+	body: Ruma<change_password::v3::Request>,
+) -> Result<change_password::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let sender_device = body.sender_device.as_ref().expect("user is authenticated");
 
@@ -459,7 +473,8 @@ pub async fn change_password_route(body: Ruma<change_password::v3::Request>) ->
 		.admin
 		.send_message(RoomMessageEventContent::notice_plain(format!(
 			"User {sender_user} changed their password."
-		)));
+		)))
+		.await;
 
 	Ok(change_password::v3::Response {})
 }
@@ -469,7 +484,7 @@ pub async fn change_password_route(body: Ruma<change_password::v3::Request>) ->
 /// Get `user_id` of the sender user.
 ///
 /// Note: Also works for Application Services
-pub async fn whoami_route(body: Ruma<whoami::v3::Request>) -> Result<whoami::v3::Response> {
+pub(crate) async fn whoami_route(body: Ruma<whoami::v3::Request>) -> Result<whoami::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let device_id = body.sender_device.clone();
 
@@ -491,7 +506,7 @@ pub async fn whoami_route(body: Ruma<whoami::v3::Request>) -> Result<whoami::v3:
 /// - Forgets all to-device events
 /// - Triggers device list updates
 /// - Removes ability to log in again
-pub async fn deactivate_route(body: Ruma<deactivate::v3::Request>) -> Result<deactivate::v3::Response> {
+pub(crate) async fn deactivate_route(body: Ruma<deactivate::v3::Request>) -> Result<deactivate::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let sender_device = body.sender_device.as_ref().expect("user is authenticated");
 
@@ -524,7 +539,7 @@ pub async fn deactivate_route(body: Ruma<deactivate::v3::Request>) -> Result<dea
 	}
 
 	// Make the user leave all rooms before deactivation
-	client_server::leave_all_rooms(sender_user).await?;
+	client_server::leave_all_rooms(sender_user).await;
 
 	// Remove devices and mark account as deactivated
 	services().users.deactivate_account(sender_user)?;
@@ -534,7 +549,8 @@ pub async fn deactivate_route(body: Ruma<deactivate::v3::Request>) -> Result<dea
 		.admin
 		.send_message(RoomMessageEventContent::notice_plain(format!(
 			"User {sender_user} deactivated their account."
-		)));
+		)))
+		.await;
 
 	Ok(deactivate::v3::Response {
 		id_server_unbind_result: ThirdPartyIdRemovalStatus::NoSupport,
@@ -546,7 +562,7 @@ pub async fn deactivate_route(body: Ruma<deactivate::v3::Request>) -> Result<dea
 /// Get a list of third party identifiers associated with this account.
 ///
 /// - Currently always returns empty list
-pub async fn third_party_route(body: Ruma<get_3pids::v3::Request>) -> Result<get_3pids::v3::Response> {
+pub(crate) async fn third_party_route(body: Ruma<get_3pids::v3::Request>) -> Result<get_3pids::v3::Response> {
 	let _sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	Ok(get_3pids::v3::Response::new(Vec::new()))
@@ -559,7 +575,7 @@ pub async fn third_party_route(body: Ruma<get_3pids::v3::Request>) -> Result<get
 ///
 /// - 403 signals that The homeserver does not allow the third party identifier
 ///   as a contact option.
-pub async fn request_3pid_management_token_via_email_route(
+pub(crate) async fn request_3pid_management_token_via_email_route(
 	_body: Ruma<request_3pid_management_token_via_email::v3::Request>,
 ) -> Result<request_3pid_management_token_via_email::v3::Response> {
 	Err(Error::BadRequest(
@@ -575,7 +591,7 @@ pub async fn request_3pid_management_token_via_email_route(
 ///
 /// - 403 signals that The homeserver does not allow the third party identifier
 ///   as a contact option.
-pub async fn request_3pid_management_token_via_msisdn_route(
+pub(crate) async fn request_3pid_management_token_via_msisdn_route(
 	_body: Ruma<request_3pid_management_token_via_msisdn::v3::Request>,
 ) -> Result<request_3pid_management_token_via_msisdn::v3::Response> {
 	Err(Error::BadRequest(
@@ -583,3 +599,24 @@ pub async fn request_3pid_management_token_via_msisdn_route(
 		"Third party identifier is not allowed",
 	))
 }
+
+/// # `GET /_matrix/client/v1/register/m.login.registration_token/validity`
+///
+/// Checks if the provided registration token is valid at the time of checking
+///
+/// Currently does not have any ratelimiting, and this isn't very practical as
+/// there is only one registration token allowed.
+pub(crate) async fn check_registration_token_validity(
+	body: Ruma<check_registration_token_validity::v1::Request>,
+) -> Result<check_registration_token_validity::v1::Response> {
+	let Some(reg_token) = services().globals.config.registration_token.clone() else {
+		return Err(Error::BadRequest(
+			ErrorKind::forbidden(),
+			"Server does not allow token registration.",
+		));
+	};
+
+	Ok(check_registration_token_validity::v1::Response {
+		valid: reg_token == body.token,
+	})
+}

src/api/client_server/alias.rs

@@ -8,37 +8,30 @@
 		},
 		federation,
 	},
-	OwnedRoomAliasId, OwnedServerName,
+	OwnedRoomAliasId, OwnedRoomId, OwnedServerName,
 };
+use tracing::debug;
 
-use crate::{services, Error, Result, Ruma};
+use crate::{
+	debug_info, debug_warn,
+	service::{appservice::RegistrationInfo, server_is_ours},
+	services, Error, Result, Ruma,
+};
 
 /// # `PUT /_matrix/client/v3/directory/room/{roomAlias}`
 ///
 /// Creates a new room alias on this server.
-pub async fn create_alias_route(body: Ruma<create_alias::v3::Request>) -> Result<create_alias::v3::Response> {
-	if body.room_alias.server_name() != services().globals.server_name() {
-		return Err(Error::BadRequest(ErrorKind::InvalidParam, "Alias is from another server."));
-	}
+pub(crate) async fn create_alias_route(body: Ruma<create_alias::v3::Request>) -> Result<create_alias::v3::Response> {
+	alias_checks(&body.room_alias, &body.appservice_info).await?;
 
+	// this isn't apart of alias_checks or delete alias route because we should
+	// allow removing forbidden room aliases
 	if services()
 		.globals
 		.forbidden_alias_names()
 		.is_match(body.room_alias.alias())
 	{
-		return Err(Error::BadRequest(ErrorKind::Unknown, "Room alias is forbidden."));
-	}
-
-	if let Some(ref info) = body.appservice_info {
-		if !info.aliases.is_match(body.room_alias.as_str()) {
-			return Err(Error::BadRequest(ErrorKind::Exclusive, "Room alias is not in namespace."));
-		}
-	} else if services()
-		.appservice
-		.is_exclusive_alias(&body.room_alias)
-		.await
-	{
-		return Err(Error::BadRequest(ErrorKind::Exclusive, "Room alias reserved by appservice."));
+		return Err(Error::BadRequest(ErrorKind::forbidden(), "Room alias is forbidden."));
 	}
 
 	if services()
@@ -71,11 +64,8 @@ pub async fn create_alias_route(body: Ruma<create_alias::v3::Request>) -> Result
 ///
 /// - TODO: additional access control checks
 /// - TODO: Update canonical alias event
-pub async fn delete_alias_route(body: Ruma<delete_alias::v3::Request>) -> Result<delete_alias::v3::Response> {
-	if body.room_alias.server_name() != services().globals.server_name() {
-		return Err(Error::BadRequest(ErrorKind::InvalidParam, "Alias is from another server."));
-	}
-
+pub(crate) async fn delete_alias_route(body: Ruma<delete_alias::v3::Request>) -> Result<delete_alias::v3::Response> {
+	alias_checks(&body.room_alias, &body.appservice_info).await?;
 	if services()
 		.rooms
 		.alias
@@ -85,18 +75,6 @@ pub async fn delete_alias_route(body: Ruma<delete_alias::v3::Request>) -> Result
 		return Err(Error::BadRequest(ErrorKind::NotFound, "Alias does not exist."));
 	}
 
-	if let Some(ref info) = body.appservice_info {
-		if !info.aliases.is_match(body.room_alias.as_str()) {
-			return Err(Error::BadRequest(ErrorKind::Exclusive, "Room alias is not in namespace."));
-		}
-	} else if services()
-		.appservice
-		.is_exclusive_alias(&body.room_alias)
-		.await
-	{
-		return Err(Error::BadRequest(ErrorKind::Exclusive, "Room alias reserved by appservice."));
-	}
-
 	if services()
 		.rooms
 		.alias
@@ -117,13 +95,21 @@ pub async fn delete_alias_route(body: Ruma<delete_alias::v3::Request>) -> Result
 /// # `GET /_matrix/client/v3/directory/room/{roomAlias}`
 ///
 /// Resolve an alias locally or over federation.
-pub async fn get_alias_route(body: Ruma<get_alias::v3::Request>) -> Result<get_alias::v3::Response> {
-	get_alias_helper(body.body.room_alias).await
+pub(crate) async fn get_alias_route(body: Ruma<get_alias::v3::Request>) -> Result<get_alias::v3::Response> {
+	get_alias_helper(body.body.room_alias, None).await
 }
 
-pub(crate) async fn get_alias_helper(room_alias: OwnedRoomAliasId) -> Result<get_alias::v3::Response> {
-	if room_alias.server_name() != services().globals.server_name() {
-		let response = services()
+pub async fn get_alias_helper(
+	room_alias: OwnedRoomAliasId, servers: Option<Vec<OwnedServerName>>,
+) -> Result<get_alias::v3::Response> {
+	debug!("get_alias_helper servers: {servers:?}");
+	if !server_is_ours(room_alias.server_name())
+		&& (!servers
+			.as_ref()
+			.is_some_and(|servers| servers.contains(&services().globals.server_name().to_owned()))
+			|| servers.as_ref().is_none())
+	{
+		let mut response = services()
 			.sending
 			.send_federation_request(
 				room_alias.server_name(),
@@ -131,47 +117,63 @@ pub(crate) async fn get_alias_helper(room_alias: OwnedRoomAliasId) -> Result<get
 					room_alias: room_alias.clone(),
 				},
 			)
-			.await?;
+			.await;
 
-		let room_id = response.room_id;
+		debug_info!("room alias server_name get_alias_helper response: {response:?}");
 
-		let mut servers = response.servers;
-
-		// since the room alias server_name responded, insert it into the list
-		servers.push(room_alias.server_name().into());
-
-		// find active servers in room state cache to suggest
-		servers.extend(
-			services()
-				.rooms
-				.state_cache
-				.room_servers(&room_id)
-				.filter_map(Result::ok),
-		);
-
-		servers.sort_unstable();
-		servers.dedup();
-
-		// shuffle list of servers randomly after sort and dedupe
-		servers.shuffle(&mut rand::thread_rng());
-
-		// prefer the very first server to be ourselves if available, else prefer the
-		// room alias server first
-		if let Some(server_index) = servers
-			.iter()
-			.position(|server| server == services().globals.server_name())
-		{
-			servers.remove(server_index);
-			servers.insert(0, services().globals.server_name().to_owned());
-		} else if let Some(alias_server_index) = servers
-			.iter()
-			.position(|server| server == room_alias.server_name())
-		{
-			servers.remove(alias_server_index);
-			servers.insert(0, room_alias.server_name().into());
+		if let Err(ref e) = response {
+			debug_info!(
+				"Server {} of the original room alias failed to assist in resolving room alias: {e}",
+				room_alias.server_name()
+			);
 		}
 
-		return Ok(get_alias::v3::Response::new(room_id, servers));
+		if response.as_ref().is_ok_and(|resp| resp.servers.is_empty()) || response.as_ref().is_err() {
+			if let Some(servers) = servers {
+				for server in servers {
+					response = services()
+						.sending
+						.send_federation_request(
+							&server,
+							federation::query::get_room_information::v1::Request {
+								room_alias: room_alias.clone(),
+							},
+						)
+						.await;
+					debug_info!("Got response from server {server} for room aliases: {response:?}");
+
+					if let Ok(ref response) = response {
+						if !response.servers.is_empty() {
+							break;
+						}
+						debug_warn!(
+							"Server {server} responded with room aliases, but was empty? Response: {response:?}"
+						);
+					}
+				}
+			}
+		}
+
+		if let Ok(response) = response {
+			let room_id = response.room_id;
+
+			let mut pre_servers = response.servers;
+			// since the room alis server responded, insert it into the list
+			pre_servers.push(room_alias.server_name().into());
+
+			let servers = room_available_servers(&room_id, &room_alias, &Some(pre_servers));
+			debug_warn!(
+				"room alias servers from federation response for room ID {room_id} and room alias {room_alias}: \
+				 {servers:?}"
+			);
+
+			return Ok(get_alias::v3::Response::new(room_id, servers));
+		}
+
+		return Err(Error::BadRequest(
+			ErrorKind::NotFound,
+			"No servers could assist in resolving the room alias",
+		));
 	}
 
 	let mut room_id = None;
@@ -209,28 +211,67 @@ pub(crate) async fn get_alias_helper(room_alias: OwnedRoomAliasId) -> Result<get
 		return Err(Error::BadRequest(ErrorKind::NotFound, "Room with alias not found."));
 	};
 
+	let servers = room_available_servers(&room_id, &room_alias, &None);
+
+	debug_warn!("room alias servers for room ID {room_id} and room alias {room_alias}");
+
+	Ok(get_alias::v3::Response::new(room_id, servers))
+}
+
+fn room_available_servers(
+	room_id: &OwnedRoomId, room_alias: &OwnedRoomAliasId, pre_servers: &Option<Vec<OwnedServerName>>,
+) -> Vec<OwnedServerName> {
 	// find active servers in room state cache to suggest
 	let mut servers: Vec<OwnedServerName> = services()
 		.rooms
 		.state_cache
-		.room_servers(&room_id)
+		.room_servers(room_id)
 		.filter_map(Result::ok)
 		.collect();
 
+	// push any servers we want in the list already (e.g. responded remote alias
+	// servers, room alias server itself)
+	if let Some(pre_servers) = pre_servers {
+		servers.extend(pre_servers.clone());
+	};
+
 	servers.sort_unstable();
 	servers.dedup();
 
 	// shuffle list of servers randomly after sort and dedupe
 	servers.shuffle(&mut rand::thread_rng());
 
-	// insert our server as the very first choice if in list
+	// insert our server as the very first choice if in list, else check if we can
+	// prefer the room alias server first
 	if let Some(server_index) = servers
 		.iter()
-		.position(|server| server == services().globals.server_name())
+		.position(|server_name| server_is_ours(server_name))
 	{
 		servers.remove(server_index);
 		servers.insert(0, services().globals.server_name().to_owned());
+	} else if let Some(alias_server_index) = servers
+		.iter()
+		.position(|server| server == room_alias.server_name())
+	{
+		servers.remove(alias_server_index);
+		servers.insert(0, room_alias.server_name().into());
 	}
 
-	Ok(get_alias::v3::Response::new(room_id, servers))
+	servers
+}
+
+async fn alias_checks(room_alias: &OwnedRoomAliasId, appservice_info: &Option<RegistrationInfo>) -> Result<()> {
+	if !server_is_ours(room_alias.server_name()) {
+		return Err(Error::BadRequest(ErrorKind::InvalidParam, "Alias is from another server."));
+	}
+
+	if let Some(ref info) = appservice_info {
+		if !info.aliases.is_match(room_alias.as_str()) {
+			return Err(Error::BadRequest(ErrorKind::Exclusive, "Room alias is not in namespace."));
+		}
+	} else if services().appservice.is_exclusive_alias(room_alias).await {
+		return Err(Error::BadRequest(ErrorKind::Exclusive, "Room alias reserved by appservice."));
+	}
+
+	Ok(())
 }

src/api/client_server/backup.rs

@@ -1,11 +1,14 @@
-use ruma::api::client::{
-	backup::{
-		add_backup_keys, add_backup_keys_for_room, add_backup_keys_for_session, create_backup_version,
-		delete_backup_keys, delete_backup_keys_for_room, delete_backup_keys_for_session, delete_backup_version,
-		get_backup_info, get_backup_keys, get_backup_keys_for_room, get_backup_keys_for_session,
-		get_latest_backup_info, update_backup_version,
+use ruma::{
+	api::client::{
+		backup::{
+			add_backup_keys, add_backup_keys_for_room, add_backup_keys_for_session, create_backup_version,
+			delete_backup_keys, delete_backup_keys_for_room, delete_backup_keys_for_session, delete_backup_version,
+			get_backup_info, get_backup_keys, get_backup_keys_for_room, get_backup_keys_for_session,
+			get_latest_backup_info, update_backup_version,
+		},
+		error::ErrorKind,
 	},
-	error::ErrorKind,
+	UInt,
 };
 
 use crate::{services, Error, Result, Ruma};
@@ -13,7 +16,7 @@
 /// # `POST /_matrix/client/r0/room_keys/version`
 ///
 /// Creates a new backup.
-pub async fn create_backup_version_route(
+pub(crate) async fn create_backup_version_route(
 	body: Ruma<create_backup_version::v3::Request>,
 ) -> Result<create_backup_version::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -30,7 +33,7 @@ pub async fn create_backup_version_route(
 ///
 /// Update information about an existing backup. Only `auth_data` can be
 /// modified.
-pub async fn update_backup_version_route(
+pub(crate) async fn update_backup_version_route(
 	body: Ruma<update_backup_version::v3::Request>,
 ) -> Result<update_backup_version::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -44,7 +47,7 @@ pub async fn update_backup_version_route(
 /// # `GET /_matrix/client/r0/room_keys/version`
 ///
 /// Get information about the latest backup version.
-pub async fn get_latest_backup_info_route(
+pub(crate) async fn get_latest_backup_info_route(
 	body: Ruma<get_latest_backup_info::v3::Request>,
 ) -> Result<get_latest_backup_info::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -52,32 +55,37 @@ pub async fn get_latest_backup_info_route(
 	let (version, algorithm) = services()
 		.key_backups
 		.get_latest_backup(sender_user)?
-		.ok_or(Error::BadRequest(ErrorKind::NotFound, "Key backup does not exist."))?;
+		.ok_or_else(|| Error::BadRequest(ErrorKind::NotFound, "Key backup does not exist."))?;
 
 	Ok(get_latest_backup_info::v3::Response {
 		algorithm,
-		count: (services().key_backups.count_keys(sender_user, &version)? as u32).into(),
+		count: (UInt::try_from(services().key_backups.count_keys(sender_user, &version)?)
+			.expect("user backup keys count should not be that high")),
 		etag: services().key_backups.get_etag(sender_user, &version)?,
 		version,
 	})
 }
 
-/// # `GET /_matrix/client/r0/room_keys/version`
+/// # `GET /_matrix/client/v3/room_keys/version/{version}`
 ///
 /// Get information about an existing backup.
-pub async fn get_backup_info_route(body: Ruma<get_backup_info::v3::Request>) -> Result<get_backup_info::v3::Response> {
+pub(crate) async fn get_backup_info_route(
+	body: Ruma<get_backup_info::v3::Request>,
+) -> Result<get_backup_info::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let algorithm = services()
 		.key_backups
 		.get_backup(sender_user, &body.version)?
-		.ok_or(Error::BadRequest(ErrorKind::NotFound, "Key backup does not exist."))?;
+		.ok_or_else(|| Error::BadRequest(ErrorKind::NotFound, "Key backup does not exist."))?;
 
 	Ok(get_backup_info::v3::Response {
 		algorithm,
-		count: (services()
-			.key_backups
-			.count_keys(sender_user, &body.version)? as u32)
-			.into(),
+		count: (UInt::try_from(
+			services()
+				.key_backups
+				.count_keys(sender_user, &body.version)?,
+		)
+		.expect("user backup keys count should not be that high")),
 		etag: services()
 			.key_backups
 			.get_etag(sender_user, &body.version)?,
@@ -91,7 +99,7 @@ pub async fn get_backup_info_route(body: Ruma<get_backup_info::v3::Request>) ->
 ///
 /// - Deletes both information about the backup, as well as all key data related
 ///   to the backup
-pub async fn delete_backup_version_route(
+pub(crate) async fn delete_backup_version_route(
 	body: Ruma<delete_backup_version::v3::Request>,
 ) -> Result<delete_backup_version::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -111,7 +119,9 @@ pub async fn delete_backup_version_route(
 ///   allowed
 /// - Adds the keys to the backup
 /// - Returns the new number of keys in this backup and the etag
-pub async fn add_backup_keys_route(body: Ruma<add_backup_keys::v3::Request>) -> Result<add_backup_keys::v3::Response> {
+pub(crate) async fn add_backup_keys_route(
+	body: Ruma<add_backup_keys::v3::Request>,
+) -> Result<add_backup_keys::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	if Some(&body.version)
@@ -135,10 +145,12 @@ pub async fn add_backup_keys_route(body: Ruma<add_backup_keys::v3::Request>) ->
 	}
 
 	Ok(add_backup_keys::v3::Response {
-		count: (services()
-			.key_backups
-			.count_keys(sender_user, &body.version)? as u32)
-			.into(),
+		count: (UInt::try_from(
+			services()
+				.key_backups
+				.count_keys(sender_user, &body.version)?,
+		)
+		.expect("user backup keys count should not be that high")),
 		etag: services()
 			.key_backups
 			.get_etag(sender_user, &body.version)?,
@@ -153,7 +165,7 @@ pub async fn add_backup_keys_route(body: Ruma<add_backup_keys::v3::Request>) ->
 ///   allowed
 /// - Adds the keys to the backup
 /// - Returns the new number of keys in this backup and the etag
-pub async fn add_backup_keys_for_room_route(
+pub(crate) async fn add_backup_keys_for_room_route(
 	body: Ruma<add_backup_keys_for_room::v3::Request>,
 ) -> Result<add_backup_keys_for_room::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -177,10 +189,12 @@ pub async fn add_backup_keys_for_room_route(
 	}
 
 	Ok(add_backup_keys_for_room::v3::Response {
-		count: (services()
-			.key_backups
-			.count_keys(sender_user, &body.version)? as u32)
-			.into(),
+		count: (UInt::try_from(
+			services()
+				.key_backups
+				.count_keys(sender_user, &body.version)?,
+		)
+		.expect("user backup keys count should not be that high")),
 		etag: services()
 			.key_backups
 			.get_etag(sender_user, &body.version)?,
@@ -195,7 +209,7 @@ pub async fn add_backup_keys_for_room_route(
 ///   allowed
 /// - Adds the keys to the backup
 /// - Returns the new number of keys in this backup and the etag
-pub async fn add_backup_keys_for_session_route(
+pub(crate) async fn add_backup_keys_for_session_route(
 	body: Ruma<add_backup_keys_for_session::v3::Request>,
 ) -> Result<add_backup_keys_for_session::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -217,10 +231,12 @@ pub async fn add_backup_keys_for_session_route(
 		.add_key(sender_user, &body.version, &body.room_id, &body.session_id, &body.session_data)?;
 
 	Ok(add_backup_keys_for_session::v3::Response {
-		count: (services()
-			.key_backups
-			.count_keys(sender_user, &body.version)? as u32)
-			.into(),
+		count: (UInt::try_from(
+			services()
+				.key_backups
+				.count_keys(sender_user, &body.version)?,
+		)
+		.expect("user backup keys count should not be that high")),
 		etag: services()
 			.key_backups
 			.get_etag(sender_user, &body.version)?,
@@ -230,7 +246,9 @@ pub async fn add_backup_keys_for_session_route(
 /// # `GET /_matrix/client/r0/room_keys/keys`
 ///
 /// Retrieves all keys from the backup.
-pub async fn get_backup_keys_route(body: Ruma<get_backup_keys::v3::Request>) -> Result<get_backup_keys::v3::Response> {
+pub(crate) async fn get_backup_keys_route(
+	body: Ruma<get_backup_keys::v3::Request>,
+) -> Result<get_backup_keys::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	let rooms = services().key_backups.get_all(sender_user, &body.version)?;
@@ -243,7 +261,7 @@ pub async fn get_backup_keys_route(body: Ruma<get_backup_keys::v3::Request>) ->
 /// # `GET /_matrix/client/r0/room_keys/keys/{roomId}`
 ///
 /// Retrieves all keys from the backup for a given room.
-pub async fn get_backup_keys_for_room_route(
+pub(crate) async fn get_backup_keys_for_room_route(
 	body: Ruma<get_backup_keys_for_room::v3::Request>,
 ) -> Result<get_backup_keys_for_room::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -260,7 +278,7 @@ pub async fn get_backup_keys_for_room_route(
 /// # `GET /_matrix/client/r0/room_keys/keys/{roomId}/{sessionId}`
 ///
 /// Retrieves a key from the backup.
-pub async fn get_backup_keys_for_session_route(
+pub(crate) async fn get_backup_keys_for_session_route(
 	body: Ruma<get_backup_keys_for_session::v3::Request>,
 ) -> Result<get_backup_keys_for_session::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -268,10 +286,7 @@ pub async fn get_backup_keys_for_session_route(
 	let key_data = services()
 		.key_backups
 		.get_session(sender_user, &body.version, &body.room_id, &body.session_id)?
-		.ok_or(Error::BadRequest(
-			ErrorKind::NotFound,
-			"Backup key not found for this user's session.",
-		))?;
+		.ok_or_else(|| Error::BadRequest(ErrorKind::NotFound, "Backup key not found for this user's session."))?;
 
 	Ok(get_backup_keys_for_session::v3::Response {
 		key_data,
@@ -281,7 +296,7 @@ pub async fn get_backup_keys_for_session_route(
 /// # `DELETE /_matrix/client/r0/room_keys/keys`
 ///
 /// Delete the keys from the backup.
-pub async fn delete_backup_keys_route(
+pub(crate) async fn delete_backup_keys_route(
 	body: Ruma<delete_backup_keys::v3::Request>,
 ) -> Result<delete_backup_keys::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -291,10 +306,12 @@ pub async fn delete_backup_keys_route(
 		.delete_all_keys(sender_user, &body.version)?;
 
 	Ok(delete_backup_keys::v3::Response {
-		count: (services()
-			.key_backups
-			.count_keys(sender_user, &body.version)? as u32)
-			.into(),
+		count: (UInt::try_from(
+			services()
+				.key_backups
+				.count_keys(sender_user, &body.version)?,
+		)
+		.expect("user backup keys count should not be that high")),
 		etag: services()
 			.key_backups
 			.get_etag(sender_user, &body.version)?,
@@ -304,7 +321,7 @@ pub async fn delete_backup_keys_route(
 /// # `DELETE /_matrix/client/r0/room_keys/keys/{roomId}`
 ///
 /// Delete the keys from the backup for a given room.
-pub async fn delete_backup_keys_for_room_route(
+pub(crate) async fn delete_backup_keys_for_room_route(
 	body: Ruma<delete_backup_keys_for_room::v3::Request>,
 ) -> Result<delete_backup_keys_for_room::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -314,10 +331,12 @@ pub async fn delete_backup_keys_for_room_route(
 		.delete_room_keys(sender_user, &body.version, &body.room_id)?;
 
 	Ok(delete_backup_keys_for_room::v3::Response {
-		count: (services()
-			.key_backups
-			.count_keys(sender_user, &body.version)? as u32)
-			.into(),
+		count: (UInt::try_from(
+			services()
+				.key_backups
+				.count_keys(sender_user, &body.version)?,
+		)
+		.expect("user backup keys count should not be that high")),
 		etag: services()
 			.key_backups
 			.get_etag(sender_user, &body.version)?,
@@ -327,7 +346,7 @@ pub async fn delete_backup_keys_for_room_route(
 /// # `DELETE /_matrix/client/r0/room_keys/keys/{roomId}/{sessionId}`
 ///
 /// Delete a key from the backup.
-pub async fn delete_backup_keys_for_session_route(
+pub(crate) async fn delete_backup_keys_for_session_route(
 	body: Ruma<delete_backup_keys_for_session::v3::Request>,
 ) -> Result<delete_backup_keys_for_session::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -337,10 +356,12 @@ pub async fn delete_backup_keys_for_session_route(
 		.delete_room_key(sender_user, &body.version, &body.room_id, &body.session_id)?;
 
 	Ok(delete_backup_keys_for_session::v3::Response {
-		count: (services()
-			.key_backups
-			.count_keys(sender_user, &body.version)? as u32)
-			.into(),
+		count: (UInt::try_from(
+			services()
+				.key_backups
+				.count_keys(sender_user, &body.version)?,
+		)
+		.expect("user backup keys count should not be that high")),
 		etag: services()
 			.key_backups
 			.get_etag(sender_user, &body.version)?,

src/api/client_server/capabilities.rs

@@ -1,8 +1,7 @@
 use std::collections::BTreeMap;
 
 use ruma::api::client::discovery::get_capabilities::{
-	self, Capabilities, ChangePasswordCapability, RoomVersionStability, RoomVersionsCapability, SetAvatarUrlCapability,
-	SetDisplayNameCapability, ThirdPartyIdChangesCapability,
+	self, Capabilities, RoomVersionStability, RoomVersionsCapability, ThirdPartyIdChangesCapability,
 };
 
 use crate::{services, Result, Ruma};
@@ -11,7 +10,7 @@
 ///
 /// Get information on the supported feature set and other relevent capabilities
 /// of this server.
-pub async fn get_capabilities_route(
+pub(crate) async fn get_capabilities_route(
 	_body: Ruma<get_capabilities::v3::Request>,
 ) -> Result<get_capabilities::v3::Response> {
 	let mut available = BTreeMap::new();
@@ -22,24 +21,12 @@ pub async fn get_capabilities_route(
 		available.insert(room_version.clone(), RoomVersionStability::Stable);
 	}
 
-	let mut capabilities = Capabilities::new();
+	let mut capabilities = Capabilities::default();
 	capabilities.room_versions = RoomVersionsCapability {
 		default: services().globals.default_room_version(),
 		available,
 	};
 
-	capabilities.change_password = ChangePasswordCapability {
-		enabled: true,
-	};
-
-	capabilities.set_avatar_url = SetAvatarUrlCapability {
-		enabled: true,
-	};
-
-	capabilities.set_displayname = SetDisplayNameCapability {
-		enabled: true,
-	};
-
 	// conduit does not implement 3PID stuff
 	capabilities.thirdparty_id_changes = ThirdPartyIdChangesCapability {
 		enabled: false,

src/api/client_server/config.rs

@@ -5,6 +5,7 @@
 	},
 	events::{AnyGlobalAccountDataEventContent, AnyRoomAccountDataEventContent},
 	serde::Raw,
+	OwnedUserId, RoomId,
 };
 use serde::Deserialize;
 use serde_json::{json, value::RawValue as RawJsonValue};
@@ -14,25 +15,10 @@
 /// # `PUT /_matrix/client/r0/user/{userId}/account_data/{type}`
 ///
 /// Sets some account data for the sender user.
-pub async fn set_global_account_data_route(
+pub(crate) async fn set_global_account_data_route(
 	body: Ruma<set_global_account_data::v3::Request>,
 ) -> Result<set_global_account_data::v3::Response> {
-	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
-
-	let data: serde_json::Value = serde_json::from_str(body.data.json().get())
-		.map_err(|_| Error::BadRequest(ErrorKind::BadJson, "Data is invalid."))?;
-
-	let event_type = body.event_type.to_string();
-
-	services().account_data.update(
-		None,
-		sender_user,
-		event_type.clone().into(),
-		&json!({
-			"type": event_type,
-			"content": data,
-		}),
-	)?;
+	set_account_data(None, &body.sender_user, &body.event_type.to_string(), body.data.json())?;
 
 	Ok(set_global_account_data::v3::Response {})
 }
@@ -40,24 +26,14 @@ pub async fn set_global_account_data_route(
 /// # `PUT /_matrix/client/r0/user/{userId}/rooms/{roomId}/account_data/{type}`
 ///
 /// Sets some room account data for the sender user.
-pub async fn set_room_account_data_route(
+pub(crate) async fn set_room_account_data_route(
 	body: Ruma<set_room_account_data::v3::Request>,
 ) -> Result<set_room_account_data::v3::Response> {
-	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
-
-	let data: serde_json::Value = serde_json::from_str(body.data.json().get())
-		.map_err(|_| Error::BadRequest(ErrorKind::BadJson, "Data is invalid."))?;
-
-	let event_type = body.event_type.to_string();
-
-	services().account_data.update(
+	set_account_data(
 		Some(&body.room_id),
-		sender_user,
-		event_type.clone().into(),
-		&json!({
-			"type": event_type,
-			"content": data,
-		}),
+		&body.sender_user,
+		&body.event_type.to_string(),
+		body.data.json(),
 	)?;
 
 	Ok(set_room_account_data::v3::Response {})
@@ -66,7 +42,7 @@ pub async fn set_room_account_data_route(
 /// # `GET /_matrix/client/r0/user/{userId}/account_data/{type}`
 ///
 /// Gets some account data for the sender user.
-pub async fn get_global_account_data_route(
+pub(crate) async fn get_global_account_data_route(
 	body: Ruma<get_global_account_data::v3::Request>,
 ) -> Result<get_global_account_data::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -74,7 +50,7 @@ pub async fn get_global_account_data_route(
 	let event: Box<RawJsonValue> = services()
 		.account_data
 		.get(None, sender_user, body.event_type.to_string().into())?
-		.ok_or(Error::BadRequest(ErrorKind::NotFound, "Data not found."))?;
+		.ok_or_else(|| Error::BadRequest(ErrorKind::NotFound, "Data not found."))?;
 
 	let account_data = serde_json::from_str::<ExtractGlobalEventContent>(event.get())
 		.map_err(|_| Error::bad_database("Invalid account data event in db."))?
@@ -88,7 +64,7 @@ pub async fn get_global_account_data_route(
 /// # `GET /_matrix/client/r0/user/{userId}/rooms/{roomId}/account_data/{type}`
 ///
 /// Gets some room account data for the sender user.
-pub async fn get_room_account_data_route(
+pub(crate) async fn get_room_account_data_route(
 	body: Ruma<get_room_account_data::v3::Request>,
 ) -> Result<get_room_account_data::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -96,7 +72,7 @@ pub async fn get_room_account_data_route(
 	let event: Box<RawJsonValue> = services()
 		.account_data
 		.get(Some(&body.room_id), sender_user, body.event_type.clone())?
-		.ok_or(Error::BadRequest(ErrorKind::NotFound, "Data not found."))?;
+		.ok_or_else(|| Error::BadRequest(ErrorKind::NotFound, "Data not found."))?;
 
 	let account_data = serde_json::from_str::<ExtractRoomEventContent>(event.get())
 		.map_err(|_| Error::bad_database("Invalid account data event in db."))?
@@ -107,6 +83,27 @@ pub async fn get_room_account_data_route(
 	})
 }
 
+fn set_account_data(
+	room_id: Option<&RoomId>, sender_user: &Option<OwnedUserId>, event_type: &str, data: &RawJsonValue,
+) -> Result<()> {
+	let sender_user = sender_user.as_ref().expect("user is authenticated");
+
+	let data: serde_json::Value =
+		serde_json::from_str(data.get()).map_err(|_| Error::BadRequest(ErrorKind::BadJson, "Data is invalid."))?;
+
+	services().account_data.update(
+		room_id,
+		sender_user,
+		event_type.into(),
+		&json!({
+			"type": event_type,
+			"content": data,
+		}),
+	)?;
+
+	Ok(())
+}
+
 #[derive(Deserialize)]
 struct ExtractRoomEventContent {
 	content: Raw<AnyRoomAccountDataEventContent>,

src/api/client_server/context.rs

@@ -15,7 +15,7 @@
 /// - Only works if the user is joined (TODO: always allow, but only show events
 ///   if the user was
 /// joined, depending on history_visibility)
-pub async fn get_context_route(body: Ruma<get_context::v3::Request>) -> Result<get_context::v3::Response> {
+pub(crate) async fn get_context_route(body: Ruma<get_context::v3::Request>) -> Result<get_context::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let sender_device = body.sender_device.as_ref().expect("user is authenticated");
 
@@ -63,8 +63,8 @@ pub async fn get_context_route(body: Ruma<get_context::v3::Request>) -> Result<g
 		lazy_loaded.insert(base_event.sender.as_str().to_owned());
 	}
 
-	// Use limit with maximum 100
-	let limit = u64::from(body.limit).min(100) as usize;
+	// Use limit or else 10, with maximum 100
+	let limit = usize::try_from(body.limit).unwrap_or(10).min(100);
 
 	let base_event = base_event.to_room_event();
 
@@ -163,7 +163,7 @@ pub async fn get_context_route(body: Ruma<get_context::v3::Request>) -> Result<g
 		.map(|(_, pdu)| pdu.to_room_event())
 		.collect();
 
-	let mut state = Vec::new();
+	let mut state = Vec::with_capacity(state_ids.len());
 
 	for (shortstatekey, id) in state_ids {
 		let (event_type, state_key) = services()
@@ -188,14 +188,12 @@ pub async fn get_context_route(body: Ruma<get_context::v3::Request>) -> Result<g
 		}
 	}
 
-	let resp = get_context::v3::Response {
+	Ok(get_context::v3::Response {
 		start: Some(start_token),
 		end: Some(end_token),
 		events_before,
 		event: Some(base_event),
 		events_after,
 		state,
-	};
-
-	Ok(resp)
+	})
 }

src/api/client_server/device.rs

@@ -10,7 +10,7 @@
 /// # `GET /_matrix/client/r0/devices`
 ///
 /// Get metadata on all devices of the sender user.
-pub async fn get_devices_route(body: Ruma<get_devices::v3::Request>) -> Result<get_devices::v3::Response> {
+pub(crate) async fn get_devices_route(body: Ruma<get_devices::v3::Request>) -> Result<get_devices::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	let devices: Vec<device::Device> = services()
@@ -27,7 +27,7 @@ pub async fn get_devices_route(body: Ruma<get_devices::v3::Request>) -> Result<g
 /// # `GET /_matrix/client/r0/devices/{deviceId}`
 ///
 /// Get metadata on a single device of the sender user.
-pub async fn get_device_route(body: Ruma<get_device::v3::Request>) -> Result<get_device::v3::Response> {
+pub(crate) async fn get_device_route(body: Ruma<get_device::v3::Request>) -> Result<get_device::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	let device = services()
@@ -43,7 +43,7 @@ pub async fn get_device_route(body: Ruma<get_device::v3::Request>) -> Result<get
 /// # `PUT /_matrix/client/r0/devices/{deviceId}`
 ///
 /// Updates the metadata on a given device of the sender user.
-pub async fn update_device_route(body: Ruma<update_device::v3::Request>) -> Result<update_device::v3::Response> {
+pub(crate) async fn update_device_route(body: Ruma<update_device::v3::Request>) -> Result<update_device::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	let mut device = services()
@@ -70,7 +70,7 @@ pub async fn update_device_route(body: Ruma<update_device::v3::Request>) -> Resu
 ///   last seen ts)
 /// - Forgets to-device events
 /// - Triggers device list updates
-pub async fn delete_device_route(body: Ruma<delete_device::v3::Request>) -> Result<delete_device::v3::Response> {
+pub(crate) async fn delete_device_route(body: Ruma<delete_device::v3::Request>) -> Result<delete_device::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let sender_device = body.sender_device.as_ref().expect("user is authenticated");
 
@@ -122,7 +122,9 @@ pub async fn delete_device_route(body: Ruma<delete_device::v3::Request>) -> Resu
 ///   last seen ts)
 /// - Forgets to-device events
 /// - Triggers device list updates
-pub async fn delete_devices_route(body: Ruma<delete_devices::v3::Request>) -> Result<delete_devices::v3::Response> {
+pub(crate) async fn delete_devices_route(
+	body: Ruma<delete_devices::v3::Request>,
+) -> Result<delete_devices::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let sender_device = body.sender_device.as_ref().expect("user is authenticated");
 

src/api/client_server/directory.rs

@@ -20,18 +20,18 @@
 		},
 		StateEventType,
 	},
-	ServerName, UInt,
+	uint, ServerName, UInt,
 };
 use tracing::{error, info, warn};
 
-use crate::{services, Error, Result, Ruma};
+use crate::{service::server_is_ours, services, Error, Result, Ruma};
 
 /// # `POST /_matrix/client/v3/publicRooms`
 ///
 /// Lists the public rooms on this server.
 ///
 /// - Rooms are ordered by the number of joined members
-pub async fn get_public_rooms_filtered_route(
+pub(crate) async fn get_public_rooms_filtered_route(
 	body: Ruma<get_public_rooms_filtered::v3::Request>,
 ) -> Result<get_public_rooms_filtered::v3::Response> {
 	if let Some(server) = &body.server {
@@ -68,7 +68,7 @@ pub async fn get_public_rooms_filtered_route(
 /// Lists the public rooms on this server.
 ///
 /// - Rooms are ordered by the number of joined members
-pub async fn get_public_rooms_route(
+pub(crate) async fn get_public_rooms_route(
 	body: Ruma<get_public_rooms::v3::Request>,
 ) -> Result<get_public_rooms::v3::Response> {
 	if let Some(server) = &body.server {
@@ -110,7 +110,7 @@ pub async fn get_public_rooms_route(
 /// Sets the visibility of a given room in the room directory.
 ///
 /// - TODO: Access control checks
-pub async fn set_room_visibility_route(
+pub(crate) async fn set_room_visibility_route(
 	body: Ruma<set_room_visibility::v3::Request>,
 ) -> Result<set_room_visibility::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -153,7 +153,7 @@ pub async fn set_room_visibility_route(
 /// # `GET /_matrix/client/r0/directory/list/room/{roomId}`
 ///
 /// Gets the visibility of a given room in the room directory.
-pub async fn get_room_visibility_route(
+pub(crate) async fn get_room_visibility_route(
 	body: Ruma<get_room_visibility::v3::Request>,
 ) -> Result<get_room_visibility::v3::Response> {
 	if !services().rooms.metadata.exists(&body.room_id)? {
@@ -173,7 +173,7 @@ pub async fn get_room_visibility_route(
 pub(crate) async fn get_public_rooms_filtered_helper(
 	server: Option<&ServerName>, limit: Option<UInt>, since: Option<&str>, filter: &Filter, _network: &RoomNetwork,
 ) -> Result<get_public_rooms_filtered::v3::Response> {
-	if let Some(other_server) = server.filter(|server| *server != services().globals.server_name().as_str()) {
+	if let Some(other_server) = server.filter(|server_name| !server_is_ours(server_name)) {
 		let response = services()
 			.sending
 			.send_federation_request(
@@ -198,8 +198,9 @@ pub(crate) async fn get_public_rooms_filtered_helper(
 		});
 	}
 
+	// Use limit or else 10, with maximum 100
 	let limit = limit.map_or(10, u64::from);
-	let mut num_since = 0_u64;
+	let mut num_since: u64 = 0;
 
 	if let Some(s) = &since {
 		let mut characters = s.chars();
@@ -363,12 +364,16 @@ pub(crate) async fn get_public_rooms_filtered_helper(
 
 	all_rooms.sort_by(|l, r| r.num_joined_members.cmp(&l.num_joined_members));
 
-	let total_room_count_estimate = (all_rooms.len() as u32).into();
+	let total_room_count_estimate = UInt::try_from(all_rooms.len()).unwrap_or_else(|_| uint!(0));
 
 	let chunk: Vec<_> = all_rooms
 		.into_iter()
-		.skip(num_since as usize)
-		.take(limit as usize)
+		.skip(
+			num_since
+				.try_into()
+				.expect("num_since should not be this high"),
+		)
+		.take(limit.try_into().expect("limit should not be this high"))
 		.collect();
 
 	let prev_batch = if num_since == 0 {
@@ -377,10 +382,15 @@ pub(crate) async fn get_public_rooms_filtered_helper(
 		Some(format!("p{num_since}"))
 	};
 
-	let next_batch = if chunk.len() < limit as usize {
+	let next_batch = if chunk.len() < limit.try_into().unwrap() {
 		None
 	} else {
-		Some(format!("n{}", num_since + limit))
+		Some(format!(
+			"n{}",
+			num_since
+				.checked_add(limit)
+				.expect("num_since and limit should not be that large")
+		))
 	};
 
 	Ok(get_public_rooms_filtered::v3::Response {