ci: dont publish -rc tags as latest docker branches

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

.dockerignore

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

.editorconfig

@@ -0,0 +1,20 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+tab_width = 4
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+max_line_length = 120
+
+[*.{md,txt}]
+indent_style = space
+indent_size = 4
+max_line_length = 80
+
+[*.nix]
+indent_size = 2

.envrc

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

.git-blame-ignore-revs

@@ -0,0 +1,7 @@
+# .git-blame-ignore-revs
+# adds a proper rustfmt.toml and formats the entire codebase
+1d1ac065141181438e744e7d8abd0e45f75a2f91
+f419c64aca300a338096b4e0db4c73ace54f23d0
+# use chain_width 60
+162948313c212193965dece50b816ef0903172ba
+5998a0d883d31b866f7c8c46433a8857eae51a89

.gitea/workflows/ci.yml

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

.github/workflows/ci.yml

@@ -1,227 +1,392 @@
 name: CI and Artifacts
 
 on:
-  pull_request:
-  push:
-    branches:
-      - main
+    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
+            - change-ci-cache
+        tags:
+          - '*'
+    # 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
-  ATTIC_TOKEN: ${{ secrets.ATTIC_TOKEN }}
+    # Required to make some things output color
+    TERM: ansi
+    # Publishing to my nix binary cache
+    ATTIC_TOKEN: ${{ secrets.ATTIC_TOKEN }}
+    # conduwuit.cachix.org
+    CACHIX_AUTH_TOKEN: ${{ secrets.CACHIX_AUTH_TOKEN }}
+    # Just in case incremental is still being set to true, speeds up CI
+    CARGO_INCREMENTAL: 0
+    # Custom nix binary cache if fork is being used
+    ATTIC_ENDPOINT: ${{ vars.ATTIC_ENDPOINT }}
+    ATTIC_PUBLIC_KEY: ${{ vars.ATTIC_PUBLIC_KEY }}
+    # Get error output from nix that we can actually use, and use our binary caches for the earlier CI steps
+    NIX_CONFIG: |
+      show-trace = true
+      extra-substituters = https://attic.kennel.juneis.dog/conduit https://attic.kennel.juneis.dog/conduwuit https://cache.lix.systems https://conduwuit.cachix.org
+      extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk= conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o= conduwuit.cachix.org-1:MFRm6jcnfTf0jSAbmvLfhO3KBMt4px+1xaereWXp8Xg=
+
+permissions:
+    packages: write
+    contents: read
 
 jobs:
-  ci:
-    name: CI and Artifacts
+    tests:
+        name: Test
+        runs-on: ubuntu-latest
+        steps:
+            - name: Free Disk Space (Ubuntu)
+              uses: jlumbroso/free-disk-space@main
 
-    runs-on: ubuntu-latest
+            - name: Sync repository
+              uses: actions/checkout@v4
 
-    steps:
-      - name: Sync repository
-        uses: actions/checkout@v4
+            - name: Tag comparison check
+              if: ${{ startsWith(github.ref, 'refs/tags/v') && !endsWith(github.ref, '-rc') }}
+              run: |
+                  # Tag mismatch with latest repo tag check to prevent potential downgrades
+                  LATEST_TAG=$(git describe --tags `git rev-list --tags --max-count=1`)
 
-      - name: Install Nix (with flakes and nix-command enabled)
-        uses: cachix/install-nix-action@v25
-        with:
-          nix_path: nixpkgs=channel:nixos-unstable
+                  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
 
-          # Add the `nix-community` cachix to speed up things that leverage it
-          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=
+            - uses: nixbuild/nix-quick-install-action@v28
 
-      - 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: Restore and cache Nix store
+              uses: nix-community/cache-nix-action@v5.1.0
+              with:
+                # restore and save a cache using this key
+                primary-key: nix-${{ runner.os }}-${{ hashFiles('**/*.nix', '**/.lock') }}
+                # if there's no cache hit, restore a cache by this prefix
+                restore-prefixes-first-match: nix-${{ runner.os }}-
+                # collect garbage until Nix store size (in bytes) is at most this number
+                # before trying to save a new cache
+                gc-max-store-size-linux: 2073741824
+                # do purge caches
+                purge: true
+                # purge all versions of the cache
+                purge-prefixes: nix-${{ runner.os }}-
+                # created more than this number of seconds ago relative to the start of the `Post Restore` phase
+                purge-last-accessed: 86400
+                # except the version with the `primary-key`, if it exists
+                purge-primary-key: never
+                # always save the cache
+                save-always: true
 
-      - name: 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 "${XDG_CONFIG_HOME:-$HOME/.config}/nix/nix.conf" > /dev/null <<EOF
+                  extra-substituters = https://attic.kennel.juneis.dog/conduit https://attic.kennel.juneis.dog/conduwuit https://cache.lix.systems https://conduwuit.cachix.org
+                  extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk= conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o= conduwuit.cachix.org-1:MFRm6jcnfTf0jSAbmvLfhO3KBMt4px+1xaereWXp8Xg=
+                  EOF
 
-      - name: 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 "${XDG_CONFIG_HOME:-$HOME/.config}/nix/nix.conf" > /dev/null <<EOF
+                  extra-substituters = ${{ env.ATTIC_ENDPOINT }}
+                  extra-trusted-public-keys = ${{ env.ATTIC_PUBLIC_KEY }}
+                  EOF
 
-      - name: Pop/push 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 --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: Perform continuous integration
-        run: |
-          direnv allow
-          direnv exec . engage
+            - uses: Swatinem/rust-cache@v2
 
-      - name: Build static-x86_64-unknown-linux-musl
-        run: |
-          ./bin/nix-build-and-cache .#static-x86_64-unknown-linux-musl
+            - name: Run CI tests
+              run: |
+                  direnv exec . engage > >(tee -a test_output.log)
 
-      - name: Upload artifact static-x86_64-unknown-linux-musl
-        uses: actions/upload-artifact@v4
-        with:
-          name: static-x86_64-unknown-linux-musl
-          path: result/bin/conduit
-          if-no-files-found: error
+            - name: Run Complement tests
+              run: |
+                  # the nix devshell sets $COMPLEMENT_SRC, so "/dev/null" is no-op
+                  direnv exec . bin/complement "/dev/null" complement_test_logs.jsonl complement_test_results.jsonl > >(tee -a test_output.log)
+                  cp -v -f result complement_oci_image.tar.gz
 
-      - name: Build static-aarch64-unknown-linux-musl
-        run: |
-          ./bin/nix-build-and-cache .#static-aarch64-unknown-linux-musl
+            - name: Upload Complement OCI image
+              uses: actions/upload-artifact@v4
+              with:
+                name: complement_oci_image.tar.gz
+                path: complement_oci_image.tar.gz
+                if-no-files-found: error
 
-      - name: Upload artifact static-aarch64-unknown-linux-musl
-        uses: actions/upload-artifact@v4
-        with:
-          name: static-aarch64-unknown-linux-musl
-          path: result/bin/conduit
-          if-no-files-found: error
+            - 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: Build oci-image-x86_64-unknown-linux-gnu
-        run: |
-          ./bin/nix-build-and-cache .#oci-image
-          cp -f result oci-image-amd64.tar.gz
+            - 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: Upload artifact oci-image-x86_64-unknown-linux-gnu
-        uses: actions/upload-artifact@v4
-        with:
-          name: oci-image-x86_64-unknown-linux-gnu
-          path: oci-image-amd64.tar.gz
-          # don't compress again
-          compression-level: 0
+            - 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_diff_output.log)
 
-      - name: Build oci-image-aarch64-unknown-linux-musl
-        run: |
-          ./bin/nix-build-and-cache .#oci-image-aarch64-unknown-linux-musl
-          cp -f result oci-image-arm64v8.tar.gz
+            - name: Update Job Summary
+              if: success() || failure()
+              run: |
+                  if [ ${{ job.status }} == 'success' ]; then
+                      echo '# ✅ completed suwuccessfully' >> $GITHUB_STEP_SUMMARY
+                  else
+                      echo '# CI failure' >> $GITHUB_STEP_SUMMARY
+                      echo '```' >> $GITHUB_STEP_SUMMARY
+                      tail -n 40 test_output.log | sed 's/\x1b\[[0-9;]*m//g' >> $GITHUB_STEP_SUMMARY
+                      echo '```' >> $GITHUB_STEP_SUMMARY
 
-      - name: Upload artifact oci-image-aarch64-unknown-linux-musl
-        uses: actions/upload-artifact@v4
-        with:
-          name: oci-image-aarch64-unknown-linux-musl
-          path: oci-image-arm64v8.tar.gz
-          if-no-files-found: error
-          # don't compress again
-          compression-level: 0
+                      echo '# Complement diff results' >> $GITHUB_STEP_SUMMARY
+                      echo '```diff' >> $GITHUB_STEP_SUMMARY
+                      tail -n 100 complement_diff_output.log | sed 's/\x1b\[[0-9;]*m//g' >>     $GITHUB_STEP_SUMMARY
+                      echo '```' >> $GITHUB_STEP_SUMMARY
+                  fi
 
-      - name: Build deb-x86_64-unknown-linux-gnu
-        run: |
-          sudo apt-get update && sudo apt-get install -y --no-install-recommends libclang-dev
-          cargo install cargo-deb
-          cargo deb
+    build:
+        name: Build
+        runs-on: ubuntu-latest
+        needs: tests
+        strategy:
+            matrix:
+                include:
+                    - target: aarch64-unknown-linux-musl
+                    - target: x86_64-unknown-linux-musl
+        steps:
+            - name: Sync repository
+              uses: actions/checkout@v4
 
-      - name: Upload artifact deb-x86_64-unknown-linux-gnu
-        uses: actions/upload-artifact@v4
-        with:
-          name: deb-x86_64-unknown-linux-gnu
-          path: target/debian/*.deb
-          if-no-files-found: error
+            - uses: nixbuild/nix-quick-install-action@v28
 
-      - name: Extract metadata for Dockerhub
+            - name: Enable Cachix binary cache
+              run: |
+                  nix profile install nixpkgs#cachix
+                  cachix use crane
+                  cachix use nix-community
+
+            - name: Restore and cache Nix store
+              uses: nix-community/cache-nix-action@v5.1.0
+              with:
+                # restore and save a cache using this key
+                primary-key: nix-${{ runner.os }}-${{ matrix.target }}-${{ hashFiles('**/*.nix', '**/.lock') }}
+                # if there's no cache hit, restore a cache by this prefix
+                restore-prefixes-first-match: nix-${{ runner.os }}-
+                # collect garbage until Nix store size (in bytes) is at most this number
+                # before trying to save a new cache
+                gc-max-store-size-linux: 2073741824
+                # do purge caches
+                purge: true
+                # purge all versions of the cache
+                purge-prefixes: nix-${{ runner.os }}-
+                # created more than this number of seconds ago relative to the start of the `Post Restore` phase
+                purge-last-accessed: 86400
+                # except the version with the `primary-key`, if it exists
+                purge-primary-key: never
+                # always save the cache
+                save-always: true
+
+            - name: Apply Nix binary cache configuration
+              run: |
+                  sudo tee -a "${XDG_CONFIG_HOME:-$HOME/.config}/nix/nix.conf" > /dev/null <<EOF
+                  extra-substituters = https://attic.kennel.juneis.dog/conduit https://attic.kennel.juneis.dog/conduwuit https://cache.lix.systems https://conduwuit.cachix.org
+                  extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk= conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o= conduwuit.cachix.org-1:MFRm6jcnfTf0jSAbmvLfhO3KBMt4px+1xaereWXp8Xg=
+                  EOF
+
+            - name: Use alternative Nix binary caches if specified
+              if: ${{ (env.ATTIC_ENDPOINT != '') && (env.ATTIC_PUBLIC_KEY != '') }}
+              run: |
+                  sudo tee -a "${XDG_CONFIG_HOME:-$HOME/.config}/nix/nix.conf" > /dev/null <<EOF
+                  extra-substituters = ${{ env.ATTIC_ENDPOINT }}
+                  extra-trusted-public-keys = ${{ env.ATTIC_PUBLIC_KEY }}
+                  EOF
+
+            - name: Prepare build environment
+              run: |
+                  echo 'source $HOME/.nix-profile/share/nix-direnv/direnvrc' > "$HOME/.direnvrc"
+                  nix profile install --inputs-from . nixpkgs#direnv nixpkgs#nix-direnv
+                  direnv allow
+                  nix develop .#all-features --command true
+
+            - name: Build static ${{ matrix.target }}
+              run: |
+                  CARGO_DEB_TARGET_TUPLE=$(echo ${{ matrix.target }} | grep -o -E '^([^-]*-){3}[^-]*')
+                  SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct)
+
+                  bin/nix-build-and-cache just .#static-${{ matrix.target }}-all-features
+                  mkdir -v -p target/release/
+                  mkdir -v -p target/$CARGO_DEB_TARGET_TUPLE/release/
+                  cp -v -f result/bin/conduit target/release/conduwuit
+                  cp -v -f result/bin/conduit target/$CARGO_DEB_TARGET_TUPLE/release/conduwuit
+                  # -p conduit is the main crate name
+                  direnv exec . cargo deb --verbose --no-build --no-strip -p conduit --target=$CARGO_DEB_TARGET_TUPLE --output target/release/${{ matrix.target }}.deb
+                  mv -v target/release/conduwuit static-${{ matrix.target }}
+                  mv -v target/release/${{ matrix.target }}.deb ${{ matrix.target }}.deb
+
+            - 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: 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 }}-all-features
+                  cp -v -f result oci-image-${{ matrix.target }}.tar.gz
+
+            - 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
+
+    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 != '') && github.event.pull_request.user.login != 'renovate[bot]'
         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 }}
+            DOCKER_ARM64: docker.io/${{ github.repository }}:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}-arm64v8
+            DOCKER_AMD64: docker.io/${{ github.repository }}:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}-amd64
+            DOCKER_TAG: docker.io/${{ github.repository }}:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}
+            DOCKER_BRANCH: docker.io/${{ github.repository }}:${{ (startsWith(github.ref, 'refs/tags/v') && !endsWith(github.ref, '-rc') && 'latest') || (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}
+            GHCR_ARM64: ghcr.io/${{ github.repository }}:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}-arm64v8
+            GHCR_AMD64: ghcr.io/${{ github.repository }}:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}-amd64
+            GHCR_TAG: ghcr.io/${{ github.repository }}:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}
+            GHCR_BRANCH: ghcr.io/${{ github.repository }}:${{ (startsWith(github.ref, 'refs/tags/v') && !endsWith(github.ref, '-rc') && 'latest') || (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}
+            GLCR_ARM64: registry.gitlab.com/conduwuit/conduwuit:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}-arm64v8
+            GLCR_AMD64: registry.gitlab.com/conduwuit/conduwuit:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}-amd64
+            GLCR_TAG: registry.gitlab.com/conduwuit/conduwuit:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}
+            GLCR_BRANCH: registry.gitlab.com/conduwuit/conduwuit:${{ (startsWith(github.ref, 'refs/tags/v') && !endsWith(github.ref, '-rc') && 'latest') || (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}
 
-      - 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 }}
+            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 }}
 
-      - name: Login to Dockerhub
-        if: github.event_name != 'pull_request'
-        uses: docker/login-action@v3
-        with:
-          username: girlbossceo
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
+            - 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 GitHub Container Registry
-        if: github.event_name != 'pull_request'
-        uses: docker/login-action@v3
-        env:
-          REGISTRY: ghcr.io
-        with:
-          registry: ${{ env.REGISTRY }}
-          username: girlbossceo
-          password: ${{ secrets.GITHUB_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: Publish to Dockerhub
-        if: github.event_name != 'pull_request'
-        env:
-          IMAGE_NAME: docker.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)
+            - name: Download artifacts
+              uses: actions/download-artifact@v4
 
-          # 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 git tags as 'latest'
-          if [[ -n "$GITHUB_REF_NAME" ]]; 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: 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: 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)
+            - 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 }}
 
-          # 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 git tags as 'latest'
-          if [[ -n "$GITHUB_REF_NAME" ]]; 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: 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

@@ -0,0 +1,139 @@
+name: Documentation and GitHub Pages
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+    tags:
+      - '*'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+env:
+  # Required to make some things output color
+  TERM: ansi
+  # Publishing to my nix binary cache
+  ATTIC_TOKEN: ${{ secrets.ATTIC_TOKEN }}
+  # conduwuit.cachix.org
+  CACHIX_AUTH_TOKEN: ${{ secrets.CACHIX_AUTH_TOKEN }}
+  # Custom nix binary cache if fork is being used
+  ATTIC_ENDPOINT: ${{ vars.ATTIC_ENDPOINT }}
+  ATTIC_PUBLIC_KEY: ${{ vars.ATTIC_PUBLIC_KEY }}
+  # Get error output from nix that we can actually use, and use our binary caches for the earlier CI steps
+  NIX_CONFIG: |
+    show-trace = true
+    extra-substituters = https://attic.kennel.juneis.dog/conduit https://attic.kennel.juneis.dog/conduwuit https://cache.lix.systems https://conduwuit.cachix.org
+    extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk= conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o= conduwuit.cachix.org-1:MFRm6jcnfTf0jSAbmvLfhO3KBMt4px+1xaereWXp8Xg=
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  docs:
+    name: Documentation and GitHub Pages
+    runs-on: ubuntu-latest
+
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Sync repository
+        uses: actions/checkout@v4
+
+      - name: Setup GitHub Pages
+        if: github.event_name != 'pull_request'
+        uses: actions/configure-pages@v5
+
+      - uses: nixbuild/nix-quick-install-action@v28
+
+      - name: Enable Cachix binary cache
+        run: |
+            nix profile install nixpkgs#cachix
+            cachix use crane
+            cachix use nix-community
+
+      - name: Restore and cache Nix store
+        uses: nix-community/cache-nix-action@v5.1.0
+        with:
+          # restore and save a cache using this key
+          primary-key: nix-${{ runner.os }}-${{ hashFiles('**/*.nix', '**/.lock') }}
+          # if there's no cache hit, restore a cache by this prefix
+          restore-prefixes-first-match: nix-${{ runner.os }}-
+          # collect garbage until Nix store size (in bytes) is at most this number
+          # before trying to save a new cache
+          gc-max-store-size-linux: 2073741824
+          # do purge caches
+          purge: true
+          # purge all versions of the cache
+          purge-prefixes: nix-${{ runner.os }}-
+          # created more than this number of seconds ago relative to the start of the `Post Restore` phase
+          purge-last-accessed: 86400
+          # except the version with the `primary-key`, if it exists
+          purge-primary-key: never
+          # always save the cache
+          save-always: true
+
+      - name: Apply Nix binary cache configuration
+        run: |
+            sudo tee -a "${XDG_CONFIG_HOME:-$HOME/.config}/nix/nix.conf" > /dev/null <<EOF
+            extra-substituters = https://attic.kennel.juneis.dog/conduit https://attic.kennel.juneis.dog/conduwuit https://cache.lix.systems https://conduwuit.cachix.org
+            extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk= conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o= conduwuit.cachix.org-1:MFRm6jcnfTf0jSAbmvLfhO3KBMt4px+1xaereWXp8Xg=
+            EOF
+
+      - name: Use alternative Nix binary caches if specified
+        if: ${{ (env.ATTIC_ENDPOINT != '') && (env.ATTIC_PUBLIC_KEY != '') }}
+        run: |
+            sudo tee -a "${XDG_CONFIG_HOME:-$HOME/.config}/nix/nix.conf" > /dev/null <<EOF
+            extra-substituters = ${{ env.ATTIC_ENDPOINT }}
+            extra-trusted-public-keys = ${{ env.ATTIC_PUBLIC_KEY }}
+            EOF
+
+      - name: Prepare build environment
+        run: |
+            echo 'source $HOME/.nix-profile/share/nix-direnv/direnvrc' > "$HOME/.direnvrc"
+            nix profile install --inputs-from . nixpkgs#direnv nixpkgs#nix-direnv
+            direnv allow
+            nix develop --command true
+
+      - name: Cache CI dependencies
+        run: |
+            bin/nix-build-and-cache ci
+
+      - name: Run lychee and markdownlint
+        run: |
+            direnv exec . engage just lints lychee
+            direnv exec . engage just lints markdownlint
+
+      - name: Build documentation (book)
+        run: |
+          ./bin/nix-build-and-cache just .#book
+          cp -r --dereference result public
+      - name: Upload generated documentation (book) as normal artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: public
+          path: public
+          if-no-files-found: error
+          # don't compress again
+          compression-level: 0
+
+      - name: Upload generated documentation (book) as GitHub Pages artifact
+        if: github.event_name != 'pull_request'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: public
+
+      - name: Deploy to GitHub Pages
+        if: github.event_name != 'pull_request'
+        id: deployment
+        uses: actions/deploy-pages@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.17.0
+        uses: aquasecurity/trivy-action@0.24.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.17.0
+        uses: aquasecurity/trivy-action@0.24.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-*/
 
@@ -73,4 +76,22 @@ test-conduit/
 test-conduit.toml
 
 # Gitlab CI cache
-/.gitlab-ci.d
+/.gitlab-ci.d
+
+# mdbook output
+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,22 +6,49 @@ stages:
 variables:
   # Makes some things print in color
   TERM: ansi
-  NIX_CONFIG: |
-    experimental-features = nix-command flake
-    extra-substituters = https://nix.computer.surgery/conduit
-    extra-trusted-public-keys = conduit:ZGAf6P6LhNvnoJJ3Me3PRg7tlLSrPxcQ2RiE5LIppjo=
-    extra-substituters = https://crane.cachix.org
-    extra-trusted-public-keys = crane.cachix.org-1:8Scfpmn9w+hGdXH/Q9tTLiYAE/2dnJYRJP7kl80GuRk=
-    extra-substituters = https://nix-community.cachix.org
-    extra-trusted-public-keys = nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs=
-    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=
+  # 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
+workflow:
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    - if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS
+      when: never
+    - if: $CI
 
 before_script:
+  # Enable nix-command and flakes
+  - if command -v nix > /dev/null; then echo "experimental-features = nix-command flakes" >> /etc/nix/nix.conf; fi
+
+  # 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: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: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
+
+  # Add nix-community binary cache
+  - if command -v nix > /dev/null; then echo "extra-substituters = https://nix-community.cachix.org" >> /etc/nix/nix.conf; fi
+  - if command -v nix > /dev/null; then echo "extra-trusted-public-keys = nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs=" >> /etc/nix/nix.conf; fi
+
   # Install direnv and nix-direnv
-  - if command -v nix > /dev/null; then nix-env -iA nixpkgs.direnv nixpkgs.nix-direnv nixpkgs.engage; fi
+  - if command -v nix > /dev/null; then nix-env -iA nixpkgs.direnv nixpkgs.nix-direnv; fi
 
   # Allow .envrc
   - if command -v nix > /dev/null; then direnv allow; fi
@@ -31,134 +58,87 @@ before_script:
 
 ci:
   stage: ci
-  image: nixos/nix:2.20.2
+  image: nixos/nix:2.23.3
   script:
+    # Cache CI dependencies
+    - ./bin/nix-build-and-cache ci
+
     - direnv exec . engage
   cache:
     key: nix
     paths:
       - target
       - .gitlab-ci.d
+  rules:
+    # CI on upstream runners (only available for maintainers)
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event" && $IS_UPSTREAM_CI == "true"
+    # Manual CI on unprotected branches that are not MRs
+    - if: $CI_PIPELINE_SOURCE != "merge_request_event" && $CI_COMMIT_REF_PROTECTED == "false"
+      when: manual
+    # Manual CI on forks
+    - if: $IS_UPSTREAM_CI != "true"
+      when: manual
+    - if: $CI
+  interruptible: true
 
-static:x86_64-unknown-linux-musl:
+artifacts:
   stage: artifacts
-  image: nixos/nix:2.20.2
+  image: nixos/nix:2.23.3
   script:
-    # Push artifacts and build requirements to binary cache
-    - ./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
 
