chore: Test

Part of #753

.cargo/audit.toml

@@ -0,0 +1,27 @@
+[advisories]
+ignore = ["RUSTSEC-2024-0436", "RUSTSEC-2025-0014"] # advisory IDs to ignore e.g. ["RUSTSEC-2019-0001", ...]
+informational_warnings = [] # warn for categories of informational advisories
+severity_threshold = "none" # CVSS severity ("none", "low", "medium", "high", "critical")
+
+# Advisory Database Configuration
+[database]
+path = "~/.cargo/advisory-db" # Path where advisory git repo will be cloned
+url = "https://github.com/RustSec/advisory-db.git" # URL to git repo
+fetch = true # Perform a `git fetch` before auditing (default: true)
+stale = false # Allow stale advisory DB (i.e. no commits for 90 days, default: false)
+
+# Output Configuration
+[output]
+deny = ["warnings", "unmaintained", "unsound", "yanked"] # exit on error if unmaintained dependencies are found
+format = "terminal" # "terminal" (human readable report) or "json"
+quiet = false # Only print information on error
+show_tree = true # Show inverse dependency trees along with advisories (default: true)
+
+# Target Configuration
+[target]
+arch = ["x86_64", "aarch64"] # Ignore advisories for CPU architectures other than these
+os = ["linux", "windows", "macos"] # Ignore advisories for operating systems other than these
+
+[yanked]
+enabled = true # Warn for yanked crates in Cargo.lock (default: true)
+update_index = true # Auto-update the crates.io index (default: true)

.editorconfig

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

.envrc

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

.forgejo/workflows/test.yaml

@@ -0,0 +1,12 @@
+name: Test
+
+on:
+  push:
+  workflow_dispatch:
+
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - run: echo "forgejo.ref = ${{ forgejo.ref }}"

.gitattributes

@@ -0,0 +1,87 @@
+# taken from https://github.com/gitattributes/gitattributes/blob/46a8961ad73f5bd4d8d193708840fbc9e851d702/Rust.gitattributes
+# Auto detect text files and perform normalization
+*          text=auto
+
+*.rs       text diff=rust
+*.toml     text diff=toml
+Cargo.lock text
+
+# taken from https://github.com/gitattributes/gitattributes/blob/46a8961ad73f5bd4d8d193708840fbc9e851d702/Common.gitattributes
+# Documents
+*.bibtex   text diff=bibtex
+*.doc      diff=astextplain
+*.DOC      diff=astextplain
+*.docx     diff=astextplain
+*.DOCX     diff=astextplain
+*.dot      diff=astextplain
+*.DOT      diff=astextplain
+*.pdf      diff=astextplain
+*.PDF      diff=astextplain
+*.rtf      diff=astextplain
+*.RTF      diff=astextplain
+*.md       text diff=markdown
+*.mdx      text diff=markdown
+*.tex      text diff=tex
+*.adoc     text
+*.textile  text
+*.mustache text
+*.csv      text eol=crlf
+*.tab      text
+*.tsv      text
+*.txt      text
+*.sql      text
+*.epub     diff=astextplain
+
+# Graphics
+*.png      binary
+*.jpg      binary
+*.jpeg     binary
+*.gif      binary
+*.tif      binary
+*.tiff     binary
+*.ico      binary
+# SVG treated as text by default.
+*.svg      text
+*.eps      binary
+
+# Scripts
+*.bash     text eol=lf
+*.fish     text eol=lf
+*.ksh      text eol=lf
+*.sh       text eol=lf
+*.zsh      text eol=lf
+# These are explicitly windows files and should use crlf
+*.bat      text eol=crlf
+*.cmd      text eol=crlf
+*.ps1      text eol=crlf
+
+# Serialisation
+*.json     text
+*.toml     text
+*.xml      text
+*.yaml     text
+*.yml      text
+
+# Archives
+*.7z       binary
+*.bz       binary
+*.bz2      binary
+*.bzip2    binary
+*.gz       binary
+*.lz       binary
+*.lzma     binary
+*.rar      binary
+*.tar      binary
+*.taz      binary
+*.tbz      binary
+*.tbz2     binary
+*.tgz      binary
+*.tlz      binary
+*.txz      binary
+*.xz       binary
+*.Z        binary
+*.zip      binary
+*.zst      binary
+
+# Text files where line endings should be preserved
+*.patch    -text

.gitea/PULL_REQUEST_TEMPLATE.md

@@ -1,8 +0,0 @@
-
-<!-- Please describe your changes here -->
-
------------------------------------------------------------------------------
-
-- [ ] I ran `cargo fmt`, `cargo clippy`, and `cargo test`
-- [ ] I agree to release my code and all other changes of this MR under the Apache-2.0 license
-

.github/workflows/ci.yml

@@ -1,323 +0,0 @@
-name: CI and Artifacts
-
-on:
-    pull_request:
-    push:
-        # documentation workflow deals with this or is not relevant for this workflow
-        paths-ignore:
-          - '*.md'
-          - 'conduwuit-example.toml'
-          - 'book.toml'
-          - '.gitlab-ci.yml'
-          - '.gitignore'
-          - 'renovate.json'
-          - 'docs/**'
-          - 'debian/**'
-          - 'docker/**'
-          - 'test_results/**'
-        branches:
-            - main
-            - dev
-    # Allows you to run this workflow manually from the Actions tab
-    workflow_dispatch:
-
-concurrency:
-    group: ${{ github.head_ref || github.ref_name }}
-    cancel-in-progress: true
-
-env:
-    # Required to make some things output color
-    TERM: ansi
-    # Publishing to my nix binary cache
-    ATTIC_TOKEN: ${{ secrets.ATTIC_TOKEN }}
-    # Just in case incremental is still being set to true, speeds up CI
-    CARGO_INCREMENTAL: 0
-    # Custom nix binary cache if fork is being used
-    ATTIC_ENDPOINT: ${{ vars.ATTIC_ENDPOINT }}
-    ATTIC_PUBLIC_KEY: ${{ vars.ATTIC_PUBLIC_KEY }}
-
-permissions:
-    packages: write
-    contents: read
-
-jobs:
-    tests:
-        name: Test
-        runs-on: ubuntu-latest
-        steps:
-            - name: Sync repository
-              uses: actions/checkout@v4
-
-            - name: Install Nix
-              uses: DeterminateSystems/nix-installer-action@main
-
-            - name: Enable Cachix binary cache
-              run: |
-                  nix profile install nixpkgs#cachix
-                  cachix use crane
-                  cachix use nix-community
-
-            - name: Configure Magic Nix Cache
-              uses: DeterminateSystems/magic-nix-cache-action@main
-
-            - name: Apply Nix binary cache configuration
-              run: |
-                  sudo tee -a /etc/nix/nix.conf > /dev/null <<EOF
-                  extra-substituters = https://attic.kennel.juneis.dog/conduit https://attic.kennel.juneis.dog/conduwuit
-                  extra-trusted-public-keys = conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg= conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw=
-                  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 --command true
-
-            - name: Run CI tests
-              run: |
-                  direnv exec . engage > >(tee -a test_output.log)
-
-            - name: Sync Complement repository
-              uses: actions/checkout@v4
-              with:
-                repository: 'matrix-org/complement'
-                path: complement_src
-
-            - name: Run Complement tests
-              run: |
-                  direnv exec . bin/complement 'complement_src' 'complement_test_logs.jsonl' 'complement_test_results.jsonl'
-
-            - name: Upload Complement logs
-              uses: actions/upload-artifact@v4
-              with:
-                name: complement_test_logs.jsonl
-                path: complement_test_logs.jsonl
-                if-no-files-found: error
-
-            - name: Upload Complement results
-              uses: actions/upload-artifact@v4
-              with:
-                name: complement_test_results.jsonl
-                path: complement_test_results.jsonl
-                if-no-files-found: error
-
-            - name: Diff Complement results with checked-in repo results
-            # TODO: figure out why our complement results are not 100% consistent so we don't need to allow failures
-              continue-on-error: true
-              run: |
-                  diff -u --color=always complement_test_results.jsonl tests/test_results/complement/test_results.jsonl > >(tee -a complement_test_output.log)
-
-            - name: Add Complement diff result to Job Summary
-              run: |
-                  echo '# Complement diff results' >> $GITHUB_STEP_SUMMARY
-                  echo '```diff' >> $GITHUB_STEP_SUMMARY
-                  tail -n 50 complement_test_output.log | sed 's/\x1b\[[0-9;]*m//g' >> $GITHUB_STEP_SUMMARY
-                  echo '```' >> $GITHUB_STEP_SUMMARY
-
-            - name: Update Job Summary
-              if: success() || failure()
-              run: |
-                  if [ ${{ job.status }} == 'success' ]; then
-                      echo '# ✅ completed suwuccessfully' >> $GITHUB_STEP_SUMMARY
-                  else
-                      echo '```' >> $GITHUB_STEP_SUMMARY
-                      tail -n 20 test_output.log | sed 's/\x1b\[[0-9;]*m//g' >> $GITHUB_STEP_SUMMARY
-                      echo '```' >> $GITHUB_STEP_SUMMARY
-                  fi
-
-    build:
-        name: Build
-        runs-on: ubuntu-latest
-        needs: tests
-        if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev'
-        strategy:
-            matrix:
-                include:
-                    - target: aarch64-unknown-linux-musl
-                    - target: aarch64-unknown-linux-musl-jemalloc
-                    - target: x86_64-unknown-linux-musl
-                    - target: x86_64-unknown-linux-musl-jemalloc
-        steps:
-            - name: Sync repository
-              uses: actions/checkout@v4
-
-            - name: Install Nix
-              uses: DeterminateSystems/nix-installer-action@main
-
-            - name: Install and enable Cachix binary cache
-              run: |
-                  nix profile install nixpkgs#cachix
-                  cachix use crane
-                  cachix use nix-community
-
-            - name: Configure Magic Nix Cache
-              uses: DeterminateSystems/magic-nix-cache-action@main
-
-            - name: Apply Nix binary cache configuration
-              run: |
-                  sudo tee -a /etc/nix/nix.conf > /dev/null <<EOF
-                  extra-substituters = https://attic.kennel.juneis.dog/conduit https://attic.kennel.juneis.dog/conduwuit
-                  extra-trusted-public-keys = conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg= conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw=
-                  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 --command true
-
-            - name: Build static ${{ matrix.target }}
-              run: |
-                  bin/nix-build-and-cache just .#static-${{ matrix.target }}
-                  mkdir -p target/release
-                  cp -v -f result/bin/conduit target/release/
-                  direnv exec . cargo deb --no-build --no-strip --output target/debian/${{ matrix.target }}.deb
-                  mv target/release/conduit static-${{ matrix.target }}
-
-            - 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: target/debian/${{ matrix.target }}.deb
-                  if-no-files-found: error
-
-            - 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: 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: (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev') && github.event_name != 'pull_request'
-        env:
-            DOCKER_ARM64: docker.io/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}-arm64v8
-            DOCKER_AMD64: docker.io/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}-amd64
-            DOCKER_TAG: docker.io/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}
-            DOCKER_BRANCH: docker.io/${{ github.repository }}:${{ (github.ref == 'refs/heads/main' && 'latest') || github.ref_name }}
-            GHCR_ARM64: ghcr.io/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}-arm64v8
-            GHCR_AMD64: ghcr.io/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}-amd64
-            GHCR_TAG: ghcr.io/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}
-            GHCR_BRANCH: ghcr.io/${{ github.repository }}:${{ (github.ref == 'refs/heads/main' && 'latest') || github.ref_name }}
-            GLCR_ARM64: registry.gitlab.com/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}-arm64v8
-            GLCR_AMD64: registry.gitlab.com/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}-amd64
-            GLCR_TAG: registry.gitlab.com/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}
-            GLCR_BRANCH: registry.gitlab.com/${{ github.repository }}:${{ (github.ref == 'refs/heads/main' && 'latest') || github.ref_name }}
-            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 Docker Hub
-              if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
-              uses: docker/login-action@v3
-              with:
-                  registry: docker.io
-                  username: ${{ vars.DOCKER_USERNAME }}
-                  password: ${{ secrets.DOCKERHUB_TOKEN }}
-
-            - name: Login to GitLab Container Registry
-              if: ${{ (vars.GITLAB_USERNAME != '') && (env.GITLAB_TOKEN != '') }}
-              uses: docker/login-action@v3
-              with:
-                  registry: registry.gitlab.com
-                  username: ${{ vars.GITLAB_USERNAME }}
-                  password: ${{ secrets.GITLAB_TOKEN }}
-
-            - name: Download artifacts
-              uses: actions/download-artifact@v4
-
-            - name: Move OCI images into position
-              run: |
-                  mv oci-image-x86_64-*-jemalloc/*.tar.gz oci-image-amd64.tar.gz
-                  mv oci-image-aarch64-*-jemalloc/*.tar.gz oci-image-arm64v8.tar.gz
-
-            - name: Load and push amd64 image
-              if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
-              run: |
-                  docker load -i oci-image-amd64.tar.gz
-                  docker tag $(docker images -q conduit:main) ${{ env.DOCKER_AMD64 }}
-                  docker tag $(docker images -q conduit:main) ${{ env.GHCR_AMD64 }}
-                  docker tag $(docker images -q conduit:main) ${{ env.GLCR_AMD64 }}
-                  docker push ${{ env.DOCKER_AMD64 }}
-                  docker push ${{ env.GHCR_AMD64 }}
-                  docker push ${{ env.GLCR_AMD64 }}
-
-            - name: Load and push arm64 image
-              if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
-              run: |
-                  docker load -i oci-image-arm64v8.tar.gz
-                  docker tag $(docker images -q conduit:main) ${{ env.DOCKER_ARM64 }}
-                  docker tag $(docker images -q conduit:main) ${{ env.GHCR_ARM64 }}
-                  docker tag $(docker images -q conduit:main) ${{ env.GLCR_ARM64 }}
-                  docker push ${{ env.DOCKER_ARM64 }}
-                  docker push ${{ env.GHCR_ARM64 }}
-                  docker push ${{ env.GLCR_ARM64 }}
-
-            - name: Create Docker combined manifests
-              run: |
-                  # Dockerhub Container Registry
-                  docker manifest create ${{ env.DOCKER_TAG }} --amend ${{ env.DOCKER_ARM64 }} --amend ${{ env.DOCKER_AMD64 }}
-                  docker manifest create ${{ env.DOCKER_BRANCH }} --amend ${{ env.DOCKER_ARM64 }} --amend ${{ env.DOCKER_AMD64 }}
-                  # GitHub Container Registry
-                  docker manifest create ${{ env.GHCR_TAG }} --amend ${{ env.GHCR_ARM64 }} --amend ${{ env.GHCR_AMD64 }}
-                  docker manifest create ${{ env.GHCR_BRANCH }} --amend ${{ env.GHCR_ARM64 }} --amend ${{ env.GHCR_AMD64 }}
-                  # GitLab Container Registry
-                  docker manifest create ${{ env.GLCR_TAG }} --amend ${{ env.GLCR_ARM64 }} --amend ${{ env.GCCR_AMD64 }}
-                  docker manifest create ${{ env.GLCR_BRANCH }} --amend ${{ env.GLCR_ARM64 }} --amend ${{ env.GLCR_AMD64 }}
-
-            - name: Push manifests to Docker registries
-              if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
-              run: |
-                  docker manifest push ${{ env.DOCKER_TAG }}
-                  docker manifest push ${{ env.DOCKER_BRANCH }}
-                  docker manifest push ${{ env.GHCR_TAG }}
-                  docker manifest push ${{ env.GHCR_BRANCH }}
-                  docker manifest push ${{ env.GLCR_TAG }}
-                  docker manifest push ${{ env.GLCR_BRANCH }}
-
-            - name: Add Image Links to Job Summary
-              if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
-              run: |
-                  echo "- \`docker pull ${{ env.DOCKER_TAG }}\`" >> $GITHUB_STEP_SUMMARY
-                  echo "- \`docker pull ${{ env.GHCR_TAG }}\`" >> $GITHUB_STEP_SUMMARY
-                  echo "- \`docker pull ${{ env.GLCR_TAG }}\`" >> $GITHUB_STEP_SUMMARY

.github/workflows/documentation.yml

@@ -1,115 +0,0 @@
-name: Documentation and GitHub Pages
-
-on:
-  pull_request:
-  push:
-    branches:
-      - main
-
-  # 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 }}
-  # Custom nix binary cache if fork is being used
-  ATTIC_ENDPOINT: ${{ vars.ATTIC_ENDPOINT }}
-  ATTIC_PUBLIC_KEY: ${{ vars.ATTIC_PUBLIC_KEY }}
-
-# 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
-
-      - name: Install Nix (with flakes and nix-command enabled)
-        uses: cachix/install-nix-action@v26
-        with:
-          nix_path: nixpkgs=channel:nixos-unstable
-
-          # Add `nix-community`, Crane, upstream Conduit, and conduwuit binary caches
-          extra_nix_config: |
-            experimental-features = nix-command flakes
-            extra-substituters = https://nix-community.cachix.org
-            extra-trusted-public-keys = nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs=
-            extra-substituters = https://crane.cachix.org
-            extra-trusted-public-keys = crane.cachix.org-1:8Scfpmn9w+hGdXH/Q9tTLiYAE/2dnJYRJP7kl80GuRk=
-            extra-substituters = https://attic.kennel.juneis.dog/conduit
-            extra-trusted-public-keys = conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg=
-            extra-substituters = https://attic.kennel.juneis.dog/conduwuit
-            extra-trusted-public-keys = conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw=
-
-      - name: Add alternative Nix binary caches if specified
-        if: ${{ (env.ATTIC_ENDPOINT != '') && (env.ATTIC_PUBLIC_KEY != '') }}
-        run: |
-          echo "extra-substituters = ${{ env.ATTIC_ENDPOINT }}" >> /etc/nix/nix.conf
-          echo "extra-trusted-public-keys = ${{ env.ATTIC_PUBLIC_KEY }}" >> /etc/nix/nix.conf
-
-      - name: Pop/push Magic Nix Cache
-        uses: DeterminateSystems/magic-nix-cache-action@main
-
-      - name: Configure `nix-direnv`
-        run: |
-          echo 'source $HOME/.nix-profile/share/nix-direnv/direnvrc' > "$HOME/.direnvrc"
-
-      - name: Install `direnv` and `nix-direnv`
-        run: nix-env -f "<nixpkgs>" -iA direnv -iA nix-direnv
-
-      # Do this to shorten the logs for the real CI step
-      - name: Populate `/nix/store`
-        run: nix develop --command true
-
-      - name: Allow direnv
-        run: direnv allow
-
-      - name: Cache CI dependencies
-        run: |
-          ./bin/nix-build-and-cache ci
-
-      - 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

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

.gitignore

@@ -1,3 +1,6 @@
+# Local environment overrides
+/.env
+
 # CMake
 cmake-build-*/
 
@@ -27,7 +30,7 @@ modules.xml
 .nfs*
 
 # Rust