-    # Make the output less difficult to find
-    - cp result/bin/conduit conduit
-  artifacts:
-    paths:
-      - conduit
+    - mkdir -p target/release
+    - cp result/bin/conduit target/release
+    - direnv exec . cargo deb --no-build --no-strip
+    - mv target/debian/*.deb x86_64-unknown-linux-musl.deb
 
-static:aarch64-unknown-linux-musl:
-  stage: artifacts
-  image: nixos/nix:2.20.2
-  script:
-    # Push artifacts and build requirements to binary cache
-    - ./bin/nix-build-and-cache .#static-aarch64-unknown-linux-musl
-
-    # Make the output less difficult to find
-    - cp result/bin/conduit conduit
-  artifacts:
-    paths:
-      - conduit
-
-# 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.
-oci-image:x86_64-unknown-linux-gnu:
-  stage: artifacts
-  image: nixos/nix:2.20.2
-  script:
-    # Push artifacts and build requirements to binary cache
-    #
     # Since the OCI image package is based on the binary package, this has the
     # fun side effect of uploading the normal binary too. Conduit users who are
     # deploying with Nix can leverage this fact by adding our binary cache to
     # their systems.
-    - ./bin/nix-build-and-cache .#oci-image
-
-    # Make the output less difficult to find
+    #
+    # 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 just .#oci-image
     - cp result oci-image-amd64.tar.gz
-  artifacts:
-    paths:
-      - oci-image-amd64.tar.gz
 
-oci-image:aarch64-unknown-linux-musl:
-  stage: artifacts
-  needs:
-    # Wait for the static binary job to finish before starting so we don't have
-    # to build that twice for no reason
-    - static:aarch64-unknown-linux-musl
-  image: nixos/nix:2.20.2
-  script:
-    # Push artifacts and build requirements to binary cache
-    - ./bin/nix-build-and-cache .#oci-image-aarch64-unknown-linux-musl
+    - ./bin/nix-build-and-cache just .#static-aarch64-unknown-linux-musl
+    - cp result/bin/conduit aarch64-unknown-linux-musl
 
-    # Make the output less difficult to find
+    - ./bin/nix-build-and-cache just .#oci-image-aarch64-unknown-linux-musl
     - cp result oci-image-arm64v8.tar.gz
+
+    - ./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:
     paths:
+      - x86_64-unknown-linux-musl
+      - aarch64-unknown-linux-musl
+      - x86_64-unknown-linux-musl.deb
+      - oci-image-amd64.tar.gz
       - oci-image-arm64v8.tar.gz
+      - public
+  rules:
+    # CI required for all MRs
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    # Optional CI on forks
+    - if: $IS_UPSTREAM_CI != "true"
+      when: manual
+      allow_failure: true
+    - if: $CI
+  interruptible: true
 
-debian:x86_64-unknown-linux-gnu:
-  stage: artifacts
-  # See also `rust-toolchain.toml`
-  image: rust:1.75.0
+pages:
+  stage: publish
+  dependencies:
+    - artifacts
+  only:
+    - next
   script:
-    - cargo install cargo-deb
-    - cargo deb
-
-    # Make the output less difficult to find
-    - mv target/debian/*.deb conduit.deb
+    - "true"
   artifacts:
     paths:
-      - conduit.deb
-  cache:
-    key: debian
-    paths:
-      - target
-      - .gitlab-ci.d
-
-docker-publish:
-  stage: publish
-  image: docker:25.0.3
-  services:
-    - docker:25.0.3-dind
-  variables:
-    IMAGE_NAME: $CI_REGISTRY_IMAGE/conduwuit
-    IMAGE_SUFFIX_AMD64: amd64
-    IMAGE_SUFFIX_ARM64V8: arm64v8
-  before_script:
-    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
-  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:
-    - oci-image:x86_64-unknown-linux-gnu
-    - oci-image:aarch64-unknown-linux-musl
-  only:
-    - main
-    - tags
+      - public

.gitlab/route-map.yml

@@ -0,0 +1,3 @@
+# Docs: Map markdown to html files
+- source: /docs/(.+)\.md/
+  public: '\1.html'

.markdownlintignore

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

.vscode/extensions.json

@@ -1,10 +0,0 @@
-{
-    "recommendations": [
-        "rust-lang.rust-analyzer",
-        "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_CONFIG": "",
-                "CONDUIT_SERVER_NAME": "localhost",
-                "CONDUIT_DATABASE_PATH": "/tmp",
-                "CONDUIT_ADDRESS": "0.0.0.0",
-                "CONDUIT_PORT": "6167"
-            },
-            "cwd": "${workspaceFolder}"
-        }
-    ]
-}

APPSERVICES.md

@@ -1,61 +0,0 @@
-# Setting up Appservices
-
-## Getting help
-
-If you run into any problems while setting up an Appservice, write an email to `timo@koesters.xyz`, ask us in [#conduit:fachschaften.org](https://matrix.to/#/#conduit:fachschaften.org) or [open an issue on GitLab](https://gitlab.com/famedly/conduit/-/issues/new).
-
-## Set up the appservice - general instructions
-
-Follow whatever instructions are given by the appservice. This usually includes
-downloading, changing its config (setting domain, homeserver url, port etc.)
-and later starting it.
-
-At some point the appservice guide should ask you to add a registration yaml
-file to the homeserver. In Synapse you would do this by adding the path to the
-homeserver.yaml, but in Conduit you can do this from within Matrix:
-
-First, go into the #admins room of your homeserver. The first person that
-registered on the homeserver automatically joins it. Then send a message into
-the room like this:
-
-    @conduit:your.server.name: register-appservice
-    ```
-    paste
-    the
-    contents
-    of
-    the
-    yaml
-    registration
-    here
-    ```
-
-You can confirm it worked by sending a message like this:
-`@conduit:your.server.name: list-appservices`
-
-The @conduit bot should answer with `Appservices (1): your-bridge`
-
-Then you are done. Conduit will send messages to the appservices and the
-appservice can send requests to the homeserver. You don't need to restart
-Conduit, but if it doesn't work, restarting while the appservice is running
-could help.
-
-## Appservice-specific instructions
-
-### Remove an appservice
-
-To remove an appservice go to your admin room and execute
-
-`@conduit:your.server.name: unregister-appservice <name>`
-
-where `<name>` one of the output of `list-appservices`.
-
-### Tested appservices
-
-These appservices have been tested and work with Conduit without any extra steps:
-
-- [matrix-appservice-discord](https://github.com/Half-Shot/matrix-appservice-discord)
-- [mautrix-hangouts](https://github.com/mautrix/hangouts/)
-- [mautrix-telegram](https://github.com/mautrix/telegram/)
-- [mautrix-signal](https://github.com/mautrix/signal/) from version `0.2.2` forward.
-- [heisenbridge](https://github.com/hifi/heisenbridge/)

CODE_OF_CONDUCT.md

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

CONTRIBUTING.md

@@ -0,0 +1,95 @@
+# Contributing guide
+
+This page is for about contributing to conduwuit. The [development](development.md) page may be of interest for you as well.
+
+If you would like to work on an [issue][issues] that is not assigned, preferably ask in the Matrix room first at [#conduwuit:puppygock.gay][conduwuit-matrix], and comment on it.
+
+### Linting and Formatting
+
+It is mandatory all your changes satisfy the lints (clippy, rustc, rustdoc, etc) and your code is formatted via the **nightly** `cargo fmt`. A lot of the `rustfmt.toml` features depend on nightly toolchain. It would be ideal if they weren't nightly-exclusive features, but they currently still are. CI's rustfmt uses nightly.
+
+If you need to allow a lint, please make sure it's either obvious as to why (e.g. clippy saying redundant clone but it's actually required) or it has a comment saying why. Do not write inefficient code for the sake of satisfying lints. If a lint is wrong and provides a more inefficient solution or suggestion, allow the lint and mention that in a comment.
+
+### Running CI tests locally
+
+conduwuit's CI for tests, linting, formatting, audit, etc use [`engage`][engage]. engage can be installed from nixpkgs or `cargo install engage`. conduwuit's Nix flake devshell has the nixpkgs engage with `direnv`. Use `engage --help` for more usage details.
+
+To test, format, lint, etc that CI would do, install engage, allow the `.envrc` file using `direnv allow`, and run `engage`.
+
+All of the tasks are defined at the [engage.toml][engage.toml] file. You can view all of them neatly by running `engage list`
+
+If you would like to run only a specific engage task group, use `just`:
+
+- `engage just <group>`
+- Example: `engage just lints`
+
+If you would like to run a specific engage task in a specific group, use `just <GROUP> [TASK]`: `engage just lints cargo-fmt`
+
+The following binaries are used in [`engage.toml`][engage.toml]:
+
+- [`engage`][engage]
+- `nix`
+- [`direnv`][direnv]
+- `rustc`
+- `cargo`
+- `cargo-fmt`
+- `rustdoc`
+- `cargo-clippy`
+- [`cargo-audit`][cargo-audit]
+- [`cargo-deb`][cargo-deb]
+- [`lychee`][lychee]
+- [`markdownlint-cli`][markdownlint-cli]
+
+### Matrix tests
+
+CI runs [Complement][complement], but currently does not fail if results from the checked-in results differ with the new results. If your changes are done to fix Matrix tests, note that in your pull request. If more Complement tests start failing from your changes, please review the logs (they are uploaded as artifacts) and determine if they're intended or not.
+
+If you'd like to run Complement locally using Nix, see the [testing](docs/development/testing.md) page.
+
+[Sytest][sytest] support will come soon.
+
+### Writing documentation
+
+conduwuit's website uses [`mdbook`][mdbook] and deployed via CI using GitHub Pages in the [`documentation.yml`][documentation.yml] workflow file with Nix's mdbook in the devshell. All documentation is in the `docs/` directory at the top level. The compiled mdbook website is also uploaded as an artifact.
+
+To build the documentation using Nix, run: `bin/nix-build-and-cache just .#book`
+
+The output of the mdbook generation is in `result/`. mdbooks can be opened in your browser from the individual HTML files without any web server needed.
+
+### Inclusivity and Diversity
+
+All **MUST** code and write with inclusivity and diversity in mind. See the [following page by Google on writing inclusive code and documentation](https://developers.google.com/style/inclusive-documentation).
+
+This **EXPLICITLY** forbids usage of terms like "blacklist"/"whitelist" and "master"/"slave", [forbids gender-specific words and phrases](https://developers.google.com/style/pronouns#gender-neutral-pronouns), forbids ableist language like "sanity-check", "cripple", or "insane", and forbids culture-specific language (e.g. US-only holidays or cultures).
+
+No exceptions are allowed. Dependencies that may use these terms are allowed but [do not replicate the name in your functions or variables](https://developers.google.com/style/inclusive-documentation#write-around).
+
+In addition to language, write and code with the user experience in mind. This is software that intends to be used by everyone, so make it easy and comfortable for everyone to use. 🏳️‍⚧️
+
+### Variable, comment, function, etc standards
+
+Rust's default style and standards with regards to [function names, variable names, comments](https://rust-lang.github.io/api-guidelines/naming.html), etc applies here.
+
+### Creating pull requests
+
+Please try to keep contributions to the GitHub. While the mirrors of conduwuit allow for pull/merge requests, there is no guarantee I will see them in a timely manner. Additionally, please mark WIP or unfinished or incomplete PRs as drafts. This prevents me from having to ping once in a while to double check the status of it, especially when the CI completed successfully and everything so it *looks* done.
+
+If you open a pull request on one of the mirrors, it is your responsibility to inform me about its existence. In the future I may try to solve this with more repo bots in the conduwuit Matrix room. There is no mailing list or email-patch support on the sr.ht mirror, but if you'd like to email me a git patch you can do so at `strawberry@puppygock.gay`.
+
+Direct all PRs/MRs to the `main` branch.
+
+By sending a pull request or patch, you are agreeing that your changes are allowed to be licenced under the Apache-2.0 licence and all of your conduct is in line with the Contributor's Covenant.
+
+[issues]: https://github.com/girlbossceo/conduwuit/issues
+[conduwuit-matrix]: https://matrix.to/#/#conduwuit:puppygock.gay
+[complement]: https://github.com/matrix-org/complement/
+[engage.toml]: https://github.com/girlbossceo/conduwuit/blob/main/engage.toml
+[engage]: https://charles.page.computer.surgery/engage/
+[sytest]: https://github.com/matrix-org/sytest/
+[cargo-deb]: https://github.com/kornelski/cargo-deb
+[lychee]: https://github.com/lycheeverse/lychee
+[markdownlint-cli]: https://github.com/igorshubovych/markdownlint-cli
+[cargo-audit]: https://github.com/RustSec/rustsec/tree/main/cargo-audit
+[direnv]: https://direnv.net/
+[mdbook]: https://rust-lang.github.io/mdBook/
+[documentation.yml]: https://github.com/girlbossceo/conduwuit/blob/main/.github/workflows/documentation.yml

DEPLOY.md

@@ -1,330 +0,0 @@
-# Deploying Conduit
-
-### Please note that this documentation is not fully representative of conduwuit at the moment. Assume majority of it is outdated.
-
-> ## Getting help
->
-> If you run into any problems while setting up conduwuit, ask us
-> in `#conduwuit:puppygock.gay` or [open an issue on GitHub](https://github.com/girlbossceo/conduwuit/issues/new).
-
-## Installing conduwuit
-
-You may simply download the binary that fits your machine. Run `uname -m` to see what you need. Now copy the appropriate URL:
-
-**Stable versions:**
-
-| CPU Architecture                            | Download stable version                                         |
-| ------------------------------------------- | --------------------------------------------------------------- |
-| x84_64 / amd64 (Most servers and computers) | [Binary][x84_64-glibc-master] / [.deb][x84_64-glibc-master-deb] |
-| armv7 (e.g. Raspberry Pi by default)        | [Binary][armv7-glibc-master] / [.deb][armv7-glibc-master-deb]   |
-| armv8 / aarch64                             | [Binary][armv8-glibc-master] / [.deb][armv8-glibc-master-deb]   |
-
-[x84_64-glibc-master]: https://gitlab.com/famedly/conduit/-/jobs/artifacts/master/raw/build-output/linux_amd64/conduit?job=docker:master
-[armv7-glibc-master]: https://gitlab.com/famedly/conduit/-/jobs/artifacts/master/raw/build-output/linux_arm_v7/conduit?job=docker:master
-[armv8-glibc-master]: https://gitlab.com/famedly/conduit/-/jobs/artifacts/master/raw/build-output/linux_arm64/conduit?job=docker:master
-[x84_64-glibc-master-deb]: https://gitlab.com/famedly/conduit/-/jobs/artifacts/master/raw/build-output/linux_amd64/conduit.deb?job=docker:master
-[armv7-glibc-master-deb]: https://gitlab.com/famedly/conduit/-/jobs/artifacts/master/raw/build-output/linux_arm_v7/conduit.deb?job=docker:master
-[armv8-glibc-master-deb]: https://gitlab.com/famedly/conduit/-/jobs/artifacts/master/raw/build-output/linux_arm64/conduit.deb?job=docker:master
-
-**Latest versions:**
-
-| Target | Type | Download |
-|-|-|-|
-| `x86_64-unknown-linux-gnu` | Dynamically linked Debian package | [link](https://gitlab.com/api/v4/projects/famedly%2Fconduit/jobs/artifacts/next/raw/conduit.deb?job=debian:x86_64-unknown-linux-gnu) |
-| `x86_64-unknown-linux-musl` | Statically linked binary | [link](https://gitlab.com/api/v4/projects/famedly%2Fconduit/jobs/artifacts/next/raw/conduit?job=static:x86_64-unknown-linux-musl) |
-| `aarch64-unknown-linux-musl` | Statically linked binary | [link](https://gitlab.com/api/v4/projects/famedly%2Fconduit/jobs/artifacts/next/raw/conduit?job=static:aarch64-unknown-linux-musl) |
-| `x86_64-unknown-linux-musl` | OCI image | [link](https://gitlab.com/api/v4/projects/famedly%2Fconduit/jobs/artifacts/next/raw/oci-image-amd64.tar.gz?job=oci-image:x86_64-unknown-linux-musl) |
-| `aarch64-unknown-linux-musl` | OCI image | [link](https://gitlab.com/api/v4/projects/famedly%2Fconduit/jobs/artifacts/next/raw/oci-image-arm64v8.tar.gz?job=oci-image:aarch64-unknown-linux-musl) |
-
-```bash
-$ sudo wget -O /usr/local/bin/matrix-conduit <url>
-$ sudo chmod +x /usr/local/bin/matrix-conduit
-```
-
-Alternatively, you may compile the binary yourself. First, install any dependencies:
-
-```bash
-# Debian
-$ sudo apt install libclang-dev build-essential
-
-# RHEL
-$ sudo dnf install clang
-```
-Then, `cd` into the source tree of conduit-next and run:
-```bash
-$ cargo build --release
-```
-
-If you want to cross compile Conduit to another architecture, read the guide below.
-
-<details>
-<summary>Cross compilation</summary>
-
-As easiest way to compile conduit for another platform [cross-rs](https://github.com/cross-rs/cross) is recommended, so install it first.
-
-In order to use RockDB as storage backend append `-latomic` to linker flags.
-
-For example, to build a binary for Raspberry Pi Zero W (ARMv6) you need `arm-unknown-linux-gnueabihf` as compilation
-target.
-
-```bash
-git clone https://gitlab.com/famedly/conduit.git
-cd conduit
-export RUSTFLAGS='-C link-arg=-lgcc -Clink-arg=-latomic -Clink-arg=-static-libgcc'
-cross build --release --no-default-features --features conduit_bin,backend_rocksdb --target=arm-unknown-linux-gnueabihf
-```
-</details>
-
-## Adding a Conduit user
-
-While Conduit can run as any user it is usually better to use dedicated users for different services. This also allows
-you to make sure that the file permissions are correctly set up.
-
-In Debian or RHEL, you can use this command to create a Conduit user:
-
-```bash
-sudo adduser --system conduit --group --disabled-login --no-create-home
-```
-
-## 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.
-
-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.
-
-## Optional: Avoid port 8448
-
-If Conduit runs behind Cloudflare reverse proxy, which doesn't support port 8448 on free plans, [delegation](https://matrix-org.github.io/synapse/latest/delegate.html) can be set up to have federation traffic routed to port 443:
-```apache
-# .well-known delegation on Apache
-<Files "/.well-known/matrix/server">
-    ErrorDocument 200 '{"m.server": "your.server.name:443"}'
-    Header always set Content-Type application/json
-    Header always set Access-Control-Allow-Origin *
-</Files>
-```
-[SRV DNS record](https://spec.matrix.org/latest/server-server-api/#resolving-server-names) delegation is also [possible](https://www.cloudflare.com/en-gb/learning/dns/dns-records/dns-srv-record/).
-
-## 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`.
-
-```systemd
-[Unit]
-Description=Conduit Matrix Server
-After=network.target
-
-[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
-
-[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.**  
-You can also choose to use a different database backend, but right now only `rocksdb` and `sqlite` are recommended.
-
-See the following example config at [conduwuit-example.toml](conduwuit-example.toml)
-
-## 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
-Debian or RHEL:
-
-```bash
-sudo chown -R root:root /etc/matrix-conduit
-sudo chmod 755 /etc/matrix-conduit
-```
-
-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/
-```
-
-## Setting up the Reverse Proxy
-
-This depends on whether you use Apache, Caddy, Nginx or another web server.
-
-### Apache
-
-Create `/etc/apache2/sites-enabled/050-conduit.conf` and copy-and-paste this:
-
-```apache
-# Requires mod_proxy and mod_proxy_http
-#
-# On Apache instance compiled from source,
-# paste into httpd-ssl.conf or httpd.conf
-
-Listen 8448
-
-<VirtualHost *:443 *:8448>
-
-ServerName your.server.name # EDIT THIS
-
-AllowEncodedSlashes NoDecode
-
-# TCP
-ProxyPass /_matrix/ http://127.0.0.1:6167/_matrix/ timeout=300 nocanon
-ProxyPassReverse /_matrix/ http://127.0.0.1:6167/_matrix/
-
-# UNIX socket
-#ProxyPass /_matrix/ unix:/run/conduit/conduit.sock|http://127.0.0.1:6167/_matrix/ nocanon
-#ProxyPassReverse /_matrix/ unix:/run/conduit/conduit.sock|http://127.0.0.1:6167/_matrix/
-
-</VirtualHost>
-```
-
-**You need to make some edits again.** When you are done, run
-
-```bash
-# Debian
-$ sudo systemctl reload apache2
-
-# Installed from source
-$ sudo apachectl -k graceful
-```
-
-### Caddy
-
-Create `/etc/caddy/conf.d/conduit_caddyfile` and enter this (substitute for your server name).
-
-```caddy
-your.server.name, your.server.name:8448 {
-        # TCP
-        reverse_proxy /_matrix/* 127.0.0.1:6167
-
-        # UNIX socket
-        #reverse_proxy /_matrix/* unix//run/conduit/conduit.sock
-}
-```
-
-That's it! Just start or enable the service and you're set.
-
-```bash
-$ sudo systemctl enable caddy
-```
-
-### Nginx
-
-If you use Nginx and not Apache, add the following server section inside the http section of `/etc/nginx/nginx.conf`
-
-```nginx
-server {
-    listen 443 ssl http2;
-    listen [::]:443 ssl http2;
-    listen 8448 ssl http2;
-    listen [::]:8448 ssl http2;
-    server_name your.server.name; # EDIT THIS
-    merge_slashes off;
-
-    # Nginx defaults to only allow 1MB uploads
-    # Increase this to allow posting large files such as videos
-    client_max_body_size 20M;
-
-    # UNIX socket
-    #upstream backend {
-    #    server unix:/run/conduit/conduit.sock;
-    #}
-
-    location /_matrix/ {
-        # TCP
-        proxy_pass http://127.0.0.1:6167$request_uri;
-
-        # UNIX socket
-        #proxy_pass http://backend;
-
-        proxy_set_header Host $http_host;
-        proxy_buffering off;
-        proxy_read_timeout 5m;
-    }
-
-    ssl_certificate /etc/letsencrypt/live/your.server.name/fullchain.pem; # EDIT THIS
-    ssl_certificate_key /etc/letsencrypt/live/your.server.name/privkey.pem; # EDIT THIS
-    ssl_trusted_certificate /etc/letsencrypt/live/your.server.name/chain.pem; # EDIT THIS
-    include /etc/letsencrypt/options-ssl-nginx.conf;
-}
-```
-
-**You need to make some edits again.** When you are done, run
-
-```bash
-$ sudo systemctl reload nginx
-```
-
-## SSL Certificate
-
-If you chose Caddy as your web proxy SSL certificates are handled automatically and you can skip this step.
-
-The easiest way to get an SSL certificate, if you don't have one already, is to [install](https://certbot.eff.org/instructions) `certbot` and run this:
-
-```bash
-# To use ECC for the private key, 
-# paste into /etc/letsencrypt/cli.ini:
-# key-type = ecdsa
-# elliptic-curve = secp384r1
-
-$ sudo certbot -d your.server.name
-```
-[Automated renewal](https://eff-certbot.readthedocs.io/en/stable/using.html#automated-renewals) is usually preconfigured.
-
-If using Cloudflare, configure instead the edge and origin certificates in dashboard. In case you’re already running a website on the same Apache server, you can just copy-and-paste the SSL configuration from your main virtual host on port 443 into the above-mentioned vhost.
-
-## You're done!
-
-Now you can start Conduit with:
-
-```bash
-$ sudo systemctl start conduit
-```
-
-Set it to start automatically when your system boots with:
-
-```bash
-$ sudo systemctl enable conduit
-```
-
-## How do I know it works?
-
-You can open <https://app.element.io>, enter your homeserver and try to register.
-
-You can also use these commands as a quick health check.
-
-```bash
-$ curl https://your.server.name/_matrix/client/versions
-
-# If using port 8448
-$ curl https://your.server.name:8448/_matrix/client/versions
-```
-
-- To check if your server can talk with other homeservers, you can use the [Matrix Federation Tester](https://federationtester.matrix.org/).
-  If you can register but cannot join federated rooms check your config again and also check if the port 8448 is open and forwarded correctly.
-
-# What's next?
-
-## Audio/Video calls
-
-For Audio/Video call functionality see the [TURN Guide](TURN.md).
-
-## Appservices
-
-If you want to set up an appservice, take a look at the [Appservice Guide](APPSERVICES.md).

DIFFERENCES.md

@@ -1,71 +0,0 @@
-### list of features, bug fixes, etc that conduwuit does that upstream 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
-- 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
-- Federated presence support and configurable local presence (via upstream MR)
-- Concurrency support for key fetching for faster remote room joins and room joins that will error less frequently (via upstream MR)
-- Experimental room version 11 support (via upstream MR)
-- Enabled all non-officially-supported room versions as experimental so we can at least attempt to join them
-- Configurable guest registration including forbidding guest registrations if no admin user is created yet, respects allow registration setting, and an optional override setting with a default of no guest registrations allowed.
-- 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, and a conduwuit setting to tell RocksDB to use settings that are tailored to HDDs or slow spinning rust storage.
-- Updated Ruma to latest commit where possible, and add some unstable MSCs (some still require an implementation though)
-- conduwuit allows MXIDs with `+` in them (thanks to Ruma update)
-- 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
-- Make PDU appending, building, etc asynchronous
-- 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) 
-- Add *optional* feature flag to enable zstd HTTP body compression
-- Add support for querying both Matrix SRV records, the deprecated `_matrix` record and `_matrix-fed` record if necessary
-- 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)
-- Fix spec compliance issue with servers being able to fetch remote user profiles over federation for users who don't belong to our server (`/_matrix/federation/v1/query/profile`)
-- 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
-- Add non-standard sliding sync proxy health check (?) endpoint at `/client/server.json` that some clients such as Element Web query using the `well_known_client` or `well_known_server` config 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
-- Basic binary commands like `conduwuit --version` work (interested in expanding it more)
-- 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)
-- Only follow 6 redirects total in our default reqwest ClientBuilder
-- 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.
-- 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
-- Warn on unknown config options specified
-- Add support for preventing certain room alias names and usernames using regex (via upstream MR) and extended to custom room IDs
-- Revamp appservice registration to ruma's `Registration` type which fixes various appservice registration issues, including fixing crashing upon no URL specified (via upstream MR)
-- 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, and ask systemd for more time to shutdown if needed to prevent systemd's default [`TimeoutStopSec=`](https://www.freedesktop.org/software/systemd/man/latest/systemd.service.html#TimeoutStopSec=) of 90 seconds from killing conduwuit
-- Bumped default max_concurrent_requests to 500
-- Add support for the deprecated `user` identifier field for all `/login` requests
-- 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, as a moderation feature

README.md

@@ -1,10 +1,19 @@
 # conduwuit
-### a well maintained fork of [Conduit](https://conduit.rs/)
 
+`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 very cool, featureful fork of [Conduit](https://conduit.rs/)
+<!-- ANCHOR_END: catchphrase -->
+
+Visit the [Conduwuit documentation](https://conduwuit.puppyirl.gay/) for more information.
+
+<!-- ANCHOR: body -->
 #### What is Matrix?
+
 [Matrix](https://matrix.org) is an open network for secure and decentralized
 communication. Users from every Matrix homeserver can chat with users from all
-other Matrix servers. You can even use bridges (also called Matrix appservices)
+other Matrix servers. You can even use bridges (also called Matrix Appservices)
 to communicate with users outside of Matrix, like a community on Discord.
 
 #### What is the goal?
@@ -15,76 +24,49 @@ friends or company.
 
 #### Can I try it out?
 
-There are no public conduwuit homeservers available, however conduwuit is incredibly simple to install. It's just a binary, a config file, and a database path.
+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. conduwuit attempts to fix and improve the majority of upstream Conduit bugs
-or UX issues that are taking too long to be resolved, or unnecessary Matrix or developer
-politics halting simple things from being merged or fixed, and general inactivity.
+from time to time.
 
-There are still a few nice to have features missing that some users may notice:
+<!-- ANCHOR_END: body -->
 
-- Outgoing read receipts and typing indicators (receiving works)
-
-#### What's different about your fork than upstream Conduit?
-
-See [DIFFERENCES.md](DIFFERENCES.md)
-
-#### Why does this fork exist? Why don't you contribute back upstream?
-
-I have tried, but:
-- unnecessary Matrix / developer politics
-- bikeshedding unnecessary or irrelevant things in MRs
-- disagreement with how the upstream project is maintained including the codebase
-- upstream maintainer inactivity
-- questionable community members
-- lack of MR reviews or issue triaging and no upstream maintainer interest in receiving help
-- severe bugs, including denial of service and other likely vulnerabilities, not being merged due to things mentioned above
-- no interest in adding co-maintainers to help out
-
-are what are keeping me from contributing. If the state of the upstream project improves, I'm
-willing to start contributing again. As is, I think if folks want a more polished and well-kept version of Conduit, conduwuit exists for that.
-
-#### How can I deploy my own?
-
-- Simple install (this was tested the most): [DEPLOY.md](DEPLOY.md)
-- Nix/NixOS: [nix/README.md](nix/README.md)
-
-If you want to connect an Appservice to Conduit, take a look at [APPSERVICES.md](APPSERVICES.md).
-
-#### 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.)
+<!-- ANCHOR: footer -->
 
 #### Contact
 
 If you run into any question, feel free to
+
 - Ask us in `#conduwuit:puppygock.gay` on Matrix
 - [Open an issue on GitHub](https://github.com/girlbossceo/conduwuit/issues/new)
 
 #### Donate
 
-Liberapay: <https://liberapay.com/girlbossceo>\
-Ko-fi: <https://ko-fi.com/puppygock>\
-GitHub Sponsors: <https://github.com/sponsors/girlbossceo>
+- Liberapay: <https://liberapay.com/girlbossceo>
+- Ko-fi: <https://ko-fi.com/puppygock>
+- GitHub Sponsors: <https://github.com/sponsors/girlbossceo>
 
 #### Logo
 
-No official conduwuit logo exists. Repo and Matrix room picture is from bran (<3).
+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, but I prefer conduwuit.
 
 #### Mirrors of conduwuit
 
-GitHub: https://github.com/girlbossceo/conduwuit
-GitLab: https://gitlab.com/girlbossceo/conduwuit
-git.gay: https://git.gay/june/conduwuit
-Codeberg: https://codeberg.org/girlbossceo/conduwuit
-sourcehut: https://git.sr.ht/~girlbossceo/conduwuit
+- GitHub: <https://github.com/girlbossceo/conduwuit>
+- GitLab: <https://gitlab.com/conduwuit/conduwuit>
+- git.girlcock.ceo: <https://git.girlcock.ceo/strawberry/conduwuit>
+- git.gay: <https://git.gay/june/conduwuit>
+- Codeberg: <https://codeberg.org/girlbossceo/conduwuit>
+- sourcehut: <https://git.sr.ht/~girlbossceo/conduwuit>
+<!-- ANCHOR_END: footer -->

TURN.md

@@ -1,25 +0,0 @@
-# Setting up TURN/STURN
-
-## General instructions
-
-* 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).
-
-## Edit/Add a few settings to your existing conduit.toml
-
-```
-# 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 = ""
-```
-
-## Apply settings
-
-Restart Conduit.

arch/conduwuit.service

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

bin/complement

@@ -3,7 +3,11 @@
 set -euo pipefail
 
 # Path to Complement's source code
-COMPLEMENT_SRC="$1"
+#
+# 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="${COMPLEMENT_SRC:-$1}"
 
 # A `.jsonl` file to write test logs to
 LOG_FILE="$2"
@@ -11,27 +15,42 @@ 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 complement/Dockerfile \
-        .
+# Complement tests that are skipped due to flakiness/reliability issues
+SKIPPED_COMPLEMENT_TESTS='-skip=TestClientSpacesSummary.*|TestJoinFederatedRoomFromApplicationServiceBridgeUser.*|TestJumpToDateEndpoint.*'
+
+# $COMPLEMENT_SRC needs to be a directory to Complement source code
+if [ -f "$COMPLEMENT_SRC" ]; then
+    echo "\$COMPLEMENT_SRC must be a directory/path to Complement source code"
+    exit 1
+fi
+
+# quick test to make sure we can actually write to $LOG_FILE and $RESULTS_FILE
+touch $LOG_FILE && rm -v $LOG_FILE
+touch $RESULTS_FILE && rm -v $RESULTS_FILE
+
+toplevel="$(git rev-parse --show-toplevel)"
+
+pushd "$toplevel" > /dev/null
+
+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 -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

@@ -1,50 +1,104 @@
 #!/usr/bin/env bash
 
-set -euo pipefail
+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+x} ]; then
+    if [ -z "$ATTIC_TOKEN" ]; then
+        echo "\$ATTIC_TOKEN is unset, skipping uploading to the binary cache"
+        return
+    fi
 
-nix run --inputs-from . attic -- login \
-    conduit \
-        https://attic.kennel.juneis.dog/conduit \
+    # 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_args=(
-        # Attic and its build dependencies
-        "$(nix path-info --inputs-from . attic)"
-        "$(nix path-info --inputs-from . attic --derivation)"
+    # 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
 
-        # The target installable and its build dependencies
-        "$(nix path-info "$INSTALLABLE" --derivation)"
-        "$(nix path-info "$INSTALLABLE")"
+    # 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[*]}"
     )
 
-    nix run --inputs-from . attic -- push conduit "${push_args[@]}"
-
-    # push to "conduwuit" too
-nix run --inputs-from . attic -- login \
-    conduwuit \
-        https://attic.kennel.juneis.dog/conduwuit \
+    # main "conduwuit" store
+    nix run --inputs-from "$toplevel" attic -- \
+        login \
+        conduwuit \
+        "${ATTIC_ENDPOINT:-https://attic.kennel.juneis.dog/conduwuit}" \
         "$ATTIC_TOKEN"
 
-    push_args=(
-        # Attic and its build dependencies
-        "$(nix path-info --inputs-from . attic)"
-        "$(nix path-info --inputs-from . attic --derivation)"
+    # Upload them to Attic (conduwuit store) and Cachix
+    #
+    # Use `xargs` and a here-string because something would probably explode if
+    # several thousand arguments got passed to a command at once. Hopefully no
+    # store paths include a newline in them.
+    (
+        IFS=$'\n'
+        nix shell --inputs-from "$toplevel" attic -c xargs \
+            attic push conduwuit <<< "${cache[*]}"
 
-        # The target installable and its build dependencies
-        "$(nix path-info "$INSTALLABLE" --derivation)"
-        "$(nix path-info "$INSTALLABLE")"
+        # push to cachix if available
+        if [ "$CACHIX_AUTH_TOKEN" ]; then
+            nix shell --inputs-from "$toplevel" cachix -c xargs \
+            cachix push conduwuit <<< "${cache[*]}"
+        fi
+    )
+}
+
+# Build and cache things needed for CI
+ci() {
+    cache=(
+        --inputs-from "$toplevel"
+
+        # Keep sorted
+        "$toplevel#devShells.x86_64-linux.default"
+        "$toplevel#devShells.x86_64-linux.all-features"
+        attic#default
+        cachix#default
+        nixpkgs#direnv
+        nixpkgs#jq
+        nixpkgs#nix-direnv
     )
 
-    nix run --inputs-from . attic -- push conduwuit "${push_args[@]}"
+    just "${cache[@]}"
+}
 
-else
-    echo "\$ATTIC_TOKEN is unset, skipping uploading to the binary cache"
-fi
+# 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

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

clippy.toml

@@ -0,0 +1,7 @@
+array-size-threshold = 4096
+cognitive-complexity-threshold = 94         # TODO reduce me ALARA
+excessive-nesting-threshold = 11            # TODO reduce me to 4 or 5
+future-size-threshold = 7745                # TODO reduce me ALARA
+stack-size-threshold = 144000               # reduce me ALARA
+too-many-lines-threshold = 700              # TODO reduce me to <= 100
+type-complexity-threshold = 250             # reduce me to ~200

complement/Dockerfile

@@ -1,46 +0,0 @@
-FROM rust:1.75.0
-
-WORKDIR /workdir
-
-RUN apt-get update && apt-get install -y --no-install-recommends \
-    libclang-dev
-
-COPY Cargo.toml Cargo.toml
-COPY Cargo.lock Cargo.lock
-COPY src src
-RUN cargo build --release \
-    && mv target/release/conduit conduit \
-    && rm -rf target
-
-# Install caddy
-RUN apt-get update \
-    && apt-get install -y \
-    debian-keyring \
-    debian-archive-keyring \
-    apt-transport-https \
-    curl \
-    && curl -1sLf 'https://dl.cloudsmith.io/public/caddy/testing/gpg.key' \
-    | gpg --dearmor -o /usr/share/keyrings/caddy-testing-archive-keyring.gpg \
-    && curl -1sLf 'https://dl.cloudsmith.io/public/caddy/testing/debian.deb.txt' \
-    | tee /etc/apt/sources.list.d/caddy-testing.list \
-    && apt-get update \
-    && apt-get install -y caddy
-
-COPY conduit-example.toml conduit.toml
-COPY complement/caddy.json caddy.json
-
-ENV SERVER_NAME=localhost
-ENV CONDUIT_CONFIG=/workdir/conduit.toml
-
-RUN sed -i "s/port = 6167/port = 8008/g" conduit.toml
-RUN echo "log = \"warn,_=off,sled=off\"" >> conduit.toml
-RUN sed -i "s/address = \"127.0.0.1\"/address = \"0.0.0.0\"/g" conduit.toml
-
-EXPOSE 8008 8448
-
-CMD uname -a && \
-    sed -i "s/#server_name = \"your.server.name\"/server_name = \"${SERVER_NAME}\"/g" conduit.toml && \
-    sed -i "s/your.server.name/${SERVER_NAME}/g" caddy.json && \
-    caddy start --config caddy.json > /dev/null && \
-    /workdir/conduit
-

complement/README.md

@@ -1,12 +0,0 @@
-# Complement
-
-## What's that?
-
-Have a look at [its repository](https://github.com/matrix-org/complement).
-
-## How do I use it with Conduit?
-
-The script at [`../bin/complement`](../bin/complement) has automation for this.
-It takes a few command line arguments, you can read the script to find out what
-those are.
-

complement/caddy.json

@@ -1,72 +0,0 @@
-{
-    "logging": {
-        "logs": {
-            "default": {
-                "level": "WARN"
-            }
-        }
-    },
-    "apps": {
-        "http": {
-            "https_port": 8448,
-            "servers": {
-                "srv0": {
-                    "listen": [":8448"],
-                    "routes": [{
-                        "match": [{
-                            "host": ["your.server.name"]
-                        }],
-                        "handle": [{
-                            "handler": "subroute",
-                            "routes": [{
-                                "handle": [{
-                                    "handler": "reverse_proxy",
-                                    "upstreams": [{
-                                        "dial": "127.0.0.1:8008"
-                                    }]
-                                }]
-                            }]
-                        }],
-                        "terminal": true
-                    }],
-                    "tls_connection_policies": [{
-                        "match": {
-                            "sni": ["your.server.name"]
-                        }
-                    }]
-                }
-            }
-        },
-        "pki": {
-            "certificate_authorities": {
-                "local": {
-                    "name": "Complement CA",
-                    "root": {
-                        "certificate": "/complement/ca/ca.crt",
-                        "private_key": "/complement/ca/ca.key"
-                    },
-                    "intermediate": {
-                        "certificate": "/complement/ca/ca.crt",
-                        "private_key": "/complement/ca/ca.key"
-                    }
-                }
-            }
-        },
-        "tls": {
-            "automation": {
-                "policies": [{
-                    "subjects": ["your.server.name"],
-                    "issuers": [{
-                        "module": "internal"
-                    }],
-                    "on_demand": true
-                }, {
-                    "issuers": [{
-                        "module": "internal",
-                        "ca": "local"
-                    }]
-                }]
-            }
-        }
-    }
-}

conduwuit-example.toml

@@ -2,6 +2,8 @@
 #  This is the official example config for conduwuit.
 #  If you use it for your server, you will need to adjust it to your own needs.
 #  At the very least, change the server_name field!
+#
+#  This documentation can also be found at https://conduwuit.puppyirl.gay/configuration.html
 # =============================================================================
 
 [global]
@@ -22,54 +24,79 @@
 # YOU NEED TO EDIT THIS
 #server_name = "your.server.name"
 
-# Servers listed here will be used to gather public keys of other servers.
-# Generally, copying this exactly should be enough. (Currently, conduwuit doesn't
-# support batched key requests, so this list should only contain Synapse
-# servers.) Defaults to `matrix.org`
+# Servers listed here will be used to gather public keys of other servers (notary trusted key servers).
+#
+# The default behaviour for conduwuit is to attempt to query trusted key servers before querying the individual servers.
+# This is done for performance reasons, but if you would like to query individual servers before the notary servers
+# configured below, set to
+#
+# (Currently, conduwuit doesn't support batched key requests, so this list should only contain Synapse servers)
+# Defaults to `matrix.org`
 # trusted_servers = ["matrix.org"]
 
+# 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*
+#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
+#sentry_send_server_name = false
+
+# Performance monitoring/tracing sample rate for Sentry.io
+#
+# Note that too high values may impact performance, and can be disabled by setting it to 0.0
+#
+# Defaults to 0.15
+#sentry_traces_sample_rate = 0.15
+
+# Whether to attach a stacktrace to Sentry reports.
+#sentry_attach_stacktrace = false
+
+# Send panics to sentry. This is true by default, but sentry has to be enabled.
+#sentry_send_panic = true
+
+# Send errors to sentry. This is true by default, but sentry has to be enabled. This option is
+# only effective in release-mode; forced to false in debug-mode.
+#sentry_send_error = true
 
 
 ### Database configuration
 
-# This is the only directory where conduwuit will save its data, including media
-database_path = "/var/lib/conduwuit/"
+# This is the only directory where conduwuit will save its data, including media.
+# Note: this was previously "/var/lib/matrix-conduit"
+database_path = "/var/lib/conduwuit"
 
-# Database backend: Only rocksdb and sqlite are supported. Please note that sqlite
-# will perform significantly worse than rocksdb as it is not intended to be used the
-# way it is by conduwuit. sqlite only exists for historical reasons.
+# Database backend: Only rocksdb is supported.
 database_backend = "rocksdb"
 
 
-
 ### Network
 
-# The port conduwuit will be running on. You need to set up a reverse proxy such as
+# The port(s) conduwuit will be running on. You need to set up a reverse proxy such as
 # Caddy or Nginx so all requests to /_matrix on port 443 and 8448 will be
 # forwarded to the conduwuit instance running on this port
 # Docker users: Don't change this, you'll need to map an external port to this.
+# To listen on multiple ports, specify a vector e.g. [8080, 8448]
+#
+# default if unspecified is 8008
 port = 6167
 
 # default address (IPv4 or IPv6) conduwuit will listen on. Generally you want this to be
 # localhost (127.0.0.1 / ::1). If you are using Docker or a container NAT networking setup, you
-# likely need this to be 0.0.0.0. 
+# likely need this to be 0.0.0.0.
+# To listen multiple addresses, specify a vector e.g. ["127.0.0.1", "::1"]
+#
+# default if unspecified is both IPv4 and IPv6 localhost: ["127.0.0.1", "::1"]
 address = "127.0.0.1"
 
-# 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
 
@@ -80,15 +107,31 @@ max_request_size = 20_000_000 # in bytes
 #unix_socket_perms = 660
 
 # Set this to true for conduwuit to compress HTTP response bodies using zstd.
-# Please be aware that enabling HTTP compression may weaken or even defeat TLS.
+# This option does nothing if conduwuit was not built with `zstd_compression` feature.
+# Please be aware that enabling HTTP compression may weaken TLS.
 # Most users should not need to enable this.
 # See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH before deciding to enable this.
 zstd_compression = false
 
+# Set this to true for conduwuit to compress HTTP response bodies using gzip.
+# This option does nothing if conduwuit was not built with `gzip_compression` feature.
+# Please be aware that enabling HTTP compression may weaken TLS.
+# Most users should not need to enable this.
+# See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH before deciding to enable this.
+gzip_compression = false
+
+# Set this to true for conduwuit to compress HTTP response bodies using brotli.
+# This option does nothing if conduwuit was not built with `brotli_compression` feature.
+# Please be aware that enabling HTTP compression may weaken TLS.
+# Most users should not need to enable this.
+# See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH before deciding to enable this.
+brotli_compression = false
+
 # Vector list of IPv4 and IPv6 CIDR ranges / subnets *in quotes* that you do not want conduwuit to send outbound requests to.
 # Defaults to RFC1918, unroutable, loopback, multicast, and testnet addresses for security.
 #
 # To disable, set this to be an empty vector (`[]`).
+# Please be aware that this is *not* a guarantee. You should be using a firewall with zones as doing this on the application layer may have bypasses.
 #
 # Currently this does not account for proxies in use like Synapse does.
 ip_range_denylist = [
@@ -114,18 +157,25 @@ ip_range_denylist = [
 ]
 
 
-
 ### Moderation / Privacy / Security
 
 # Set to true to allow user type "guest" registrations. Element attempts to register guest users automatically.
-# For private homeservers, this is best at false.
+# Defaults to false
 allow_guest_registration = false
 
+# Set to true to log guest registrations in the admin room.
+# Defaults to false as it may be noisy or unnecessary.
+log_guest_registrations = false
+
+# Set to true to allow guest registrations/users to auto join any rooms specified in `auto_join_rooms`
+# Defaults to false
+allow_guests_auto_join_rooms = false
+
 # Vector list of servers that conduwuit will refuse to download remote media from.
 # No default.
 # prevent_media_downloads_from = ["example.com", "example.local"]
 
-# Enables open registration. If set to false, no users can register on this
+# Enables registration. If set to false, no users can register on this
 # server.
 # If set to true without a token configured, users can register with no form of 2nd-
 # step only if you set
@@ -151,6 +201,37 @@ registration_token = "change this token for something specific to your server"
 # defaults to true
 # allow_room_creation = true
 
+# controls whether non-admin local users are forbidden from sending room invites (local and remote),
+# and if non-admin users can receive remote room invites. admins are always allowed to send and receive all room invites.
+# defaults to false
+# block_non_admin_invites = false
+
+# Allows admins to enter commands in rooms other than #admins by prefixing with \!admin. The reply
+# will be publicly visible to the room, originating from the sender.
+# defaults to true
+#admin_escape_commands = true
+
+# List of forbidden username patterns/strings. Values in this list are matched as *contains*.
+# This is checked upon username availability check, registration, and startup as warnings if any local users in your database
+# have a forbidden username.
+# No default.
+# forbidden_usernames = []
+
+# List of forbidden room aliases and room IDs as patterns/strings. Values in this list are matched as *contains*.
+# This is checked upon room alias creation, custom room ID creation if used, and startup as warnings if any room aliases
+# in your database have a forbidden room alias/ID.
+# No default.
+# forbidden_alias_names = []
+
+# List of forbidden server names that we will block all client room joins, incoming federated room directory requests, incoming federated invites for, and incoming federated joins. This check is applied on the room ID, room alias, sender server name, and sender user's server name.
+# Basically "global" ACLs. For our user (client) checks, admin users are allowed.
+# No default.
+# forbidden_remote_server_names = []
+
+# List of forbidden server names that we will block all outgoing federated room directory requests for. Useful for preventing our users from wandering into bad servers or spaces.
+# No default.
+# forbidden_remote_room_directory_server_names = []
+
 # Set this to true to allow your server's public room directory to be federated.
 # Set this to false to protect against /publicRooms spiders, but will forbid external users
 # from viewing your server's public room directory. If federation is disabled entirely
@@ -161,6 +242,12 @@ allow_public_room_directory_over_federation = false
 # authentication (access token) through the Client APIs. Set this to false to protect against /publicRooms spiders.
 allow_public_room_directory_without_auth = false
 
+# Set this to true to lock down your server's public room directory and only allow admins to publish rooms to the room directory.
+# Unpublishing is still allowed by all users with this enabled.
+#
+# Defaults to false
+lockdown_public_room_directory = false
+
 # Set this to true to allow federating device display names / allow external users to see your device display name.
 # If federation is disabled entirely (`allow_federation`), this is inherently false. For privacy, this is best disabled.
 allow_device_name_federation = false
@@ -171,7 +258,7 @@ allow_device_name_federation = false
 url_preview_domain_contains_allowlist = []
 
 # Vector list of explicit domains allowed to send requests to for URL previews. Defaults to none.
-# Note: This is an *explicit* match, not a ccontains match. Putting "google.com" will match "https://google.com", "http://google.com", but not "https://mymaliciousdomainexamplegoogle.com"
+# Note: This is an *explicit* match, not a contains match. Putting "google.com" will match "https://google.com", "http://google.com", but not "https://mymaliciousdomainexamplegoogle.com"
 # Setting this to "*" will allow all URL previews. Please note that this opens up significant attack surface to your server, you are expected to be aware of the risks by doing so.
 url_preview_domain_explicit_allowlist = []
 
@@ -180,65 +267,192 @@ url_preview_domain_explicit_allowlist = []
 # Setting this to "*" will allow all URL previews. Please note that this opens up significant attack surface to your server, you are expected to be aware of the risks by doing so.
 url_preview_url_contains_allowlist = []
 
-# Maximum amount of bytes allowed in a URL preview body size when spidering. Defaults to 1MB (1_000_000 bytes)
-url_preview_max_spider_size = 1_000_000
+# Vector list of explicit domains not allowed to send requests to for URL previews. Defaults to none.
+# Note: This is an *explicit* match, not a contains match. Putting "google.com" will match "https://google.com", "http://google.com", but not "https://mymaliciousdomainexamplegoogle.com"
+# The denylist is checked first before allowlist. Setting this to "*" will not do anything.
+url_preview_domain_explicit_denylist = []
+
+# Maximum amount of bytes allowed in a URL preview body size when spidering. Defaults to 384KB (384_000 bytes)
+url_preview_max_spider_size = 384_000
 
 # Option to decide whether you would like to run the domain allowlist checks (contains and explicit) on the root domain or not. Does not apply to URL contains allowlist. Defaults to false.
 # Example: If this is enabled and you have "wikipedia.org" allowed in the explicit and/or contains domain allowlist, it will allow all subdomains under "wikipedia.org" such as "en.m.wikipedia.org" as the root domain is checked and matched.
 # Useful if the domain contains allowlist is still too broad for you but you still want to allow all the subdomains under a root domain.
 url_preview_check_root_domain = false
 
+# Config option to allow or disallow incoming federation requests that obtain the profiles
+# of our local users from `/_matrix/federation/v1/query/profile`
+#
+# This is inherently false if `allow_federation` is disabled
+#
+# 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
 
 # max log level for conduwuit. allows debug, info, warn, or error
-#log = "warn"
+# see also: https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives
+# **Caveat**:
+# 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 "info"
+#log = "info"
 
 # controls whether encrypted rooms and events are allowed (default true)
 #allow_encryption = false
 
-# conduwuit will send a simple GET request periodically to `https://pupbrain.dev/check-for-updates/stable`
+# if enabled, conduwuit will send a simple GET request periodically to `https://pupbrain.dev/check-for-updates/stable`
 # for any new announcements made. Despite the name, this is not an update check
-# endpoint, it is simply an announcement check endpoint. I don't plan on using
-# this so feel free to disable it.
-allow_check_for_updates = true
-
-# Enables adding the lightning bolt emoji (⚡️) to all newly registered users'
-# initial display names. 
-enable_lightning_bolt = false
-
-# If you are using delegation via well-known files and you cannot serve them from your reverse proxy, you can
-# uncomment these to serve them directly from conduwuit. This requires proxying all requests to conduwuit, not just `/_matrix` to work.
-#well_known_server = "matrix.example.com:443"
-#well_known_client = "https://matrix.example.com"
-# Note that whatever you put will show up in the well-known JSON values.
+# endpoint, it is simply an announcement check endpoint.
+# Defaults to false.
+#allow_check_for_updates = false
 
 # Set to false to disable users from joining or creating room versions that aren't 100% officially supported by conduwuit.
-# conduwuit officially supports room versions 6 - 10. conduwuit has experimental/unstable support for 1 - 5, and 11.
+# conduwuit officially supports room versions 6 - 10. conduwuit has experimental/unstable support for 3 - 5, and 11.
 # Defaults to true.
 #allow_unstable_room_versions = true
 
+# Option to control adding arbitrary text to the end of the user's displayname upon registration with a space before the text.
+# This was the lightning bolt emoji option, just replaced with support for adding your own custom text or emojis.
+# To disable, set this to "" (an empty string)
+# Defaults to "🏳️‍⚧️" (trans pride flag)
+#new_user_displayname_suffix = "🏳️‍⚧️"
+
+# Option to control whether conduwuit will query your list of trusted notary key servers (`trusted_servers`) for
+# remote homeserver signing keys it doesn't know *first*, or query the individual servers first before falling back to the trusted
+# key servers.
+#
+# The former/default behaviour makes federated/remote rooms joins generally faster because we're querying a single (or list of) server
+# that we know works, is reasonably fast, and is reliable for just about all the homeserver signing keys in the room. Querying individual
+# servers may take longer depending on the general infrastructure of everyone in there, how many dead servers there are, etc.
+#
+# However, this does create an increased reliance on one single or multiple large entities as `trusted_servers` should generally
+# contain long-term and large servers who know a very large number of homeservers.
+#
+# If you don't know what any of this means, leave this and `trusted_servers` alone to their defaults.
+#
+# Defaults to true as this is the fastest option for federation.
+#query_trusted_key_servers_first = true
+
+# List/vector of room **IDs** that conduwuit will make newly registered users join.
+# The room IDs specified must be rooms that you have joined at least once on the server, and must be public.
+#
+# No default.
+#auto_join_rooms = []
+
+# Retry failed and incomplete messages to remote servers immediately upon startup. This is called bursting.
+# If this is disabled, said messages may not be delivered until more messages are queued for that server.
+# Do not change this option unless server resources are extremely limited or the scale of the server's
+# deployment is huge. Do not disable this unless you know what you are doing.
+#startup_netburst = true
+
+# Limit the startup netburst to the most recent (default: 50) messages queued for each remote server. All older
+# messages are dropped and not reattempted. The `startup_netburst` option must be enabled for this value to have
+# any effect. Do not change this value unless you know what you are doing. Set this value to -1 to reattempt
+# every message without trimming the queues; this may consume significant disk. Set this value to 0 to drop all
+# 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"
+
+# Enable the tokio-console. This option is only relevant to developers.
+# See: docs/development.md#debugging-with-tokio-console for more information.
+#tokio_console = false
+
+# Enable backward-compatibility with Conduit's media directory by creating symlinks of media. This
+# option is only necessary if you plan on using Conduit again. Otherwise setting this to false
+# reduces filesystem clutter and overhead for managing these symlinks in the directory.
+#
+# Enabled by default.
+#media_compat_file_link = true
+
+# Checks consistency of the media directory at startup:
+# 1. When `media_compat_file_link` is enbled, this check will upgrade media when switching back
+#    and forth between Conduit and Conduwuit. Both options must be enabled to handle this.
+# 2. When media is deleted from the directory, this check will also delete its database entry.
+#
+# If none of these checks apply to your use cases, and your media directory is significantly large
+# setting this to false may reduce startup time.
+#
+# Enabled by default.
+#media_statup_check = true
+
+# OpenID token expiration/TTL in seconds
+#
+# These are the OpenID tokens that are primarily used for Matrix account integrations, *not* OIDC/OpenID Connect/etc
+#
+# Defaults to 3600 (1 hour)
+#openid_token_ttl = 3600
+
+# Emergency password feature. This password set here will let you login to the server service account (e.g. `@conduit`)
+# and let you run admin commands, invite yourself to the admin room, etc.
+#
+# no default.
+#emergency_password = ""
+
+
+### Generic database options
+
 # Set this to any float value to multiply conduwuit's in-memory LRU caches with.
 # May be useful if you have significant memory to spare to increase performance.
+#
+# This was previously called `conduit_cache_capacity_modifier`
+#
 # Defaults to 1.0.
-#conduit_cache_capacity_modifier = 1.0
+#cache_capacity_modifier = 1.0
 
 # Set this to any float value in megabytes for conduwuit to tell the database engine that this much memory is available for database-related caches.
 # May be useful if you have significant memory to spare to increase performance.
-# Defaults to 300.0
-#db_cache_capacity_mb = 300.0
-
+# Defaults to 256.0
+#db_cache_capacity_mb = 256.0
 
 
 ### RocksDB options
 
 # Set this to true to use RocksDB config options that are tailored to HDDs (slower device storage)
+#
+# It is worth noting that by default, conduwuit will use RocksDB with Direct IO enabled. *Generally* speaking this improves performance as it bypasses buffered I/O (system page cache).
+# However there is a potential chance that Direct IO may cause issues with database operations if your setup is uncommon. This has been observed with FUSE filesystems, and possibly ZFS filesystem.
+# RocksDB generally deals/corrects these issues but it cannot account for all setups.
+# If you experience any weird RocksDB issues, try enabling this option as it turns off Direct IO and feel free to report in the conduwuit Matrix room if this option fixes your DB issues.
+# See https://github.com/facebook/rocksdb/wiki/Direct-IO for more information.
+#
+# Defaults to false
 #rocksdb_optimize_for_spinning_disks = false
 
-# RocksDB log level. This is not the same as conduwuit's log level. This is the log level for RocksDB itself
-# which show up in your database folder/path as `LOG` files. Defaults to warn. conduwuit will typically log RocksDB errors. 
-#rocksdb_log_level = "warn"
+# 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"
 
 # Max RocksDB `LOG` file size before rotating in bytes. Defaults to 4MB.
 #rocksdb_max_log_file_size = 4194304
@@ -246,32 +460,365 @@ enable_lightning_bolt = false
 # 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 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", "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"
+
+# Level of compression the specified compression algorithm for RocksDB to use.
+# Default is 32767, which is internally read by RocksDB as the default magic number and
+# translated to the library's default compression level as they all differ.
+# See their `kDefaultCompressionLevel`.
+#
+#rocksdb_compression_level = 32767
+
+# Level of compression the specified compression algorithm for the bottommost level/data for RocksDB to use.
+# Default is 32767, which is internally read by RocksDB as the default magic number and
+# translated to the library's default compression level as they all differ.
+# See their `kDefaultCompressionLevel`.
+#
+# Since this is the bottommost level (generally old and least used data), it may be desirable to have a very
+# high compression level here as it's lesss likely for this data to be used. Research your chosen compression algorithm.
+#
+#rocksdb_bottommost_compression_level = 32767
+
+# Whether to enable RocksDB "bottommost_compression".
+# At the expense of more CPU usage, this will further compress the database to reduce more storage.
+# It is recommended to use ZSTD compression with this for best compression results.
+# See https://github.com/facebook/rocksdb/wiki/Compression for more details.
+#
+# Defaults to false as this uses more CPU when compressing.
+#rocksdb_bottommost_compression = false
+
+# Database recovery mode (for RocksDB WAL corruption)
+#
+# Use this option when the server reports corruption and refuses to start. Set mode 2 (PointInTime)
+# to cleanly recover from this corruption. The server will continue from the last good state,
+# several seconds or minutes prior to the crash. Clients may have to run "clear-cache & reload" to
+# account for the rollback. Upon success, you may reset the mode back to default and restart again.
+# Please note in some cases the corruption error may not be cleared for at least 30 minutes of
+# operation in PointInTime mode.
+#
+# As a very last ditch effort, if PointInTime does not fix or resolve anything, you can try mode
+# 3 (SkipAnyCorruptedRecord) but this will leave the server in a potentially inconsistent state.
+#
+# The default mode 1 (TolerateCorruptedTailRecords) will automatically drop the last entry in the
+# database if corrupted during shutdown, but nothing more. It is extraordinarily unlikely this will
+# desynchronize clients. To disable any form of silent rollback set mode 0 (AbsoluteConsistency).
+#
+# The options are:
+# 0 = AbsoluteConsistency
+# 1 = TolerateCorruptedTailRecords (default)
+# 2 = PointInTime (use me if trying to recover)
+# 3 = SkipAnyCorruptedRecord (you now voided your Conduwuit warranty)
+#
+# See https://github.com/facebook/rocksdb/wiki/WAL-Recovery-Modes for more information
+#
+# Defaults to 1 (TolerateCorruptedTailRecords)
+#rocksdb_recovery_mode = 1
 
 
-### Presence
+### Domain Name Resolution and Caching
 
-# Config option to control local (your server only) presence updates/requests. Defaults to false.
+# 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 = 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.
+#dns_min_ttl = 10800
+
+# 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.
+#
+# 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.
+#dns_timeout = 10
+
+# Number of retries after a timeout.
+#dns_attempts = 10
+
+# Fallback to TCP on DNS errors. Set this to false if unsupported by nameserver.
+#dns_tcp_fallback = true
+
+# Enable to query all nameservers until the domain is found. Referred to as "trust_negative_responses" in hickory_resolver.
+# This can avoid useless DNS queries if the first nameserver responds with NXDOMAIN or an empty NOERROR response.
+#
+# 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
+
+## Request Timeouts are HTTP response timeouts
+## Connection Timeouts are TCP connection timeouts
+##
+## Connection Pooling Timeouts are timeouts for keeping an open idle connection alive.
+## Connection pooling and keepalive is very useful for federation or other places where for performance reasons,
+## we want to keep connections open that we will re-use frequently due to TCP and TLS 1.3 overhead/expensiveness.
+##
+## Generally these defaults are the best, but if you find a reason to need to change these they are here.
+
+# 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. 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 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 320 seconds
+#request_total_timeout = 320
+
+# Default/base idle connection pool timeout
+# This is used only by URL previews and update/news endpoint checks
+#
+# 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
+#well_known_conn_timeout = 6
+
+# Federation HTTP well-known resolution request timeout
+#
+# Defaults to 10 seconds
+#well_known_timeout = 10
+
+# 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 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 35 seconds as generally appservices are hosted within the same network
+#appservice_timeout = 35
+
+# Appservice URL idle connection pool timeout
+#
+# Defaults to 300 seconds
+#appservice_idle_timeout = 300
+
+# Notification gateway pusher idle connection pool timeout
+#
+# Defaults to 15 seconds
+#pusher_idle_timeout = 15
+
+
+### Presence / Typing Indicators / Read Receipts
+
+# Config option to control local (your server only) presence updates/requests. Defaults to true.
 # Note that presence on conduwuit is very fast unlike Synapse's.
 # If using outgoing presence, this MUST be enabled.
-#allow_local_presence = false
+#
+#allow_local_presence = true
 
-# Config option to control incoming federated presence updates/requests. Defaults to false.
+# Config option to control incoming federated presence updates/requests. Defaults to true.
 # This option receives presence updates from other servers, but does not send any unless `allow_outgoing_presence` is true.
 # Note that presence on conduwuit is very fast unlike Synapse's.
-#allow_incoming_presence = false
+#
+#allow_incoming_presence = true
 
-# Config option to control outgoing presence updates/requests. Defaults to false.
+# Config option to control outgoing presence updates/requests. Defaults to true.
 # This option sends presence updates to other servers, but does not receive any unless `allow_incoming_presence` is true.
 # Note that presence on conduwuit is very fast unlike Synapse's.
 # If using outgoing presence, you MUST enable `allow_local_presence` as well.
 #
-# Warning: Outgoing federated presence is not spec compliant due to relying on PDUs and EDUs combined.
-# Outgoing presence will not be very reliable due to this and any issues with federated outgoing presence are very likely attributed to this issue.
-# Incoming presence and local presence are unaffected.
-#allow_outgoing_presence = false
+#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
 
 # Config option to control how many seconds before presence updates that you are offline. Defaults to 30 minutes.
-#presence_offline_timeout_s = 1800
+#presence_offline_timeout_s = 1800
+
+# Config option to control whether we should receive remote incoming read receipts.
+# Defaults to true.
+#allow_incoming_read_receipts = true
+
+# Config option to control whether we should send read receipts to remote servers.
+# Defaults to true.
+#allow_outgoing_read_receipts = true
+
+# Config option to control outgoing typing updates to federation. Defaults to true.
+#allow_outgoing_typing = true
+
+# Config option to control incoming typing updates from federation. Defaults to true.
+#allow_incoming_typing = true
+
+# Config option to control maximum time federation user can indicate typing.
+#typing_federation_timeout_s = 30
+
+# Config option to control minimum time local client can indicate typing. This does not override
+# a client's request to stop typing. It only enforces a minimum value in case of no stop request.
+#typing_client_timeout_min_s = 15
+
+# Config option to control maximum time local client can indicate typing.
+#typing_client_timeout_max_s = 45
+
+
+### TURN / VoIP
+
+# vector list of TURN URIs/servers to use
+#
+# No default
+#turn_uris = ["turn:example.turn.uri?transport=udp", "turn:example.turn.uri?transport=tcp"]
+
+# TURN secret to use for generating the HMAC-SHA1 hash apart of username and password generation
+#
+# this is more secure, but if needed you can use traditional username/password below.
+#
+# no default
+#turn_secret = ""
+
+# TURN username to provide the client
+#
+# no default
+#turn_username = ""
+
+# TURN password to provide the client
+#
+# no default
+#turn_password = ""
+
+# TURN TTL
+#
+# Default is 86400 seconds
+#turn_ttl = 86400
+
+# allow guests/unauthenticated users to access TURN credentials
+#
+# this is the equivalent of Synapse's `turn_allow_guests` config option. this allows
+# any unauthenticated user to call `/_matrix/client/v3/voip/turnServer`.
+#
+# defaults to false
+#turn_allow_guests = false
+
+
+# Other options not in [global]:
+#
+#
+# Enables running conduwuit with direct TLS support
+# It is strongly recommended you use a reverse proxy instead. This is primarily relevant for test suites like complement that require a private CA setup.
+# [global.tls]
+# certs = "/path/to/my/certificate.crt"
+# key = "/path/to/my/private_key.key"
+#
+# Whether to listen and allow for HTTP and HTTPS connections (insecure!)
+# This config option is only available if conduwuit was built with `axum_dual_protocol` feature (not default feature)
+# Defaults to false
+#dual_protocol = false
+
+
+# If you are using delegation via well-known files and you cannot serve them from your reverse proxy, you can
+# uncomment these to serve them directly from conduwuit. This requires proxying all requests to conduwuit, not just `/_matrix` to work.
+#
+#[global.well_known]
+#server = "matrix.example.com:443"
+#client = "https://matrix.example.com"
+#
+# A single contact and/or support page for /.well-known/matrix/support
+# All options here are strings. Currently only supports 1 single contact.
+# No default.
+#
+#support_page = ""
+#support_role = ""
+#support_email = ""
+#support_mxid = ""

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 [DEPLOY.md](../DEPLOY.md).
-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/examples.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=Conduit Matrix homeserver
+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,20 +43,20 @@ 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=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,320 +1,44 @@
 #!/bin/sh
 set -e
 
-. /usr/share/debconf/confmodule
+# TODO: implement debconf support that is maintainable without duplicating the config
+#. /usr/share/debconf/confmodule
 
-CONDUIT_CONFIG_PATH=/etc/matrix-conduit
-CONDUIT_CONFIG_FILE="${CONDUIT_CONFIG_PATH}/conduit.toml"
-CONDUIT_DATABASE_PATH=/var/lib/matrix-conduit/
+CONDUWUIT_DATABASE_PATH=/var/lib/conduwuit
+CONDUWUIT_CONFIG_PATH=/etc/conduwuit
 
 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 Conduit 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 \
-        --force-badname \
-        _matrix-conduit
+        --shell "/usr/sbin/nologin" \
+        --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 "$CONDUIT_DATABASE_PATH"
-    chmod 700 "$CONDUIT_DATABASE_PATH"
+    # and permissions for the config.
+    mkdir -v -p "$CONDUWUIT_DATABASE_PATH"
 
-    if [ ! -e "$CONDUIT_CONFIG_FILE" ]; then
-      # Write the debconf values in the config.
-      db_get matrix-conduit/hostname
-      CONDUIT_SERVER_NAME="$RET"
-      db_get matrix-conduit/address
-      CONDUIT_ADDRESS="$RET"
-      db_get matrix-conduit/port
-      CONDUIT_PORT="$RET"
-      mkdir -p "$CONDUIT_CONFIG_PATH"
-      cat > "$CONDUIT_CONFIG_FILE" << EOF
-# =============================================================================
-#  This is the official example config for conduwuit.
-#  If you use it for your server, you will need to adjust it to your own needs.
-#  At the very least, change the server_name field!
-# =============================================================================
-
-[global]
-
-# The server_name is the pretty name of this server. It is used as a suffix for user
-# and room ids. Examples: matrix.org, conduit.rs
-
-# The Conduit server needs all /_matrix/ requests to be reachable at
-# https://your.server.name/ on port 443 (client-server) and 8448 (federation).
-
-# If that's not possible for you, you can create /.well-known files to redirect
-# requests (delegation). See
-# https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixclient
-# and
-# https://spec.matrix.org/v1.9/server-server-api/#getwell-knownmatrixserver
-# for more information
-
-# YOU NEED TO EDIT THIS
-server_name = "${CONDUIT_SERVER_NAME}"
-
-# Servers listed here will be used to gather public keys of other servers.
-# Generally, copying this exactly should be enough. (Currently, conduwuit doesn't
-# support batched key requests, so this list should only contain Synapse
-# servers.) Defaults to `matrix.org`
-# trusted_servers = ["matrix.org"]
-
-
-
-### Database configuration
-
-# This is the only directory where conduwuit will save its data, including media
-database_path = "${CONDUIT_DATABASE_PATH}"
-
-# Database backend: Only rocksdb and sqlite are supported. Please note that sqlite
-# will perform significantly worse than rocksdb as it is not intended to be used the
-# way it is by conduwuit. sqlite only exists for historical reasons.
-database_backend = "rocksdb"
-
-
-
-### Network
-
-# The port conduwuit will be running on. You need to set up a reverse proxy such as
-# Caddy or Nginx so all requests to /_matrix on port 443 and 8448 will be
-# forwarded to the conduwuit instance running on this port
-# Docker users: Don't change this, you'll need to map an external port to this.
-port = ${CONDUIT_PORT}
-
-# default address (IPv4 or IPv6) conduwuit will listen on. Generally you want this to be
-# localhost (127.0.0.1 / ::1). If you are using Docker or a container NAT networking setup, you
-# likely need this to be 0.0.0.0. 
-address = "${CONDUIT_ADDRESS}"
-
-# 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
-
-# Uncomment unix_socket_path to listen on a UNIX socket at the specified path.
-# If listening on a UNIX socket, you must remove/comment the 'address' key if defined and add your
-# reverse proxy to the 'conduwuit' group, unless world RW permissions are specified with unix_socket_perms (666 minimum).
-#unix_socket_path = "/run/conduwuit/conduwuit.sock"
-#unix_socket_perms = 660
-
-# Set this to true for conduwuit to compress HTTP response bodies using zstd.
-# Please be aware that enabling HTTP compression may weaken or even defeat TLS.
-# Most users should not need to enable this.
-# See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH before deciding to enable this.
-zstd_compression = false
-
-# Vector list of IPv4 and IPv6 CIDR ranges / subnets *in quotes* that you do not want conduwuit to send outbound requests to.
-# Defaults to RFC1918, unroutable, loopback, multicast, and testnet addresses for security.
-#
-# To disable, set this to be an empty vector (`[]`).
-#
-# Currently this does not account for proxies in use like Synapse does.
-ip_range_denylist = [
-    "127.0.0.0/8",
-    "10.0.0.0/8",
-    "172.16.0.0/12",
-    "192.168.0.0/16",
-    "100.64.0.0/10",
-    "192.0.0.0/24",
-    "169.254.0.0/16",
-    "192.88.99.0/24",
-    "198.18.0.0/15",
-    "192.0.2.0/24",
-    "198.51.100.0/24",
-    "203.0.113.0/24",
-    "224.0.0.0/4",
-    "::1/128",
-    "fe80::/10",
-    "fc00::/7",
-    "2001:db8::/32",
-    "ff00::/8",
-    "fec0::/10",
-]
-
-
-
-### Moderation / Privacy / Security
-
-# Set to true to allow user type "guest" registrations. Element attempts to register guest users automatically.
-# For private homeservers, this is best at false.
-allow_guest_registration = false
-
-# Vector list of servers that conduwuit will refuse to download remote media from.
-# No default.
-# prevent_media_downloads_from = ["example.com", "example.local"]
-
-# Enables open registration. If set to false, no users can register on this
-# server.
-# If set to true without a token configured, users can register with no form of 2nd-
-# step only if you set
-# `yes_i_am_very_very_sure_i_want_an_open_registration_server_prone_to_abuse` to
-# true in your config. If you would like
-# registration only via token reg, please configure the `registration_token` key.
-allow_registration = false
-# Please note that an open registration homeserver with no second-step verification
-# is highly prone to abuse and potential defederation by homeservers, including
-# matrix.org.
-
-# A static registration token that new users will have to provide when creating
-# an account. If unset and `allow_registration` is true, registration is open
-# without any condition. YOU NEED TO EDIT THIS.
-registration_token = "change this token for something specific to your server"
-
-# controls whether federation is allowed or not
-# defaults to true
-# allow_federation = true
-
-# controls whether users are allowed to create rooms.
-# appservices and admins are always allowed to create rooms
-# defaults to true
-# allow_room_creation = true
-
-# Set this to true to allow your server's public room directory to be federated.
-# Set this to false to protect against /publicRooms spiders, but will forbid external users
-# from viewing your server's public room directory. If federation is disabled entirely
-# (`allow_federation`), this is inherently false.
-allow_public_room_directory_over_federation = false
-
-# Set this to true to allow your server's public room directory to be queried without client
-# authentication (access token) through the Client APIs. Set this to false to protect against /publicRooms spiders.
-allow_public_room_directory_without_auth = false
-
-# Set this to true to allow federating device display names / allow external users to see your device display name.
-# If federation is disabled entirely (`allow_federation`), this is inherently false. For privacy, this is best disabled.
-allow_device_name_federation = false
-
-# Vector list of domains allowed to send requests to for URL previews. Defaults to none.
-# Note: this is a *contains* match, not an explicit match. Putting "google.com" will match "https://google.com" and "http://mymaliciousdomainexamplegoogle.com"
-# Setting this to "*" will allow all URL previews. Please note that this opens up significant attack surface to your server, you are expected to be aware of the risks by doing so.
-url_preview_domain_contains_allowlist = []
-
-# Vector list of explicit domains allowed to send requests to for URL previews. Defaults to none.
-# Note: This is an *explicit* match, not a ccontains match. Putting "google.com" will match "https://google.com", "http://google.com", but not "https://mymaliciousdomainexamplegoogle.com"
-# Setting this to "*" will allow all URL previews. Please note that this opens up significant attack surface to your server, you are expected to be aware of the risks by doing so.
-url_preview_domain_explicit_allowlist = []
-
-# Vector list of URLs allowed to send requests to for URL previews. Defaults to none.
-# Note that this is a *contains* match, not an explicit match. Putting "google.com" will match "https://google.com/", "https://google.com/url?q=https://mymaliciousdomainexample.com", and "https://mymaliciousdomainexample.com/hi/google.com"
-# Setting this to "*" will allow all URL previews. Please note that this opens up significant attack surface to your server, you are expected to be aware of the risks by doing so.
-url_preview_url_contains_allowlist = []
-
-# Maximum amount of bytes allowed in a URL preview body size when spidering. Defaults to 1MB (1_000_000 bytes)
-url_preview_max_spider_size = 1_000_000
-
-# Option to decide whether you would like to run the domain allowlist checks (contains and explicit) on the root domain or not. Does not apply to URL contains allowlist. Defaults to false.
-# Example: If this is enabled and you have "wikipedia.org" allowed in the explicit and/or contains domain allowlist, it will allow all subdomains under "wikipedia.org" such as "en.m.wikipedia.org" as the root domain is checked and matched.
-# Useful if the domain contains allowlist is still too broad for you but you still want to allow all the subdomains under a root domain.
-url_preview_check_root_domain = false
-
-
-
-### Misc
-
-# max log level for conduwuit. allows debug, info, warn, or error
-#log = "warn"
-
-# controls whether encrypted rooms and events are allowed (default true)
-#allow_encryption = false
-
-# conduwuit will send a simple GET request periodically to `https://pupbrain.dev/check-for-updates/stable`
-# for any new announcements made. Despite the name, this is not an update check
-# endpoint, it is simply an announcement check endpoint. I don't plan on using
-# this so feel free to disable it.
-allow_check_for_updates = true
-
-# Enables adding the lightning bolt emoji (⚡️) to all newly registered users'
-# initial display names. 
-enable_lightning_bolt = false
-
-# If you are using delegation via well-known files and you cannot serve them from your reverse proxy, you can
-# uncomment these to serve them directly from conduwuit. This requires proxying all requests to conduwuit, not just `/_matrix` to work.
-#well_known_server = "matrix.example.com:443"
-#well_known_client = "https://matrix.example.com"
-# Note that whatever you put will show up in the well-known JSON values.
-
-# Set to false to disable users from joining or creating room versions that aren't 100% officially supported by conduwuit.
-# conduwuit officially supports room versions 6 - 10. conduwuit has experimental/unstable support for 1 - 5, and 11.
-# Defaults to true.
-#allow_unstable_room_versions = true
-
-# Set this to any float value to multiply conduwuit's in-memory LRU caches with.
-# May be useful if you have significant memory to spare to increase performance.
-# Defaults to 1.0.
-#conduit_cache_capacity_modifier = 1.0
-
-# Set this to any float value in megabytes for conduwuit to tell the database engine that this much memory is available for database-related caches.
-# May be useful if you have significant memory to spare to increase performance.
-# Defaults to 900.0
-#db_cache_capacity_mb = 900.0
-
-
-
-### RocksDB options
-
-# Set this to true to use RocksDB config options that are tailored to HDDs (slower device storage)
-#rocksdb_optimize_for_spinning_disks = false
-
-# RocksDB log level. This is not the same as conduwuit's log level. This is the log level for RocksDB itself
-# which show up in your database folder/path as `LOG` files. Defaults to warn. conduwuit will typically log RocksDB errors. 
-#rocksdb_log_level = "warn"
-
-# Max RocksDB `LOG` file size before rotating in bytes. Defaults to 4MB.
-#rocksdb_max_log_file_size = 4194304
-
-# Time in seconds before RocksDB will forcibly rotate logs. Defaults to 0.
-#rocksdb_log_time_to_roll = 0
-
-
-
-### Presence
-
-# Config option to control local (your server only) presence updates/requests. Defaults to false.
-# Note that presence on conduwuit is very fast unlike Synapse's.
-# If using outgoing presence, this MUST be enabled.
-#allow_local_presence = false
-
-# Config option to control incoming federated presence updates/requests. Defaults to false.
-# This option receives presence updates from other servers, but does not send any unless `allow_outgoing_presence` is true.
-# Note that presence on conduwuit is very fast unlike Synapse's.
-#allow_incoming_presence = false
-
-# Config option to control outgoing presence updates/requests. Defaults to false.
-# This option sends presence updates to other servers, but does not receive any unless `allow_incoming_presence` is true.
-# Note that presence on conduwuit is very fast unlike Synapse's.
-# If using outgoing presence, you MUST enable `allow_local_presence` as well.
-#
-# Warning: Outgoing federated presence is not spec compliant due to relying on PDUs and EDUs combined.
-# Outgoing presence will not be very reliable due to this and any issues with federated outgoing presence are very likely attributed to this issue.
-# Incoming presence and local presence are unaffected.
-#allow_outgoing_presence = false
-
-# Config option to control how many seconds before presence updates that you are idle. Defaults to 5 minutes.
-#presence_idle_timeout_s = 300
-
-# Config option to control how many seconds before presence updates that you are offline. Defaults to 30 minutes.
-#presence_offline_timeout_s = 1800
-
-EOF
+    # symlink the previous location for compatibility if it does not exist yet.
+    if ! test -L "/var/lib/matrix-conduit" ; then
+        ln -s -v "$CONDUWUIT_DATABASE_PATH" "/var/lib/matrix-conduit"
     fi
+
+    chown -v conduwuit:conduwuit -R "$CONDUWUIT_DATABASE_PATH"
+    chown -v conduwuit:conduwuit -R "$CONDUWUIT_CONFIG_PATH"
+
+    chmod -v 740 "$CONDUWUIT_DATABASE_PATH"
+
+    echo ''
+    echo 'Make sure you edit the example config at /etc/conduwuit/conduwuit.toml before starting!'
+    echo 'To start the server, run: systemctl start conduwuit.service'
+    echo ''
+
     ;;
 esac
 

debian/postrm

@@ -1,10 +1,11 @@
 #!/bin/sh
 set -e
 
-. /usr/share/debconf/confmodule
+#. /usr/share/debconf/confmodule
 
-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,42 @@
+[package]
+name = "rust-rocksdb-uwu"
+categories.workspace = true
+description = "dylib wrapper for rust-rocksdb"
+edition = "2021"
+keywords.workspace = true
+license.workspace = true
+readme.workspace = true
+repository.workspace = true
+version = "0.0.1"
+
+[features]
+default = ["lz4", "zstd", "zlib", "bzip2"]
+jemalloc = ["rust-rocksdb/jemalloc"]
+io-uring = ["rust-rocksdb/io-uring"]
+valgrind = ["rust-rocksdb/valgrind"]
+snappy = ["rust-rocksdb/snappy"]
+lz4 = ["rust-rocksdb/lz4"]
+zstd = ["rust-rocksdb/zstd"]
+zlib = ["rust-rocksdb/zlib"]
+bzip2 = ["rust-rocksdb/bzip2"]
+rtti = ["rust-rocksdb/rtti"]
+mt_static = ["rust-rocksdb/mt_static"]
+multi-threaded-cf = ["rust-rocksdb/multi-threaded-cf"]
+serde1 = ["rust-rocksdb/serde1"]
+malloc-usable-size = ["rust-rocksdb/malloc-usable-size"]
+
+[dependencies.rust-rocksdb]
+git = "https://github.com/zaidoon1/rust-rocksdb"
+rev = "4056a3b0f823013fec49f6d0b3e5698856e6476a"
+#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/README.md

@@ -1,218 +0,0 @@
-# Deploy using Docker
-
-> **Note:** To run and use Conduit you should probably use it with a Domain or Subdomain behind a reverse proxy (like Nginx, Traefik, Apache, ...) with a Lets Encrypt certificate.
-
-## Docker
-
-To run conduwuit with Docker you can either build the image yourself or pull it from a registry.
-
-
-### Use a registry
-
-OCI images for conduwuit are available in the registries listed below. We recommend using the image tagged as `latest` from GitLab's own 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.   |
-
-
-[dh]: https://hub.docker.com/repository/docker/girlbossceo/conduwuit
-[gh]: https://github.com/girlbossceo/conduwuit/pkgs/container/conduwuit
-[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 
-```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/ \
-  -e CONDUIT_SERVER_NAME="your.server.name" \
-  -e CONDUIT_DATABASE_BACKEND="rocksdb" \
-  -e CONDUIT_ALLOW_REGISTRATION=true \
-  -e CONDUIT_ALLOW_FEDERATION=true \
-  -e CONDUIT_MAX_REQUEST_SIZE="20000000" \
-  -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).
-
-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](../conduit-example.toml).
-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.
-
-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.
-
-### Docker-compose
-
-If the `docker run` command is not for you or your setup, you can also use one of the provided `docker-compose` files.
-
-Depending on your proxy setup, you can use one of the following files;
-- If you already have a `traefik` instance set up, use [`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml)
-- If you don't have a `traefik` instance set up (or any other reverse proxy), use [`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)
-- For any other reverse proxy, use [`docker-compose.yml`](docker-compose.yml)
-
-When picking the traefik-related compose file, rename it so it matches `docker-compose.yml`, and
-rename the override file to `docker-compose.override.yml`. Edit the latter with the values you want
-for your server.
-
-Additional info about deploying Conduit can be found [here](../DEPLOY.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:
-
-```bash
-docker-compose up
-```
-
-This will also start the container right afterwards, so if want it to run in detached mode, you also should use the `-d` flag.
-
-### 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
-```
-
-> **Note:** Don't forget to modify and adjust the compose file to your needs.
-
-### Use Traefik as Proxy
-
-As a container user, you probably know about Traefik. It is a easy to use reverse proxy for making
-containerized app and services available through the web. With the two provided files,
-[`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
-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
-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](../conduit-example.toml), 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).
-

docker/docker-compose.yml

@@ -1,54 +0,0 @@
-# Conduit
-version: '3'
-
-services:
-    homeserver:
-        ### If you already built the Conduit 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/
-        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: '' # Ignore this
-    #
-    ### 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
-    ### Config-Docs: https://github.com/vector-im/element-web/blob/develop/docs/config.md
-    # element-web:
-    #     image: vectorim/element-web:latest
-    #     restart: unless-stopped
-    #     ports:
-    #         - 8009:80
-    #     volumes:
-    #         - ./element_config.json:/app/config.json
-    #     depends_on:
-    #         - homeserver
-
-volumes:
-    db:

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

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

docs/appservices.md

@@ -0,0 +1,51 @@
+# Setting up Appservices
+
+## Getting help
+
+If you run into any problems while setting up an Appservice: ask us in [#conduwuit:puppygock.gay](https://matrix.to/#/#conduwuit:puppygock.gay) or [open an issue on GitHub](https://github.com/girlbossceo/conduwuit/issues/new).
+
+## Set up the appservice - general instructions
+
+Follow whatever instructions are given by the appservice. This usually includes
+downloading, changing its config (setting domain, homeserver url, port etc.)
+and later starting it.
+
+At some point the appservice guide should ask you to add a registration yaml
+file to the homeserver. In Synapse you would do this by adding the path to the
+homeserver.yaml, but in conduwuit you can do this from within Matrix:
+
+First, go into the `#admins` room of your homeserver. The first person that
+registered on the homeserver automatically joins it. Then send a message into
+the room like this:
+
+    !admin appservices register
+    ```
+    paste
+    the
+    contents
+    of
+    the
+    yaml
+    registration
+    here
+    ```
+
+You can confirm it worked by sending a message like this:
+`!admin appservices list`
+
+The server bot should answer with `Appservices (1): your-bridge`
+
+Then you are done. conduwuit will send messages to the appservices and the
+appservice can send requests to the homeserver. You don't need to restart
+conduwuit, but if it doesn't work, restarting while the appservice is running
+could help.
+
+## Appservice-specific instructions
+
+### Remove an appservice
+
+To remove an appservice go to your admin room and execute
+
+`!admin appservices unregister <name>`
+
+where `<name>` one of the output of `appservices list`.

docs/conduwuit_coc.md

@@ -0,0 +1,77 @@
+# conduwuit Community Code of Conduct
+
+Welcome to the conduwuit community! We’re excited to have you here. conduwuit is a hard-fork of the Conduit homeserver,
+aimed at making Matrix more accessible and inclusive for everyone.
+
+This space is dedicated to fostering a positive, supportive, and inclusive environment for everyone. This Code of
+Conduct applies to all conduwuit spaces, including any further community rooms that reference this CoC. Here are our
+guidelines to help maintain the welcoming atmosphere that sets conduwuit apart.
+
+For the foundational rules, please refer to the [Matrix.org Code of Conduct](https://matrix.org/legal/code-of-conduct/)
+and the [Contributor's Covenant](https://github.com/girlbossceo/conduwuit/blob/main/CODE_OF_CONDUCT.md). Below are
+additional guidelines specific to the conduwuit community.
+
+## Our Values and Guidelines
+
+1. **Respect and Inclusivity**: We are committed to maintaining a community where everyone feels safe and respected.
+   Discrimination, harassment, or hate speech of any kind will not be tolerated. Recognise that each community member
+   experiences the world differently based on their past experiences, background, and identity. Share your own
+   experiences and be open to learning about others' diverse perspectives.
+
+2. **Positivity and Constructiveness**: Engage in constructive discussions and support each other. If you feel angry,
+   negative, or aggressive, take a break until you can participate in a positive and constructive manner. Process
+   intense feelings with a friend or in a private setting before engaging in community conversations to help maintain
+   a supportive and focused environment.
+
+3. **Clarity and Understanding**: Our community includes neurodivergent individuals and those who may not appreciate
+   sarcasm or subtlety. Communicate clearly and kindly, avoiding sarcasm and ensuring your messages are easily
+   understood by all. Additionally, avoid putting the burden of education on marginalized groups by doing your own
+   research before asking for explanations.
+
+4. **Be Open to Inclusivity**: Actively engage in conversations about making our community more inclusive. Report
+   discriminatory behavior to the moderators and be open to constructive feedback that aims to improve our community.
+   Understand that discussing discrimination and negative experiences can be emotionally taxing, so focus on the
+   message rather than critiquing the tone used.
+
+5. **Commit to Inclusivity**: Building an inclusive community requires time, energy, and resources. Recognise that
+   addressing discrimination and bias is an ongoing process that necessitates commitment and action from all community
+   members.
+
+## Matrix Community
+
+This Code of Conduct applies to the entire [conduwuit Matrix Space](https://matrix.to/#/#conduwuit-space:puppygock.gay)
+and its rooms, including:
+
+### [#conduwuit:puppygock.gay](https://matrix.to/#/#conduwuit:puppygock.gay)
+
+This room is for support and discussions about conduwuit. Ask questions, share insights, and help each other out.
+
+### [#conduwuit-offtopic:girlboss.ceo](https://matrix.to/#/#conduwuit-offtopic:girlboss.ceo)
+
+For off-topic community conversations about any subject. While this room allows for a wide range of topics, the same
+CoC applies. Keep discussions respectful and inclusive, and avoid divisive subjects like country/world politics.
+General topics, such as world events, are welcome as long as they follow the CoC.
+
+### [#conduwuit-dev:puppygock.gay](https://matrix.to/#/#conduwuit-dev:puppygock.gay)
+
+This room is dedicated to discussing active development of conduwuit. Posting requires an elevated power level, which
+can be requested in one of the other rooms. Use this space to collaborate and innovate.
+
+## Enforcement
+
+We have a zero-tolerance policy for violations of this Code of Conduct. If someone’s behavior makes you uncomfortable,
+please report it to the moderators. Actions we may take include:
+
+1. **Warning**: A warning given directly in the room or via a private message from the moderators, identifying
+   the violation and requesting corrective action.
+2. **Temporary Mute**: Temporary restriction from participating in discussions for a specified period to allow for
+   reflection and cooling off.
+3. **Kick or Ban**: Egregious behavior may result in an immediate kick or ban to protect other community members.
+   Bans are considered permanent and will only be reversed in exceptional circumstances after proven good behavior.
+
+Please highlight issues directly in rooms when possible, but if you don't feel comfortable doing that, then please send
+a DM to one of the moderators directly.
+
+Together, let’s build a community where everyone feels valued and respected.
+
+- The conduwuit Moderation Team

docs/configuration.md

@@ -0,0 +1,18 @@
+# Configuration
+
+This chapter describes various ways to configure conduwuit.
+
+## Basics
+
+Conduwuit uses a config file for the majority of the settings. Please refer to the
+[example config file](./configuration/examples.md#example-configuration) for all of those settings.
+The config file to use can either be specified on the command line when running conduwuit by specifying the
+`-c`, `--config` flag. Alternatively, you can use the environment variable `CONDUWUIT_CONFIG` to specify the config
+file to used.
+
+## Environment variables
+
+All of the settings that are found in the config file can be specified by using environment variables.
+The environment variable names should be all caps and prefixed with `CONDUWUIT_`.
+For example, if the setting you are changing is `max_request_size`, then the environment variable to set is
+`CONDUWUIT_MAX_REQUEST_SIZE`.

docs/configuration/examples.md

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

docs/contributing.md

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

docs/deploying.md

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

docs/deploying/arch-linux.md

@@ -0,0 +1,9 @@
+# conduwuit for Arch Linux
+
+Currently conduwuit is only on the Arch User Repository (AUR).
+
+The conduwuit AUR packages are community maintained and are not maintained by conduwuit development team, but the AUR package maintainers are in the Matrix room. Please attempt to verify your AUR package's PKGBUILD file looks fine before asking for support.
+
+- [conduwuit](https://aur.archlinux.org/packages/conduwuit) - latest tagged conduwuit
+- [conduwuit-git](https://aur.archlinux.org/packages/conduwuit-git) - latest git conduwuit from `main` branch
+- [conduwuit-bin](https://aur.archlinux.org/packages/conduwuit-bin) - latest tagged conduwuit static binary

docs/deploying/debian.md

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

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

@@ -1,44 +1,34 @@
-# Conduit - Behind Traefik Reverse Proxy
-version: '3'
+# conduwuit - Behind Traefik Reverse Proxy
 
 services:
     homeserver:
-        ### If you already built the Conduit image with 'docker build' or want to use the Docker Hub image,
+        ### 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/
+            - 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: '' # Ignore this
+            CONDUWUIT_SERVER_NAME: your.server.name # EDIT THIS
+            CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit
+            CONDUWUIT_DATABASE_BACKEND: rocksdb
+            CONDUWUIT_PORT: 6167
+            CONDUWUIT_MAX_REQUEST_SIZE: 20_000_000 # in bytes, ~20 MB
+            CONDUWUIT_ALLOW_REGISTRATION: 'true'
+            CONDUWUIT_ALLOW_FEDERATION: 'true'
+            CONDUWUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
+            CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
+            #CONDUWUIT_LOG: warn,state_res=warn
+            CONDUWUIT_ADDRESS: 0.0.0.0
+            #CONDUWUIT_CONFIG: '/etc/conduwuit.toml' # Uncomment if you mapped config toml above
+        #cpuset: "0-4" # Uncomment to limit to specific CPU cores
 
     # 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
@@ -47,7 +37,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,5 +1,4 @@
-# Conduit - Traefik Reverse Proxy Labels
-version: '3'
+# conduwuit - Traefik Reverse Proxy Labels
 
 services:
     homeserver:
@@ -7,10 +6,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 +17,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-caddy.yml

@@ -0,0 +1,54 @@
+services:
+    caddy:
+    # This compose file uses caddy-docker-proxy as the reverse proxy for conduwuit!
+    # For more info, visit https://github.com/lucaslorentz/caddy-docker-proxy
+        image: lucaslorentz/caddy-docker-proxy:ci-alpine
+        ports:
+            - 80:80
+            - 443:443
+        environment:
+            - CADDY_INGRESS_NETWORKS=caddy
+        networks:
+            - caddy
+        volumes:
+            - /var/run/docker.sock:/var/run/docker.sock
+            - ./data:/data
+        restart: unless-stopped
+        labels:
+            caddy: example.com
+            caddy.0_respond: /.well-known/matrix/server {"m.server":"matrix.example.com:443"}
+            caddy.1_respond: /.well-known/matrix/client {"m.server":{"base_url":"https://matrix.example.com"},"m.homeserver":{"base_url":"https://matrix.example.com"},"org.matrix.msc3575.proxy":{"url":"https://matrix.example.com"}}
+
+    homeserver:
+        ### If you already built the conduwuit image with 'docker build' or want to use a registry image,
+        ### then you are ready to go.
+        image: girlbossceo/conduwuit:latest
+        restart: unless-stopped
+        volumes:
+            - db:/var/lib/conduwuit
+            #- ./conduwuit.toml:/etc/conduwuit.toml
+        environment:
+            CONDUWUIT_SERVER_NAME: example.com # EDIT THIS
+            CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit
+            CONDUWUIT_DATABASE_BACKEND: rocksdb
+            CONDUWUIT_PORT: 6167
+            CONDUWUIT_MAX_REQUEST_SIZE: 20_000_000 # in bytes, ~20 MB
+            CONDUWUIT_ALLOW_REGISTRATION: 'true'
+            CONDUWUIT_ALLOW_FEDERATION: 'true'
+            CONDUWUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
+            CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
+            #CONDUWUIT_LOG: warn,state_res=warn
+            CONDUWUIT_ADDRESS: 0.0.0.0
+            #CONDUWUIT_CONFIG: '/etc/conduwuit.toml' # Uncomment if you mapped config toml above
+        networks:
+            - caddy
+        labels:
+            caddy: matrix.example.com
+            caddy.reverse_proxy: "{{upstreams 6167}}"
+
+volumes:
+    db:
+
+networks:
+    caddy:
+        external: true

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

@@ -1,50 +1,36 @@
-# Conduit - Behind Traefik Reverse Proxy
-version: '3'
+# conduwuit - Behind Traefik Reverse Proxy
 
 services:
     homeserver:
-        ### If you already built the Conduit image with 'docker build' or want to use the Docker Hub image,
+        ### 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
-            ### Uncomment if you want to use conduit.toml to configure Conduit
-            ### Note: Set env vars will override conduit.toml values
-            # - ./conduit.toml:/srv/conduit/conduit.toml
+            - db:/srv/conduwuit/.local/share/conduwuit
+            #- ./conduwuit.toml:/etc/conduwuit.toml
         networks:
             - proxy
         environment:
-            CONDUIT_SERVER_NAME: localhost:6167  # replace with your own name
-            CONDUIT_TRUSTED_SERVERS: '["matrix.org"]'
-            CONDUIT_ALLOW_REGISTRATION : 'true'
+            CONDUWUIT_SERVER_NAME: your.server.name # EDIT THIS
+            CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
+            CONDUWUIT_ALLOW_REGISTRATION : 'true'
+            #CONDUWUIT_CONFIG: '/etc/conduwuit.toml' # Uncomment if you mapped config toml above
             ### Uncomment and change values as desired
-            # CONDUIT_ADDRESS: 0.0.0.0
-            # CONDUIT_PORT: 6167
-            # CONDUIT_CONFIG: '/srv/conduit/conduit.toml'  # if you want to configure purely by env vars, set this to an empty string ''
-            # 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
 
     # 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
@@ -54,7 +40,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
@@ -95,4 +81,4 @@ volumes:
     acme:
 
 networks:
-    proxy:
+    proxy:

docs/deploying/docker-compose.yml

@@ -0,0 +1,43 @@
+# conduwuit
+
+services:
+    homeserver:
+        ### If you already built the conduwuit image with 'docker build' or want to use a registry image,
+        ### then you are ready to go.
+        image: girlbossceo/conduwuit:latest
+        restart: unless-stopped
+        ports:
+            - 8448:6167
+        volumes:
+            - db:/var/lib/conduwuit
+            #- ./conduwuit.toml:/etc/conduwuit.toml
+        environment:
+            CONDUWUIT_SERVER_NAME: your.server.name # EDIT THIS
+            CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit
+            CONDUWUIT_DATABASE_BACKEND: rocksdb
+            CONDUWUIT_PORT: 6167
+            CONDUWUIT_MAX_REQUEST_SIZE: 20_000_000 # in bytes, ~20 MB
+            CONDUWUIT_ALLOW_REGISTRATION: 'true'
+            CONDUWUIT_ALLOW_FEDERATION: 'true'
+            CONDUWUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
+            CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
+            #CONDUWUIT_LOG: warn,state_res=warn
+            CONDUWUIT_ADDRESS: 0.0.0.0
+            #CONDUWUIT_CONFIG: '/etc/conduwuit.toml' # Uncomment if you mapped config toml above
+    #
+    ### Uncomment if you want to use your own Element-Web App.
+    ### Note: You need to provide a config.json for Element and you also need a second
+    ###       Domain or Subdomain for the communication between Element and conduwuit
+    ### Config-Docs: https://github.com/vector-im/element-web/blob/develop/docs/config.md
+    # element-web:
+    #     image: vectorim/element-web:latest
+    #     restart: unless-stopped
+    #     ports:
+    #         - 8009:80
+    #     volumes:
+    #         - ./element_config.json:/app/config.json
+    #     depends_on:
+    #         - homeserver
+
+volumes:
+    db:

docs/deploying/docker.md

@@ -0,0 +1,117 @@
+# conduwuit for Docker
+
+## Docker
+
+To run conduwuit with Docker you can either build the image yourself or pull it from a registry.
+
+### Use a registry
+
+OCI images for conduwuit are available in the registries listed below.
+
+| Registry        | Image                                                           | Size                          | Notes                  |
+| --------------- | --------------------------------------------------------------- | ----------------------------- | ---------------------- |
+| 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
+
+```bash
+docker image pull <link>
+```
+
+to pull it to your machine.
+
+### Run
+
+When you have the image you can simply run it with
+
+```bash
+docker run -d -p 8448:6167 \
+  -v db:/var/lib/conduwuit/ \
+  -e CONDUWUIT_SERVER_NAME="your.server.name" \
+  -e CONDUWUIT_DATABASE_BACKEND="rocksdb" \
+  -e CONDUWUIT_ALLOW_REGISTRATION=false \
+  --name conduit <link>
+```
+
+or you can use [docker compose](#docker-compose).
+
+The `-d` flag lets the container run in detached mode. You may supply an optional `conduwuit.toml` config file, the example config can be found [here](../configuration/examples.md).
+You can pass in different env vars to change config values on the fly. You can even configure conduwuit completely by using env vars. For an overview of possible
+values, please take a look at the [`docker-compose.yml`](docker-compose.yml) file.
+
+If you just want to test conduwuit for a short time, you can use the `--rm` flag, which will clean up everything related to your container after you stop it.
+
+### Docker-compose
+
+If the `docker run` command is not for you or your setup, you can also use one of the provided `docker-compose` files.
+
+Depending on your proxy setup, you can use one of the following files;
+
+- If you already have a `traefik` instance set up, use [`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml)
+- If you don't have a `traefik` instance set up and would like to use it, use [`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)
+- If you want a setup that works out of the box with `caddy-docker-proxy`, use [`docker-compose.with-caddy.yml`](docker-compose.with-caddy.yml) and replace all `example.com` placeholders with your own domain
+- For any other reverse proxy, use [`docker-compose.yml`](docker-compose.yml)
+
+When picking the traefik-related compose file, rename it so it matches `docker-compose.yml`, and
+rename the override file to `docker-compose.override.yml`. Edit the latter with the values you want
+for your server.
+
+When picking the `caddy-docker-proxy` compose file, it's important to first create the `caddy` network before spinning up the containers:
+
+```bash
+docker network create caddy
+```
+
+After that, you can rename it so it matches `docker-compose.yml` and spin up the containers!
+
+Additional info about deploying conduwuit can be found [here](generic.md).
+
+### Build
+
+To build the conduwuit image with docker-compose, you first need to open and modify the `docker-compose.yml` file. There you need to comment the `image:` option and uncomment the `build:` option. Then call docker compose with:
+
+```bash
+docker compose up
+```
+
+This will also start the container right afterwards, so if want it to run in detached mode, you also should use the `-d` flag.
+
+### 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
+```
+
+> **Note:** Don't forget to modify and adjust the compose file to your needs.
+
+### Use Traefik as Proxy
+
+As a container user, you probably know about Traefik. It is a easy to use reverse proxy for making
+containerized app and services available through the web. With the two provided files,
+[`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml) (or
+[`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)) and
+[`docker-compose.override.yml`](docker-compose.override.yml), it is equally easy to deploy
+and use conduwuit, with a little caveat. If you already took a look at the files, then you should have
+seen the `well-known` service, and that is the little caveat. Traefik is simply a proxy and
+loadbalancer and is not able to serve any kind of content, but for conduwuit to federate, we need to
+either expose ports `443` and `8448` or serve two endpoints `.well-known/matrix/client` and
+`.well-known/matrix/server`.
+
+With the service `well-known` we use a single `nginx` container that will serve those two files.
+
+## Voice communication
+
+See the [TURN](../turn.md) page.

docs/deploying/generic.md

@@ -0,0 +1,135 @@
+# Generic deployment documentation
+
+> ## Getting help
+>
+> If you run into any problems while setting up conduwuit, ask us
+> in `#conduwuit:puppygock.gay` or [open an issue on GitHub](https://github.com/girlbossceo/conduwuit/issues/new).
+
+## 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 tagged release [here](https://github.com/girlbossceo/conduwuit/releases/latest).
+
+The latest tagged release also includes the Debian packages.
+
+Alternatively, you may compile the binary yourself. We recommend using [Lix](https://lix.systems) to build conduwuit as this has the most guaranteed
+reproducibiltiy and easiest to get a build environment and output going.
+
+Otherwise, follow standard Rust project build guides (installing git and cloning the repo, getting the Rust toolchain via rustup, installing LLVM toolchain + libclang, installing liburing for io_uring and RocksDB, etc).
+
+## Adding a conduwuit user
+
+While conduwuit can run as any user it is better to use dedicated users for different services. This also allows
+you to make sure that the file permissions are correctly set up.
+
+In Debian or Fedora/RHEL, you can use this command to create a conduwuit user:
+
+```bash
+sudo adduser --system conduwuit --group --disabled-login --no-create-home
+```
+
+For distros without `adduser`:
+
+```bash
+sudo useradd -r --shell /usr/bin/nologin --no-create-home conduwuit
+```
+
+## Forwarding ports in the firewall or the router
+
+conduwuit uses the ports 443 and 8448 both of which need to be open in the firewall.
+
+If conduwuit runs behind a router or in a container and has a different public IP address than the host system these public ports need to be forwarded directly or indirectly to the port mentioned in the config.
+
+## Setting up a systemd service
+
+The systemd unit for conduwuit can be found [here](../configuration/examples.md#example-systemd-unit-file). You may need to change the `ExecStart=` path to where you placed the conduwuit binary.
+
+## Creating the conduwuit configuration file
+
+Now we need to create the conduwuit's config file in `/etc/conduwuit/conduwuit.toml`. The example config can be found at [conduwuit-example.toml](../configuration/examples.md).**Please take a moment to read it. You need to change at least the server name.**
+
+RocksDB is the only supported database backend.
+
+## Setting the correct file permissions
+
+If you are using a dedicated user for conduwuit, you will need to allow it to read the config. To do that you can run this:
+
+```bash
+sudo chown -R root:root /etc/conduwuit
+sudo chmod -R 755 /etc/conduwuit
+```
+
+If you use the default database path you also need to run this:
+
+```bash
+sudo mkdir -p /var/lib/conduwuit/
+sudo chown -R conduwuit:conduwuit /var/lib/conduwuit/
+sudo chmod 700 /var/lib/conduwuit/
+```
+
+## Setting up the Reverse Proxy
+
+Refer to the documentation or various guides online of your chosen reverse proxy software. A [Caddy](https://caddyserver.com/) example will be provided as this is the recommended reverse proxy for new users and is very trivial to use (handles TLS, reverse proxy headers, etc transparently with proper defaults).
+
+Lighttpd is not supported as it seems to mess with the `X-Matrix` Authorization header, making federation non-functional. If using Apache, you need to use `nocanon` to prevent this.
+
+### Caddy
+
+Create `/etc/caddy/conf.d/conduwuit_caddyfile` and enter this (substitute for your server name).
+
+```caddy
+your.server.name, your.server.name:8448 {
+        # TCP
+        reverse_proxy 127.0.0.1:6167
+
+        # UNIX socket
+        #reverse_proxy unix//run/conduwuit/conduwuit.sock
+}
+```
+
+That's it! Just start and enable the service and you're set.
+
+```bash
+sudo systemctl enable --now caddy
+```
+
+## You're done
+
+Now you can start conduwuit with:
+
+```bash
+sudo systemctl start conduwuit
+```
+
+Set it to start automatically when your system boots with:
+
+```bash
+sudo systemctl enable conduwuit
+```
+
+## How do I know it works?
+
+You can open [a Matrix client](https://matrix.org/ecosystem/clients), enter your homeserver and try to register.
+
+You can also use these commands as a quick health check (replace `your.server.name`).
+
+```bash
+$ curl https://your.server.name/_conduwuit/server_version
+
+# If using port 8448
+$ curl https://your.server.name:8448/_conduwuit/server_version
+```
+
+- To check if your server can talk with other homeservers, you can use the [Matrix Federation Tester](https://federationtester.matrix.org/).
+  If you can register but cannot join federated rooms check your config again and also check if the port 8448 is open and forwarded correctly.
+
+# What's next?
+
+## Audio/Video calls
+
+For Audio/Video call functionality see the [TURN Guide](../turn.md).
+
+## Appservices
+
+If you want to set up an appservice, take a look at the [Appservice Guide](../appservices.md).

docs/deploying/nixos.md

@@ -0,0 +1,40 @@
+# conduwuit for NixOS
+
+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
+
+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: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=
+```
+
+If specifying a URL in your flake, please use the GitHub remote: `github:girlbossceo/conduwuit`
+
+The `flake.nix` and `default.nix` do not (currently) provide a NixOS module, so
+(for now) [`services.matrix-conduit`][module] from Nixpkgs should be used to
+configure conduwuit.
+
+If you want to run the latest code, you should get conduwuit from the `flake.nix`
+or `default.nix` and set [`services.matrix-conduit.package`][package]
+appropriately.
+
+[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=systemd,element_hacks,gzip_compression,brotli_compression,zstd_compression,tokio_console
+```
+
+[1]: https://docs.rs/tokio-console/latest/tokio_console/

docs/development/hot_reload.md

@@ -0,0 +1,96 @@
+# Hot Reloading ("Live" Development)
+
+### Summary
+
+When developing in debug-builds with the nightly toolchain, conduwuit is modular using dynamic libraries and various parts of the application are hot-reloadable while the server is running: http api handlers, admin commands, services, database, etc. These are all split up into individual workspace crates as seen in the `src/` directory. Changes to sourcecode in a crate rebuild that crate and subsequent crates depending on it. Reloading then occurs for the changed crates.
+
+Release builds still produce static binaries which are unaffected. Rust's soundness guarantees are in full force. Thus you cannot hot-reload release binaries.
+
+### Requirements
+
+Currently, this development setup only works on x86_64 and aarch64 Linux glibc. [musl explicitly does not support hot reloadable libraries, and does not implement `dlclose`][2]. macOS does not fully support our usage of `RTLD_GLOBAL` possibly due to some thread-local issues. [This Rust issue][3] may be of relevance, specifically [this comment][4]. It may be possible to get it working on only very modern macOS versions such as at least Sonoma, as currently loading dylibs is supported, but not unloading them in our setup, and the cited comment mentions an Apple WWDC confirming there have been TLS changes to somewhat make this possible.
+
+As mentioned above this requires the nightly toolchain. This is due to reliance on various Cargo.toml features that are only available on nightly, most specifically `RUSTFLAGS` in Cargo.toml. Some of the implementation could also be simpler based on other various nightly features. We hope lots of nightly features start making it out of nightly sooner as there have been dozens of very helpful features that have been stuck in nightly ("unstable") for at least 5+ years that would make this simpler. We encourage greater community consensus to move these features into stability.
+
+This currently only works on x86_64/aarch64 Linux with a glibc C library. musl C library, macOS, and likely other host architectures are not supported (if other architectures work, feel free to let us know and/or make a PR updating this). This should work on GNU ld and lld (rust-lld) and gcc/clang, however if you happen to have linker issues it's recommended to try using `mold` or `gold` linkers, and please let us know in the [conduwuit Matrix room][7] the linker error and what linker solved this issue so we can figure out a solution. Ideally there should be minimal friction to using this, and in the future a build script (`build.rs`) may be suitable to making this easier to use if the capabilities allow us.
+
+### Usage
+
+As of 19 May 2024, the instructions for using this are:
+
+0. Have patience. Don't hesitate to join the [conduwuit Matrix room][7] to receive help using this. As indicated by the various rustflags used and some of the interesting issues linked at the bottom, this is definitely not something the Rust ecosystem or toolchain is used to doing.
+
+1. Install the nightly toolchain using rustup. You may need to use `rustup override set nightly` in your local conduwuit directory, or use `cargo +nightly` for all actions.
+
+2. Uncomment `cargo-features` at the top level / root Cargo.toml
+
+3. Scroll down to the `# Developer profile` section and uncomment ALL the rustflags for each dev profile and their respective packages.
+
+4. In each workspace crate's Cargo.toml (everything under `src/*` AND `deps/rust-rocksdb/Cargo.toml`), uncomment the `dylib` crate type under `[lib]`.
+
+5. Due to [this rpath issue][5], you must export the `LD_LIBRARY_PATH` environment variable to your nightly Rust toolchain library directory. If using rustup (hopefully), use this: `export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$HOME/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/`
+
+6. Start the server. You can use `cargo +nightly run` for this along with the standard.
+
+7. Make some changes where you need to.
+
+8. In a separate terminal window in the same directory (or using a terminal multiplexer like tmux), run the *build* Cargo command `cargo +nightly build`. Cargo should only rebuild what was changed / what's necessary, so it should not be rebuilding all the crates.
+
+9. In your conduwuit server terminal, hit/send `CTRL+C` signal. This will tell conduwuit to find which libraries need to be reloaded, and reloads them as necessary.
+
+10. If there were no errors, it will tell you it successfully reloaded `#` modules, and your changes should now be visible. Repeat 7 - 9 as needed.
+
+To shutdown conduwuit in this setup, hit/send `CTRL+\`. Normal builds still shutdown with `CTRL+C` as usual.
+
+Steps 1 - 5 are the initial first-time steps for using this. To remove the hot reload setup, revert/comment all the Cargo.toml changes.
+
+As mentioned in the requirements section, if you happen to have some linker issues, try using the `-fuse-ld=` rustflag and specify mold or gold in all the `rustflags` definitions in the top level Cargo.toml, and please let us know in the [conduwuit Matrix room][7] the problem. mold can be installed typically through your distro, and gold is provided by the binutils package.
+
+It's possible a helper script can be made to do all of this, or most preferably a specially made build script (build.rs). `cargo watch` support will be implemented soon which will eliminate the need to manually run `cargo build` all together.
+
+### Addendum
+
+Conduit was inherited as a single crate without modularity or reloading in its design. Reasonable partitioning and abstraction allowed a split into several crates, though many circular dependencies had to be corrected. The resulting crates now form a directed graph as depicted in figures below. The interfacing between these crates is still extremely broad which is not mitigable.
+
+Initially [hot_lib_reload][6] was investigated but found appropriate for a project designed with modularity through limited interfaces, not a large and complex existing codebase. Instead a bespoke solution built directly on [libloading][8] satisfied our constraints. This required relatively minimal modifications and zero maintenance burden compared to what would be required otherwise. The technical difference lies with relocation processing: we leverage global bindings (`RTLD_GLOBAL`) in a very intentional way. Most libraries and off-the-shelf module systems (such as [hot_lib_reload][6]) restrict themselves to local bindings (`RTLD_LOCAL`). This allows them to release software to multiple platforms with much greater consistency, but at the cost of burdening applications to explicitly manage these bindings. In our case with an optional feature for developers, we shrug any such requirement to enjoy the cost/benefit on platforms where global relocations are properly cooperative.
+
+To make use of `RTLD_GLOBAL` the application has to be oriented as a directed acyclic graph. The primary rule is simple and illustrated in the figure below: **no crate is allowed to call a function or use a variable from a crate below it.**
+
+![conduwuit's dynamic library setup diagram - created by Jason Volk](assets/libraries.png)
+
+When a symbol is referenced between crates they become bound: **crates cannot be unloaded until their calling crates are first unloaded.** Thus we start the reloading process from the crate which has no callers. There is a small problem though: the first crate is called by the base executable itself! This is solved by using an `RTLD_LOCAL` binding for just one link between the main executable and the first crate, freeing the executable from all modules as no global binding ever occurs between them.
+
+![conduwuit's reload and load order diagram - created by Jason Volk](assets/reload_order.png)
+
+Proper resource management is essential for reliable reloading to occur. This is a very basic ask in RAII-idiomatic Rust and the exposure to reloading hazards is remarkably low, generally stemming from poor patterns and practices. Unfortunately static analysis doesn't enforce reload-safety programmatically (though it could one day), for now hazards can be avoided by knowing a few basic do's and dont's:
+
+1. Understand that code is memory. Just like one is forbidden from referencing free'd memory, one must not transfer control to free'd code. Exposure to this is primarily from two things:
+
+- Callbacks, which this project makes very little use of.
+- Async tasks, which are addressed below.
+
+2. Tie all resources to a scope or object lifetime with greatest possible symmetry (locality). For our purposes this applies to code resources, which means async blocks and tokio tasks.
+
+- **Never spawn a task without receiving and storing its JoinHandle**.
+- **Always wait on join handles** before leaving a scope or in another cleanup function called by an owning scope.
+
+3. Know any minor specific quirks documented in code or here:
+
+- Don't use `tokio::spawn`, instead use our `Handle` in `core/server.rs`, which is reachable in most of the codebase via `services()` or other state. This is due to some bugs or assumptions made in tokio, as it happens in `unsafe {}` blocks, which are mitigated by circumventing some thread-local variables. Using runtime handles is good practice in any case.
+
+The initial implementation PR is available [here][1].
+
+### Interesting related issues/bugs
+
+- [DT_RUNPATH produced in binary with rpath = true is wrong (cargo)][5]
+- [Disabling MIR Optimization in Rust Compilation (cargo)](https://internals.rust-lang.org/t/disabling-mir-optimization-in-rust-compilation/19066/5)
+- [Workspace-level metadata (cargo-deb)](https://github.com/kornelski/cargo-deb/issues/68)
+
+[1]: https://github.com/girlbossceo/conduwuit/pull/387
+[2]: https://wiki.musl-libc.org/functional-differences-from-glibc.html#Unloading-libraries
+[3]: https://github.com/rust-lang/rust/issues/28794
+[4]: https://github.com/rust-lang/rust/issues/28794#issuecomment-368693049
+[5]: https://github.com/rust-lang/cargo/issues/12746
+[6]: https://crates.io/crates/hot-lib-reloader/
+[7]: https://matrix.to/#/#conduwuit:puppygock.gay
+[8]: https://crates.io/crates/libloading

docs/development/testing.md

@@ -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

@@ -0,0 +1,197 @@
+#### **Note: This list may not up to date. There are rapidly more and more improvements, fixes, changes, etc being made that it is becoming more difficult to maintain this list. I recommend that you give conduwuit a try and see the differences for yourself. If you have any concerns, feel free to join the conduwuit Matrix room and ask any pre-usage questions.**
+
+### list of features, bug fixes, etc that conduwuit does that Conduit does not
+
+Outgoing typing indicators, outgoing read receipts, **and** outgoing presence!
+
+## Performance
+
+- Concurrency support for individual homeserver key fetching for faster remote room joins and room joins that will error less frequently
+- Send `Cache-Control` response header with `immutable` and 1 year cache length for all media requests (download and thumbnail) to instruct clients to cache media, and reduce server load from media requests that could be otherwise cached
+- Add feature flags and config options to enable/build with zstd, brotli, and/or gzip HTTP body compression (response and request)
+- Eliminate all usage of the thread-blocking `getaddrinfo(3)` call upon DNS queries, significantly improving federation latency/ping and cache DNS results (NXDOMAINs, successful queries, etc) using hickory-dns / hickory-resolver
+- Enable HTTP/2 support on all requests
+- Vastly improve RocksDB default settings to use new features that help with performance significantly, uses settings tailored to SSDs, various ways to tweak RocksDB, and a conduwuit setting to tell RocksDB to use settings that are tailored to HDDs or slow spinning rust storage or buggy filesystems.
+- Implement database flush and cleanup conduwuit operations when using RocksDB
+- Implement RocksDB write buffer corking and coalescing in database write-heavy areas
+- Perform connection pooling and keepalives where necessary to significantly improve federation performance and latency
+- Various config options to tweak connection pooling, request timeouts, connection timeouts, DNS timeouts and settings, etc with good defaults which also help huge with performance via reusing connections and retrying where needed
+- Properly get and use the amount of parallelism / tokio workers
+- Implement building conduwuit with jemalloc (which extends to the RocksDB jemalloc feature for maximum gains) or hardened_malloc light variant, and io_uring support, and produce CI builds with jemalloc and io_uring by default for performance (Nix doesn't seem to build [hardened_malloc-rs](https://github.com/girlbossceo/hardened_malloc-rs) properly)
+- Add support for caching DNS results with hickory-dns / hickory-resolver in conduwuit (not a replacement for a proper resolver cache, but still far better than nothing), also properly falls back on TCP for UDP errors or if a SRV response is too large
+- Add config option for using DNS over TCP, and config option for controlling A/AAAA record lookup strategy (e.g. don't query AAAA records if you don't have IPv6 connectivity)
+- Overall significant database, Client-Server, and federation performance and latency improvements (check out the ping room leaderboards if you don't believe me :>)
+- Add config options for RocksDB compression and bottommost compression, including choosing the algorithm and compression level
+- Use [loole](https://github.com/mahdi-shojaee/loole) MPSC channels instead of tokio MPSC channels for huge performance boosts in sending channels (mainly relevant for federation) and presence channels
+- Use `tracing`/`log`'s `release_max_level_info` feature to improve performance, build speeds, binary size, and CPU usage in release builds by avoid compiling debug/trace log level macros that users will generally never use (can be disabled with a build-time feature flag)
+- Remove some unnecessary checks on EDU handling for incoming transactions, effectively speeding them up
+- Simplify, dedupe, etc huge chunks of the codebase, including some that were unnecessary overhead, binary bloats, or preventing compiler/linker optimisations
+- Implement zero-copy RocksDB database accessors, substantially improving performance caused by unnecessary memory allocations
+
+## General Fixes/Features
+
+- Add legacy Element client hack fixing password changes and deactivations on legacy Element Android/iOS due to usage of an unspecced `user` field for UIAA
+- Raise and improve all the various request timeouts making some things like room joins and client bugs error less or none at all than they should, and make them all user configurable
+- Add missing `reason` field to user ban events (`/ban`)
+- Safer and cleaner shutdowns across incoming/outgoing requests (graceful shutdown) and the database
+- Stop sending `make_join` requests on room joins if 15 servers respond with `M_UNSUPPORTED_ROOM_VERSION` or `M_INVALID_ROOM_VERSION`
+- Stop sending `make_join` requests if 50 servers cannot provide `make_join` for us
+- Respect *most* client parameters for `/media/` requests (`allow_redirect` still needs work)
+- Return joined member count of rooms for push rules/conditions instead of a hardcoded value of 10
+- Make `CONDUIT_CONFIG` optional, relevant for container users that configure only by environment variables and no longer need to set `CONDUIT_CONFIG` to an empty string.
+- Allow HEAD and PATCH (MSC4138) HTTP requests in CORS for clients (despite not being explicity mentioned in Matrix spec, HTTP spec says all HEAD requests need to behave the same as GET requests, Synapse supports HEAD requests)
+- Fix using conduwuit with flake-compat on NixOS
+- Resolve and remove some "features" from upstream that result in concurrency hazards, exponential backoff issues, or arbitrary performance limiters
+- Find more servers for outbound federation `/hierarchy` requests instead of just the room ID server name
+- Support for suggesting servers to join through at `/_matrix/client/v3/directory/room/{roomAlias}`
+- Support for suggesting servers to join through us at `/_matrix/federation/v1/query/directory`
+- Misc edge-case search fixes (e.g. potentially missing some events)
+- Misc `/sync` fixes (e.g. returning unnecessary data or incorrect/invalid responses)
+- Add `replaces_state` and `prev_sender` in `unsigned` for state event changes which primarily makes Element's "See history" button on a state event functional
+- Fix Conduit not allowing incoming federation requests for various world readable rooms
+- Fix Conduit not respecting the client-requested file name on media requests
+- Prevent sending junk / non-membership events to `/send_join` and `/send_leave` endpoints
+- Only allow the requested membership type on `/send_join` and `/send_leave` endpoints (e.g. don't allow leave memberships on join endpoints)
+- Prevent state key impersonation on `/send_join` and `/send_leave` endpoints
+- Validate `X-Matrix` origin and request body `"origin"` field on incoming transactions
+- Add `GET /_matrix/client/v1/register/m.login.registration_token/validity` endpoint
+- Explicitly define support for sliding sync at `/_matrix/client/versions` (`org.matrix.msc3575`)
+- Fix seeing empty status messages on user presences
+
+## Moderation
+
+- (Also see [Admin Room](#admin-room) for all the admin commands pertaining to moderation, there's a lot!)
+- Add support for room banning/blocking by ID using admin command
+- Add support for serving `support` well-known from `[global.well_known]` (MSC1929) (`/.well-known/matrix/support`)
+- Config option to forbid publishing rooms to the room directory (`lockdown_public_room_directory`) except for admins
+- Admin commands to delete room aliases and unpublish rooms from our room directory
+- For all [`/report`](https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3roomsroomidreporteventid) requests: check if the reported event ID belongs to the reported room ID, raise report reasoning character limit to 750, fix broken formatting, make a small delayed random response per spec suggestion on privacy, and check if the sender user is in the reported room.
+- Support blocking servers from downloading remote media from, returning a 404
+- Don't allow `m.call.invite` events to be sent in public rooms (prevents calling the entire room)
+- On new public room creations, only allow moderators to send `m.call.invite`, `org.matrix.msc3401.call`, and `org.matrix.msc3401.call.member` events to prevent unprivileged users from calling the entire room
+- Add support for a "global ACLs" feature (`forbidden_remote_server_names`) that blocks inbound remote room invites, room joins by room ID on server name, room joins by room alias on server name, incoming federated joins, and incoming federated room directory requests. This is very helpful for blocking servers that are purely toxic/bad and serve no value in allowing our users to suffer from things like room invite spam or such. Please note that this is not a substitute for room ACLs.
+- Add support for a config option to forbid our local users from sending federated room directory requests for (`forbidden_remote_room_directory_server_names`). Similar to above, useful for blocking servers that help prevent our users from wandering into bad areas of Matrix via room directories of those malicious servers.
+- Add config option for auto remediating/deactivating local non-admin users who attempt to join bad/forbidden rooms (`auto_deactivate_banned_room_attempts`)
+- Deactivating users will remove their profile picture, blurhash, display name, and leave all rooms by default just like Synapse and for additional privacy
+- Reject some EDUs from ACL'd users such as read receipts and typing indicators
+
+## Privacy/Security
+
+- Add config option for device name federation with a privacy-friendly default (disabled)
+- Add config option for requiring authentication to the `/publicRooms` endpoint (room directory) with a default enabled for privacy
+- Add config option for federating `/publicRooms` endpoint (room directory) to other servers with a default disabled for privacy
+- Uses proper `argon2` crate by RustCrypto instead of questionable `rust-argon2` crate
+- Generate passwords with 25 characters instead of 15
+- Config option `ip_range_denylist` to support refusing to send requests (typically federation) to specific IP ranges, typically RFC 1918, non-routable, testnet, etc addresses like Synapse for security (note: this is not a guaranteed protection, and you should be using a firewall with zones if you want guaranteed protection as doing this on the application level is prone to bypasses).
+- Config option to block non-admin users from sending room invites or receiving remote room invites. Admin users are still allowed.
+- Config option to disable incoming and/or outgoing remote read receipts
+- Config option to disable incoming and/or outgoing remote typing indicators
+- Config option to disable incoming, outgoing, and/or local presence and for timing out remote users
+- Sanitise file names for the `Content-Disposition` header for all media requests (thumbnails, downloads, uploads)
+- Media repository on handling `Content-Disposition` and `Content-Type` is fully spec compliant and secured
+- Send secure default HTTP headers such as a strong restrictive CSP (see MSC4149), deny iframes, disable `X-XSS-Protection`, disable interest cohort in `Permission-Policy`, etc to mitigate any potential attack surface such as from untrusted media
+
+## 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
+- Add `/_conduwuit/server_version` route to return the version of conduwuit without relying on the federation API `/_matrix/federation/v1/version`
+- Add `/_conduwuit/local_user_count` route to return the amount of registered active local users on your homeserver *if federation is enabled*
+- Add configurable RocksDB recovery modes to aid in recovering corrupted RocksDB databases
+- Support config options via `CONDUWUIT_` prefix and accessing non-global struct config options with the `__` split (e.g. `CONDUWUIT_WELL_KNOWN__SERVER`)
+- Add support for listening on multiple TCP ports and multiple addresses
+- **Opt-in** Sentry.io telemetry and metrics, mainly used for crash reporting
+- Log the client IP on various requests such as registrations, banned room join attempts, logins, deactivations, federation transactions, etc
+- Fix Conduit dropping some remote server federation response errors
+
+## Maintenance/Stability
+
+- GitLab CI ported to GitHub Actions
+- Add support for the Matrix spec compliance test suite [Complement](https://github.com/matrix-org/complement/) via the Nix flake and various other fixes for it
+- Implement running and diff'ing Complement results in CI and error if any mismatch occurs to prevent large cases of conduwuit regressions
+- Repo is (officially) mirrored to GitHub, GitLab, git.gay, git.girlcock.ceo, sourcehut, and Codeberg (see README.md for their links)
+- Docker container images published to GitLab Container Registry, GitHub Container Registry, and Dockerhub
+- Extensively revamp the example config to be extremely helpful and useful to both new users and power users
+- Fixed every single clippy (default lints) and rustc warnings, including some that were performance related or potential safety issues / unsoundness
+- Add a **lot** of other clippy and rustc lints and a rustfmt.toml file
+- Repo uses [Renovate](https://docs.renovatebot.com/), [Trivy](https://github.com/aquasecurity/trivy-action), and keeps ALL dependencies as up to date as possible
+- Purge unmaintained/irrelevant/broken database backends (heed, sled, persy) and other unnecessary code or overhead
+- webp support for images
+- Add cargo audit support to CI
+- Add documentation lints via lychee and markdownlint-cli to CI
+- CI tests for all sorts of feature matrixes (jemalloc, non-defaullt, all features, etc)
+- Add static and dynamic linking smoke tests in CI to prevent any potential linking regressions for Complement, static binaries, Nix devshells, etc
+- Add timestamp by commit date when building OCI images for keeping image build reproducibility and still have a meaningful "last modified date" for OCI image
+- Add timestamp by commit date via `SOURCE_DATE_EPOCH` for Debian packages
+- Startup check if conduwuit running in a container and is listening on 127.0.0.1 (generally containers are using NAT networking and 0.0.0.0 is the intended listening address)
+- Add a panic catcher layer to return panic messages in HTTP responses if a panic occurs
+- Add full compatibility support for SHA256 media file names instead of base64 file names to overcome filesystem file name length limitations (OS error file name too long) while still retaining upstream database compatibility
+- Remove SQLite support due to being very poor performance, difficult to maintain against RocksDB, and is a blocker to significantly improved database code
+
+## Admin Room
+
+- Add support for a console CLI interface that can issue admin commands and output them in your terminal
+- Add support for an admin-user-only commandline admin room interface that can be issued in any room with the `\\!admin` or `\!admin` prefix and returns the response as yourself in the same room
+- Add admin commands for uptime, server startup, server shutdown, and server restart
+- Fix admin room handler to not panic/crash if the admin room command response fails (e.g. too large message)
+- Add command to dynamically change conduwuit's tracing log level filter on the fly
+- Add admin command to fetch a server's `/.well-known/matrix/support` file
+- Add debug admin command to force update user device lists (could potentially resolve some E2EE flukes)
+- Implement **RocksDB online backups**, listing RocksDB backups, and listing database file counts all via admin commands
+- Add various database visibility commands such as being able to query the getters and iterators used in conduwuit, a very helpful online debugging utility
+- 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 command to list all the rooms a local user is joined in
+- Add admin command to list joined members in a room
+- Add admin command to view the room topic of a room
+- Add admin command to delete all remote media in the past X minutes as a form of deleting media that you don't want on your server that a remote user posted in a room, a `--force` flag to ignore errors, and support for reading `last modified time` instead of `creation time` for filesystems that don't support file created metadata
+- Add admin command to return a room's full/complete state
+- Admin debug command to fetch a PDU from a remote server and inserts it into our database/timeline as backfill
+- Add admin command to delete media via a specific MXC. This deletes the MXC from our database, and the file locally.
+- Add admin commands for banning (blocking) room IDs from our local users joining (admins are always allowed) and evicts all our local users from that room, in addition to bulk room banning support, and blocks room invites (remote and local) to the banned room, as a moderation feature
+- Add admin commands to output jemalloc memory stats and memory usage
+- Add admin command to get rooms a *remote* user shares with us
+- Add debug admin commands to get the earliest and latest PDU in a room
+- Add debug admin command to echo a message
+- Add admin command to insert rooms tags for a user, most useful for inserting the `m.server_notice` tag on your admin room to make it "persistent" in the "System Alerts" section of Element
+- Add experimental admin debug command for Dendrite's `AdminDownloadState` (`/admin/downloadState/{serverName}/{roomID}`) admin API endpoint to download and use a remote server's room state in the room
+- Disable URL previews by default in the admin room due to various command outputs having "URLs" in them that clients may needlessly render/request
+- Extend memory usage admin server command to support showing memory allocator stats such as jemalloc's
+- Add admin debug command to see memory allocator's full extended debug statistics such as jemalloc's
+
+## Misc
+
+- Add guest support for accessing TURN servers via `turn_allow_guests` like Synapse
+- Support for creating rooms with custom room IDs like Maunium Synapse (`room_id` request body field to `/createRoom`)
+- Query parameter `?format=event|content` for returning either the room state event's content (default) for the full room state event on `/_matrix/client/v3/rooms/{roomId}/state/{eventType}[/{stateKey}]` requests (see <https://github.com/matrix-org/matrix-spec/issues/1047>)
+- Send a User-Agent on all of our requests
+- Send `avatar_url` on invite room membership events/changes
+- Support sending [`well_known` response to client login responses](https://spec.matrix.org/v1.10/client-server-api/#post_matrixclientv3login) if using config option `[well_known.client]`
+- Implement `include_state` search criteria support for `/search` requests (response now can include room states)
+- Declare various missing Matrix versions and features at `/_matrix/client/versions`
+- Implement legacy Matrix `/v1/` media endpoints that some clients and servers may still call
+- Config option to change Conduit's behaviour of homeserver key fetching (`query_trusted_key_servers_first`). This option sets whether conduwuit will query trusted notary key servers first before the individual homeserver(s), or vice versa which may help in joining certain rooms.
+- Implement unstable MSC2666 support for querying mutual rooms with a user
+- Implement unstable MSC3266 room summary API support
+- Implement unstable MSC4125 support for specifying servers to join via on federated invites
+- Make conduwuit build and be functional under Nix + macOS
+- Log out all sessions after unsetting the emergency password
+- Assume well-knowns are broken if they exceed past 12288 characters.
+- Add support for listening on both HTTP and HTTPS if using direct TLS with conduwuit for usecases such as Complement
+- Add config option for disabling RocksDB Direct IO if needed
+- Add various documentation on maintaining conduwuit, using RocksDB online backups, some troubleshooting, using admin commands, moderation documentation, etc
+- (Developers): Add support for [hot reloadable/"live" modular development](development/hot_reload.md)
+- (Developers): Add support for tokio-console
+- (Developers): Add support for tracing flame graphs
+- No cryptocurrency donations allowed, conduwuit is fully maintained by independent queer maintainers, and with a strong priority on inclusitivity and comfort for protected groups 🏳️‍⚧️
+- [Add a community Code of Conduct for all conduwuit community spaces, primarily the Matrix space](https://conduwuit.puppyirl.gay/conduwuit_coc.html)

docs/introduction.md

@@ -0,0 +1,21 @@
+# conduwuit
+
+{{#include ../README.md:catchphrase}}
+
+{{#include ../README.md:body}}
+
+#### What's different about your fork than upstream Conduit?
+
+See the [differences](differences.md) page
+
+#### How can I deploy my own?
+
+- [Deployment options](deploying.md)
+
+If you want to connect an appservice to conduwuit, take a look at the [appservices documentation](appservices.md).
+
+#### How can I contribute?
+
+See the [contributor's guide](contributing.md)
+
+{{#include ../README.md:footer}}

docs/maintenance.md

@@ -0,0 +1,66 @@
+# Maintaining your conduwuit setup
+
+## Moderation
+
+conduwuit has moderation through admin room commands. "binary commands" (medium priority) and an admin API (low priority) is planned. Some moderation-related config options are available in the example config such as "global ACLs" and blocking media requests to certain servers. See the example config for the moderation config options under the "Moderation / Privacy / Security" section.
+
+conduwuit has moderation admin commands for:
+
+- managing room aliases (`!admin rooms alias`)
+- managing room directory (`!admin rooms directory`)
+- managing room banning/blocking and user removal (`!admin rooms moderation`)
+- managing user accounts (`!admin users`)
+- fetching `/.well-known/matrix/support` from servers (`!admin federation`)
+- blocking incoming federation for certain rooms (not the same as room banning) (`!admin federation`)
+- deleting media (see [the media section](#media))
+
+Any commands with `-list` in them will require a codeblock in the message with each object being newline delimited. An example of doing this is:
+
+````
+!admin rooms moderation ban-list-of-rooms
+```
+!roomid1:server.name
+!roomid2:server.name
+!roomid3:server.name
+```
+````
+
+## Database
+
+If using RocksDB, there's very little you need to do. Compaction is ran automatically based on various defined thresholds tuned for conduwuit to be high performance with the least I/O amplifcation or overhead. Manually running compaction is not recommended, or compaction via a timer. RocksDB is built with io_uring support via liburing for async read I/O.
+
+Some RocksDB settings can be adjusted such as the compression method chosen. See the RocksDB section in the [example config](configuration/examples.md). btrfs users may benefit from disabling compression on RocksDB if CoW is in use.
+
+RocksDB troubleshooting can be found [in the RocksDB section of troubleshooting](troubleshooting.md).
+
+## Backups
+
+Currently only RocksDB supports online backups. If you'd like to backup your database online without any downtime, see the `!admin server` command for the backup commands and the `database_backup_path` config options in the example config. Please note that the format of the database backup is not the exact same. This is unfortunately a bad design choice by Facebook as we are using the database backup engine API from RocksDB, however the data is still there and can still be joined together.
+
+To restore a backup from an online RocksDB backup:
+
+- shutdown conduwuit
+- create a new directory for merging together the data
+- in the online backup created, copy all `.sst` files in `$DATABASE_BACKUP_PATH/shared_checksum` to your new directory
+- trim all the strings so instead of `######_sxxxxxxxxx.sst`, it reads `######.sst`. A way of doing this with sed and bash is `for file in *.sst; do mv "$file" "$(echo "$file" | sed 's/_s.*/.sst/')"; done`
+- copy all the files in `$DATABASE_BACKUP_PATH/1` (or the latest backup number if you have multiple) to your new directory
+- set your `database_path` config option to your new directory, or replace your old one with the new one you crafted
+- start up conduwuit again and it should open as normal
+
+If you'd like to do an offline backup, shutdown conduwuit and copy your `database_path` directory elsewhere. This can be restored with no modifications needed.
+
+Backing up media is also just copying the `media/` directory from your database directory.
+
+## Media
+
+Media still needs various work, however conduwuit implements media deletion via:
+
+- MXC URI or Event ID (unencrypted and attempts to find the MXC URI in the event)
+- Delete list of MXC URIs
+- Delete remote media in the past `N` seconds/minutes via filesystem metadata on the file created time (`btime`) or file modified time (`mtime`)
+
+See the `!admin media` command for further information. All media in conduwuit is stored at `$DATABASE_DIR/media`. This will be configurable soon.
+
+If you are finding yourself needing extensive granular control over media, we recommend looking into [Matrix Media Repo](https://github.com/t2bot/matrix-media-repo). conduwuit intends to implement various utilities for media, but MMR is dedicated to extensive media management.
+
+Built-in S3 support is also planned, but for now using a "S3 filesystem" on `media/` works. conduwuit also sends a `Cache-Control` header of 1 year and immutable for all media requests (download and thumbnail) to reduce unnecessary media requests from browsers, reduce bandwidth usage, and reduce load.

docs/troubleshooting.md

@@ -0,0 +1,61 @@
+# Troubleshooting conduwuit
+
+> ## Docker users ⚠️
+>
+> Docker is extremely UX unfriendly. Because of this, a ton of issues or support is actually Docker support, not conduwuit support. We also cannot document the ever-growing list of Docker issues here.
+>
+> If you intend on asking for support and you are using Docker, **PLEASE** triple validate your issues are **NOT** because you have a misconfiguration in your Docker setup.
+>
+> If there are things like Compose file issues or Dockerhub image issues, those can still be mentioned as long as they're something we can fix.
+
+## Rocksdb / database issues
+
+#### Direct IO
+
+Some filesystems may not like RocksDB using [Direct IO](https://github.com/facebook/rocksdb/wiki/Direct-IO). Direct IO is for non-buffered I/O which improves conduwuit performance, but at least FUSE is a filesystem potentially known to not like this. See the [example config](configuration/examples.md) for disabling it if needed. Issues from Direct IO on unsupported filesystems are usually shown as startup errors.
+
+#### Database corruption
+
+If your database is corrupted *and* is failing to start (e.g. checksum mismatch), it may be recoverable but careful steps must be taken, and there is no guarantee it may be recoverable.
+
+The first thing that can be done is launching conduwuit with the `rocksdb_repair` config option set to true. This will tell RocksDB to attempt to repair itself at launch. If this does not work, disable the option and continue reading.
+
+RocksDB has the following recovery modes:
+
+- `TolerateCorruptedTailRecords`
+- `AbsoluteConsistency`
+- `PointInTime`
+- `SkipAnyCorruptedRecord`
+
+By default, conduwuit uses `TolerateCorruptedTailRecords` as generally these may be due to bad federation and we can re-fetch the correct data over federation. The RocksDB default is `PointInTime` which will attempt to restore a "snapshot" of the data when it was last known to be good. This data can be either a few seconds old, or multiple minutes prior. `PointInTime` may not be suitable for default usage due to clients and servers possibly not being able to handle sudden "backwards time travels", and `AbsoluteConsistency` may be too strict.
+
+`AbsoluteConsistency` will fail to start the database if any sign of corruption is detected. `SkipAnyCorruptedRecord` will skip all forms of corruption unless it forbids the database from opening (e.g. too severe). Usage of `SkipAnyCorruptedRecord` voids any support as this may cause more damage and/or leave your database in a permanently inconsistent state, but it may do something if `PointInTime` does not work as a last ditch effort.
+
+With this in mind:
+
+- First start conduwuit with the `PointInTime` recovery method. See the [example config](configuration/examples.md) for how to do this using `rocksdb_recovery_mode`
+- If your database successfully opens, clients are recommended to clear their client cache to account for the rollback
+- Leave your conduwuit running in `PointInTime` for at least 30-60 minutes so as much possible corruption is restored
+- If all goes will, you should be able to restore back to using `TolerateCorruptedTailRecords` and you have successfully recovered your database
+
+## Media
+
+## Debugging
+
+Note that users should not really be debugging things. If you find yourself debugging and find the issue, please let us know and/or how we can fix it. Various debug commands can be found in `!admin debug`.
+
+#### Debug/Trace log level
+
+conduwuit builds without debug or trace log levels by default for at least performance reasons. This may change in the future and/or binaries providing such configurations may be provided. If you need to access debug/trace log levels, you will need to build without the `release_max_log_level` feature.
+
+#### Changing log level dynamically
+
+conduwuit supports changing the tracing log environment filter on-the-fly using the admin command `!admin debug change-log-level`. This accepts a string **without quotes** the same format as the `log` config option.
+
+#### Pinging servers
+
+conduwuit can ping other servers using `!admin debug ping`. This takes a server name and goes through the server discovery process and queries `/_matrix/federation/v1/version`. Errors are outputted.
+
+#### Allocator memory stats
+
+When using jemalloc with jemallocator's `stats` feature, you can see conduwuit's jemalloc memory stats by using `!admin debug memory-stats`

docs/turn.md

@@ -0,0 +1,44 @@
+# Setting up TURN/STURN
+
+In order to make or receive calls, a TURN server is required. conduwuit suggests using [Coturn](https://github.com/coturn/coturn) for this purpose, which is also available as a Docker image.
+
+### Configuration
+
+Create a configuration file called `coturn.conf` containing:
+
+```conf
+use-auth-secret
+static-auth-secret=<a secret key>
+realm=<your server domain>
+```
+
+A common way to generate a suitable alphanumeric secret key is by using `pwgen -s 64 1`.
+
+These same values need to be set in conduwuit. See the [example config](configuration/examples.md) in the TURN section for configuring these and restart conduwuit after.
+
+### Run
+
+Run the [Coturn](https://hub.docker.com/r/coturn/coturn) image using
+
+```bash
+docker run -d --network=host -v $(pwd)/coturn.conf:/etc/coturn/turnserver.conf coturn/coturn
+```
+
+or docker-compose. For the latter, paste the following section into a file called `docker-compose.yml`
+and run `docker compose up -d` in the same directory.
+
+```yml
+version: 3
+services:
+    turn:
+      container_name: coturn-server
+      image: docker.io/coturn/coturn
+      restart: unless-stopped
+      network_mode: "host"
+      volumes:
+        - ./coturn.conf:/etc/coturn/turnserver.conf
+```
+
+To understand why the host networking mode is used and explore alternative configuration options, please visit [Coturn's Docker documentation](https://github.com/coturn/coturn/blob/master/docker/coturn/README.md).
+
+For security recommendations see Synapse's [Coturn documentation](https://element-hq.github.io/synapse/latest/turn-howto.html).

engage.toml

@@ -40,6 +40,31 @@ name = "cargo-clippy"
 group = "versions"
 script = "cargo clippy -- --version"
 
+[[task]]
+name = "cargo-audit"
+group = "versions"
+script = "cargo audit --version"
+
+[[task]]
+name = "cargo-deb"
+group = "versions"
+script = "cargo deb --version"
+
+[[task]]
+name = "lychee"
+group = "versions"
+script = "lychee --version"
+
+[[task]]
+name = "markdownlint"
+group = "versions"
+script = "markdownlint --version"
+
+[[task]]
+name = "cargo-audit"
+group = "security"
+script = "cargo audit -D warnings -D unmaintained -D unsound -D yanked"
+
 [[task]]
 name = "cargo-fmt"
 group = "lints"
@@ -49,20 +74,97 @@ script = "cargo fmt --check -- --color=always"
 name = "cargo-doc"
 group = "lints"
 script = """
-RUSTDOCFLAGS="-D warnings" cargo doc \
-    --workspace \
-    --no-deps \
-    --document-private-items \
-    --color always
+env DIRENV_DEVSHELL=all-features \
+    RUSTDOCFLAGS="-D warnings" \
+    direnv exec . \
+    cargo doc \
+        --workspace \
+        --all-features \
+        --no-deps \
+        --document-private-items \
+        --color always
 """
 
 [[task]]
-name = "cargo-clippy"
+name = "clippy/default"
 group = "lints"
-script = "cargo clippy --workspace --all-targets --color=always -- -D warnings"
+script = """
+cargo clippy \
+    --workspace \
+    --all-targets \
+    --color=always \
+    -- \
+    -D warnings
+"""
 
 [[task]]
-name = "cargo"
+name = "clippy/all"
+group = "lints"
+script = """
+env DIRENV_DEVSHELL=all-features \
+    direnv exec . \
+    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 --verbose --offline docs *.md --exclude development.md"
+
+[[task]]
+name = "markdownlint"
+group = "lints"
+script = "markdownlint docs *.md || true" # TODO: fix the ton of markdown lints so we can drop `|| true`
+
+[[task]]
+name = "cargo/all"
+group = "tests"
+script = """
+env DIRENV_DEVSHELL=all-features \
+    direnv exec . \
+    cargo test \
+        --workspace \
+        --all-targets \
+        --all-features \
+        --color=always \
+        -- \
+        --color=always
+"""
+
+[[task]]
+name = "cargo/default"
 group = "tests"
 script = """
 cargo test \
@@ -73,7 +175,19 @@ 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 = "cargo-audit"
-group = "security"
-script = "cargo audit -D warnings -D unmaintained -D unsound -D yanked"
+name = "nix-default"
+group = "tests"
+script = """
+env DIRENV_DEVSHELL=dynamic \
+    direnv exec . \
+    bin/nix-build-and-cache just .#default
+env DIRENV_DEVSHELL=dynamic \
+    direnv exec . \
+    nix run -L .#default -- --help
+"""

flake.lock

@@ -9,11 +9,11 @@
         "nixpkgs-stable": "nixpkgs-stable"
       },
       "locked": {
-        "lastModified": 1707922053,
-        "narHash": "sha256-wSZjK+rOXn+UQiP1NbdNn5/UW6UcBxjvlqr2wh++MbM=",
+        "lastModified": 1720542474,
+        "narHash": "sha256-aKjJ/4l2I9+wNGTaOGRsuS3M1+IoTibqgEMPDikXm04=",
         "owner": "zhaofengli",
         "repo": "attic",
-        "rev": "6eabc3f02fae3683bffab483e614bebfcd476b21",
+        "rev": "6139576a3ce6bb992e0f6c3022528ec233e45f00",
         "type": "github"
       },
       "original": {
@@ -23,6 +23,78 @@
         "type": "github"
       }
     },
+    "cachix": {
+      "inputs": {
+        "devenv": "devenv",
+        "flake-compat": "flake-compat_3",
+        "nixpkgs": "nixpkgs_3",
+        "pre-commit-hooks": "pre-commit-hooks"
+      },
+      "locked": {
+        "lastModified": 1719923519,
+        "narHash": "sha256-7Rhljj2fsklFRsu+eq7N683Z9qukmreMEj5C1GqCrSA=",
+        "owner": "cachix",
+        "repo": "cachix",
+        "rev": "4e9e71f78b9500fa6210cf1eaa4d75bdbab777c3",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "ref": "master",
+        "repo": "cachix",
+        "type": "github"
+      }
+    },
+    "cachix_2": {
+      "inputs": {
+        "devenv": "devenv_2",
+        "flake-compat": [
+          "cachix",
+          "devenv",
+          "flake-compat"
+        ],
+        "nixpkgs": [
+          "cachix",
+          "devenv",
+          "nixpkgs"
+        ],
+        "pre-commit-hooks": [
+          "cachix",
+          "devenv",
+          "pre-commit-hooks"
+        ]
+      },
+      "locked": {
+        "lastModified": 1712055811,
+        "narHash": "sha256-7FcfMm5A/f02yyzuavJe06zLa9hcMHsagE28ADcmQvk=",
+        "owner": "cachix",
+        "repo": "cachix",
+        "rev": "02e38da89851ec7fec3356a5c04bc8349cae0e30",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "cachix",
+        "type": "github"
+      }
+    },
+    "complement": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1720637557,
+        "narHash": "sha256-oZz6nCmFmdJZpC+K1iOG2KkzTI6rlAmndxANPDVU7X0=",
+        "owner": "matrix-org",
+        "repo": "complement",
+        "rev": "0d14432e010482ea9e13a6f7c47c1533c0c9d62f",
+        "type": "github"
+      },
+      "original": {
+        "owner": "matrix-org",
+        "ref": "main",
+        "repo": "complement",
+        "type": "github"
+      }
+    },
     "crane": {
       "inputs": {
         "nixpkgs": [
@@ -31,11 +103,11 @@
         ]
       },
       "locked": {
-        "lastModified": 1702918879,
-        "narHash": "sha256-tWJqzajIvYcaRWxn+cLUB9L9Pv4dQ3Bfit/YjU5ze3g=",
+        "lastModified": 1717025063,
+        "narHash": "sha256-dIubLa56W9sNNz0e8jGxrX3CAkPXsq7snuFA/Ie6dn8=",
         "owner": "ipetkov",
         "repo": "crane",
-        "rev": "7195c00c272fdd92fc74e7d5a0a2844b9fadb2fb",
+        "rev": "480dff0be03dac0e51a8dfc26e882b0d123a450e",
         "type": "github"
       },
       "original": {
@@ -51,11 +123,11 @@
         ]
       },
       "locked": {
-        "lastModified": 1707685877,
-        "narHash": "sha256-XoXRS+5whotelr1rHiZle5t5hDg9kpguS5yk8c8qzOc=",
+        "lastModified": 1720546058,
+        "narHash": "sha256-iU2yVaPIZm5vMGdlT0+57vdB/aPq/V5oZFBRwYw+HBM=",
         "owner": "ipetkov",
         "repo": "crane",
-        "rev": "2c653e4478476a52c6aa3ac0495e4dea7449ea0e",
+        "rev": "2d83156f23c43598cf44e152c33a59d3892f8b29",
         "type": "github"
       },
       "original": {
@@ -65,6 +137,70 @@
         "type": "github"
       }
     },
+    "devenv": {
+      "inputs": {
+        "cachix": "cachix_2",
+        "flake-compat": [
+          "cachix",
+          "flake-compat"
+        ],
+        "nix": "nix_2",
+        "nixpkgs": [
+          "cachix",
+          "nixpkgs"
+        ],
+        "pre-commit-hooks": [
+          "cachix",
+          "pre-commit-hooks"
+        ]
+      },
+      "locked": {
+        "lastModified": 1719759336,
+        "narHash": "sha256-3a34VL/QnHprl5gMy9xlx6d8J+iNp+W88Ex8smkgH9M=",
+        "owner": "cachix",
+        "repo": "devenv",
+        "rev": "bb32aa986f2f695385e54428d0eaf7d05b31466e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "devenv",
+        "type": "github"
+      }
+    },
+    "devenv_2": {
+      "inputs": {
+        "flake-compat": [
+          "cachix",
+          "devenv",
+          "cachix",
+          "flake-compat"
+        ],
+        "nix": "nix",
+        "nixpkgs": "nixpkgs_2",
+        "poetry2nix": "poetry2nix",
+        "pre-commit-hooks": [
+          "cachix",
+          "devenv",
+          "cachix",
+          "pre-commit-hooks"
+        ]
+      },
+      "locked": {
+        "lastModified": 1708704632,
+        "narHash": "sha256-w+dOIW60FKMaHI1q5714CSibk99JfYxm0CzTinYWr+Q=",
+        "owner": "cachix",
+        "repo": "devenv",
+        "rev": "2ee4450b0f4b95a1b90f2eb5ffea98b90e48c196",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "ref": "python-rewrite",
+        "repo": "devenv",
+        "type": "github"
+      }
+    },
     "fenix": {
       "inputs": {
         "nixpkgs": [
@@ -73,15 +209,16 @@
         "rust-analyzer-src": "rust-analyzer-src"
       },
       "locked": {
-        "lastModified": 1707891749,
-        "narHash": "sha256-SeikNYElHgv8uVMbiA9/pU3Cce7ssIsiM8CnEiwd1Nc=",
+        "lastModified": 1720852044,
+        "narHash": "sha256-3NBYz8VuXuKU+8ONd9NFafCNjPEGHIZQ2Mdoam1a4mY=",
         "owner": "nix-community",
         "repo": "fenix",
-        "rev": "3115aab064ef38cccd792c45429af8df43d6d277",
+        "rev": "5087b12a595ee73131a944d922f24d81dae05725",
         "type": "github"
       },
       "original": {
         "owner": "nix-community",
+        "ref": "main",
         "repo": "fenix",
         "type": "github"
       }
@@ -103,6 +240,22 @@
       }
     },
     "flake-compat_2": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1673956053,