-/target/
+/target
 
 ### vscode ###
 .vscode/*

.gitlab-ci.yml

@@ -1,140 +0,0 @@
-stages:
-  - ci
-  - artifacts
-  - publish
-
-variables:
-  # Makes some things print in color
-  TERM: ansi
-  # Faster cache and artifact compression / decompression
-  FF_USE_FASTZIP: true
-  # Print progress reports for cache and artifact transfers
-  TRANSFER_METER_FREQUENCY: 5s
-
-# Avoid duplicate pipelines
-# See: https://docs.gitlab.com/ee/ci/yaml/workflow.html#switch-between-branch-pipelines-and-merge-request-pipelines
-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:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw=" >> /etc/nix/nix.conf; fi
-
-  - if command -v nix > /dev/null; then echo "extra-substituters = https://attic.kennel.juneis.dog/conduit" >> /etc/nix/nix.conf; fi
-  - if command -v nix > /dev/null; then echo "extra-trusted-public-keys = conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg=" >> /etc/nix/nix.conf; fi
-
-  # Add 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 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; fi
-
-  # Allow .envrc
-  - if command -v nix > /dev/null; then direnv allow; fi
-
-  # Set CARGO_HOME to a cacheable path
-  - export CARGO_HOME="$(git rev-parse --show-toplevel)/.gitlab-ci.d/cargo"
-
-ci:
-  stage: ci
-  image: nixos/nix:2.22.0
-  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
-
-artifacts:
-  stage: artifacts
-  image: nixos/nix:2.22.0
-  script:
-    - ./bin/nix-build-and-cache just .#static-x86_64-unknown-linux-musl
-    - cp result/bin/conduit x86_64-unknown-linux-musl
-
-    - mkdir -p target/release
-    - cp result/bin/conduit target/release
-    - direnv exec . cargo deb --no-build --no-strip
-    - mv target/debian/*.deb x86_64-unknown-linux-musl.deb
-
-    # Since the OCI image package is based on the binary package, this has the
-    # fun side effect of uploading the normal binary too. Conduit users who are
-    # deploying with Nix can leverage this fact by adding our binary cache to
-    # their systems.
-    #
-    # Note that although we have an `oci-image-x86_64-unknown-linux-musl`
-    # output, we don't build it because it would be largely redundant to this
-    # one since it's all containerized anyway.
-    - ./bin/nix-build-and-cache just .#oci-image
-    - cp result oci-image-amd64.tar.gz
-
-    - ./bin/nix-build-and-cache just .#static-aarch64-unknown-linux-musl
-    - cp result/bin/conduit aarch64-unknown-linux-musl
-
-    - ./bin/nix-build-and-cache just .#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
-
-pages:
-  stage: publish
-  dependencies:
-    - artifacts
-  only:
-    - next
-  script:
-    - "true"
-  artifacts:
-    paths:
-      - public

.gitlab/merge_request_templates/MR.md

@@ -1,8 +0,0 @@
-
-<!-- Please describe your changes here -->
-
------------------------------------------------------------------------------
-
-- [ ] I ran `cargo fmt`, `cargo clippy`, and `cargo test`
-- [ ] I agree to release my code and all other changes of this MR under the Apache-2.0 license
-

.gitlab/route-map.yml

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

.mailmap

@@ -0,0 +1,15 @@
+AlexPewMaster <git@alex.unbox.at> <68469103+AlexPewMaster@users.noreply.github.com>
+Daniel Wiesenberg <weasy@hotmail.de> <weasy666@gmail.com>
+Devin Ragotzy <devin.ragotzy@gmail.com> <d6ragotzy@wmich.edu>
+Devin Ragotzy <devin.ragotzy@gmail.com> <dragotzy7460@mail.kvcc.edu>
+Jonas Platte <jplatte+git@posteo.de> <jplatte+gitlab@posteo.de>
+Jonas Zohren <git-pbkyr@jzohren.de> <gitlab-jfowl-0ux98@sh14.de>
+Jonathan de Jong <jonathan@automatia.nl> <jonathandejong02@gmail.com>
+June Clementine Strawberry <june@3.dog> <june@girlboss.ceo>
+June Clementine Strawberry <june@3.dog> <strawberry@pupbrain.dev>
+June Clementine Strawberry <june@3.dog> <strawberry@puppygock.gay>
+Olivia Lee <olivia@computer.surgery> <benjamin@computer.surgery>
+Rudi Floren <rudi.floren@gmail.com> <rudi.floren@googlemail.com>
+Tamara Schmitz <tamara.zoe.schmitz@posteo.de> <15906939+tamara-schmitz@users.noreply.github.com>
+Timo Kösters <timo@koesters.xyz>
+x4u <xi.zhu@protonmail.ch> <14617923-x4u@users.noreply.gitlab.com>

.markdownlintignore

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

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+    "cSpell.words": [
+        "Forgejo",
+        "appservice",
+        "appservices",
+        "conduwuit",
+        "continuwuity",
+        "homeserver",
+        "homeservers"
+    ]
+}

CODE_OF_CONDUCT.md

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

CONTRIBUTING.md

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

README.md

@@ -1,76 +1,113 @@
-# conduwuit
-
-`main` / stable: [![CI and Artifacts](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml)
-
-`dev`: [![CI and Artifacts](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml/badge.svg?branch=dev)](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml)
+# continuwuity
 
 <!-- ANCHOR: catchphrase -->
-### a very cool, featureful fork of [Conduit](https://conduit.rs/)
+
+## A community-driven [Matrix](https://matrix.org/) homeserver in Rust
+
 <!-- ANCHOR_END: catchphrase -->
 
-Visit the [Conduwuit documentation](https://conduwuit.puppyirl.gay/) for more information.
+[continuwuity] is a Matrix homeserver written in Rust.
+It's a community continuation of the [conduwuit](https://github.com/girlbossceo/conduwuit) homeserver. 
 
 <!-- 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)
-to communicate with users outside of Matrix, like a community on Discord.
 
-#### What is the goal?
+### Why does this exist?
 
-An efficient Matrix homeserver that's easy to set up and just works. You can install
-it on a mini-computer like the Raspberry Pi to host Matrix for your family,
-friends or company.
+The original conduwuit project has been archived and is no longer maintained. Rather than letting this Rust-based Matrix homeserver disappear, a group of community contributors have forked the project to continue its development, fix outstanding issues, and add new features.
 
-#### Can I try it out?
+We aim to provide a stable, well-maintained alternative for current Conduit users and welcome newcomers seeking a lightweight, efficient Matrix homeserver.
 
-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))
+### Who are we?
 
-#### What is the current status?
+We are a group of Matrix enthusiasts, developers and system administrators who have used conduwuit and believe in its potential. Our team includes both previous
+contributors to the original project and new developers who want to help maintain and improve this important piece of Matrix infrastructure.
 
-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.
+We operate as an open community project, welcoming contributions from anyone interested in improving continuwuity.
+
+### What is Matrix?
+
+[Matrix](https://matrix.org) is an open, federated, and extensible network for
+decentralized communication. Users from any Matrix homeserver can chat with users from all
+other homeservers over federation. Matrix is designed to be extensible and built on top of.
+You can even use bridges such as Matrix Appservices to communicate with users outside of Matrix, like a community on Discord.
+
+### What are the project's goals?
+
+Continuwuity aims to:
+
+- Maintain a stable, reliable Matrix homeserver implementation in Rust
+- Improve compatibility and specification compliance with the Matrix protocol
+- Fix bugs and performance issues from the original conduwuit
+- Add missing features needed by homeserver administrators
+- Provide comprehensive documentation and easy deployment options
+- Create a sustainable development model for long-term maintenance
+- Keep a lightweight, efficient codebase that can run on modest hardware
+
+### Can I try it out?
+
+Not right now. We've still got work to do!
+
+
+### What are we working on?
+
+We're working our way through all of the issues in the [Forgejo project](https://forgejo.ellis.link/continuwuation/continuwuity/issues).
+
+- [Replacing old conduwuit links with working continuwuity links](https://forgejo.ellis.link/continuwuation/continuwuity/issues/742)
+- [Getting CI and docs deployment working on the new Forgejo project](https://forgejo.ellis.link/continuwuation/continuwuity/issues/740)
+- [Packaging & availability in more places](https://forgejo.ellis.link/continuwuation/continuwuity/issues/747)
+- [Appservices bugs & features](https://forgejo.ellis.link/continuwuation/continuwuity/issues?q=&type=all&state=open&labels=178&milestone=0&assignee=0&poster=0)
+- [Improving compatibility and spec compliance](https://forgejo.ellis.link/continuwuation/continuwuity/issues?labels=119)
+- Automated testing
+- [Admin API](https://forgejo.ellis.link/continuwuation/continuwuity/issues/748)
+- [Policy-list controlled moderation](https://forgejo.ellis.link/continuwuation/continuwuity/issues/750)
+
+### Can I migrate my data from x?
+
+- Conduwuit: Yes
+- Conduit: No, database is now incompatible
+- Grapevine: No, database is now incompatible
+- Dendrite: No
+- Synapse: No
+
+We haven't written up a guide on migrating from incompatible homeservers yet. Reach out to us if you need to do this!
 
 <!-- ANCHOR_END: body -->
 
-<!-- ANCHOR: footer -->
-#### How can I contribute?
+## Contribution
 
-1. Look for an issue you would like to work on and make sure it's not assigned
-   to other users
-2. Ask someone to assign the issue to you (comment on the issue or chat in
-   [#conduwuit:puppygock.gay](https://matrix.to/#/#conduwuit:puppygock.gay))
-3. Fork the repo and work on the issue.
-4. Submit a PR (please keep contributions to the GitHub repo, main development is done here, not the GitLab repo which exists just as a mirror. If you are avoiding GitHub, feel free to join our Matrix chat to get your patch in.)
+### Development flow
+
+- Features / changes must developed in a separate branch
+- For each change, create a descriptive PR
+- Your code will be reviewed by one or more of the continuwuity developers
+- The branch will be deployed live on multiple tester's matrix servers to shake out bugs
+- Once all testers and reviewers have agreed, the PR will be merged to the main branch
+- The main branch will have nightly builds deployed to users on the cutting edge
+- Every week or two, a new release is cut.
+
+The main branch is always green!
+
+
+### Policy on pulling from other forks
+
+We welcome contributions from other forks of conduwuit, subject to our review process.
+When incorporating code from other forks:
+
+- All external contributions must go through our standard PR process
+- Code must meet our quality standards and pass tests
+- Code changes will require testing on multiple test servers before merging
+- Attribution will be given to original authors and forks
+- We prioritize stability and compatibility when evaluating external contributions
+- Features that align with our project goals will be given priority consideration
+
+<!-- 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)
+<!-- TODO: contact details -->
 
-#### Donate
-
-- Liberapay: <https://liberapay.com/girlbossceo>
-- Ko-fi: <https://ko-fi.com/puppygock>
-- GitHub Sponsors: <https://github.com/sponsors/girlbossceo>
-
-#### Logo
-
-Original repo and Matrix room picture was from bran (<3). Current banner image and logo is directly from [this cohost post](https://cohost.org/RatBaby/post/1028290-finally-a-flag-for).
-
-#### 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>
 <!-- ANCHOR_END: footer -->
+
+
+[continuwuity]: https://forgejo.ellis.link/continuwuation/continuwuity

arch/conduwuit.service

@@ -0,0 +1,77 @@
+[Unit]
+Description=conduwuit Matrix homeserver
+Wants=network-online.target
+After=network-online.target
+Documentation=https://conduwuit.puppyirl.gay/
+RequiresMountsFor=/var/lib/private/conduwuit
+Alias=matrix-conduwuit.service
+
+[Service]
+DynamicUser=yes
+Type=notify-reload
+ReloadSignal=SIGUSR1
+
+TTYPath=/dev/tty25
+DeviceAllow=char-tty
+StandardInput=tty-force
+StandardOutput=tty
+StandardError=journal+console
+TTYReset=yes
+# uncomment to allow buffer to be cleared every restart
+TTYVTDisallocate=no
+
+TTYColumns=120
+TTYRows=40
+
+AmbientCapabilities=
+CapabilityBoundingSet=
+
+DevicePolicy=closed
+LockPersonality=yes
+MemoryDenyWriteExecute=yes
+NoNewPrivileges=yes
+#ProcSubset=pid
+ProtectClock=yes
+ProtectControlGroups=yes
+ProtectHome=yes
+ProtectHostname=yes
+ProtectKernelLogs=yes
+ProtectKernelModules=yes
+ProtectKernelTunables=yes
+ProtectProc=invisible
+ProtectSystem=strict
+PrivateDevices=yes
+PrivateMounts=yes
+PrivateTmp=yes
+PrivateUsers=yes
+PrivateIPC=yes
+RemoveIPC=yes
+RestrictAddressFamilies=AF_INET AF_INET6 AF_UNIX
+RestrictNamespaces=yes
+RestrictRealtime=yes
+RestrictSUIDSGID=yes
+SystemCallArchitectures=native
+SystemCallFilter=@system-service @resources
+SystemCallFilter=~@clock @debug @module @mount @reboot @swap @cpu-emulation @obsolete @timer @chown @setuid @privileged @keyring @ipc
+SystemCallErrorNumber=EPERM
+StateDirectory=conduwuit
+
+RuntimeDirectory=conduwuit
+RuntimeDirectoryMode=0750
+
+Environment="CONDUWUIT_CONFIG=/etc/conduwuit/conduwuit.toml"
+BindPaths=/var/lib/private/conduwuit:/var/lib/matrix-conduit
+BindPaths=/var/lib/private/conduwuit:/var/lib/private/matrix-conduit
+
+ExecStart=/usr/bin/conduwuit
+Restart=on-failure
+RestartSec=5
+
+TimeoutStopSec=4m
+TimeoutStartSec=4m
+
+StartLimitInterval=1m
+StartLimitBurst=5
+
+[Install]
+WantedBy=multi-user.target

audit.toml

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

bin/complement

@@ -7,34 +7,68 @@ set -euo pipefail
 # The `COMPLEMENT_SRC` environment variable is set in the Nix dev shell, which
 # points to a store path containing the Complement source code. It's likely you
 # want to just pass that as the first argument to use it here.
-COMPLEMENT_SRC="$1"
+COMPLEMENT_SRC="${COMPLEMENT_SRC:-$1}"
 
 # A `.jsonl` file to write test logs to
-LOG_FILE="$2"
+LOG_FILE="${2:-complement_test_logs.jsonl}"
 
 # A `.jsonl` file to write test results to
-RESULTS_FILE="$3"
+RESULTS_FILE="${3:-complement_test_results.jsonl}"
 
-OCI_IMAGE="complement-conduit:dev"
+COMPLEMENT_BASE_IMAGE="${COMPLEMENT_BASE_IMAGE:-complement-conduwuit:main}"
+
+# Complement tests that are skipped due to flakiness/reliability issues or we don't implement such features and won't for a long time
+SKIPPED_COMPLEMENT_TESTS='TestPartialStateJoin.*|TestRoomDeleteAlias/Parallel/Regular_users_can_add_and_delete_aliases_when_m.*|TestRoomDeleteAlias/Parallel/Can_delete_canonical_alias|TestUnbanViaInvite.*|TestRoomState/Parallel/GET_/publicRooms_lists.*"|TestRoomDeleteAlias/Parallel/Users_with_sufficient_power-level_can_delete_other.*'
+
+# $COMPLEMENT_SRC needs to be a directory to Complement source code
+if [ -f "$COMPLEMENT_SRC" ]; then
+    echo "\$COMPLEMENT_SRC must be a directory/path to Complement source code"
+    exit 1
+fi
+
+# quick test to make sure we can actually write to $LOG_FILE and $RESULTS_FILE
+touch $LOG_FILE && rm -v $LOG_FILE
+touch $RESULTS_FILE && rm -v $RESULTS_FILE
 
 toplevel="$(git rev-parse --show-toplevel)"
 
 pushd "$toplevel" > /dev/null
-# uses nix-output-monitor (nom) if available
-if command -v nom &> /dev/null; then
-    nom build .#complement
+
+if [ ! -f "complement_oci_image.tar.gz" ]; then
+    echo "building complement conduwuit image"
+
+    # if using macOS, use linux-complement
+    #bin/nix-build-and-cache just .#linux-complement
+    bin/nix-build-and-cache just .#complement
+    #nix build -L .#complement
+
+    echo "complement conduwuit image tar.gz built at \"result\""
+
+    echo "loading into docker"
+    docker load < result
+    popd > /dev/null
 else
-    nix build -L .#complement
+    echo "skipping building a complement conduwuit image as complement_oci_image.tar.gz was already found, loading this"
+
+    docker load < complement_oci_image.tar.gz
+    popd > /dev/null
 fi
-docker load < result
-popd > /dev/null
+
+echo ""
+echo "running go test with:"
+echo "\$COMPLEMENT_SRC: $COMPLEMENT_SRC"
+echo "\$COMPLEMENT_BASE_IMAGE: $COMPLEMENT_BASE_IMAGE"
+echo "\$RESULTS_FILE: $RESULTS_FILE"
+echo "\$LOG_FILE: $LOG_FILE"
+echo ""
 
 # It's okay (likely, even) that `go test` exits nonzero
+# `COMPLEMENT_ENABLE_DIRTY_RUNS=1`  reuses the same complement container for faster complement, at the possible expense of test environment pollution
 set +o pipefail
 env \
     -C "$COMPLEMENT_SRC" \
-    COMPLEMENT_BASE_IMAGE="$OCI_IMAGE" \
-    go test -vet=off -timeout 1h -json ./tests | tee "$LOG_FILE"
+    COMPLEMENT_BASE_IMAGE="$COMPLEMENT_BASE_IMAGE" \
+    go test -tags="conduwuit_blacklist" -skip="$SKIPPED_COMPLEMENT_TESTS" -v -timeout 1h -json ./tests/... | tee "$LOG_FILE"
 set -o pipefail
 
 # Post-process the results into an easy-to-compare format, sorted by Test name for reproducible results
@@ -44,3 +78,18 @@ cat "$LOG_FILE" | jq -s -c 'sort_by(.Test)[]' | jq -c '
         and .Test != null
     ) | {Action: .Action, Test: .Test}
     ' > "$RESULTS_FILE"
+
+#if command -v gotestfmt &> /dev/null; then
+#    echo "using gotestfmt on $LOG_FILE"
+#    grep '{"Time":' "$LOG_FILE" | gotestfmt > "complement_test_logs_gotestfmt.log"
+#fi
+
+echo ""
+echo ""
+echo "complement logs saved at $LOG_FILE"
+echo "complement results saved at $RESULTS_FILE"
+#if command -v gotestfmt &> /dev/null; then
+#    echo "complement logs in gotestfmt pretty format outputted at complement_test_logs_gotestfmt.log (use an editor/terminal/pager that interprets ANSI colours and UTF-8 emojis)"
+#fi
+echo ""
+echo ""

bin/nix-build-and-cache

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

book.toml

@@ -1,18 +1,27 @@
 [book]
-title = "conduwuit"
+title = "conduwuit 🏳️‍⚧️ 💜 🦴"
 description = "conduwuit, which is a well-maintained fork of Conduit, is a simple, fast and reliable chat server for the Matrix protocol"
 language = "en"
+authors = ["strawberry (June)"]
+text-direction = "ltr"
 multilingual = false
 src = "docs"
 
 [build]
 build-dir = "public"
 create-missing = true
+extra-watch-dirs = ["debian", "docs"]
+
+[rust]
+edition = "2024"
 
 [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.redirect]
+"/differences.html" = "https://conduwuit.puppyirl.gay/#where-is-the-differences-page"
+
 [output.html.search]
 limit-results = 15

clippy.toml

@@ -1 +1,20 @@
-too-many-lines-threshold = 700
+array-size-threshold = 4096
+cognitive-complexity-threshold = 94         # TODO reduce me ALARA
+excessive-nesting-threshold = 11            # TODO reduce me to 4 or 5
+future-size-threshold = 7745                # TODO reduce me ALARA
+stack-size-threshold = 196608               # TODO reduce me ALARA
+too-many-lines-threshold = 780              # TODO reduce me to <= 100
+type-complexity-threshold = 250             # reduce me to ~200
+large-error-threshold = 256                 # TODO reduce me ALARA
+
+disallowed-macros = [
+	{ path = "log::error", reason = "use conduwuit_core::error" },
+	{ path = "log::warn", reason = "use conduwuit_core::warn" },
+	{ path = "log::info", reason = "use conduwuit_core::info" },
+	{ path = "log::debug", reason = "use conduwuit_core::debug" },
+	{ path = "log::trace", reason = "use conduwuit_core::trace" },
+]
+
+disallowed-methods = [
+    { path = "tokio::spawn", reason = "use and pass conduuwit_core::server::Server::runtime() to spawn from" },
+]

debian/README.md

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

debian/conduwuit.service

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

debian/config

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

debian/postinst

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

debian/postrm

@@ -1,25 +1,42 @@
 #!/bin/sh
 set -e
 
-. /usr/share/debconf/confmodule
+#. /usr/share/debconf/confmodule
 
 CONDUWUIT_CONFIG_PATH=/etc/conduwuit
 CONDUWUIT_DATABASE_PATH=/var/lib/conduwuit
+CONDUWUIT_DATABASE_PATH_SYMLINK=/var/lib/matrix-conduit
 
 case $1 in
   purge)
     # Remove debconf changes from the db
-    db_purge
+    #db_purge
 
     # 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 "$CONDUWUIT_CONFIG_PATH" ]; then
-      rm -r "$CONDUWUIT_CONFIG_PATH"
+      if test -L "$CONDUWUIT_CONFIG_PATH"; then
+        echo "Deleting conduwuit configuration files"
+        rm -v -r "$CONDUWUIT_CONFIG_PATH"
+      fi
     fi
 
     if [ -d "$CONDUWUIT_DATABASE_PATH" ]; then
-      rm -r "$CONDUWUIT_DATABASE_PATH"
+      if test -L "$CONDUWUIT_DATABASE_PATH"; then
+        echo "Deleting conduwuit database directory"
+        rm -r "$CONDUWUIT_DATABASE_PATH"
+      fi
+    fi
+
+    if [ -d "$CONDUWUIT_DATABASE_PATH_SYMLINK" ]; then
+      if test -L "$CONDUWUIT_DATABASE_SYMLINK"; then
+        echo "Removing matrix-conduit symlink"
+        rm -r "$CONDUWUIT_DATABASE_PATH_SYMLINK"
+      fi
     fi
     ;;
 esac

debian/templates

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

development.md

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

docs/SUMMARY.md

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

docs/appservices.md

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

docs/assets/conduwuit_logo.svg

@@ -0,0 +1,36 @@
+<svg
+  version="1.1"
+  id="Layer_1"
+  xmlns="http://www.w3.org/2000/svg"
+  x="0px"
+  y="0px"
+  width="100%"
+  viewBox="0 0 864 864"
+  enableBackground="new 0 0 864 864"
+  xmlSpace="preserve"
+>
+  <path
+    fill="#EC008C"
+    opacity="1.000000"
+    stroke="none"
+    d="M0.999997,649.000000 C1.000000,433.052795 1.000000,217.105591 1.000000,1.079198 C288.876801,1.079198 576.753601,1.079198 865.000000,1.079198 C865.000000,73.025414 865.000000,145.051453 864.634888,217.500671 C852.362488,223.837280 840.447632,229.735275 828.549438,235.666794 C782.143677,258.801056 735.743225,281.945923 688.998657,304.980469 C688.122009,304.476532 687.580750,304.087708 687.053894,303.680206 C639.556946,266.944733 573.006775,291.446869 560.804199,350.179443 C560.141357,353.369446 559.717590,356.609131 559.195374,359.748962 C474.522705,359.748962 390.283478,359.748962 306.088135,359.748962 C298.804138,318.894806 265.253357,295.206024 231.834442,293.306793 C201.003021,291.554596 169.912033,310.230042 156.935104,338.792725 C149.905151,354.265930 147.884064,370.379944 151.151794,387.034515 C155.204453,407.689667 166.300507,423.954224 183.344437,436.516663 C181.938263,437.607025 180.887405,438.409576 179.849426,439.228516 C147.141953,465.032562 139.918045,510.888947 163.388611,545.322632 C167.274551,551.023804 172.285187,555.958313 176.587341,561.495728 C125.846893,587.012817 75.302292,612.295532 24.735992,637.534790 C16.874903,641.458496 8.914484,645.183228 0.999997,649.000000 z"
+  />
+  <path
+    fill="#000000"
+    opacity="1.000000"
+    stroke="none"
+    d="M689.340759,305.086823 C735.743225,281.945923 782.143677,258.801056 828.549438,235.666794 C840.447632,229.735275 852.362488,223.837280 864.634888,217.961929 C865.000000,433.613190 865.000000,649.226379 865.000000,864.919800 C577.000000,864.919800 289.000000,864.919800 1.000000,864.919800 C1.000000,793.225708 1.000000,721.576721 0.999997,649.463867 C8.914484,645.183228 16.874903,641.458496 24.735992,637.534790 C75.302292,612.295532 125.846893,587.012817 176.939667,561.513062 C178.543060,562.085083 179.606812,562.886414 180.667526,563.691833 C225.656799,597.853394 291.232574,574.487244 304.462524,519.579773 C304.989105,517.394409 305.501068,515.205505 305.984619,513.166748 C391.466370,513.166748 476.422729,513.166748 561.331177,513.166748 C573.857727,555.764343 608.978149,572.880920 638.519897,572.672791 C671.048340,572.443665 700.623230,551.730408 711.658752,520.910583 C722.546875,490.502106 715.037842,453.265564 682.776733,429.447052 C683.966064,428.506866 685.119507,427.602356 686.265320,426.688232 C712.934143,405.412262 723.011475,370.684631 711.897339,338.686676 C707.312805,325.487671 699.185303,314.725128 689.340759,305.086823 z"
+  />
+  <path
+    fill="#FEFBFC"
+    opacity="1.000000"
+    stroke="none"
+    d="M688.998657,304.980469 C699.185303,314.725128 707.312805,325.487671 711.897339,338.686676 C723.011475,370.684631 712.934143,405.412262 686.265320,426.688232 C685.119507,427.602356 683.966064,428.506866 682.776733,429.447052 C715.037842,453.265564 722.546875,490.502106 711.658752,520.910583 C700.623230,551.730408 671.048340,572.443665 638.519897,572.672791 C608.978149,572.880920 573.857727,555.764343 561.331177,513.166748 C476.422729,513.166748 391.466370,513.166748 305.984619,513.166748 C305.501068,515.205505 304.989105,517.394409 304.462524,519.579773 C291.232574,574.487244 225.656799,597.853394 180.667526,563.691833 C179.606812,562.886414 178.543060,562.085083 177.128418,561.264465 C172.285187,555.958313 167.274551,551.023804 163.388611,545.322632 C139.918045,510.888947 147.141953,465.032562 179.849426,439.228516 C180.887405,438.409576 181.938263,437.607025 183.344437,436.516663 C166.300507,423.954224 155.204453,407.689667 151.151794,387.034515 C147.884064,370.379944 149.905151,354.265930 156.935104,338.792725 C169.912033,310.230042 201.003021,291.554596 231.834442,293.306793 C265.253357,295.206024 298.804138,318.894806 306.088135,359.748962 C390.283478,359.748962 474.522705,359.748962 559.195374,359.748962 C559.717590,356.609131 560.141357,353.369446 560.804199,350.179443 C573.006775,291.446869 639.556946,266.944733 687.053894,303.680206 C687.580750,304.087708 688.122009,304.476532 688.998657,304.980469 M703.311279,484.370789 C698.954468,457.053253 681.951416,440.229645 656.413696,429.482330 C673.953552,421.977875 688.014709,412.074219 696.456482,395.642365 C704.862061,379.280853 706.487793,362.316345 700.947998,344.809204 C691.688965,315.548492 664.183716,296.954437 633.103516,298.838257 C618.467957,299.725372 605.538086,305.139557 594.588501,314.780121 C577.473999,329.848511 570.185486,349.121399 571.838501,371.750854 C479.166595,371.750854 387.082886,371.750854 294.582672,371.750854 C293.993011,354.662048 288.485260,339.622314 276.940491,327.118439 C265.392609,314.611176 251.082092,307.205322 234.093262,305.960541 C203.355347,303.708374 176.337585,320.898438 166.089890,348.816620 C159.557541,366.613007 160.527206,384.117401 168.756042,401.172516 C177.054779,418.372589 191.471954,428.832886 207.526581,435.632172 C198.407059,442.272583 188.815598,448.302246 180.383728,455.660675 C171.685028,463.251984 166.849655,473.658661 163.940216,484.838684 C161.021744,496.053375 161.212982,507.259705 164.178833,518.426208 C171.577927,546.284302 197.338104,566.588867 226.001465,567.336853 C240.828415,567.723816 254.357819,563.819092 266.385468,555.199646 C284.811554,541.994751 293.631104,523.530579 294.687347,501.238312 C387.354828,501.238312 479.461304,501.238312 571.531799,501.238312 C577.616638,543.189026 615.312866,566.342102 651.310059,559.044739 C684.973938,552.220398 708.263306,519.393127 703.311279,484.370789 z"
+  />
+  <path
+    fill="#EC008C"
+    opacity="1.000000"
+    stroke="none"
+    d="M703.401855,484.804718 C708.263306,519.393127 684.973938,552.220398 651.310059,559.044739 C615.312866,566.342102 577.616638,543.189026 571.531799,501.238312 C479.461304,501.238312 387.354828,501.238312 294.687347,501.238312 C293.631104,523.530579 284.811554,541.994751 266.385468,555.199646 C254.357819,563.819092 240.828415,567.723816 226.001465,567.336853 C197.338104,566.588867 171.577927,546.284302 164.178833,518.426208 C161.212982,507.259705 161.021744,496.053375 163.940216,484.838684 C166.849655,473.658661 171.685028,463.251984 180.383728,455.660675 C188.815598,448.302246 198.407059,442.272583 207.526581,435.632172 C191.471954,428.832886 177.054779,418.372589 168.756042,401.172516 C160.527206,384.117401 159.557541,366.613007 166.089890,348.816620 C176.337585,320.898438 203.355347,303.708374 234.093262,305.960541 C251.082092,307.205322 265.392609,314.611176 276.940491,327.118439 C288.485260,339.622314 293.993011,354.662048 294.582672,371.750854 C387.082886,371.750854 479.166595,371.750854 571.838501,371.750854 C570.185486,349.121399 577.473999,329.848511 594.588501,314.780121 C605.538086,305.139557 618.467957,299.725372 633.103516,298.838257 C664.183716,296.954437 691.688965,315.548492 700.947998,344.809204 C706.487793,362.316345 704.862061,379.280853 696.456482,395.642365 C688.014709,412.074219 673.953552,421.977875 656.413696,429.482330 C681.951416,440.229645 698.954468,457.053253 703.401855,484.804718 z"
+  />
+</svg>

docs/conduwuit_coc.md

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

docs/configuration.md

@@ -1,5 +1,64 @@
-# Example configuration
+# Configuration
 
-``` toml
-{{#include ../conduwuit-example.toml}}
+This chapter describes various ways to configure conduwuit.
+
+## Basics
+
+conduwuit uses a config file for the majority of the settings, but also supports
+setting individual config options via commandline.
+
+Please refer to the [example config
+file](./configuration/examples.md#example-configuration) for all of those
+settings.
+
+The config file to use can be specified on the commandline when running
+conduwuit by specifying the `-c`, `--config` flag. Alternatively, you can use
+the environment variable `CONDUWUIT_CONFIG` to specify the config file to used.
+Conduit's environment variables are supported for backwards compatibility.
+
+## Option commandline flag
+
+conduwuit supports setting individual config options in TOML format from the
+`-O` / `--option` flag. For example, you can set your server name via `-O
+server_name=\"example.com\"`.
+
+Note that the config is parsed as TOML, and shells like bash will remove quotes.
+So unfortunately it is required to escape quotes if the config option takes a
+string. This does not apply to options that take booleans or numbers:
+- `--option allow_registration=true` works ✅
+- `-O max_request_size=99999999` works ✅
+- `-O server_name=example.com` does not work ❌
+- `--option log=\"debug\"` works ✅
+- `--option server_name='"example.com'"` works ✅
+
+## Execute commandline flag
+
+conduwuit supports running admin commands on startup using the commandline
+argument `--execute`. The most notable use for this is to create an admin user
+on first startup.
+
+The syntax of this is a standard admin command without the prefix such as
+`./conduwuit --execute "users create_user june"`
+
+An example output of a success is:
 ```
+INFO conduwuit_service::admin::startup: Startup command #0 completed:
+Created user with user_id: @june:girlboss.ceo and password: `<redacted>`
+```
+
+This commandline argument can be paired with the `--option` flag.
+
+## Environment variables
+
+All of the settings that are found in the config file can be specified by using
+environment variables. The environment variable names should be all caps and
+prefixed with `CONDUWUIT_`.
+
+For example, if the setting you are changing is `max_request_size`, then the
+environment variable to set is `CONDUWUIT_MAX_REQUEST_SIZE`.
+
+To modify config options not in the `[global]` context such as
+`[global.well_known]`, use the `__` suffix split: `CONDUWUIT_WELL_KNOWN__SERVER`
+
+Conduit's environment variables are supported for backwards compatibility (e.g.
+`CONDUIT_SERVER_NAME`).

docs/configuration/examples.md

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

docs/contributing.md

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

docs/deploying.md

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

docs/deploying/arch-linux.md

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

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

@@ -1,54 +1,48 @@
-# Conduit - Behind Traefik Reverse Proxy
-version: '2.4' # uses '2.4' for cpuset
+# conduwuit - Behind Traefik Reverse Proxy
 
 services:
-    homeserver:
-        ### If you already built the Conduit image with 'docker build' or want to use the Docker Hub image,
-        ### then you are ready to go.
-        image: girlbossceo/conduwuit:latest
-        ### If you want to build a fresh image from the sources, then comment the image line and uncomment the
-        ### build lines. If you want meaningful labels in your built Conduit image, you should run docker compose like this:
-        ### CREATED=$(date -u +'%Y-%m-%dT%H:%M:%SZ') VERSION=$(grep -m1 -o '[0-9].[0-9].[0-9]' Cargo.toml) docker compose up -d
-        # build:
-        #     context: .
-        #     args:
-        #         CREATED: '2021-03-16T08:18:27Z'
-        #         VERSION: '0.1.0'
-        #         LOCAL: 'false'
-        #         GIT_REF: origin/master
-        restart: unless-stopped
-        volumes:
-            - db:/var/lib/matrix-conduit
-            #- ./conduwuit.toml:/etc/conduit.toml
-        networks:
-            - proxy
-        environment:
-            CONDUIT_SERVER_NAME: your.server.name # EDIT THIS
-            CONDUIT_DATABASE_PATH: /var/lib/matrix-conduit
-            CONDUIT_DATABASE_BACKEND: rocksdb
-            CONDUIT_PORT: 6167
-            CONDUIT_MAX_REQUEST_SIZE: 20_000_000 # in bytes, ~20 MB
-            CONDUIT_ALLOW_REGISTRATION: 'true'
-            CONDUIT_ALLOW_FEDERATION: 'true'
-            CONDUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
-            CONDUIT_TRUSTED_SERVERS: '["matrix.org"]'
-            #CONDUIT_LOG: warn,state_res=warn
-            CONDUIT_ADDRESS: 0.0.0.0
-            #CONDUIT_CONFIG: './conduwuit.toml' # Uncomment if you mapped config toml above
-        #cpuset: "0-4" # Uncomment to limit to specific CPU cores
+  homeserver:
+    ### If you already built the conduduwit image with 'docker build' or want to use the Docker Hub image,
+    ### then you are ready to go.
+    image: girlbossceo/conduwuit:latest
+    restart: unless-stopped
+    volumes:
+      - db:/var/lib/conduwuit
+      #- ./conduwuit.toml:/etc/conduwuit.toml
+    networks:
+      - proxy
+    environment:
+      CONDUWUIT_SERVER_NAME: your.server.name.example # EDIT THIS
+      CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit
+      CONDUWUIT_PORT: 6167 # should match the loadbalancer traefik label
+      CONDUWUIT_MAX_REQUEST_SIZE: 20000000 # in bytes, ~20 MB
+      CONDUWUIT_ALLOW_REGISTRATION: 'true'
+      CONDUWUIT_REGISTRATION_TOKEN: 'YOUR_TOKEN' # A registration token is required when registration is allowed.
+      #CONDUWUIT_YES_I_AM_VERY_VERY_SURE_I_WANT_AN_OPEN_REGISTRATION_SERVER_PRONE_TO_ABUSE: 'true'
+      CONDUWUIT_ALLOW_FEDERATION: 'true'
+      CONDUWUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
+      CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
+      #CONDUWUIT_LOG: warn,state_res=warn
+      CONDUWUIT_ADDRESS: 0.0.0.0
+      #CONDUWUIT_CONFIG: '/etc/conduwuit.toml' # Uncomment if you mapped config toml above
+
+      # We need some way to serve the client and server .well-known json. The simplest way is via the CONDUWUIT_WELL_KNOWN
+      # variable / config option, there are multiple ways to do this, e.g. in the conduwuit.toml file, and in a seperate
+      # see the override file for more information about delegation
+      CONDUWUIT_WELL_KNOWN: |
+        {
+        client=https://your.server.name.example,
+        server=your.server.name.example:443
+        }
+    #cpuset: "0-4" # Uncomment to limit to specific CPU cores
+    ulimits: # conduwuit uses quite a few file descriptors, and on some systems it defaults to 1024, so you can tell docker to increase it
+      nofile:
+        soft: 1048567
+        hard: 1048567
 
-    # We need some way to server the client and server .well-known json. The simplest way is to use a nginx container
-    # to serve those two as static files. If you want to use a different way, delete or comment the below service, here
-    # and in the docker compose override file.
-    well-known:
-        image: nginx:latest
-        restart: unless-stopped
-        volumes:
-            - ./nginx/matrix.conf:/etc/nginx/conf.d/matrix.conf # the config to serve the .well-known/matrix files
-            - ./nginx/www:/var/www/ # location of the client and server .well-known-files
     ### Uncomment if you want to use your own Element-Web App.
     ### Note: You need to provide a config.json for Element and you also need a second
-    ###       Domain or Subdomain for the communication between Element and Conduit
+    ###       Domain or Subdomain for the communication between Element and conduwuit
     ### Config-Docs: https://github.com/vector-im/element-web/blob/develop/docs/config.md
     # element-web:
     #     image: vectorim/element-web:latest
@@ -61,10 +55,12 @@ services:
     #         - homeserver
 
 volumes:
-    db:
+  db:
 
 networks:
-    # This is the network Traefik listens to, if your network has a different
-    # name, don't forget to change it here and in the docker-compose.override.yml
-    proxy:
-        external: true
+  # This is the network Traefik listens to, if your network has a different
+  # name, don't forget to change it here and in the docker-compose.override.yml
+  proxy:
+    external: true
+
+# vim: ts=2:sw=2:expandtab

docs/deploying/docker-compose.override.yml

@@ -1,45 +1,37 @@
-# Conduit - Traefik Reverse Proxy Labels
-version: '2.4' # uses '2.4' for cpuset
+# conduwuit - Traefik Reverse Proxy Labels
 
 services:
-    homeserver:
-        labels:
-            - "traefik.enable=true"
-            - "traefik.docker.network=proxy"  # Change this to the name of your Traefik docker proxy network
+  homeserver:
+    labels:
+      - "traefik.enable=true"
+      - "traefik.docker.network=proxy"  # Change this to the name of your Traefik docker proxy network
 
-            - "traefik.http.routers.to-conduit.rule=Host(`<SUBDOMAIN>.<DOMAIN>`)"  # Change to the address on which Conduit is hosted
-            - "traefik.http.routers.to-conduit.tls=true"
-            - "traefik.http.routers.to-conduit.tls.certresolver=letsencrypt"
-            - "traefik.http.routers.to-conduit.middlewares=cors-headers@docker"
+      - "traefik.http.routers.to-conduwuit.rule=Host(`<SUBDOMAIN>.<DOMAIN>`)"  # Change to the address on which conduwuit is hosted
+      - "traefik.http.routers.to-conduwuit.tls=true"
+      - "traefik.http.routers.to-conduwuit.tls.certresolver=letsencrypt"
+      - "traefik.http.routers.to-conduwuit.middlewares=cors-headers@docker"
+      - "traefik.http.services.to_conduwuit.loadbalancer.server.port=6167"
 
-            - "traefik.http.middlewares.cors-headers.headers.accessControlAllowOriginList=*"
-            - "traefik.http.middlewares.cors-headers.headers.accessControlAllowHeaders=Origin, X-Requested-With, Content-Type, Accept, Authorization"
-            - "traefik.http.middlewares.cors-headers.headers.accessControlAllowMethods=GET, POST, PUT, DELETE, OPTIONS"
+      - "traefik.http.middlewares.cors-headers.headers.accessControlAllowOriginList=*"
+      - "traefik.http.middlewares.cors-headers.headers.accessControlAllowHeaders=Origin, X-Requested-With, Content-Type, Accept, Authorization"
+      - "traefik.http.middlewares.cors-headers.headers.accessControlAllowMethods=GET, POST, PUT, DELETE, OPTIONS"
 
-    # We need some way to server the client and server .well-known json. The simplest way is to use a nginx container
-    # to serve those two as static files. If you want to use a different way, delete or comment the below service, here
-    # and in the docker compose file.
-    well-known:
-        labels:
-            - "traefik.enable=true"
-            - "traefik.docker.network=proxy"
+      # If you want to have your account on <DOMAIN>, but host conduwuit on a subdomain,
+      # you can let it only handle the well known file on that domain instead
+      #- "traefik.http.routers.to-matrix-wellknown.rule=Host(`<DOMAIN>`) && PathPrefix(`/.well-known/matrix`)"
+      #- "traefik.http.routers.to-matrix-wellknown.tls=true"
+      #- "traefik.http.routers.to-matrix-wellknown.tls.certresolver=letsencrypt"
+      #- "traefik.http.routers.to-matrix-wellknown.middlewares=cors-headers@docker"
 
-            - "traefik.http.routers.to-matrix-wellknown.rule=Host(`<SUBDOMAIN>.<DOMAIN>`) && PathPrefix(`/.well-known/matrix`)"
-            - "traefik.http.routers.to-matrix-wellknown.tls=true"
-            - "traefik.http.routers.to-matrix-wellknown.tls.certresolver=letsencrypt"
-            - "traefik.http.routers.to-matrix-wellknown.middlewares=cors-headers@docker"
+  ### Uncomment this if you uncommented Element-Web App in the docker-compose.yml
+  # element-web:
+  #     labels:
+  #         - "traefik.enable=true"
+  #         - "traefik.docker.network=proxy"  # Change this to the name of your Traefik docker proxy network
 
-            - "traefik.http.middlewares.cors-headers.headers.accessControlAllowOriginList=*"
-            - "traefik.http.middlewares.cors-headers.headers.accessControlAllowHeaders=Origin, X-Requested-With, Content-Type, Accept, Authorization"
-            - "traefik.http.middlewares.cors-headers.headers.accessControlAllowMethods=GET, POST, PUT, DELETE, OPTIONS"
+  #         - "traefik.http.routers.to-element-web.rule=Host(`<SUBDOMAIN>.<DOMAIN>`)"  # Change to the address on which Element-Web is hosted
+  #         - "traefik.http.routers.to-element-web.tls=true"
+  #         - "traefik.http.routers.to-element-web.tls.certresolver=letsencrypt"
 
+# vim: ts=2:sw=2:expandtab
 
-    ### Uncomment this if you uncommented Element-Web App in the docker-compose.yml
-    # element-web:
-    #     labels:
-    #         - "traefik.enable=true"
-    #         - "traefik.docker.network=proxy"  # Change this to the name of your Traefik docker proxy network
-
-    #         - "traefik.http.routers.to-element-web.rule=Host(`<SUBDOMAIN>.<DOMAIN>`)"  # Change to the address on which Element-Web is hosted
-    #         - "traefik.http.routers.to-element-web.tls=true"
-    #         - "traefik.http.routers.to-element-web.tls.certresolver=letsencrypt"

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

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

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

@@ -1,59 +1,56 @@
-# Conduit - Behind Traefik Reverse Proxy
-version: '2.4' # uses '2.4' for cpuset
+# conduwuit - Behind Traefik Reverse Proxy
 
 services:
-    homeserver:
-        ### If you already built the Conduit image with 'docker build' or want to use the Docker Hub image,
-        ### then you are ready to go.
-        image: girlbossceo/conduwuit:latest
-        ### If you want to build a fresh image from the sources, then comment the image line and uncomment the
-        ### build lines. If you want meaningful labels in your built Conduit image, you should run docker compose like this:
-        ### CREATED=$(date -u +'%Y-%m-%dT%H:%M:%SZ') VERSION=$(grep -m1 -o '[0-9].[0-9].[0-9]' Cargo.toml) docker compose up -d
-        # build:
-        #     context: .
-        #     args:
-        #         CREATED: '2021-03-16T08:18:27Z'
-        #         VERSION: '0.1.0'
-        #         LOCAL: 'false'
-        #         GIT_REF: origin/master
-        restart: unless-stopped
-        volumes:
-            - db:/srv/conduit/.local/share/conduit
-            #- ./conduwuit.toml:/etc/conduit.toml
-        networks:
-            - proxy
-        environment:
-            CONDUIT_SERVER_NAME: your.server.name # EDIT THIS
-            CONDUIT_TRUSTED_SERVERS: '["matrix.org"]'
-            CONDUIT_ALLOW_REGISTRATION : 'true'
-            #CONDUIT_CONFIG: './conduwuit.toml' # Uncomment if you mapped config toml above
-            ### Uncomment and change values as desired
-            # CONDUIT_ADDRESS: 0.0.0.0
-            # CONDUIT_PORT: 6167
-            # Available levels are: error, warn, info, debug, trace - more info at: https://docs.rs/env_logger/*/env_logger/#enabling-logging
-            # CONDUIT_LOG: info  # default is: "warn,state_res=warn"
-            # CONDUIT_ALLOW_JAEGER: 'false'
-            # CONDUIT_ALLOW_ENCRYPTION: 'true'
-            # CONDUIT_ALLOW_FEDERATION: 'true'
-            # CONDUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
-            # CONDUIT_DATABASE_PATH: /srv/conduit/.local/share/conduit
-            # CONDUIT_WORKERS: 10
-            # CONDUIT_MAX_REQUEST_SIZE: 20_000_000  # in bytes, ~20 MB
-        #cpuset: "0-4" # Uncomment to limit to specific CPU cores
+  homeserver:
+    ### If you already built the conduwuit image with 'docker build' or want to use the Docker Hub image,
+    ### then you are ready to go.
+    image: girlbossceo/conduwuit:latest
+    restart: unless-stopped
+    volumes:
+      - db:/var/lib/conduwuit
+      #- ./conduwuit.toml:/etc/conduwuit.toml
+    networks:
+      - proxy
+    environment:
+      CONDUWUIT_SERVER_NAME: your.server.name.example # EDIT THIS
+      CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
+      CONDUWUIT_ALLOW_REGISTRATION: 'false' # After setting a secure registration token, you can enable this
+      CONDUWUIT_REGISTRATION_TOKEN: "" # This is a token you can use to register on the server
+      #CONDUWUIT_REGISTRATION_TOKEN_FILE: "" # Alternatively you can configure a path to a token file to read
+      CONDUWUIT_ADDRESS: 0.0.0.0
+      CONDUWUIT_PORT: 6167 # you need to match this with the traefik load balancer label if you're want to change it
+      CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit
+      #CONDUWUIT_CONFIG: '/etc/conduit.toml' # Uncomment if you mapped config toml above
+      ### Uncomment and change values as desired, note that conduwuit has plenty of config options, so you should check out the example example config too
+      # Available levels are: error, warn, info, debug, trace - more info at: https://docs.rs/env_logger/*/env_logger/#enabling-logging
+      # CONDUWUIT_LOG: info  # default is: "warn,state_res=warn"
+      # CONDUWUIT_ALLOW_ENCRYPTION: 'true'
+      # CONDUWUIT_ALLOW_FEDERATION: 'true'
+      # CONDUWUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
+      # CONDUWUIT_ALLOW_INCOMING_PRESENCE: true
+      # CONDUWUIT_ALLOW_OUTGOING_PRESENCE: true
+      # CONDUWUIT_ALLOW_LOCAL_PRESENCE: true
+      # CONDUWUIT_WORKERS: 10
+      # CONDUWUIT_MAX_REQUEST_SIZE: 20000000  # in bytes, ~20 MB
+      # CONDUWUIT_NEW_USER_DISPLAYNAME_SUFFIX = "🏳<200d>⚧"
 