+        "narHash": "sha256-4gtG9iQuiKITOjNQQeQIpoIB6b16fm+504Ch3sNKLd8=",
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "35bb57c0c8d8b62bbfd284272c928ceb64ddbde9",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "flake-compat_3": {
       "flake": false,
       "locked": {
         "lastModified": 1696426674,
@@ -118,6 +271,39 @@
         "type": "github"
       }
     },
+    "flake-compat_4": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1696426674,
+        "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=",
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "flake-compat_5": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1696426674,
+        "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=",
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "ref": "master",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
     "flake-utils": {
       "locked": {
         "lastModified": 1667395993,
@@ -138,11 +324,11 @@
         "systems": "systems"
       },
       "locked": {
-        "lastModified": 1705309234,
-        "narHash": "sha256-uNRRNRKmJyCRC/8y1RqBkqWBLM034y4qN7EprSdmgyA=",
+        "lastModified": 1689068808,
+        "narHash": "sha256-6ixXo3wt24N/melDWjq70UuHQLxGV8jZvooRanIHXw0=",
         "owner": "numtide",
         "repo": "flake-utils",
-        "rev": "1ef2e671c3b0c19053962c07dbda38332dcebf26",
+        "rev": "919d646de7be200f3bf08cb76ae1f09402b6f9b4",
         "type": "github"
       },
       "original": {
@@ -151,28 +337,168 @@
         "type": "github"
       }
     },
+    "flake-utils_3": {
+      "inputs": {
+        "systems": "systems_2"
+      },
+      "locked": {
+        "lastModified": 1710146030,
+        "narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "b1d9ab70662946ef0850d488da1c9019f3a9752a",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "ref": "main",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "gitignore": {
+      "inputs": {
+        "nixpkgs": [
+          "cachix",
+          "pre-commit-hooks",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1709087332,
+        "narHash": "sha256-HG2cCnktfHsKV0s4XW83gU3F57gaTljL9KNSuG6bnQs=",
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "rev": "637db329424fd7e46cf4185293b9cc8c88c95394",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "type": "github"
+      }
+    },
+    "liburing": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1720798442,
+        "narHash": "sha256-gtPppAoksMLW4GuruQ36nf4EAqIA1Bs6V9Xcx8dBxrQ=",
+        "owner": "axboe",
+        "repo": "liburing",
+        "rev": "1d674f83b7d0f07553ac44d99a401b05853d9dbe",
+        "type": "github"
+      },
+      "original": {
+        "owner": "axboe",
+        "ref": "master",
+        "repo": "liburing",
+        "type": "github"
+      }
+    },
+    "nix": {
+      "inputs": {
+        "flake-compat": "flake-compat_2",
+        "nixpkgs": [
+          "cachix",
+          "devenv",
+          "cachix",
+          "devenv",
+          "nixpkgs"
+        ],
+        "nixpkgs-regression": "nixpkgs-regression"
+      },
+      "locked": {
+        "lastModified": 1712911606,
+        "narHash": "sha256-BGvBhepCufsjcUkXnEEXhEVjwdJAwPglCC2+bInc794=",
+        "owner": "domenkozar",
+        "repo": "nix",
+        "rev": "b24a9318ea3f3600c1e24b4a00691ee912d4de12",
+        "type": "github"
+      },
+      "original": {
+        "owner": "domenkozar",
+        "ref": "devenv-2.21",
+        "repo": "nix",
+        "type": "github"
+      }
+    },
     "nix-filter": {
       "locked": {
-        "lastModified": 1705332318,
-        "narHash": "sha256-kcw1yFeJe9N4PjQji9ZeX47jg0p9A0DuU4djKvg1a7I=",
+        "lastModified": 1710156097,
+        "narHash": "sha256-1Wvk8UP7PXdf8bCCaEoMnOT1qe5/Duqgj+rL8sRQsSM=",
         "owner": "numtide",
         "repo": "nix-filter",
-        "rev": "3449dc925982ad46246cfc36469baf66e1b64f17",
+        "rev": "3342559a24e85fc164b295c3444e8a139924675b",
         "type": "github"
       },
       "original": {
         "owner": "numtide",
+        "ref": "main",
         "repo": "nix-filter",
         "type": "github"
       }
     },