-    # We need some way to server the client and server .well-known json. The simplest way is to use a nginx container
-    # to serve those two as static files. If you want to use a different way, delete or comment the below service, here
-    # and in the docker compose override file.
-    well-known:
-        image: nginx:latest
-        restart: unless-stopped
-        volumes:
-            - ./nginx/matrix.conf:/etc/nginx/conf.d/matrix.conf # the config to serve the .well-known/matrix files
-            - ./nginx/www:/var/www/ # location of the client and server .well-known-files
+      # We need some way to serve the client and server .well-known json. The simplest way is via the CONDUWUIT_WELL_KNOWN
+      # variable / config option, there are multiple ways to do this, e.g. in the conduwuit.toml file, and in a seperate
+      # reverse proxy, but since you do not have a reverse proxy and following this guide, this example is included
+      CONDUWUIT_WELL_KNOWN: |
+        {
+          client=https://your.server.name.example,
+          server=your.server.name.example:443
+        }
+    #cpuset: "0-4" # Uncomment to limit to specific CPU cores
+    ulimits: # conduwuit uses quite a few file descriptors, and on some systems it defaults to 1024, so you can tell docker to increase it
+      nofile:
+        soft: 1048567
+        hard: 1048567
 
     ### Uncomment if you want to use your own Element-Web App.
     ### Note: You need to provide a config.json for Element and you also need a second
-    ###       Domain or Subdomain for the communication between Element and Conduit
+    ###       Domain or Subdomain for the communication between Element and conduwuit
     ### Config-Docs: https://github.com/vector-im/element-web/blob/develop/docs/config.md
     # element-web:
     #     image: vectorim/element-web:latest
@@ -65,29 +62,79 @@ services:
     #     depends_on:
     #         - homeserver
 
-    traefik:
-        image: "traefik:latest"
-        container_name: "traefik"
-        restart: "unless-stopped"
-        ports:
-            - "80:80"
-            - "443:443"
-        volumes:
-            - "/var/run/docker.sock:/var/run/docker.sock"
-            # - "./traefik_config:/etc/traefik"
-            - "acme:/etc/traefik/acme"
-        labels:
-            - "traefik.enable=true"
+  traefik:
+    image: "traefik:latest"
+    container_name: "traefik"
+    restart: "unless-stopped"
+    ports:
+      - "80:80"
+      - "443:443"
+    volumes:
+      - "/var/run/docker.sock:/var/run/docker.sock:z"
+      - "acme:/etc/traefik/acme"
+      #- "./traefik_config:/etc/traefik:z"
+    labels:
+      - "traefik.enable=true"
 
-            # middleware redirect
-            - "traefik.http.middlewares.redirect-to-https.redirectscheme.scheme=https"
-            # global redirect to https
-            - "traefik.http.routers.redirs.rule=hostregexp(`{host:.+}`)"
-            - "traefik.http.routers.redirs.entrypoints=http"
-            - "traefik.http.routers.redirs.middlewares=redirect-to-https"
+      # middleware redirect
+      - "traefik.http.middlewares.redirect-to-https.redirectscheme.scheme=https"
+      # global redirect to https
+      - "traefik.http.routers.redirs.rule=hostregexp(`{host:.+}`)"
+      - "traefik.http.routers.redirs.entrypoints=web"
+      - "traefik.http.routers.redirs.middlewares=redirect-to-https"
 
-        networks:
-            - proxy
+    configs:
+      - source: dynamic.yml
+        target: /etc/traefik/dynamic.yml
+
+    environment:
+      TRAEFIK_LOG_LEVEL: DEBUG
+      TRAEFIK_ENTRYPOINTS_WEB: true
+      TRAEFIK_ENTRYPOINTS_WEB_ADDRESS: ":80"
+      TRAEFIK_ENTRYPOINTS_WEB_HTTP_REDIRECTIONS_ENTRYPOINT_TO: websecure
+
+      TRAEFIK_ENTRYPOINTS_WEBSECURE: true
+      TRAEFIK_ENTRYPOINTS_WEBSECURE_ADDRESS: ":443"
+      TRAEFIK_ENTRYPOINTS_WEBSECURE_HTTP_TLS_CERTRESOLVER: letsencrypt
+      #TRAEFIK_ENTRYPOINTS_WEBSECURE_HTTP_MIDDLEWARES: secureHeaders@file # if you want to enabled STS
+
+      TRAEFIK_CERTIFICATESRESOLVERS_LETSENCRYPT: true
+      TRAEFIK_CERTIFICATESRESOLVERS_LETSENCRYPT_ACME_EMAIL: # Set this to the email you want to receive certificate expiration emails for
+      TRAEFIK_CERTIFICATESRESOLVERS_LETSENCRYPT_ACME_KEYTYPE: EC384
+      TRAEFIK_CERTIFICATESRESOLVERS_LETSENCRYPT_ACME_HTTPCHALLENGE: true
+      TRAEFIK_CERTIFICATESRESOLVERS_LETSENCRYPT_ACME_HTTPCHALLENGE_ENTRYPOINT: web
+      TRAEFIK_CERTIFICATESRESOLVERS_LETSENCRYPT_ACME_STORAGE: "/etc/traefik/acme/acme.json"
+
+      TRAEFIK_PROVIDERS_DOCKER: true
+      TRAEFIK_PROVIDERS_DOCKER_ENDPOINT: "unix:///var/run/docker.sock"
+      TRAEFIK_PROVIDERS_DOCKER_EXPOSEDBYDEFAULT: false
+
+      TRAEFIK_PROVIDERS_FILE: true
+      TRAEFIK_PROVIDERS_FILE_FILENAME: "/etc/traefik/dynamic.yml"
+
+configs:
+  dynamic.yml:
+    content: |
+      # Optionally set STS headers, like in https://hstspreload.org
+      # http:
+      #   middlewares:
+      #     secureHeaders:
+      #       headers:
+      #         forceSTSHeader: true
+      #         stsIncludeSubdomains: true
+      #         stsPreload: true
+      #         stsSeconds: 31536000
+      tls:
+        options:
+          default:
+            cipherSuites:
+              - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
+              - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
+              - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
+              - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
+              - TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305
+              - TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305
+            minVersion: VersionTLS12
 
 volumes:
     db:
@@ -95,3 +142,5 @@ volumes:
 
 networks:
     proxy:
+
+# vim: ts=2:sw=2:expandtab

docs/deploying/docker-compose.yml

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

docs/deploying/docker.md

@@ -2,8 +2,8 @@ # conduwuit for Docker
 
 ## Docker
 
-To run conduwuit with Docker you can either build the image yourself or pull it from a registry.
-
+To run conduwuit with Docker you can either build the image yourself or pull it
+from a registry.
 
 ### Use a registry
 
@@ -11,31 +11,29 @@ ### Use a registry
 
 | Registry        | Image                                                           | Size                          | Notes                  |
 | --------------- | --------------------------------------------------------------- | ----------------------------- | ---------------------- |
-| GitHub Registry | [ghcr.io/girlbossceo/conduwuit:latest][gh] | ![Image Size][shield-latest]  | Stable tagged image.          |
-| GitLab Registry | [registry.gitlab.com/girlbossceo/conduwuit:latest][gl] | ![Image Size][shield-latest]  | Stable tagged image.          |
-| Docker Hub      | [docker.io/girlbossceo/conduwuit:latest][dh]             | ![Image Size][shield-latest]  | Stable tagged image.          |
+| GitHub Registry | [ghcr.io/girlbossceo/conduwuit:latest][gh] | ![Image Size][shield-latest]  | Stable latest tagged image.          |
+| GitLab Registry | [registry.gitlab.com/conduwuit/conduwuit:latest][gl] | ![Image Size][shield-latest]  | Stable latest tagged image.          |
+| Docker Hub      | [docker.io/girlbossceo/conduwuit:latest][dh]             | ![Image Size][shield-latest]  | Stable latest tagged image.          |
 | GitHub Registry | [ghcr.io/girlbossceo/conduwuit:main][gh]   | ![Image Size][shield-main]    | Stable main branch.   |
-| GitLab Registry | [registry.gitlab.com/girlbossceo/conduwuit:main][gl]   | ![Image Size][shield-main]    | Stable main branch.   |
+| GitLab Registry | [registry.gitlab.com/conduwuit/conduwuit:main][gl]   | ![Image Size][shield-main]    | Stable main branch.   |
 | Docker Hub      | [docker.io/girlbossceo/conduwuit:main][dh]               | ![Image Size][shield-main]    | Stable main branch.   |
-| GitHub Registry | [ghcr.io/girlbossceo/conduwuit:dev][gh]   | ![Image Size][shield-dev]    | Development version/branch.   |
-| GitLab Registry | [registry.gitlab.com/girlbossceo/conduwuit:dev][gl]   | ![Image Size][shield-dev]    | Development version/branch.   |
-| Docker Hub      | [docker.io/girlbossceo/conduwuit:dev][dh]               | ![Image Size][shield-dev]    | Development version/branch.   |
 
-
-[dh]: https://hub.docker.com/repository/docker/girlbossceo/conduwuit
+[dh]: https://hub.docker.com/r/girlbossceo/conduwuit
 [gh]: https://github.com/girlbossceo/conduwuit/pkgs/container/conduwuit
-[gl]: https://gitlab.com/girlbossceo/conduwuit/container_registry/6351657
+[gl]: https://gitlab.com/conduwuit/conduwuit/container_registry/6369729
 [shield-latest]: https://img.shields.io/docker/image-size/girlbossceo/conduwuit/latest
 [shield-main]: https://img.shields.io/docker/image-size/girlbossceo/conduwuit/main