+    "nix-github-actions": {
+      "inputs": {
+        "nixpkgs": [
+          "cachix",
+          "devenv",
+          "cachix",
+          "devenv",
+          "poetry2nix",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1688870561,
+        "narHash": "sha256-4UYkifnPEw1nAzqqPOTL2MvWtm3sNGw1UTYTalkTcGY=",
+        "owner": "nix-community",
+        "repo": "nix-github-actions",
+        "rev": "165b1650b753316aa7f1787f3005a8d2da0f5301",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-community",
+        "repo": "nix-github-actions",
+        "type": "github"
+      }
+    },
+    "nix_2": {
+      "inputs": {
+        "flake-compat": [
+          "cachix",
+          "devenv",
+          "flake-compat"
+        ],
+        "nixpkgs": [
+          "cachix",
+          "devenv",
+          "nixpkgs"
+        ],
+        "nixpkgs-regression": "nixpkgs-regression_2"
+      },
+      "locked": {
+        "lastModified": 1712911606,
+        "narHash": "sha256-BGvBhepCufsjcUkXnEEXhEVjwdJAwPglCC2+bInc794=",
+        "owner": "domenkozar",
+        "repo": "nix",
+        "rev": "b24a9318ea3f3600c1e24b4a00691ee912d4de12",
+        "type": "github"
+      },
+      "original": {
+        "owner": "domenkozar",
+        "ref": "devenv-2.21",
+        "repo": "nix",
+        "type": "github"
+      }
+    },
     "nixpkgs": {
       "locked": {
-        "lastModified": 1702539185,
-        "narHash": "sha256-KnIRG5NMdLIpEkZTnN5zovNYc0hhXjAgv6pfd5Z4c7U=",
+        "lastModified": 1711401922,
+        "narHash": "sha256-QoQqXoj8ClGo0sqD/qWKFWezgEwUL0SUh37/vY2jNhc=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "aa9d4729cbc99dabacb50e3994dcefb3ea0f7447",
+        "rev": "07262b18b97000d16a4bdb003418bd2fb067a932",
         "type": "github"
       },
       "original": {
@@ -182,13 +508,61 @@
         "type": "github"
       }
     },
-    "nixpkgs-stable": {
+    "nixpkgs-regression": {
       "locked": {
-        "lastModified": 1702780907,
-        "narHash": "sha256-blbrBBXjjZt6OKTcYX1jpe9SRof2P9ZYWPzq22tzXAA=",
+        "lastModified": 1643052045,
+        "narHash": "sha256-uGJ0VXIhWKGXxkeNnq4TvV3CIOkUJ3PAoLZ3HMzNVMw=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "1e2e384c5b7c50dbf8e9c441a9e58d85f408b01f",
+        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
+        "type": "github"
+      }
+    },
+    "nixpkgs-regression_2": {
+      "locked": {
+        "lastModified": 1643052045,
+        "narHash": "sha256-uGJ0VXIhWKGXxkeNnq4TvV3CIOkUJ3PAoLZ3HMzNVMw=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
+        "type": "github"
+      }
+    },
+    "nixpkgs-stable": {
+      "locked": {
+        "lastModified": 1711460390,
+        "narHash": "sha256-akSgjDZL6pVHEfSE6sz1DNSXuYX6hq+P/1Z5IoYWs7E=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "44733514b72e732bd49f5511bd0203dea9b9a434",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-23.11",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs-stable_2": {
+      "locked": {
+        "lastModified": 1718811006,
+        "narHash": "sha256-0Y8IrGhRmBmT7HHXlxxepg2t8j1X90++qRN3lukGaIk=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "03d771e513ce90147b65fe922d87d3a0356fc125",
         "type": "github"
       },
       "original": {
@@ -200,11 +574,27 @@
     },
     "nixpkgs_2": {
       "locked": {
-        "lastModified": 1707689078,
-        "narHash": "sha256-UUGmRa84ZJHpGZ1WZEBEUOzaPOWG8LZ0yPg1pdDF/yM=",
+        "lastModified": 1692808169,
+        "narHash": "sha256-x9Opq06rIiwdwGeK2Ykj69dNc2IvUH1fY55Wm7atwrE=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "f9d39fb9aff0efee4a3d5f4a6d7c17701d38a1d8",
+        "rev": "9201b5ff357e781bf014d0330d18555695df7ba8",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs_3": {
+      "locked": {
+        "lastModified": 1719848872,
+        "narHash": "sha256-H3+EC5cYuq+gQW8y0lSrrDZfH71LB4DAf+TDFyvwCNA=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "00d80d13810dbfea8ab4ed1009b09100cca86ba8",
         "type": "github"
       },
       "original": {
@@ -214,25 +604,112 @@
         "type": "github"
       }
     },
+    "nixpkgs_4": {
+      "locked": {
+        "lastModified": 1720768451,
+        "narHash": "sha256-EYekUHJE2gxeo2pM/zM9Wlqw1Uw2XTJXOSAO79ksc4Y=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "7e7c39ea35c5cdd002cd4588b03a3fb9ece6fad9",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "poetry2nix": {
+      "inputs": {
+        "flake-utils": "flake-utils_2",
+        "nix-github-actions": "nix-github-actions",
+        "nixpkgs": [
+          "cachix",
+          "devenv",
+          "cachix",
+          "devenv",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1692876271,
+        "narHash": "sha256-IXfZEkI0Mal5y1jr6IRWMqK8GW2/f28xJenZIPQqkY0=",
+        "owner": "nix-community",
+        "repo": "poetry2nix",
+        "rev": "d5006be9c2c2417dafb2e2e5034d83fabd207ee3",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-community",
+        "repo": "poetry2nix",
+        "type": "github"
+      }
+    },
+    "pre-commit-hooks": {
+      "inputs": {
+        "flake-compat": "flake-compat_4",
+        "gitignore": "gitignore",
+        "nixpkgs": [
+          "cachix",
+          "nixpkgs"
+        ],
+        "nixpkgs-stable": "nixpkgs-stable_2"
+      },
+      "locked": {
+        "lastModified": 1719259945,
+        "narHash": "sha256-F1h+XIsGKT9TkGO3omxDLEb/9jOOsI6NnzsXFsZhry4=",
+        "owner": "cachix",
+        "repo": "pre-commit-hooks.nix",
+        "rev": "0ff4381bbb8f7a52ca4a851660fc7a437a4c6e07",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "pre-commit-hooks.nix",
+        "type": "github"
+      }
+    },
+    "rocksdb": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1720900786,
+        "narHash": "sha256-Vta9Um/RRuWwZ46BjXftV06iWLm/j/9MX39emXUvSAY=",
+        "owner": "girlbossceo",
+        "repo": "rocksdb",
+        "rev": "911f4243e69c2e320a7a209bf1f5f3ff5f825495",
+        "type": "github"
+      },
+      "original": {
+        "owner": "girlbossceo",
+        "ref": "v9.4.0",
+        "repo": "rocksdb",
+        "type": "github"
+      }
+    },
     "root": {
       "inputs": {
         "attic": "attic",
+        "cachix": "cachix",
+        "complement": "complement",
         "crane": "crane_2",
         "fenix": "fenix",
-        "flake-compat": "flake-compat_2",
-        "flake-utils": "flake-utils_2",
+        "flake-compat": "flake-compat_5",
+        "flake-utils": "flake-utils_3",
+        "liburing": "liburing",
         "nix-filter": "nix-filter",
-        "nixpkgs": "nixpkgs_2"
+        "nixpkgs": "nixpkgs_4",
+        "rocksdb": "rocksdb"
       }
     },
     "rust-analyzer-src": {
       "flake": false,
       "locked": {
-        "lastModified": 1707849817,
-        "narHash": "sha256-If6T0MDErp3/z7DBlpG4bV46IPP+7BWSlgTI88cmbw0=",
+        "lastModified": 1720717809,
+        "narHash": "sha256-6I+fm+nTLF/iaj7ffiFGlSY7POmubwUaPA/Wq0Bm53M=",
         "owner": "rust-lang",
         "repo": "rust-analyzer",
-        "rev": "a02a219773629686bd8ff123ca1aa995fa50d976",
+        "rev": "ffbc5ad993d5cd2f3b8bcf9a511165470944ab91",
         "type": "github"
       },
       "original": {
@@ -256,6 +733,21 @@
         "repo": "default",
         "type": "github"
       }
+    },
+    "systems_2": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
     }
   },
   "root": "root",

flake.nix

@@ -1,203 +1,182 @@
 {
   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 = {
-      url = "github:ipetkov/crane?ref=master";
-      inputs.nixpkgs.follows = "nixpkgs";
-    };
     attic.url = "github:zhaofengli/attic?ref=main";
+    cachix.url = "github:cachix/cachix?ref=master";
+    complement = { url = "github:matrix-org/complement?ref=main"; flake = false; };
+    crane = { url = "github:ipetkov/crane?ref=master"; inputs.nixpkgs.follows = "nixpkgs"; };
+    fenix = { url = "github:nix-community/fenix?ref=main"; inputs.nixpkgs.follows = "nixpkgs"; };
+    flake-compat = { url = "github:edolstra/flake-compat?ref=master"; flake = false; };
+    flake-utils.url = "github:numtide/flake-utils?ref=main";
+    nix-filter.url = "github:numtide/nix-filter?ref=main";
+    nixpkgs.url = "github:NixOS/nixpkgs?ref=nixos-unstable";
+    rocksdb = { url = "github:girlbossceo/rocksdb?ref=v9.4.0"; 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};
-
-      rocksdb' = pkgs: pkgs.rocksdb.overrideAttrs (old:
-              {
-                src = pkgs.fetchFromGitHub {
-                  owner = "facebook";
-                  repo = "rocksdb";
-                  rev = "v8.10.0";
-                  hash = "sha256-KGsYDBc1fz/90YYNGwlZ0LUKXYsP1zyhP29TnRQwgjQ=";
-                };
-              });
-
-      # 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;
+          # we have this already at https://github.com/girlbossceo/rocksdb/commit/a935c0273e1ba44eacf88ce3685a9b9831486155
+          # unsetting this so i don't have to revert it and make this nix exclusive
+          patches = [];
+          cmakeFlags = pkgs.lib.subtractLists
+            [
+              # no real reason to have snappy, no one uses this
+              "-DWITH_SNAPPY=1"
+              # we dont need to use ldb or sst_dump (core_tools)
+              "-DWITH_CORE_TOOLS=1"
+              # we dont need to build rocksdb tests
+              "-DWITH_TESTS=1"
+              # we use rust-rocksdb via C interface and dont need C++ RTTI
+              "-DUSE_RTTI=1"
+            ]
+            old.cmakeFlags
+            ++ [
+              # we dont need to use ldb or sst_dump (core_tools)
+              "-DWITH_CORE_TOOLS=0"
+              # we dont need trace tools
+              "-DWITH_TRACE_TOOLS=0"
+              # we dont need to build rocksdb tests
+              "-DWITH_TESTS=0"
+              # we use rust-rocksdb via C interface and dont need C++ RTTI
+              "-DUSE_RTTI=0"
+            ];
 
-      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.buildPackages.rustPlatform.bindgenHook
-      ];
+          # outputs has "tools" which we dont need or use
+          outputs = [ "out" ];
 
-      env = pkgs: {
-        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.
-              #
-              # [0]: https://github.com/NixOS/nixpkgs/blob/612f97239e2cc474c13c9dafa0df378058c5ad8d/pkgs/build-support/rust/lib/default.nix#L36-L39
-              (
-                # 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"
-              ]
-          );
-      }
+          # preInstall hooks has stuff for messing with ldb/sst_dump which we dont need or use
+          preInstall = "";
+        });
+        # 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;
+        });
+      });
 
-      # 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/612f97239e2cc474c13c9dafa0df378058c5ad8d/pkgs/build-support/rust/lib/default.nix#L64-L78
-      // (
-        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;
-            }
-          )
-      // (
-        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.buildPackages.stdenv.cc}/bin/cc";
-          HOST_CXX = "${pkgs.buildPackages.stdenv.cc}/bin/c++";
-        }
-      ));
+      scopeHost = mkScope pkgsHost;
+      scopeHostStatic = mkScope pkgsHostStatic;
 
-      package = pkgs: builder pkgs {
-        src = nix-filter {
-          root = ./.;
-          include = [
-            "src"
-            "Cargo.toml"
-            "Cargo.lock"
-          ];
+      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";
         };
 
-        # This is redundant with CI
-        doCheck = false;
+        # Development tools
+        packages = [
+          # Always use nightly rustfmt because most of its options are unstable
+          #
+          # This needs to come before `toolchain` in this list, otherwise
+          # `$PATH` will have stable rustfmt instead.
+          inputs.fenix.packages.${system}.latest.rustfmt
 
-        env = env pkgs;
-        nativeBuildInputs = nativeBuildInputs pkgs;
+          toolchain
+        ]
+        ++ (with pkgsHost.pkgs; [
+          engage
+          cargo-audit
 
-        meta.mainProgram = cargoToml.package.name;
+          # Needed for producing Debian packages
+          cargo-deb
+
+          # Needed for Complement
+          go
+
+          # Needed for our script for Complement
+          jq
+
+          # Needed for finding broken markdown links
+          lychee
+
+          # Needed for linting markdown files
+          markdownlint-cli
+
+          # Useful for editing the book locally
+          mdbook
+        ])
+        ++ scope.main.buildInputs
+        ++ scope.main.propagatedBuildInputs
+        ++ scope.main.nativeBuildInputs;
+
+        meta.broken = scope.main.meta.broken;
       };
-
-      mkOciImage = pkgs: package:
-        pkgs.dockerTools.buildImage {
-          name = package.pname;
-          tag = "main";
-          copyToRoot = [
-            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 = package pkgsHost;
-        oci-image = mkOciImage pkgsHost self.packages.${system}.default;
+        default = scopeHost.main;
+        all-features = scopeHost.main.override {
+            all_features = true;
+            disable_features = [
+                # this is non-functional on nix for some reason
+                "hardened_malloc"
+                # dont include experimental features
+                "experimental"
+            ];
+        };
+        hmalloc = scopeHost.main.override { features = ["hardened_malloc"]; };
+
+        oci-image = scopeHost.oci-image;
+        oci-image-all-features = scopeHost.oci-image.override {
+          main = scopeHost.main.override {
+            all_features = true;
+            disable_features = [
+                # this is non-functional on nix for some reason
+                "hardened_malloc"
+                # dont include experimental features
+                "experimental"
+            ];
+          };
+        };
+        oci-image-hmalloc = scopeHost.oci-image.override {
+          main = scopeHost.main.override {
+            features = ["hardened_malloc"];
+          };
+        };
+
+        book = scopeHost.book;
+
+        complement = scopeHost.complement;
+        static-complement = scopeHostStatic.complement;
       }
       //
       builtins.listToAttrs
@@ -207,26 +186,73 @@
               let
                 binaryName = "static-${crossSystem}";
                 pkgsCrossStatic =
-                  (import nixpkgs {
+                  (import inputs.nixpkgs {
                     inherit system;
                     crossSystem = {
                       config = crossSystem;
                     };
                   }).pkgsStatic;
+                scopeCrossStatic = mkScope pkgsCrossStatic;
               in
               [
                 # An output for a statically-linked binary
                 {
                   name = binaryName;
-                  value = package pkgsCrossStatic;
+                  value = scopeCrossStatic.main;
+                }
+
+                # An output for a statically-linked binary with `--all-features`
+                {
+                  name = "${binaryName}-all-features";
+                  value = scopeCrossStatic.main.override {
+                    all_features = true;
+                    disable_features = [
+                        # this is non-functional on nix for some reason
+                        "hardened_malloc"
+                        # dont include experimental features
+                        "experimental"
+                    ];
+                  };
+                }
+
+                # An output for a statically-linked 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 = mkOciImage
-                    pkgsCrossStatic
-                    self.packages.${system}.${binaryName};
+                  value = scopeCrossStatic.oci-image;
+                }
+
+                # An output for an OCI image based on that binary with `--all-features`
+                {
+                  name = "oci-image-${crossSystem}-all-features";
+                  value = scopeCrossStatic.oci-image.override {
+                    main = scopeCrossStatic.main.override {
+                      all_features = true;
+                      disable_features = [
+                          # this is non-functional on nix for some reason
+                          "hardened_malloc"
+                          # dont include experimental features
+                          "experimental"
+                      ];
+                    };
+                  };
+                }
+
+                # An output for an OCI image based on that binary with hardened_malloc
+                {
+                  name = "oci-image-${crossSystem}-hmalloc";
+                  value = scopeCrossStatic.oci-image.override {
+                    main = scopeCrossStatic.main.override {
+                      features = ["hardened_malloc"];
+                    };
+                  };
                 }
               ]
             )
@@ -237,33 +263,23 @@
           )
         );
 
-      devShells.default = pkgsHost.mkShell {
-        env = env pkgsHost // {
-          # 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";
+      devShells.default = mkDevShell scopeHostStatic;
+      devShells.all-features = mkDevShell
+        (scopeHostStatic.overrideScope (final: prev: {
+          main = prev.main.override {
+            all_features = true;
+            disable_features = [
+                # this is non-functional on nix for some reason
+                "hardened_malloc"
+                # dont include experimental features
+                "experimental"
+            ];
         };
-
-        # Development tools
-        nativeBuildInputs = nativeBuildInputs pkgsHost ++ [
-          # 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
-
-          toolchain
-        ] ++ (with pkgsHost; [
-          engage
-
-          # Needed for Complement
-          go
-          olm
-
-          # Needed for our script for Complement
-          jq
-        ]);
-      };
+        }));
+      devShells.no-features = mkDevShell
+        (scopeHostStatic.overrideScope (final: prev: {
+          main = prev.main.override { default_features = false; };
+        }));
+      devShells.dynamic = mkDevShell scopeHost;
     });
 }

nix/README.md

@@ -1,198 +0,0 @@
-# Conduit for Nix/NixOS
-
-This guide assumes you have a recent version of Nix (^2.4) installed.
-
-Since Conduit ships as a Nix flake, you'll first need to [enable
-flakes][enable_flakes].
-
-You can now use the usual Nix commands to interact with Conduit's flake. For
-example, `nix run gitlab:famedly/conduit` will run Conduit (though you'll need
-to provide configuration and such manually as usual).
-
-If your NixOS configuration is defined as a flake, you can depend on this flake
-to provide a more up-to-date version than provided by `nixpkgs`. In your flake,
-add the following to your `inputs`:
-
-```nix
-conduit = {
-    url = "gitlab:famedly/conduit";
-
-    # Assuming you have an input for nixpkgs called `nixpkgs`. If you experience
-    # build failures while using this, try commenting/deleting this line. This
-    # will probably also require you to always build from source.
-    inputs.nixpkgs.follows = "nixpkgs";
-};
-```
-
-Next, make sure you're passing your flake inputs to the `specialArgs` argument
-of `nixpkgs.lib.nixosSystem` [as explained here][specialargs]. This guide will
-assume you've named the group `flake-inputs`.
-
-Now you can configure Conduit and a reverse proxy for it. Add the following to
-a new Nix file and include it in your configuration:
-
-```nix
-{ config
-, pkgs
-, flake-inputs
-, ...
-}:
-
-let
-  # You'll need to edit these values
-
-  # The hostname that will appear in your user and room IDs
-  server_name = "example.com";
-
-  # The hostname that Conduit actually runs on
-  #
-  # This can be the same as `server_name` if you want. This is only necessary
-  # when Conduit is running on a different machine than the one hosting your
-  # root domain. This configuration also assumes this is all running on a single
-  # machine, some tweaks will need to be made if this is not the case.
-  matrix_hostname = "matrix.${server_name}";
-
-  # An admin email for TLS certificate notifications
-  admin_email = "admin@${server_name}";
-
-  # These ones you can leave alone
-
-  # Build a dervation that stores the content of `${server_name}/.well-known/matrix/server`
-  well_known_server = pkgs.writeText "well-known-matrix-server" ''
-    {
-      "m.server": "${matrix_hostname}"
-    }
-  '';
-
-  # Build a dervation that stores the content of `${server_name}/.well-known/matrix/client`
-  well_known_client = pkgs.writeText "well-known-matrix-client" ''
-    {
-      "m.homeserver": {
-        "base_url": "https://${matrix_hostname}"
-      }
-    }
-  '';
-in
-
-{
-  # Configure Conduit itself
-  services.matrix-conduit = {
-    enable = true;
-
-    # This causes NixOS to use the flake defined in this repository instead of
-    # the build of Conduit built into nixpkgs.
-    package = flake-inputs.conduit.packages.${pkgs.system}.default;
-
-    settings.global = {
-      inherit server_name;
-    };
-  };
-
-  # Configure automated TLS acquisition/renewal
-  security.acme = {
-    acceptTerms = true;
-    defaults = {
-      email = admin_email;
-    };
-  };
-
-  # ACME data must be readable by the NGINX user
-  users.users.nginx.extraGroups = [
-    "acme"
-  ];
-
-  # Configure NGINX as a reverse proxy
-  services.nginx = {
-    enable = true;
-    recommendedProxySettings = true;
-
-    virtualHosts = {
-      "${matrix_hostname}" = {
-        forceSSL = true;
-        enableACME = true;
-
-        listen = [
-          {
-            addr = "0.0.0.0";
-            port = 443;
-            ssl = true;
-          }
-          {
-            addr = "[::]";
-            port = 443;
-            ssl = true;
-          }          {
-            addr = "0.0.0.0";
-            port = 8448;
-            ssl = true;
-          }
-          {
-            addr = "[::]";
-            port = 8448;
-            ssl = true;
-          }
-        ];
-
-        locations."/_matrix/" = {
-          proxyPass = "http://backend_conduit$request_uri";
-          proxyWebsockets = true;
-          extraConfig = ''
-            proxy_set_header Host $host;
-            proxy_buffering off;
-          '';
-        };
-
-        extraConfig = ''
-          merge_slashes off;
-        '';
-      };
-
-      "${server_name}" = {
-        forceSSL = true;
-        enableACME = true;
-
-        locations."=/.well-known/matrix/server" = {
-          # Use the contents of the derivation built previously
-          alias = "${well_known_server}";
-
-          extraConfig = ''
-            # Set the header since by default NGINX thinks it's just bytes
-            default_type application/json;
-          '';
-        };
-
-        locations."=/.well-known/matrix/client" = {
-          # Use the contents of the derivation built previously
-          alias = "${well_known_client}";
-
-          extraConfig = ''
-            # Set the header since by default NGINX thinks it's just bytes
-            default_type application/json;
-
-            # https://matrix.org/docs/spec/client_server/r0.4.0#web-browser-clients
-            add_header Access-Control-Allow-Origin "*";
-          '';
-        };
-      };
-    };
-
-    upstreams = {
-      "backend_conduit" = {
-        servers = {
-          "[::1]:${toString config.services.matrix-conduit.settings.global.port}" = { };
-        };
-      };
-    };
-  };
-
-  # Open firewall ports for HTTP, HTTPS, and Matrix federation
-  networking.firewall.allowedTCPPorts = [ 80 443 8448 ];
-  networking.firewall.allowedUDPPorts = [ 80 443 8448 ];
-}
-```
-
-Now you can rebuild your system configuration and you should be good to go!
-
-[enable_flakes]: https://nixos.wiki/wiki/Flakes#Enable_flakes
-
-[specialargs]: https://nixos.wiki/wiki/Flakes#Using_nix_flakes_with_NixOS

nix/pkgs/book/default.nix

@@ -0,0 +1,34 @@
+{ 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"
+      "arch/conduwuit.service"
+      "docs"
+      "theme"
+    ];
+  };
+
+  nativeBuildInputs = [
+    mdbook
+  ];
+
+  buildPhase = ''
+    mdbook build -d $out
+  '';
+}

nix/pkgs/complement/config.toml

@@ -0,0 +1,23 @@
+[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
+database_path = "/database"
+log = "trace,h2=warn,hyper=warn"
+port = [8008, 8448]
+trusted_servers = []
+query_trusted_key_servers_first = false
+yes_i_am_very_very_sure_i_want_an_open_registration_server_prone_to_abuse = true
+ip_range_denylist = []
+url_preview_domain_contains_allowlist = ["*"]
+media_compat_file_link = false
+media_statup_check = false
+rocksdb_direct_io = false
+
+[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,106 @@
+{ lib
+, pkgsBuildHost
+, rust
+, stdenv
+}:
+
+lib.optionalAttrs stdenv.hostPlatform.isStatic {
+  ROCKSDB_STATIC = "";
+}
+//
+{
+  CARGO_BUILD_RUSTFLAGS =
+    lib.concatStringsSep
+      " "
+      ([]
+        ++ lib.optionals
+          stdenv.targetPlatform.isx86_64
+          [ "-C" "target-cpu=x86-64-v2" ]
+        ++ lib.optionals
+          stdenv.targetPlatform.isAarch64
+          [ "-C" "target-cpu=cortex-a55" ] # cortex-a55 == ARMv8.2-a
+        # 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,201 @@
+# Dependencies (keep sorted)
+{ craneLib
+, inputs
+, jq
+, lib
+, libiconv
+, liburing
+, pkgsBuildHost
+, rocksdb
+, rust
+, rust-jemalloc-sys
+, stdenv
+
+# Options (keep sorted)
+, default_features ? true
+, disable_release_max_log_level ? false
+, all_features ? false
+, disable_features ? []
+, features ? []
+, profile ? "release"
+}:
+
+let
+# We perform default-feature unification in nix, because some of the dependencies
+# on the nix side depend on feature values.
+crateFeatures = path:
+  let manifest = lib.importTOML "${path}/Cargo.toml"; in
+  lib.remove "default" (lib.attrNames manifest.features);
+crateDefaultFeatures = path:
+  (lib.importTOML "${path}/Cargo.toml").features.default;
+allDefaultFeatures = crateDefaultFeatures "${inputs.self}/src/main";
+allFeatures = crateFeatures "${inputs.self}/src/main";
+features' = lib.unique
+  (features ++
+    lib.optionals default_features allDefaultFeatures ++
+    lib.optionals all_features allFeatures);
+disable_features' = disable_features ++ lib.optionals disable_release_max_log_level ["release_max_log_level"];
+features'' = lib.subtractLists disable_features' features';
+
+featureEnabled = feature : builtins.elem feature features'';
+
+enableLiburing = featureEnabled "io_uring" && !stdenv.isDarwin;
+
+# This derivation will set the JEMALLOC_OVERRIDE variable, causing the
+# tikv-jemalloc-sys crate to use the nixpkgs jemalloc instead of building it's
+# own. In order for this to work, we need to set flags on the build that match
+# whatever flags tikv-jemalloc-sys was going to use. These are dependent on
+# which features we enable in tikv-jemalloc-sys.
+rust-jemalloc-sys' = (rust-jemalloc-sys.override {
+  # tikv-jemalloc-sys/unprefixed_malloc_on_supported_platforms feature
+  unprefixed = true;
+}).overrideAttrs (old: {
+  configureFlags = old.configureFlags ++
+    # 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;
+
+      # for some reason enableLiburing in nixpkgs rocksdb is default true
+      # which breaks Darwin entirely
+      enableLiburing = enableLiburing;
+    }).overrideAttrs (old: {
+      # TODO: static rocksdb fails to build on darwin, also see <https://github.com/NixOS/nixpkgs/issues/320448>
+      # build log at <https://girlboss.ceo/~strawberry/pb/JjGH>
+      meta.broken = stdenv.hostPlatform.isStatic && stdenv.isDarwin;
+
+      enableLiburing = enableLiburing;
+
+      sse42Support = stdenv.targetPlatform.isx86_64;
+
+      cmakeFlags = if stdenv.targetPlatform.isx86_64
+        then lib.subtractLists [ "-DPORTABLE=1" ] old.cmakeFlags
+        ++ lib.optionals stdenv.targetPlatform.isx86_64 [
+          "-DPORTABLE=x86-64-v2"
+          "-DUSE_SSE=1"
+          "-DHAVE_SSE=1"
+          "-DHAVE_SSE42=1"
+        ]
+        else if stdenv.targetPlatform.isAarch64
+        then lib.subtractLists [ "-DPORTABLE=1" ] old.cmakeFlags
+        ++ lib.optionals stdenv.targetPlatform.isAarch64 [
+          # cortex-a55 == ARMv8.2-a
+          "-DPORTABLE=armv8.2-a"
+        ]
+        else old.cmakeFlags;
+    });
+  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"
+    + lib.optionalString stdenv.targetPlatform.isx86_64
+      " -Ctarget-cpu=x86-64-v2"
+    + lib.optionalString stdenv.targetPlatform.isAarch64
+      " -Ctarget-cpu=cortex-a55"; # cortex-a55 == ARMv8.2-a
+};
+
+
+
+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"
+      ];
+    };
+
+    dontStrip = profile == "dev";
+
+    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

@@ -3,6 +3,7 @@
 # Other files that need upkeep when this changes:
 #
 # * `.gitlab-ci.yml`
+# * `.github/workflows/ci.yml`
 # * `Cargo.toml`
 # * `flake.nix`
 #
@@ -10,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",
@@ -19,4 +20,4 @@ targets = [
     "x86_64-unknown-linux-gnu",
     "x86_64-unknown-linux-musl",
     "aarch64-unknown-linux-musl",
-]
+]

rustfmt.toml

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

src/admin/Cargo.toml

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

src/admin/appservice/commands.rs

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

src/admin/appservice/mod.rs

@@ -0,0 +1,52 @@
+mod commands;
+
+use clap::Subcommand;
+use conduit::Result;
+use ruma::events::room::message::RoomMessageEventContent;
+
+use self::commands::*;
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+pub(super) enum 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(super) 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/check/commands.rs

@@ -0,0 +1,26 @@
+use conduit::Result;
+use ruma::events::room::message::RoomMessageEventContent;
+
+use crate::services;
+
+/// Uses the iterator in `src/database/key_value/users.rs` to iterator over
+/// every user in our database (remote and local). Reports total count, any
+/// errors if there were any, etc
+pub(super) async fn check_all_users(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	let timer = tokio::time::Instant::now();
+	let results = services().users.db.iter();
+	let query_time = timer.elapsed();
+
+	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: {total:?}\nFailure/Invalid user count: \
+		 {err_count:?}\nSuccess/Valid user count: {ok_count:?}\n```"
+	);
+
+	Ok(RoomMessageEventContent::notice_markdown(message))
+}

src/admin/check/mod.rs

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

src/admin/debug/commands.rs

@@ -0,0 +1,689 @@
+use std::{
+	collections::{BTreeMap, HashMap},
+	sync::{Arc, Mutex},
+	time::Instant,
+};
+
+use api::client::validate_and_add_event_id;
+use conduit::{
+	debug, info, log,
+	log::{capture, Capture},
+	warn, Error, Result,
+};
+use ruma::{
+	api::{client::error::ErrorKind, federation::event::get_room_state},
+	events::room::message::RoomMessageEventContent,
+	CanonicalJsonObject, EventId, OwnedRoomOrAliasId, RoomId, RoomVersionId, ServerName,
+};
+use service::{rooms::event_handler::parse_incoming_pdu, sending::resolve_actual_dest, services, PduEvent};
+use tokio::sync::RwLock;
+use tracing_subscriber::EnvFilter;
+
+pub(super) async fn echo(_body: Vec<&str>, message: Vec<String>) -> Result<RoomMessageEventContent> {
+	let message = message.join(" ");
+
+	Ok(RoomMessageEventContent::notice_plain(message))
+}
+
+pub(super) async fn get_auth_chain(_body: Vec<&str>, event_id: Box<EventId>) -> Result<RoomMessageEventContent> {
+	let event_id = Arc::<EventId>::from(event_id);
+	if let Some(event) = services().rooms.timeline.get_pdu_json(&event_id)? {
+		let room_id_str = event
+			.get("room_id")
+			.and_then(|val| val.as_str())
+			.ok_or_else(|| Error::bad_database("Invalid event in database"))?;
+
+		let room_id = <&RoomId>::try_from(room_id_str)
+			.map_err(|_| Error::bad_database("Invalid room id field in event in database"))?;
+		let start = Instant::now();
+		let count = services()
+			.rooms
+			.auth_chain
+			.event_ids_iter(room_id, vec![event_id])
+			.await?
+			.count();
+		let elapsed = start.elapsed();
+		Ok(RoomMessageEventContent::text_plain(format!(
+			"Loaded auth chain with length {count} in {elapsed:?}"
+		)))
+	} else {
+		Ok(RoomMessageEventContent::text_plain("Event not found."))
+	}
+}
+
+pub(super) async fn parse_pdu(body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	if body.len() < 2 || !body[0].trim().starts_with("```") || body.last().unwrap_or(&"").trim() != "```" {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		));
+	}
+
+	let string = body[1..body.len().saturating_sub(1)].join("\n");
+	match serde_json::from_str(&string) {
+		Ok(value) => match ruma::signatures::reference_hash(&value, &RoomVersionId::V6) {
+			Ok(hash) => {
+				let event_id = EventId::parse(format!("${hash}"));
+
+				match serde_json::from_value::<PduEvent>(serde_json::to_value(value).expect("value is json")) {
+					Ok(pdu) => Ok(RoomMessageEventContent::text_plain(format!("EventId: {event_id:?}\n{pdu:#?}"))),
+					Err(e) => Ok(RoomMessageEventContent::text_plain(format!(
+						"EventId: {event_id:?}\nCould not parse event: {e}"
+					))),
+				}
+			},
+			Err(e) => Ok(RoomMessageEventContent::text_plain(format!("Could not parse PDU JSON: {e:?}"))),
+		},
+		Err(e) => Ok(RoomMessageEventContent::text_plain(format!(
+			"Invalid json in command body: {e}"
+		))),
+	}
+}
+
+pub(super) async fn get_pdu(_body: Vec<&str>, event_id: Box<EventId>) -> Result<RoomMessageEventContent> {
+	let mut outlier = false;
+	let mut pdu_json = services()
+		.rooms
+		.timeline
+		.get_non_outlier_pdu_json(&event_id)?;
+	if pdu_json.is_none() {
+		outlier = true;
+		pdu_json = services().rooms.timeline.get_pdu_json(&event_id)?;
+	}
+	match pdu_json {
+		Some(json) => {
+			let json_text = serde_json::to_string_pretty(&json).expect("canonical json is valid json");
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"{}\n```json\n{}\n```",
+				if outlier {
+					"Outlier PDU found in our database"
+				} else {
+					"PDU found in our database"
+				},
+				json_text
+			)))
+		},
+		None => Ok(RoomMessageEventContent::text_plain("PDU not found locally.")),
+	}
+}
+
+pub(super) async fn get_remote_pdu_list(
+	body: Vec<&str>, server: Box<ServerName>, force: bool,
+) -> Result<RoomMessageEventContent> {
+	if !services().globals.config.allow_federation {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Federation is disabled on this homeserver.",
+		));
+	}
+
+	if server == services().globals.server_name() {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Not allowed to send federation requests to ourselves. Please use `get-pdu` for fetching local PDUs from \
+			 the database.",
+		));
+	}
+
+	if body.len() < 2 || !body[0].trim().starts_with("```") || body.last().unwrap_or(&"").trim() != "```" {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		));
+	}
+
+	let list = body
+		.clone()
+		.drain(1..body.len().checked_sub(1).unwrap())
+		.filter_map(|pdu| EventId::parse(pdu).ok())
+		.collect::<Vec<_>>();
+
+	for pdu in list {
+		if force {
+			if let Err(e) = get_remote_pdu(Vec::new(), Box::from(pdu), server.clone()).await {
+				services()
+					.admin
+					.send_message(RoomMessageEventContent::text_plain(format!(
+						"Failed to get remote PDU, ignoring error: {e}"
+					)))
+					.await;
+				warn!(%e, "Failed to get remote PDU, ignoring error");
+			}
+		} else {
+			get_remote_pdu(Vec::new(), Box::from(pdu), server.clone()).await?;
+		}
+	}
+
+	Ok(RoomMessageEventContent::text_plain("Fetched list of remote PDUs."))
+}
+
+pub(super) async fn get_remote_pdu(
+	_body: Vec<&str>, event_id: Box<EventId>, server: Box<ServerName>,
+) -> Result<RoomMessageEventContent> {
+	if !services().globals.config.allow_federation {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Federation is disabled on this homeserver.",
+		));
+	}
+
+	if server == services().globals.server_name() {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Not allowed to send federation requests to ourselves. Please use `get-pdu` for fetching local PDUs.",
+		));
+	}
+
+	match services()
+		.sending
+		.send_federation_request(
+			&server,
+			ruma::api::federation::event::get_event::v1::Request {
+				event_id: event_id.clone().into(),
+			},
+		)
+		.await
+	{
+		Ok(response) => {
+			let json: CanonicalJsonObject = serde_json::from_str(response.pdu.get()).map_err(|e| {
+				warn!(
+					"Requested event ID {event_id} from server but failed to convert from RawValue to \
+					 CanonicalJsonObject (malformed event/response?): {e}"
+				);
+				Error::BadRequest(ErrorKind::Unknown, "Received response from server but failed to parse PDU")
+			})?;
+
+			debug!("Attempting to parse PDU: {:?}", &response.pdu);
+			let parsed_pdu = {
+				let parsed_result = parse_incoming_pdu(&response.pdu);
+				let (event_id, value, room_id) = match parsed_result {
+					Ok(t) => t,
+					Err(e) => {
+						warn!("Failed to parse PDU: {e}");
+						info!("Full PDU: {:?}", &response.pdu);
+						return Ok(RoomMessageEventContent::text_plain(format!(
+							"Failed to parse PDU remote server {server} sent us: {e}"
+						)));
+					},
+				};
+
+				vec![(event_id, value, room_id)]
+			};
+
+			let pub_key_map = RwLock::new(BTreeMap::new());
+
+			debug!("Attempting to fetch homeserver signing keys for {server}");
+			services()
+				.rooms
+				.event_handler
+				.fetch_required_signing_keys(parsed_pdu.iter().map(|(_event_id, event, _room_id)| event), &pub_key_map)
+				.await
+				.unwrap_or_else(|e| {
+					warn!("Could not fetch all signatures for PDUs from {server}: {e:?}");
+				});
+
+			info!("Attempting to handle event ID {event_id} as backfilled PDU");
+			services()
+				.rooms
+				.timeline
+				.backfill_pdu(&server, response.pdu, &pub_key_map)
+				.await?;
+
+			let json_text = serde_json::to_string_pretty(&json).expect("canonical json is valid json");
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"{}\n```json\n{}\n```",
+				"Got PDU from specified server and handled as backfilled PDU successfully. Event body:", json_text
+			)))
+		},
+		Err(e) => Ok(RoomMessageEventContent::text_plain(format!(
+			"Remote server did not have PDU or failed sending request to remote server: {e}"
+		))),
+	}
+}
+
+pub(super) async fn get_room_state(_body: Vec<&str>, room: OwnedRoomOrAliasId) -> Result<RoomMessageEventContent> {
+	let room_id = services().rooms.alias.resolve(&room).await?;
+	let room_state = services()
+		.rooms
+		.state_accessor
+		.room_state_full(&room_id)
+		.await?
+		.values()
+		.map(|pdu| pdu.to_state_event())
+		.collect::<Vec<_>>();
+
+	if room_state.is_empty() {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Unable to find room state in our database (vector is empty)",
+		));
+	}
+
+	let json = serde_json::to_string_pretty(&room_state).map_err(|e| {
+		warn!("Failed converting room state vector in our database to pretty JSON: {e}");
+		Error::bad_database(
+			"Failed to convert room state events to pretty JSON, possible invalid room state events in our database",
+		)
+	})?;
+
+	Ok(RoomMessageEventContent::notice_markdown(format!("```json\n{json}\n```")))
+}
+
+pub(super) async fn ping(_body: Vec<&str>, server: Box<ServerName>) -> Result<RoomMessageEventContent> {
+	if server == services().globals.server_name() {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Not allowed to send federation requests to ourselves.",
+		));
+	}
+
+	let timer = tokio::time::Instant::now();
+
+	match services()
+		.sending
+		.send_federation_request(&server, ruma::api::federation::discovery::get_server_version::v1::Request {})
+		.await
+	{
+		Ok(response) => {
+			let ping_time = timer.elapsed();
+
+			let json_text_res = serde_json::to_string_pretty(&response.server);
+
+			if let Ok(json) = json_text_res {
+				return Ok(RoomMessageEventContent::notice_markdown(format!(
+					"Got response which took {ping_time:?} time:\n```json\n{json}\n```"
+				)));
+			}
+
+			Ok(RoomMessageEventContent::text_plain(format!(
+				"Got non-JSON response which took {ping_time:?} time:\n{response:?}"
+			)))
+		},
+		Err(e) => {
+			warn!("Failed sending federation request to specified server from ping debug command: {e}");
+			Ok(RoomMessageEventContent::text_plain(format!(
+				"Failed sending federation request to specified server:\n\n{e}",
+			)))
+		},
+	}
+}
+
+pub(super) async fn force_device_list_updates(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	// Force E2EE device list updates for all users
+	for user_id in services().users.iter().filter_map(Result::ok) {
+		services().users.mark_device_key_update(&user_id)?;
+	}
+	Ok(RoomMessageEventContent::text_plain(
+		"Marked all devices for all users as having new keys to update",
+	))
+}
+
+pub(super) async fn change_log_level(
+	_body: Vec<&str>, filter: Option<String>, reset: bool,
+) -> Result<RoomMessageEventContent> {
+	let handles = &["console"];
+
+	if reset {
+		let old_filter_layer = match EnvFilter::try_new(&services().globals.config.log) {
+			Ok(s) => s,
+			Err(e) => {
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"Log level from config appears to be invalid now: {e}"
+				)));
+			},
+		};
+
+		match services()
+			.server
+			.log
+			.reload
+			.reload(&old_filter_layer, Some(handles))
+		{
+			Ok(()) => {
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"Successfully changed log level back to config value {}",
+					services().globals.config.log
+				)));
+			},
+			Err(e) => {
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"Failed to modify and reload the global tracing log level: {e}"
+				)));
+			},
+		}
+	}
+
+	if let Some(filter) = filter {
+		let new_filter_layer = match EnvFilter::try_new(filter) {
+			Ok(s) => s,
+			Err(e) => {
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"Invalid log level filter specified: {e}"
+				)));
+			},
+		};
+
+		match services()
+			.server
+			.log
+			.reload
+			.reload(&new_filter_layer, Some(handles))
+		{
+			Ok(()) => {
+				return Ok(RoomMessageEventContent::text_plain("Successfully changed log level"));
+			},
+			Err(e) => {
+				return Ok(RoomMessageEventContent::text_plain(format!(
+					"Failed to modify and reload the global tracing log level: {e}"
+				)));
+			},
+		}
+	}
+
+	Ok(RoomMessageEventContent::text_plain("No log level was specified."))
+}
+
+pub(super) async fn sign_json(body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	if body.len() < 2 || !body[0].trim().starts_with("```") || body.last().unwrap_or(&"").trim() != "```" {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		));
+	}
+
+	let string = body[1..body.len().checked_sub(1).unwrap()].join("\n");
+	match serde_json::from_str(&string) {
+		Ok(mut value) => {
+			ruma::signatures::sign_json(
+				services().globals.server_name().as_str(),
+				services().globals.keypair(),
+				&mut value,
+			)
+			.expect("our request json is what ruma expects");
+			let json_text = serde_json::to_string_pretty(&value).expect("canonical json is valid json");
+			Ok(RoomMessageEventContent::text_plain(json_text))
+		},
+		Err(e) => Ok(RoomMessageEventContent::text_plain(format!("Invalid json: {e}"))),
+	}
+}
+
+pub(super) async fn verify_json(body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	if body.len() < 2 || !body[0].trim().starts_with("```") || body.last().unwrap_or(&"").trim() != "```" {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		));
+	}
+
+	let string = body[1..body.len().checked_sub(1).unwrap()].join("\n");
+	match serde_json::from_str(&string) {
+		Ok(value) => {
+			let pub_key_map = RwLock::new(BTreeMap::new());
+
+			services()
+				.rooms
+				.event_handler
+				.fetch_required_signing_keys([&value], &pub_key_map)
+				.await?;
+
+			let pub_key_map = pub_key_map.read().await;
+			match ruma::signatures::verify_json(&pub_key_map, &value) {
+				Ok(()) => Ok(RoomMessageEventContent::text_plain("Signature correct")),
+				Err(e) => Ok(RoomMessageEventContent::text_plain(format!(
+					"Signature verification failed: {e}"
+				))),
+			}
+		},
+		Err(e) => Ok(RoomMessageEventContent::text_plain(format!("Invalid json: {e}"))),
+	}
+}
+
+#[tracing::instrument(skip(_body))]
+pub(super) async fn first_pdu_in_room(_body: Vec<&str>, room_id: Box<RoomId>) -> Result<RoomMessageEventContent> {
+	if !services()
+		.rooms
+		.state_cache
+		.server_in_room(&services().globals.config.server_name, &room_id)?
+	{
+		return Ok(RoomMessageEventContent::text_plain(
+			"We are not participating in the room / we don't know about the room ID.",
+		));
+	}
+
+	let first_pdu = services()
+		.rooms
+		.timeline
+		.first_pdu_in_room(&room_id)?
+		.ok_or_else(|| Error::bad_database("Failed to find the first PDU in database"))?;
+
+	Ok(RoomMessageEventContent::text_plain(format!("{first_pdu:?}")))
+}
+
+#[tracing::instrument(skip(_body))]
+pub(super) async fn latest_pdu_in_room(_body: Vec<&str>, room_id: Box<RoomId>) -> Result<RoomMessageEventContent> {
+	if !services()
+		.rooms
+		.state_cache
+		.server_in_room(&services().globals.config.server_name, &room_id)?
+	{
+		return Ok(RoomMessageEventContent::text_plain(
+			"We are not participating in the room / we don't know about the room ID.",
+		));
+	}
+
+	let latest_pdu = services()
+		.rooms
+		.timeline
+		.latest_pdu_in_room(&room_id)?
+		.ok_or_else(|| Error::bad_database("Failed to find the latest PDU in database"))?;
+
+	Ok(RoomMessageEventContent::text_plain(format!("{latest_pdu:?}")))
+}
+
+#[tracing::instrument(skip(_body))]
+pub(super) async fn force_set_room_state_from_server(
+	_body: Vec<&str>, server_name: Box<ServerName>, room_id: Box<RoomId>,
+) -> Result<RoomMessageEventContent> {
+	if !services()
+		.rooms
+		.state_cache
+		.server_in_room(&services().globals.config.server_name, &room_id)?
+	{
+		return Ok(RoomMessageEventContent::text_plain(
+			"We are not participating in the room / we don't know about the room ID.",
+		));
+	}
+
+	let first_pdu = services()
+		.rooms
+		.timeline
+		.latest_pdu_in_room(&room_id)?
+		.ok_or_else(|| Error::bad_database("Failed to find the latest PDU in database"))?;
+
+	let room_version = services().rooms.state.get_room_version(&room_id)?;
+
+	let mut state: HashMap<u64, Arc<EventId>> = HashMap::new();
+	let pub_key_map = RwLock::new(BTreeMap::new());
+
+	let remote_state_response = services()
+		.sending
+		.send_federation_request(
+			&server_name,
+			get_room_state::v1::Request {
+				room_id: room_id.clone().into(),
+				event_id: first_pdu.event_id.clone().into(),
+			},
+		)
+		.await?;
+
+	let mut events = Vec::with_capacity(remote_state_response.pdus.len());
+
+	for pdu in remote_state_response.pdus.clone() {
+		events.push(match parse_incoming_pdu(&pdu) {
+			Ok(t) => t,
+			Err(e) => {
+				warn!("Could not parse PDU, ignoring: {e}");
+				continue;
+			},
+		});
+	}
+
+	info!("Fetching required signing keys for all the state events we got");
+	services()
+		.rooms
+		.event_handler
+		.fetch_required_signing_keys(events.iter().map(|(_event_id, event, _room_id)| event), &pub_key_map)
+		.await?;
+
+	info!("Going through room_state response PDUs");
+	for result in remote_state_response
+		.pdus
+		.iter()
+		.map(|pdu| validate_and_add_event_id(pdu, &room_version, &pub_key_map))
+	{
+		let Ok((event_id, value)) = result.await else {
+			continue;
+		};
+
+		let pdu = PduEvent::from_id_val(&event_id, value.clone()).map_err(|e| {
+			warn!("Invalid PDU in fetching remote room state PDUs response: {} {:?}", e, value);
+			Error::BadServerResponse("Invalid PDU in send_join response.")
+		})?;
+
+		services()
+			.rooms
+			.outlier
+			.add_pdu_outlier(&event_id, &value)?;
+		if let Some(state_key) = &pdu.state_key {
+			let shortstatekey = services()
+				.rooms
+				.short
+				.get_or_create_shortstatekey(&pdu.kind.to_string().into(), state_key)?;
+			state.insert(shortstatekey, pdu.event_id.clone());
+		}
+	}
+
+	info!("Going through auth_chain response");
+	for result in remote_state_response
+		.auth_chain
+		.iter()
+		.map(|pdu| validate_and_add_event_id(pdu, &room_version, &pub_key_map))
+	{
+		let Ok((event_id, value)) = result.await else {
+			continue;
+		};
+
+		services()
+			.rooms
+			.outlier
+			.add_pdu_outlier(&event_id, &value)?;
+	}
+
+	let new_room_state = services()
+		.rooms
+		.event_handler
+		.resolve_state(room_id.clone().as_ref(), &room_version, state)
+		.await?;
+
+	info!("Forcing new room state");
+	let (short_state_hash, new, removed) = services()
+		.rooms
+		.state_compressor
+		.save_state(room_id.clone().as_ref(), new_room_state)?;
+
+	let state_lock = services().rooms.state.mutex.lock(&room_id).await;
+	services()
+		.rooms
+		.state
+		.force_state(room_id.clone().as_ref(), short_state_hash, new, removed, &state_lock)
+		.await?;
+
+	info!(
+		"Updating joined counts for room just in case (e.g. we may have found a difference in the room's \
+		 m.room.member state"
+	);
+	services().rooms.state_cache.update_joined_count(&room_id)?;
+
+	drop(state_lock);
+
+	Ok(RoomMessageEventContent::text_plain(
+		"Successfully forced the room state from the requested remote server.",
+	))
+}
+
+pub(super) async fn resolve_true_destination(
+	_body: Vec<&str>, server_name: Box<ServerName>, no_cache: bool,
+) -> Result<RoomMessageEventContent> {
+	if !services().globals.config.allow_federation {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Federation is disabled on this homeserver.",
+		));
+	}
+
+	if server_name == services().globals.config.server_name {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Not allowed to send federation requests to ourselves. Please use `get-pdu` for fetching local PDUs.",
+		));
+	}
+
+	let filter: &capture::Filter = &|data| {
+		data.level() <= log::Level::DEBUG
+			&& data.mod_name().starts_with("conduit")
+			&& matches!(data.span_name(), "actual" | "well-known" | "srv")
+	};
+
+	let state = &services().server.log.capture;
+	let logs = Arc::new(Mutex::new(String::new()));
+	let capture = Capture::new(state, Some(filter), capture::fmt_markdown(logs.clone()));
+
+	let capture_scope = capture.start();
+	let actual = resolve_actual_dest(&server_name, !no_cache).await?;
+	drop(capture_scope);
+
+	let msg = format!(
+		"{}\nDestination: {}\nHostname URI: {}",
+		logs.lock().expect("locked"),
+		actual.dest,
+		actual.host,
+	);
+	Ok(RoomMessageEventContent::text_markdown(msg))
+}
+
+#[must_use]
+pub(super) fn memory_stats() -> RoomMessageEventContent {
+	let html_body = conduit::alloc::memory_stats();
+
+	if html_body.is_none() {
+		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.expect("string result"),
+	)
+}
+
+#[cfg(tokio_unstable)]
+pub(super) async fn runtime_metrics(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	let out = services().server.metrics.runtime_metrics().map_or_else(
+		|| "Runtime metrics are not available.".to_owned(),
+		|metrics| format!("```rs\n{metrics:#?}\n```"),
+	);
+
+	Ok(RoomMessageEventContent::text_markdown(out))
+}
+
+#[cfg(not(tokio_unstable))]
+pub(super) async fn runtime_metrics(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	Ok(RoomMessageEventContent::text_markdown(
+		"Runtime metrics require building with `tokio_unstable`.",
+	))
+}
+
+#[cfg(tokio_unstable)]
+pub(super) async fn runtime_interval(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	let out = services().server.metrics.runtime_interval().map_or_else(
+		|| "Runtime metrics are not available.".to_owned(),
+		|metrics| format!("```rs\n{metrics:#?}\n```"),
+	);
+
+	Ok(RoomMessageEventContent::text_markdown(out))
+}
+
+#[cfg(not(tokio_unstable))]
+pub(super) async fn runtime_interval(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	Ok(RoomMessageEventContent::text_markdown(
+		"Runtime metrics require building with `tokio_unstable`.",
+	))
+}