-[shield-dev]: https://img.shields.io/docker/image-size/girlbossceo/conduwuit/dev
 
+OCI image `.tar.gz` files are also hosted directly at when uploaded by CI with a
+commit hash/revision or a tagged release: <https://pup.systems/~strawberry/conduwuit/>
 
 Use
-```bash
-docker image pull <link>
-```
-to pull it to your machine.
 
+```bash
+docker image pull $LINK
+```
+
+to pull it to your machine.
 
 ### Run
 
@@ -43,53 +41,88 @@ ### Run
 
 ```bash
 docker run -d -p 8448:6167 \
-  -v db:/var/lib/conduwuit/ \
-  -e CONDUIT_SERVER_NAME="your.server.name" \
-  -e CONDUIT_DATABASE_BACKEND="rocksdb" \
-  -e CONDUIT_ALLOW_REGISTRATION=false \
-  -e CONDUIT_ALLOW_FEDERATION=true \
-  -e CONDUIT_MAX_REQUEST_SIZE="40000000" \
-  -e CONDUIT_TRUSTED_SERVERS="[\"matrix.org\"]" \
-  -e CONDUIT_LOG="warn,ruma_state_res=warn" \
-  --name conduit <link>
+    -v db:/var/lib/conduwuit/ \
+    -e CONDUWUIT_SERVER_NAME="your.server.name" \
+    -e CONDUWUIT_ALLOW_REGISTRATION=false \
+    --name conduwuit $LINK
 ```
 
 or you can use [docker compose](#docker-compose).
 
-The `-d` flag lets the container run in detached mode. You may supply an optional `conduwuit.toml` config file, an example can be found [here](../configuration.md).
-You can pass in different env vars to change config values on the fly. You can even configure conduwuit completely by using env vars. For an overview of possible
-values, please take a look at the `docker-compose.yml` file.
+The `-d` flag lets the container run in detached mode. You may supply an
+optional `conduwuit.toml` config file, the example config can be found
+[here](../configuration/examples.md). You can pass in different env vars to
+change config values on the fly. You can even configure conduwuit completely by
+using env vars. For an overview of possible values, please take a look at the
+[`docker-compose.yml`](docker-compose.yml) file.
 
-If you just want to test conduwuit for a short time, you can use the `--rm` flag, which will clean up everything related to your container after you stop it.
+If you just want to test conduwuit for a short time, you can use the `--rm`
+flag, which will clean up everything related to your container after you stop
+it.
 
 ### Docker-compose
 
-If the `docker run` command is not for you or your setup, you can also use one of the provided `docker-compose` files.
+If the `docker run` command is not for you or your setup, you can also use one
+of the provided `docker-compose` files.
 
 Depending on your proxy setup, you can use one of the following files;
-- If you already have a `traefik` instance set up, use [`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml)
-- If you don't have a `traefik` instance set up (or any other reverse proxy), use [`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)
+
+- If you already have a `traefik` instance set up, use
+[`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml)
+- If you don't have a `traefik` instance set up and would like to use it, use
+[`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)
+- If you want a setup that works out of the box with `caddy-docker-proxy`, use
+[`docker-compose.with-caddy.yml`](docker-compose.with-caddy.yml) and replace all
+`example.com` placeholders with your own domain
 - For any other reverse proxy, use [`docker-compose.yml`](docker-compose.yml)
 
-When picking the traefik-related compose file, rename it so it matches `docker-compose.yml`, and
-rename the override file to `docker-compose.override.yml`. Edit the latter with the values you want
-for your server.
+When picking the traefik-related compose file, rename it so it matches
+`docker-compose.yml`, and rename the override file to
+`docker-compose.override.yml`. Edit the latter with the values you want for your
+server.
+
+When picking the `caddy-docker-proxy` compose file, it's important to first
+create the `caddy` network before spinning up the containers:
+
+```bash
+docker network create caddy
+```
+
+After that, you can rename it so it matches `docker-compose.yml` and spin up the
+containers!
 
 Additional info about deploying conduwuit can be found [here](generic.md).
 
 ### Build
 
-To build the conduwuit image with docker-compose, you first need to open and modify the `docker-compose.yml` file. There you need to comment the `image:` option and uncomment the `build:` option. Then call docker compose with:
+Official conduwuit images are built using Nix's
+[`buildLayeredImage`][nix-buildlayeredimage]. This ensures all OCI images are
+repeatable and reproducible by anyone, keeps the images lightweight, and can be
+built offline.
 
-```bash
-docker compose up
-```
+This also ensures portability of our images because `buildLayeredImage` builds
+OCI images, not Docker images, and works with other container software.
 
-This will also start the container right afterwards, so if want it to run in detached mode, you also should use the `-d` flag.
+The OCI images are OS-less with only a very minimal environment of the `tini`
+init system, CA certificates, and the conduwuit binary. This does mean there is
+not a shell, but in theory you can get a shell by adding the necessary layers
+to the layered image. However it's very unlikely you will need a shell for any
+real troubleshooting.
+
+The flake file for the OCI image definition is at [`nix/pkgs/oci-image/default.nix`][oci-image-def].
+
+To build an OCI image using Nix, the following outputs can be built:
+- `nix build -L .#oci-image` (default features, x86_64 glibc)
+- `nix build -L .#oci-image-x86_64-linux-musl` (default features, x86_64 musl)
+- `nix build -L .#oci-image-aarch64-linux-musl` (default features, aarch64 musl)
+- `nix build -L .#oci-image-x86_64-linux-musl-all-features` (all features, x86_64 musl)
+- `nix build -L .#oci-image-aarch64-linux-musl-all-features` (all features, aarch64 musl)
 
 ### Run
 
-If you already have built the image or want to use one from the registries, you can just start the container and everything else in the compose file in detached mode with:
+If you already have built the image or want to use one from the registries, you
+can just start the container and everything else in the compose file in detached
+mode with:
 
 ```bash
 docker compose up -d
@@ -99,105 +132,25 @@ ### Run
 
 ### Use Traefik as Proxy
 
-As a container user, you probably know about Traefik. It is a easy to use reverse proxy for making
-containerized app and services available through the web. With the two provided files,
+As a container user, you probably know about Traefik. It is a easy to use
+reverse proxy for making containerized app and services available through the
+web. With the two provided files,
 [`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml) (or
 [`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)) and
-[`docker-compose.override.yml`](docker-compose.override.yml), it is equally easy to deploy
-and use conduwuit, with a little caveat. If you already took a look at the files, then you should have
-seen the `well-known` service, and that is the little caveat. Traefik is simply a proxy and
-loadbalancer and is not able to serve any kind of content, but for conduwuit to federate, we need to
-either expose ports `443` and `8448` or serve two endpoints `.well-known/matrix/client` and
-`.well-known/matrix/server`.
-
-With the service `well-known` we use a single `nginx` container that will serve those two files.
-
-So...step by step:
-
-1. Copy [`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml) (or
-[`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)) and [`docker-compose.override.yml`](docker-compose.override.yml) from the repository and remove `.for-traefik` (or `.with-traefik`) from the filename.
-2. Open both files and modify/adjust them to your needs. Meaning, change the `CONDUIT_SERVER_NAME` and the volume host mappings according to your needs.
-3. Create the `conduwuit.toml` config file, an example can be found [here](../configuration.md), or set `CONDUIT_CONFIG=""` and configure conduwuit per env vars.
-4. Uncomment the `element-web` service if you want to host your own Element Web Client and create a `element_config.json`.
-5. Create the files needed by the `well-known` service.
-
-   - `./nginx/matrix.conf` (relative to the compose file, you can change this, but then also need to change the volume mapping)
-
-     ```nginx
-     server {
-         server_name <SUBDOMAIN>.<DOMAIN>;
-         listen      80 default_server;
-
-         location /.well-known/matrix/server {
-            return 200 '{"m.server": "<SUBDOMAIN>.<DOMAIN>:443"}';
-            types { } default_type "application/json; charset=utf-8";
-         }
-
-        location /.well-known/matrix/client {
-            return 200 '{"m.homeserver": {"base_url": "https://<SUBDOMAIN>.<DOMAIN>"}}';
-            types { } default_type "application/json; charset=utf-8";
-            add_header "Access-Control-Allow-Origin" *;
-        }
-
-        location / {
-            return 404;
-        }
-     }
-     ```
-
-6. Run `docker compose up -d`
-7. Connect to your homeserver with your preferred client and create a user. You should do this immediately after starting Conduit, because the first created user is the admin.
-
-
+[`docker-compose.override.yml`](docker-compose.override.yml), it is equally easy
+to deploy and use conduwuit, with a little caveat. If you already took a look at
+the files, then you should have seen the `well-known` service, and that is the
+little caveat. Traefik is simply a proxy and loadbalancer and is not able to
+serve any kind of content, but for conduwuit to federate, we need to either
+expose ports `443` and `8448` or serve two endpoints `.well-known/matrix/client`
+and `.well-known/matrix/server`.
 
+With the service `well-known` we use a single `nginx` container that will serve
+those two files.
 
 ## Voice communication
 
-In order to make or receive calls, a TURN server is required. conduwuit suggests using [Coturn](https://github.com/coturn/coturn) for this purpose, which is also available as a Docker image. Before proceeding with the software installation, it is essential to have the necessary configurations in place.
+See the [TURN](../turn.md) page.
 
-### Configuration
-
-Create a configuration file called `coturn.conf` containing:
-
-```conf
-use-auth-secret
-static-auth-secret=<a secret key>
-realm=<your server domain>
-```
-A common way to generate a suitable alphanumeric secret key is by using `pwgen -s 64 1`.
-
-These same values need to be set in conduwuit. You can either modify conduwuit.toml to include these lines:
-```
-turn_uris = ["turn:<your server domain>?transport=udp", "turn:<your server domain>?transport=tcp"]
-turn_secret = "<secret key from coturn configuration>"
-```
-or append the following to the docker environment variables dependig on which configuration method you used earlier:
-```yml
-CONDUIT_TURN_URIS: '["turn:<your server domain>?transport=udp", "turn:<your server domain>?transport=tcp"]'
-CONDUIT_TURN_SECRET: "<secret key from coturn configuration>"
-```
-Restart Conduit to apply these changes.
-
-### Run
-Run the [Coturn](https://hub.docker.com/r/coturn/coturn) image using
-```bash
-docker run -d --network=host -v $(pwd)/coturn.conf:/etc/coturn/turnserver.conf coturn/coturn
-```
-
-or docker-compose. For the latter, paste the following section into a file called `docker-compose.yml`
-and run `docker compose up -d` in the same directory.
-
-```yml
-version: 3
-services:
-    turn:
-      container_name: coturn-server
-      image: docker.io/coturn/coturn
-      restart: unless-stopped
-      network_mode: "host"
-      volumes:
-        - ./coturn.conf:/etc/coturn/turnserver.conf
-```
-
-To understand why the host networking mode is used and explore alternative configuration options, please visit the following link: https://github.com/coturn/coturn/blob/master/docker/coturn/README.md.
-For security recommendations see Synapse's [Coturn documentation](https://github.com/matrix-org/synapse/blob/develop/docs/setup/turn/coturn.md#configuration).
+[nix-buildlayeredimage]: https://ryantm.github.io/nixpkgs/builders/images/dockertools/#ssec-pkgs-dockerTools-buildLayeredImage
+[oci-image-def]: https://github.com/girlbossceo/conduwuit/blob/main/nix/pkgs/oci-image/default.nix

docs/deploying/freebsd.md

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

docs/deploying/generic.md

@@ -1,95 +1,138 @@
 # Generic deployment documentation
 
-### Please note that this documentation is not fully representative of conduwuit at the moment. Assume majority of it is outdated.
-
-> ## Getting help
+> ### Getting help
 >
-> If you run into any problems while setting up conduwuit, ask us
-> in `#conduwuit:puppygock.gay` or [open an issue on GitHub](https://github.com/girlbossceo/conduwuit/issues/new).
+> If you run into any problems while setting up conduwuit, ask us in
+> `#conduwuit:puppygock.gay` or [open an issue on
+> GitHub](https://github.com/girlbossceo/conduwuit/issues/new).
 
 ## Installing conduwuit
 
-You may simply download the binary that fits your machine. Run `uname -m` to see what you need.
+### Static prebuilt binary
 
-Prebuilt binaries can be downloaded from the latest tagged release [here](https://github.com/girlbossceo/conduwuit/releases/latest).
+You may simply download the binary that fits your machine architecture (x86_64
+or aarch64). Run `uname -m` to see what you need.
 
-Alternatively, you may compile the binary yourself. First, install any dependencies:
+Prebuilt fully static musl binaries can be downloaded from the latest tagged
+release [here](https://github.com/girlbossceo/conduwuit/releases/latest) or
+`main` CI branch workflow artifact output. These also include Debian/Ubuntu
+packages.
 
-```bash
-# Debian
-$ sudo apt install libclang-dev build-essential
+Binaries are also available on my website directly at: <https://pup.systems/~strawberry/conduwuit/>
 
-# RHEL
-$ sudo dnf install clang
-```
-Then, `cd` into the source tree of conduwuit and run:
-```bash
-$ cargo build --release
-```
+These can be curl'd directly from. `ci-bins` are CI workflow binaries by commit
+hash/revision, and `releases` are tagged releases. Sort by descending last
+modified for the latest.
+
+These binaries have jemalloc and io_uring statically linked and included with
+them, so no additional dynamic dependencies need to be installed.
+
+For the **best** performance; if using an `x86_64` CPU made in the last ~15 years,
+we recommend using the `-haswell-` optimised binaries. This sets
+`-march=haswell` which is the most compatible and highest performance with
+optimised binaries. The database backend, RocksDB, most benefits from this as it
+will then use hardware accelerated CRC32 hashing/checksumming which is critical
+for performance.
+
+### Compiling
+
+Alternatively, you may compile the binary yourself. We recommend using
+Nix (or [Lix](https://lix.systems)) to build conduwuit as this has the most
+guaranteed reproducibiltiy and easiest to get a build environment and output
+going. This also allows easy cross-compilation.
+
+You can run the `nix build -L .#static-x86_64-linux-musl-all-features` or
+`nix build -L .#static-aarch64-linux-musl-all-features` commands based
+on architecture to cross-compile the necessary static binary located at
+`result/bin/conduwuit`. This is reproducible with the static binaries produced
+in our CI.
+
+If wanting to build using standard Rust toolchains, make sure you install:
+- `liburing-dev` on the compiling machine, and `liburing` on the target host
+- LLVM and libclang for RocksDB
+
+You can build conduwuit using `cargo build --release --all-features`
 
 ## Adding a conduwuit user
 
-While conduwuit can run as any user it is usually better to use dedicated users for different services. This also allows
-you to make sure that the file permissions are correctly set up.
+While conduwuit can run as any user it is better to use dedicated users for
+different services. This also allows you to make sure that the file permissions
+are correctly set up.
 
-In Debian or RHEL, you can use this command to create a conduwuit user:
+In Debian, you can use this command to create a conduwuit user:
 
 ```bash
 sudo adduser --system conduwuit --group --disabled-login --no-create-home
 ```
 
+For distros without `adduser` (or where it's a symlink to `useradd`):
+
+```bash
+sudo useradd -r --shell /usr/bin/nologin --no-create-home conduwuit
+```
+
 ## Forwarding ports in the firewall or the router
 
-conduwuit uses the ports 443 and 8448 both of which need to be open in the firewall.
+Matrix's default federation port is port 8448, and clients must be using port 443.
+If you would like to use only port 443, or a different port, you will need to setup
+delegation. conduwuit has config options for doing delegation, or you can configure
+your reverse proxy to manually serve the necessary JSON files to do delegation
+(see the `[global.well_known]` config section).
 
-If conduwuit runs behind a router or in a container and has a different public IP address than the host system these public ports need to be forwarded directly or indirectly to the port mentioned in the config.
+If conduwuit runs behind a router or in a container and has a different public
+IP address than the host system these public ports need to be forwarded directly
+or indirectly to the port mentioned in the config.
+
+Note for NAT users; if you have trouble connecting to your server from the inside
+of your network, you need to research your router and see if it supports "NAT
+hairpinning" or "NAT loopback".
+
+If your router does not support this feature, you need to research doing local
+DNS overrides and force your Matrix DNS records to use your local IP internally.
+This can be done at the host level using `/etc/hosts`. If you need this to be
+on the network level, consider something like NextDNS or Pi-Hole.
 
 ## Setting up a systemd service
 
-Now we'll set up a systemd service for conduwuit, so it's easy to start/stop conduwuit and set it to autostart when your
-server reboots. Simply paste the default systemd service you can find below into
-`/etc/systemd/system/conduwuit.service`.
+Two example systemd units for conduwuit can be found
+[on the configuration page](../configuration/examples.md#debian-systemd-unit-file).
+You may need to change the `ExecStart=` path to where you placed the conduwuit
+binary if it is not `/usr/bin/conduwuit`.
 
-```systemd
-[Unit]
-Description=conduwuit Matrix Server
-After=network.target
+On systems where rsyslog is used alongside journald (i.e. Red Hat-based distros
+and OpenSUSE), put `$EscapeControlCharactersOnReceive off` inside
+`/etc/rsyslog.conf` to allow color in logs.
 
-[Service]
-Environment="CONDUWUIT_CONFIG=/etc/conduwuit/conduwuit.toml"
-User=conduwuit
-Group=conduwuit
-RuntimeDirectory=conduwuit
-RuntimeDirectoryMode=0750
-Restart=always
-ExecStart=/usr/local/bin/conduwuit
+If you are using a different `database_path` other than the systemd unit
+configured default `/var/lib/conduwuit`, you need to add your path to the
+systemd unit's `ReadWritePaths=`. This can be done by either directly editing
+`conduwuit.service` and reloading systemd, or running `systemctl edit conduwuit.service`
+and entering the following:
 
-[Install]
-WantedBy=multi-user.target
 ```
-
-Finally, run
-
-```bash
-$ sudo systemctl daemon-reload
+[Service]
+ReadWritePaths=/path/to/custom/database/path
 ```
 
 ## Creating the conduwuit configuration file
 
-Now we need to create the conduwuit's config file in `/etc/conduwuit/conduwuit.toml`. Paste this in **and take a moment
-to read it. You need to change at least the server name.**
-RocksDB (`rocksdb`) is the only supported database backend. SQLite only exists for historical reasons and is not recommended. Any performance issues, storage issues, database issues, etc will not be assisted if using SQLite and you will be asked to migrate to RocksDB first.
+Now we need to create the conduwuit's config file in
+`/etc/conduwuit/conduwuit.toml`. The example config can be found at
+[conduwuit-example.toml](../configuration/examples.md).
 
-See the following example config at [conduwuit-example.toml](../configuration.md)
+**Please take a moment to read the config. You need to change at least the
+server name.**
+
+RocksDB is the only supported database backend.
 
 ## Setting the correct file permissions
 
-As we are using a conduwuit specific user we need to allow it to read the config. To do that you can run this command on
-Debian or RHEL:
+If you are using a dedicated user for conduwuit, you will need to allow it to
+read the config. To do that you can run this:
 
 ```bash
 sudo chown -R root:root /etc/conduwuit
-sudo chmod 755 /etc/conduwuit
+sudo chmod -R 755 /etc/conduwuit
 ```
 
 If you use the default database path you also need to run this:
@@ -102,57 +145,104 @@ ## Setting the correct file permissions
 
 ## Setting up the Reverse Proxy
 
-Refer to the documentation or various guides online of your chosen reverse proxy software. A Caddy example will be provided as this is the recommended reverse proxy for new users and is very trivial.
+We recommend Caddy as a reverse proxy, as it is trivial to use, handling TLS certificates, reverse proxy headers, etc transparently with proper defaults.
+For other software, please refer to their respective documentation or online guides.
 
 ### Caddy
 
-Create `/etc/caddy/conf.d/conduwuit_caddyfile` and enter this (substitute for your server name).
+After installing Caddy via your preferred method, create `/etc/caddy/conf.d/conduwuit_caddyfile`
+and enter this (substitute for your server name).
 
-```caddy
+```caddyfile
 your.server.name, your.server.name:8448 {
-        # TCP
-        reverse_proxy 127.0.0.1:6167
-
-        # UNIX socket
-        #reverse_proxy unix//run/conduwuit/conduwuit.sock
+    # TCP reverse_proxy
+    reverse_proxy 127.0.0.1:6167
+    # UNIX socket
+    #reverse_proxy unix//run/conduwuit/conduwuit.sock
 }
 ```
 
-That's it! Just start or enable the service and you're set.
+That's it! Just start and enable the service and you're set.
 
 ```bash
-$ sudo systemctl enable caddy
+sudo systemctl enable --now caddy
 ```
 
-## You're done!
+### Other Reverse Proxies
+
+As we would prefer our users to use Caddy, we will not provide configuration files for other proxys.
+
+You will need to reverse proxy everything under following routes:
+- `/_matrix/` - core Matrix C-S and S-S APIs
+- `/_conduwuit/` - ad-hoc conduwuit routes such as `/local_user_count` and
+`/server_version`
+
+You can optionally reverse proxy the following individual routes:
+- `/.well-known/matrix/client` and `/.well-known/matrix/server` if using
+conduwuit to perform delegation (see the `[global.well_known]` config section)
+- `/.well-known/matrix/support` if using conduwuit to send the homeserver admin
+contact and support page (formerly known as MSC1929)
+- `/` if you would like to see `hewwo from conduwuit woof!` at the root
+
+See the following spec pages for more details on these files:
+- [`/.well-known/matrix/server`](https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixserver)
+- [`/.well-known/matrix/client`](https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixclient)
+- [`/.well-known/matrix/support`](https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixsupport)
+
+Examples of delegation:
+- <https://puppygock.gay/.well-known/matrix/server>
+- <https://puppygock.gay/.well-known/matrix/client>
+
+For Apache and Nginx there are many examples available online.
+
+Lighttpd is not supported as it seems to mess with the `X-Matrix` Authorization
+header, making federation non-functional. If a workaround is found, feel free to share to get it added to the documentation here.
+
+If using Apache, you need to use `nocanon` in your `ProxyPass` directive to prevent httpd from messing with the `X-Matrix` header (note that Apache isn't very good as a general reverse proxy and we discourage the usage of it if you can).
+
+If using Nginx, you need to give conduwuit the request URI using `$request_uri`, or like so:
+- `proxy_pass http://127.0.0.1:6167$request_uri;`
+- `proxy_pass http://127.0.0.1:6167;`
+
+Nginx users need to increase `client_max_body_size` (default is 1M) to match
+`max_request_size` defined in conduwuit.toml.
+
+## You're done
 
 Now you can start conduwuit with:
 
 ```bash
-$ sudo systemctl start conduwuit
+sudo systemctl start conduwuit
 ```
 
 Set it to start automatically when your system boots with:
 
 ```bash
-$ sudo systemctl enable conduwuit
+sudo systemctl enable conduwuit
 ```
 
 ## How do I know it works?
 
-You can open [a Matrix client](https://matrix.org/ecosystem/clients), enter your homeserver and try to register.
+You can open [a Matrix client](https://matrix.org/ecosystem/clients), enter your
+homeserver and try to register.
 
-You can also use these commands as a quick health check.
+You can also use these commands as a quick health check (replace
+`your.server.name`).
 
 ```bash
-$ curl https://your.server.name/_conduwuit/server_version
+curl https://your.server.name/_conduwuit/server_version
 
 # If using port 8448
-$ curl https://your.server.name:8448/_conduwuit/server_version
+curl https://your.server.name:8448/_conduwuit/server_version
+
+# If federation is enabled
+curl https://your.server.name:8448/_matrix/federation/v1/version
 ```
 
-- To check if your server can talk with other homeservers, you can use the [Matrix Federation Tester](https://federationtester.matrix.org/).
-  If you can register but cannot join federated rooms check your config again and also check if the port 8448 is open and forwarded correctly.
+- To check if your server can talk with other homeservers, you can use the
+[Matrix Federation Tester](https://federationtester.matrix.org/). If you can
+register but cannot join federated rooms check your config again and also check
+if the port 8448 is open and forwarded correctly.
 
 # What's next?
 
@@ -162,4 +252,5 @@ ## Audio/Video calls
 
 ## Appservices
 
-If you want to set up an appservice, take a look at the [Appservice Guide](../appservices.md).
+If you want to set up an appservice, take a look at the [Appservice
+Guide](../appservices.md).

docs/deploying/kubernetes.md

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

docs/deploying/nixos.md

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

docs/development.md

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

docs/development/hot_reload.md

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

docs/development/testing.md

@@ -5,13 +5,27 @@ ## Complement
 Have a look at [Complement's repository][complement] for an explanation of what
 it is.
 
-To test against Complement, with Nix and direnv installed and set up, you can
-either:
+To test against Complement, with Nix (or [Lix](https://lix.systems) and
+[direnv installed and set up][direnv] (run `direnv allow` after setting up the hook), you can:
 
-* Run `./bin/complement "$COMPLEMENT_SRC" ./path/to/logs.jsonl ./path/to/results.jsonl`
-  to build a Complement image, run the tests, and output the logs and results
-  to the specified paths
+* Run `./bin/complement "$COMPLEMENT_SRC"` to build a Complement image, run
+the tests, and output the logs and results to the specified paths. This will also output the OCI image
+at `result`
 * Run `nix build .#complement` from the root of the repository to just build a
-  Complement image
+Complement OCI image outputted to `result` (it's a `.tar.gz` file)
+* Or download the latest Complement OCI image from the CI workflow artifacts
+output from the commit/revision you want to test (e.g. from main)
+[here][ci-workflows]
 
+If you want to use your own prebuilt OCI image (such as from our CI) without needing
+Nix installed, put the image at `complement_oci_image.tar.gz` in the root of the repo
+and run the script.
+
+If you're on macOS and need to build an image, run `nix build .#linux-complement`.
+
+We have a Complement fork as some tests have needed to be fixed. This can be found
+at: <https://github.com/girlbossceo/complement>
+
+[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
+[direnv]: https://direnv.net/docs/hook.html

docs/differences.md

@@ -1,152 +0,0 @@
-#### **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 key fetching for faster remote room joins and room joins that will error less frequently
-- Send `Cache-Control` response header with `immutable` and 1 year cache length for all media requests to instruct clients to cache media, and reduce server load from media requests that could be otherwise cached
-- Add feature flags and config options to enable/build with zstd, brotli, and/or gzip HTTP body compression (response and request)
-- Eliminate all usage of the thread-blocking `getaddrinfo(3)` call upon DNS queries, significantly improving federation latency/ping and cache DNS results (NXDOMAINs, successful queries, etc) using hickory-dns / hickory-resolver
-- Vastly improve RocksDB default settings to use new features that help with performance significantly, uses settings tailored to SSDs, various ways to tweak RocksDB, and a conduwuit setting to tell RocksDB to use settings that are tailored to HDDs or slow spinning rust storage or buggy filesystems.
-- Add a Cargo build profile for aggressive build-time performance optimisations for release builds (1 codegen unit, no debug, fat LTO, etc, and optimise all crates with same)
-- Implement database flush and cleanup conduwuit operations when using RocksDB
-- Implement RocksDB write buffer corking and coalescing in database write-heavy areas
-- Perform connection pooling and keepalives where necessary to significantly improve federation performance and latency
-- Various config options to tweak connection pooling, request timeouts, connection timeouts, DNS timeouts and settings, etc with good defaults which also help huge with performance via reusing connections and retrying where needed
-- Implement building conduwuit with jemalloc (which extends to the RocksDB jemalloc feature for maximum gains) or hardened_malloc light variant, and produce CI builds with jemalloc for performance (Nix doesn't seem to build [hardened_malloc-rs](https://github.com/girlbossceo/hardened_malloc-rs) properly)
-- Add support for caching DNS results with hickory-dns / hickory-resolver in conduwuit (not a replacement for a proper resolver cache, but still far better than nothing)
-- Add config option for using DNS over TCP, and config option for controlling A/AAAA record lookup strategy (e.g. don't query AAAA records if you don't have IPv6 connectivity)
-- Overall significant database, Client-Server, and federation performance and latency improvements (check out the ping room leaderboards if you don't believe me :>)
-- Add config options for RocksDB compression and bottommost compression, including choosing the algorithm and compression level
-- Use [loole](https://github.com/mahdi-shojaee/loole) MPSC channels instead of tokio MPSC channels for huge performance boosts in sending channels (mainly relevant for federation) and presence channels
-- Use `tracing`/`log`'s `release_max_level_info` feature to improve performance, build speeds, binary size, and CPU usage in release builds by avoid compiling debug/trace log level macros that users will generally never use (can be disabled with a build-time feature flag)
-
-
-## General Fixes:
-- Raise and improve all the various request timeouts making some things like room joins and client bugs error less or none at all than they should, and make them all user configurable
-- Add missing `reason` field to user ban events (`/ban`)
-- Fixed spec compliance issue with room version 8 - 11 joins (https://github.com/matrix-org/synapse/issues/16717 / https://github.com/matrix-org/matrix-spec/issues/1708)
-- Safer and cleaner shutdowns on both database side as we run cleanup on shutdown and exits database loop better (no potential hanging issues in database loop), overall cleaner shutdown logic
-- Stop sending `make_join` requests on room joins if 15 servers respond with `M_UNSUPPORTED_ROOM_VERSION` or `M_INVALID_ROOM_VERSION`
-- Stop sending `make_join` requests if 50 servers cannot provide `make_join` for us
-- Respect *most* client parameters for `/media/` requests (`allow_redirect` still needs work)
-- Increased graceful shutdown timeout from a low 60 seconds to 180 seconds to avoid killing connections and let the remaining ones finish processing
-- Return joined member count of rooms for push rules/conditions instead of a hardcoded value of 10
-- Make `CONDUIT_CONFIG` optional, relevant for container users that configure only by environment variables and no longer need to set `CONDUIT_CONFIG` to an empty string.
-- Allow HEAD HTTP requests in CORS for clients (despite not being explicity mentioned in Matrix spec, HTTP spec says all HEAD requests need to behave the same as GET requests, Synapse supports HEAD requests)
-- Resolve and remove some "features" from upstream that result in concurrency hazards, exponential backoff issues, or arbitrary performance limiters
-- Find more servers for outbound federation `/hierarchy` requests instead of just the room ID server name
-- Support for suggesting servers to join through at `/_matrix/client/v3/directory/room/{roomAlias}`
-- Support for suggesting servers to join through us at `/_matrix/federation/v1/query/directory`
-- Add workaround for [Out Of Your Element](https://gitdab.com/cadence/out-of-your-element) appservice bridge to make it functional on conduwuit (bug has already been reported)
-
-
-## Moderation:
-- (Also see [Admin Room](#admin-room) for all the admin commands pertaining to moderation, there's a lot!)
-- Add support for room banning/blocking by ID using admin command
-- Add support for serving `support` well-known from `[well_known.support]` (MSC1929)
-- Config option to forbid publishing rooms to the room directory (`lockdown_public_room_directory`) except for admins
-- Admin commands to delete room aliases and unpublish rooms from our room directory
-- For all [`/report`](https://spec.matrix.org/v1.9/client-server-api/#post_matrixclientv3roomsroomidreporteventid) requests: check if the reported event ID belongs to the reported room ID, raise report reasoning character limit to 750, fix broken formatting, make a small delayed random response per spec suggestion on privacy, and check if the sender user is in the reported room.
-- Support blocking servers from downloading remote media from, returning a 404
-- Don't allow `m.call.invite` events to be sent in public rooms (prevents calling the entire room)
-- On new public room creations, only allow moderators to send `m.call.invite`, `org.matrix.msc3401.call`, and `org.matrix.msc3401.call.member` events
-- Add support for a "global ACLs" feature (`forbidden_remote_server_names`) that blocks inbound remote room invites, room joins by room ID on server name, room joins by room alias on server name, incoming federated joins, and incoming federated room directory requests. This is very helpful for blocking servers that are purely toxic/bad and serve no value in allowing our users to suffer from things like room invite spam or such. Please note that this is not a substitute for room ACLs.
-- Add support for a config option to forbid our local users from sending federated room directory requests for (`forbidden_remote_room_directory_server_names`). Similar to above, useful for blocking servers that help prevent our users from wandering into bad areas of Matrix via room directories of those malicious servers.
-
-
-## 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
-
-
-## 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 configurable RocksDB recovery modes to aid in recovering corrupted RocksDB databases
-- Support config options via `CONDUWUIT_` prefix
-- Add support for listening on multiple TCP ports
-- Disable update check by default as it's not useful for conduwuit
-- **Opt-in** Sentry.io telemetry and metrics, mainly used for crash reporting
-
-
-## Maintenance/Stability:
-- GitLab CI ported to GitHub Actions
-- Repo is mirrored to GitHub, GitLab, git.gay, sourcehut, and Codeberg (see README.md for their links)
-- Extensively revamp the example config to be extremely helpful and useful to both new users and power users
-- Fixed every single clippy (default lints) and rustc warnings, including some that were performance related or potential safety issues / unsoundness
-- Add a **lot** of other clippy and rustc lints and a rustfmt.toml file
-- Has [Renovate](https://docs.renovatebot.com/), [Trivy](https://github.com/aquasecurity/trivy-action), and keeps ALL dependencies as up to date as possible
-- Attempts and interest in removing extreme and unnecessary panics/unwraps/expects that can lead to denial of service or such (upstream and upstream contributors want this unusual behaviour for some reason)
-- Purge unmaintained/irrelevant/broken database backends (heed, sled, persy) and other unnecessary code or overhead
-- webp support for images
-- Add cargo audit support to CI
-- CI tests with all features
-- Add timestamp by commit date support to building OCI images for keeping image build reproducibility and still have a meaningful "last modified date" for OCI image metadata
-- Update rusqlite/sqlite (not that you should be using it)
-- Startup check if conduwuit running in a container and is listening on 127.0.0.1 (generally containers are using NAT networking and 0.0.0.0 is the intended listening address)
-
-
-## Admin Room:
-- Fix admin room handler to not panic/crash if the admin room command response fails (e.g. too large message)
-- Add command to dynamically change conduwuit's tracing log level filter on the fly
-- Add admin command to fetch a server's `/.well-known/matrix/support` file
-- Add debug admin command to force update user device lists (could potentially resolve some E2EE flukes)
-- Implement **RocksDB online backups**, listing RocksDB backups, and listing database file counts all via admin commands
-- Add various database visibility commands such as being able to query the getters and iterators used in conduwuit, a very helpful online debugging utility
-- Forbid the admin room from being made public or world readable history
-- Add `!admin` as a way to call the admin bot
-- Extend clear cache admin command to support clearing more caches such as DNS and TLS name overrides
-- Admin debug command to send a federation request/ping to a server's `/_matrix/federation/v1/version` endpoint and measures the latency it took
-- Add admin command to bulk delete media via a codeblock list of MXC URLs.
-- Add admin command to delete both the thumbnail and media MXC URLs from an event ID (e.g. from an abuse report)
-- Add admin command to list all the rooms a local user is joined in
-- Add admin command to delete all remote media in the past X minutes as a form of deleting media that you don't want on your server that a remote user posted in a room
-- Add admin command to return a room's state
-- Admin debug command to fetch a PDU from a remote server and inserts it into our database/timeline as backfill
-- Add admin command to delete media via a specific MXC. This deletes the MXC from our database, and the file locally.
-- Add admin commands for banning (blocking) room IDs from our local users joining (admins are always allowed) and evicts all our local users from that room, in addition to bulk room banning support, and blocks room invites (remote and local) to the banned room, as a moderation feature
-- Add admin commands to output jemalloc memory stats and memory usage
-- Add admin command to get conduwuit's uptime
-- Add admin command to get rooms a *remote* user shares with us
-
-
-## Misc:
-- Support for creating rooms with custom room IDs like Maunium Synapse (`room_id` request body field to `/createRoom`)
-- Query parameter `?format=event|content` for returning either the room state event's content (default) for the full room state event on ` /_matrix/client/v3/rooms/{roomId}/state/{eventType}[/{stateKey}]` requests (see https://github.com/matrix-org/matrix-spec/issues/1047)
-- Add **optional** feature flag to use SHA256 key names for media instead of base64 to overcome filesystem file name length limitations (OS error file name too long)
-- Send a User-Agent on all of our requests
-- Send `avatar_url` on invite room membership events/changes
-- Support sending [`well_known` response to client login responses](https://spec.matrix.org/v1.10/client-server-api/#post_matrixclientv3login) if using config option `[well_known.client]`
-- Implement `include_state` search criteria support for `/search` requests (response now can include room states)
-- Declare various missing Matrix versions and features at `/_matrix/client/versions`
-- Implement legacy Matrix `/v1/` media endpoints that some clients and servers may still call
-- Config option to change Conduit's behaviour of homeserver key fetching (`query_trusted_key_servers_first`). This option sets whether conduwuit will query trusted notary key servers first before the individual homeserver(s), or vice versa which may help in joining certain rooms.
-- Implement unstable MSC2666 support for querying mutual rooms with a user
-- Assume well-knowns are broken if they exceed past 10000 characters.
-- Add support for the Matrix spec compliance test suite [Complement](https://github.com/matrix-org/complement/) via the Nix flake and various other fixes for it
-- Add support for listening on both HTTP and HTTPS if using direct TLS with conduwuit for usecases such as Complement
-- Implement running and diff'ing Complement results in CI
-- Interest in supporting other operating systems such as macOS, BSDs, and Windows, and getting them added into CI and doing builds for them
-- Add config option for disabling RocksDB Direct IO if needed
-- (Developers): Add support for tokio-console
-- (Developers): Add support for tracing flame graphs
-- Add `release-debuginfo` Cargo build profile
-- No cryptocurrency donations allowed, conduwuit is fully maintained by independent queer maintainers, and with a strong priority on inclusitivity and comfort for protected groups 🏳️‍⚧️

docs/introduction.md

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

docs/maintenance.md

@@ -0,0 +1,135 @@
+# 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
+#badroomalias1:server.name
+!roomid2:server.name
+!roomid3:server.name
+#badroomalias2:server.name
+```
+````
+
+## Database (RocksDB)
+
+Generally there is very little you need to do. [Compaction][rocksdb-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, due to
+creating unnecessary I/O amplification. RocksDB is built with io_uring support
+via liburing for improved read performance.
+
+RocksDB troubleshooting can be found [in the RocksDB section of troubleshooting](troubleshooting.md).
+
+### Compression
+
+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 have reported that database compression does not need to be disabled
+on conduwuit as the filesystem already does not attempt to compress. This can be
+validated by using `filefrag -v` on a `.SST` file in your database, and ensure
+the `physical_offset` matches (no filesystem compression). It is very important
+to ensure no additional filesystem compression takes place as this can render
+unbuffered Direct IO inoperable, significantly slowing down read and write
+performance. See <https://btrfs.readthedocs.io/en/latest/Compression.html#compatibility>
+
+> Compression is done using the COW mechanism so it’s incompatible with
+> nodatacow. Direct IO read works on compressed files but will fall back to
+> buffered writes and leads to no compression even if force compression is set.
+> Currently nodatasum and compression don’t work together.
+
+### Files in database
+
+Do not touch any of the files in the database directory. This must be said due
+to users being mislead by the `.log` files in the RocksDB directory, thinking
+they're server logs or database logs, however they are critical RocksDB files
+related to WAL tracking.
+
+The only safe files that can be deleted are the `LOG` files (all caps). These
+are the real RocksDB telemetry/log files, however conduwuit has already
+configured to only store up to 3 RocksDB `LOG` files due to generall being
+useless for average users unless troubleshooting something low-level. If you
+would like to store nearly none at all, see the `rocksdb_max_log_files`
+config option.
+
+## 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.
+
+[rocksdb-compaction]: https://github.com/facebook/rocksdb/wiki/Compaction

docs/troubleshooting.md

@@ -0,0 +1,192 @@
+# Troubleshooting conduwuit
+
+> ## Docker users ⚠️
+>
+> Docker is extremely UX unfriendly. Because of this, a ton of issues or support
+> is actually Docker support, not conduwuit support. We also cannot document the
+> ever-growing list of Docker issues here.
+>
+> If you intend on asking for support and you are using Docker, **PLEASE**
+> triple validate your issues are **NOT** because you have a misconfiguration in
+> your Docker setup.
+>
+> If there are things like Compose file issues or Dockerhub image issues, those
+> can still be mentioned as long as they're something we can fix.
+
+## conduwuit and Matrix issues
+
+#### Lost access to admin room
+
+You can reinvite yourself to the admin room through the following methods:
+- Use the `--execute "users make_user_admin <username>"` conduwuit binary
+argument once to invite yourslf to the admin room on startup
+- Use the conduwuit console/CLI to run the `users make_user_admin` command
+- Or specify the `emergency_password` config option to allow you to temporarily
+log into the server account (`@conduit`) from a web client
+
+## General potential issues
+
+#### Potential DNS issues when using Docker
+
+Docker has issues with its default DNS setup that may cause DNS to not be
+properly functional when running conduwuit, resulting in federation issues. The
+symptoms of this have shown in excessively long room joins (30+ minutes) from
+very long DNS timeouts, log entries of "mismatching responding nameservers",
+and/or partial or non-functional inbound/outbound federation.
+
+This is **not** a conduwuit issue, and is purely a Docker issue. It is not
+sustainable for heavy DNS activity which is normal for Matrix federation. The
+workarounds for this are:
+- Use DNS over TCP via the config option `query_over_tcp_only = true`
+- Don't use Docker's default DNS setup and instead allow the container to use
+and communicate with your host's DNS servers (host's `/etc/resolv.conf`)
+
+#### DNS No connections available error message
+
+If you receive spurious amounts of error logs saying "DNS No connections
+available", this is due to your DNS server (servers from `/etc/resolv.conf`)
+being overloaded and unable to handle typical Matrix federation volume. Some
+users have reported that the upstream servers are rate-limiting them as well
+when they get this error (e.g. popular upstreams like Google DNS).
+
+Matrix federation is extremely heavy and sends wild amounts of DNS requests.
+Unfortunately this is by design and has only gotten worse with more
+server/destination resolution steps. Synapse also expects a very perfect DNS
+setup.
+
+There are some ways you can reduce the amount of DNS queries, but ultimately
+the best solution/fix is selfhosting a high quality caching DNS server like
+[Unbound][unbound-arch] without any upstream resolvers, and without DNSSEC
+validation enabled.
+
+DNSSEC validation is highly recommended to be **disabled** due to DNSSEC being
+very computationally expensive, and is extremely susceptible to denial of
+service, especially on Matrix. Many servers also strangely have broken DNSSEC
+setups and will result in non-functional federation.
+
+conduwuit cannot provide a "works-for-everyone" Unbound DNS setup guide, but
+the [official Unbound tuning guide][unbound-tuning] and the [Unbound Arch Linux wiki page][unbound-arch]
+may be of interest. Disabling DNSSEC on Unbound is commenting out trust-anchors
+config options and removing the `validator` module.
+
+**Avoid** using `systemd-resolved` as it does **not** perform very well under
+high load, and we have identified its DNS caching to not be very effective.
+
+dnsmasq can possibly work, but it does **not** support TCP fallback which can be
+problematic when receiving large DNS responses such as from large SRV records.
+If you still want to use dnsmasq, make sure you **disable** `dns_tcp_fallback`
+in conduwuit config.
+
+Raising `dns_cache_entries` in conduwuit config from the default can also assist
+in DNS caching, but a full-fledged external caching resolver is better and more
+reliable.
+
+If you don't have IPv6 connectivity, changing `ip_lookup_strategy` to match
+your setup can help reduce unnecessary AAAA queries
+(`1 - Ipv4Only (Only query for A records, no AAAA/IPv6)`).
+
+If your DNS server supports it, some users have reported enabling
+`query_over_tcp_only` to force only TCP querying by default has improved DNS
+reliability at a slight performance cost due to TCP overhead.
+
+## RocksDB / database issues
+
+#### Database corruption
+
+If your database is corrupted *and* is failing to start (e.g. checksum
+mismatch), it may be recoverable but careful steps must be taken, and there is
+no guarantee it may be recoverable.
+
+The first thing that can be done is launching conduwuit with the
+`rocksdb_repair` config option set to true. This will tell RocksDB to attempt to
+repair itself at launch. If this does not work, disable the option and continue
+reading.
+
+RocksDB has the following recovery modes:
+
+- `TolerateCorruptedTailRecords`
+- `AbsoluteConsistency`
+- `PointInTime`
+- `SkipAnyCorruptedRecord`
+
+By default, conduwuit uses `TolerateCorruptedTailRecords` as generally these may
+be due to bad federation and we can re-fetch the correct data over federation.
+The RocksDB default is `PointInTime` which will attempt to restore a "snapshot"
+of the data when it was last known to be good. This data can be either a few
+seconds old, or multiple minutes prior. `PointInTime` may not be suitable for
+default usage due to clients and servers possibly not being able to handle
+sudden "backwards time travels", and `AbsoluteConsistency` may be too strict.
+
+`AbsoluteConsistency` will fail to start the database if any sign of corruption
+is detected. `SkipAnyCorruptedRecord` will skip all forms of corruption unless
+it forbids the database from opening (e.g. too severe). Usage of
+`SkipAnyCorruptedRecord` voids any support as this may cause more damage and/or
+leave your database in a permanently inconsistent state, but it may do something
+if `PointInTime` does not work as a last ditch effort.
+
+With this in mind:
+
+- First start conduwuit with the `PointInTime` recovery method. See the [example
+config](configuration/examples.md) for how to do this using
+`rocksdb_recovery_mode`
+- If your database successfully opens, clients are recommended to clear their
+client cache to account for the rollback
+- Leave your conduwuit running in `PointInTime` for at least 30-60 minutes so as
+much possible corruption is restored
+- If all goes will, you should be able to restore back to using
+`TolerateCorruptedTailRecords` and you have successfully recovered your database
+
+## Debugging
+
+Note that users should not really be debugging things. If you find yourself
+debugging and find the issue, please let us know and/or how we can fix it.
+Various debug commands can be found in `!admin debug`.
+
+#### Debug/Trace log level
+
+conduwuit builds without debug or trace log levels at compile time by default
+for substantial performance gains in CPU usage and improved compile times. If
+you need to access debug/trace log levels, you will need to build without the
+`release_max_log_level` feature or use our provided static debug binaries.
+
+#### Changing log level dynamically
+
+conduwuit supports changing the tracing log environment filter on-the-fly using
+the admin command `!admin debug change-log-level <log env filter>`. This accepts
+a string **without quotes** the same format as the `log` config option.
+
+Example: `!admin debug change-log-level debug`
+
+This can also accept complex filters such as:
+`!admin debug change-log-level info,conduit_service[{dest="example.com"}]=trace,ruma_state_res=trace`
+`!admin debug change-log-level info,conduit_service[{dest="example.com"}]=trace,conduit_service[send{dest="example.org"}]=trace`
+
+And to reset the log level to the one that was set at startup / last config
+load, simply pass the `--reset` flag.
+
+`!admin debug change-log-level --reset`
+
+#### Pinging servers
+
+conduwuit can ping other servers using `!admin debug ping <server>`. This takes
+a server name and goes through the server discovery process and queries
+`/_matrix/federation/v1/version`. Errors are outputted.
+
+While it does measure the latency of the request, it is not indicative of
+server performance on either side as that endpoint is completely unauthenticated
+and simply fetches a string on a static JSON endpoint. It is very low cost both
+bandwidth and computationally.
+
+#### Allocator memory stats
+
+When using jemalloc with jemallocator's `stats` feature (`--enable-stats`), you
+can see conduwuit's high-level allocator stats by using
+`!admin server memory-usage` at the bottom.
+
+If you are a developer, you can also view the raw jemalloc statistics with
+`!admin debug memory-stats`. Please note that this output is extremely large
+which may only be visible in the conduwuit console CLI due to PDU size limits,
+and is not easy for non-developers to understand.
+
+[unbound-tuning]: https://unbound.docs.nlnetlabs.nl/en/latest/topics/core/performance.html
+[unbound-arch]: https://wiki.archlinux.org/title/Unbound

docs/turn.md

@@ -1,25 +1,70 @@
 # Setting up TURN/STURN
 
-## General instructions
+In order to make or receive calls, a TURN server is required. conduwuit suggests
+using [Coturn](https://github.com/coturn/coturn) for this purpose, which is also
+available as a Docker image.
 
-* It is assumed you have a [Coturn server](https://github.com/coturn/coturn) up and running. See [Synapse reference implementation](https://github.com/matrix-org/synapse/blob/develop/docs/turn-howto.md).
+### Configuration
 
-## Edit/Add a few settings to your existing conduit.toml
+Create a configuration file called `coturn.conf` containing:
 
-```
-# Refer to your Coturn settings. 
-# `your.turn.url` has to match the REALM setting of your Coturn as well as `transport`.
-turn_uris = ["turn:your.turn.url?transport=udp", "turn:your.turn.url?transport=tcp"]
-
-# static-auth-secret of your turnserver
-turn_secret = "ADD SECRET HERE"
-
-# If you have your TURN server configured to use a username and password
-# you can provide these information too. In this case comment out `turn_secret above`!
-#turn_username = ""
-#turn_password = ""
+```conf
+use-auth-secret
+static-auth-secret=<a secret key>
+realm=<your server domain>
 ```
 
-## Apply settings
+A common way to generate a suitable alphanumeric secret key is by using `pwgen
+-s 64 1`.
 
-Restart Conduit.
+These same values need to be set in conduwuit. See the [example
+config](configuration/examples.md) in the TURN section for configuring these and
+restart conduwuit after.
+
+`turn_secret` or a path to `turn_secret_file` must have a value of your
+coturn `static-auth-secret`, or use `turn_username` and `turn_password`
+if using legacy username:password TURN authentication (not preferred).
+
+`turn_uris` must be the list of TURN URIs you would like to send to the client.
+Typically you will just replace the example domain `example.turn.uri` with the
+`realm` you set from the example config.
+
+If you are using TURN over TLS, you can replace `turn:` with `turns:` in the
+`turn_uris` config option to instruct clients to attempt to connect to
+TURN over TLS. This is highly recommended.
+
+If you need unauthenticated access to the TURN URIs, or some clients may be
+having trouble, you can enable `turn_guest_access` in conduwuit which disables
+authentication for the TURN URI endpoint `/_matrix/client/v3/voip/turnServer`
+
+### Run
+
+Run the [Coturn](https://hub.docker.com/r/coturn/coturn) image using
+
+```bash
+docker run -d --network=host -v
+$(pwd)/coturn.conf:/etc/coturn/turnserver.conf coturn/coturn
+```
+
+or docker-compose. For the latter, paste the following section into a file
+called `docker-compose.yml` and run `docker compose up -d` in the same
+directory.
+
+```yml
+version: 3
+services:
+    turn:
+      container_name: coturn-server
+      image: docker.io/coturn/coturn
+      restart: unless-stopped
+      network_mode: "host"
+      volumes:
+        - ./coturn.conf:/etc/coturn/turnserver.conf
+```
+
+To understand why the host networking mode is used and explore alternative
+configuration options, please visit [Coturn's Docker
+documentation](https://github.com/coturn/coturn/blob/master/docker/coturn/README.md).
+
+For security recommendations see Synapse's [Coturn
+documentation](https://element-hq.github.io/synapse/latest/turn-howto.html).

engage.toml

@@ -18,12 +18,12 @@ script = "direnv --version"
 [[task]]
 name = "rustc"
 group = "versions"
-script = "rustc --version"
+script = "rustc --version -v"
 
 [[task]]
 name = "cargo"
 group = "versions"
-script = "cargo --version"
+script = "cargo --version -v"
 
 [[task]]
 name = "cargo-fmt"
@@ -55,35 +55,49 @@ name = "lychee"
 group = "versions"
 script = "lychee --version"
 
+[[task]]
+name = "markdownlint"
+group = "versions"
+script = "markdownlint --version"
+
 [[task]]
 name = "cargo-audit"
 group = "security"
-script = "cargo audit -D warnings -D unmaintained -D unsound -D yanked --ignore RUSTSEC-2020-0016"
+script = "cargo audit --color=always -D warnings -D unmaintained -D unsound -D yanked"
 
 [[task]]
 name = "cargo-fmt"
 group = "lints"
-script = "cargo fmt --check -- --color=always"
+script = """
+cargo fmt --check -- --color=always
+"""
 
 [[task]]
 name = "cargo-doc"
 group = "lints"
 script = """
-RUSTDOCFLAGS="-D warnings" cargo doc \
-    --workspace \
-    --all-features \
-    --no-deps \
-    --document-private-items \
-    --color always
+env DIRENV_DEVSHELL=all-features \
+    RUSTDOCFLAGS="-D warnings" \
+    direnv exec . \
+    cargo doc \
+        --workspace \
+        --locked \
+        --profile test \
+        --all-features \
+        --no-deps \
+        --document-private-items \
+        --color always
 """
 
 [[task]]
 name = "clippy/default"
 group = "lints"
 script = """
+direnv exec . \
 cargo clippy \
     --workspace \
-    --all-targets \
+    --locked \
+    --profile test \
     --color=always \
     -- \
     -D warnings
@@ -93,36 +107,45 @@ cargo clippy \
 name = "clippy/all"
 group = "lints"
 script = """
-cargo clippy \
-    --workspace \
-    --all-targets \
-    --all-features \
-    --color=always \
-    -- \
-    -D warnings
+env DIRENV_DEVSHELL=all-features \
+    direnv exec . \
+    cargo clippy \
+        --workspace \
+        --locked \
+        --profile test \
+        --all-features \
+        --color=always \
+        -- \
+        -D warnings
 """
 
 [[task]]
-name = "clippy/jemalloc"
+name = "clippy/no-features"
 group = "lints"
 script = """
-cargo clippy \
-    --workspace \
-    --features jemalloc \
-    --all-targets \
-    --color=always \
-    -- \
-    -D warnings
+env DIRENV_DEVSHELL=no-features \
+    direnv exec . \
+    cargo clippy \
+        --workspace \
+        --locked \
+        --profile test \
+        --no-default-features \
+        --color=always \
+        -- \
+        -D warnings
 """
 
 [[task]]
-name = "clippy/hardened_malloc"
+name = "clippy/other-features"
 group = "lints"
 script = """
+direnv exec . \
 cargo clippy \
     --workspace \
-    --features hardened_malloc \
-    --all-targets \
+    --locked \
+    --profile test \
+    --no-default-features \
+    --features=console,systemd,element_hacks,direct_tls,perf_measurements,brotli_compression,blurhashing \
     --color=always \
     -- \
     -D warnings
@@ -131,17 +154,36 @@ cargo clippy \
 [[task]]
 name = "lychee"
 group = "lints"
-script = "lychee --offline docs"
+script = "lychee --verbose --offline docs *.md --exclude development.md --exclude contributing.md --exclude testing.md"
 
 [[task]]
-name = "cargo"
+name = "markdownlint"
+group = "lints"
+script = "markdownlint docs *.md || true" # TODO: fix the ton of markdown lints so we can drop `|| true`
+
+[[task]]
+name = "cargo/default"
 group = "tests"
 script = """
-cargo test \
-    --workspace \
-    --all-targets \
-    --all-features \
-    --color=always \
-    -- \
-    --color=always
+env DIRENV_DEVSHELL=default \
+    direnv exec . \
+    cargo test \
+        --workspace \
+        --locked \
+        --profile test \
+        --all-targets \
+        --no-fail-fast \
+        --color=always \
+        -- \
+        --color=always
+"""
+
+# Checks if the generated example config differs from the checked in repo's
+# example config.
+[[task]]
+name = "example-config"
+group = "tests"
+depends = ["cargo/default"]
+script = """
+git diff --exit-code conduwuit-example.toml
 """

flake.lock

@@ -4,16 +4,17 @@
       "inputs": {
         "crane": "crane",
         "flake-compat": "flake-compat",
-        "flake-utils": "flake-utils",
+        "flake-parts": "flake-parts",
+        "nix-github-actions": "nix-github-actions",
         "nixpkgs": "nixpkgs",
         "nixpkgs-stable": "nixpkgs-stable"
       },
       "locked": {
-        "lastModified": 1711742460,
-        "narHash": "sha256-0O4v6e4a1toxXZ2gf5INhg4WPE5C5T+SVvsBt+45Mcc=",
+        "lastModified": 1738524606,
+        "narHash": "sha256-hPYEJ4juK3ph7kbjbvv7PlU1D9pAkkhl+pwx8fZY53U=",
         "owner": "zhaofengli",
         "repo": "attic",
-        "rev": "4dbdbee45728d8ce5788db6461aaaa89d98081f0",
+        "rev": "ff8a897d1f4408ebbf4d45fa9049c06b3e1e3f4e",
         "type": "github"
       },
       "original": {
@@ -23,18 +24,71 @@
         "type": "github"
       }
     },
-    "complement": {
-      "flake": false,
+    "cachix": {
+      "inputs": {
+        "devenv": "devenv",
+        "flake-compat": "flake-compat_2",
+        "git-hooks": "git-hooks",
+        "nixpkgs": "nixpkgs_4"
+      },
       "locked": {
-        "lastModified": 1714472853,
-        "narHash": "sha256-CNRHSZe3TE+3tFj2dHNyxTMjDqL0MKY3P/3jqUgA7YE=",
-        "owner": "matrix-org",
-        "repo": "complement",
-        "rev": "891d18872c153d39a9ce63b545045efddb845738",
+        "lastModified": 1737621947,
+        "narHash": "sha256-8HFvG7fvIFbgtaYAY2628Tb89fA55nPm2jSiNs0/Cws=",
+        "owner": "cachix",
+        "repo": "cachix",
+        "rev": "f65a3cd5e339c223471e64c051434616e18cc4f5",
         "type": "github"
       },
       "original": {
-        "owner": "matrix-org",
+        "owner": "cachix",
+        "ref": "master",
+        "repo": "cachix",
+        "type": "github"
+      }
+    },
+    "cachix_2": {
+      "inputs": {
+        "devenv": [
+          "cachix",
+          "devenv"
+        ],
+        "flake-compat": [
+          "cachix",
+          "devenv"
+        ],
+        "git-hooks": [
+          "cachix",
+          "devenv"
+        ],
+        "nixpkgs": "nixpkgs_2"
+      },
+      "locked": {
+        "lastModified": 1728672398,
+        "narHash": "sha256-KxuGSoVUFnQLB2ZcYODW7AVPAh9JqRlD5BrfsC/Q4qs=",
+        "owner": "cachix",
+        "repo": "cachix",
+        "rev": "aac51f698309fd0f381149214b7eee213c66ef0a",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "ref": "latest",
+        "repo": "cachix",
+        "type": "github"
+      }
+    },
+    "complement": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1741891349,
+        "narHash": "sha256-YvrzOWcX7DH1drp5SGa+E/fc7wN3hqFtPbqPjZpOu1Q=",
+        "owner": "girlbossceo",
+        "repo": "complement",
+        "rev": "e587b3df569cba411aeac7c20b6366d03c143745",
+        "type": "github"
+      },
+      "original": {
+        "owner": "girlbossceo",
         "ref": "main",
         "repo": "complement",
         "type": "github"
@@ -48,11 +102,11 @@
         ]
       },
       "locked": {
-        "lastModified": 1702918879,
-        "narHash": "sha256-tWJqzajIvYcaRWxn+cLUB9L9Pv4dQ3Bfit/YjU5ze3g=",
+        "lastModified": 1722960479,
+        "narHash": "sha256-NhCkJJQhD5GUib8zN9JrmYGMwt4lCRp6ZVNzIiYCl0Y=",
         "owner": "ipetkov",
         "repo": "crane",
-        "rev": "7195c00c272fdd92fc74e7d5a0a2844b9fadb2fb",
+        "rev": "4c6c77920b8d44cd6660c1621dea6b3fc4b4c4f4",
         "type": "github"
       },
       "original": {
@@ -62,17 +116,12 @@
       }
     },
     "crane_2": {
-      "inputs": {
-        "nixpkgs": [
-          "nixpkgs"
-        ]
-      },
       "locked": {
-        "lastModified": 1713738183,
-        "narHash": "sha256-qd/MuLm7OfKQKyd4FAMqV4H6zYyOfef5lLzRrmXwKJM=",
+        "lastModified": 1739936662,
+        "narHash": "sha256-x4syUjNUuRblR07nDPeLDP7DpphaBVbUaSoeZkFbGSk=",
         "owner": "ipetkov",
         "repo": "crane",
-        "rev": "f6c6a2fb1b8bd9b65d65ca9342dd0eb180a63f11",
+        "rev": "19de14aaeb869287647d9461cbd389187d8ecdb7",
         "type": "github"
       },
       "original": {
@@ -82,6 +131,37 @@
         "type": "github"
       }
     },
+    "devenv": {
+      "inputs": {
+        "cachix": "cachix_2",
+        "flake-compat": [
+          "cachix",
+          "flake-compat"
+        ],
+        "git-hooks": [
+          "cachix",
+          "git-hooks"
+        ],
+        "nix": "nix",
+        "nixpkgs": [
+          "cachix",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1733323168,
+        "narHash": "sha256-d5DwB4MZvlaQpN6OQ4SLYxb5jA4UH5EtV5t5WOtjLPU=",
+        "owner": "cachix",
+        "repo": "devenv",
+        "rev": "efa9010b8b1cfd5dd3c7ed1e172a470c3b84a064",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "devenv",
+        "type": "github"
+      }
+    },
     "fenix": {
       "inputs": {
         "nixpkgs": [
@@ -90,11 +170,11 @@
         "rust-analyzer-src": "rust-analyzer-src"
       },
       "locked": {
-        "lastModified": 1714544767,
-        "narHash": "sha256-kF1bX+YFMedf1g0PAJYwGUkzh22JmULtj8Rm4IXAQKs=",
+        "lastModified": 1740724364,
+        "narHash": "sha256-D1jLIueJx1dPrP09ZZwTrPf4cubV+TsFMYbpYYTVj6A=",
         "owner": "nix-community",
         "repo": "fenix",
-        "rev": "73124e1356bde9411b163d636b39fe4804b7ca45",
+        "rev": "edf7d9e431cda8782e729253835f178a356d3aab",
         "type": "github"
       },
       "original": {
@@ -107,11 +187,11 @@
     "flake-compat": {
       "flake": false,
       "locked": {
-        "lastModified": 1673956053,
-        "narHash": "sha256-4gtG9iQuiKITOjNQQeQIpoIB6b16fm+504Ch3sNKLd8=",
+        "lastModified": 1696426674,
+        "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=",
         "owner": "edolstra",
         "repo": "flake-compat",
-        "rev": "35bb57c0c8d8b62bbfd284272c928ceb64ddbde9",
+        "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33",
         "type": "github"
       },
       "original": {
@@ -123,11 +203,27 @@
     "flake-compat_2": {
       "flake": false,
       "locked": {
-        "lastModified": 1696426674,
-        "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=",
+        "lastModified": 1733328505,
+        "narHash": "sha256-NeCCThCEP3eCl2l/+27kNNK7QrwZB1IJCrXfrbv5oqU=",
         "owner": "edolstra",
         "repo": "flake-compat",
-        "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33",
+        "rev": "ff81ac966bb2cae68946d5ed5fc4994f96d0ffec",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "flake-compat_3": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1733328505,
+        "narHash": "sha256-NeCCThCEP3eCl2l/+27kNNK7QrwZB1IJCrXfrbv5oqU=",
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "ff81ac966bb2cae68946d5ed5fc4994f96d0ffec",
         "type": "github"
       },
       "original": {
@@ -137,31 +233,60 @@
         "type": "github"
       }
     },
-    "flake-utils": {
+    "flake-parts": {
+      "inputs": {
+        "nixpkgs-lib": [
+          "attic",
+          "nixpkgs"
+        ]
+      },
       "locked": {
-        "lastModified": 1667395993,
-        "narHash": "sha256-nuEHfE/LcWyuSWnS8t12N1wc105Qtau+/OdUAjtQ0rA=",
-        "owner": "numtide",
-        "repo": "flake-utils",
-        "rev": "5aed5285a952e0b949eb3ba02c12fa4fcfef535f",
+        "lastModified": 1722555600,
+        "narHash": "sha256-XOQkdLafnb/p9ij77byFQjDf5m5QYl9b2REiVClC+x4=",
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
+        "rev": "8471fe90ad337a8074e957b69ca4d0089218391d",
         "type": "github"
       },
       "original": {
-        "owner": "numtide",
-        "repo": "flake-utils",
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
         "type": "github"
       }
     },
-    "flake-utils_2": {
+    "flake-parts_2": {
+      "inputs": {
+        "nixpkgs-lib": [
+          "cachix",
+          "devenv",
+          "nix",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1712014858,
+        "narHash": "sha256-sB4SWl2lX95bExY2gMFG5HIzvva5AVMJd4Igm+GpZNw=",
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
+        "rev": "9126214d0a59633752a136528f5f3b9aa8565b7d",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
+        "type": "github"
+      }
+    },
+    "flake-utils": {
       "inputs": {
         "systems": "systems"
       },
       "locked": {
-        "lastModified": 1710146030,
-        "narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=",
+        "lastModified": 1731533236,
+        "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",
         "owner": "numtide",
         "repo": "flake-utils",
-        "rev": "b1d9ab70662946ef0850d488da1c9019f3a9752a",
+        "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
         "type": "github"
       },
       "original": {
@@ -171,13 +296,132 @@
         "type": "github"
       }
     },
+    "git-hooks": {
+      "inputs": {
+        "flake-compat": [
+          "cachix",
+          "flake-compat"
+        ],
+        "gitignore": "gitignore",
+        "nixpkgs": [
+          "cachix",
+          "nixpkgs"
+        ],
+        "nixpkgs-stable": "nixpkgs-stable_2"
+      },
+      "locked": {
+        "lastModified": 1733318908,
+        "narHash": "sha256-SVQVsbafSM1dJ4fpgyBqLZ+Lft+jcQuMtEL3lQWx2Sk=",
+        "owner": "cachix",
+        "repo": "git-hooks.nix",
+        "rev": "6f4e2a2112050951a314d2733a994fbab94864c6",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "git-hooks.nix",
+        "type": "github"
+      }
+    },
+    "gitignore": {
+      "inputs": {
+        "nixpkgs": [
+          "cachix",
+          "git-hooks",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1709087332,
+        "narHash": "sha256-HG2cCnktfHsKV0s4XW83gU3F57gaTljL9KNSuG6bnQs=",
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "rev": "637db329424fd7e46cf4185293b9cc8c88c95394",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "type": "github"
+      }
+    },
+    "libgit2": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1697646580,
+        "narHash": "sha256-oX4Z3S9WtJlwvj0uH9HlYcWv+x1hqp8mhXl7HsLu2f0=",
+        "owner": "libgit2",
+        "repo": "libgit2",
+        "rev": "45fd9ed7ae1a9b74b957ef4f337bc3c8b3df01b5",
+        "type": "github"
+      },
+      "original": {
+        "owner": "libgit2",
+        "repo": "libgit2",
+        "type": "github"
+      }
+    },
+    "liburing": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1740613216,
+        "narHash": "sha256-NpPOBqNND3Qe9IwqYs0mJLGTmIx7e6FgUEBAnJ+1ZLA=",
+        "owner": "axboe",
+        "repo": "liburing",
+        "rev": "e1003e496e66f9b0ae06674869795edf772d5500",
+        "type": "github"
+      },
+      "original": {
+        "owner": "axboe",
+        "ref": "master",
+        "repo": "liburing",
+        "type": "github"
+      }
+    },
+    "nix": {
+      "inputs": {
+        "flake-compat": [
+          "cachix",
+          "devenv"
+        ],
+        "flake-parts": "flake-parts_2",
+        "libgit2": "libgit2",
+        "nixpkgs": "nixpkgs_3",
+        "nixpkgs-23-11": [
+          "cachix",
+          "devenv"
+        ],
+        "nixpkgs-regression": [
+          "cachix",
+          "devenv"
+        ],
+        "pre-commit-hooks": [
+          "cachix",
+          "devenv"
+        ]
+      },
+      "locked": {
+        "lastModified": 1727438425,
+        "narHash": "sha256-X8ES7I1cfNhR9oKp06F6ir4Np70WGZU5sfCOuNBEwMg=",
+        "owner": "domenkozar",
+        "repo": "nix",
+        "rev": "f6c5ae4c1b2e411e6b1e6a8181cc84363d6a7546",
+        "type": "github"
+      },
+      "original": {
+        "owner": "domenkozar",
+        "ref": "devenv-2.24",
+        "repo": "nix",
+        "type": "github"
+      }
+    },
     "nix-filter": {
       "locked": {
-        "lastModified": 1710156097,
-        "narHash": "sha256-1Wvk8UP7PXdf8bCCaEoMnOT1qe5/Duqgj+rL8sRQsSM=",
+        "lastModified": 1731533336,
+        "narHash": "sha256-oRam5PS1vcrr5UPgALW0eo1m/5/pls27Z/pabHNy2Ms=",
         "owner": "numtide",
         "repo": "nix-filter",
-        "rev": "3342559a24e85fc164b295c3444e8a139924675b",
+        "rev": "f7653272fd234696ae94229839a99b73c9ab7de0",
         "type": "github"
       },
       "original": {
@@ -187,13 +431,34 @@
         "type": "github"
       }
     },
+    "nix-github-actions": {
+      "inputs": {
+        "nixpkgs": [
+          "attic",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1729742964,
+        "narHash": "sha256-B4mzTcQ0FZHdpeWcpDYPERtyjJd/NIuaQ9+BV1h+MpA=",
+        "owner": "nix-community",
+        "repo": "nix-github-actions",
+        "rev": "e04df33f62cdcf93d73e9a04142464753a16db67",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-community",
+        "repo": "nix-github-actions",
+        "type": "github"
+      }
+    },
     "nixpkgs": {
       "locked": {
-        "lastModified": 1711401922,
-        "narHash": "sha256-QoQqXoj8ClGo0sqD/qWKFWezgEwUL0SUh37/vY2jNhc=",
+        "lastModified": 1726042813,
+        "narHash": "sha256-LnNKCCxnwgF+575y0pxUdlGZBO/ru1CtGHIqQVfvjlA=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "07262b18b97000d16a4bdb003418bd2fb067a932",
+        "rev": "159be5db480d1df880a0135ca0bfed84c2f88353",
         "type": "github"
       },
       "original": {
@@ -205,27 +470,43 @@
     },
     "nixpkgs-stable": {
       "locked": {
-        "lastModified": 1711460390,
-        "narHash": "sha256-akSgjDZL6pVHEfSE6sz1DNSXuYX6hq+P/1Z5IoYWs7E=",
+        "lastModified": 1724316499,
+        "narHash": "sha256-Qb9MhKBUTCfWg/wqqaxt89Xfi6qTD3XpTzQ9eXi3JmE=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "44733514b72e732bd49f5511bd0203dea9b9a434",
+        "rev": "797f7dc49e0bc7fab4b57c021cdf68f595e47841",
         "type": "github"
       },
       "original": {
         "owner": "NixOS",
-        "ref": "nixos-23.11",
+        "ref": "nixos-24.05",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs-stable_2": {
+      "locked": {
+        "lastModified": 1730741070,
+        "narHash": "sha256-edm8WG19kWozJ/GqyYx2VjW99EdhjKwbY3ZwdlPAAlo=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "d063c1dd113c91ab27959ba540c0d9753409edf3",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-24.05",
         "repo": "nixpkgs",
         "type": "github"
       }
     },
     "nixpkgs_2": {
       "locked": {
-        "lastModified": 1713537308,
-        "narHash": "sha256-XtTSSIB2DA6tOv+l0FhvfDMiyCmhoRbNB+0SeInZkbk=",
+        "lastModified": 1730531603,
+        "narHash": "sha256-Dqg6si5CqIzm87sp57j5nTaeBbWhHFaVyG7V6L8k3lY=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "5c24cf2f0a12ad855f444c30b2421d044120c66f",
+        "rev": "7ffd9ae656aec493492b44d0ddfb28e79a1ea25d",
         "type": "github"
       },
       "original": {
@@ -235,19 +516,67 @@
         "type": "github"
       }
     },
-    "rocksdb": {
-      "flake": false,
+    "nixpkgs_3": {
       "locked": {
-        "lastModified": 1713810944,
-        "narHash": "sha256-/Xf0bzNJPclH9IP80QNaABfhj4IAR5LycYET18VFCXc=",
-        "owner": "facebook",
-        "repo": "rocksdb",
-        "rev": "6f7cabeac80a3a6150be2c8a8369fcecb107bf43",
+        "lastModified": 1717432640,
+        "narHash": "sha256-+f9c4/ZX5MWDOuB1rKoWj+lBNm0z0rs4CK47HBLxy1o=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "88269ab3044128b7c2f4c7d68448b2fb50456870",
         "type": "github"
       },
       "original": {
-        "owner": "facebook",
-        "ref": "v9.1.1",
+        "owner": "NixOS",
+        "ref": "release-24.05",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs_4": {
+      "locked": {
+        "lastModified": 1733212471,
+        "narHash": "sha256-M1+uCoV5igihRfcUKrr1riygbe73/dzNnzPsmaLCmpo=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "55d15ad12a74eb7d4646254e13638ad0c4128776",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs_5": {
+      "locked": {
+        "lastModified": 1740547748,
+        "narHash": "sha256-Ly2fBL1LscV+KyCqPRufUBuiw+zmWrlJzpWOWbahplg=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "3a05eebede89661660945da1f151959900903b6a",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "rocksdb": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1741308171,
+        "narHash": "sha256-YdBvdQ75UJg5ffwNjxizpviCVwVDJnBkM8ZtGIduMgY=",
+        "owner": "girlbossceo",
+        "repo": "rocksdb",
+        "rev": "3ce04794bcfbbb0d2e6f81ae35fc4acf688b6986",
+        "type": "github"
+      },
+      "original": {
+        "owner": "girlbossceo",
+        "ref": "v9.11.1",
         "repo": "rocksdb",
         "type": "github"
       }
@@ -255,24 +584,26 @@
     "root": {
       "inputs": {
         "attic": "attic",
+        "cachix": "cachix",
         "complement": "complement",
         "crane": "crane_2",
         "fenix": "fenix",
-        "flake-compat": "flake-compat_2",
-        "flake-utils": "flake-utils_2",
+        "flake-compat": "flake-compat_3",
+        "flake-utils": "flake-utils",
+        "liburing": "liburing",
         "nix-filter": "nix-filter",
-        "nixpkgs": "nixpkgs_2",
+        "nixpkgs": "nixpkgs_5",
         "rocksdb": "rocksdb"
       }
     },
     "rust-analyzer-src": {
       "flake": false,
       "locked": {
-        "lastModified": 1713628977,
-        "narHash": "sha256-iN5QUlUq527lswmBC+RopfXdu6Xx7mmTaBSH2l59FtM=",
+        "lastModified": 1740691488,
+        "narHash": "sha256-Fs6vBrByuiOf2WO77qeMDMTXcTGzrIMqLBv+lNeywwM=",
         "owner": "rust-lang",
         "repo": "rust-analyzer",
-        "rev": "55d9a533b309119c8acd13061581b43ae8840823",
+        "rev": "fe3eda77d3a7ce212388bda7b6cec8bffcc077e5",
         "type": "github"
       },
       "original": {

flake.nix

@@ -1,57 +1,295 @@
 {
   inputs = {
     attic.url = "github:zhaofengli/attic?ref=main";
-    complement = { url = "github:matrix-org/complement?ref=main"; flake = false; };
-    crane = { url = "github:ipetkov/crane?ref=master"; inputs.nixpkgs.follows = "nixpkgs"; };
+    cachix.url = "github:cachix/cachix?ref=master";
+    complement = { url = "github:girlbossceo/complement?ref=main"; flake = false; };
+    crane = { url = "github:ipetkov/crane?ref=master"; };
     fenix = { url = "github:nix-community/fenix?ref=main"; inputs.nixpkgs.follows = "nixpkgs"; };
     flake-compat = { url = "github:edolstra/flake-compat?ref=master"; flake = false; };
     flake-utils.url = "github:numtide/flake-utils?ref=main";
     nix-filter.url = "github:numtide/nix-filter?ref=main";
-    nixpkgs.url = "github:NixOS/nixpkgs?ref=nixos-unstable";
-    rocksdb = { url = "github:facebook/rocksdb?ref=v9.1.1"; flake = false; };
+    nixpkgs.url = "github:NixOS/nixpkgs?ref=nixpkgs-unstable";
+    rocksdb = { url = "github:girlbossceo/rocksdb?ref=v9.11.1"; flake = false; };
+    liburing = { url = "github:axboe/liburing?ref=master"; flake = false; };
   };
 
   outputs = inputs:
     inputs.flake-utils.lib.eachDefaultSystem (system:
     let
-      pkgsHost = inputs.nixpkgs.legacyPackages.${system};
+      pkgsHost = import inputs.nixpkgs{
+        inherit system;
+      };
+      pkgsHostStatic = pkgsHost.pkgsStatic;
 
       # The Rust toolchain to use
       toolchain = inputs.fenix.packages.${system}.fromToolchainFile {
         file = ./rust-toolchain.toml;
 
         # See also `rust-toolchain.toml`
-        sha256 = "sha256-e4mlaJehWBymYxJGgnbuCObVlqMlQSilZ8FljG9zPHY=";
+        sha256 = "sha256-X/4ZBHO3iW0fOenQ3foEvscgAPJYl2abspaBThDOukI=";
       };
 
-      scope = pkgs: pkgs.lib.makeScope pkgs.newScope (self: {
+      mkScope = pkgs: pkgs.lib.makeScope pkgs.newScope (self: {
+        inherit pkgs;
         book = self.callPackage ./nix/pkgs/book {};
         complement = self.callPackage ./nix/pkgs/complement {};
-        craneLib = ((inputs.crane.mkLib pkgs).overrideToolchain toolchain);
+        craneLib = ((inputs.crane.mkLib pkgs).overrideToolchain (_: toolchain));
         inherit inputs;
         main = self.callPackage ./nix/pkgs/main {};
         oci-image = self.callPackage ./nix/pkgs/oci-image {};
-        rocksdb = pkgs.rocksdb.overrideAttrs (old: {
+        tini = pkgs.tini.overrideAttrs {
+            # newer clang/gcc is unhappy with tini-static: <https://3.dog/~strawberry/pb/c8y4>
+            patches = [ (pkgs.fetchpatch {
+                url = "https://patch-diff.githubusercontent.com/raw/krallin/tini/pull/224.patch";
+                hash = "sha256-4bTfAhRyIT71VALhHY13hUgbjLEUyvgkIJMt3w9ag3k=";
+              })
+            ];
+        };
+        liburing = pkgs.liburing.overrideAttrs {
+          # Tests weren't building
+          outputs = [ "out" "dev" "man" ];
+          buildFlags = [ "library" ];
+          src = inputs.liburing;
+        };
+        rocksdb = (pkgs.rocksdb.override {
+          liburing = self.liburing;
+        }).overrideAttrs (old: {
           src = inputs.rocksdb;
           version = pkgs.lib.removePrefix
             "v"
             (builtins.fromJSON (builtins.readFile ./flake.lock))
               .nodes.rocksdb.original.ref;
+          # we have this already at https://github.com/girlbossceo/rocksdb/commit/a935c0273e1ba44eacf88ce3685a9b9831486155
+          # unsetting this so i don't have to revert it and make this nix exclusive
+          patches = [];
+          cmakeFlags = pkgs.lib.subtractLists
+            [
+              # no real reason to have snappy or zlib, no one uses this
+              "-DWITH_SNAPPY=1"
+              "-DZLIB=1"
+              "-DWITH_ZLIB=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"
+              # this doesn't exist in RocksDB, and USE_SSE is deprecated for
+              # PORTABLE=$(march)
+              "-DFORCE_SSE42=1"
+              # PORTABLE will get set in main/default.nix
+              "-DPORTABLE=1"
+            ]
+            old.cmakeFlags
+            ++ [
+              # no real reason to have snappy, no one uses this
+              "-DWITH_SNAPPY=0"
+              "-DZLIB=0"
+              "-DWITH_ZLIB=0"
+              # we dont need to use ldb or sst_dump (core_tools)
+              "-DWITH_CORE_TOOLS=0"
+              # we dont need trace tools
+              "-DWITH_TRACE_TOOLS=0"
+              # we dont need to build rocksdb tests
+              "-DWITH_TESTS=0"
+              # we use rust-rocksdb via C interface and dont need C++ RTTI
+              "-DUSE_RTTI=0"
+            ];
+
+          # outputs has "tools" which we dont need or use
+          outputs = [ "out" ];
+
+          # preInstall hooks has stuff for messing with ldb/sst_dump which we dont need or use
+          preInstall = "";
         });
       });
 
-      scopeHost = (scope pkgsHost);
+      scopeHost = mkScope pkgsHost;
+      scopeHostStatic = mkScope pkgsHostStatic;
+      scopeCrossLinux = mkScope pkgsHost.pkgsLinux.pkgsStatic;
+      mkCrossScope = crossSystem:
+        let pkgsCrossStatic = (import inputs.nixpkgs {
+          inherit system;
+          crossSystem = {
+           config = crossSystem;
+          };
+        }).pkgsStatic;
+         in
+        mkScope pkgsCrossStatic;
+
+      mkDevShell = scope: scope.pkgs.mkShell {
+        env = scope.main.env // {
+          # Rust Analyzer needs to be able to find the path to default crate
+          # sources, and it can read this environment variable to do so. The
+          # `rust-src` component is required in order for this to work.
+          RUST_SRC_PATH = "${toolchain}/lib/rustlib/src/rust/library";
+
+          # Convenient way to access a pinned version of Complement's source
+          # code.
+          COMPLEMENT_SRC = inputs.complement.outPath;
+
+          # Needed for Complement: <https://github.com/golang/go/issues/52690>
+          CGO_CFLAGS = "-Wl,--no-gc-sections";
+          CGO_LDFLAGS = "-Wl,--no-gc-sections";
+        };
+
+        # Development tools
+        packages = [
+          # Always use nightly rustfmt because most of its options are unstable
+          #
+          # This needs to come before `toolchain` in this list, otherwise
+          # `$PATH` will have stable rustfmt instead.
+          inputs.fenix.packages.${system}.latest.rustfmt
+
+          toolchain
+        ]
+        ++ (with pkgsHost.pkgs; [
+          # Required by hardened-malloc.rs dep
+          binutils
+
+          cargo-audit
+          cargo-auditable
+
+          # Needed for producing Debian packages
+          cargo-deb
+
+          # Needed for CI to check validity of produced Debian packages (dpkg-deb)
+          dpkg
+
+	  engage
+
+          # Needed for Complement
+          go
+
+          # Needed for our script for Complement
+          jq
+          gotestfmt
+
+          # Needed for finding broken markdown links
+          lychee
+
+          # Needed for linting markdown files
+          markdownlint-cli
+
+          # Useful for editing the book locally
+          mdbook
+
+          # used for rust caching in CI to speed it up
+          sccache
+        ]
+        # liburing is Linux-exclusive
+        ++ lib.optional stdenv.hostPlatform.isLinux liburing
+        ++ lib.optional stdenv.hostPlatform.isLinux numactl)
+        ++ scope.main.buildInputs
+        ++ scope.main.propagatedBuildInputs
+        ++ scope.main.nativeBuildInputs;
+      };
     in
     {
       packages = {
-        default = scopeHost.main;
-        jemalloc = scopeHost.main.override { features = ["jemalloc"]; };
+        default = scopeHost.main.override {
+            disable_features = [
+                # dont include experimental features
+                "experimental"
+                # jemalloc profiling/stats features are expensive and shouldn't
+                # be expected on non-debug builds.
+                "jemalloc_prof"
+                "jemalloc_stats"
+                # this is non-functional on nix for some reason
+                "hardened_malloc"
+                # conduwuit_mods is a development-only hot reload feature
+                "conduwuit_mods"
+            ];
+        };
+        default-debug = scopeHost.main.override {
+            profile = "dev";
+            # debug build users expect full logs
+            disable_release_max_log_level = true;
+            disable_features = [
+                # dont include experimental features
+                "experimental"
+                # this is non-functional on nix for some reason
+                "hardened_malloc"
+                # conduwuit_mods is a development-only hot reload feature
+                "conduwuit_mods"
+            ];
+        };
+        # just a test profile used for things like CI and complement
+        default-test = scopeHost.main.override {
+            profile = "test";
+            disable_release_max_log_level = true;
+            disable_features = [
+                # dont include experimental features
+                "experimental"
+                # this is non-functional on nix for some reason
+                "hardened_malloc"
+                # conduwuit_mods is a development-only hot reload feature
+                "conduwuit_mods"
+            ];
+        };
+        all-features = scopeHost.main.override {
+            all_features = true;
+            disable_features = [
+                # dont include experimental features
+                "experimental"
+                # jemalloc profiling/stats features are expensive and shouldn't
+                # be expected on non-debug builds.
+                "jemalloc_prof"
+                "jemalloc_stats"
+                # this is non-functional on nix for some reason
+                "hardened_malloc"
+                # conduwuit_mods is a development-only hot reload feature
+                "conduwuit_mods"
+            ];
+        };
+        all-features-debug = scopeHost.main.override {
+            profile = "dev";
+            all_features = true;
+            # debug build users expect full logs
+            disable_release_max_log_level = true;
+            disable_features = [
+                # dont include experimental features
+                "experimental"
+                # this is non-functional on nix for some reason
+                "hardened_malloc"
+                # conduwuit_mods is a development-only hot reload feature
+                "conduwuit_mods"
+            ];
+        };
         hmalloc = scopeHost.main.override { features = ["hardened_malloc"]; };
 
         oci-image = scopeHost.oci-image;
-        oci-image-jemalloc = scopeHost.oci-image.override {
+        oci-image-all-features = scopeHost.oci-image.override {
           main = scopeHost.main.override {
-            features = ["jemalloc"];
+            all_features = true;
+            disable_features = [
+                # dont include experimental features
+                "experimental"
+                # jemalloc profiling/stats features are expensive and shouldn't
+                # be expected on non-debug builds.
+                "jemalloc_prof"
+                "jemalloc_stats"
+                # this is non-functional on nix for some reason
+                "hardened_malloc"
+                # conduwuit_mods is a development-only hot reload feature
+                "conduwuit_mods"
+            ];
+          };
+        };
+        oci-image-all-features-debug = scopeHost.oci-image.override {
+          main = scopeHost.main.override {
+            profile = "dev";
+            all_features = true;
+            # debug build users expect full logs
+            disable_release_max_log_level = true;
+            disable_features = [
+                # dont include experimental features
+                "experimental"
+                # this is non-functional on nix for some reason
+                "hardened_malloc"
+                # conduwuit_mods is a development-only hot reload feature
+                "conduwuit_mods"
+            ];
           };
         };
         oci-image-hmalloc = scopeHost.oci-image.override {
@@ -63,6 +301,9 @@
         book = scopeHost.book;
 
         complement = scopeHost.complement;
+        static-complement = scopeHostStatic.complement;
+        # macOS containers don't exist, so the complement images must be forced to linux
+        linux-complement = (mkCrossScope "${pkgsHost.hostPlatform.qemuArch}-linux-musl").complement;
       }
       //
       builtins.listToAttrs
@@ -71,14 +312,7 @@
             (crossSystem:
               let
                 binaryName = "static-${crossSystem}";
-                pkgsCrossStatic =
-                  (import inputs.nixpkgs {
-                    inherit system;
-                    crossSystem = {
-                      config = crossSystem;
-                    };
-                  }).pkgsStatic;
-                scopeCrossStatic = scope pkgsCrossStatic;
+                scopeCrossStatic = mkCrossScope crossSystem;
               in
               [
                 # An output for a statically-linked binary
@@ -87,11 +321,101 @@
                   value = scopeCrossStatic.main;
                 }
 
-                # An output for a statically-linked binary with jemalloc
+                # An output for a statically-linked binary with x86_64 haswell
+                # target optimisations
                 {
-                  name = "${binaryName}-jemalloc";
+                  name = "${binaryName}-x86_64-haswell-optimised";
                   value = scopeCrossStatic.main.override {
-                    features = ["jemalloc"];
+                    x86_64_haswell_target_optimised = (if (crossSystem == "x86_64-linux-gnu" || crossSystem == "x86_64-linux-musl") then true else false);
+                  };
+                }
+
+                # An output for a statically-linked unstripped debug ("dev") binary
+                {
+                  name = "${binaryName}-debug";
+                  value = scopeCrossStatic.main.override {
+                    profile = "dev";
+                    # debug build users expect full logs
+                    disable_release_max_log_level = true;
+                  };
+                }
+
+                # An output for a statically-linked unstripped debug binary with the
+                # "test" profile (for CI usage only)
+                {
+                  name = "${binaryName}-test";
+                  value = scopeCrossStatic.main.override {
+                    profile = "test";
+                    disable_release_max_log_level = true;
+                    disable_features = [
+                        # dont include experimental features
+                        "experimental"
+                        # this is non-functional on nix for some reason
+                        "hardened_malloc"
+                        # conduwuit_mods is a development-only hot reload feature
+                        "conduwuit_mods"
+                    ];
+                  };
+                }
+
+                # An output for a statically-linked binary with `--all-features`
+                {
+                  name = "${binaryName}-all-features";
+                  value = scopeCrossStatic.main.override {
+                    all_features = true;
+                    disable_features = [
+                        # dont include experimental features
+                        "experimental"
+                        # jemalloc profiling/stats features are expensive and shouldn't
+                        # be expected on non-debug builds.
+                        "jemalloc_prof"
+                        "jemalloc_stats"
+                        # this is non-functional on nix for some reason
+                        "hardened_malloc"
+                        # conduwuit_mods is a development-only hot reload feature
+                        "conduwuit_mods"
+                    ];
+                  };
+                }
+
+                # An output for a statically-linked binary with `--all-features` and with x86_64 haswell
+                # target optimisations
+                {
+                  name = "${binaryName}-all-features-x86_64-haswell-optimised";
+                  value = scopeCrossStatic.main.override {
+                    all_features = true;
+                    disable_features = [
+                        # dont include experimental features
+                        "experimental"
+                        # jemalloc profiling/stats features are expensive and shouldn't
+                        # be expected on non-debug builds.
+                        "jemalloc_prof"
+                        "jemalloc_stats"
+                        # this is non-functional on nix for some reason
+                        "hardened_malloc"
+                        # conduwuit_mods is a development-only hot reload feature
+                        "conduwuit_mods"
+                    ];
+                    x86_64_haswell_target_optimised = (if (crossSystem == "x86_64-linux-gnu" || crossSystem == "x86_64-linux-musl") then true else false);
+                  };
+                }
+
+                # An output for a statically-linked unstripped debug ("dev") binary with `--all-features`
+                {
+                  name = "${binaryName}-all-features-debug";
+                  value = scopeCrossStatic.main.override {
+                    profile = "dev";
+                    all_features = true;
+                    # debug build users expect full logs
+                    disable_release_max_log_level = true;
+                    disable_features = [
+                        # dont include experimental features
+                        "experimental"
+                        # this is non-functional on nix for some reason
+                        "hardened_malloc"
+                        # conduwuit_mods is a development-only hot reload feature
+                        "conduwuit_mods"
+                    ];
                   };
                 }
 
@@ -109,12 +433,92 @@
                   value = scopeCrossStatic.oci-image;
                 }
 
-                # An output for an OCI image based on that binary with jemalloc
+                # An output for an OCI image based on that binary with x86_64 haswell
+                # target optimisations
                 {
-                  name = "oci-image-${crossSystem}-jemalloc";
+                  name = "oci-image-${crossSystem}-x86_64-haswell-optimised";
                   value = scopeCrossStatic.oci-image.override {
                     main = scopeCrossStatic.main.override {
-                      features = ["jemalloc"];
+                      x86_64_haswell_target_optimised = (if (crossSystem == "x86_64-linux-gnu" || crossSystem == "x86_64-linux-musl") then true else false);
+                    };
+                  };
+                }
+
+                # An output for an OCI image based on that unstripped debug ("dev") binary
+                {
+                  name = "oci-image-${crossSystem}-debug";
+                  value = scopeCrossStatic.oci-image.override {
+                    main = scopeCrossStatic.main.override {
+                        profile = "dev";
+                        # debug build users expect full logs
+                        disable_release_max_log_level = true;
+                    };
+                  };
+                }
+
+                # An output for an OCI image based on that binary with `--all-features`
+                {
+                  name = "oci-image-${crossSystem}-all-features";
+                  value = scopeCrossStatic.oci-image.override {
+                    main = scopeCrossStatic.main.override {
+                      all_features = true;
+                      disable_features = [
+                        # dont include experimental features
+                        "experimental"
+                        # jemalloc profiling/stats features are expensive and shouldn't
+                        # be expected on non-debug builds.
+                        "jemalloc_prof"
+                        "jemalloc_stats"
+                        # this is non-functional on nix for some reason
+                        "hardened_malloc"
+                        # conduwuit_mods is a development-only hot reload feature
+                        "conduwuit_mods"
+                      ];
+                    };
+                  };
+                }
+
+                # An output for an OCI image based on that binary with `--all-features` and with x86_64 haswell
+                # target optimisations
+                {
+                  name = "oci-image-${crossSystem}-all-features-x86_64-haswell-optimised";
+                  value = scopeCrossStatic.oci-image.override {
+                    main = scopeCrossStatic.main.override {
+                      all_features = true;
+                      disable_features = [
+                        # dont include experimental features
+                        "experimental"
+                        # jemalloc profiling/stats features are expensive and shouldn't
+                        # be expected on non-debug builds.
+                        "jemalloc_prof"
+                        "jemalloc_stats"
+                        # this is non-functional on nix for some reason
+                        "hardened_malloc"
+                        # conduwuit_mods is a development-only hot reload feature
+                        "conduwuit_mods"
+                      ];
+                      x86_64_haswell_target_optimised = (if (crossSystem == "x86_64-linux-gnu" || crossSystem == "x86_64-linux-musl") then true else false);
+                    };
+                  };
+                }
+
+                # An output for an OCI image based on that unstripped debug ("dev") binary with `--all-features`
+                {
+                  name = "oci-image-${crossSystem}-all-features-debug";
+                  value = scopeCrossStatic.oci-image.override {
+                    main = scopeCrossStatic.main.override {
+                      profile = "dev";
+                      all_features = true;
+                      # debug build users expect full logs
+                      disable_release_max_log_level = true;
+                      disable_features = [
+                        # dont include experimental features
+                        "experimental"
+                        # this is non-functional on nix for some reason
+                        "hardened_malloc"
+                        # conduwuit_mods is a development-only hot reload feature
+                        "conduwuit_mods"
+                      ];
                     };
                   };
                 }
@@ -128,59 +532,47 @@
                     };
                   };
                 }
+
+                # An output for a complement OCI image for the specified platform
+                {
+                  name = "complement-${crossSystem}";
+                  value = scopeCrossStatic.complement;
+                }
               ]
             )
             [
-              "x86_64-unknown-linux-musl"
-              "aarch64-unknown-linux-musl"
+              #"x86_64-apple-darwin"
+              #"aarch64-apple-darwin"
+              "x86_64-linux-gnu"
+              "x86_64-linux-musl"
+              "aarch64-linux-musl"
             ]
           )
         );
 
-      devShells.default = pkgsHost.mkShell {
-        env = scopeHost.main.env // {
-          # Rust Analyzer needs to be able to find the path to default crate
-          # sources, and it can read this environment variable to do so. The
-          # `rust-src` component is required in order for this to work.
-          RUST_SRC_PATH = "${toolchain}/lib/rustlib/src/rust/library";
-
-          # Convenient way to access a pinned version of Complement's source
-          # code.
-          COMPLEMENT_SRC = inputs.complement.outPath;
+      devShells.default = mkDevShell scopeHostStatic;
+      devShells.all-features = mkDevShell
+        (scopeHostStatic.overrideScope (final: prev: {
+          main = prev.main.override {
+            all_features = true;
+            disable_features = [
+                # dont include experimental features
+                "experimental"
+                # jemalloc profiling/stats features are expensive and shouldn't
+                # be expected on non-debug builds.
+                "jemalloc_prof"
+                "jemalloc_stats"
+                # this is non-functional on nix for some reason
+                "hardened_malloc"
+                # conduwuit_mods is a development-only hot reload feature
+                "conduwuit_mods"
+            ];
         };
-
-        # Development tools
-        packages = [
-          # Always use nightly rustfmt because most of its options are unstable
-          #
-          # This needs to come before `toolchain` in this list, otherwise
-          # `$PATH` will have stable rustfmt instead.
-          inputs.fenix.packages.${system}.latest.rustfmt
-
-          toolchain
-        ]
-        ++ (with pkgsHost; [
-          engage
-          cargo-audit
-
-          # Needed for producing Debian packages
-          cargo-deb
-
-          # Needed for Complement
-          go
-          olm
-
-          # Needed for our script for Complement
-          jq
-
-          # Needed for finding broken markdown links
-          lychee
-
-          # Useful for editing the book locally
-          mdbook
-        ])
-        ++
-        scopeHost.main.nativeBuildInputs;
-      };
+        }));
+      devShells.no-features = mkDevShell
+        (scopeHostStatic.overrideScope (final: prev: {
+          main = prev.main.override { default_features = false; };
+        }));
+      devShells.dynamic = mkDevShell scopeHost;
     });
 }

nix/pkgs/book/default.nix

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

nix/pkgs/complement/certificate.crt

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDfzCCAmegAwIBAgIUcrZdSPmCh33Evys/U6mTPpShqdcwDQYJKoZIhvcNAQEL
+BQAwPzELMAkGA1UEBhMCNjkxCzAJBgNVBAgMAjQyMRUwEwYDVQQKDAx3b29mZXJz
+IGluYy4xDDAKBgNVBAMMA2hzMTAgFw0yNTAzMTMxMjU4NTFaGA8yMDUyMDcyODEy
+NTg1MVowPzELMAkGA1UEBhMCNjkxCzAJBgNVBAgMAjQyMRUwEwYDVQQKDAx3b29m
+ZXJzIGluYy4xDDAKBgNVBAMMA2hzMTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCC
+AQoCggEBANL+h2ZmK/FqN5uLJPtIy6Feqcyb6EX7MQBEtxuJ56bTAbjHuCLZLpYt
+/wOWJ91drHqZ7Xd5iTisGdMu8YS803HSnHkzngf4VXKhVrdzW2YDrpZRxmOhtp88
+awOHmP7mqlJyBbCOQw8aDVrT0KmEIWzA7g+nFRQ5Ff85MaP+sQrHGKZbo61q8HBp
+L0XuaqNckruUKtxnEqrm5xx5sYyYKg7rrSFE5JMFoWKB1FNWJxyWT42BhGtnJZsK
+K5c+NDSOU4TatxoN6mpNSBpCz/a11PiQHMEfqRk6JA4g3911dqPTfZBevUdBh8gl
+8maIzqeZGhvyeKTmull1Y0781yyuj98CAwEAAaNxMG8wCQYDVR0TBAIwADALBgNV
+HQ8EBAMCBPAwNgYDVR0RBC8wLYIRKi5kb2NrZXIuaW50ZXJuYWyCA2hzMYIDaHMy
+ggNoczOCA2hzNIcEfwAAATAdBgNVHQ4EFgQUr4VYrmW1d+vjBTJewvy7fJYhLDYw
+DQYJKoZIhvcNAQELBQADggEBADkYqkjNYxjWX8hUUAmFHNdCwzT1CpYe/5qzLiyJ
+irDSdMlC5g6QqMUSrpu7nZxo1lRe1dXGroFVfWpoDxyCjSQhplQZgtYqtyLfOIx+
+HQ7cPE/tUU/KsTGc0aL61cETB6u8fj+rQKUGdfbSlm0Rpu4v0gC8RnDj06X/hZ7e
+VkWU+dOBzxlqHuLlwFFtVDgCyyTatIROx5V+GpMHrVqBPO7HcHhwqZ30k2kMM8J3
+y1CWaliQM85jqtSZV+yUHKQV8EksSowCFJuguf+Ahz0i0/koaI3i8m4MRN/1j13d
+jbTaX5a11Ynm3A27jioZdtMRty6AJ88oCp18jxVzqTxNNO4=
+-----END CERTIFICATE-----

nix/pkgs/complement/config.toml

@@ -5,15 +5,46 @@ allow_guest_registration = true
 allow_public_room_directory_over_federation = true
 allow_public_room_directory_without_auth = true
 allow_registration = true
-allow_unstable_room_versions = true
-database_backend = "rocksdb"
 database_path = "/database"
-log = "trace"
+log = "trace,h2=debug,hyper=debug"
 port = [8008, 8448]
 trusted_servers = []
+only_query_trusted_key_servers = false
+query_trusted_key_servers_first = false
+query_trusted_key_servers_first_on_join = 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 = ["*"]
+url_preview_domain_explicit_denylist = ["*"]
+media_compat_file_link = false
+media_startup_check = true
+prune_missing_media = true
+log_colors = true
+admin_room_notices = false
+allow_check_for_updates = false
+intentionally_unknown_config_option_for_testing = true
+rocksdb_log_level = "info"
+rocksdb_max_log_files = 1
+rocksdb_recovery_mode = 0
+rocksdb_paranoid_file_checks = true
+log_guest_registrations = false
+allow_legacy_media = true
+startup_netburst = true
+startup_netburst_keep = -1
+
+allow_invalid_tls_certificates_yes_i_know_what_the_fuck_i_am_doing_with_this_and_i_know_this_is_insecure = true
+
+# valgrind makes things so slow
+dns_timeout = 60
+dns_attempts = 20
+request_conn_timeout = 60
+request_timeout = 120
+well_known_conn_timeout = 60
+well_known_timeout = 60
+federation_idle_timeout = 300
+sender_timeout = 300
+sender_idle_timeout = 300
+sender_retry_backoff_limit = 300
 
 [global.tls]
-certs = "/certificate.crt"
 dual_protocol = true
-key = "/private_key.key"

nix/pkgs/complement/default.nix

@@ -3,10 +3,8 @@
 , buildEnv
 , coreutils
 , dockerTools
-, gawk
 , lib
 , main
-, openssl
 , stdenv
 , tini
 , writeShellScriptBin
@@ -14,46 +12,43 @@
 
 let
   main' = main.override {
-    profile = "dev";
-    features = ["axum_dual_protocol"];
+    profile = "test";
+    all_features = true;
+    disable_release_max_log_level = true;
+    disable_features = [
+        # console/CLI stuff isn't used or relevant for complement
+        "console"
+        "tokio_console"
+        # sentry telemetry isn't useful for complement, disabled by default anyways
+        "sentry_telemetry"
+        "perf_measurements"
+        # this is non-functional on nix for some reason
+        "hardened_malloc"
+        # dont include experimental features
+        "experimental"
+        # compression isn't needed for complement
+        "brotli_compression"
+        "gzip_compression"
+        "zstd_compression"
+        # complement doesn't need hot reloading
+        "conduwuit_mods"
+        # complement doesn't have URL preview media tests
+        "url_preview"
+    ];
   };
 
   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"} \
-      CONDUIT_SERVER_NAME="$SERVER_NAME" \
-      CONDUIT_WELL_KNOWN_SERVER="$SERVER_NAME:8448" \
-      CONDUIT_WELL_KNOWN_SERVER="$SERVER_NAME:8008" \
+      CONDUWUIT_SERVER_NAME="$SERVER_NAME" \
       ${lib.getExe main'}
   '';
 in
 
 dockerTools.buildImage {
-  name = "complement-${main.pname}";
-  tag = "dev";
+  name = "complement-conduwuit";
+  tag = "main";
 
   copyToRoot = buildEnv {
     name = "root";
@@ -73,15 +68,17 @@ dockerTools.buildImage {
       "${lib.getExe start}"
     ];
 
-    Entrypoint = if !stdenv.isDarwin
+    Entrypoint = if !stdenv.hostPlatform.isDarwin
       # Use the `tini` init system so that signals (e.g. ctrl+c/SIGINT)
       # are handled as expected
       then [ "${lib.getExe' tini "tini"}" "--" ]
       else [];
 
     Env = [
-      "SSL_CERT_FILE=/complement/ca/ca.crt"
-      "CONDUIT_CONFIG=${./config.toml}"
+      "CONDUWUIT_TLS__KEY=${./private_key.key}"
+      "CONDUWUIT_TLS__CERTS=${./certificate.crt}"
+      "CONDUWUIT_CONFIG=${./config.toml}"
+      "RUST_BACKTRACE=full"
     ];
 
     ExposedPorts = {

nix/pkgs/complement/private_key.key

@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDS/odmZivxajeb
+iyT7SMuhXqnMm+hF+zEARLcbieem0wG4x7gi2S6WLf8DlifdXax6me13eYk4rBnT
+LvGEvNNx0px5M54H+FVyoVa3c1tmA66WUcZjobafPGsDh5j+5qpScgWwjkMPGg1a
+09CphCFswO4PpxUUORX/OTGj/rEKxximW6OtavBwaS9F7mqjXJK7lCrcZxKq5ucc
+ebGMmCoO660hROSTBaFigdRTVicclk+NgYRrZyWbCiuXPjQ0jlOE2rcaDepqTUga
+Qs/2tdT4kBzBH6kZOiQOIN/ddXaj032QXr1HQYfIJfJmiM6nmRob8nik5rpZdWNO
+/Ncsro/fAgMBAAECggEAITCCkfv+a5I+vwvrPE/eIDso0JOxvNhfg+BLQVy3AMnu
+WmeoMmshZeREWgcTrEGg8QQnk4Sdrjl8MnkO6sddJ2luza3t7OkGX+q7Hk5aETkB
+DIo+f8ufU3sIhlydF3OnVSK0fGpUaBq8AQ6Soyeyrk3G5NVufmjgae5QPbDBnqUb
+piOGyfcwagL4JtCbZsMk8AT7vQSynLm6zaWsVzWNd71jummLqtVV063K95J9PqVN
+D8meEcP3WR5kQrvf+mgy9RVgWLRtVWN8OLZfJ9yrnl4Efj62elrldUj4jaCFezGQ
+8f0W+d8jjt038qhmEdymw2MWQ+X/b0R79lJar1Up8QKBgQD1DtHxauhl+JUoI3y+
+3eboqXl7YPJt1/GTnChb4b6D1Z1hvLsOKUa7hjGEfruYGbsWXBCRMICdfzp+iWcq
+/lEOp7/YU9OaW4lQMoG4sXMoBWd9uLgg0E+aH6VDJOBvxsfafqM4ufmtspzwEm90
+FU1cq6oImomFnPChSq4X+3+YpwKBgQDcalaK9llCcscWA8HAP8WVVNTjCOqiDp9q
+td61E9IO/FIB/gW5y+JkaFRrA2CN1zY3s3K92uveLTNYTArecWlDcPNNFDuaYu2M
+Roz4bC104HGh+zztJ0iPVzELL81Lgg6wHhLONN+eVi4gTftJxzJFXybyb+xVT25A
+91ynKXB+CQKBgQC+Ub43MoI+/6pHvBfb3FbDByvz6D0flgBmVXb6tP3TQYmzKHJV
+8zSd2wCGGC71V7Z3DRVIzVR1/SOetnPLbivhp+JUzfWfAcxI3pDksdvvjxLrDxTh
+VycbWcxtsywjY0w/ou581eLVRcygnpC0pP6qJCAwAmUfwd0YRvmiYo6cLQKBgHIW
+UIlJDdaJFmdctnLOD3VGHZMOUHRlYTqYvJe5lKbRD5mcZFZRI/OY1Ok3LEj+tj+K
+kL+YizHK76KqaY3N4hBYbHbfHCLDRfWvptQHGlg+vFJ9eoG+LZ6UIPyLV5XX0cZz
+KoS1dXG9Zc6uznzXsDucDsq6B/f4TzctUjXsCyARAoGAOKb4HtuNyYAW0jUlujR7
+IMHwUesOGlhSXqFtP9aTvk6qJgvV0+3CKcWEb4y02g+uYftP8BLNbJbIt9qOqLYh
+tOVyzCoamAi8araAhjA0w4dXvqDCDK7k/gZFkojmKQtRijoxTHnWcDc3vAjYCgaM
+9MVtdgSkuh2gwkD/mMoAJXM=
+-----END PRIVATE KEY-----

nix/pkgs/complement/signing_request.csr

@@ -0,0 +1,16 @@
+-----BEGIN CERTIFICATE REQUEST-----
+MIIChDCCAWwCAQAwPzELMAkGA1UEBhMCNjkxCzAJBgNVBAgMAjQyMRUwEwYDVQQK
+DAx3b29mZXJzIGluYy4xDDAKBgNVBAMMA2hzMTCCASIwDQYJKoZIhvcNAQEBBQAD
+ggEPADCCAQoCggEBANL+h2ZmK/FqN5uLJPtIy6Feqcyb6EX7MQBEtxuJ56bTAbjH
+uCLZLpYt/wOWJ91drHqZ7Xd5iTisGdMu8YS803HSnHkzngf4VXKhVrdzW2YDrpZR
+xmOhtp88awOHmP7mqlJyBbCOQw8aDVrT0KmEIWzA7g+nFRQ5Ff85MaP+sQrHGKZb
+o61q8HBpL0XuaqNckruUKtxnEqrm5xx5sYyYKg7rrSFE5JMFoWKB1FNWJxyWT42B
+hGtnJZsKK5c+NDSOU4TatxoN6mpNSBpCz/a11PiQHMEfqRk6JA4g3911dqPTfZBe
+vUdBh8gl8maIzqeZGhvyeKTmull1Y0781yyuj98CAwEAAaAAMA0GCSqGSIb3DQEB
+CwUAA4IBAQDR/gjfxN0IID1MidyhZB4qpdWn3m6qZnEQqoTyHHdWalbfNXcALC79
+ffS+Smx40N5hEPvqy6euR89N5YuYvt8Hs+j7aWNBn7Wus5Favixcm2JcfCTJn2R3
+r8FefuSs2xGkoyGsPFFcXE13SP/9zrZiwvOgSIuTdz/Pbh6GtEx7aV4DqHJsrXnb
+XuPxpQleoBqKvQgSlmaEBsJg13TQB+Fl2foBVUtqAFDQiv+RIuircf0yesMCKJaK
+MPH4Oo+r3pR8lI8ewfJPreRhCoV+XrGYMubaakz003TJ1xlOW8M+N9a6eFyMVh76
+U1nY/KP8Ua6Lgaj9PRz7JCRzNoshZID/
+-----END CERTIFICATE REQUEST-----

nix/pkgs/complement/v3.ext

@@ -4,3 +4,9 @@ keyUsage = digitalSignature, nonRepudiation, keyEncipherment, dataEncipherment
 subjectAltName = @alt_names
 
 [alt_names]
+DNS.1 = *.docker.internal
+DNS.2 = hs1
+DNS.3 = hs2
+DNS.4 = hs3
+DNS.5 = hs4
+IP.1 = 127.0.0.1

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

@@ -22,25 +22,13 @@ lib.optionalAttrs 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"
+            "c"
+
             "-l"
             "stdc++"
+
             "-L"
             "${stdenv.cc.cc.lib}/${stdenv.hostPlatform.config}/lib"
           ]
@@ -52,7 +40,7 @@ lib.optionalAttrs stdenv.hostPlatform.isStatic {
 # even covers the case of build scripts that need native code compiled and
 # run on the build platform (I think).
 #
-# [0]: https://github.com/NixOS/nixpkgs/blob/5cdb38bb16c6d0a38779db14fcc766bc1b2394d6/pkgs/build-support/rust/lib/default.nix#L57-L80
+# [0]: https://github.com/NixOS/nixpkgs/blob/nixpkgs-unstable/pkgs/build-support/rust/lib/default.nix#L48-L68
 //
 (
   let
@@ -68,8 +56,7 @@ lib.optionalAttrs stdenv.hostPlatform.isStatic {
       {
         "CC_${cargoEnvVarTarget}" = envVars.ccForTarget;
         "CXX_${cargoEnvVarTarget}" = envVars.cxxForTarget;
-        "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" =
-          envVars.linkerForTarget;
+        "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" = envVars.ccForTarget;
       }
     )
   //
@@ -80,7 +67,7 @@ lib.optionalAttrs stdenv.hostPlatform.isStatic {
     {
       "CC_${cargoEnvVarTarget}" = envVars.ccForHost;
       "CXX_${cargoEnvVarTarget}" = envVars.cxxForHost;
-      "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" = envVars.linkerForHost;
+      "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" = envVars.ccForHost;
       CARGO_BUILD_TARGET = rustcTarget;
     }
   )
@@ -92,7 +79,7 @@ lib.optionalAttrs stdenv.hostPlatform.isStatic {
     {
       "CC_${cargoEnvVarTarget}" = envVars.ccForBuild;
       "CXX_${cargoEnvVarTarget}" = envVars.cxxForBuild;
-      "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" = envVars.linkerForBuild;
+      "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" = envVars.ccForBuild;
       HOST_CC = "${pkgsBuildHost.stdenv.cc}/bin/cc";
       HOST_CXX = "${pkgsBuildHost.stdenv.cc}/bin/c++";
     }

nix/pkgs/main/default.nix

@@ -1,27 +1,120 @@
 # Dependencies (keep sorted)
 { craneLib
 , inputs
+, jq
 , lib
 , libiconv
+, liburing
 , pkgsBuildHost
 , rocksdb
+, removeReferencesTo
 , rust
+, rust-jemalloc-sys
 , stdenv
 
 # Options (keep sorted)
+, all_features ? false
 , default_features ? true
+# default list of disabled features
+, disable_features ? [
+  # dont include experimental features
+  "experimental"
+  # jemalloc profiling/stats features are expensive and shouldn't
+  # be expected on non-debug builds.
+  "jemalloc_prof"
+  "jemalloc_stats"
+  # this is non-functional on nix for some reason
+  "hardened_malloc"
+  # conduwuit_mods is a development-only hot reload feature
+  "conduwuit_mods"
+]
+, disable_release_max_log_level ? false
 , features ? []
 , profile ? "release"
+# rocksdb compiled with -march=haswell and target-cpu=haswell rustflag
+# haswell is pretty much any x86 cpu made in the last 12 years, and
+# supports modern CPU extensions that rocksdb can make use of.
+# disable if trying to make a portable x86_64 build for very old hardware
+, x86_64_haswell_target_optimised ? false
 }:
 
 let
+# We perform default-feature unification in nix, because some of the dependencies
+# on the nix side depend on feature values.
+crateFeatures = path:
+  let manifest = lib.importTOML "${path}/Cargo.toml"; in
+  lib.remove "default" (lib.attrNames manifest.features);
+crateDefaultFeatures = path:
+  (lib.importTOML "${path}/Cargo.toml").features.default;
+allDefaultFeatures = crateDefaultFeatures "${inputs.self}/src/main";
+allFeatures = crateFeatures "${inputs.self}/src/main";
+features' = lib.unique
+  (features ++
+    lib.optionals default_features allDefaultFeatures ++
+    lib.optionals all_features allFeatures);
+disable_features' = disable_features ++ lib.optionals disable_release_max_log_level ["release_max_log_level"];
+features'' = lib.subtractLists disable_features' features';
+
+featureEnabled = feature : builtins.elem feature features'';
+
+enableLiburing = featureEnabled "io_uring" && !stdenv.hostPlatform.isDarwin;
+
+# This derivation will set the JEMALLOC_OVERRIDE variable, causing the
+# tikv-jemalloc-sys crate to use the nixpkgs jemalloc instead of building it's
+# own. In order for this to work, we need to set flags on the build that match
+# whatever flags tikv-jemalloc-sys was going to use. These are dependent on
+# which features we enable in tikv-jemalloc-sys.
+rust-jemalloc-sys' = (rust-jemalloc-sys.override {
+  # tikv-jemalloc-sys/unprefixed_malloc_on_supported_platforms feature
+  unprefixed = true;
+}).overrideAttrs (old: {
+  configureFlags = old.configureFlags ++
+    # we dont need docs
+    [ "--disable-doc" ] ++
+    # we dont need cxx/C++ integration
+    [ "--disable-cxx" ] ++
+    # tikv-jemalloc-sys/profiling feature
+    lib.optional (featureEnabled "jemalloc_prof") "--enable-prof" ++
+    # tikv-jemalloc-sys/stats feature
+    (if (featureEnabled "jemalloc_stats") then [ "--enable-stats" ] else [ "--disable-stats" ]);
+});
+
 buildDepsOnlyEnv =
   let
-    rocksdb' = rocksdb.override {
-      enableJemalloc = builtins.elem "jemalloc" features;
-    };
+    rocksdb' = (rocksdb.override {
+      jemalloc = lib.optional (featureEnabled "jemalloc") rust-jemalloc-sys';
+      # rocksdb fails to build with prefixed jemalloc, which is required on
+      # darwin due to [1]. In this case, fall back to building rocksdb with
+      # libc malloc. This should not cause conflicts, because all of the
+      # jemalloc symbols are prefixed.
+      #
+      # [1]: https://github.com/tikv/jemallocator/blob/ab0676d77e81268cd09b059260c75b38dbef2d51/jemalloc-sys/src/env.rs#L17
+      enableJemalloc = featureEnabled "jemalloc" && !stdenv.hostPlatform.isDarwin;
+
+      # for some reason enableLiburing in nixpkgs rocksdb is default true
+      # which breaks Darwin entirely
+      enableLiburing = enableLiburing;
+    }).overrideAttrs (old: {
+      enableLiburing = enableLiburing;
+      cmakeFlags = (if x86_64_haswell_target_optimised then (lib.subtractLists [
+        # dont make a portable build if x86_64_haswell_target_optimised is enabled
+        "-DPORTABLE=1"
+      ] old.cmakeFlags
+      ++ [ "-DPORTABLE=haswell" ]) else ([ "-DPORTABLE=1" ])
+      )
+      ++ old.cmakeFlags;
+
+      # outputs has "tools" which we dont need or use
+      outputs = [ "out" ];
+
+      # preInstall hooks has stuff for messing with ldb/sst_dump which we dont need or use
+      preInstall = "";
+    });
   in
   {
+    # https://crane.dev/faq/rebuilds-bindgen.html
+    NIX_OUTPATH_USED_AS_RANDOM_SEED = "aaaaaaaaaa";
+
     CARGO_PROFILE = profile;
     ROCKSDB_INCLUDE_DIR = "${rocksdb'}/include";
     ROCKSDB_LIB_DIR = "${rocksdb'}/lib";
@@ -37,8 +130,17 @@ buildDepsOnlyEnv =
   });
 
 buildPackageEnv = {
-  CONDUWUIT_VERSION_EXTRA = inputs.self.shortRev or inputs.self.dirtyShortRev;
-} // buildDepsOnlyEnv;
+  CONDUWUIT_VERSION_EXTRA = inputs.self.shortRev or inputs.self.dirtyShortRev or "";
+} // buildDepsOnlyEnv // {
+  # Only needed in static stdenv because these are transitive dependencies of rocksdb
+  CARGO_BUILD_RUSTFLAGS = buildDepsOnlyEnv.CARGO_BUILD_RUSTFLAGS
+    + lib.optionalString (enableLiburing && stdenv.hostPlatform.isStatic)
+      " -L${lib.getLib liburing}/lib -luring"
+    + lib.optionalString x86_64_haswell_target_optimised
+      " -Ctarget-cpu=haswell";
+};
+
+
 
 commonAttrs = {
   inherit
@@ -53,20 +155,46 @@ commonAttrs = {
 
       # Keep sorted
       include = [
+        ".cargo"
         "Cargo.lock"
         "Cargo.toml"
-        "hot_lib"
         "src"
       ];
     };
 
+    doCheck = true;
+
+    cargoExtraArgs = "--no-default-features --locked "
+      + lib.optionalString
+        (features'' != [])
+        "--features " + (builtins.concatStringsSep "," features'');
+
+    dontStrip = profile == "dev" || profile == "test";
+    dontPatchELF = profile == "dev" || profile == "test";
+
+    buildInputs = lib.optional (featureEnabled "jemalloc") rust-jemalloc-sys'
+    # needed to build Rust applications on macOS
+    ++ lib.optionals stdenv.hostPlatform.isDarwin [
+        # https://github.com/NixOS/nixpkgs/issues/206242
+        # ld: library not found for -liconv
+        libiconv
+        # https://stackoverflow.com/questions/69869574/properly-adding-darwin-apple-sdk-to-a-nix-shell
+        # https://discourse.nixos.org/t/compile-a-rust-binary-on-macos-dbcrossbar/8612
+        pkgsBuildHost.darwin.apple_sdk.frameworks.Security
+      ];
+
     nativeBuildInputs = [
       # bindgen needs the build platform's libclang. Apparently due to "splicing
       # weirdness", pkgs.rustPlatform.bindgenHook on its own doesn't quite do the
       # right thing here.
       pkgsBuildHost.rustPlatform.bindgenHook
-  ]
-  ++ lib.optionals stdenv.isDarwin [ libiconv ];
+
+      # 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
+  ];
  };
 in
 
@@ -75,16 +203,12 @@ craneLib.buildPackage ( commonAttrs // {
     env = buildDepsOnlyEnv;
   });
 
-  cargoExtraArgs = ""
-    + lib.optionalString
-      (!default_features)
-      "--no-default-features "
-    + lib.optionalString
-      (features != [])
-      "--features " + (builtins.concatStringsSep "," features);
+  doCheck = true;
 
-  # This is redundant with CI
-  doCheck = false;
+  cargoExtraArgs = "--no-default-features --locked "
+    + lib.optionalString
+      (features'' != [])
+      "--features " + (builtins.concatStringsSep "," features'');
 
   env = buildPackageEnv;
 

nix/pkgs/oci-image/default.nix

@@ -14,9 +14,10 @@ dockerTools.buildLayeredImage {
   created = "@${toString inputs.self.lastModified}";
   contents = [
     dockerTools.caCertificates
+    main
   ];
   config = {
-    Entrypoint = if !stdenv.isDarwin
+    Entrypoint = if !stdenv.hostPlatform.isDarwin
       # Use the `tini` init system so that signals (e.g. ctrl+c/SIGINT)
       # are handled as expected
       then [ "${lib.getExe' tini "tini"}" "--" ]
@@ -24,5 +25,22 @@ dockerTools.buildLayeredImage {
     Cmd = [
       "${lib.getExe main}"
     ];
+    Env = [
+      "RUST_BACKTRACE=full"
+    ];
+    Labels = {
+      "org.opencontainers.image.authors" = "June Clementine Strawberry <june@girlboss.ceo> and Jason Volk
+      <jason@zemos.net>";
+      "org.opencontainers.image.created" ="@${toString inputs.self.lastModified}";
+      "org.opencontainers.image.description" = "a very cool Matrix chat homeserver written in Rust";
+      "org.opencontainers.image.documentation" = "https://conduwuit.puppyirl.gay/";
+      "org.opencontainers.image.licenses" = "Apache-2.0";
+      "org.opencontainers.image.revision" = inputs.self.rev or inputs.self.dirtyRev or "";
+      "org.opencontainers.image.source" = "https://github.com/girlbossceo/conduwuit";
+      "org.opencontainers.image.title" = main.pname;
+      "org.opencontainers.image.url" = "https://conduwuit.puppyirl.gay/";
+      "org.opencontainers.image.vendor" = "girlbossceo";
+      "org.opencontainers.image.version" = main.version;
+    };
   };
 }

renovate.json

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

rust-toolchain.toml

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

rustfmt.toml

@@ -1,28 +1,33 @@
-edition = "2021"
-
+array_width = 80
+chain_width = 60
+comment_width = 80
 condense_wildcard_suffixes = true
+style_edition = "2024"
+fn_call_width = 80
+fn_single_line = true
 format_code_in_doc_comments = true
 format_macro_bodies = true
 format_macro_matchers = true
 format_strings = true
-hex_literal_case = "Upper"
-max_width = 120
-tab_spaces = 4
-array_width = 80
-comment_width = 80
-wrap_comments = true
-fn_params_layout = "Compressed"
-fn_call_width = 80
-fn_single_line = true
+group_imports = "StdExternalCrate"
 hard_tabs = true
-match_block_trailing_comma = true
+hex_literal_case = "Upper"
 imports_granularity = "Crate"
+match_arm_blocks = false
+match_arm_leading_pipes = "Always"
+match_block_trailing_comma = true
+max_width = 98
+newline_style = "Unix"
 normalize_comments = false
+overflow_delimited_expr = true
 reorder_impl_items = true
 reorder_imports = true
-group_imports = "StdExternalCrate"
-newline_style = "Unix"
+single_line_if_else_max_width = 60
+single_line_let_else_max_width = 80
+struct_lit_width = 40
+tab_spaces = 4
+unstable_features = true
 use_field_init_shorthand = true
 use_small_heuristics = "Off"
 use_try_shorthand = true
-chain_width = 60
+wrap_comments = true

src/admin/Cargo.toml

@@ -0,0 +1,45 @@
+[package]
+name = "conduwuit_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]
+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
+conduwuit-api.workspace = true
+conduwuit-core.workspace = true
+conduwuit-database.workspace = true
+conduwuit-macros.workspace = true
+conduwuit-service.workspace = true
+const-str.workspace = true
+futures.workspace = true
+log.workspace = true
+ruma.workspace = true
+serde_json.workspace = true
+serde_yaml.workspace = true
+tokio.workspace = true
+tracing-subscriber.workspace = true
+tracing.workspace = true
+
+[lints]
+workspace = true

src/admin/admin.rs

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

src/admin/appservice/commands.rs

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

src/admin/appservice/mod.rs

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

src/admin/check/commands.rs

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

src/admin/check/mod.rs

@@ -0,0 +1,12 @@
+mod commands;
+
+use clap::Subcommand;
+use conduwuit::Result;
+
+use crate::admin_command_dispatch;
+
+#[admin_command_dispatch]
+#[derive(Debug, Subcommand)]
+pub(super) enum CheckCommand {
+	CheckAllUsers,
+}

src/admin/command.rs

@@ -0,0 +1,39 @@
+use std::{fmt, time::SystemTime};
+
+use conduwuit::Result;
+use conduwuit_service::Services;
+use futures::{
+	Future, FutureExt,
+	io::{AsyncWriteExt, BufWriter},
+	lock::Mutex,
+};
+use ruma::EventId;
+
+pub(crate) struct Command<'a> {
+	pub(crate) services: &'a Services,
+	pub(crate) body: &'a [&'a str],
+	pub(crate) timer: SystemTime,
+	pub(crate) reply_id: Option<&'a EventId>,
+	pub(crate) output: Mutex<BufWriter<Vec<u8>>>,
+}
+
+impl Command<'_> {
+	pub(crate) fn write_fmt(
+		&self,
+		arguments: fmt::Arguments<'_>,
+	) -> impl Future<Output = Result> + Send + '_ + use<'_> {
+		let buf = format!("{arguments}");
+		self.output.lock().then(|mut output| async move {
+			output.write_all(buf.as_bytes()).await.map_err(Into::into)
+		})
+	}
+
+	pub(crate) fn write_str<'a>(
+		&'a self,
+		s: &'a str,
+	) -> impl Future<Output = Result> + Send + 'a {
+		self.output.lock().then(move |mut output| async move {
+			output.write_all(s.as_bytes()).await.map_err(Into::into)
+		})
+	}
+}

src/admin/debug/mod.rs

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

src/admin/debug/tester.rs

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

src/admin/federation/commands.rs

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

src/admin/federation/mod.rs

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

src/admin/media/commands.rs

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

src/admin/media/mod.rs

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

src/admin/mod.rs

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

src/admin/processor.rs

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

src/admin/query/account_data.rs

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

src/admin/query/appservice.rs

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

src/admin/query/globals.rs

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