src/admin/debug/mod.rs

@@ -0,0 +1,227 @@
+mod commands;
+pub(crate) mod tester;
+
+use clap::Subcommand;
+use conduit::Result;
+use ruma::{events::room::message::RoomMessageEventContent, EventId, OwnedRoomOrAliasId, RoomId, ServerName};
+use tester::TesterCommand;
+
+use self::commands::*;
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+pub(super) enum DebugCommand {
+	/// - Echo input of admin command
+	Echo {
+		message: Vec<String>,
+	},
+
+	/// - Get the auth_chain of a PDU
+	GetAuthChain {
+		/// An event ID (the $ character followed by the base64 reference hash)
+		event_id: Box<EventId>,
+	},
+
+	/// - Parse and print a PDU from a JSON
+	///
+	/// The PDU event is only checked for validity and is not added to the
+	/// database.
+	///
+	/// This command needs a JSON blob provided in a Markdown code block below
+	/// the command.
+	ParsePdu,
+
+	/// - Retrieve and print a PDU by ID from the conduwuit database
+	GetPdu {
+		/// An event ID (a $ followed by the base64 reference hash)
+		event_id: Box<EventId>,
+	},
+
+	/// - Attempts to retrieve a PDU from a remote server. Inserts it into our
+	///   database/timeline if found and we do not have this PDU already
+	///   (following normal event auth rules, handles it as an incoming PDU).
+	GetRemotePdu {
+		/// An event ID (a $ followed by the base64 reference hash)
+		event_id: Box<EventId>,
+
+		/// Argument for us to attempt to fetch the event from the
+		/// specified remote server.
+		server: Box<ServerName>,
+	},
+
+	/// - Same as `get-remote-pdu` but accepts a codeblock newline delimited
+	///   list of PDUs and a single server to fetch from
+	GetRemotePduList {
+		/// Argument for us to attempt to fetch all the events from the
+		/// specified remote server.
+		server: Box<ServerName>,
+
+		/// If set, ignores errors, else stops at the first error/failure.
+		#[arg(short, long)]
+		force: bool,
+	},
+
+	/// - Gets all the room state events for the specified room.
+	///
+	/// This is functionally equivalent to `GET
+	/// /_matrix/client/v3/rooms/{roomid}/state`, except the admin command does
+	/// *not* check if the sender user is allowed to see state events. This is
+	/// done because it's implied that server admins here have database access
+	/// and can see/get room info themselves anyways if they were malicious
+	/// admins.
+	///
+	/// Of course the check is still done on the actual client API.
+	GetRoomState {
+		/// Room ID
+		room_id: OwnedRoomOrAliasId,
+	},
+
+	/// - 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,
+
+	/// - Prints the very first PDU in the specified room (typically
+	///   m.room.create)
+	FirstPduInRoom {
+		/// The room ID
+		room_id: Box<RoomId>,
+	},
+
+	/// - Prints the latest ("last") PDU in the specified room (typically a
+	///   message)
+	LatestPduInRoom {
+		/// The room ID
+		room_id: Box<RoomId>,
+	},
+
+	/// - Forcefully replaces the room state of our local copy of the specified
+	///   room, with the copy (auth chain and room state events) the specified
+	///   remote server says.
+	///
+	/// A common desire for room deletion is to simply "reset" our copy of the
+	/// room. While this admin command is not a replacement for that, if you
+	/// know you have split/broken room state and you know another server in the
+	/// room that has the best/working room state, this command can let you use
+	/// their room state. Such example is your server saying users are in a
+	/// room, but other servers are saying they're not in the room in question.
+	///
+	/// This command will get the latest PDU in the room we know about, and
+	/// request the room state at that point in time via
+	/// `/_matrix/federation/v1/state/{roomId}`.
+	ForceSetRoomStateFromServer {
+		/// The impacted room ID
+		room_id: Box<RoomId>,
+		/// The server we will use to query the room state for
+		server_name: Box<ServerName>,
+	},
+
+	/// - Runs a server name through conduwuit's true destination resolution
+	///   process
+	///
+	/// Useful for debugging well-known issues
+	ResolveTrueDestination {
+		server_name: Box<ServerName>,
+
+		#[arg(short, long)]
+		no_cache: bool,
+	},
+
+	/// - Print extended memory usage
+	MemoryStats,
+
+	/// - Print general tokio runtime metric totals.
+	RuntimeMetrics,
+
+	/// - Print detailed tokio runtime metrics accumulated since last command
+	///   invocation.
+	RuntimeInterval,
+
+	/// - Developer test stubs
+	#[command(subcommand)]
+	Tester(TesterCommand),
+}
+
+pub(super) async fn process(command: DebugCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	Ok(match command {
+		DebugCommand::Echo {
+			message,
+		} => echo(body, message).await?,
+		DebugCommand::GetAuthChain {
+			event_id,
+		} => get_auth_chain(body, event_id).await?,
+		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::FirstPduInRoom {
+			room_id,
+		} => first_pdu_in_room(body, room_id).await?,
+		DebugCommand::LatestPduInRoom {
+			room_id,
+		} => latest_pdu_in_room(body, room_id).await?,
+		DebugCommand::GetRemotePduList {
+			server,
+			force,
+		} => get_remote_pdu_list(body, server, force).await?,
+		DebugCommand::ForceSetRoomStateFromServer {
+			room_id,
+			server_name,
+		} => force_set_room_state_from_server(body, server_name, room_id).await?,
+		DebugCommand::ResolveTrueDestination {
+			server_name,
+			no_cache,
+		} => resolve_true_destination(body, server_name, no_cache).await?,
+		DebugCommand::MemoryStats => memory_stats(),
+		DebugCommand::RuntimeMetrics => runtime_metrics(body).await?,
+		DebugCommand::RuntimeInterval => runtime_interval(body).await?,
+		DebugCommand::Tester(command) => tester::process(command, body).await?,
+	})
+}

src/admin/debug/tester.rs

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

src/admin/federation/commands.rs

@@ -0,0 +1,133 @@
+use std::fmt::Write;
+
+use ruma::{events::room::message::RoomMessageEventContent, OwnedRoomId, RoomId, ServerName, UserId};
+
+use crate::{escape_html, get_room_info, services, Result};
+
+pub(super) async fn disable_room(_body: Vec<&str>, room_id: Box<RoomId>) -> Result<RoomMessageEventContent> {
+	services().rooms.metadata.disable_room(&room_id, true)?;
+	Ok(RoomMessageEventContent::text_plain("Room disabled."))
+}
+
+pub(super) async fn enable_room(_body: Vec<&str>, room_id: Box<RoomId>) -> Result<RoomMessageEventContent> {
+	services().rooms.metadata.disable_room(&room_id, false)?;
+	Ok(RoomMessageEventContent::text_plain("Room enabled."))
+}
+
+pub(super) async fn incoming_federation(_body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	let map = services()
+		.rooms
+		.event_handler
+		.federation_handletime
+		.read()
+		.expect("locked");
+	let mut msg = format!("Handling {} incoming pdus:\n", map.len());
+
+	for (r, (e, i)) in map.iter() {
+		let elapsed = i.elapsed();
+		writeln!(msg, "{} {}: {}m{}s", r, e, elapsed.as_secs() / 60, elapsed.as_secs() % 60)?;
+	}
+
+	Ok(RoomMessageEventContent::text_plain(&msg))
+}
+
+pub(super) 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::notice_markdown(format!(
+		"Got JSON response:\n\n```json\n{pretty_json}\n```"
+	)))
+}
+
+pub(super) async fn remote_user_in_rooms(_body: Vec<&str>, user_id: Box<UserId>) -> Result<RoomMessageEventContent> {
+	if user_id.server_name() == services().globals.config.server_name {
+		return Ok(RoomMessageEventContent::text_plain(
+			"User belongs to our server, please use `list-joined-rooms` user admin command instead.",
+		));
+	}
+
+	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.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} shares with us \
+		 ({})</caption>\n<tr><th>id</th>\t<th>members</th>\t<th>name</th></tr>\n{}</table>",
+		rooms.len(),
+		rooms
+			.iter()
+			.fold(String::new(), |mut output, (id, members, name)| {
+				writeln!(
+					output,
+					"<tr><td>{}</td>\t<td>{}</td>\t<td>{}</td></tr>",
+					id,
+					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,60 @@
+mod commands;
+
+use clap::Subcommand;
+use conduit::Result;
+use ruma::{events::room::message::RoomMessageEventContent, RoomId, ServerName, UserId};
+
+use self::commands::*;
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+pub(super) enum FederationCommand {
+	/// - List all rooms we are currently handling an incoming pdu from
+	IncomingFederation,
+
+	/// - Disables incoming federation handling for a room.
+	DisableRoom {
+		room_id: Box<RoomId>,
+	},
+
+	/// - Enables incoming federation handling for a room again.
+	EnableRoom {
+		room_id: Box<RoomId>,
+	},
+
+	/// - Fetch `/.well-known/matrix/support` from the specified server
+	///
+	/// Despite the name, this is not a federation endpoint and does not go
+	/// through the federation / server resolution process as per-spec this is
+	/// supposed to be served at the server_name.
+	///
+	/// Respecting homeservers put this file here for listing administration,
+	/// moderation, and security inquiries. This command provides a way to
+	/// easily fetch that information.
+	FetchSupportWellKnown {
+		server_name: Box<ServerName>,
+	},
+
+	/// - Lists all the rooms we share/track with the specified *remote* user
+	RemoteUserInRooms {
+		user_id: Box<UserId>,
+	},
+}
+
+pub(super) 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_federation(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/handler.rs

@@ -0,0 +1,241 @@
+use std::{panic::AssertUnwindSafe, time::Instant};
+
+use clap::{CommandFactory, Parser};
+use conduit::{error, trace, Error};
+use futures_util::future::FutureExt;
+use ruma::{
+	events::{
+		relation::InReplyTo,
+		room::message::{Relation::Reply, RoomMessageEventContent},
+	},
+	OwnedEventId,
+};
+
+extern crate conduit_service as service;
+
+use conduit::{utils::string::common_prefix, Result};
+pub(crate) use service::admin::{Command, Service};
+use service::admin::{CommandOutput, CommandResult, HandlerResult};
+
+use crate::{
+	appservice, appservice::AppserviceCommand, check, check::CheckCommand, debug, debug::DebugCommand, federation,
+	federation::FederationCommand, media, media::MediaCommand, query, query::QueryCommand, room, room::RoomCommand,
+	server, server::ServerCommand, services, user, user::UserCommand,
+};
+pub(crate) const PAGE_SIZE: usize = 100;
+
+#[derive(Parser)]
+#[command(name = "admin", version = env!("CARGO_PKG_VERSION"))]
+pub(crate) enum AdminCommand {
+	#[command(subcommand)]
+	/// - Commands for managing appservices
+	Appservices(AppserviceCommand),
+
+	#[command(subcommand)]
+	/// - Commands for managing local users
+	Users(UserCommand),
+
+	#[command(subcommand)]
+	/// - Commands for managing rooms
+	Rooms(RoomCommand),
+
+	#[command(subcommand)]
+	/// - Commands for managing federation
+	Federation(FederationCommand),
+
+	#[command(subcommand)]
+	/// - Commands for managing the server
+	Server(ServerCommand),
+
+	#[command(subcommand)]
+	/// - Commands for managing media
+	Media(MediaCommand),
+
+	#[command(subcommand)]
+	/// - Commands for checking integrity
+	Check(CheckCommand),
+
+	#[command(subcommand)]
+	/// - Commands for debugging things
+	Debug(DebugCommand),
+
+	#[command(subcommand)]
+	/// - Low-level queries for database getters and iterators
+	Query(QueryCommand),
+}
+
+#[must_use]
+pub(crate) fn handle(command: Command) -> HandlerResult { Box::pin(handle_command(command)) }
+
+#[must_use]
+pub(crate) fn complete(line: &str) -> String { complete_admin_command(AdminCommand::command(), line) }
+
+#[tracing::instrument(skip_all, name = "admin")]
+async fn handle_command(command: Command) -> CommandResult {
+	AssertUnwindSafe(process_command(&command))
+		.catch_unwind()
+		.await
+		.map_err(Error::from_panic)
+		.or_else(|error| handle_panic(&error, command))
+}
+
+async fn process_command(command: &Command) -> CommandOutput {
+	process_admin_message(&command.command)
+		.await
+		.and_then(|content| reply(content, command.reply_id.clone()))
+}
+
+fn handle_panic(error: &Error, command: Command) -> CommandResult {
+	let link = "Please submit a [bug report](https://github.com/girlbossceo/conduwuit/issues/new). 🥺";
+	let msg = format!("Panic occurred while processing command:\n```\n{error:#?}\n```\n{link}");
+	let content = RoomMessageEventContent::notice_markdown(msg);
+	error!("Panic while processing command: {error:?}");
+	Ok(reply(content, command.reply_id))
+}
+
+fn reply(mut content: RoomMessageEventContent, reply_id: Option<OwnedEventId>) -> Option<RoomMessageEventContent> {
+	content.relates_to = reply_id.map(|event_id| Reply {
+		in_reply_to: InReplyTo {
+			event_id,
+		},
+	});
+
+	Some(content)
+}
+
+// Parse and process a message from the admin room
+async fn process_admin_message(msg: &str) -> CommandOutput {
+	let mut lines = msg.lines().filter(|l| !l.trim().is_empty());
+	let command = lines.next().expect("each string has at least one line");
+	let body = lines.collect::<Vec<_>>();
+	let parsed = match parse_admin_command(command) {
+		Ok(parsed) => parsed,
+		Err(error) => {
+			let server_name = services().globals.server_name();
+			let message = error.replace("server.name", server_name.as_str());
+			return Some(RoomMessageEventContent::notice_markdown(message));
+		},
+	};
+
+	let timer = Instant::now();
+	let result = process_admin_command(parsed, body).await;
+	let elapsed = timer.elapsed();
+	conduit::debug!(?command, ok = result.is_ok(), "command processed in {elapsed:?}");
+	match result {
+		Ok(reply) => Some(reply),
+		Err(error) => Some(RoomMessageEventContent::notice_markdown(format!(
+			"Encountered an error while handling the command:\n```\n{error:#?}\n```"
+		))),
+	}
+}
+
+#[tracing::instrument(skip_all, name = "command")]
+async fn process_admin_command(command: AdminCommand, body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	let reply_message_content = match command {
+		AdminCommand::Appservices(command) => appservice::process(command, body).await?,
+		AdminCommand::Media(command) => media::process(command, body).await?,
+		AdminCommand::Users(command) => user::process(command, body).await?,
+		AdminCommand::Rooms(command) => room::process(command, body).await?,
+		AdminCommand::Federation(command) => federation::process(command, body).await?,
+		AdminCommand::Server(command) => server::process(command, body).await?,
+		AdminCommand::Debug(command) => debug::process(command, body).await?,
+		AdminCommand::Query(command) => query::process(command, body).await?,
+		AdminCommand::Check(command) => check::process(command, body).await?,
+	};
+
+	Ok(reply_message_content)
+}
+
+// Parse chat messages from the admin room into an AdminCommand object
+fn parse_admin_command(command_line: &str) -> Result<AdminCommand, String> {
+	let argv = parse_command_line(command_line);
+	AdminCommand::try_parse_from(argv).map_err(|error| error.to_string())
+}
+
+fn complete_admin_command(mut cmd: clap::Command, line: &str) -> String {
+	let argv = parse_command_line(line);
+	let mut ret = Vec::<String>::with_capacity(argv.len().saturating_add(1));
+
+	'token: for token in argv.into_iter().skip(1) {
+		let cmd_ = cmd.clone();
+		let mut choice = Vec::new();
+
+		for sub in cmd_.get_subcommands() {
+			let name = sub.get_name();
+			if *name == token {
+				// token already complete; recurse to subcommand
+				ret.push(token);
+				cmd.clone_from(sub);
+				continue 'token;
+			} else if name.starts_with(&token) {
+				// partial match; add to choices
+				choice.push(name);
+			}
+		}
+
+		if choice.len() == 1 {
+			// One choice. Add extra space because it's complete
+			let choice = *choice.first().expect("only choice");
+			ret.push(choice.to_owned());
+			ret.push(String::new());
+		} else if choice.is_empty() {
+			// Nothing found, return original string
+			ret.push(token);
+		} else {
+			// Find the common prefix
+			ret.push(common_prefix(&choice).into());
+		}
+
+		// Return from completion
+		return ret.join(" ");
+	}
+
+	// Return from no completion. Needs a space though.
+	ret.push(String::new());
+	ret.join(" ")
+}
+
+// Parse chat messages from the admin room into an AdminCommand object
+fn parse_command_line(command_line: &str) -> Vec<String> {
+	let mut argv = command_line
+		.split_whitespace()
+		.map(str::to_owned)
+		.collect::<Vec<String>>();
+
+	// Remove any escapes that came with a server-side escape command
+	if !argv.is_empty() && argv[0].ends_with("admin") {
+		argv[0] = argv[0].trim_start_matches('\\').into();
+	}
+
+	// First indice has to be "admin" but for console convenience we add it here
+	let server_user = services().globals.server_user.as_str();
+	if !argv.is_empty() && !argv[0].ends_with("admin") && !argv[0].starts_with(server_user) {
+		argv.insert(0, "admin".to_owned());
+	}
+
+	// Replace `help command` with `command --help`
+	// Clap has a help subcommand, but it omits the long help description.
+	if argv.len() > 1 && argv[1] == "help" {
+		argv.remove(1);
+		argv.push("--help".to_owned());
+	}
+
+	// Backwards compatibility with `register_appservice`-style commands
+	if argv.len() > 1 && argv[1].contains('_') {
+		argv[1] = argv[1].replace('_', "-");
+	}
+
+	// Backwards compatibility with `register_appservice`-style commands
+	if argv.len() > 2 && argv[2].contains('_') {
+		argv[2] = argv[2].replace('_', "-");
+	}
+
+	// if the user is using the `query` command (argv[1]), replace the database
+	// function/table calls with underscores to match the codebase
+	if argv.len() > 3 && argv[1].eq("query") {
+		argv[3] = argv[3].replace('_', "-");
+	}
+
+	trace!(?command_line, ?argv, "parse");
+	argv
+}

src/admin/media/commands.rs

@@ -0,0 +1,179 @@
+use conduit::Result;
+use ruma::{events::room::message::RoomMessageEventContent, EventId, MxcUri};
+use tracing::{debug, info};
+
+use crate::services;
+
+pub(super) async fn delete(
+	_body: Vec<&str>, mxc: Option<Box<MxcUri>>, event_id: Option<Box<EventId>>,
+) -> Result<RoomMessageEventContent> {
+	if event_id.is_some() && mxc.is_some() {
+		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.as_ref()).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: usize = 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 = mxc_deletion_count.saturating_add(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(super) async fn delete_list(body: Vec<&str>) -> Result<RoomMessageEventContent> {
+	if body.len() < 2 || !body[0].trim().starts_with("```") || body.last().unwrap_or(&"").trim() != "```" {
+		return Ok(RoomMessageEventContent::text_plain(
+			"Expected code block in command body. Add --help for details.",
+		));
+	}
+
+	let mxc_list = body
+		.clone()
+		.drain(1..body.len().checked_sub(1).unwrap())
+		.collect::<Vec<_>>();
+
+	let mut mxc_deletion_count: usize = 0;
+
+	for mxc in mxc_list {
+		debug!("Deleting MXC {mxc} in bulk");
+		services().media.delete(mxc).await?;
+		mxc_deletion_count = mxc_deletion_count
+			.checked_add(1)
+			.expect("mxc_deletion_count should not get this high");
+	}
+
+	Ok(RoomMessageEventContent::text_plain(format!(
+		"Finished bulk MXC deletion, deleted {mxc_deletion_count} total MXCs from our database and the filesystem.",
+	)))
+}
+
+pub(super) async fn delete_past_remote_media(
+	_body: Vec<&str>, duration: String, force: bool,
+) -> Result<RoomMessageEventContent> {
+	let deleted_count = services()
+		.media
+		.delete_all_remote_media_at_after_time(duration, force)
+		.await?;
+
+	Ok(RoomMessageEventContent::text_plain(format!(
+		"Deleted {deleted_count} total files.",
+	)))
+}

src/admin/media/mod.rs

@@ -0,0 +1,53 @@
+mod commands;
+
+use clap::Subcommand;
+use conduit::Result;
+use ruma::{events::room::message::RoomMessageEventContent, EventId, MxcUri};
+
+use self::commands::*;
+
+#[cfg_attr(test, derive(Debug))]
+#[derive(Subcommand)]
+pub(super) 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,
+		/// Continues deleting remote media if an undeletable object is found
+		#[arg(short, long)]
+		force: bool,
+	},
+}
+
+pub(super) 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,
+			force,
+		} => delete_past_remote_media(body, duration, force).await?,
+	})
+}

src/admin/mod.rs

@@ -0,0 +1,56 @@
+#![allow(clippy::wildcard_imports)]
+
+pub(crate) mod appservice;
+pub(crate) mod check;
+pub(crate) mod debug;
+pub(crate) mod federation;
+pub(crate) mod handler;
+pub(crate) mod media;
+pub(crate) mod query;
+pub(crate) mod room;
+pub(crate) mod server;
+mod tests;
+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(crate) use service::{services, user_is_local};
+
+pub(crate) use crate::{
+	handler::Service,
+	utils::{escape_html, get_room_info},
+};
+
+mod_ctor! {}
+mod_dtor! {}
+
+/// Install the admin command handler
+pub async fn init() {
+	_ = services()
+		.admin
+		.complete
+		.write()
+		.expect("locked for writing")
+		.insert(handler::complete);
+	_ = services()
+		.admin
+		.handle
+		.write()
+		.await
+		.insert(handler::handle);
+}
+
+/// Uninstall the admin command handler
+pub async fn fini() {
+	_ = services().admin.handle.write().await.take();
+	_ = services()
+		.admin
+		.complete
+		.write()
+		.expect("locked for writing")
+		.take();
+}

src/admin/query/account_data.rs

@@ -0,0 +1,40 @@
+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(super) 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
+				.changes_since(room_id.as_deref(), &user_id, since)?;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		AccountData::Get {
+			user_id,
+			kind,
+			room_id,
+		} => {
+			let timer = tokio::time::Instant::now();
+			let results = services()
+				.account_data
+				.get(room_id.as_deref(), &user_id, kind)?;
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+	}
+}

src/admin/query/appservice.rs

@@ -0,0 +1,33 @@
+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(super) 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::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+		Appservice::All => {
+			let timer = tokio::time::Instant::now();
+			let results = services().appservice.all();
+			let query_time = timer.elapsed();
+
+			Ok(RoomMessageEventContent::notice_markdown(format!(
+				"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
+			)))
+		},
+	}
+}