Bump 1.4.7

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

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

.cargo/config.toml

@@ -0,0 +1,2 @@
+[env]
+RUMA_UNSTABLE_EXHAUSTIVE_TYPES = "true"

.cargo/smoketest.sh

@@ -18,7 +18,7 @@ run () {
 	fi
 }
 
-conduwuit () {
+tuwunel () {
 	UWU_OPTS=$@
 	rm -rf /tmp/uwu_smoketest.db
 	echo -e "[global]\nserver_name = \"localhost\"\ndatabase_path = \"/tmp/uwu_smoketest.db\"" > /tmp/uwu_smoketest.toml
@@ -38,8 +38,8 @@ element () {
 		run cargo "$TOOLCHAIN" build $ELEMENT_OPTS --all-targets
 		run cargo "$TOOLCHAIN" test $ELEMENT_OPTS --all-targets
 		run cargo "$TOOLCHAIN" bench $ELEMENT_OPTS --all-targets
-		run cargo "$TOOLCHAIN" run $ELEMENT_OPTS --bin conduit -- -V
-		run conduwuit "$TOOLCHAIN" run $ELEMENT_OPTS --bin conduit
+		run cargo "$TOOLCHAIN" run $ELEMENT_OPTS --bin tuwunel -- -V
+		run tuwunel "$TOOLCHAIN" run $ELEMENT_OPTS --bin tuwunel
 	fi
 }
 

.dockerignore

@@ -1,27 +1,31 @@
 # Local build and dev artifacts
-target
-tests
+target/
+#tests
 
 # Docker files
 Dockerfile*
+docker/
 
 # IDE files
 .vscode
 .idea
 *.iml
 
+.
+
 # Git folder
-.git
-.gitea
-.gitlab
-.github
+#.git
+#.gitea
+#.gitlab
+#.github
 
 # Dot files
 .env
-.gitignore
+#.gitignore
 
 # Toml files
-rustfmt.toml
+#rustfmt.toml
 
 # Documentation
 #*.md
+*.hcl

.editorconfig

@@ -21,3 +21,4 @@ indent_size = 2
 
 [*.rs]
 indent_style = tab
+max_line_length = 98

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

.gitea/workflows/ci.yml

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

.github/workflows/README.md

@@ -0,0 +1,13 @@
+## Overview
+
+The release pipeline `Main` (main.yml) and its subroutines defined in the other yamls form a high-level
+description for the underlying self-hosted build system in  `/docker`. In other words, this is a sort of
+terminal, a "thin-client" with a display and a keyboard for our docker mainframe. We minimize
+vendor-lockin and duplication with other services by limiting everything here to only what is
+essential for driving the docker builder.
+
+Though we slightly relax the above by specifying details of the actual CI pipeline, the 
+control-flow logic to go from some input event to some output or release here. This gives us
+better integration  with github, like granular progress indications by breaking up operations
+as individual jobs and workflows within the pipeline. This means we'll have duplicate logic
+with other services, but only as it relates to high-level control flow.

.github/workflows/bake.yml

@@ -0,0 +1,252 @@
+name: Bakery
+
+on:
+  workflow_call:
+    inputs:
+      bake_targets:
+        type: string
+        description: Bake Matrix
+      cargo_profiles:
+        type: string
+        description: Cargo profiles
+      feat_sets:
+        type: string
+        description: Cargo feature groups
+      rust_targets:
+        type: string
+        description: Rust targets
+      rust_toolchains:
+        type: string
+        description: Rust toolchains
+      sys_names:
+        type: string
+        description: System names
+      sys_targets:
+        type: string
+        description: System targets
+      sys_versions:
+        type: string
+        description: System versions
+      machines:
+        type: string
+        description: Hardware platforms
+      runner:
+        type: string
+        description: Runner mask
+        default: 'self-hosted'
+      excludes:
+        type: string
+        default: '[]'
+        description: Matrix exclusions
+      includes:
+        type: string
+        default: '[]'
+        description: Matrix inclusions
+      max-parallel:
+        type: number
+        default: 128
+        description: Limit number of concurrent jobs.
+      verbose_env:
+        type: string
+        default: ${{vars.CI_VERBOSE_ENV || false}}
+        description: Print the bake environment.
+      silent_bake:
+        type: string
+        default: ${{vars.CI_SILENT_BAKE || false}}
+        description: Print as little as possible.
+      print_bake:
+        type: string
+        default: ${{vars.CI_PRINT_BAKE || false}}
+        description: Print the computed receipe.
+      fail_fast:
+        type: boolean
+        default: false
+        description: Fail-fast for the underlying matrix.
+      release_url:
+        type: string
+        description: Upload url for created release.
+      artifact:
+        type: string
+        default: '{}'
+        description: >
+          Map of targets to artifact files to upload. Key is bake target (image prefix),
+          value is a JSON object containing keys 'src' and 'dst'. dst is the artifact name,
+          src is optional path inside image, defaulting to dst.
+
+jobs:
+  bake:
+    if: >
+      !failure() && !cancelled()
+      && inputs.machines
+      && fromJSON(inputs.machines)[0] != null
+      && fromJSON(inputs.bake_targets)[0] != null
+
+    name: >
+      ${{matrix.bake_target}}
+      ${{matrix.cargo_profile}}
+      ${{matrix.rust_toolchain}}
+      ${{matrix.feat_set}}
+      ${{matrix.sys_name}}
+      ${{matrix.sys_version}}
+      ${{matrix.sys_target}}
+
+    runs-on: ["${{matrix.machine}}", "${{inputs.runner}}"]
+    strategy:
+      fail-fast: ${{inputs.fail_fast}}
+      max-parallel: ${{inputs.max-parallel}}
+      matrix:
+        exclude: ${{fromJSON(inputs.excludes)}}
+        include: ${{fromJSON(inputs.includes)}}
+        bake_target: ${{fromJSON(inputs.bake_targets)}}
+        cargo_profile: ${{fromJSON(inputs.cargo_profiles)}}
+        feat_set: ${{fromJSON(inputs.feat_sets)}}
+        rust_toolchain: ${{fromJSON(inputs.rust_toolchains)}}
+        sys_name: ${{fromJSON(inputs.sys_names)}}
+        sys_version: ${{fromJSON(inputs.sys_versions)}}
+        rust_target: ${{fromJSON(inputs.rust_targets)}}
+        sys_target: ${{fromJSON(inputs.sys_targets)}}
+        machine: ${{fromJSON(inputs.machines)}}
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+
+    # Call docker
+    - name: Bake ${{matrix.bake_target}}
+      env:
+        bake_target: ${{matrix.bake_target}}
+        cargo_profile: ${{matrix.cargo_profile}}
+        rust_toolchain: ${{matrix.rust_toolchain}}
+        rust_target: ${{matrix.rust_target}}
+        feat_set: ${{matrix.feat_set}}
+        sys_name: ${{matrix.sys_name}}
+        sys_version: ${{matrix.sys_version}}
+        sys_target: ${{matrix.sys_target}}
+        machine: ${{matrix.machine}}
+        acct: ${{github.actor}}
+        repo: ${{github.repository}}
+        CI_VERBOSE_ENV: ${{inputs.verbose_env}}
+        CI_SILENT_BAKE: ${{inputs.silent_bake}}
+        CI_PRINT_BAKE: ${{inputs.print_bake}}
+
+      run: |
+        docker/bake.sh "${{matrix.bake_target}}"
+
+    # Optionally extract an inner artifact
+    - name: Extract Inner Artifact
+      if: >
+        !failure() && !cancelled()
+        && fromJSON(inputs.artifact)[matrix.bake_target].dst
+        && fromJSON(inputs.artifact)[matrix.bake_target].img == null
+        && fromJSON(inputs.artifact)[matrix.bake_target].runner != true
+
+      env:
+        iid: ${{matrix.bake_target}}--${{matrix.cargo_profile}}--${{matrix.rust_toolchain}}--${{matrix.rust_target}}--${{matrix.feat_set}}--${{matrix.sys_name}}--${{matrix.sys_version}}--${{matrix.sys_target}}
+        dst: ${{ fromJSON(inputs.artifact)[matrix.bake_target].dst }}
+        src: ${{ fromJSON(inputs.artifact)[matrix.bake_target].src || fromJSON(inputs.artifact)[matrix.bake_target].dst }}
+        mod: ${{ fromJSON(inputs.artifact)[matrix.bake_target].chmod || 'u+r' }}
+
+      run: |
+        cid=$(docker create "$iid" /)
+        rm -rf _artifact
+        mkdir -p "_artifact"
+        docker cp "$cid:$src" "_artifact/$dst"
+        chmod "$mod" "_artifact/$dst"
+
+    # Optionally extract the image itself as an artifact.
+    - name: Extract Image Artifact
+      if: >
+        !failure() && !cancelled()
+        && fromJSON(inputs.artifact)[matrix.bake_target].dst
+        && fromJSON(inputs.artifact)[matrix.bake_target].img != null
+
+      env:
+        iid: ${{matrix.bake_target}}--${{matrix.cargo_profile}}--${{matrix.rust_toolchain}}--${{matrix.rust_target}}--${{matrix.feat_set}}--${{matrix.sys_name}}--${{matrix.sys_version}}--${{matrix.sys_target}}
+        dst: ${{ fromJSON(inputs.artifact)[matrix.bake_target].dst }}
+
+      run: |
+        rm -rf _artifact
+        mkdir -p "_artifact"
+        docker save -o "_artifact/$dst" "$iid"
+
+    # Optionally extract a runner artifact
+    - name: Extract Outer Artifact
+      if: >
+        !failure() && !cancelled()
+        && fromJSON(inputs.artifact)[matrix.bake_target].dst
+        && fromJSON(inputs.artifact)[matrix.bake_target].runner == true
+
+      env:
+        dst: ${{ fromJSON(inputs.artifact)[matrix.bake_target].dst }}
+        src: ${{ fromJSON(inputs.artifact)[matrix.bake_target].src || fromJSON(inputs.artifact)[matrix.bake_target].dst }}
+        mod: ${{ fromJSON(inputs.artifact)[matrix.bake_target].chmod || 'u+r' }}
+
+      run: |
+        rm -rf _artifact
+        mkdir -p "_artifact"
+        mv "$src" "_artifact/$dst"
+        chmod "$mod" "_artifact/$dst"
+
+    # Optionally compress extracted artifact
+    - name: Compress Artifact
+      if: >
+        !failure() && !cancelled()
+        && fromJSON(inputs.artifact)[matrix.bake_target].dst
+        && (fromJSON(inputs.artifact)[matrix.bake_target].gzip || fromJSON(inputs.artifact)[matrix.bake_target].zstd)
+
+      env:
+        dst: ${{ fromJSON(inputs.artifact)[matrix.bake_target].dst }}
+        gzlev: ${{ fromJSON(inputs.artifact)[matrix.bake_target].gzip }}
+        zstlev: ${{ fromJSON(inputs.artifact)[matrix.bake_target].zstd }}
+
+      run: |
+        if test -n "$gzlev"; then
+          mv "_artifact/$dst" "_artifact/$dst.artifact"
+          gzip "-$gzlev" "_artifact/$dst.artifact"
+          mv "_artifact/$dst.artifact.gz" "_artifact/$dst"
+        elif test -n "$zstlev"; then
+          zstd "-$zstlev" "_artifact/$dst"
+          mv "_artifact/$dst.zst" "_artifact/$dst"
+        fi
+
+    # Upload either artifact
+    - name: Upload Artifact
+      if: >
+        !failure() && !cancelled()
+        && fromJSON(inputs.artifact)[matrix.bake_target].dst
+
+      uses: actions/upload-artifact@v4
+      with:
+        path: _artifact/*
+        name: ${{matrix.cargo_profile}}-${{matrix.feat_set}}-${{matrix.sys_target}}-${{fromJSON(inputs.artifact)[matrix.bake_target].dst}}
+
+    # Optionally upload artifact as pages-artifact
+    - name: Upload Pages Artifact
+      if: >
+        !failure() && !cancelled()
+        && fromJSON(inputs.artifact)[matrix.bake_target].dst
+        && fromJSON(inputs.artifact)[matrix.bake_target].pages == true
+
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: _artifact/${{fromJSON(inputs.artifact)[matrix.bake_target].dst}}
+        name: github-pages
+
+    # Optionally upload artifact as release-artifact
+    - name: Upload Release Artifact
+      if: >
+        !failure() && !cancelled()
+        && fromJSON(inputs.artifact)[matrix.bake_target].dst
+        && fromJSON(inputs.artifact)[matrix.bake_target].mime
+        && contains(github.ref, 'refs/tags/v')
+        && inputs.release_url
+
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+      with:
+        upload_url: ${{inputs.release_url}}
+        asset_path: _artifact/${{fromJSON(inputs.artifact)[matrix.bake_target].dst}}
+        asset_name: ${{github.ref_name}}-${{matrix.cargo_profile}}-${{matrix.feat_set}}-${{matrix.sys_target}}-${{fromJSON(inputs.artifact)[matrix.bake_target].dst}}
+        asset_content_type: ${{fromJSON(inputs.artifact)[matrix.bake_target].mime || 'application/octet-stream'}}

.github/workflows/ci.yml

@@ -1,631 +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/**'
-        branches:
-            - main
-            - change-ci-cache
-        tags:
-          - '*'
-    # Allows you to run this workflow manually from the Actions tab
-    workflow_dispatch:
-
-concurrency:
-    group: ${{ github.head_ref || github.ref_name }}
-    cancel-in-progress: true
-
-env:
-    # sccache only on main repo
-    SCCACHE_GHA_ENABLED: "${{ (github.event.pull_request.draft != true) && (vars.DOCKER_USERNAME != '') && (vars.GITLAB_USERNAME != '') && (vars.SCCACHE_ENDPOINT != '') && (github.event.pull_request.user.login != 'renovate[bot]') && 'true' || 'false' }}"
-    RUSTC_WRAPPER: "${{ (github.event.pull_request.draft != true) && (vars.DOCKER_USERNAME != '') && (vars.GITLAB_USERNAME != '') && (vars.SCCACHE_ENDPOINT != '') && (github.event.pull_request.user.login != 'renovate[bot]') && 'sccache' || '' }}"
-    SCCACHE_BUCKET: "${{ (github.event.pull_request.draft != true) && (vars.DOCKER_USERNAME != '') && (vars.GITLAB_USERNAME != '') && (vars.SCCACHE_ENDPOINT != '') && (github.event.pull_request.user.login != 'renovate[bot]') && 'sccache' || '' }}"
-    SCCACHE_S3_USE_SSL: ${{ vars.SCCACHE_S3_USE_SSL }}
-    SCCACHE_REGION: ${{ vars.SCCACHE_REGION }}
-    SCCACHE_ENDPOINT: ${{ vars.SCCACHE_ENDPOINT }}
-    SCCACHE_CACHE_MULTIARCH: ${{ vars.SCCACHE_CACHE_MULTIARCH }}
-    AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-    AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-    # Required to make some things output color
-    TERM: ansi
-    # Publishing to my nix binary cache
-    ATTIC_TOKEN: ${{ secrets.ATTIC_TOKEN }}
-    # conduwuit.cachix.org
-    CACHIX_AUTH_TOKEN: ${{ secrets.CACHIX_AUTH_TOKEN }}
-    # Just in case incremental is still being set to true, speeds up CI
-    CARGO_INCREMENTAL: 0
-    # Custom nix binary cache if fork is being used
-    ATTIC_ENDPOINT: ${{ vars.ATTIC_ENDPOINT }}
-    ATTIC_PUBLIC_KEY: ${{ vars.ATTIC_PUBLIC_KEY }}
-    # Get error output from nix that we can actually use, and use our binary caches for the earlier CI steps
-    NIX_CONFIG: |
-      show-trace = true
-      extra-substituters = https://attic.kennel.juneis.dog/conduit https://attic.kennel.juneis.dog/conduwuit https://cache.lix.systems https://conduwuit.cachix.org
-      extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk= conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o= conduwuit.cachix.org-1:MFRm6jcnfTf0jSAbmvLfhO3KBMt4px+1xaereWXp8Xg=
-    # complement uses libolm
-    NIXPKGS_ALLOW_INSECURE: 1
-
-permissions:
-    packages: write
-    contents: read
-
-jobs:
-    tests:
-        name: Test
-        runs-on: ubuntu-latest
-        env:
-          CARGO_PROFILE: "test"
-        steps:
-            - name: Free Disk Space (Ubuntu)
-              uses: jlumbroso/free-disk-space@main
-
-            - name: Sync repository
-              uses: actions/checkout@v4
-
-            - name: Tag comparison check
-              if: ${{ startsWith(github.ref, 'refs/tags/v') && !endsWith(github.ref, '-rc') }}
-              run: |
-                  # Tag mismatch with latest repo tag check to prevent potential downgrades
-                  LATEST_TAG=$(git describe --tags `git rev-list --tags --max-count=1`)
-
-                  if [ $LATEST_TAG != ${{ github.ref_name }} ]; then
-                    echo '# WARNING: Attempting to run this workflow for a tag that is not the latest repo tag. Aborting.'
-                    echo '# WARNING: Attempting to run this workflow for a tag that is not the latest repo tag. Aborting.' >> $GITHUB_STEP_SUMMARY
-                    exit 1
-                  fi
-
-            - uses: nixbuild/nix-quick-install-action@v28
-
-            - name: Enable Cachix binary cache
-              run: |
-                  nix profile install nixpkgs#cachix
-                  cachix use crane
-                  cachix use nix-community
-
-            - name: Restore and cache Nix store
-              uses: nix-community/cache-nix-action@v5.1.0
-              with:
-                # restore and save a cache using this key
-                primary-key: nix-${{ runner.os }}-${{ hashFiles('**/*.nix', '**/.lock') }}
-                # if there's no cache hit, restore a cache by this prefix
-                restore-prefixes-first-match: nix-${{ runner.os }}-
-                # collect garbage until Nix store size (in bytes) is at most this number
-                # before trying to save a new cache
-                gc-max-store-size-linux: 2073741824
-                # do purge caches
-                purge: true
-                # purge all versions of the cache
-                purge-prefixes: nix-${{ runner.os }}-
-                # created more than this number of seconds ago relative to the start of the `Post Restore` phase
-                purge-last-accessed: 86400
-                # except the version with the `primary-key`, if it exists
-                purge-primary-key: never
-                # always save the cache
-                save-always: true
-
-            - name: Apply Nix binary cache configuration
-              run: |
-                  sudo tee -a "${XDG_CONFIG_HOME:-$HOME/.config}/nix/nix.conf" > /dev/null <<EOF
-                  extra-substituters = https://attic.kennel.juneis.dog/conduit https://attic.kennel.juneis.dog/conduwuit https://cache.lix.systems https://conduwuit.cachix.org
-                  extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk= conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o= conduwuit.cachix.org-1:MFRm6jcnfTf0jSAbmvLfhO3KBMt4px+1xaereWXp8Xg=
-                  EOF
-
-            - name: Use alternative Nix binary caches if specified
-              if: ${{ (env.ATTIC_ENDPOINT != '') && (env.ATTIC_PUBLIC_KEY != '') }}
-              run: |
-                  sudo tee -a "${XDG_CONFIG_HOME:-$HOME/.config}/nix/nix.conf" > /dev/null <<EOF
-                  extra-substituters = ${{ env.ATTIC_ENDPOINT }}
-                  extra-trusted-public-keys = ${{ env.ATTIC_PUBLIC_KEY }}
-                  EOF
-
-            - name: Prepare build environment
-              run: |
-                  echo 'source $HOME/.nix-profile/share/nix-direnv/direnvrc' > "$HOME/.direnvrc"
-                  nix profile install --impure --inputs-from . nixpkgs#direnv nixpkgs#nix-direnv
-                  direnv allow
-                  nix develop .#all-features --command true --impure
-
-            - name: Cache CI dependencies
-              run: |
-                  # attic nix binary cache server is very, very terribly flakey. nothing i can do to fix it other than retry multiple times here
-                  ATTEMPTS=3
-                  SUCCESS=false
-                  while (( ATTEMPTS-- > 0 ))
-                  do
-                    bin/nix-build-and-cache ci
-                    if [[ $? == 0 ]]; then
-                      SUCCESS=true
-                      break
-                    else
-                      sleep 3
-                    fi
-                  done
-
-                  if [[ $SUCCESS == "false" ]]; then
-                    exit 1
-                  fi
-
-            # use sccache for Rust
-            - name: Run sccache-cache
-              if: (github.event.pull_request.draft != true) && (vars.DOCKER_USERNAME != '') && (vars.GITLAB_USERNAME != '') && (vars.SCCACHE_ENDPOINT != '') && (github.event.pull_request.user.login != 'renovate[bot]')
-              uses: mozilla-actions/sccache-action@main
-
-            # use rust-cache
-            - uses: Swatinem/rust-cache@v2
-              with:
-                cache-all-crates: "true"
-
-            - name: Run CI tests
-              run: |
-                  direnv exec . engage > >(tee -a test_output.log)
-
-            - name: Run Complement tests
-              run: |
-                  # the nix devshell sets $COMPLEMENT_SRC, so "/dev/null" is no-op
-                  direnv exec . bin/complement "/dev/null" complement_test_logs.jsonl complement_test_results.jsonl > >(tee -a test_output.log)
-                  cp -v -f result complement_oci_image.tar.gz
-
-            - name: Upload Complement OCI image
-              uses: actions/upload-artifact@v4
-              with:
-                name: complement_oci_image.tar.gz
-                path: complement_oci_image.tar.gz
-                if-no-files-found: error
-
-            - name: Upload Complement logs
-              uses: actions/upload-artifact@v4
-              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
-              run: |
-                  diff -u --color=always tests/test_results/complement/test_results.jsonl complement_test_results.jsonl > >(tee -a complement_diff_output.log)
-
-            - name: Update Job Summary
-              if: success() || failure()
-              run: |
-                  if [ ${{ job.status }} == 'success' ]; then
-                      echo '# ✅ completed suwuccessfully' >> $GITHUB_STEP_SUMMARY
-                  else
-                      echo '# CI failure' >> $GITHUB_STEP_SUMMARY
-                      echo '```' >> $GITHUB_STEP_SUMMARY
-                      tail -n 40 test_output.log | sed 's/\x1b\[[0-9;]*m//g' >> $GITHUB_STEP_SUMMARY
-                      echo '```' >> $GITHUB_STEP_SUMMARY
-
-                      echo '# Complement diff results' >> $GITHUB_STEP_SUMMARY
-                      echo '```diff' >> $GITHUB_STEP_SUMMARY
-                      tail -n 100 complement_diff_output.log | sed 's/\x1b\[[0-9;]*m//g' >>     $GITHUB_STEP_SUMMARY
-                      echo '```' >> $GITHUB_STEP_SUMMARY
-                  fi
-
-            - name: Run cargo clean test artifacts
-              run: |
-                  cargo clean --profile test
-
-    build:
-        name: Build
-        runs-on: ubuntu-latest
-        needs: tests
-        strategy:
-            matrix:
-                include:
-                    - target: aarch64-unknown-linux-musl
-                    - target: x86_64-unknown-linux-musl
-        steps:
-            - name: Free Disk Space (Ubuntu)
-              uses: jlumbroso/free-disk-space@main
-
-            - name: Sync repository
-              uses: actions/checkout@v4
-
-            - uses: nixbuild/nix-quick-install-action@v28
-
-            - name: Enable Cachix binary cache
-              run: |
-                  nix profile install nixpkgs#cachix
-                  cachix use crane
-                  cachix use nix-community
-
-            - name: Restore and cache Nix store
-              uses: nix-community/cache-nix-action@v5.1.0
-              with:
-                # restore and save a cache using this key
-                primary-key: nix-${{ runner.os }}-${{ matrix.target }}-${{ hashFiles('**/*.nix', '**/.lock') }}
-                # if there's no cache hit, restore a cache by this prefix
-                restore-prefixes-first-match: nix-${{ runner.os }}-
-                # collect garbage until Nix store size (in bytes) is at most this number
-                # before trying to save a new cache
-                gc-max-store-size-linux: 2073741824
-                # do purge caches
-                purge: true
-                # purge all versions of the cache
-                purge-prefixes: nix-${{ runner.os }}-
-                # created more than this number of seconds ago relative to the start of the `Post Restore` phase
-                purge-last-accessed: 86400
-                # except the version with the `primary-key`, if it exists
-                purge-primary-key: never
-                # always save the cache
-                save-always: true
-
-            - name: Apply Nix binary cache configuration
-              run: |
-                  sudo tee -a "${XDG_CONFIG_HOME:-$HOME/.config}/nix/nix.conf" > /dev/null <<EOF
-                  extra-substituters = https://attic.kennel.juneis.dog/conduit https://attic.kennel.juneis.dog/conduwuit https://cache.lix.systems https://conduwuit.cachix.org
-                  extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk= conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o= conduwuit.cachix.org-1:MFRm6jcnfTf0jSAbmvLfhO3KBMt4px+1xaereWXp8Xg=
-                  EOF
-
-            - name: Use alternative Nix binary caches if specified
-              if: ${{ (env.ATTIC_ENDPOINT != '') && (env.ATTIC_PUBLIC_KEY != '') }}
-              run: |
-                  sudo tee -a "${XDG_CONFIG_HOME:-$HOME/.config}/nix/nix.conf" > /dev/null <<EOF
-                  extra-substituters = ${{ env.ATTIC_ENDPOINT }}
-                  extra-trusted-public-keys = ${{ env.ATTIC_PUBLIC_KEY }}
-                  EOF
-
-            - name: Prepare build environment
-              run: |
-                  echo 'source $HOME/.nix-profile/share/nix-direnv/direnvrc' > "$HOME/.direnvrc"
-                  nix profile install --impure --inputs-from . nixpkgs#direnv nixpkgs#nix-direnv
-                  direnv allow
-                  nix develop .#all-features --command true --impure
-
-            # use sccache for Rust
-            - name: Run sccache-cache
-              if: (github.event.pull_request.draft != true) && (vars.DOCKER_USERNAME != '') && (vars.GITLAB_USERNAME != '') && (vars.SCCACHE_ENDPOINT != '') && (github.event.pull_request.user.login != 'renovate[bot]')
-              uses: mozilla-actions/sccache-action@main
-
-            # use rust-cache
-            - uses: Swatinem/rust-cache@v2
-              with:
-                cache-all-crates: "true"
-
-            - name: Build static ${{ matrix.target }}
-              run: |
-                  CARGO_DEB_TARGET_TUPLE=$(echo ${{ matrix.target }} | grep -o -E '^([^-]*-){3}[^-]*')
-                  SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct)
-
-                  # attic nix binary cache server is very, very terribly flakey. nothing i can do to fix it other than retry multiple times here
-                  ATTEMPTS=3
-                  SUCCESS=false
-                  while (( ATTEMPTS-- > 0 ))
-                  do
-                    bin/nix-build-and-cache just .#static-${{ matrix.target }}-all-features
-                    if [[ $? == 0 ]]; then
-                      SUCCESS=true
-                      break
-                    else
-                      sleep 3
-                    fi
-                  done
-
-                  if [[ $SUCCESS == "false" ]]; then
-                    exit 1
-                  fi
-
-                  mkdir -v -p target/release/
-                  mkdir -v -p target/$CARGO_DEB_TARGET_TUPLE/release/
-                  cp -v -f result/bin/conduit target/release/conduwuit
-                  cp -v -f result/bin/conduit target/$CARGO_DEB_TARGET_TUPLE/release/conduwuit
-                  # -p conduit is the main crate name
-                  direnv exec . cargo deb --verbose --no-build --no-strip -p conduit --target=$CARGO_DEB_TARGET_TUPLE --output target/release/${{ matrix.target }}.deb
-                  mv -v target/release/conduwuit static-${{ matrix.target }}
-                  mv -v target/release/${{ matrix.target }}.deb ${{ matrix.target }}.deb
-
-            # quick smoke test of the x86_64 static release binary
-            - name: Run x86_64 static release binary
-              run: |
-                  # GH actions default runners are x86_64 only
-                  if file result/bin/conduit | grep x86-64; then
-                    result/bin/conduit --version
-                  fi
-
-            - name: Build static debug ${{ matrix.target }}
-              run: |
-                  CARGO_DEB_TARGET_TUPLE=$(echo ${{ matrix.target }} | grep -o -E '^([^-]*-){3}[^-]*')
-                  SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct)
-
-                  # attic nix binary cache server is very, very terribly flakey. nothing i can do to fix it other than retry multiple times here
-                  ATTEMPTS=3
-                  SUCCESS=false
-                  while (( ATTEMPTS-- > 0 ))
-                  do
-                    bin/nix-build-and-cache just .#static-${{ matrix.target }}-all-features-debug
-                    if [[ $? == 0 ]]; then
-                      SUCCESS=true
-                      break
-                    else
-                      sleep 3
-                    fi
-                  done
-
-                  if [[ $SUCCESS == "false" ]]; then
-                    exit 1
-                  fi
-
-                  # > warning: dev profile is not supported and will be a hard error in the future. cargo-deb is for making releases, and it doesn't make sense to use it with dev profiles.
-                  # so we need to coerce cargo-deb into thinking this is a release binary
-                  mkdir -v -p target/release/
-                  mkdir -v -p target/$CARGO_DEB_TARGET_TUPLE/release/
-                  cp -v -f result/bin/conduit target/release/conduwuit
-                  cp -v -f result/bin/conduit target/$CARGO_DEB_TARGET_TUPLE/release/conduwuit
-                  # -p conduit is the main crate name
-                  direnv exec . cargo deb --verbose --no-build --no-strip -p conduit --target=$CARGO_DEB_TARGET_TUPLE --output target/release/${{ matrix.target }}-debug.deb
-                  mv -v target/release/conduwuit static-${{ matrix.target }}-debug
-                  mv -v target/release/${{ matrix.target }}-debug.deb ${{ matrix.target }}-debug.deb
-
-            # quick smoke test of the x86_64 static debug binary
-            - name: Run x86_64 static debug binary
-              run: |
-                  # GH actions default runners are x86_64 only
-                  if file result/bin/conduit | grep x86-64; then
-                    result/bin/conduit --version
-                  fi
-
-            # check validity of produced deb package, invalid debs will error on these commands
-            - name: Validate produced deb package
-              run: |
-                  # List contents
-                  dpkg-deb --contents ${{ matrix.target }}.deb
-                  dpkg-deb --contents ${{ matrix.target }}-debug.deb
-                  # List info
-                  dpkg-deb --info ${{ matrix.target }}.deb
-                  dpkg-deb --info ${{ matrix.target }}-debug.deb
-
-            - name: Upload static-${{ matrix.target }}
-              uses: actions/upload-artifact@v4
-              with:
-                  name: static-${{ matrix.target }}
-                  path: static-${{ matrix.target }}
-                  if-no-files-found: error
-
-            - name: Upload deb ${{ matrix.target }}
-              uses: actions/upload-artifact@v4
-              with:
-                  name: deb-${{ matrix.target }}
-                  path: ${{ matrix.target }}.deb
-                  if-no-files-found: error
-                  compression-level: 0
-
-            - name: Upload static-${{ matrix.target }}-debug
-              uses: actions/upload-artifact@v4
-              with:
-                  name: static-${{ matrix.target }}-debug
-                  path: static-${{ matrix.target }}-debug
-                  if-no-files-found: error
-
-            - name: Upload deb ${{ matrix.target }}-debug
-              uses: actions/upload-artifact@v4
-              with:
-                  name: deb-${{ matrix.target }}-debug
-                  path: ${{ matrix.target }}-debug.deb
-                  if-no-files-found: error
-                  compression-level: 0
-
-            - name: Build OCI image ${{ matrix.target }}
-              run: |
-                  # attic nix binary cache server is very, very terribly flakey. nothing i can do to fix it other than retry multiple times here
-                  ATTEMPTS=3
-                  SUCCESS=false
-                  while (( ATTEMPTS-- > 0 ))
-                  do
-                    bin/nix-build-and-cache just .#oci-image-${{ matrix.target }}-all-features
-                    if [[ $? == 0 ]]; then
-                      SUCCESS=true
-                      break
-                    else
-                      sleep 3
-                    fi
-                  done
-
-                  if [[ $SUCCESS == "false" ]]; then
-                    exit 1
-                  fi
-
-                  cp -v -f result oci-image-${{ matrix.target }}.tar.gz
-
-            - name: Build debug OCI image ${{ matrix.target }}
-              run: |
-                  # attic nix binary cache server is very, very terribly flakey. nothing i can do to fix it other than retry multiple times here
-                  ATTEMPTS=3
-                  SUCCESS=false
-                  while (( ATTEMPTS-- > 0 ))
-                  do
-                    bin/nix-build-and-cache just .#oci-image-${{ matrix.target }}-all-features-debug
-                    if [[ $? == 0 ]]; then
-                      SUCCESS=true
-                      break
-                    else
-                      sleep 3
-                    fi
-                  done
-
-                  if [[ $SUCCESS == "false" ]]; then
-                    exit 1
-                  fi
-
-                  cp -v -f result oci-image-${{ matrix.target }}-debug.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
-
-            - name: Upload OCI image ${{ matrix.target }}-debug
-              uses: actions/upload-artifact@v4
-              with:
-                  name: oci-image-${{ matrix.target }}-debug
-                  path: oci-image-${{ matrix.target }}-debug.tar.gz
-                  if-no-files-found: error
-                  compression-level: 0
-
-    docker:
-        name: Docker publish
-        runs-on: ubuntu-latest
-        needs: build
-        if: (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main' || (github.event.pull_request.draft != true)) && (vars.DOCKER_USERNAME != '') && (vars.GITLAB_USERNAME != '') && github.event.pull_request.user.login != 'renovate[bot]'
-        env:
-            DOCKER_ARM64: docker.io/${{ github.repository }}:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}-arm64v8
-            DOCKER_AMD64: docker.io/${{ github.repository }}:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}-amd64
-            DOCKER_TAG: docker.io/${{ github.repository }}:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}
-            DOCKER_BRANCH: docker.io/${{ github.repository }}:${{ (startsWith(github.ref, 'refs/tags/v') && !endsWith(github.ref, '-rc') && 'latest') || (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}
-            GHCR_ARM64: ghcr.io/${{ github.repository }}:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}-arm64v8
-            GHCR_AMD64: ghcr.io/${{ github.repository }}:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}-amd64
-            GHCR_TAG: ghcr.io/${{ github.repository }}:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}
-            GHCR_BRANCH: ghcr.io/${{ github.repository }}:${{ (startsWith(github.ref, 'refs/tags/v') && !endsWith(github.ref, '-rc') && 'latest') || (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}
-            GLCR_ARM64: registry.gitlab.com/conduwuit/conduwuit:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}-arm64v8
-            GLCR_AMD64: registry.gitlab.com/conduwuit/conduwuit:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}-amd64
-            GLCR_TAG: registry.gitlab.com/conduwuit/conduwuit:${{ (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}-${{ github.sha }}
-            GLCR_BRANCH: registry.gitlab.com/conduwuit/conduwuit:${{ (startsWith(github.ref, 'refs/tags/v') && !endsWith(github.ref, '-rc') && 'latest') || (github.head_ref != '' && format('merge-{0}-{1}', github.event.number, github.event.pull_request.user.login)) || github.ref_name }}
-
-            DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
-            GITLAB_TOKEN: ${{ secrets.GITLAB_TOKEN }}
-        steps:
-            - 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 -v oci-image-x86_64-unknown-linux-musl/*.tar.gz oci-image-amd64.tar.gz
-                  mv -v oci-image-aarch64-unknown-linux-musl/*.tar.gz oci-image-arm64v8.tar.gz
-                  mv -v oci-image-x86_64-unknown-linux-musl-debug/*.tar.gz oci-image-amd64-debug.tar.gz
-                  mv -v oci-image-aarch64-unknown-linux-musl-debug/*.tar.gz oci-image-arm64v8-debug.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: Load and push amd64 debug image
-              if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
-              run: |
-                  docker load -i oci-image-amd64-debug.tar.gz
-                  docker tag $(docker images -q conduit:main) ${{ env.DOCKER_AMD64 }}-debug
-                  docker tag $(docker images -q conduit:main) ${{ env.GHCR_AMD64 }}-debug
-                  docker tag $(docker images -q conduit:main) ${{ env.GLCR_AMD64 }}-debug
-                  docker push ${{ env.DOCKER_AMD64 }}-debug
-                  docker push ${{ env.GHCR_AMD64 }}-debug
-                  docker push ${{ env.GLCR_AMD64 }}-debug
-
-            - name: Load and push arm64 debug image
-              if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
-              run: |
-                  docker load -i oci-image-arm64v8-debug.tar.gz
-                  docker tag $(docker images -q conduit:main) ${{ env.DOCKER_ARM64 }}-debug
-                  docker tag $(docker images -q conduit:main) ${{ env.GHCR_ARM64 }}-debug
-                  docker tag $(docker images -q conduit:main) ${{ env.GLCR_ARM64 }}-debug
-                  docker push ${{ env.DOCKER_ARM64 }}-debug
-                  docker push ${{ env.GHCR_ARM64 }}-debug
-                  docker push ${{ env.GLCR_ARM64 }}-debug
-
-            - name: Create Docker combined manifests
-              run: |
-                  # Dockerhub Container Registry
-                  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.GLCR_AMD64 }}
-                  docker manifest create ${{ env.GLCR_BRANCH }} --amend ${{ env.GLCR_ARM64 }} --amend ${{ env.GLCR_AMD64 }}
-
-            - name: Create Docker combined debug manifests
-              run: |
-                  # Dockerhub Container Registry
-                  docker manifest create ${{ env.DOCKER_TAG }}-debug --amend ${{ env.DOCKER_ARM64 }}-debug --amend ${{ env.DOCKER_AMD64 }}-debug
-                  docker manifest create ${{ env.DOCKER_BRANCH }}-debug --amend ${{ env.DOCKER_ARM64 }}-debug --amend ${{ env.DOCKER_AMD64 }}-debug
-                  # GitHub Container Registry
-                  docker manifest create ${{ env.GHCR_TAG }}-debug --amend ${{ env.GHCR_ARM64 }}-debug --amend ${{ env.GHCR_AMD64 }}-debug
-                  docker manifest create ${{ env.GHCR_BRANCH }}-debug --amend ${{ env.GHCR_ARM64 }}-debug --amend ${{ env.GHCR_AMD64 }}-debug
-                  # GitLab Container Registry
-                  docker manifest create ${{ env.GLCR_TAG }}-debug --amend ${{ env.GLCR_ARM64 }}-debug --amend ${{ env.GLCR_AMD64 }}-debug
-                  docker manifest create ${{ env.GLCR_BRANCH }}-debug --amend ${{ env.GLCR_ARM64 }}-debug --amend ${{ env.GLCR_AMD64 }}-debug
-
-            - name: Push manifests to Docker registries
-              if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
-              run: |
-                  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 }}
-                  docker manifest push ${{ env.DOCKER_TAG }}-debug
-                  docker manifest push ${{ env.DOCKER_BRANCH }}-debug
-                  docker manifest push ${{ env.GHCR_TAG }}-debug
-                  docker manifest push ${{ env.GHCR_BRANCH }}-debug
-                  docker manifest push ${{ env.GLCR_TAG }}-debug
-                  docker manifest push ${{ env.GLCR_BRANCH }}-debug
-
-            - name: Add Image Links to Job Summary
-              if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
-              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
-                  echo "- \`docker pull ${{ env.DOCKER_TAG }}-debug\`" >> $GITHUB_STEP_SUMMARY
-                  echo "- \`docker pull ${{ env.GHCR_TAG }}-debug\`" >> $GITHUB_STEP_SUMMARY
-                  echo "- \`docker pull ${{ env.GLCR_TAG }}-debug\`" >> $GITHUB_STEP_SUMMARY

.github/workflows/documentation.yml

@@ -1,176 +0,0 @@
-name: Documentation and GitHub Pages
-
-on:
-  pull_request:
-  push:
-    branches:
-      - main
-    tags:
-      - '*'
-
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
-
-env:
-  # Required to make some things output color
-  TERM: ansi
-  # Publishing to my nix binary cache
-  ATTIC_TOKEN: ${{ secrets.ATTIC_TOKEN }}
-  # conduwuit.cachix.org
-  CACHIX_AUTH_TOKEN: ${{ secrets.CACHIX_AUTH_TOKEN }}
-  # Custom nix binary cache if fork is being used
-  ATTIC_ENDPOINT: ${{ vars.ATTIC_ENDPOINT }}
-  ATTIC_PUBLIC_KEY: ${{ vars.ATTIC_PUBLIC_KEY }}
-  # Get error output from nix that we can actually use, and use our binary caches for the earlier CI steps
-  NIX_CONFIG: |
-    show-trace = true
-    extra-substituters = https://attic.kennel.juneis.dog/conduit https://attic.kennel.juneis.dog/conduwuit https://cache.lix.systems https://conduwuit.cachix.org
-    extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk= conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o= conduwuit.cachix.org-1:MFRm6jcnfTf0jSAbmvLfhO3KBMt4px+1xaereWXp8Xg=
-
-# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
-# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
-concurrency:
-  group: "pages"
-  cancel-in-progress: false
-
-jobs:
-  docs:
-    name: Documentation and GitHub Pages
-    runs-on: ubuntu-latest
-
-    permissions:
-      pages: write
-      id-token: write
-
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-
-    steps:
-      - name: Free Disk Space (Ubuntu)
-        uses: jlumbroso/free-disk-space@main
-
-      - name: Sync repository
-        uses: actions/checkout@v4
-
-      - name: Setup GitHub Pages
-        if: github.event_name != 'pull_request'
-        uses: actions/configure-pages@v5
-
-      - uses: nixbuild/nix-quick-install-action@v28
-
-      - name: Enable Cachix binary cache
-        run: |
-            nix profile install nixpkgs#cachix
-            cachix use crane
-            cachix use nix-community
-
-      - name: Restore and cache Nix store
-        uses: nix-community/cache-nix-action@v5.1.0
-        with:
-          # restore and save a cache using this key
-          primary-key: nix-${{ runner.os }}-${{ hashFiles('**/*.nix', '**/.lock') }}
-          # if there's no cache hit, restore a cache by this prefix
-          restore-prefixes-first-match: nix-${{ runner.os }}-
-          # collect garbage until Nix store size (in bytes) is at most this number
-          # before trying to save a new cache
-          gc-max-store-size-linux: 2073741824
-          # do purge caches
-          purge: true
-          # purge all versions of the cache
-          purge-prefixes: nix-${{ runner.os }}-
-          # created more than this number of seconds ago relative to the start of the `Post Restore` phase
-          purge-last-accessed: 86400
-          # except the version with the `primary-key`, if it exists
-          purge-primary-key: never
-          # always save the cache
-          save-always: true
-
-      - name: Apply Nix binary cache configuration
-        run: |
-            sudo tee -a "${XDG_CONFIG_HOME:-$HOME/.config}/nix/nix.conf" > /dev/null <<EOF
-            extra-substituters = https://attic.kennel.juneis.dog/conduit https://attic.kennel.juneis.dog/conduwuit https://cache.lix.systems https://conduwuit.cachix.org
-            extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk= conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o= conduwuit.cachix.org-1:MFRm6jcnfTf0jSAbmvLfhO3KBMt4px+1xaereWXp8Xg=
-            EOF
-
-      - name: Use alternative Nix binary caches if specified
-        if: ${{ (env.ATTIC_ENDPOINT != '') && (env.ATTIC_PUBLIC_KEY != '') }}
-        run: |
-            sudo tee -a "${XDG_CONFIG_HOME:-$HOME/.config}/nix/nix.conf" > /dev/null <<EOF
-            extra-substituters = ${{ env.ATTIC_ENDPOINT }}
-            extra-trusted-public-keys = ${{ env.ATTIC_PUBLIC_KEY }}
-            EOF
-
-      - name: Prepare build environment
-        run: |
-            echo 'source $HOME/.nix-profile/share/nix-direnv/direnvrc' > "$HOME/.direnvrc"
-            nix profile install --inputs-from . nixpkgs#direnv nixpkgs#nix-direnv
-            direnv allow
-            nix develop --command true
-
-      - name: Cache CI dependencies
-        run: |
-            # attic nix binary cache server is very, very terribly flakey. nothing i can do to fix it other than retry multiple times here
-            ATTEMPTS=3
-            SUCCESS=false
-            while (( ATTEMPTS-- > 0 ))
-            do
-              bin/nix-build-and-cache ci
-              if [[ $? == 0 ]]; then
-                SUCCESS=true
-                break
-              else
-                sleep 3
-              fi
-            done
-
-            if [[ $SUCCESS == "false" ]]; then
-              exit 1
-            fi
-
-      - name: Run lychee and markdownlint
-        run: |
-            direnv exec . engage just lints lychee
-            direnv exec . engage just lints markdownlint
-
-      - name: Build documentation (book)
-        run: |
-            # attic nix binary cache server is very, very terribly flakey. nothing i can do to fix it other than retry multiple times here
-            ATTEMPTS=3
-            SUCCESS=false
-            while (( ATTEMPTS-- > 0 ))
-            do
-              bin/nix-build-and-cache just .#book
-              if [[ $? == 0 ]]; then
-                SUCCESS=true
-                break
-              else
-                sleep 3
-              fi
-            done
-
-            if [[ $SUCCESS == "false" ]]; then
-              exit 1
-            fi
-
-            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/lint.yml

@@ -0,0 +1,173 @@
+name: Linting
+
+on:
+  workflow_call:
+    inputs:
+      cargo_profiles:
+        type: string
+        description: Cargo profiles
+      feat_sets:
+        type: string
+        description: Cargo feature groups
+      rust_toolchains:
+        type: string
+        description: Rust toolchains
+      sys_names:
+        type: string
+        description: System names
+      sys_versions:
+        type: string
+        description: System versions
+      rust_targets:
+        type: string
+        description: Rust targets
+      sys_targets:
+        type: string
+        description: System targets
+      machines:
+        type: string
+        description: Hardware platform vector
+      excludes:
+        type: string
+        default: '[]'
+        description: Matrix exclusions
+      includes:
+        type: string
+        default: '[]'
+        description: Matrix inclusions
+
+jobs:
+  fmt:
+    if: >
+      !failure() && !cancelled()
+      && contains(fromJSON(inputs.cargo_profiles), fromJSON('["test"]')[0])
+      && contains(fromJSON(inputs.feat_sets), fromJSON('["all"]')[0])
+      && contains(fromJSON(inputs.rust_toolchains), fromJSON('["nightly"]')[0])
+      && contains(fromJSON(inputs.sys_targets), fromJSON('["x86_64-v1-linux-gnu"]')[0])
+
+    name: Format
+    uses: ./.github/workflows/bake.yml
+    with:
+      bake_targets: '["fmt"]'
+      cargo_profiles: '["test"]'
+      feat_sets: '["all"]'
+      rust_toolchains: '["nightly"]'
+      rust_targets: ${{inputs.rust_targets}}
+      sys_names: ${{inputs.sys_names}}
+      sys_versions: ${{inputs.sys_versions}}
+      sys_targets: '["x86_64-v1-linux-gnu"]'
+      machines: ${{inputs.machines}}
+      excludes: ${{inputs.excludes}}
+      includes: ${{inputs.includes}}
+
+  typos:
+    if: >
+      !failure() && !cancelled()
+      && contains(fromJSON(inputs.cargo_profiles), fromJSON('["test"]')[0])
+      && contains(fromJSON(inputs.feat_sets), fromJSON('["all"]')[0])
+      && contains(fromJSON(inputs.rust_toolchains), fromJSON('["nightly"]')[0])
+      && contains(fromJSON(inputs.sys_targets), fromJSON('["x86_64-v1-linux-gnu"]')[0])
+
+    name: Typos
+    uses: ./.github/workflows/bake.yml
+    with:
+      bake_targets: '["typos"]'
+      cargo_profiles: '["test"]'
+      feat_sets: '["all"]'
+      rust_toolchains: '["nightly"]'
+      sys_names: ${{inputs.sys_names}}
+      sys_versions: ${{inputs.sys_versions}}
+      rust_targets: ${{inputs.rust_targets}}
+      sys_targets: '["x86_64-v1-linux-gnu"]'
+      machines: ${{inputs.machines}}
+      excludes: ${{inputs.excludes}}
+      includes: ${{inputs.includes}}
+
+  audit:
+    if: >
+      !failure() && !cancelled()
+      && contains(fromJSON(inputs.cargo_profiles), fromJSON('["test"]')[0])
+      && contains(fromJSON(inputs.feat_sets), fromJSON('["all"]')[0])
+      && contains(fromJSON(inputs.rust_toolchains), fromJSON('["nightly"]')[0])
+      && contains(fromJSON(inputs.sys_targets), fromJSON('["x86_64-v1-linux-gnu"]')[0])
+
+    name: Audit
+    uses: ./.github/workflows/bake.yml
+    with:
+      bake_targets: '["audit"]'
+      cargo_profiles: '["test"]'
+      feat_sets: '["all"]'
+      rust_toolchains: '["nightly"]'
+      sys_names: ${{inputs.sys_names}}
+      sys_versions: ${{inputs.sys_versions}}
+      rust_targets: ${{inputs.rust_targets}}
+      sys_targets: '["x86_64-v1-linux-gnu"]'
+      machines: ${{inputs.machines}}
+      excludes: ${{inputs.excludes}}
+      includes: ${{inputs.includes}}
+
+  lychee:
+    if: >
+      !failure() && !cancelled()
+      && contains(fromJSON(inputs.cargo_profiles), fromJSON('["test"]')[0])
+      && contains(fromJSON(inputs.feat_sets), fromJSON('["all"]')[0])
+      && contains(fromJSON(inputs.rust_toolchains), fromJSON('["nightly"]')[0])
+      && contains(fromJSON(inputs.sys_targets), fromJSON('["x86_64-v1-linux-gnu"]')[0])
+
+    name: Lychee
+    uses: ./.github/workflows/bake.yml
+    with:
+      bake_targets: '["lychee"]'
+      cargo_profiles: '["test"]'
+      feat_sets: '["all"]'
+      rust_toolchains: '["nightly"]'
+      sys_names: ${{inputs.sys_names}}
+      sys_versions: ${{inputs.sys_versions}}
+      rust_targets: ${{inputs.rust_targets}}
+      sys_targets: '["x86_64-v1-linux-gnu"]'
+      machines: ${{inputs.machines}}
+      excludes: ${{inputs.excludes}}
+      includes: ${{inputs.includes}}
+
+  check:
+    if: >
+      !failure() && !cancelled()
+      && contains(fromJSON(inputs.cargo_profiles), fromJSON('["test"]')[0])
+      && contains(fromJSON(inputs.feat_sets), fromJSON('["all"]')[0])
+      && contains(fromJSON(inputs.rust_toolchains), fromJSON('["nightly"]')[0])
+      && contains(fromJSON(inputs.sys_targets), fromJSON('["x86_64-v1-linux-gnu"]')[0])
+
+    name: Check
+    uses: ./.github/workflows/bake.yml
+    with:
+      bake_targets: '["check"]'
+      cargo_profiles: '["test"]'
+      feat_sets: '["all"]'
+      rust_toolchains: '["nightly"]'
+      sys_names: ${{inputs.sys_names}}
+      sys_versions: ${{inputs.sys_versions}}
+      rust_targets: ${{inputs.rust_targets}}
+      sys_targets: '["x86_64-v1-linux-gnu"]'
+      machines: ${{inputs.machines}}
+      excludes: ${{inputs.excludes}}
+      includes: ${{inputs.includes}}
+
+  clippy:
+    if: >
+      !failure() && !cancelled()
+      && inputs.cargo_profiles
+
+    name: Clippy
+    uses: ./.github/workflows/bake.yml
+    with:
+      bake_targets: '["clippy"]'
+      cargo_profiles: ${{inputs.cargo_profiles}}
+      feat_sets: ${{inputs.feat_sets}}
+      rust_toolchains: ${{inputs.rust_toolchains}}
+      sys_names: ${{inputs.sys_names}}
+      sys_versions: ${{inputs.sys_versions}}
+      rust_targets: ${{inputs.rust_targets}}
+      sys_targets: ${{inputs.sys_targets}}
+      machines: ${{inputs.machines}}
+      excludes: ${{inputs.excludes}}
+      includes: ${{inputs.includes}}

.github/workflows/main.yml

@@ -0,0 +1,337 @@
+name: Main
+
+on:
+  push:
+    branches:
+      - "**"
+    tags:
+      - "v*"
+  pull_request:
+    branches:
+      - "**"
+  workflow_dispatch:
+
+concurrency:
+  group: ${{github.workflow}}-${{github.ref}}
+  cancel-in-progress: false
+
+jobs:
+  init:
+    name: Init
+    runs-on: ${{matrix.runner}}
+    env:
+      default_cargo_profiles: '["test", "bench", "release"]'
+      default_feat_sets: '["none", "default", "all"]'
+      default_rust_toolchains: '["nightly", "stable"]'
+      default_sys_names: '["debian"]'
+      default_sys_versions: '["testing-slim"]'
+      default_rust_targets: '["x86_64-unknown-linux-gnu"]'
+      default_sys_targets: '["x86_64-v1-linux-gnu", "x86_64-v3-linux-gnu"]'
+      default_machines: '["X64"]'
+
+    outputs:
+      cargo_profiles: ${{vars.CARGO_PROFILES || env.default_cargo_profiles}}
+      feat_sets: ${{vars.FEAT_SETS || env.default_feat_sets}}
+      rust_toolchains: ${{vars.RUST_TOOLCHAINS || env.default_rust_toolchains}}
+      rust_targets: ${{vars.RUST_TARGETS || env.default_rust_targets}}
+      sys_names: ${{vars.SYS_NAMES || env.default_sys_names}}
+      sys_targets: ${{vars.SYS_TARGETS || env.default_sys_targets}}
+      sys_versions: ${{vars.SYS_VERSIONS || env.default_sys_versions}}
+      machines: ${{vars.MACHINES || env.default_machines}}
+      package: ${{vars.PACKAGE != 'false'}}
+      publish: ${{vars.PUBLISH != 'false'}}
+      build_nix: ${{vars.BUILD_NIX != 'false'}}
+      build_pkgs: ${{vars.BUILD_PKGS || github.ref == 'refs/heads/main' || github.ref == 'refs/heads/test' || contains(github.ref, 'tags/v')}}
+      check_pkgs: ${{vars.CHECK_PKGS || github.ref == 'refs/heads/test'}}
+      complement: ${{vars.COMPLEMENT != 'false'}}
+      complement_runner: 'het'
+      docker_repo: ${{vars.DOCKER_REPO}}
+      release_url: ${{steps.release.outputs.upload_url}}
+      pages_url: 'https://matrix-construct.github.io/tuwunel/'
+      rust_sdk_integ: ${{vars.RUST_SDK_INTEGRATION != 'false'}}
+      head_msg: ${{github.event.head_commit.message || github.event.workflow_run.head_commit.message}}
+
+    strategy:
+      fail-fast: true
+      matrix:
+        runner: ${{fromJSON(vars.RUNNERS || '["het"]')}}
+        machine: ${{fromJSON(vars.MACHINES || '["X64"]')}}
+        exclude: ${{fromJSON(vars.RUNNERS_EXCLUDES || '[]')}}
+
+    steps:
+    - name: Initialize Builder
+      env:
+        runner: ${{matrix.runner}}
+        reserved_space: '{"het": "192GB", "aws": "48GB", "gcp": "160GB"}'
+        max_used_space: '{"het": "384GB", "aws": "64GB", "gcp": "192GB"}'
+      run: |
+        set +e
+        docker buildx inspect "${GITHUB_ACTOR}"
+        if test x"$?" = x"0"; then
+          exit 0
+        fi
+
+        set -eux
+        reserved_space=$(echo -n "$reserved_space" | jq -r ".$runner")
+        max_used_space=$(echo -n "$max_used_space" | jq -r ".$runner")
+        cat <<EOF > ./buildkitd.toml
+        [system]
+          platformsCacheMaxAge = "504h"
+        [worker.oci]
+          enabled = true
+          rootless = false
+          gc = true
+          reservedSpace = "${reserved_space}"
+          maxUsedSpace = "${max_used_space}"
+        [[worker.oci.gcpolicy]]
+          reservedSpace = "${reserved_space}"
+          maxUsedSpace = "${max_used_space}"
+          filters = ["label!=cache==pin"]
+          all = true
+        EOF
+
+        docker buildx create \
+          --bootstrap \
+          --driver docker-container \
+          --buildkitd-config ./buildkitd.toml \
+          --name "${GITHUB_ACTOR}" \
+          --buildkitd-flags "--allow-insecure-entitlement network.host"
+
+    - if: >
+        !failure() && !cancelled()
+        && contains(github.ref, 'refs/tags/v')
+        && matrix.runner == 'het'
+
+      id: release
+      name: Create Release
+      uses: actions/create-release@v1
+      env:
+        GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+      with:
+        release_name: Release ${{github.ref_name}}
+        tag_name: ${{github.ref}}
+        body_path: RELEASE.md
+        draft: ${{ contains(github.ref, '-draft') }}
+        prerelease: ${{ contains(github.ref, '-rc') }}
+
+  lint:
+    if: >
+      !failure() && !cancelled()
+      && !contains(github.ref, 'refs/tags/v')
+      && !contains(needs.init.outputs.head_msg, '[ci no lint]')
+      && !contains(needs.init.outputs.head_msg, '[ci only it]')
+
+    name: Lint
+    needs: [init] #needs: [init, deps]
+    uses: ./.github/workflows/lint.yml
+    with:
+      cargo_profiles: ${{needs.init.outputs.cargo_profiles}}
+      feat_sets: ${{needs.init.outputs.feat_sets}}
+      rust_toolchains: ${{needs.init.outputs.rust_toolchains}}
+      rust_targets: ${{needs.init.outputs.rust_targets}}
+      sys_names: ${{needs.init.outputs.sys_names}}
+      sys_targets: ${{needs.init.outputs.sys_targets}}
+      sys_versions: ${{needs.init.outputs.sys_versions}}
+      machines: ${{needs.init.outputs.machines}}
+      excludes: >
+        [
+          {"cargo_profile": "test", "feat_set": "logging"},
+          {"cargo_profile": "test", "rust_toolchain": "stable", "feat_set": "none"},
+          {"cargo_profile": "test", "rust_target": "aarch64-unknown-linux-gnu"},
+          {"cargo_profile": "bench"},
+          {"cargo_profile": "release", "rust_toolchain": "nightly", "feat_set": "none"},
+          {"cargo_profile": "release", "rust_toolchain": "nightly", "feat_set": "default"},
+          {"cargo_profile": "release", "rust_toolchain": "nightly", "feat_set": "logging"},
+          {"cargo_profile": "release-debuginfo"},
+          {"cargo_profile": "release-native", "feat_set": "none"},
+          {"cargo_profile": "release-native", "feat_set": "default"},
+          {"cargo_profile": "release-native", "feat_set": "logging"},
+          {"cargo_profile": "release-native", "rust_toolchain": "stable"},
+          {"cargo_profile": "release-native", "rust_target": "aarch64-unknown-linux-gnu"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "feat_set": "none"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "feat_set": "default"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "feat_set": "logging"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "rust_toolchain": "nightly"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "sys_target": "x86_64-v1-linux-gnu"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "sys_target": "x86_64-v2-linux-gnu"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "sys_target": "x86_64-v3-linux-gnu"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "sys_target": "x86_64-v4-linux-gnu"},
+          {"rust_target": "x86_64-unknown-linux-gnu", "sys_target": "aarch64-v8-linux-gnu"},
+          {"sys_target": "aarch64-v8-linux-gnu", "machine": "X64"},
+          {"sys_target": "x86_64-v1-linux-gnu", "machine": "ARM64"},
+          {"sys_target": "x86_64-v2-linux-gnu"},
+          {"sys_target": "x86_64-v3-linux-gnu"},
+          {"sys_target": "x86_64-v4-linux-gnu"},
+        ]
+
+  test:
+    if: >
+      !failure() && !cancelled()
+      && !contains(github.ref, 'refs/tags/v')
+      && !contains(needs.init.outputs.head_msg, '[ci no test]')
+
+    name: Test
+    needs: [init, lint]
+    uses: ./.github/workflows/test.yml
+    with:
+      head_msg: ${{needs.init.outputs.head_msg}}
+      build_nix: ${{fromJSON(needs.init.outputs.build_nix)}}
+      rust_sdk_integ: ${{fromJSON(needs.init.outputs.rust_sdk_integ)}}
+      complement: ${{fromJSON(needs.init.outputs.complement)}}
+      complement_runner: ${{needs.init.outputs.complement_runner}}
+      cargo_profiles: ${{needs.init.outputs.cargo_profiles}}
+      feat_sets: ${{needs.init.outputs.feat_sets}}
+      rust_toolchains: ${{needs.init.outputs.rust_toolchains}}
+      rust_targets: ${{needs.init.outputs.rust_targets}}
+      sys_names: ${{needs.init.outputs.sys_names}}
+      sys_targets: ${{needs.init.outputs.sys_targets}}
+      sys_versions: ${{needs.init.outputs.sys_versions}}
+      machines: ${{needs.init.outputs.machines}}
+      excludes: >
+        [
+          {"cargo_profile": "test", "rust_toolchain": "stable", "feat_set": "none"},
+          {"cargo_profile": "test", "rust_target": "aarch64-unknown-linux-gnu"},
+          {"cargo_profile": "release-debuginfo"},
+          {"cargo_profile": "release-native", "feat_set": "none"},
+          {"cargo_profile": "release-native", "feat_set": "default"},
+          {"cargo_profile": "release-native", "rust_toolchain": "stable"},
+          {"cargo_profile": "release-native", "rust_target": "aarch64-unknown-linux-gnu"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "feat_set": "none"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "feat_set": "default"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "feat_set": "logging"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "rust_toolchain": "nightly"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "sys_target": "x86_64-v1-linux-gnu"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "sys_target": "x86_64-v2-linux-gnu"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "sys_target": "x86_64-v3-linux-gnu"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "sys_target": "x86_64-v4-linux-gnu"},
+          {"rust_target": "x86_64-unknown-linux-gnu", "sys_target": "aarch64-v8-linux-gnu"},
+          {"sys_target": "aarch64-v8-linux-gnu", "machine": "X64"},
+          {"sys_target": "x86_64-v1-linux-gnu", "machine": "ARM64"},
+          {"sys_target": "x86_64-v2-linux-gnu", "machine": "ARM64"},
+          {"sys_target": "x86_64-v2-linux-gnu", "feat_set": "none"},
+          {"sys_target": "x86_64-v2-linux-gnu", "feat_set": "default"},
+          {"sys_target": "x86_64-v3-linux-gnu", "machine": "ARM64"},
+          {"sys_target": "x86_64-v3-linux-gnu", "feat_set": "none"},
+          {"sys_target": "x86_64-v3-linux-gnu", "feat_set": "default"},
+          {"sys_target": "x86_64-v4-linux-gnu", "machine": "ARM64"},
+          {"sys_target": "x86_64-v4-linux-gnu", "feat_set": "none"},
+          {"sys_target": "x86_64-v4-linux-gnu", "feat_set": "default"},
+        ]
+
+  package:
+    if: >
+      !failure() && !cancelled()
+      && needs.init.outputs.package
+      && !contains(github.ref, 'refs/pull')
+      && !contains(needs.init.outputs.head_msg, '[ci only it]')
+      && !contains(needs.init.outputs.head_msg, '[ci no build]')
+      && !contains(needs.init.outputs.head_msg, '[ci no package]')
+
+    name: Package
+    needs: [init, test]
+    uses: ./.github/workflows/package.yml
+    with:
+      release_url: ${{needs.init.outputs.release_url}}
+      check_pkgs: ${{needs.init.outputs.check_pkgs}}
+      build_pkgs: ${{needs.init.outputs.build_pkgs}}
+      build_nix: ${{fromJSON(needs.init.outputs.build_nix)}}
+      cargo_profiles: ${{needs.init.outputs.cargo_profiles}}
+      feat_sets: ${{needs.init.outputs.feat_sets}}
+      rust_toolchains: ${{needs.init.outputs.rust_toolchains}}
+      rust_targets: ${{needs.init.outputs.rust_targets}}
+      sys_names: ${{needs.init.outputs.sys_names}}
+      sys_targets: ${{needs.init.outputs.sys_targets}}
+      sys_versions: ${{needs.init.outputs.sys_versions}}
+      machines: ${{needs.init.outputs.machines}}
+      excludes: >
+        [
+          {"feat_set": "none"},
+          {"cargo_profile": "test"},
+          {"cargo_profile": "bench"},
+          {"cargo_profile": "release-native"},
+          {"cargo_profile": "release-debuginfo", "feat_set": "default"},
+          {"cargo_profile": "release-debuginfo", "feat_set": "logging"},
+          {"cargo_profile": "release-debuginfo", "rust_toolchain": "nightly"},
+          {"cargo_profile": "release-debuginfo", "bake_target": "oci"},
+          {"cargo_profile": "release-debuginfo", "rust_target": "aarch64-unknown-linux-gnu"},
+          {"cargo_profile": "release-debuginfo", "sys_target": "x86_64-v2-linux-gnu"},
+          {"cargo_profile": "release-debuginfo", "sys_target": "x86_64-v3-linux-gnu"},
+          {"cargo_profile": "release-debuginfo", "sys_target": "x86_64-v4-linux-gnu"},
+          {"cargo_profile": "release", "rust_toolchain": "nightly"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "feat_set": "default"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "feat_set": "logging"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "bake_target": "nix"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "sys_target": "x86_64-v1-linux-gnu"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "sys_target": "x86_64-v2-linux-gnu"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "sys_target": "x86_64-v3-linux-gnu"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "sys_target": "x86_64-v4-linux-gnu"},
+          {"rust_target": "x86_64-unknown-linux-gnu", "sys_target": "aarch64-v8-linux-gnu"},
+          {"sys_target": "aarch64-v8-linux-gnu", "machine": "X64"},
+          {"sys_target": "x86_64-v1-linux-gnu", "machine": "ARM64"},
+          {"sys_target": "x86_64-v2-linux-gnu", "machine": "ARM64"},
+          {"sys_target": "x86_64-v2-linux-gnu", "feat_set": "default"},
+          {"sys_target": "x86_64-v2-linux-gnu", "feat_set": "logging"},
+          {"sys_target": "x86_64-v2-linux-gnu", "bake_target": "nix"},
+          {"sys_target": "x86_64-v3-linux-gnu", "machine": "ARM64"},
+          {"sys_target": "x86_64-v3-linux-gnu", "feat_set": "default"},
+          {"sys_target": "x86_64-v3-linux-gnu", "feat_set": "logging"},
+          {"sys_target": "x86_64-v3-linux-gnu", "bake_target": "nix"},
+          {"sys_target": "x86_64-v4-linux-gnu", "machine": "ARM64"},
+          {"sys_target": "x86_64-v4-linux-gnu", "feat_set": "default"},
+          {"sys_target": "x86_64-v4-linux-gnu", "feat_set": "logging"},
+          {"sys_target": "x86_64-v4-linux-gnu", "bake_target": "nix"},
+        ]
+
+  publish:
+    if: >
+      !failure() && !cancelled()
+      && needs.init.outputs.publish
+      && !contains(github.ref, 'refs/pull')
+      && !contains(needs.init.outputs.head_msg, '[ci only it]')
+      && !contains(needs.init.outputs.head_msg, '[ci no build]')
+      && !contains(needs.init.outputs.head_msg, '[ci no package]')
+      && !contains(needs.init.outputs.head_msg, '[ci no publish]')
+
+    name: Publish
+    needs: [init, test, package]
+    uses: ./.github/workflows/publish.yml
+    with:
+      docker_repo: ${{needs.init.outputs.docker_repo}}
+      release_url: ${{needs.init.outputs.release_url}}
+      pages_url: ${{needs.init.outputs.pages_url}}
+      cargo_profiles: ${{needs.init.outputs.cargo_profiles}}
+      feat_sets: ${{needs.init.outputs.feat_sets}}
+      rust_toolchains: ${{needs.init.outputs.rust_toolchains}}
+      rust_targets: ${{needs.init.outputs.rust_targets}}
+      sys_names: ${{needs.init.outputs.sys_names}}
+      sys_targets: ${{needs.init.outputs.sys_targets}}
+      sys_versions: ${{needs.init.outputs.sys_versions}}
+      machines: ${{needs.init.outputs.machines}}
+      excludes: >
+        [
+          {"feat_set": "none"},
+          {"feat_set": "default"},
+          {"cargo_profile": "test"},
+          {"cargo_profile": "bench"},
+          {"cargo_profile": "release-debuginfo"},
+          {"cargo_profile": "release-native"},
+          {"rust_toolchain": "nightly"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "feat_set": "logging"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "sys_target": "x86_64-v1-linux-gnu"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "sys_target": "x86_64-v2-linux-gnu"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "sys_target": "x86_64-v3-linux-gnu"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "sys_target": "x86_64-v4-linux-gnu"},
+          {"rust_target": "x86_64-unknown-linux-gnu", "sys_target": "aarch64-v8-linux-gnu"},
+          {"sys_target": "aarch64-v8-linux-gnu", "machine": "X64"},
+          {"sys_target": "x86_64-v1-linux-gnu", "machine": "ARM64"},
+          {"sys_target": "x86_64-v2-linux-gnu", "machine": "ARM64"},
+          {"sys_target": "x86_64-v2-linux-gnu", "feat_set": "logging"},
+          {"sys_target": "x86_64-v3-linux-gnu", "machine": "ARM64"},
+          {"sys_target": "x86_64-v3-linux-gnu", "feat_set": "logging"},
+          {"sys_target": "x86_64-v4-linux-gnu", "machine": "ARM64"},
+          {"sys_target": "x86_64-v4-linux-gnu", "feat_set": "logging"},
+        ]
+
+    secrets:
+      ghcr_token: ${{ secrets.GHCR_TOKEN }}
+      dockerhub_token: ${{ secrets.DOCKERHUB_TOKEN }}

.github/workflows/package.yml

@@ -0,0 +1,213 @@
+name: Package
+
+on:
+  workflow_call:
+    inputs:
+      cargo_profiles:
+        type: string
+        description: Cargo profiles
+      feat_sets:
+        type: string
+        description: Cargo feature groups
+      rust_toolchains:
+        type: string
+        description: Rust toolchains
+      sys_names:
+        type: string
+        description: System names
+      sys_versions:
+        type: string
+        description: System versions
+      rust_targets:
+        type: string
+        description: Rust targets
+      sys_targets:
+        type: string
+        description: System targets
+      machines:
+        type: string
+        description: Hardware platform vector
+      excludes:
+        type: string
+        default: '[]'
+        description: Matrix exclusions
+      includes:
+        type: string
+        default: '[]'
+        description: Matrix inclusions
+      release_url:
+        type: string
+        description: For release assets
+      build_pkgs:
+        type: string
+        default: 'true'
+      check_pkgs:
+        type: string
+        default: 'false'
+      build_nix:
+        type: string
+        default: 'true'
+
+jobs:
+  book:
+    if: >
+      !failure() && !cancelled()
+      && contains(fromJSON(inputs.cargo_profiles), fromJSON('["release"]')[0])
+      && contains(fromJSON(inputs.feat_sets), fromJSON('["default"]')[0])
+      && contains(fromJSON(inputs.rust_toolchains), fromJSON('["stable"]')[0])
+      && contains(fromJSON(inputs.sys_targets), fromJSON('["x86_64-v1-linux-gnu"]')[0])
+
+    name: Book
+    uses: ./.github/workflows/bake.yml
+    with:
+      bake_targets: '["book"]'
+      cargo_profiles: '["release"]'
+      feat_sets: '["default"]'
+      rust_toolchains: '["stable"]'
+      rust_targets: ${{inputs.rust_targets}}
+      sys_names: ${{inputs.sys_names}}
+      sys_versions: ${{inputs.sys_versions}}
+      sys_targets: '["x86_64-v1-linux-gnu"]'
+      machines: ${{inputs.machines}}
+      runner: 'het'
+      excludes: ${{inputs.excludes}}
+      includes: ${{inputs.includes}}
+      release_url: ${{inputs.release_url}}
+      artifact: >
+        {
+          "book": {
+            "dst": "book",
+            "src": "/book",
+            "pages": true
+          }
+        }
+
+  binary:
+    if: >
+      !failure() && !cancelled()
+
+    name: Binaries
+    uses: ./.github/workflows/bake.yml
+    with:
+      bake_targets: '["static"]'
+      cargo_profiles: ${{inputs.cargo_profiles}}
+      feat_sets: ${{inputs.feat_sets}}
+      rust_toolchains: ${{inputs.rust_toolchains}}
+      sys_names: ${{inputs.sys_names}}
+      sys_versions: ${{inputs.sys_versions}}
+      rust_targets: ${{inputs.rust_targets}}
+      sys_targets: ${{inputs.sys_targets}}
+      machines: ${{inputs.machines}}
+      excludes: ${{inputs.excludes}}
+      includes: ${{inputs.includes}}
+      release_url: ${{inputs.release_url}}
+      artifact: >
+        {
+          "static": {
+            "dst": "tuwunel.zst",
+            "src": "/usr/bin/tuwunel",
+            "mime": "application/zstd",
+            "zstd": 11,
+            "chmod": "a+x"
+          }
+        }
+
+  container:
+    if: >
+      !failure() && !cancelled()
+
+    name: Containers
+    uses: ./.github/workflows/bake.yml
+    with:
+      bake_targets: '["docker", "oci"]'
+      cargo_profiles: ${{inputs.cargo_profiles}}
+      feat_sets: ${{inputs.feat_sets}}
+      rust_toolchains: ${{inputs.rust_toolchains}}
+      sys_names: ${{inputs.sys_names}}
+      sys_versions: ${{inputs.sys_versions}}
+      rust_targets: ${{inputs.rust_targets}}
+      sys_targets: ${{inputs.sys_targets}}
+      machines: ${{inputs.machines}}
+      excludes: ${{inputs.excludes}}
+      includes: ${{inputs.includes}}
+      release_url: ${{inputs.release_url}}
+      artifact: >
+        {
+          "docker": {
+            "dst": "tuwunel-docker.tar.gz",
+            "img": true,
+            "mime": "application/gzip",
+            "gzip": 7
+          },
+          "oci": {
+            "dst": "tuwunel-oci.tar.zst",
+            "runner": true,
+            "mime": "application/zstd",
+            "zstd": 11
+          }
+        }
+
+  pkgs:
+    if: >
+      !failure() && !cancelled()
+      && contains(fromJSON(inputs.feat_sets), fromJSON('["all"]')[0])
+      && contains(fromJSON(inputs.cargo_profiles), fromJSON('["release"]')[0])
+      && contains(fromJSON(inputs.rust_toolchains), fromJSON('["stable"]')[0])
+      && fromJSON(inputs.build_pkgs)
+
+    name: Distro Packages
+    uses: ./.github/workflows/bake.yml
+    with:
+      bake_targets: '["deb", "rpm", "nix"]'
+      cargo_profiles: '["release"]'
+      feat_sets: '["all"]'
+      rust_toolchains: '["stable"]'
+      sys_names: ${{inputs.sys_names}}
+      sys_versions: ${{inputs.sys_versions}}
+      rust_targets: ${{inputs.rust_targets}}
+      sys_targets: ${{inputs.sys_targets}}
+      machines: ${{inputs.machines}}
+      excludes: ${{inputs.excludes}}
+      includes: ${{inputs.includes}}
+      release_url: ${{inputs.release_url}}
+      artifact: >
+        {
+          "deb": {
+            "dst": "tuwunel.deb",
+            "mime": "application/vnd.debian.binary-package"
+          },
+          "rpm": {
+            "dst": "tuwunel.rpm",
+            "mime": "application/x-rpm"
+          },
+          "nix": {
+            "dst": "tuwunel.nix.tar.zst",
+            "src": "/opt/tuwunel.nix.tar",
+            "mime": "application/zstd",
+            "zstd": 11
+          }
+        }
+
+  check_pkgs:
+    if: >
+      !failure() && !cancelled()
+      && contains(fromJSON(inputs.feat_sets), fromJSON('["all"]')[0])
+      && contains(fromJSON(inputs.cargo_profiles), fromJSON('["release"]')[0])
+      && contains(fromJSON(inputs.rust_toolchains), fromJSON('["stable"]')[0])
+      && fromJSON(inputs.check_pkgs)
+
+    name: Check Packages
+    needs: [pkgs]
+    uses: ./.github/workflows/bake.yml
+    with:
+      bake_targets: '["deb-install", "rpm-install"]'
+      cargo_profiles: '["release"]'
+      feat_sets: '["all"]'
+      rust_toolchains: '["stable"]'
+      sys_names: ${{inputs.sys_names}}
+      sys_versions: ${{inputs.sys_versions}}
+      rust_targets: ${{inputs.rust_targets}}
+      sys_targets: ${{inputs.sys_targets}}
+      machines: ${{inputs.machines}}
+      excludes: ${{inputs.excludes}}
+      includes: ${{inputs.includes}}

.github/workflows/publish.yml

@@ -0,0 +1,328 @@
+name: Publish
+
+on:
+  workflow_call:
+    secrets:
+      ghcr_token:
+      dockerhub_token:
+    inputs:
+      cargo_profiles:
+        type: string
+        description: Cargo profiles
+      feat_sets:
+        type: string
+        description: Cargo feature groups
+      rust_toolchains:
+        type: string
+        description: Rust toolchains
+      sys_names:
+        type: string
+        description: System names
+      sys_versions:
+        type: string
+        description: System versions
+      rust_targets:
+        type: string
+        description: Rust targets
+      sys_targets:
+        type: string
+        description: System targets
+      machines:
+        type: string
+        description: Hardware platform vector
+      excludes:
+        type: string
+        default: '[]'
+        description: Matrix exclusions
+      includes:
+        type: string
+        default: '[]'
+        description: Matrix inclusions
+      docker_repo:
+        type: string
+        description: DockerHub Repository
+      release_url:
+        type: string
+        description: For release assets
+      pages_url:
+        type: string
+        description: For pages deployment
+
+jobs:
+  documents:
+    if: >
+      !failure() && !cancelled()
+      && (github.ref == 'refs/heads/main' || contains(github.ref, 'refs/tags/v'))
+      && !contains(github.ref, '-draft')
+
+    name: Documents
+    runs-on: ['X64', 'het']
+    permissions:
+      contents: read
+      id-token: write
+      pages: write
+
+    environment:
+      name: github-pages
+      url: ${{inputs.pages_url}}
+
+    steps:
+      - id: book
+        name: Book
+        uses: actions/deploy-pages@v4
+
+  containers:
+    if: >
+      !failure() && !cancelled()
+      && inputs.machines
+      && inputs.docker_repo != ''
+      && (github.ref == 'refs/heads/main' || contains(github.ref, 'refs/tags/v'))
+
+    name: Containers
+    runs-on: ${{matrix.machine}}
+    permissions: write-all
+    strategy:
+      fail-fast: true
+      matrix:
+        bake_target: ${{fromJSON('["docker_io", "ghcr_io"]')}}
+        cargo_profile: ${{fromJSON(inputs.cargo_profiles)}}
+        rust_toolchain: ${{fromJSON(inputs.rust_toolchains)}}
+        feat_set: ${{fromJSON(inputs.feat_sets)}}
+        sys_name: ${{fromJSON(inputs.sys_names)}}
+        sys_version: ${{fromJSON(inputs.sys_versions)}}
+        rust_target: ${{fromJSON(inputs.rust_targets)}}
+        sys_target: ${{fromJSON(inputs.sys_targets)}}
+        machine: ${{fromJSON(inputs.machines)}}
+        exclude: ${{fromJSON(inputs.excludes)}}
+        include: ${{fromJSON(inputs.includes)}}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: GitHub Login
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.ghcr_token }}
+
+      - name: DockerHub Login
+        uses: docker/login-action@v3
+        with:
+          registry: docker.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.dockerhub_token }}
+
+      - name: Bake
+        env:
+          bake_target: ${{matrix.bake_target}}
+          cargo_profile: ${{matrix.cargo_profile}}
+          rust_toolchain: ${{matrix.rust_toolchain}}
+          rust_target: ${{matrix.rust_target}}
+          feat_set: ${{matrix.feat_set}}
+          sys_name: ${{matrix.sys_name}}
+          sys_version: ${{matrix.sys_version}}
+          sys_target: ${{matrix.sys_target}}
+          machine: ${{matrix.machine}}
+          acct: ${{github.actor}}
+          repo: ${{github.repository}}
+          docker_repo: ${{inputs.docker_repo}}
+
+        run: |
+          docker/bake.sh "${{matrix.bake_target}}"
+
+  bundles:
+    if: >
+      !failure() && !cancelled()
+      && inputs.machines
+      && inputs.docker_repo != ''
+      && contains(fromJSON(inputs.cargo_profiles), fromJSON('["release"]')[0])
+      && contains(fromJSON(inputs.feat_sets), fromJSON('["all"]')[0])
+      && contains(fromJSON(inputs.rust_toolchains), fromJSON('["stable"]')[0])
+      && (github.ref == 'refs/heads/main' || contains(github.ref, 'refs/tags/v'))
+
+    name: Bundles
+    needs: [containers]
+    runs-on: 'het'
+    permissions: write-all
+    strategy:
+      fail-fast: true
+      matrix:
+        bake_target: ${{fromJSON('["docker_io", "ghcr_io"]')}}
+        cargo_profile: ${{fromJSON('["release"]')}}
+        feat_set: ${{fromJSON('["all"]')}}
+        rust_toolchain: ${{fromJSON('["stable"]')}}
+        sys_name: ${{fromJSON(inputs.sys_names)}}
+        sys_version: ${{fromJSON(inputs.sys_versions)}}
+        rust_target: ${{fromJSON(inputs.rust_targets)}}
+        sys_target: ${{fromJSON(inputs.sys_targets)}}
+        machine: ${{fromJSON(inputs.machines)}}
+        exclude: ${{fromJSON(inputs.excludes)}}
+        include: ${{fromJSON(inputs.includes)}}
+
+    steps:
+      - name: GitHub Login
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.ghcr_token }}
+
+      - name: DockerHub Login
+        uses: docker/login-action@v3
+        with:
+          registry: docker.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.dockerhub_token }}
+
+      - name: Release Branch
+        if: >
+          !failure() && !cancelled()
+          && (github.ref == 'refs/heads/main' || contains(github.ref, 'refs/tags/v'))
+
+        env:
+          acct: ${{github.actor}}
+          ghcr_repo: ${{github.repository}}
+          docker_repo: ${{inputs.docker_repo}}
+          registry: ${{matrix.bake_target}}
+          cargo_profile: ${{matrix.cargo_profile}}
+          feat_set: ${{matrix.feat_set}}
+          sys_target: ${{matrix.sys_target}}
+          ref_name: ${{github.ref_name}}
+
+        run: |
+          registry="$(echo -n $registry | sed s/_/./)"
+          if test "$registry" = "ghcr.io"; then
+            repo="$ghcr_repo"
+          else
+            repo="$docker_repo"
+          fi
+
+          docker manifest create "${registry}/${repo}:${ref_name}" \
+            --amend "${registry}/${repo}:${ref_name}-${cargo_profile}-${feat_set}-${sys_target}"
+
+      - name: Release Preview
+        if: >
+          !failure() && !cancelled()
+          && contains(github.ref, 'refs/tags/v')
+          && !contains(github.ref, '-draft')
+
+        env:
+          acct: ${{github.actor}}
+          ghcr_repo: ${{github.repository}}
+          docker_repo: ${{inputs.docker_repo}}
+          registry: ${{matrix.bake_target}}
+          cargo_profile: ${{matrix.cargo_profile}}
+          feat_set: ${{matrix.feat_set}}
+          sys_target: ${{matrix.sys_target}}
+          ref_name: ${{github.ref_name}}
+
+        run: |
+          registry="$(echo -n $registry | sed s/_/./)"
+          if test "$registry" = "ghcr.io"; then
+            repo="$ghcr_repo"
+          else
+            repo="$docker_repo"
+          fi
+
+          docker manifest create "${registry}/${repo}:preview" \
+            --amend "${registry}/${repo}:${ref_name}-${cargo_profile}-${feat_set}-${sys_target}"
+
+      - name: Release Latest
+        if: >
+          !failure() && !cancelled()
+          && contains(github.ref, 'refs/tags/v')
+          && !contains(github.ref, '-draft')
+          && !contains(github.ref, '-rc')
+
+        env:
+          acct: ${{github.actor}}
+          ghcr_repo: ${{github.repository}}
+          docker_repo: ${{inputs.docker_repo}}
+          registry: ${{matrix.bake_target}}
+          cargo_profile: ${{matrix.cargo_profile}}
+          feat_set: ${{matrix.feat_set}}
+          sys_target: ${{matrix.sys_target}}
+          ref_name: ${{github.ref_name}}
+
+        run: |
+          registry="$(echo -n $registry | sed s/_/./)"
+          if test "$registry" = "ghcr.io"; then
+            repo="$ghcr_repo"
+          else
+            repo="$docker_repo"
+          fi
+
+          docker manifest create "${registry}/${repo}:latest" \
+            --amend "${registry}/${repo}:${ref_name}-${cargo_profile}-${feat_set}-${sys_target}"
+
+  delivery:
+    if: >
+      !failure() && !cancelled()
+      && inputs.machines
+      && inputs.docker_repo != ''
+      && (github.ref == 'refs/heads/main' || contains(github.ref, 'refs/tags/v'))
+
+    name: Delivery
+    needs: [bundles, documents]
+    runs-on: 'het'
+    permissions: write-all
+    steps:
+      - name: GitHub Login
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.ghcr_token }}
+
+      - name: DockerHub Login
+        uses: docker/login-action@v3
+        with:
+          registry: docker.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.dockerhub_token }}
+
+      - name: Push Branch
+        if: >
+          !failure() && !cancelled()
+          && (github.ref == 'refs/heads/main' || contains(github.ref, 'refs/tags/v'))
+
+        env:
+          ref_name: ${{github.ref_name}}
+          ghcr_repo: ${{github.repository}}
+          docker_repo: ${{inputs.docker_repo}}
+
+        run: |
+          docker manifest push -p "ghcr.io/${ghcr_repo}:${ref_name}"
+          docker manifest push -p "docker.io/${docker_repo}:${ref_name}"
+
+      - name: Push Preview
+        if: >
+          !failure() && !cancelled()
+          && contains(github.ref, 'refs/tags/v')
+          && !contains(github.ref, '-draft')
+
+        env:
+          ghcr_repo: ${{github.repository}}
+          docker_repo: ${{inputs.docker_repo}}
+
+        run: |
+          docker manifest push -p "ghcr.io/${ghcr_repo}:preview"
+          docker manifest push -p "docker.io/${docker_repo}:preview"
+
+      - name: Push Latest
+        if: >
+          !failure() && !cancelled()
+          && contains(github.ref, 'refs/tags/v')
+          && !contains(github.ref, '-draft')
+          && !contains(github.ref, '-rc')
+
+        env:
+          ghcr_repo: ${{github.repository}}
+          docker_repo: ${{inputs.docker_repo}}
+
+        run: |
+          docker manifest push -p "ghcr.io/${ghcr_repo}:latest"
+          docker manifest push -p "docker.io/${docker_repo}:latest"

.github/workflows/test.yml

@@ -0,0 +1,404 @@
+name: Testing
+
+on:
+  workflow_call:
+    inputs:
+      cargo_profiles:
+        type: string
+        description: Cargo profiles
+      feat_sets:
+        type: string
+        description: Cargo feature groups
+      rust_toolchains:
+        type: string
+        description: Rust toolchains
+      sys_names:
+        type: string
+        description: System names
+      sys_versions:
+        type: string
+        description: System versions
+      rust_targets:
+        type: string
+        description: Rust targets
+      sys_targets:
+        type: string
+        description: System targets
+      machines:
+        type: string
+        description: Hardware platform vector
+      excludes:
+        type: string
+        default: '[]'
+        description: Matrix exclusions
+      includes:
+        type: string
+        default: '[]'
+        description: Matrix inclusions
+      complement:
+        type: boolean
+        default: true
+      complement_runner:
+        type: string
+      rust_sdk_integ:
+        type: boolean
+        default: true
+      build_nix:
+        type: boolean
+        default: true
+      head_msg:
+        type: string
+
+jobs:
+  docs:
+    if: >
+      !contains(inputs.head_msg, '[ci only it]')
+      && contains(fromJSON(inputs.cargo_profiles), fromJSON('["test"]')[0])
+      && contains(fromJSON(inputs.feat_sets), fromJSON('["all"]')[0])
+      && contains(fromJSON(inputs.rust_toolchains), fromJSON('["nightly"]')[0])
+      && contains(fromJSON(inputs.sys_targets), fromJSON('["x86_64-v1-linux-gnu"]')[0])
+
+    name: Docs
+    uses: ./.github/workflows/bake.yml
+    with:
+      bake_targets: '["docs"]'
+      cargo_profiles: '["test"]'
+      feat_sets: '["all"]'
+      rust_toolchains: '["nightly"]'
+      sys_names: ${{inputs.sys_names}}
+      sys_versions: ${{inputs.sys_versions}}
+      rust_targets: ${{inputs.rust_targets}}
+      sys_targets: '["x86_64-v1-linux-gnu"]'
+      machines: ${{inputs.machines}}
+      excludes: ${{inputs.excludes}}
+      includes: ${{inputs.includes}}
+
+  unit:
+    if: >
+      !contains(inputs.head_msg, '[ci only it]')
+      && contains(fromJSON(inputs.cargo_profiles), fromJSON('["test"]')[0])
+      && contains(fromJSON(inputs.feat_sets), fromJSON('["all"]')[0])
+      && contains(fromJSON(inputs.rust_toolchains), fromJSON('["nightly"]')[0])
+      && contains(fromJSON(inputs.sys_targets), fromJSON('["x86_64-v1-linux-gnu"]')[0])
+
+    name: Module
+    uses: ./.github/workflows/bake.yml
+    with:
+      bake_targets: '["unit", "integ"]'
+      cargo_profiles: '["test"]'
+      feat_sets: '["all"]'
+      rust_toolchains: ${{inputs.rust_toolchains}}
+      sys_names: ${{inputs.sys_names}}
+      sys_versions: ${{inputs.sys_versions}}
+      rust_targets: ${{inputs.rust_targets}}
+      sys_targets: '["x86_64-v1-linux-gnu"]'
+      machines: ${{inputs.machines}}
+      excludes: ${{inputs.excludes}}
+      includes: ${{inputs.includes}}
+
+  bench:
+    if: >
+      !contains(inputs.head_msg, '[ci only it]')
+      && contains(fromJSON(inputs.cargo_profiles), fromJSON('["bench"]')[0])
+      && contains(fromJSON(inputs.feat_sets), fromJSON('["all"]')[0])
+      && contains(fromJSON(inputs.rust_toolchains), fromJSON('["nightly"]')[0])
+      && contains(fromJSON(inputs.sys_targets), fromJSON('["x86_64-v3-linux-gnu"]')[0])
+
+    name: Bench
+    uses: ./.github/workflows/bake.yml
+    with:
+      bake_targets: '["unit", "integ"]'
+      cargo_profiles: '["bench"]'
+      feat_sets: '["all"]'
+      rust_toolchains: '["nightly"]'
+      sys_names: ${{inputs.sys_names}}
+      sys_versions: ${{inputs.sys_versions}}
+      rust_targets: ${{inputs.rust_targets}}
+      sys_targets: '["x86_64-v3-linux-gnu"]'
+      machines: ${{inputs.machines}}
+      excludes: ${{inputs.excludes}}
+      includes: ${{inputs.includes}}
+
+  memcheck:
+    if: >
+      !contains(inputs.head_msg, '[ci only it]')
+      && contains(fromJSON(inputs.cargo_profiles), fromJSON('["bench"]')[0])
+      && contains(fromJSON(inputs.feat_sets), fromJSON('["all"]')[0])
+      && contains(fromJSON(inputs.rust_toolchains), fromJSON('["nightly"]')[0])
+      && contains(fromJSON(inputs.sys_targets), fromJSON('["x86_64-v3-linux-gnu"]')[0])
+
+    name: Memcheck
+    uses: ./.github/workflows/bake.yml
+    with:
+      #bake_targets: '["unit-valgrind", "integ-valgrind"]'
+      bake_targets: '["integ-valgrind"]'
+      cargo_profiles: '["bench"]' # use bench not release for debug syms
+      feat_sets: '["all"]'
+      rust_toolchains: '["nightly"]'
+      sys_names: ${{inputs.sys_names}}
+      sys_versions: ${{inputs.sys_versions}}
+      rust_targets: ${{inputs.rust_targets}}
+      sys_targets: '["x86_64-v3-linux-gnu"]'
+      machines: ${{inputs.machines}}
+      includes: ${{inputs.includes}}
+      excludes: ${{inputs.excludes}}
+
+  smoke:
+    if: >
+      !failure() && !cancelled()
+      && !contains(inputs.head_msg, '[ci only it]')
+      && !contains(inputs.head_msg, '[ci no build]')
+      && inputs.cargo_profiles
+      && inputs.machines
+
+    name: Smoke
+    uses: ./.github/workflows/bake.yml
+    with:
+      bake_targets: '["smoke", "smoke-valgrind"]'
+      cargo_profiles: ${{inputs.cargo_profiles}}
+      feat_sets: ${{inputs.feat_sets}}
+      rust_toolchains: ${{inputs.rust_toolchains}}
+      sys_names: ${{inputs.sys_names}}
+      sys_versions: ${{inputs.sys_versions}}
+      rust_targets: ${{inputs.rust_targets}}
+      sys_targets: ${{inputs.sys_targets}}
+      machines: ${{inputs.machines}}
+      includes: ${{inputs.includes}}
+      excludes: >
+        [
+          {"cargo_profile": "test", "feat_set": "default"},
+          {"cargo_profile": "test", "feat_set": "logging"},
+          {"cargo_profile": "test", "feat_set": "none", "bake_target": "smoke-valgrind"},
+          {"cargo_profile": "test", "rust_toolchain": "stable"},
+          {"cargo_profile": "test", "rust_target": "aarch64-unknown-linux-gnu"},
+          {"cargo_profile": "test", "sys_target": "x86_64-v2-linux-gnu"},
+          {"cargo_profile": "test", "sys_target": "x86_64-v3-linux-gnu"},
+          {"cargo_profile": "test", "bake_target": "smoke-valgrind"},
+          {"cargo_profile": "bench"},
+          {"cargo_profile": "release", "rust_toolchain": "nightly"},
+          {"cargo_profile": "release", "rust_toolchain": "stable", "feat_set": "none"},
+          {"cargo_profile": "release", "bake_target": "smoke-valgrind"},
+          {"cargo_profile": "release-debuginfo", "feat_set": "logging"},
+          {"cargo_profile": "release-debuginfo", "rust_toolchain": "nightly"},
+          {"cargo_profile": "release-debuginfo", "rust_toolchain": "stable", "feat_set": "none"},
+          {"cargo_profile": "release-debuginfo", "bake_target": "smoke"},
+          {"cargo_profile": "release-debuginfo", "rust_target": "aarch64-unknown-linux-gnu"},
+          {"cargo_profile": "release-native", "rust_toolchain": "stable"},
+          {"cargo_profile": "release-native", "feat_set": "none"},
+          {"cargo_profile": "release-native", "feat_set": "default"},
+          {"cargo_profile": "release-native", "feat_set": "logging"},
+          {"cargo_profile": "release-native", "bake_target": "smoke-valgrind"},
+          {"cargo_profile": "release-native", "rust_target": "aarch64-unknown-linux-gnu"},
+          {"cargo_profile": "release-native", "sys_target": "x86_64-v2-linux-gnu"},
+          {"cargo_profile": "release-native", "sys_target": "x86_64-v3-linux-gnu"},
+          {"cargo_profile": "release-native", "sys_target": "x86_64-v4-linux-gnu"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "feat_set": "none"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "feat_set": "default"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "feat_set": "logging"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "sys_target": "x86_64-v1-linux-gnu"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "sys_target": "x86_64-v2-linux-gnu"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "sys_target": "x86_64-v3-linux-gnu"},
+          {"rust_target": "aarch64-unknown-linux-gnu", "sys_target": "x86_64-v4-linux-gnu"},
+          {"rust_target": "x86_64-unknown-linux-gnu", "sys_target": "aarch64-v8-linux-gnu"},
+          {"sys_target": "aarch64-v8-linux-gnu", "machine": "X64"},
+          {"sys_target": "x86_64-v1-linux-gnu", "machine": "ARM64"},
+          {"sys_target": "x86_64-v2-linux-gnu", "machine": "ARM64"},
+          {"sys_target": "x86_64-v2-linux-gnu", "feat_set": "none"},
+          {"sys_target": "x86_64-v2-linux-gnu", "feat_set": "default"},
+          {"sys_target": "x86_64-v2-linux-gnu", "feat_set": "logging"},
+          {"sys_target": "x86_64-v3-linux-gnu", "machine": "ARM64"},
+          {"sys_target": "x86_64-v3-linux-gnu", "feat_set": "none"},
+          {"sys_target": "x86_64-v3-linux-gnu", "feat_set": "default"},
+          {"sys_target": "x86_64-v3-linux-gnu", "feat_set": "logging"},
+          {"sys_target": "x86_64-v3-linux-gnu", "bake_target": "smoke-valgrind"},
+          {"sys_target": "x86_64-v4-linux-gnu", "machine": "ARM64"},
+          {"sys_target": "x86_64-v4-linux-gnu", "feat_set": "none"},
+          {"sys_target": "x86_64-v4-linux-gnu", "feat_set": "default"},
+          {"sys_target": "x86_64-v4-linux-gnu", "feat_set": "logging"},
+          {"sys_target": "x86_64-v4-linux-gnu", "bake_target": "smoke-valgrind"},
+        ]
+
+  nix:
+    if: >
+      !failure() && !cancelled()
+      && !contains(inputs.head_msg, '[ci only it]')
+      && !contains(inputs.head_msg, '[ci no build]')
+      && !contains(github.ref, 'refs/pull')
+      && contains(fromJSON(inputs.cargo_profiles), fromJSON('["release"]')[0])
+      && contains(fromJSON(inputs.feat_sets), fromJSON('["all"]')[0])
+      && contains(fromJSON(inputs.rust_toolchains), fromJSON('["stable"]')[0])
+      && contains(fromJSON(inputs.sys_targets), fromJSON('["x86_64-v1-linux-gnu"]')[0])
+      && fromJSON(inputs.build_nix)
+
+    name: Smoke NixOS
+    uses: ./.github/workflows/bake.yml
+    with:
+      bake_targets: '["smoke-nix"]'
+      cargo_profiles: '["release"]'
+      feat_sets: '["all"]'
+      rust_toolchains: '["stable"]'
+      sys_names: ${{inputs.sys_names}}
+      sys_versions: ${{inputs.sys_versions}}
+      rust_targets: ${{inputs.rust_targets}}
+      sys_targets: '["x86_64-v1-linux-gnu"]'
+      machines: ${{inputs.machines}}
+      excludes: ${{inputs.excludes}}
+      includes: ${{inputs.includes}}
+
+  rust-sdk-integ:
+    if: >
+      !failure() && !cancelled()
+      && !contains(inputs.head_msg, '[ci no build]')
+      && inputs.rust_sdk_integ
+      && contains(fromJSON(inputs.feat_sets), fromJSON('["all"]')[0])
+      && contains(fromJSON(inputs.rust_toolchains), fromJSON('["nightly"]')[0])
+      && contains(fromJSON(inputs.rust_targets), fromJSON('["x86_64-unknown-linux-gnu"]')[0])
+
+    name: Matrix SDK Integration
+    needs: [smoke]
+    uses: ./.github/workflows/bake.yml
+    with:
+      #bake_targets: '["rust-sdk-integ", "rust-sdk-valgrind"]'
+      bake_targets: '["rust-sdk-integ"]'
+      cargo_profiles: ${{inputs.cargo_profiles}}
+      feat_sets: '["all"]'
+      rust_toolchains: '["nightly"]'
+      sys_names: ${{inputs.sys_names}}
+      sys_versions: ${{inputs.sys_versions}}
+      rust_targets: '["x86_64-unknown-linux-gnu"]'
+      sys_targets: ${{inputs.sys_targets}}
+      machines: '["X64"]'
+      runner: ${{inputs.complement_runner}}
+      includes: ${{inputs.includes}}
+      artifact: >
+        {
+          "rust-sdk-integ": {
+            "src": "/var/log/tuwunel.log",
+            "dst": "rust-sdk-integ.tuwunel.log",
+          },
+          "rust-sdk-valgrind": {
+            "src": "/var/log/tuwunel.log",
+            "dst": "rust-sdk-valgrind.tuwunel.log",
+          }
+        }
+      excludes: >
+        [
+          {"bake_target": "rust-sdk-valgrind", "cargo_profile": "test"},
+          {"feat_set": "none"},
+          {"feat_set": "logging"},
+          {"cargo_profile": "release"},
+          {"cargo_profile": "release-debuginfo"},
+          {"cargo_profile": "release-native"},
+          {"cargo_profile": "test", "sys_target": "x86_64-v2-linux-gnu"},
+          {"cargo_profile": "test", "sys_target": "x86_64-v3-linux-gnu"},
+          {"cargo_profile": "bench", "sys_target": "x86_64-v1-linux-gnu"},
+          {"cargo_profile": "bench", "sys_target": "x86_64-v2-linux-gnu"},
+          {"rust_target": "aarch64-unknown-linux-gnu"},
+          {"sys_target": "aarch64-v8-linux-gnu"},
+        ]
+
+  complement:
+    if: >
+      !failure() && !cancelled()
+      && !contains(inputs.head_msg, '[ci no build]')
+      && inputs.complement
+      && contains(fromJSON(inputs.cargo_profiles), fromJSON('["bench"]')[0])
+      && contains(fromJSON(inputs.rust_toolchains), fromJSON('["nightly"]')[0])
+      && contains(fromJSON(inputs.sys_targets), fromJSON('["x86_64-v3-linux-gnu"]')[0])
+
+    name: Complement
+    uses: ./.github/workflows/bake.yml
+    with:
+      bake_targets: '["complement-tester", "complement-testee"]'
+      cargo_profiles: '["bench"]'
+      feat_sets: '["logging"]'
+      rust_toolchains: '["nightly"]'
+      sys_names: ${{inputs.sys_names}}
+      sys_versions: ${{inputs.sys_versions}}
+      rust_targets: ${{inputs.rust_targets}}
+      sys_targets: '["x86_64-v3-linux-gnu"]'
+      machines: ${{inputs.machines}}
+      runner: ${{inputs.complement_runner}}
+      excludes: ${{inputs.excludes}}
+      includes: ${{inputs.includes}}
+
+  compliance:
+    if: >
+      !failure() && !cancelled()
+      && !contains(inputs.head_msg, '[ci no build]')
+      && inputs.complement
+      && inputs.machines
+      && contains(fromJSON(inputs.cargo_profiles), fromJSON('["bench"]')[0])
+      && contains(fromJSON(inputs.rust_toolchains), fromJSON('["nightly"]')[0])
+      && contains(fromJSON(inputs.sys_targets), fromJSON('["x86_64-v3-linux-gnu"]')[0])
+
+    name: Matrix Compliance
+    needs: [complement, smoke]
+    runs-on: ["${{matrix.machine}}", "${{inputs.complement_runner}}"]
+    concurrency:
+      group: complement-cant-walk-and-chew-bubblegum
+      cancel-in-progress: false
+
+    strategy:
+      fail-fast: false
+      matrix:
+        cargo_profile: ${{fromJSON('["bench"]')}}
+        feat_set: ${{fromJSON('["logging"]')}}
+        rust_toolchain: ${{fromJSON('["nightly"]')}}
+        sys_name: ${{fromJSON(inputs.sys_names)}}
+        sys_version: ${{fromJSON(inputs.sys_versions)}}
+        rust_target: ${{fromJSON(inputs.rust_targets)}}
+        sys_target: ${{fromJSON('["x86_64-v3-linux-gnu"]')}}
+        machine: ${{fromJSON(inputs.machines)}}
+        exclude: ${{fromJSON(inputs.excludes)}}
+        include: ${{fromJSON(inputs.includes)}}
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Execute
+      id: execute
+      env:
+        cargo_profile: ${{matrix.cargo_profile}}
+        rust_toolchain: ${{matrix.rust_toolchain}}
+        rust_target: ${{matrix.rust_target}}
+        feat_set: ${{matrix.feat_set}}
+        sys_name: ${{matrix.sys_name}}
+        sys_target: ${{matrix.sys_target}}
+        sys_version: ${{matrix.sys_version}}
+        machine: ${{matrix.machine}}
+
+      run: |
+        docker/complement.sh
+
+    - if: success() || failure() && steps.execute.outcome == 'failure'
+      name: Extract
+      id: extract
+      env:
+        name: complement_tester__${{matrix.sys_name}}__${{matrix.sys_version}}__${{matrix.sys_target}}
+        tag: latest
+
+      run: |
+        cid=$(cat "$name")
+        docker cp "$cid:/usr/src/complement/new_results.jsonl" tests/complement/results.jsonl
+
+    - if: success() || failure() && steps.execute.outcome == 'failure'
+      name: Upload New Results
+      id: upload-result
+      uses: actions/upload-artifact@v4
+      with:
+        name: complement_results-${{matrix.feat_set}}-${{matrix.sys_name}}-${{matrix.sys_target}}.jsonl
+        path: ./tests/complement/results.jsonl
+
+    - if: failure() && steps.execute.outcome == 'failure'
+      name: Upload Failure Output
+      id: upload-output
+      uses: actions/upload-artifact@v4
+      with:
+        name: complement_output-${{matrix.feat_set}}-${{matrix.sys_name}}-${{matrix.sys_target}}.jsonl
+        path: ./tests/complement/logs.jsonl
+        if-no-files-found: ignore
+
+    - name: Accept
+      id: accept
+      run: |
+        git diff --exit-code --color --color-moved

.github/workflows/trivy.yml

@@ -1,42 +0,0 @@
-name: Trivy code and vulnerability scanning
-
-on:
-  pull_request:
-  push:
-    branches:
-      - main
-    tags:
-      - '*'
-  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.24.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.24.0
-        with:
-          scan-type: fs
-          format: sarif
-          output: trivy-results.sarif
-          severity: CRITICAL,HIGH,MEDIUM,LOW

.gitignore

@@ -30,7 +30,7 @@ modules.xml
 .nfs*
 
 # Rust
-/target/
+/target
 
 ### vscode ###
 .vscode/*
@@ -94,4 +94,11 @@ public/
 rustc-ice-*
 
 # complement test logs are huge
-tests/test_results/complement/test_logs.jsonl
+tests/complement/logs.jsonl
+
+# cargo profiles from -Z self-profile
+*.mm_profdata
+
+# Editor crashfiles
+*.save
+*.swp

.gitlab-ci.yml

@@ -1,144 +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:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE=" >> /etc/nix/nix.conf; fi
-
-  - if command -v nix > /dev/null; then echo "extra-substituters = https://attic.kennel.juneis.dog/conduit" >> /etc/nix/nix.conf; fi
-  - if command -v nix > /dev/null; then echo "extra-trusted-public-keys = conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk=" >> /etc/nix/nix.conf; fi
-
-  # Add alternate binary cache
-  - if command -v nix > /dev/null && [ -n "$ATTIC_ENDPOINT" ]; then echo "extra-substituters = $ATTIC_ENDPOINT" >> /etc/nix/nix.conf; fi
-  - if command -v nix > /dev/null && [ -n "$ATTIC_PUBLIC_KEY" ]; then echo "extra-trusted-public-keys = $ATTIC_PUBLIC_KEY" >> /etc/nix/nix.conf; fi
-
-  # Add Lix binary cache
-  - if command -v nix > /dev/null; then echo "extra-substituters = https://cache.lix.systems" >> /etc/nix/nix.conf; fi
-  - if command -v nix > /dev/null; then echo "extra-trusted-public-keys = cache.lix.systems:aBnZUw8zA7H35Cz2RyKFVs3H4PlGTLawyY5KRbvJR8o=" >> /etc/nix/nix.conf; fi
-
-  # Add crane binary cache
-  - if command -v nix > /dev/null; then echo "extra-substituters = https://crane.cachix.org" >> /etc/nix/nix.conf; fi
-  - if command -v nix > /dev/null; then echo "extra-trusted-public-keys = crane.cachix.org-1:8Scfpmn9w+hGdXH/Q9tTLiYAE/2dnJYRJP7kl80GuRk=" >> /etc/nix/nix.conf; fi
-
-  # Add nix-community binary cache
-  - if command -v nix > /dev/null; then echo "extra-substituters = https://nix-community.cachix.org" >> /etc/nix/nix.conf; fi
-  - if command -v nix > /dev/null; then echo "extra-trusted-public-keys = nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs=" >> /etc/nix/nix.conf; fi
-
-  # Install direnv and nix-direnv
-  - if command -v nix > /dev/null; then nix-env -iA nixpkgs.direnv nixpkgs.nix-direnv; 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.23.3
-  script:
-    # Cache CI dependencies
-    - ./bin/nix-build-and-cache ci
-
-    - direnv exec . engage
-  cache:
-    key: nix
-    paths:
-      - target
-      - .gitlab-ci.d
-  rules:
-    # CI on upstream runners (only available for maintainers)
-    - if: $CI_PIPELINE_SOURCE == "merge_request_event" && $IS_UPSTREAM_CI == "true"
-    # Manual CI on unprotected branches that are not MRs
-    - if: $CI_PIPELINE_SOURCE != "merge_request_event" && $CI_COMMIT_REF_PROTECTED == "false"
-      when: manual
-    # Manual CI on forks
-    - if: $IS_UPSTREAM_CI != "true"
-      when: manual
-    - if: $CI
-  interruptible: true
-
-artifacts:
-  stage: artifacts
-  image: nixos/nix:2.23.3
-  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

.typos.toml

@@ -0,0 +1,6 @@
+[default.extend-words]
+"allocatedp" = "allocatedp"
+"conduwuit" = "conduwuit"
+"execuse" = "execuse"
+"leafs" = "leafs"
+"serialize" = "serialize"

CODE_OF_CONDUCT.md

@@ -1,4 +1,3 @@
-
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge
@@ -18,24 +17,24 @@ ## Our Standards
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
+* Demonstrating empathy and kindness toward other people.
+* Being respectful of differing opinions, viewpoints, and experiences.
+* Giving and gracefully accepting constructive feedback.
 * Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
+  and learning from the experience.
 * Focusing on what is best not just for us as individuals, but for the overall
-  community
+  community.
 
 Examples of unacceptable behavior include:
 
 * The use of sexualized language or imagery, and sexual attention or advances of
-  any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
+  any kind.
+* Trolling, insulting or derogatory comments, and personal or political attacks.
+* Public or private harassment.
 * Publishing others' private information, such as a physical or email address,
-  without their explicit permission
+  without their explicit permission.
 * Other conduct which could reasonably be considered inappropriate in a
-  professional setting
+  professional setting.
 
 ## Enforcement Responsibilities
 
@@ -61,10 +60,10 @@ ## 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.
-All complaints will be reviewed and investigated promptly and fairly.
+<abuse@tuwunel.chat> or over Matrix at @abuse:tuwunel.chat.
 
-All community leaders are obligated to respect the privacy and security of the
+All complaints will be reviewed and investigated promptly and fairly. All
+community leaders are obligated to respect the privacy and security of the
 reporter of any incident.
 
 ## Enforcement Guidelines

CONTRIBUTING.md

@@ -1,10 +1,10 @@
 # Contributing guide
 
-This page is for about contributing to conduwuit. The
-[development](development.md) page may be of interest for you as well.
+This page is for about contributing to Tuwunel. 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],
+ask in the Matrix room first at [#tuwunel:tuwunel.chat][tuwunel-chat],
 and comment on it.
 
 ### Linting and Formatting
@@ -23,40 +23,7 @@ ### Linting and Formatting
 
 ### 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`
+<sub>TODO: docker bake matrix</sub>
 
 ### Matrix tests
 
@@ -67,13 +34,13 @@ ### Matrix tests
 artifacts) and determine if they're intended or not.
 
 If you'd like to run Complement locally using Nix, see the
-[testing](docs/development/testing.md) page.
+[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
+Tuwunel'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.
@@ -111,7 +78,7 @@ ### Variable, comment, function, etc standards
 
 ### Creating pull requests
 
-Please try to keep contributions to the GitHub. While the mirrors of conduwuit
+Please try to keep contributions to the GitHub. While the mirrors of Tuwunel
 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
@@ -120,21 +87,34 @@ ### Creating pull requests
 
 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
+repo bots in the Tuwunel 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`.
+do so at `maintainer@tuwunel.chat`.
 
 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.
+in line with the Contributor's Covenant, and Tuwunel's Code of Conduct.
 
-[issues]: https://github.com/girlbossceo/conduwuit/issues
-[conduwuit-matrix]: https://matrix.to/#/#conduwuit:puppygock.gay
+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
+Tuwunel Matrix rooms for Code of Conduct violations.
+
+### Branch Policy
+
+##### This section applies to Matrix-Construct members and Tuwunel maintainers
+
+All branches on the matrix-construct/tuwunel repository are _centrally
+maintained_. They may be rebased without your consent. Trivial conflicts may be
+resolved by another maintainer. Please resolve more difficult conflicts as soon
+as possible. Personal forks are advised to reduce the workload on other
+maintainers. Stale branches will be deleted to reduce the effort for this
+policy.
+
+[issues]: https://github.com/matrix-construct/tuwunel/issues
+[tuwunel-chat]: https://matrix.to/#/#tuwunel:tuwunel.chat
 [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
@@ -142,4 +122,4 @@ ### Creating pull requests
 [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
+[documentation.yml]: https://github.com/matrix-construct/tuwunel/blob/main/.github/workflows/docs.yml

README.md

@@ -1,77 +1,157 @@
-# conduwuit
+# Tuwunel<sup>💕</sup>
 
-`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)
+![GitHub License](https://img.shields.io/github/license/matrix-construct/tuwunel?style=flat&color=%238A2BE2)
+![GitHub Created At](https://img.shields.io/github/created-at/matrix-construct/tuwunel?style=flat&color=%238A2BE2)
+![GitHub Commit Activity](https://img.shields.io/github/commit-activity/m/matrix-construct/tuwunel?style=flat&link=https%3A%2F%2Fgithub.com%2Fmatrix-construct%2Ftuwunel%2Fpulse%2Fmonthly&color=%238A2BE2)
+![Docker Pulls](https://img.shields.io/docker/pulls/jevolk/tuwunel?style=flat&color=8A2BE2)
+![GitHub Repo Stars](https://img.shields.io/github/stars/matrix-construct/tuwunel?style=flat&link=https%3A%2F%2Fgithub.com%2Fmatrix-construct%2Ftuwunel&color=%238A2BE2)
+[![CI/CD](https://github.com/matrix-construct/tuwunel/actions/workflows/main.yml/badge.svg?branch=main&style=flat)](https://github.com/matrix-construct/tuwunel/actions/workflows/main.yml)
 
-<!-- ANCHOR: catchphrase --> ### a very cool, featureful fork of
-[Conduit](https://conduit.rs/) <!-- ANCHOR_END: catchphrase -->
+<!-- ANCHOR: catchphrase -->
 
-Visit the [Conduwuit documentation](https://conduwuit.puppyirl.gay/) for more
-information.
+## High Performance Matrix Homeserver in Rust!
 
-<!-- ANCHOR: body --> #### What is Matrix?
+<!-- ANCHOR_END: catchphrase -->
 
-[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.
+<!-- ANCHOR: body -->
 
-#### What is the goal?
+Tuwunel is a featureful [Matrix](https://matrix.org/) homeserver you can use instead of Synapse
+with your favorite [client](https://matrix.org/ecosystem/clients/),
+[bridge](https://matrix.org/ecosystem/bridges/) or
+[bot](https://matrix.org/ecosystem/integrations/). It is written entirely in Rust to be a scalable,
+lightweight, low-cost, community-driven alternative covering all but the most niche uses.
 
-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.
+This project is the official successor to conduwuit, which
+was a featureful and high-performance fork of [Conduit](https://gitlab.com/famedly/conduit), all
+community-lead homeservers implementing the compatible
+[Matrix Specification](https://spec.matrix.org/latest/).
 
-#### Can I try it out?
+Tuwunel is operated by enterprise users with a vested interest in sponsoring its continued
+development. It is now maintained by full-time staff.
 
-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))
+### Getting Started
 
-transfem.dev is a public homeserver that can be used, it is not a "test only
-homeserver". This means there are rules, so please read the rules:
-[https://transfem.dev/homeserver_rules.txt](https://transfem.dev/homeserver_rules.txt)
+- [GitHub Releases](https://github.com/matrix-construct/tuwunel/releases)
+- [Sourcecode](https://github.com/matrix-construct/tuwunel/) `git clone https://github.com/matrix-construct/tuwunel.git`
+- [DockerHub](https://hub.docker.com/r/jevolk/tuwunel) or `docker pull jevolk/tuwunel:latest`
+- [GHCR](https://github.com/matrix-construct/tuwunel/pkgs/container/tuwunel) or `docker pull ghcr.io/matrix-construct/tuwunel:latest`
+- Static binaries available as [releases](https://github.com/matrix-construct/tuwunel/releases) or [build artifacts](https://github.com/matrix-construct/tuwunel/actions?query=branch%3Amain).
+- Deb and RPM packages available as [releases](https://github.com/matrix-construct/tuwunel/releases) or [build artifacts](https://github.com/matrix-construct/tuwunel/actions?query=branch%3Amain).
+- Arch package available as [tuwunel](https://aur.archlinux.org/packages/tuwunel) or [tuwunel-git](https://aur.archlinux.org/packages/tuwunel-git).
+- Nix package still [needs some love](https://github.com/NixOS/nixpkgs/issues/415469).
 
-transfem.dev is also listed at
-[servers.joinmatrix.org](https://servers.joinmatrix.org/)
+**1.** [Configure](https://matrix-construct.github.io/tuwunel/configuration.html) by
+copying and editing the `tuwunel-example.toml`. The `server_name` and `database_path` must be
+configured. **Most users deploy via docker or a distribution package and should follow the
+[appropriate guide](https://matrix-construct.github.io/tuwunel/deploying.html) instead.**
+This is just a summary for the impatient. See the full
+[documentation](https://matrix-construct.github.io/tuwunel/).
 
-#### What is the current status?
+> [!TIP]
+> Avoid using a sub-domain for your `server_name`. You can always delegate later with a [`.well-known`](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/docs/configuring-well-known.md)
+> file, but you can never change your `server_name`.
 
-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.
+**2.** Setup TLS certificates. Most users enjoy the [Caddy](https://caddyserver.com/) reverse-proxy
+which automates their certificate renewal. Advanced users can load their own TLS certificates
+using the configuration and Tuwunel can be deployed without a reverse proxy. Example
+`/etc/caddy/Caddyfile` configuration with [Element](https://github.com/element-hq/element-web/releases)
+unzipped to `/var/www/element`:
+```
+tuwunel.me, tuwunel.me:8448 {
+    reverse_proxy localhost:8008
+}
+web.tuwunel.me {
+    root * /var/www/element/
+    file_server
+}
+```
+`caddy reload --config /etc/caddy/Caddyfile`
+
+**3.** Start the server, connect your client and register your username. The first registration is
+granted server admin.
+
+> [!TIP]
+> Configure a secret `registration_token` and set `allow_registration = true`
+
+ 🤗 Did you find this and other documentation helpful? We would love to hear feedback about setting
+ up Tuwunel.
+
+
+### Migrating to Tuwunel
+
+| Can I migrate from | |
+|-----------------|-----------|
+| conduwuit? | ✅ Yes. This will be supported at a minimum for one year, but likely indefinitely. |
+| Synapse? | ❌ Not yet, but this is planned and an important issue. Subscribe to [#2](https://github.com/matrix-construct/tuwunel/issues/2). |
+| Conduit? | ❌ Not right now, but this is planned for the near future. Subscribe to [#41](https://github.com/matrix-construct/tuwunel/issues/41). |
+| Any other fork of Conduit? | ❌ No. The migration must be explicitly listed in this table. |
+> [!CAUTION]
+> **Never switch between different forks of Conduit or you will corrupt your database.**
+> All derivatives of Conduit share the same linear database version without any awareness of other
+> forks. The database will permanently corrupt and we will not be able to help you.
+
+#### Migrating from conduwuit
+
+Migrating from conduwuit to Tuwunel _just works_. In technical parlance it is a "binary swap."
+All you have to do is update to the latest Tuwunel and change the path to the executable from
+`conduwuit` to `tuwunel`.
+
+Anything else named "conduwuit" is still recognized, this includes environment variables with prefixes
+such as `CONDUWUIT_`. In fact, `CONDUIT_` is still recognized for our legacy users. You may have
+noticed that various configs, yamls, services, users, and other items were renamed, but if you
+were a conduwuit user we recommend against changing anything at all. This will keep things simple.
+If you are not sure please ask. If you found out that something did in fact need to be changed
+please open an issue immediately.
+
+
+### Upgrading & Downgrading Tuwunel
+
+We strive to make moving between versions of Tuwunel safe and easy. Downgrading Tuwunel is always
+safe but often prevented by a guard. An error will indicate the downgrade is not possible and a
+newer version which does not error must be sought.
+
+#### Branches
+
+The main branch is always _reasonably safe_ to run. We understand the propensity for users to simply clone
+the main branch to get up and running, and we're obliged to ensure it's always viable. Nevertheless, only
+tagged releases are true releases.
+
+#### Container Tracking
+
+> [!IMPORTANT]
+> **We strongly advise tracking the `:latest` tag when automatically updating.**
+
+Tracking `:latest` gives us the necessary discretion to keep you on the appropriate stable version.
+We discourage tracking the main branch unless frequent restarts are acceptable. Alternatively,
+tracking the `:preview` tag provides the latest release-candidate becoming equivalent to `:latest`
+after a release. Tracking the `:preview` tag is a worthy alternative to the main branch, with
+turbulence limited to release-time.
+
+### Getting Help & Support
+
+If you are opposed to using github, or if private discussion is required such as for security
+disclosures, or for any other reason, I would be happy to receive your DM at
+[@jason:tuwunel.me](https://matrix.to/#/@jason:tuwunel.me). This will not be bothering me as it would
+be my pleasure to help you when possible. As an emergency contact you can send an email to
+jasonzemos@gmail.com.
+
+##### Tuwunel Fanclub
+
+We have an unofficial community-run chat which is publicly accessible at
+[#tuwunel:matrix.org](https://matrix.to/#/#tuwunel:matrix.org). The members, content, or moderation
+decisions of this room are not in any way related or endorsed by this project or its sponsors,
+and not all project staff will be present there. There will be at least some presence by staff to
+offer assistance so long as the room remains in minimally good standing.
+
+
+## Tuwunel<sup>💕</sup>
+
+Tuwunel's theme is **empathy** in communication defined by the works of
+[Edith Stein](https://plato.stanford.edu/entries/stein/). Empathy is the basis for how we approach
+every message and our responsibility to the other in every conversation.
 
 <!-- ANCHOR_END: body -->
 
-<!-- ANCHOR: footer --> #### Contact
+<!-- ANCHOR: footer -->
 
-If you run into any question, feel free to
-
-- Ask us in `#conduwuit:puppygock.gay` on Matrix
-- [Open an issue on GitHub](https://github.com/girlbossceo/conduwuit/issues/new)
-
-#### Donate
-
-- Liberapay: <https://liberapay.com/girlbossceo>
-- Ko-fi: <https://ko-fi.com/puppygock>
-- GitHub Sponsors: <https://github.com/sponsors/girlbossceo>
-
-#### 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/conduwuit/conduwuit>
-- git.girlcock.ceo: <https://git.girlcock.ceo/strawberry/conduwuit>
-- git.gay: <https://git.gay/june/conduwuit>
-- Codeberg: <https://codeberg.org/girlbossceo/conduwuit>
-- sourcehut: <https://git.sr.ht/~girlbossceo/conduwuit> <!-- ANCHOR_END: footer
--->
+<!-- ANCHOR_END: footer -->

RELEASE.md

@@ -0,0 +1,39 @@
+# Tuwunel 1.4.7
+
+December 3, 2025
+
+Tuwunel is now deployed at scale serving the citizens of Switzerland in production. Some optimizations were requested to reduce operating costs from projected growth over product lifespan: this release delivers with markedly reduced CPU usage and improves responsiveness. However, complications during routine dependency upgrades consumed valuable time planned for features and issues which could not be completed for this release.
+
+### New Features
+
+- Upgrade Support for Room Version 12 is now available. Though this room version has been supported for the entire 1.4 series, all Tuwunel servers have been protected by Hydra Backports on all room versions. As such, other work was able to be prioritized for the preceding releases.
+
+### Enhancements
+
+- Recursive relations have been enabled. This is an optimization which allows the server to gather more data using fewer client requests, for example, of a thread with many reactions and replies. The implementation is now optimal and utilizes the full capabilities of Tuwunel's asynchronous database.
+
+- Several miscellaneous but significant optimizations took place at the direction of memory profiling. This reduced load on the allocator for database queries and JSON serialization of complex objects. Heroes calculations and the joined room hot-path on sync v3 were further optimized to reduce the database query load itself.
+
+- Jemalloc has been repackaged with platform-specific optimizations enhancing the build. The upgrade to the dev branch of libjemalloc itself was considered as too much variability for the same release, it is planned for an upcoming release.
+
+- Thanks to element-hq/synapse#18970 by @dasha-uwu, we have very slightly turned down the amount of randomness when selecting join-servers, More retries also occur within a single request if necessary. Thanks to @gogo199432 and @lifeofguenter for reporting problems in (#128) and (#205) respectively. More opportunities are still available to make large room joins robust.
+
+### Bug Fixes
+
+- Special thanks to @yefimg for fixing LDAP logout in (#231) from a report kindly made by @orhtej2 in (#97); thank you for your patience waiting for domain expertise to assist here.
+
+- Thanks to @Radiant-Xyz the example configurations have been updated to remove `allow_check_for_updates`. This fixes any warnings for the item no longer existing. (#221)
+
+- Thanks again to @Radiant-Xyz reporting in (#219) the `/whoami` endpoint is now returns spec-compliant errors for Mautrix bridges (fe12daead9). Thanks also to @bobobo1618 for confirming the fix is working.
+
+- Relations responses were sometimes incorrect in the forwards direction. This was fixed by (5147b541) bringing those responses into full compliance. Note the prior release had also fixed compliance issues but in the backwards direction.
+
+- Server selection for backfill struggled sometimes for version 12 rooms. These rooms might fail to load history after join. Additional servers are now found using `creators` and `additional_creators` instead.
+
+- Room leave compliance has been fixed for an edge-case where a room becomes empty except for a locally invited user which does not have its leave event sent down `/sync`.
+
+- Thanks to @grinapo for a report which lead to the discovery of events acquired over backfill not being checked for whether they already exist.
+
+### Upcoming
+
+- As stated in the summary, several planned items could not be cut into this release. These include SSO/OIDC support (#7), Element Call setup assistance and documentation (#217)(#215), User-level Admin Room and Media deletion (#192), and any other assigned issue. These items are on the short-list for the next cycle and mean a lot to us; to all participants: your issues are not being ignored and we hear you.

arch/tuwunel.service

@@ -0,0 +1,79 @@
+[Unit]
+Description=Tuwunel Matrix homeserver
+Wants=network-online.target
+After=network-online.target
+Documentation=https://tuwunel.chat/
+RequiresMountsFor=/var/lib/private/tuwunel
+
+[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=tuwunel
+
+RuntimeDirectory=tuwunel
+RuntimeDirectoryMode=0750
+
+Environment="TUWUNEL_CONFIG=/etc/tuwunel/tuwunel.toml"
+BindPaths=/var/lib/private/tuwunel:/var/lib/conduwuit
+BindPaths=/var/lib/private/tuwunel:/var/lib/private/conduwuit
+BindPaths=/var/lib/private/tuwunel:/var/lib/matrix-conduit
+BindPaths=/var/lib/private/tuwunel:/var/lib/private/matrix-conduit
+
+ExecStart=/usr/bin/tuwunel
+Restart=on-failure
+RestartSec=5
+
+TimeoutStopSec=4m
+TimeoutStartSec=4m
+
+StartLimitInterval=1m
+StartLimitBurst=5
+
+[Install]
+WantedBy=multi-user.target
+Alias=matrix-tuwunel.service

bin/complement

@@ -1,56 +0,0 @@
-#!/usr/bin/env bash
-
-set -euo pipefail
-
-# Path to Complement's source code
-#
-# The `COMPLEMENT_SRC` environment variable is set in the Nix dev shell, which
-# points to a store path containing the Complement source code. It's likely you
-# want to just pass that as the first argument to use it here.
-COMPLEMENT_SRC="${COMPLEMENT_SRC:-$1}"
-
-# A `.jsonl` file to write test logs to
-LOG_FILE="$2"
-
-# A `.jsonl` file to write test results to
-RESULTS_FILE="$3"
-
-OCI_IMAGE="complement-conduit:main"
-
-# Complement tests that are skipped due to flakiness/reliability issues
-SKIPPED_COMPLEMENT_TESTS='-skip=TestClientSpacesSummary.*|TestJoinFederatedRoomFromApplicationServiceBridgeUser.*|TestJumpToDateEndpoint.*'
-
-# $COMPLEMENT_SRC needs to be a directory to Complement source code
-if [ -f "$COMPLEMENT_SRC" ]; then
-    echo "\$COMPLEMENT_SRC must be a directory/path to Complement source code"
-    exit 1
-fi
-
-# quick test to make sure we can actually write to $LOG_FILE and $RESULTS_FILE
-touch $LOG_FILE && rm -v $LOG_FILE
-touch $RESULTS_FILE && rm -v $RESULTS_FILE
-
-toplevel="$(git rev-parse --show-toplevel)"
-
-pushd "$toplevel" > /dev/null
-
-bin/nix-build-and-cache just .#static-complement
-
-docker load < result
-popd > /dev/null
-
-# It's okay (likely, even) that `go test` exits nonzero
-set +o pipefail
-env \
-    -C "$COMPLEMENT_SRC" \
-    COMPLEMENT_BASE_IMAGE="$OCI_IMAGE" \
-    go test -tags="conduwuit_blacklist" "$SKIPPED_COMPLEMENT_TESTS" -v -timeout 1h -json ./tests | tee "$LOG_FILE"
-set -o pipefail
-
-# Post-process the results into an easy-to-compare format, sorted by Test name for reproducible results
-cat "$LOG_FILE" | jq -s -c 'sort_by(.Test)[]' | jq -c '
-    select(
-        (.Action == "pass" or .Action == "fail" or .Action == "skip")
-        and .Test != null
-    ) | {Action: .Action, Test: .Test}
-    ' > "$RESULTS_FILE"

book.toml

@@ -1,24 +1,31 @@
 [book]
-title = "conduwuit 🏳️‍⚧️ 💜 🦴"
-description = "conduwuit, which is a well-maintained fork of Conduit, is a simple, fast and reliable chat server for the Matrix protocol"
+authors = [
+	"girlbossceo",
+	"jevolk"
+]
+description = "Tuwunel, a high performance successor to Conduit and Conduwuit"
 language = "en"
-authors = ["strawberry (June)"]
-text-direction = "ltr"
-multilingual = false
 src = "docs"
+title = "Tuwunel One"
+text-direction = "ltr"
 
 [build]
 build-dir = "public"
 create-missing = true
-extra-watch-dirs = ["debian", "docs"]
+extra-watch-dirs = [
+	"debian",
+	"docker",
+	"docs",
+	"rpm",
+]
 
 [rust]
-edition = "2021"
+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"
+git-repository-url = "https://github.com/matrix-construct/tuwunel"
+edit-url-template = "https://github.com/matrix-construct/tuwunel/edit/main/{path}"
+git-repository-icon = "fab-github"
 
 [output.html.search]
 limit-results = 15

clippy.toml

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

conduwuit-example.toml

@@ -1,863 +0,0 @@
-# =============================================================================
-#  This is the official example config for conduwuit.
-#  If you use it for your server, you will need to adjust it to your own needs.
-#  At the very least, change the server_name field!
-#
-#  This documentation can also be found at https://conduwuit.puppyirl.gay/configuration.html
-# =============================================================================
-
-[global]
-
-# The server_name is the pretty name of this server. It is used as a suffix for user
-# and room ids. Examples: matrix.org, conduit.rs
-
-# The Conduit server needs all /_matrix/ requests to be reachable at
-# https://your.server.name/ on port 443 (client-server) and 8448 (federation).
-
-# If that's not possible for you, you can create /.well-known files to redirect
-# requests (delegation). See
-# https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixclient
-# and
-# https://spec.matrix.org/v1.9/server-server-api/#getwell-knownmatrixserver
-# for more information
-
-# YOU NEED TO EDIT THIS
-#server_name = "your.server.name"
-
-# Servers listed here will be used to gather public keys of other servers (notary trusted key servers).
-#
-# The default behaviour for conduwuit is to attempt to query trusted key servers before querying the individual servers.
-# This is done for performance reasons, but if you would like to query individual servers before the notary servers
-# configured below, set to
-#
-# (Currently, conduwuit doesn't support batched key requests, so this list should only contain Synapse servers)
-# Defaults to `matrix.org`
-# trusted_servers = ["matrix.org"]
-
-# Sentry.io crash/panic reporting, performance monitoring/metrics, etc. This is NOT enabled by default.
-# conduwuit's default Sentry reporting endpoint is o4506996327251968.ingest.us.sentry.io
-#
-# Defaults to *false*
-#sentry = false
-
-# Sentry reporting URL if a custom one is desired
-#
-# Defaults to conduwuit's default Sentry endpoint: "https://fe2eb4536aa04949e28eff3128d64757@o4506996327251968.ingest.us.sentry.io/4506996334657536"
-#sentry_endpoint = ""
-
-# Report your Conduwuit server_name in Sentry.io crash reports and metrics
-#
-# Defaults to false
-#sentry_send_server_name = false
-
-# Performance monitoring/tracing sample rate for Sentry.io
-#
-# Note that too high values may impact performance, and can be disabled by setting it to 0.0 (0%)
-# This value is read as a percentage to Sentry, represented as a decimal
-#
-# Defaults to 15% of traces (0.15)
-#sentry_traces_sample_rate = 0.15
-
-# Whether to attach a stacktrace to Sentry reports.
-#sentry_attach_stacktrace = false
-
-# Send panics to sentry. This is true by default, but sentry has to be enabled.
-#sentry_send_panic = true
-
-# Send errors to sentry. This is true by default, but sentry has to be enabled. This option is
-# only effective in release-mode; forced to false in debug-mode.
-#sentry_send_error = true
-
-
-### Database configuration
-
-# This is the only directory where conduwuit will save its data, including media.
-# Note: this was previously "/var/lib/matrix-conduit"
-database_path = "/var/lib/conduwuit"
-
-# Database backend: Only rocksdb is supported.
-database_backend = "rocksdb"
-
-
-### Network
-
-# The port(s) conduwuit will be running on. You need to set up a reverse proxy such as
-# Caddy or Nginx so all requests to /_matrix on port 443 and 8448 will be
-# forwarded to the conduwuit instance running on this port
-# Docker users: Don't change this, you'll need to map an external port to this.
-# To listen on multiple ports, specify a vector e.g. [8080, 8448]
-#
-# default if unspecified is 8008
-port = 6167
-
-# default address (IPv4 or IPv6) conduwuit will listen on. Generally you want this to be
-# localhost (127.0.0.1 / ::1). If you are using Docker or a container NAT networking setup, you
-# likely need this to be 0.0.0.0.
-# To listen multiple addresses, specify a vector e.g. ["127.0.0.1", "::1"]
-#
-# default if unspecified is both IPv4 and IPv6 localhost: ["127.0.0.1", "::1"]
-address = "127.0.0.1"
-
-# Max request size for file uploads
-max_request_size = 20_000_000 # in bytes
-
-# Uncomment unix_socket_path to listen on a UNIX socket at the specified path.
-# If listening on a UNIX socket, you must remove/comment the 'address' key if defined and add your
-# reverse proxy to the 'conduwuit' group, unless world RW permissions are specified with unix_socket_perms (666 minimum).
-#unix_socket_path = "/run/conduwuit/conduwuit.sock"
-#unix_socket_perms = 660
-
-# Set this to true for conduwuit to compress HTTP response bodies using zstd.
-# This option does nothing if conduwuit was not built with `zstd_compression` feature.
-# Please be aware that enabling HTTP compression may weaken TLS.
-# Most users should not need to enable this.
-# See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH before deciding to enable this.
-zstd_compression = false
-
-# Set this to true for conduwuit to compress HTTP response bodies using gzip.
-# This option does nothing if conduwuit was not built with `gzip_compression` feature.
-# Please be aware that enabling HTTP compression may weaken TLS.
-# Most users should not need to enable this.
-# See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH before deciding to enable this.
-gzip_compression = false
-
-# Set this to true for conduwuit to compress HTTP response bodies using brotli.
-# This option does nothing if conduwuit was not built with `brotli_compression` feature.
-# Please be aware that enabling HTTP compression may weaken TLS.
-# Most users should not need to enable this.
-# See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH before deciding to enable this.
-brotli_compression = false
-
-# Vector list of IPv4 and IPv6 CIDR ranges / subnets *in quotes* that you do not want conduwuit to send outbound requests to.
-# Defaults to RFC1918, unroutable, loopback, multicast, and testnet addresses for security.
-#
-# To disable, set this to be an empty vector (`[]`).
-# Please be aware that this is *not* a guarantee. You should be using a firewall with zones as doing this on the application layer may have bypasses.
-#
-# Currently this does not account for proxies in use like Synapse does.
-ip_range_denylist = [
-    "127.0.0.0/8",
-    "10.0.0.0/8",
-    "172.16.0.0/12",
-    "192.168.0.0/16",
-    "100.64.0.0/10",
-    "192.0.0.0/24",
-    "169.254.0.0/16",
-    "192.88.99.0/24",
-    "198.18.0.0/15",
-    "192.0.2.0/24",
-    "198.51.100.0/24",
-    "203.0.113.0/24",
-    "224.0.0.0/4",
-    "::1/128",
-    "fe80::/10",
-    "fc00::/7",
-    "2001:db8::/32",
-    "ff00::/8",
-    "fec0::/10",
-]
-
-
-### Moderation / Privacy / Security
-
-# Set to true to allow user type "guest" registrations. Element attempts to register guest users automatically.
-# Defaults to false
-allow_guest_registration = false
-
-# Set to true to log guest registrations in the admin room.
-# Defaults to false as it may be noisy or unnecessary.
-log_guest_registrations = false
-
-# Set to true to allow guest registrations/users to auto join any rooms specified in `auto_join_rooms`
-# Defaults to false
-allow_guests_auto_join_rooms = false
-
-# Vector list of servers that conduwuit will refuse to download remote media from.
-# No default.
-# prevent_media_downloads_from = ["example.com", "example.local"]
-
-# Enables registration. If set to false, no users can register on this
-# server.
-# If set to true without a token configured, users can register with no form of 2nd-
-# step only if you set
-# `yes_i_am_very_very_sure_i_want_an_open_registration_server_prone_to_abuse` to
-# true in your config. If you would like
-# registration only via token reg, please configure the `registration_token` key.
-allow_registration = false
-# Please note that an open registration homeserver with no second-step verification
-# is highly prone to abuse and potential defederation by homeservers, including
-# matrix.org.
-
-# A static registration token that new users will have to provide when creating
-# an account. If unset and `allow_registration` is true, registration is open
-# without any condition. YOU NEED TO EDIT THIS.
-registration_token = "change this token for something specific to your server"
-
-# controls whether federation is allowed or not
-# defaults to true
-# allow_federation = true
-
-# controls whether users are allowed to create rooms.
-# appservices and admins are always allowed to create rooms
-# defaults to true
-# allow_room_creation = true
-
-# controls whether non-admin local users are forbidden from sending room invites (local and remote),
-# and if non-admin users can receive remote room invites. admins are always allowed to send and receive all room invites.
-# defaults to false
-# block_non_admin_invites = false
-
-# Allows admins to enter commands in rooms other than #admins by prefixing with \!admin. The reply
-# will be publicly visible to the room, originating from the sender.
-# defaults to true
-#admin_escape_commands = true
-
-# List of forbidden username patterns/strings. Values in this list are matched as *contains*.
-# This is checked upon username availability check, registration, and startup as warnings if any local users in your database
-# have a forbidden username.
-# No default.
-# forbidden_usernames = []
-
-# List of forbidden room aliases and room IDs as patterns/strings. Values in this list are matched as *contains*.
-# This is checked upon room alias creation, custom room ID creation if used, and startup as warnings if any room aliases
-# in your database have a forbidden room alias/ID.
-# No default.
-# forbidden_alias_names = []
-
-# List of forbidden server names that we will block incoming AND outgoing federation with, and block client room joins / remote user invites.
-#
-# This check is applied on the room ID, room alias, sender server name, sender user's server name, inbound federation X-Matrix origin, and outbound federation handler.
-#
-# Basically "global" ACLs. No default.
-# forbidden_remote_server_names = []
-
-# List of forbidden server names that we will block all outgoing federated room directory requests for. Useful for preventing our users from wandering into bad servers or spaces.
-# No default.
-# forbidden_remote_room_directory_server_names = []
-
-# Set this to true to allow your server's public room directory to be federated.
-# Set this to false to protect against /publicRooms spiders, but will forbid external users
-# from viewing your server's public room directory. If federation is disabled entirely
-# (`allow_federation`), this is inherently false.
-allow_public_room_directory_over_federation = false
-
-# Set this to true to allow your server's public room directory to be queried without client
-# authentication (access token) through the Client APIs. Set this to false to protect against /publicRooms spiders.
-allow_public_room_directory_without_auth = false
-
-# Set this to true to lock down your server's public room directory and only allow admins to publish rooms to the room directory.
-# Unpublishing is still allowed by all users with this enabled.
-#
-# Defaults to false
-lockdown_public_room_directory = false
-
-# Set this to true to allow federating device display names / allow external users to see your device display name.
-# If federation is disabled entirely (`allow_federation`), this is inherently false. For privacy, this is best disabled.
-allow_device_name_federation = false
-
-# Vector list of domains allowed to send requests to for URL previews. Defaults to none.
-# Note: this is a *contains* match, not an explicit match. Putting "google.com" will match "https://google.com" and "http://mymaliciousdomainexamplegoogle.com"
-# Setting this to "*" will allow all URL previews. Please note that this opens up significant attack surface to your server, you are expected to be aware of the risks by doing so.
-url_preview_domain_contains_allowlist = []
-
-# Vector list of explicit domains allowed to send requests to for URL previews. Defaults to none.
-# Note: This is an *explicit* match, not a contains match. Putting "google.com" will match "https://google.com", "http://google.com", but not "https://mymaliciousdomainexamplegoogle.com"
-# Setting this to "*" will allow all URL previews. Please note that this opens up significant attack surface to your server, you are expected to be aware of the risks by doing so.
-url_preview_domain_explicit_allowlist = []
-
-# Vector list of URLs allowed to send requests to for URL previews. Defaults to none.
-# Note that this is a *contains* match, not an explicit match. Putting "google.com" will match "https://google.com/", "https://google.com/url?q=https://mymaliciousdomainexample.com", and "https://mymaliciousdomainexample.com/hi/google.com"
-# Setting this to "*" will allow all URL previews. Please note that this opens up significant attack surface to your server, you are expected to be aware of the risks by doing so.
-url_preview_url_contains_allowlist = []
-
-# Vector list of explicit domains not allowed to send requests to for URL previews. Defaults to none.
-# Note: This is an *explicit* match, not a contains match. Putting "google.com" will match "https://google.com", "http://google.com", but not "https://mymaliciousdomainexamplegoogle.com"
-# The denylist is checked first before allowlist. Setting this to "*" will not do anything.
-url_preview_domain_explicit_denylist = []
-
-# Maximum amount of bytes allowed in a URL preview body size when spidering. Defaults to 384KB (384_000 bytes)
-url_preview_max_spider_size = 384_000
-
-# Option to decide whether you would like to run the domain allowlist checks (contains and explicit) on the root domain or not. Does not apply to URL contains allowlist. Defaults to false.
-# Example: If this is enabled and you have "wikipedia.org" allowed in the explicit and/or contains domain allowlist, it will allow all subdomains under "wikipedia.org" such as "en.m.wikipedia.org" as the root domain is checked and matched.
-# Useful if the domain contains allowlist is still too broad for you but you still want to allow all the subdomains under a root domain.
-url_preview_check_root_domain = false
-
-# Config option to allow or disallow incoming federation requests that obtain the profiles
-# of our local users from `/_matrix/federation/v1/query/profile`
-#
-# This is inherently false if `allow_federation` is disabled
-#
-# Defaults to true
-allow_profile_lookup_federation_requests = true
-
-# Config option to automatically deactivate the account of any user who attempts to join a:
-# - banned room
-# - forbidden room alias
-# - room alias or ID with a forbidden server name
-#
-# This may be useful if all your banned lists consist of toxic rooms or servers that no good faith user would ever attempt to join, and
-# to automatically remediate the problem without any admin user intervention.
-#
-# This will also make the user leave all rooms. Federation (e.g. remote room invites) are ignored here.
-#
-# Defaults to false as rooms can be banned for non-moderation-related reasons
-#auto_deactivate_banned_room_attempts = false
-
-
-### Misc
-
-# max log level for conduwuit. allows debug, info, warn, or error
-# see also: https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives
-# **Caveat**:
-# For release builds, the tracing crate is configured to only implement levels higher than error to avoid unnecessary overhead in the compiled binary from trace macros.
-# For debug builds, this restriction is not applied.
-#
-# Defaults to "info"
-#log = "info"
-
-# controls whether encrypted rooms and events are allowed (default true)
-#allow_encryption = false
-
-# if enabled, conduwuit will send a simple GET request periodically to `https://pupbrain.dev/check-for-updates/stable`
-# for any new announcements made. Despite the name, this is not an update check
-# endpoint, it is simply an announcement check endpoint.
-# Defaults to false.
-#allow_check_for_updates = false
-
-# Set to false to disable users from joining or creating room versions that aren't 100% officially supported by conduwuit.
-# conduwuit officially supports room versions 6 - 10. conduwuit has experimental/unstable support for 3 - 5, and 11.
-# Defaults to true.
-#allow_unstable_room_versions = true
-
-# Option to control adding arbitrary text to the end of the user's displayname upon registration with a space before the text.
-# This was the lightning bolt emoji option, just replaced with support for adding your own custom text or emojis.
-# To disable, set this to "" (an empty string)
-# Defaults to "🏳️‍⚧️" (trans pride flag)
-#new_user_displayname_suffix = "🏳️‍⚧️"
-
-# Option to control whether conduwuit will query your list of trusted notary key servers (`trusted_servers`) for
-# remote homeserver signing keys it doesn't know *first*, or query the individual servers first before falling back to the trusted
-# key servers.
-#
-# The former/default behaviour makes federated/remote rooms joins generally faster because we're querying a single (or list of) server
-# that we know works, is reasonably fast, and is reliable for just about all the homeserver signing keys in the room. Querying individual
-# servers may take longer depending on the general infrastructure of everyone in there, how many dead servers there are, etc.
-#
-# However, this does create an increased reliance on one single or multiple large entities as `trusted_servers` should generally
-# contain long-term and large servers who know a very large number of homeservers.
-#
-# If you don't know what any of this means, leave this and `trusted_servers` alone to their defaults.
-#
-# Defaults to true as this is the fastest option for federation.
-#query_trusted_key_servers_first = true
-
-# List/vector of room **IDs** that conduwuit will make newly registered users join.
-# The room IDs specified must be rooms that you have joined at least once on the server, and must be public.
-#
-# No default.
-#auto_join_rooms = []
-
-# Retry failed and incomplete messages to remote servers immediately upon startup. This is called bursting.
-# If this is disabled, said messages may not be delivered until more messages are queued for that server.
-# Do not change this option unless server resources are extremely limited or the scale of the server's
-# deployment is huge. Do not disable this unless you know what you are doing.
-#startup_netburst = true
-
-# Limit the startup netburst to the most recent (default: 50) messages queued for each remote server. All older
-# messages are dropped and not reattempted. The `startup_netburst` option must be enabled for this value to have
-# any effect. Do not change this value unless you know what you are doing. Set this value to -1 to reattempt
-# every message without trimming the queues; this may consume significant disk. Set this value to 0 to drop all
-# messages without any attempt at redelivery.
-#startup_netburst_keep = 50
-
-# If the 'perf_measurements' feature is enabled, enables collecting folded stack trace profile of tracing spans using
-# tracing_flame. The resulting profile can be visualized with inferno[1], speedscope[2], or a number of other tools.
-# [1]: https://github.com/jonhoo/inferno
-# [2]: www.speedscope.app
-# tracing_flame = false
-
-# If 'tracing_flame' is enabled, sets a filter for which events will be included in the profile.
-# Supported syntax is documented at https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives
-# tracing_flame_filter = "trace,h2=off"
-
-# If 'tracing_flame' is enabled, set the path to write the generated profile.
-# tracing_flame_output_path = "./tracing.folded"
-
-# Enable the tokio-console. This option is only relevant to developers.
-# See: docs/development.md#debugging-with-tokio-console for more information.
-#tokio_console = false
-
-# Enable backward-compatibility with Conduit's media directory by creating symlinks of media. This
-# option is only necessary if you plan on using Conduit again. Otherwise setting this to false
-# reduces filesystem clutter and overhead for managing these symlinks in the directory. This is now
-# disabled by default. You may still return to upstream Conduit but you have to run Conduwuit at
-# least once with this set to true and allow the media_startup_check to take place before shutting
-# down to return to Conduit.
-#
-# Disabled by default.
-#media_compat_file_link = false
-
-# Prunes missing media from the database as part of the media startup checks. This means if you
-# delete files from the media directory the corresponding entries will be removed from the
-# database. This is disabled by default because if the media directory is accidentally moved or
-# inaccessible the metadata entries in the database will be lost with sadness.
-#
-# Disabled by default.
-#prune_missing_media = false
-
-# Checks consistency of the media directory at startup:
-# 1. When `media_compat_file_link` is enbled, this check will upgrade media when switching back
-#    and forth between Conduit and Conduwuit. Both options must be enabled to handle this.
-# 2. When media is deleted from the directory, this check will also delete its database entry.
-#
-# If none of these checks apply to your use cases, and your media directory is significantly large
-# setting this to false may reduce startup time.
-#
-# Enabled by default.
-#media_startup_check = true
-
-# OpenID token expiration/TTL in seconds
-#
-# These are the OpenID tokens that are primarily used for Matrix account integrations, *not* OIDC/OpenID Connect/etc
-#
-# Defaults to 3600 (1 hour)
-#openid_token_ttl = 3600
-
-# Emergency password feature. This password set here will let you login to the server service account (e.g. `@conduit`)
-# and let you run admin commands, invite yourself to the admin room, etc.
-#
-# no default.
-#emergency_password = ""
-
-
-### Generic database options
-
-# Set this to any float value to multiply conduwuit's in-memory LRU caches with.
-# May be useful if you have significant memory to spare to increase performance.
-#
-# This was previously called `conduit_cache_capacity_modifier`
-#
-# Defaults to 1.0.
-#cache_capacity_modifier = 1.0
-
-# Set this to any float value in megabytes for conduwuit to tell the database engine that this much memory is available for database-related caches.
-# May be useful if you have significant memory to spare to increase performance.
-# Defaults to 256.0
-#db_cache_capacity_mb = 256.0
-
-
-### RocksDB options
-
-# Set this to true to use RocksDB config options that are tailored to HDDs (slower device storage)
-#
-# It is worth noting that by default, conduwuit will use RocksDB with Direct IO enabled. *Generally* speaking this improves performance as it bypasses buffered I/O (system page cache).
-# However there is a potential chance that Direct IO may cause issues with database operations if your setup is uncommon. This has been observed with FUSE filesystems, and possibly ZFS filesystem.
-# RocksDB generally deals/corrects these issues but it cannot account for all setups.
-# If you experience any weird RocksDB issues, try enabling this option as it turns off Direct IO and feel free to report in the conduwuit Matrix room if this option fixes your DB issues.
-# See https://github.com/facebook/rocksdb/wiki/Direct-IO for more information.
-#
-# Defaults to false
-#rocksdb_optimize_for_spinning_disks = false
-
-# Enables direct-io to increase database performance. This is enabled by default. Set this option to false if the
-# database resides on a filesystem which does not support direct-io.
-#rocksdb_direct_io = true
-
-# RocksDB log level. This is not the same as conduwuit's log level. This is the log level for the RocksDB engine/library
-# which show up in your database folder/path as `LOG` files. Defaults to error. conduwuit will typically log RocksDB errors as normal.
-#rocksdb_log_level = "error"
-
-# Max RocksDB `LOG` file size before rotating in bytes. Defaults to 4MB.
-#rocksdb_max_log_file_size = 4194304
-
-# Time in seconds before RocksDB will forcibly rotate logs. Defaults to 0.
-#rocksdb_log_time_to_roll = 0
-
-# Amount of threads that RocksDB will use for parallelism on database operatons such as cleanup, sync, flush, compaction, etc. Set to 0 to use all your logical threads.
-#
-# Defaults to your CPU logical thread count.
-#rocksdb_parallelism_threads = 0
-
-# Enables idle IO priority for compaction thread. This prevents any unexpected lag in the server's operation and
-# is usually a good idea. Enabled by default.
-#rocksdb_compaction_ioprio_idle = true
-
-# Enables idle CPU priority for compaction thread. This is not enabled by default to prevent compaction from
-# falling too far behind on busy systems.
-#rocksdb_compaction_prio_idle = false
-
-# Maximum number of LOG files RocksDB will keep. This must *not* be set to 0. It must be at least 1.
-# Defaults to 3 as these are not very useful.
-#rocksdb_max_log_files = 3
-
-# Type of RocksDB database compression to use.
-# Available options are "zstd", "zlib", "bz2", "lz4", or "none"
-# It is best to use ZSTD as an overall good balance between speed/performance, storage, IO amplification, and CPU usage.
-# For more performance but less compression (more storage used) and less CPU usage, use LZ4.
-# See https://github.com/facebook/rocksdb/wiki/Compression for more details.
-#
-# "none" will disable compression.
-#
-# Defaults to "zstd"
-#rocksdb_compression_algo = "zstd"
-
-# Level of compression the specified compression algorithm for RocksDB to use.
-# Default is 32767, which is internally read by RocksDB as the default magic number and
-# translated to the library's default compression level as they all differ.
-# See their `kDefaultCompressionLevel`.
-#
-#rocksdb_compression_level = 32767
-
-# Level of compression the specified compression algorithm for the bottommost level/data for RocksDB to use.
-# Default is 32767, which is internally read by RocksDB as the default magic number and
-# translated to the library's default compression level as they all differ.
-# See their `kDefaultCompressionLevel`.
-#
-# Since this is the bottommost level (generally old and least used data), it may be desirable to have a very
-# high compression level here as it's lesss likely for this data to be used. Research your chosen compression algorithm.
-#
-#rocksdb_bottommost_compression_level = 32767
-
-# Whether to enable RocksDB "bottommost_compression".
-# At the expense of more CPU usage, this will further compress the database to reduce more storage.
-# It is recommended to use ZSTD compression with this for best compression results.
-# See https://github.com/facebook/rocksdb/wiki/Compression for more details.
-#
-# Defaults to false as this uses more CPU when compressing.
-#rocksdb_bottommost_compression = false
-
-# Level of statistics collection. Some admin commands to display database statistics may require
-# this option to be set. Database performance may be impacted by higher settings.
-#
-# Option is a number ranging from 0 to 6:
-# 0 = No statistics.
-# 1 = No statistics in release mode (default).
-# 2 to 3 = Statistics with no performance impact.
-# 3 to 5 = Statistics with possible performance impact.
-# 6 = All statistics.
-#
-# Defaults to 1 (No statistics, except in debug-mode)
-#rocksdb_stats_level = 1
-
-# Database repair mode (for RocksDB SST corruption)
-#
-# Use this option when the server reports corruption while running or panics. If the server refuses
-# to start use the recovery mode options first. Corruption errors containing the acronym 'SST' which
-# occur after startup will likely require this option.
-#
-# - Backing up your database directory is recommended prior to running the repair.
-# - Disabling repair mode and restarting the server is recommended after running the repair.
-#
-# Defaults to false
-#rocksdb_repair = false
-
-# Database recovery mode (for RocksDB WAL corruption)
-#
-# Use this option when the server reports corruption and refuses to start. Set mode 2 (PointInTime)
-# to cleanly recover from this corruption. The server will continue from the last good state,
-# several seconds or minutes prior to the crash. Clients may have to run "clear-cache & reload" to
-# account for the rollback. Upon success, you may reset the mode back to default and restart again.
-# Please note in some cases the corruption error may not be cleared for at least 30 minutes of
-# operation in PointInTime mode.
-#
-# As a very last ditch effort, if PointInTime does not fix or resolve anything, you can try mode
-# 3 (SkipAnyCorruptedRecord) but this will leave the server in a potentially inconsistent state.
-#
-# The default mode 1 (TolerateCorruptedTailRecords) will automatically drop the last entry in the
-# database if corrupted during shutdown, but nothing more. It is extraordinarily unlikely this will
-# desynchronize clients. To disable any form of silent rollback set mode 0 (AbsoluteConsistency).
-#
-# The options are:
-# 0 = AbsoluteConsistency
-# 1 = TolerateCorruptedTailRecords (default)
-# 2 = PointInTime (use me if trying to recover)
-# 3 = SkipAnyCorruptedRecord (you now voided your Conduwuit warranty)
-#
-# See https://github.com/facebook/rocksdb/wiki/WAL-Recovery-Modes for more information
-#
-# Defaults to 1 (TolerateCorruptedTailRecords)
-#rocksdb_recovery_mode = 1
-
-
-### Domain Name Resolution and Caching
-
-# Maximum entries stored in DNS memory-cache. The size of an entry may vary so please take care if
-# raising this value excessively. Only decrease this when using an external DNS cache. Please note
-# that systemd does *not* count as an external cache, even when configured to do so.
-#dns_cache_entries = 32768
-
-# Minimum time-to-live in seconds for entries in the DNS cache. The default may appear high to most
-# administrators; this is by design. Only decrease this if you are using an external DNS cache.
-#dns_min_ttl = 10800
-
-# Minimum time-to-live in seconds for NXDOMAIN entries in the DNS cache. This value is critical for
-# the server to federate efficiently. NXDOMAIN's are assumed to not be returning to the federation
-# and aggressively cached rather than constantly rechecked.
-#
-# Defaults to 3 days as these are *very rarely* false negatives.
-#dns_min_ttl_nxdomain = 259200
-
-# The number of seconds to wait for a reply to a DNS query. Please note that recursive queries can
-# take up to several seconds for some domains, so this value should not be too low.
-#dns_timeout = 10
-
-# Number of retries after a timeout.
-#dns_attempts = 10
-
-# Fallback to TCP on DNS errors. Set this to false if unsupported by nameserver.
-#dns_tcp_fallback = true
-
-# Enable to query all nameservers until the domain is found. Referred to as "trust_negative_responses" in hickory_resolver.
-# This can avoid useless DNS queries if the first nameserver responds with NXDOMAIN or an empty NOERROR response.
-#
-# The default is to query one nameserver and stop (false).
-#query_all_nameservers = true
-
-# Enables using *only* TCP for querying your specified nameservers instead of UDP.
-#
-# You very likely do *not* want this. hickory-resolver already falls back to TCP on UDP errors.
-# Defaults to false
-#query_over_tcp_only = false
-
-# DNS A/AAAA record lookup strategy
-#
-# Takes a number of one of the following options:
-# 1 - Ipv4Only (Only query for A records, no AAAA/IPv6)
-# 2 - Ipv6Only (Only query for AAAA records, no A/IPv4)
-# 3 - Ipv4AndIpv6 (Query for A and AAAA records in parallel, uses whatever returns a successful response first)
-# 4 - Ipv6thenIpv4 (Query for AAAA record, if that fails then query the A record)
-# 5 - Ipv4thenIpv6 (Query for A record, if that fails then query the AAAA record)
-#
-# If you don't have IPv6 networking, then for better performance it may be suitable to set this to Ipv4Only (1) as
-# you will never ever use the AAAA record contents even if the AAAA record is successful instead of the A record.
-#
-# Defaults to 5 - Ipv4ThenIpv6 as this is the most compatible and IPv4 networking is currently the most prevalent.
-#ip_lookup_strategy = 5
-
-
-### Request Timeouts, Connection Timeouts, and Connection Pooling
-
-## Request Timeouts are HTTP response timeouts
-## Connection Timeouts are TCP connection timeouts
-##
-## Connection Pooling Timeouts are timeouts for keeping an open idle connection alive.
-## Connection pooling and keepalive is very useful for federation or other places where for performance reasons,
-## we want to keep connections open that we will re-use frequently due to TCP and TLS 1.3 overhead/expensiveness.
-##
-## Generally these defaults are the best, but if you find a reason to need to change these they are here.
-
-# Default/base connection timeout.
-# This is used only by URL previews and update/news endpoint checks
-#
-# Defaults to 10 seconds
-#request_conn_timeout = 10
-
-# Default/base request timeout. The time waiting to receive more data from another server.
-# This is used only by URL previews, update/news, and misc endpoint checks
-#
-# Defaults to 35 seconds
-#request_timeout = 35
-
-# Default/base request total timeout. The time limit for a whole request. This is set very high to not
-# cancel healthy requests while serving as a backstop.
-# This is used only by URL previews and update/news endpoint checks
-#
-# Defaults to 320 seconds
-#request_total_timeout = 320
-
-# Default/base idle connection pool timeout
-# This is used only by URL previews and update/news endpoint checks
-#
-# Defaults to 5 seconds
-#request_idle_timeout = 5
-
-# Default/base max idle connections per host
-# This is used only by URL previews and update/news endpoint checks
-#
-# Defaults to 1 as generally the same open connection can be re-used
-#request_idle_per_host = 1
-
-# Federation well-known resolution connection timeout
-#
-# Defaults to 6 seconds
-#well_known_conn_timeout = 6
-
-# Federation HTTP well-known resolution request timeout
-#
-# Defaults to 10 seconds
-#well_known_timeout = 10
-
-# Federation client request timeout
-# You most definitely want this to be high to account for extremely large room joins, slow homeservers, your own resources etc.
-#
-# Defaults to 300 seconds
-#federation_timeout = 300
-
-# Federation client idle connection pool timeout
-#
-# Defaults to 25 seconds
-#federation_idle_timeout = 25
-
-# Federation client max idle connections per host
-#
-# Defaults to 1 as generally the same open connection can be re-used
-#federation_idle_per_host = 1
-
-# Federation sender request timeout
-# The time it takes for the remote server to process sent transactions can take a while.
-#
-# Defaults to 180 seconds
-#sender_timeout = 180
-
-# Federation sender idle connection pool timeout
-#
-# Defaults to 180 seconds
-#sender_idle_timeout = 180
-
-# Federation sender transaction retry backoff limit
-#
-# Defaults to 86400 seconds
-#sender_retry_backoff_limit = 86400
-
-# Appservice URL request connection timeout
-#
-# Defaults to 35 seconds as generally appservices are hosted within the same network
-#appservice_timeout = 35
-
-# Appservice URL idle connection pool timeout
-#
-# Defaults to 300 seconds
-#appservice_idle_timeout = 300
-
-# Notification gateway pusher idle connection pool timeout
-#
-# Defaults to 15 seconds
-#pusher_idle_timeout = 15
-
-
-### Presence / Typing Indicators / Read Receipts
-
-# Config option to control local (your server only) presence updates/requests. Defaults to true.
-# Note that presence on conduwuit is very fast unlike Synapse's.
-# If using outgoing presence, this MUST be enabled.
-#
-#allow_local_presence = true
-
-# Config option to control incoming federated presence updates/requests. Defaults to true.
-# This option receives presence updates from other servers, but does not send any unless `allow_outgoing_presence` is true.
-# Note that presence on conduwuit is very fast unlike Synapse's.
-#
-#allow_incoming_presence = true
-
-# Config option to control outgoing presence updates/requests. Defaults to true.
-# This option sends presence updates to other servers, but does not receive any unless `allow_incoming_presence` is true.
-# Note that presence on conduwuit is very fast unlike Synapse's.
-# If using outgoing presence, you MUST enable `allow_local_presence` as well.
-#
-#allow_outgoing_presence = true
-
-# Config option to enable the presence idle timer for remote users. Disabling is offered as an optimization for
-# servers participating in many large rooms or when resources are limited. Disabling it may cause incorrect
-# presence states (i.e. stuck online) to be seen for some remote users. Defaults to true.
-#presence_timeout_remote_users = true
-
-# Config option to control how many seconds before presence updates that you are idle. Defaults to 5 minutes.
-#presence_idle_timeout_s = 300
-
-# Config option to control how many seconds before presence updates that you are offline. Defaults to 30 minutes.
-#presence_offline_timeout_s = 1800
-
-# Config option to control whether we should receive remote incoming read receipts.
-# Defaults to true.
-#allow_incoming_read_receipts = true
-
-# Config option to control whether we should send read receipts to remote servers.
-# Defaults to true.
-#allow_outgoing_read_receipts = true
-
-# Config option to control outgoing typing updates to federation. Defaults to true.
-#allow_outgoing_typing = true
-
-# Config option to control incoming typing updates from federation. Defaults to true.
-#allow_incoming_typing = true
-
-# Config option to control maximum time federation user can indicate typing.
-#typing_federation_timeout_s = 30
-
-# Config option to control minimum time local client can indicate typing. This does not override
-# a client's request to stop typing. It only enforces a minimum value in case of no stop request.
-#typing_client_timeout_min_s = 15
-
-# Config option to control maximum time local client can indicate typing.
-#typing_client_timeout_max_s = 45
-
-
-### TURN / VoIP
-
-# vector list of TURN URIs/servers to use
-#
-# No default
-#turn_uris = ["turn:example.turn.uri?transport=udp", "turn:example.turn.uri?transport=tcp"]
-
-# TURN secret to use for generating the HMAC-SHA1 hash apart of username and password generation
-#
-# this is more secure, but if needed you can use traditional username/password below.
-#
-# no default
-#turn_secret = ""
-
-# TURN username to provide the client
-#
-# no default
-#turn_username = ""
-
-# TURN password to provide the client
-#
-# no default
-#turn_password = ""
-
-# TURN TTL
-#
-# Default is 86400 seconds
-#turn_ttl = 86400
-
-# allow guests/unauthenticated users to access TURN credentials
-#
-# this is the equivalent of Synapse's `turn_allow_guests` config option. this allows
-# any unauthenticated user to call `/_matrix/client/v3/voip/turnServer`.
-#
-# defaults to false
-#turn_allow_guests = false
-
-
-# Other options not in [global]:
-#
-#
-# Enables running conduwuit with direct TLS support
-# It is strongly recommended you use a reverse proxy instead. This is primarily relevant for test suites like complement that require a private CA setup.
-# [global.tls]
-# certs = "/path/to/my/certificate.crt"
-# key = "/path/to/my/private_key.key"
-#
-# Whether to listen and allow for HTTP and HTTPS connections (insecure!)
-# This config option is only available if conduwuit was built with `axum_dual_protocol` feature (not default feature)
-# Defaults to false
-#dual_protocol = false
-
-
-# If you are using delegation via well-known files and you cannot serve them from your reverse proxy, you can
-# uncomment these to serve them directly from conduwuit. This requires proxying all requests to conduwuit, not just `/_matrix` to work.
-#
-#[global.well_known]
-#server = "matrix.example.com:443"
-#client = "https://matrix.example.com"
-#
-# A single contact and/or support page for /.well-known/matrix/support
-# All options here are strings. Currently only supports 1 single contact.
-# No default.
-#
-#support_page = ""
-#support_role = ""
-#support_email = ""
-#support_mxid = ""

debian/README.md

@@ -1,22 +1,36 @@
-# conduwuit for Debian
+# Tuwunel for Debian
 
-Information about downloading and deploying the Debian package. This may also be referenced for other `apt`-based distros such as Ubuntu.
+Information about downloading and deploying the Debian package. This may also be
+referenced for other `apt`-based distros such as Ubuntu.
 
 ### Installation
 
-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.
+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.
+
+No `apt` repository is currently offered yet, it is in the works/development.
 
 ### Configuration
 
-When installed, the example config is placed at `/etc/conduwuit/conduwuit.toml` as the default config. At the minimum, you will need to change your `server_name` here.
+When installed, the example config is placed at `/etc/tuwunel/tuwunel.toml`
+as the default config. The config mentions things required to be changed before
+starting.
 
-You can tweak more detailed settings by uncommenting and setting the config options
-in `/etc/conduwuit/conduwuit.toml`.
+You can tweak more detailed settings by uncommenting and setting the config
+options in `/etc/tuwunel/tuwunel.toml`.
 
 ### 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`.
+The package uses the [`tuwunel.service`](../configuration/examples.md#example-systemd-unit-file)
+systemd unit file to start and stop Tuwunel. The binary is installed at `/usr/sbin/tuwunel`.
 
-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.
+This package assumes by default that Tuwunel 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.
+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/config

@@ -6,13 +6,13 @@ set -e
 #. /usr/share/debconf/confmodule
 #
 ## Ask for the Matrix homeserver name, address and port.
-#db_input high conduwuit/hostname || true
+#db_input high tuwunel/hostname || true
 #db_go
 #
-#db_input low conduwuit/address || true
+#db_input low tuwunel/address || true
 #db_go
 #
-#db_input medium conduwuit/port || true
+#db_input medium tuwunel/port || true
 #db_go
 
 exit 0

debian/postinst

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

debian/postrm

@@ -3,28 +3,48 @@ set -e
 
 #. /usr/share/debconf/confmodule
 
-CONDUWUIT_CONFIG_PATH=/etc/conduwuit
-CONDUWUIT_DATABASE_PATH=/var/lib/conduwuit
-CONDUWUIT_DATABASE_PATH_SYMLINK=/var/lib/matrix-conduit
+TUWUNEL_CONFIG_PATH=/etc/tuwunel
+TUWUNEL_DATABASE_PATH=/var/lib/tuwunel
+CONDUIT_DATABASE_PATH_SYMLINK=/var/lib/matrix-conduit
+CONDUWUIT_DATABASE_PATH_SYMLINK=/var/lib/conduwuit
 
 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 -v -r "$CONDUWUIT_CONFIG_PATH"
+
+    #
+
+    if [ -d "$TUWUNEL_CONFIG_PATH" ]; then
+      if test -L "$TUWUNEL_CONFIG_PATH"; then
+        echo "Deleting tuwunel configuration files"
+        rm -v -r "$TUWUNEL_CONFIG_PATH"
+      fi
     fi
 
-    if [ -d "$CONDUWUIT_DATABASE_PATH" ]; then
-      rm -v -r "$CONDUWUIT_DATABASE_PATH"
+    if [ -d "$TUWUNEL_DATABASE_PATH" ]; then
+      if test -L "$TUWUNEL_DATABASE_PATH"; then
+        echo "Deleting tuwunel database directory"
+        rm -r "$TUWUNEL_DATABASE_PATH"
+      fi
+    fi
+
+    if [ -d "$CONDUIT_DATABASE_PATH_SYMLINK" ]; then
+      if test -L "$CONDUIT_DATABASE_SYMLINK"; then
+        echo "Removing matrix-conduit symlink"
+        rm -r "$CONDUIT_DATABASE_PATH_SYMLINK"
+      fi
     fi
 
     if [ -d "$CONDUWUIT_DATABASE_PATH_SYMLINK" ]; then
-      rm -v -r "$CONDUWUIT_DATABASE_PATH_SYMLINK"
+      if test -L "$CONDUWUIT_DATABASE_SYMLINK"; then
+        echo "Removing conduwuit symlink"
+        rm -r "$CONDUWUIT_DATABASE_PATH_SYMLINK"
+      fi
     fi
     ;;
 esac

debian/tuwunel.service

@@ -1,13 +1,20 @@
 [Unit]
-Description=conduwuit Matrix homeserver
-After=network.target
-Documentation=https://conduwuit.puppyirl.gay/
-RequiresMountsFor=/var/lib/private/conduwuit
+Description=Tuwunel Matrix homeserver
+Wants=network-online.target
+After=network-online.target
+Documentation=https://tuwunel.chat/
 
 [Service]
-DynamicUser=yes
+User=tuwunel
+Group=tuwunel
 Type=notify
 
+Environment="TUWUNEL_CONFIG=/etc/tuwunel/tuwunel.toml"
+
+ExecStart=/usr/sbin/tuwunel
+
+ReadWritePaths=/var/lib/tuwunel /etc/tuwunel
+
 AmbientCapabilities=
 CapabilityBoundingSet=
 
@@ -15,7 +22,7 @@ DevicePolicy=closed
 LockPersonality=yes
 MemoryDenyWriteExecute=yes
 NoNewPrivileges=yes
-ProcSubset=pid
+#ProcSubset=pid
 ProtectClock=yes
 ProtectControlGroups=yes
 ProtectHome=yes
@@ -39,24 +46,20 @@ 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
+#StateDirectory=tuwunel
 
-RuntimeDirectory=conduwuit
+RuntimeDirectory=tuwunel
 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
+TimeoutStopSec=2m
+TimeoutStartSec=2m
 
 StartLimitInterval=1m
 StartLimitBurst=5
 
 [Install]
 WantedBy=multi-user.target
+Alias=matrix-tuwunel.service

deps/rust-rocksdb/Cargo.toml

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

deps/rust-rocksdb/lib.rs

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

development.md

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

docker/Dockerfile.cargo

@@ -0,0 +1,105 @@
+# syntax = docker/dockerfile:1.11-labs
+
+FROM input AS cargo
+ARG sys_triple
+ARG rust_target
+ARG rust_toolchain
+ARG RUST_HOME
+ARG RUSTUP_HOME
+ARG CARGO_HOME
+ARG CARGO_TARGET
+ARG CARGO_TARGET_DIR
+ARG cargo_target_profile
+ARG cargo_target_artifact
+ARG cargo_target_share
+ARG cargo_share
+ARG CARGO_TERM_VERBOSE=0
+ARG RUST_BACKTRACE
+ARG JEMALLOC_OVERRIDE
+ARG ROCKSDB_LIB_DIR
+ARG VALGRINDFLAGS=""
+ARG CARGO_BUILD_RUSTFLAGS
+ARG CARGO_PROFILE_TEST_DEBUG
+ARG CARGO_PROFILE_TEST_INCREMENTAL
+ARG CARGO_PROFILE_BENCH_DEBUG
+ARG CARGO_PROFILE_BENCH_LTO
+ARG CARGO_PROFILE_RELEASE_LTO
+ARG CARGO_PROFILE_RELEASE_DEBUGINFO_DEBUG
+ARG CARGO_PROFILE_RELEASE_DEBUGINFO_LTO
+ARG cargo_profile
+ARG cargo_features
+ARG cargo_spec_features
+ARG cargo_cmd
+ARG color_args="--color always"
+ARG recipe_args=""
+ARG cargo_args=""
+ARG git_checkout
+ARG targ_dir="${CARGO_TARGET_DIR}/${cargo_target_profile}"
+ARG targ_targ_dir="${CARGO_TARGET_DIR}/${rust_target}/${cargo_target_profile}"
+
+WORKDIR /
+COPY --link --from=input . .
+COPY --link --from=rust ${RUST_HOME} ${RUST_HOME}
+COPY --link --from=deps /usr/src/tuwunel /usr/src/tuwunel
+
+WORKDIR /usr/lib/${sys_triple}
+COPY --link --from=rocksdb . .
+
+WORKDIR /usr/src/tuwunel
+SHELL ["/bin/bash", "-c"]
+ENV PATH="${CARGO_HOME}/bin:$PATH"
+ENV CARGO_TERM_VERBOSE="${CARGO_TERM_VERBOSE}"
+ENV RUST_BACKTRACE="${RUST_BACKTRACE}"
+ENV JEMALLOC_OVERRIDE="${JEMALLOC_OVERRIDE}"
+ENV ROCKSDB_LIB_DIR="${ROCKSDB_LIB_DIR}"
+ENV VALGRINDFLAGS="${VALGRINDFLAGS}"
+ENV CARGO_PROFILE_TEST_DEBUG="${CARGO_PROFILE_TEST_DEBUG}"
+ENV CARGO_PROFILE_TEST_INCREMENTAL="${CARGO_PROFILE_TEST_INCREMENTAL}"
+ENV CARGO_PROFILE_BENCH_DEBUG="${CARGO_PROFILE_BENCH_DEBUG}"
+ENV CARGO_PROFILE_BENCH_LTO="${CARGO_PROFILE_BENCH_LTO}"
+ENV CARGO_PROFILE_RELEASE_LTO="${CARGO_PROFILE_RELEASE_LTO}"
+ENV CARGO_PROFILE_RELEASE_DEBUGINFO_DEBUG="${CARGO_PROFILE_RELEASE_DEBUGINFO_DEBUG}"
+ENV CARGO_PROFILE_RELEASE_DEBUGINFO_LTO="${CARGO_PROFILE_RELEASE_DEBUGINFO_LTO}"
+ENV CARGO_BUILD_RUSTFLAGS="${CARGO_BUILD_RUSTFLAGS}"
+ENV CARGO_TARGET_DIR="${CARGO_TARGET_DIR}"
+RUN \
+--mount=type=cache,dst=${RUSTUP_HOME}/downloads,sharing=shared \
+--mount=type=cache,dst=${CARGO_HOME}/registry,sharing=shared \
+--mount=type=cache,dst=${CARGO_HOME}/git,sharing=shared \
+--mount=type=cache,dst=${targ_dir}/deps,id=${cargo_share}/deps,sharing=locked \
+--mount=type=cache,dst=${targ_dir}/build,id=${cargo_share}/build,sharing=locked \
+--mount=type=cache,dst=${targ_dir}/examples,id=${cargo_share}/examples,sharing=locked \
+--mount=type=cache,dst=${targ_dir}/incremental,id=${cargo_share}/incremental,sharing=locked \
+--mount=type=cache,dst=${targ_dir}/.fingerprint,id=${cargo_share}/fingerprint,sharing=locked \
+--mount=type=cache,dst=${targ_targ_dir}/deps,id=${cargo_target_share}/deps,sharing=locked \
+--mount=type=cache,dst=${targ_targ_dir}/build,id=${cargo_target_share}/build,sharing=locked \
+--mount=type=cache,dst=${targ_targ_dir}/examples,id=${cargo_target_share}/examples,sharing=locked \
+--mount=type=cache,dst=${targ_targ_dir}/incremental,id=${cargo_target_share}/incremental,sharing=locked \
+--mount=type=cache,dst=${targ_targ_dir}/.fingerprint,id=${cargo_target_share}/fingerprint,sharing=locked \
+<<EOF
+    set -eux
+    ulimit -n 65535
+
+    rustup run "${rust_toolchain}" \
+        cargo ${cargo_cmd} \
+            --verbose \
+            --locked \
+            --workspace \
+            "${cargo_spec_features}" \
+            "--features=${cargo_features}" \
+            "--profile=${cargo_profile}" \
+            "--target=${CARGO_TARGET}" \
+            "--target-dir=${CARGO_TARGET_DIR}" \
+            "--manifest-path=Cargo.toml" \
+            ${recipe_args} \
+            ${color_args} \
+            ${cargo_args}
+
+    # If this image is further reused with other cargo commands, all
+    # modifications made by cargo chef cook outside of target-dir have to be
+    # cleared. If not, resulting build artifacts will link incorrectly, even
+    # without error. For example, a target executable may be produced which
+    # does nothing except exit(0). If you have observed a smoketest failing in
+    # such a manner, investigate this as a cause of the issue.
+    git restore -W -S --source=${git_checkout} .
+EOF

docker/Dockerfile.cargo.audit

@@ -0,0 +1,28 @@
+# syntax = docker/dockerfile:1.11-labs
+
+FROM input AS audit
+ARG rust_toolchain="nightly"
+ARG RUSTUP_HOME
+ARG CARGO_HOME
+ARG audit_args=""
+
+WORKDIR /
+COPY --link --from=input . .
+
+WORKDIR /usr/src/tuwunel
+RUN \
+--mount=type=cache,dst=${RUSTUP_HOME}/downloads,sharing=shared \
+--mount=type=cache,dst=${CARGO_HOME}/registry,sharing=shared \
+--mount=type=cache,dst=${CARGO_HOME}/git,sharing=shared \
+<<EOF
+    set -eux
+    rustup run ${rust_toolchain} \
+        cargo audit \
+            --stale \
+            --deny yanked \
+            --deny unsound \
+            --deny unmaintained \
+            --deny warnings \
+            --color=always \
+            ${audit_args}
+EOF

docker/Dockerfile.cargo.deb

@@ -0,0 +1,83 @@
+# syntax = docker/dockerfile:1.11-labs
+
+FROM input AS build-deb
+ARG rust_target
+ARG rust_toolchain
+ARG RUSTUP_HOME
+ARG CARGO_HOME
+ARG CARGO_TARGET
+ARG CARGO_TARGET_DIR
+ARG cargo_target_profile
+ARG cargo_target_artifact
+ARG cargo_target_share
+ARG cargo_share
+ARG cargo_profile
+ARG cargo_features
+ARG cargo_spec_features
+ARG targ_dir="${CARGO_TARGET_DIR}/${cargo_target_profile}"
+ARG targ_targ_dir="${CARGO_TARGET_DIR}/${rust_target}/${cargo_target_profile}"
+ARG pkg_dir
+ARG deb_args=""
+
+WORKDIR /
+COPY --link --from=input . .
+
+WORKDIR /usr/src/tuwunel
+RUN \
+--mount=type=cache,dst=${RUSTUP_HOME}/downloads,sharing=shared \
+--mount=type=cache,dst=${CARGO_HOME}/registry,sharing=shared \
+--mount=type=cache,dst=${CARGO_HOME}/git,sharing=shared \
+--mount=type=cache,dst=${targ_dir}/deps,id=${cargo_share}/deps,sharing=locked \
+--mount=type=cache,dst=${targ_dir}/build,id=${cargo_share}/build,sharing=locked \
+--mount=type=cache,dst=${targ_dir}/examples,id=${cargo_share}/examples,sharing=locked \
+--mount=type=cache,dst=${targ_dir}/incremental,id=${cargo_share}/incremental,sharing=locked \
+--mount=type=cache,dst=${targ_dir}/.fingerprint,id=${cargo_share}/fingerprint,sharing=locked \
+--mount=type=cache,dst=${targ_targ_dir}/deps,id=${cargo_target_share}/deps,sharing=locked \
+--mount=type=cache,dst=${targ_targ_dir}/build,id=${cargo_target_share}/build,sharing=locked \
+--mount=type=cache,dst=${targ_targ_dir}/examples,id=${cargo_target_share}/examples,sharing=locked \
+--mount=type=cache,dst=${targ_targ_dir}/incremental,id=${cargo_target_share}/incremental,sharing=locked \
+--mount=type=cache,dst=${targ_targ_dir}/.fingerprint,id=${cargo_target_share}/fingerprint,sharing=locked \
+<<EOF
+    set -eux
+    mkdir -p "${pkg_dir}"
+    rustup run ${rust_toolchain} \
+        cargo deb \
+            --verbose \
+            --locked \
+            --no-build \
+            "${cargo_spec_features}" \
+            --features "${cargo_features}" \
+            --profile "${cargo_profile}" \
+            --target "${CARGO_TARGET}" \
+            --manifest-path Cargo.toml \
+            --multiarch same \
+            --compress-type gz \
+            --output "${pkg_dir}" \
+            ${deb_args}
+
+	mv ${pkg_dir}/* "${pkg_dir}/tuwunel.deb"
+	dpkg --info "${pkg_dir}/tuwunel.deb"
+	dpkg --contents "${pkg_dir}/tuwunel.deb"
+EOF
+
+
+FROM scratch AS deb
+ARG pkg_dir
+
+COPY --from=input ${pkg_dir}/tuwunel.deb .
+
+
+FROM input AS deb-install
+ARG pkg_dir
+
+WORKDIR /
+COPY --link --from=input . .
+
+WORKDIR ${pkg_dir}
+COPY --from=deb . .
+RUN <<EOF
+	set -eux
+	dpkg --info tuwunel.deb
+	dpkg --contents tuwunel.deb
+	dpkg --install tuwunel.deb
+EOF

docker/Dockerfile.cargo.fmt

@@ -0,0 +1,25 @@
+# syntax = docker/dockerfile:1.11-labs
+
+FROM input AS fmt
+ARG rust_toolchain="nightly"
+ARG RUSTUP_HOME
+ARG CARGO_HOME
+ARG fmt_args=""
+
+WORKDIR /
+COPY --link --from=input . .
+
+WORKDIR /usr/src/tuwunel
+RUN \
+--mount=type=cache,dst=${RUSTUP_HOME}/downloads,sharing=shared \
+--mount=type=cache,dst=${CARGO_HOME}/registry,sharing=shared \
+--mount=type=cache,dst=${CARGO_HOME}/git,sharing=shared \
+<<EOF
+    set -eux
+    rustup run ${rust_toolchain} \
+        cargo fmt \
+            --all \
+            --check \
+            --manifest-path Cargo.toml \
+            ${fmt_args}
+EOF

docker/Dockerfile.cargo.lychee

@@ -0,0 +1,36 @@
+# syntax = docker/dockerfile:1.11-labs
+
+FROM input AS lychee
+ARG rust_toolchain="nightly"
+ARG RUSTUP_HOME
+ARG CARGO_HOME
+ARG lychee_cache_age="7d"
+ARG lychee_mode="color"
+# .lycheecache is hardcoded as path to reg file in the cwd so we execute lychee
+# in cache directory itself. all paths here should be absolute paths
+ARG lychee_args="/usr/src/tuwunel/docs /usr/src/tuwunel/*.md"
+
+WORKDIR /
+COPY --link --from=input . .
+
+WORKDIR /usr/src/
+RUN \
+--mount=type=cache,dst=${RUSTUP_HOME}/downloads,sharing=shared \
+--mount=type=cache,dst=${CARGO_HOME}/registry,sharing=shared \
+--mount=type=cache,dst=${CARGO_HOME}/git,sharing=shared \
+--mount=type=cache,dst=lychee,sharing=locked \
+<<EOF
+    set -eux
+    cd lychee
+    rustup run ${rust_toolchain} \
+        lychee \
+            --verbose \
+            --no-progress \
+            --offline \
+            --cache \
+            --max-cache-age "${lychee_cache_age}" \
+            --mode "${lychee_mode}" \
+            --exclude /usr/src/tuwunel/contributing.md \
+            --exclude /usr/src/tuwunel/development/testing.md \
+            ${lychee_args}
+EOF

docker/Dockerfile.cargo.rpm

@@ -0,0 +1,76 @@
+# syntax = docker/dockerfile:1.11-labs
+
+FROM input AS build-rpm
+ARG rust_target
+ARG rust_toolchain
+ARG RUSTUP_HOME
+ARG CARGO_HOME
+ARG CARGO_TARGET
+ARG CARGO_TARGET_DIR
+ARG cargo_target_profile
+ARG cargo_target_artifact
+ARG cargo_target_share
+ARG cargo_share
+ARG cargo_profile
+ARG cargo_features
+ARG cargo_spec_features
+ARG targ_dir="${CARGO_TARGET_DIR}/${cargo_target_profile}"
+ARG targ_targ_dir="${CARGO_TARGET_DIR}/${rust_target}/${cargo_target_profile}"
+ARG pkg_dir
+ARG gen_rpm_args=""
+
+WORKDIR /
+COPY --link --from=input . .
+
+WORKDIR /usr/src/tuwunel
+RUN \
+--mount=type=cache,dst=${RUSTUP_HOME}/downloads,sharing=shared \
+--mount=type=cache,dst=${CARGO_HOME}/registry,sharing=shared \
+--mount=type=cache,dst=${CARGO_HOME}/git,sharing=shared \
+--mount=type=cache,dst=${targ_dir}/deps,id=${cargo_share}/deps,sharing=locked \
+--mount=type=cache,dst=${targ_dir}/build,id=${cargo_share}/build,sharing=locked \
+--mount=type=cache,dst=${targ_dir}/examples,id=${cargo_share}/examples,sharing=locked \
+--mount=type=cache,dst=${targ_dir}/incremental,id=${cargo_share}/incremental,sharing=locked \
+--mount=type=cache,dst=${targ_dir}/.fingerprint,id=${cargo_share}/fingerprint,sharing=locked \
+--mount=type=cache,dst=${targ_targ_dir}/deps,id=${cargo_target_share}/deps,sharing=locked \
+--mount=type=cache,dst=${targ_targ_dir}/build,id=${cargo_target_share}/build,sharing=locked \
+--mount=type=cache,dst=${targ_targ_dir}/examples,id=${cargo_target_share}/examples,sharing=locked \
+--mount=type=cache,dst=${targ_targ_dir}/incremental,id=${cargo_target_share}/incremental,sharing=locked \
+--mount=type=cache,dst=${targ_targ_dir}/.fingerprint,id=${cargo_target_share}/fingerprint,sharing=locked \
+<<EOF
+	set -eux
+	mkdir -p "${pkg_dir}"
+	rustup run ${rust_toolchain} \
+		cargo generate-rpm \
+			--package src/main \
+			--auto-req auto \
+			--target "${CARGO_TARGET}" \
+			--target-dir "${CARGO_TARGET_DIR}" \
+			--profile "${cargo_profile}" \
+			--payload-compress zstd \
+			--output "${pkg_dir}" \
+			${gen_rpm_args}
+
+	mv ${pkg_dir}/* "${pkg_dir}/tuwunel.rpm"
+EOF
+
+
+FROM scratch AS rpm
+ARG pkg_dir
+
+COPY --from=input ${pkg_dir}/tuwunel.rpm .
+
+
+FROM input AS rpm-install
+ARG pkg_dir
+
+WORKDIR /
+COPY --link --from=input . .
+
+WORKDIR ${pkg_dir}
+COPY --link --from=rpm . .
+RUN <<EOF
+	set -eux
+	rpm -i --test tuwunel.rpm
+	rpm -i tuwunel.rpm
+EOF

docker/Dockerfile.cargo.typos

@@ -0,0 +1,25 @@
+# syntax = docker/dockerfile:1.11-labs
+
+FROM input AS typos
+ARG rust_toolchain="nightly"
+ARG RUSTUP_HOME
+ARG CARGO_HOME
+ARG typos_args=""
+
+WORKDIR /
+COPY --link --from=input . .
+
+WORKDIR /usr/src/tuwunel
+RUN \
+--mount=type=cache,dst=${RUSTUP_HOME}/downloads,sharing=shared \
+--mount=type=cache,dst=${CARGO_HOME}/registry,sharing=shared \
+--mount=type=cache,dst=${CARGO_HOME}/git,sharing=shared \
+<<EOF
+    set -eux
+    rustup run ${rust_toolchain} \
+        typos \
+            --color always \
+            --exclude docker \
+            --exclude nix \
+            ${typos_args}
+EOF

docker/Dockerfile.complement

@@ -0,0 +1,210 @@
+# syntax = docker/dockerfile:1.11-labs
+
+FROM input AS key-gen
+
+WORKDIR /complement
+COPY <<EOF v3.ext
+    authorityKeyIdentifier=keyid,issuer
+    basicConstraints=CA:FALSE
+    keyUsage = digitalSignature, nonRepudiation, keyEncipherment, dataEncipherment
+    subjectAltName = @alt_names
+    [alt_names]
+    DNS.0 = *.docker.internal
+    DNS.1 = hs1
+    DNS.2 = hs2
+    DNS.3 = hs3
+    DNS.4 = hs4
+    IP.1 = 127.0.0.1
+EOF
+RUN <<EOF
+    set -eux
+    mkdir ca
+    openssl genrsa \
+        -out private_key.pem \
+        2048
+
+    openssl req \
+        -new \
+        -sha256 \
+        -key private_key.pem \
+        -subj "/C=US/ST=CA/O=MyOrg, Inc./CN=hs1" \
+        -addext "subjectAltName = DNS:*.docker.internal DNS:hs1, DNS:hs2, DNS:hs3, DNS:hs4, IP:127.0.0.1" \
+        -out signing_request.csr
+
+    openssl x509 \
+        -req \
+        -extfile v3.ext \
+        -in signing_request.csr \
+        -key private_key.pem \
+        -out certificate.crt \
+        -days 1 \
+        -sha256
+EOF
+RUN [ -f certificate.crt ] && [ -f private_key.pem ]
+
+
+FROM scratch AS complement-config
+WORKDIR /complement
+COPY --from=key-gen /complement/* .
+COPY --from=source /usr/src/tuwunel/tests/complement/results.jsonl old_results.jsonl
+COPY <<EOF complement.toml
+    [global]
+    address = "0.0.0.0"
+    admin_room_notices = false
+    allow_device_name_federation = true
+    allow_guest_registration = true
+    allow_invalid_tls_certificates = true
+    allow_legacy_media = true
+    allow_public_room_directory_over_federation = true
+    allow_public_room_directory_without_auth = true
+    allow_registration = true
+    create_admin_room = false
+    database_path = "/database"
+    dns_attempts = 20
+    dns_timeout = 60
+    federation_idle_timeout = 300
+    intentionally_unknown_config_option_for_testing = true
+    ip_range_denylist = []
+    log = "debug,tuwunel=trace,h2=warn,hyper=warn"
+    log_colors = false
+    log_guest_registrations = false
+    log_span_events = "NONE"
+    log_thread_ids = true
+    media_compat_file_link = false
+    media_startup_check = true
+    port = [8008, 8448]
+    prune_missing_media = true
+    query_trusted_key_servers_first = false
+    query_trusted_key_servers_first_on_join = false
+    request_conn_timeout = 60
+    request_timeout = 120
+    rocksdb_log_level = "debug"
+    rocksdb_max_log_files = 1
+    rocksdb_paranoid_file_checks = true
+    rocksdb_recovery_mode = 0
+    sender_idle_timeout = 300
+    sender_retry_backoff_limit = 300
+    sender_timeout = 300
+    startup_netburst = true
+    startup_netburst_keep = -1
+    trusted_servers = []
+    url_preview_domain_contains_allowlist = ["*"]
+    url_preview_domain_explicit_denylist = ["*"]
+    well_known_conn_timeout = 60
+    well_known_timeout = 60
+    yes_i_am_very_very_sure_i_want_an_open_registration_server_prone_to_abuse = true
+
+    [global.tls]
+    certs = "/complement/certificate.crt"
+    dual_protocol = true
+    key = "/complement/private_key.pem"
+EOF
+
+
+FROM input AS complement-testee
+
+EXPOSE 8008 8448
+RUN mkdir /database
+COPY --from=complement-config * /complement/
+ENV TUWUNEL_CONFIG="/complement/complement.toml"
+ENTRYPOINT tuwunel -Oserver_name=\""$SERVER_NAME\""
+
+
+FROM input AS complement-testee-valgrind
+
+EXPOSE 8008 8448
+RUN mkdir /database
+COPY --from=complement-config * /complement/
+ENV TUWUNEL_CONFIG="/complement/complement.toml"
+ENTRYPOINT valgrind \
+    --leak-check=no \
+    --undef-value-errors=no \
+    --exit-on-first-error=yes \
+    --error-exitcode=1 \
+    tuwunel \
+        -Oserver_name=\""$SERVER_NAME\""
+
+
+FROM input AS complement-base
+ARG var_cache
+ARG var_lib_apt
+ARG complement_ref="4d3130f06d0dc3f794b5d48fbdba0b466792b52b"
+ARG complement_tags="conduwuit_blacklist"
+ARG complement_tests="./tests/..."
+ARG complement_run=".*"
+
+WORKDIR /usr/src
+ADD https://github.com/matrix-construct/complement.git#${complement_ref} complement
+
+WORKDIR /usr/src/complement
+ENV COMPLEMENT_BASE_IMAGE="complement-testee"
+RUN \
+--mount=type=cache,dst=/go/pkg/mod/cache,sharing=locked \
+<<EOF
+    env
+    set -eux
+    go test -tags="$complement_tags" -list="$complement_run" $complement_tests
+EOF
+
+
+FROM input AS complement-tester
+ARG complement_verbose=0
+ARG complement_debug=0
+ARG complement_dirty=0
+ARG complement_count=1
+ARG complement_parallel=1
+ARG complement_shuffle=1337
+ARG complement_timeout="1h"
+ARG complement_run=".*"
+ARG complement_skip=""
+ARG complement_tags="conduwuit_blacklist"
+ARG complement_tests="./tests/..."
+ARG complement_base_image
+
+WORKDIR /usr/src/complement
+ENV COMPLEMENT_DEBUG=$complement_debug
+ENV complement_parallel="$complement_parallel"
+ENV complement_shuffle="$complement_shuffle"
+ENV complement_tags="$complement_tags"
+ENV complement_timeout="$complement_timeout"
+ENV complement_count="$complement_count"
+ENV complement_tests="$complement_tests"
+ENV complement_skip="$complement_skip"
+ENV complement_run="$complement_run"
+ENV complement_tests="$complement_tests"
+ENV COMPLEMENT_ENABLE_DIRTY_RUNS="$complement_dirty"
+ENV COMPLEMENT_ALWAYS_PRINT_SERVER_LOGS="$complement_verbose"
+ENV COMPLEMENT_HOSTNAME_RUNNING_COMPLEMENT="host.docker.internal"
+ENV COMPLEMENT_HOST_MOUNTS="/var/run/docker.sock:/var/run/docker.sock"
+ENV jq_res='{Action: .Action, Test: .Test}'
+ENV jq_sel='select((.Action == \"pass\" or .Action == \"fail\" or .Action == \"skip\") and .Test != null)'
+ENV jq_tab='[.Action, .Test] | @tsv'
+ENV jq_out='select(.Test != null) | {Test: .Test, Output: .Output}'
+COPY --from=complement-config /complement/old_results.jsonl .
+COPY <<EOF uwu.sh
+    env;
+    set -eux;
+
+    COMPLEMENT_BASE_IMAGE="\${1:-$complement_base_image}"
+    go test
+        -json
+        "-shuffle=\$complement_shuffle"
+        "-parallel=\$complement_parallel"
+        "-timeout=\$complement_timeout"
+        "-count=\$complement_count"
+        "-tags=\$complement_tags"
+        "-skip=\$complement_skip"
+        "-run=\$complement_run"
+        "\$complement_tests"
+    | jq --unbuffered -c "."
+    | tee output.jsonl
+    | jq --unbuffered -c "$jq_sel | $jq_res"
+    | tee results.jsonl
+    | jq --unbuffered -r "$jq_tab"
+    ;
+
+    jq -s -c "sort_by(.Test)[]" < results.jsonl | uniq > new_results.jsonl;
+    jq -s -c "sort_by(.Test, .Timestamp)[] | $jq_out" < output.jsonl > full_output.jsonl;
+EOF
+RUN echo $(tr -d '\n' < uwu.sh) > uwu.sh && chmod a+x uwu.sh
+ENTRYPOINT ["/bin/bash", "/usr/src/complement/uwu.sh"]

docker/Dockerfile.install

@@ -0,0 +1,31 @@
+# syntax = docker/dockerfile:1.11-labs
+
+FROM input AS install
+ARG rust_target
+ARG CARGO_TARGET_DIR
+ARG cargo_target_profile
+ARG install_prefix
+ARG assert_linkage=""
+
+WORKDIR /
+COPY --link --from=input . .
+
+WORKDIR ${install_prefix}
+ENV src_path="${CARGO_TARGET_DIR}/${rust_target}/${cargo_target_profile}/tuwunel"
+ENV dst_path="${install_prefix}/bin/tuwunel"
+COPY --from=bins $src_path $dst_path
+RUN <<EOF
+    ldd -v "${dst_path}"
+    ret=$?
+    if [ "$ret" = "0" ] && [ "$assert_linkage" = "static" ]; then
+        echo "($ret) expected a static binary"
+        exit 1
+    elif [ "$ret" != "0" ] && [ "$assert_linkage" = "dynamic" ]; then
+        echo "($ret) expected a dynamic binary"
+        exit 1
+    fi
+
+    set -eux
+    du -h "${dst_path}"
+    sha1sum "${dst_path}"
+EOF

docker/Dockerfile.matrix-rust-sdk

@@ -0,0 +1,100 @@
+# syntax = docker/dockerfile:1.11-labs
+
+FROM input AS rust-sdk-integration
+ARG sys_name
+ARG sys_version
+ARG feat_set
+ARG rust_target
+ARG rust_toolchain
+ARG cargo_profile
+ARG RUSTUP_HOME
+ARG CARGO_HOME
+ARG CARGO_TARGET
+ARG MRSDK_TARGET_DIR="/usr/src/matrix-rust-sdk/target"
+ARG mrsdk_target_share
+#ARG mrsdk_ref="integration"
+ARG mrsdk_ref="tuwunel-changes"
+ARG mrsdk_test_args=""
+ARG mrsdk_test_opts=""
+ARG mrsdk_skip_list=""
+ARG mrsdk_parallel=2
+ARG mrsdk_startup_delay="10s"
+ARG mrsdk_testee="/usr/bin/tuwunel"
+
+WORKDIR /usr/src
+ADD --link https://github.com/matrix-construct/matrix-rust-sdk.git#${mrsdk_ref} matrix-rust-sdk
+
+WORKDIR /etc
+COPY <<EOF tuwunel.toml
+    [global]
+    admin_room_notices = false
+    allow_device_name_federation = true
+    allow_guest_registration = true
+    allow_legacy_media = true
+    allow_public_room_directory_over_federation = true
+    allow_public_room_directory_without_auth = true
+    allow_registration = true
+    create_admin_room = false
+    ip_range_denylist = []
+    log = "debug,tuwunel=trace,h2=warn,hyper=warn"
+    log_colors = false
+    log_guest_registrations = false
+    log_span_events = "NONE"
+    log_thread_ids = true
+    media_compat_file_link = false
+    media_startup_check = true
+    query_trusted_key_servers_first = false
+    query_trusted_key_servers_first_on_join = false
+    rocksdb_log_level = "debug"
+    rocksdb_max_log_files = 1
+    rocksdb_paranoid_file_checks = true
+    rocksdb_recovery_mode = 0
+    trusted_servers = []
+    url_preview_domain_contains_allowlist = ["*"]
+    url_preview_domain_explicit_denylist = ["*"]
+    yes_i_am_very_very_sure_i_want_an_open_registration_server_prone_to_abuse = true
+EOF
+
+WORKDIR /usr/lib
+COPY --link --from=install /usr/lib .
+
+WORKDIR /usr/bin
+COPY --link --from=install /usr/bin/tuwunel .
+
+WORKDIR /usr/src/matrix-rust-sdk
+SHELL ["/bin/bash", "-c"]
+ENV RUST_BACKTRACE="full"
+ENV TUWUNEL_CONFIG="/etc/tuwunel.toml"
+ENV TUWUNEL_DATABASE_PATH="/var/db/tuwunel"
+ENV TUWUNEL_SERVER_NAME="localhost"
+ENV TUWUNEL_PORT="[8448]"
+ENV HOMESERVER_URL="http://localhost:8448"
+RUN \
+--mount=type=cache,dst=${RUSTUP_HOME}/downloads,sharing=shared \
+--mount=type=cache,dst=${CARGO_HOME}/registry,sharing=shared \
+--mount=type=cache,dst=${CARGO_HOME}/git,sharing=shared \
+--mount=type=cache,dst=${MRSDK_TARGET_DIR},id=${mrsdk_target_share},sharing=locked \
+<<EOF
+    set -eux
+
+    nohup ${mrsdk_testee[@]} 1> /var/log/tuwunel.log &
+    PID=$!; trap "sleep 10s; set +e; kill -QUIT ${PID}; wait ${PID}" EXIT
+    sleep "${mrsdk_startup_delay}"
+
+    rustup run ${rust_toolchain} \
+        cargo test \
+            --locked \
+            --release \
+            "--color=always" \
+            "--features=default" \
+            "--target=${rust_target}" \
+            "--target-dir=${MRSDK_TARGET_DIR}" \
+            "--package=matrix-sdk-integration-testing" \
+            ${mrsdk_test_args[@]} \
+            -- \
+            "--color=always" \
+            "--test-threads=${mrsdk_parallel}" \
+            ${mrsdk_skip_list[@]} \
+            ${mrsdk_test_opts[@]} \
+            ;
+EOF

docker/Dockerfile.nix

@@ -0,0 +1,91 @@
+# syntax = docker/dockerfile:1.11-labs
+
+FROM input AS nix-base
+
+WORKDIR /
+COPY --link --from=input . .
+
+RUN \
+--mount=type=cache,dst=/nix,sharing=shared \
+--mount=type=cache,dst=/root/.cache/nix,sharing=shared \
+--mount=type=cache,dst=/root/.local/state/nix,sharing=shared \
+<<EOF
+	set -eux
+	curl --proto '=https' --tlsv1.2 -L https://nixos.org/nix/install > nix-install
+	sh ./nix-install --daemon
+	rm nix-install
+EOF
+
+
+FROM nix-base AS build-nix
+
+WORKDIR /usr/src/tuwunel
+COPY --link --from=source /usr/src/tuwunel .
+RUN \
+--mount=type=cache,dst=/nix,sharing=shared \
+--mount=type=cache,dst=/root/.cache/nix,sharing=shared \
+--mount=type=cache,dst=/root/.local/state/nix,sharing=shared \
+<<EOF
+	set -eux
+
+	nix-build \
+		--verbose \
+		--cores 0 \
+		--max-jobs $(nproc) \
+		--log-format raw \
+		.
+
+	cp -afRL --copy-contents result /opt/tuwunel
+EOF
+
+
+FROM input AS smoke-nix
+
+WORKDIR /
+COPY --link --from=nix-base . .
+
+WORKDIR /usr/src/tuwunel
+COPY --link --from=source /usr/src/tuwunel .
+ENV TUWUNEL_DATABASE_PATH="/tmp/tuwunel/smoketest.db"
+ENV TUWUNEL_LOG="info"
+RUN \
+--mount=type=cache,dst=/nix,sharing=shared \
+--mount=type=cache,dst=/root/.cache/nix,sharing=shared \
+--mount=type=cache,dst=/root/.local/state/nix,sharing=shared \
+<<EOF
+    set -eux
+    alias nix="nix --extra-experimental-features nix-command --extra-experimental-features flakes"
+
+    nix run \
+        --verbose \
+        --cores 0 \
+        --max-jobs $(nproc) \
+        --log-format raw \
+        .#all-features \
+            -- \
+            -Otest='["smoke", "fresh"]' \
+            -Oserver_name=\"localhost\" \
+EOF
+
+
+FROM input AS nix-pkg
+
+WORKDIR /
+COPY --link --from=nix-base . .
+
+WORKDIR /usr/src/tuwunel
+COPY --link --from=source /usr/src/tuwunel .
+RUN \
+--mount=type=cache,dst=/nix,sharing=shared \
+--mount=type=cache,dst=/root/.cache/nix,sharing=shared \
+--mount=type=cache,dst=/root/.local/state/nix,sharing=shared \
+<<EOF
+    set -eux
+    alias nix="nix --extra-experimental-features nix-command --extra-experimental-features flakes"
+
+    ID=$(nix-store --realise $(nix path-info --derivation))
+
+    mkdir -p tuwunel
+    nix-store --export $ID > tuwunel/tuwunel.drv
+    tar -cvf /opt/tuwunel.nix.tar tuwunel
+EOF

docker/Dockerfile.rocksdb

@@ -0,0 +1,96 @@
+# syntax = docker/dockerfile:1.11-labs
+
+FROM input AS rocksdb-fetch
+ARG rocksdb_branch="tuwunel-changes"
+ARG rust_rocksdb_branch="conduwuit-changes"
+ARG librocksdb_submodule="librocksdb-sys/rocksdb"
+
+WORKDIR /
+COPY --link --from=input . .
+
+WORKDIR /usr/src
+COPY --link --from=recipe rocksdb.url .
+
+RUN <<EOF
+    set -eux
+    rocksdb_url="$(cat rocksdb.url)"
+    git clone \
+        --depth 1 \
+        --single-branch \
+        --branch "${rust_rocksdb_branch}" \
+        "--recurse-submodules=${librocksdb_submodule}" \
+        "${rocksdb_url}" \
+        /usr/src/rocksdb
+EOF
+
+
+FROM input AS rocksdb-build
+ARG rocksdb_shared=0
+ARG rocksdb_portable="1"
+ARG rocksdb_opt_level="3"
+ARG rocksdb_lto="-flto -ffat-lto-objects"
+ARG rocksdb_build_type="Release"
+ARG rocksdb_cxx_flags="-ftls-model=initial-exec"
+ARG rocksdb_make_verbose="ON"
+ARG rocksdb_make_rule_messages="OFF"
+ARG rocksdb_numa=0
+ARG rocksdb_jemalloc=1
+ARG rocksdb_iouring=1
+ARG rocksdb_zstd=1
+ARG rocksdb_lz4=0
+ARG rocksdb_bz2=0
+ARG rocksdb_zlib=0
+ARG rocksdb_snappy=0
+ARG nprocs
+
+WORKDIR /
+COPY --link --from=input . .
+COPY --link --from=rocksdb-fetch /usr/src/rocksdb /usr/src/rocksdb
+
+WORKDIR /usr/src/rocksdb/librocksdb-sys/rocksdb
+ENV CC="clang"
+ENV CXX="clang++"
+ENV nprocs=${nprocs}
+RUN <<EOF
+    set -eux
+
+    cmake -H. -Bbuild \
+        "-DCMAKE_RULE_MESSAGES:BOOL=${rocksdb_make_rule_messages}" \
+        "-DCMAKE_VERBOSE_MAKEFILE:BOOL=${rocksdb_make_verbose}" \
+        "-DCMAKE_BUILD_TYPE=${rocksdb_build_type}" \
+        "-DBUILD_SHARED_LIBS=${rocksdb_shared}" \
+        "-DROCKSDB_BUILD_SHARED=${rocksdb_shared}" \
+        "-DCMAKE_CXX_FLAGS:STRING=${rocksdb_cxx_flags}" \
+        "-DCMAKE_CXX_FLAGS_RELEASE:STRING=-g0 -O${rocksdb_opt_level} -DNDEBUG ${rocksdb_lto}" \
+        "-DPORTABLE=${rocksdb_portable}" \
+        "-DFAIL_ON_WARNINGS=0" \
+        "-DUSE_RTTI=0" \
+        "-DWITH_RUNTIME_DEBUG=0" \
+        "-DWITH_JNI=0" \
+        "-DWITH_EXAMPLES=0" \
+        "-DWITH_BENCHMARK=0" \
+        "-DWITH_BENCHMARK_TOOLS=0" \
+        "-DWITH_TRACE_TOOLS=0" \
+        "-DWITH_CORE_TOOLS=0" \
+        "-DWITH_TOOLS=0" \
+        "-DWITH_TESTS=0" \
+        "-DWITH_GFLAGS=0" \
+        "-DWITH_NUMA=${rocksdb_numa}" \
+        "-DWITH_LIBURING=${rocksdb_iouring}" \
+        "-DWITH_JEMALLOC=${rocksdb_jemalloc}" \
+        "-DWITH_ZSTD=${rocksdb_zstd}" \
+        "-DWITH_LZ4=${rocksdb_lz4}" \
+        "-DWITH_BZ2=${rocksdb_bz2}" \
+        "-DWITH_ZLIB=${rocksdb_zlib}" \
+        "-DWITH_SNAPPY=${rocksdb_snappy}"
+
+    nprocs=${nprocs:=$(nproc)}
+    cmake \
+        --build build \
+        --target install \
+        --parallel "${nprocs}"
+EOF
+
+
+FROM scratch AS rocksdb
+COPY --from=input /usr/src/rocksdb/librocksdb-sys/rocksdb/build/librocksdb.* .

docker/Dockerfile.rust

@@ -0,0 +1,66 @@
+# syntax = docker/dockerfile:1.11-labs
+
+FROM input AS rustup
+ARG RUST_HOME
+ARG rust_target
+ARG rustup_version="1.28.2"
+ARG rustup_profile="minimal"
+
+WORKDIR ${RUST_HOME}
+RUN <<EOF
+    set -eux
+
+    var="${rustup_version}/${rust_target}"
+    url="https://static.rust-lang.org/rustup/archive/$var/rustup-init"
+    curl -S -O -s "$url"
+    chmod a+rx rustup-init
+EOF
+
+FROM input AS rust
+ARG rust_toolchain
+ARG rust_target
+ARG RUST_HOME
+ARG RUSTUP_HOME
+ARG CARGO_HOME
+ARG CARGO_TARGET
+ARG rustup_version="1.28.1"
+ARG rustup_profile="minimal"
+ARG CARGO_TERM_VERBOSE
+ARG rustup_components
+ARG cargo_installs
+
+WORKDIR ${RUST_HOME}
+ENV CARGO_TARGET="${rust_target}"
+ENV RUSTUP_HOME="${RUSTUP_HOME}"
+ENV CARGO_HOME="${CARGO_HOME}"
+ENV PATH="${CARGO_HOME}/bin:$PATH"
+RUN \
+--mount=type=cache,dst=${RUSTUP_HOME}/downloads,sharing=locked \
+--mount=type=cache,dst=${CARGO_HOME}/registry,sharing=locked \
+--mount=type=cache,dst=${CARGO_HOME}/git,sharing=locked \
+<<EOF
+    set -eux
+    ./rustup-init -y \
+        --quiet \
+        --profile "${rustup_profile}" \
+        --default-host "${CARGO_TARGET}" \
+        --default-toolchain "${rust_toolchain}" \
+        --no-update-default-toolchain \
+        --no-modify-path
+
+    chmod -R a+rw $CARGO_HOME $RUSTUP_HOME
+    rm rustup-init
+
+    rustup component add \
+        --toolchain ${rust_toolchain} \
+        --target ${rust_target} \
+        ${rustup_components} \
+        ;
+
+    rustup run --install ${rust_toolchain} \
+        cargo install \
+            --locked \
+            --target ${rust_target} \
+            ${cargo_installs} \
+            ;
+EOF

docker/Dockerfile.smoketest

@@ -0,0 +1,66 @@
+# syntax = docker/dockerfile:1.11-labs
+
+FROM input AS smoke-version
+COPY --link --from=input . .
+RUN <<EOF
+    set -eux
+    tuwunel -V
+    version=$(tuwunel -V)
+    /bin/test -n "$version"
+EOF
+
+
+FROM input AS smoke-startup
+COPY --link --from=input . .
+ENV TUWUNEL_LOG="info"
+ENV TUWUNEL_DATABASE_PATH="/tmp/smoketest.db"
+RUN <<EOF
+    set -eux
+    tuwunel \
+        -Otest='["smoke"]' \
+        -Oserver_name=\"localhost\" \
+        -Odatabase_path=\"${TUWUNEL_DATABASE_PATH}\"
+
+    rm -rf "${TUWUNEL_DATABASE_PATH}"
+EOF
+
+
+FROM input AS smoke-valgrind
+ARG leak_check="no"
+ARG undef_value_errors="no"
+COPY --link --from=input . .
+ENV TUWUNEL_LOG="info"
+ENV TUWUNEL_DATABASE_PATH="/tmp/smoketest.db"
+RUN <<EOF
+    set -eux
+    ulimit -n 65535
+    valgrind \
+        --leak-check=${leak_check} \
+        --undef-value-errors=${undef_value_errors} \
+        --exit-on-first-error=yes \
+        --error-exitcode=1 \
+        tuwunel \
+            -Otest='["smoke"]' \
+            -Oserver_name=\"localhost\" \
+            -Odatabase_path=\"${TUWUNEL_DATABASE_PATH}\"
+
+    rm -rf "${TUWUNEL_DATABASE_PATH}"
+EOF
+
+
+FROM input AS smoke-perf
+COPY --link --from=input . .
+ENV TUWUNEL_LOG="error"
+ENV TUWUNEL_DATABASE_PATH="/tmp/smoketest.db"
+RUN <<EOF
+    set -eux
+    perf stat \
+        -j \
+        -ddd \
+        tuwunel \
+            -Otest='["smoke"]' \
+            -Oserver_name=\"localhost\" \
+            -Odatabase_path=\"${TUWUNEL_DATABASE_PATH}\"
+
+    rm -rf "${TUWUNEL_DATABASE_PATH}"
+EOF

docker/Dockerfile.source

@@ -0,0 +1,92 @@
+# syntax = docker/dockerfile:1.11-labs
+
+FROM input AS source
+ARG git_checkout
+
+ADD --link --keep-git-dir . /usr/src/tuwunel
+WORKDIR /usr/src/tuwunel
+RUN <<EOF
+    set -eux
+    git reset \
+        --hard \
+        --no-recurse-submodules \
+        ${git_checkout}
+EOF
+
+
+FROM input AS ingredients
+ARG rust_target
+ARG rust_toolchain
+ARG RUST_HOME
+ARG RUSTUP_HOME
+ARG CARGO_HOME
+ARG CARGO_TARGET
+ARG CARGO_TERM_VERBOSE=0
+ARG RUST_BACKTRACE
+ARG JEMALLOC_OVERRIDE
+ARG ROCKSDB_LIB_DIR
+
+WORKDIR /
+COPY --link --from=rust ${RUST_HOME} ${RUST_HOME}
+COPY --link --from=source /usr/src/tuwunel /usr/src/tuwunel
+
+WORKDIR /usr/src/tuwunel
+ENV PATH="${CARGO_HOME}/bin:$PATH"
+ENV CARGO_TERM_VERBOSE="${CARGO_TERM_VERBOSE}"
+ENV RUST_BACKTRACE="${RUST_BACKTRACE}"
+ENV JEMALLOC_OVERRIDE="${JEMALLOC_OVERRIDE}"
+ENV ROCKSDB_LIB_DIR="${ROCKSDB_LIB_DIR}"
+RUN \
+--mount=type=cache,dst=${RUSTUP_HOME}/downloads,sharing=locked \
+--mount=type=cache,dst=${CARGO_HOME}/registry,sharing=locked \
+--mount=type=cache,dst=${CARGO_HOME}/git,sharing=locked \
+<<EOF
+    set -eux
+    git submodule update \
+        --remote \
+        --no-fetch \
+        --recursive \
+        --checkout \
+        --init
+
+    rustup run ${rust_toolchain} \
+        cargo fetch \
+            --locked \
+            --target ${CARGO_TARGET}
+EOF
+
+
+FROM input AS preparing
+ARG rust_target
+ARG rust_toolchain
+ARG RUSTUP_HOME
+ARG CARGO_HOME
+ARG CARGO_TARGET
+
+WORKDIR /usr/src/tuwunel
+RUN \
+--mount=type=cache,dst=${RUSTUP_HOME}/downloads,sharing=locked \
+--mount=type=cache,dst=${CARGO_HOME}/registry,sharing=locked \
+--mount=type=cache,dst=${CARGO_HOME}/git,sharing=locked \
+<<EOF
+    set -euxo pipefail
+    rustup run ${rust_toolchain} \
+        cargo chef prepare \
+            --recipe-path recipe.json
+
+    manifest="Cargo.toml"
+    package="rust-librocksdb-sys"
+    cmd="cargo tree --manifest-path ${manifest} -f {r} -p ${package}"
+    url="$(rustup run ${rust_toolchain} ${cmd} | head -n 1)"
+    url="https://github.com/matrix-construct/rust-rocksdb" #TODO fixme
+    echo "$url" > rocksdb.url
+
+    sha1sum recipe.json rocksdb.url
+EOF
+
+
+FROM scratch AS recipe
+
+WORKDIR /
+COPY --from=preparing /usr/src/tuwunel/recipe.json .
+COPY --from=preparing /usr/src/tuwunel/rocksdb.url .

docker/Dockerfile.system

@@ -0,0 +1,28 @@
+# syntax = docker/dockerfile:1.11-labs
+
+ARG sys_name=debian
+ARG sys_version=testing-slim
+
+FROM ${sys_name}:${sys_version} AS system
+
+
+FROM input AS runtime
+ARG var_cache
+ARG var_lib_apt
+ARG packages
+ARG DEBIAN_FRONTEND
+
+ENV DEBIAN_FRONTEND="${DEBIAN_FRONTEND}"
+RUN \
+--mount=type=cache,dst=/var/cache,id=${var_cache},sharing=locked \
+--mount=type=cache,dst=/var/lib/apt,id=${var_lib_apt},sharing=locked \
+<<EOF
+    echo $(uname -a) $0 $-
+    set -eux
+
+    keep_downloaded='Binary::apt::APT::Keep-Downloaded-Packages "true";'
+    echo "$keep_downloaded" > /etc/apt/apt.conf.d/keep-downloaded
+    rm -f /etc/apt/apt.conf.d/docker-clean
+
+    apt-get -y -U install --no-install-recommends ${packages}
+EOF

docker/README.md

@@ -0,0 +1,106 @@
+# Docker Builder
+
+> [!NOTE]
+> This directory is for building docker images. For [deploying](https://github.com/matrix-construct/tuwunel/tree/main/docs/deploying)
+> [docker](https://github.com/matrix-construct/tuwunel/blob/main/docs/deploying/docker.md) visit
+> the appropriate documentation instead.
+
+All Docker images for the project are built here. All images are
+[Docker Bake](https://docs.docker.com/build/bake/) targets. All targets are leaves and
+branches of a unified tree leading to a single root. It is a combinatorial matrix
+of images from shared intermediate layers with a huge ever-growing pulsating cache.
+
+The result is the ability to run continuous integration for a number of build
+variations while only paying the cost of rebuilding the last layer for each one.
+
+
+### Layout
+
+This directory is made up of three types of files:
+
+- Shell scripts are the user interface. Use this system through one of the shell scripts. The
+bake files can still be docker'ed directly but it's recommended to run the script.
+
+- The `.hcl` files specify the targets of the tree. This is all standard
+[docker bake](https://docs.docker.com/build/bake/reference/). All targets are ordered where each
+depends on one or more below it. The root of the tree is at the bottom. At the time of this
+writing there is only one `bake.hcl` file but this might be broken up; in any case there will
+always be a single unified tree.
+
+- The `Dockerfile.*` files are like "library functions" and provide definition for targets.
+These are written generically in the style of "template functions" with many variables allowing
+many targets to create many variations using the same Dockerfile.
+
+
+### Getting started
+
+1. You will need to install docker buildx/buildkit and maybe a couple other related things.
+
+	`apt-get install docker-buildx`
+
+2. You will need to create a builder. There are a few complications that must be explained here
+so please be patient.
+
+	- Some unsavory options are required for some targets. It might be possible to omit these if
+	you're not building the full tree. Otherwise I've included them in the create command below.
+
+		- To run the complement compliance suite we need the `--allow-insecure-entitlement network.host`.
+		This requirement is probably a defect in Complement.
+
+	- The default cache policies are usually insufficient and custom values should be used,
+	 though the ones below are probably too much for a single or simple build.
+
+	Finally create:
+	
+	```
+	cat <<EOF > ./buildkitd.toml
+		[system]
+		  platformsCacheMaxAge = "504h"
+		[worker.oci]
+		  enabled = true
+		  gc = true
+		  reservedSpace = "64GB"
+		  maxUsedSpace = "128GB"
+		[[worker.oci.gcpolicy]]
+		  reservedSpace = "64GB"
+		  maxUsedSpace = "128GB"
+		  all = true
+	EOF
+
+	BKD_FLAGS="--allow-insecure-entitlement network.host"
+	docker buildx create \
+		--name owo \
+		--bootstrap \
+		--buildkitd-config ./buildkitd.toml \
+		--driver docker-container \
+		--buildkitd-flags "$BKD_FLAGS"
+	```
+
+3. Build something simple. The usage is `./bake.sh [target]` which defaults to building all
+elements for one vector of the full matrix. You can start smaller though by running
+`docker/bake.sh system` which is the root target. You can browse the `bake.hcl` from the bottom
+and progressively build targets, or build one or more leaf targets directly. For example try
+to run a smoketest: `./bake.sh tests-smoke`.
+
+4. Build something more complicated. Set environment variables or just edit the default vectors
+near the top of in the `bake.sh` with multiple elements (they are JSON arrays). You can take
+cues from the primary user of this system, the [GitHub CI](https://github.com/matrix-construct/tuwunel/blob/main/.github/workflows/main.yml#L32)
+
+5. Defeat the final boss by building and running complement to completion. This will involve
+building the targets for `complement-tester` and `complement-testee` using `bake.sh` and then
+invoking `complement.sh`. You can take cues again from another user of this in the
+[GitHub CI](https://github.com/matrix-construct/tuwunel/blob/7e8c4c8883ca17de91c3323d329541342366ee0c/.github/workflows/test.yml#L140).
+
+## Notes
+
+- For CI our builders are more persistent rather than being created and destroyed for
+each invocation. The builder is meant to be safely reused across operations, but
+for concurrent operations this is tricky, see the next point.
+
+- For CI our builders are isolated only by actor/user. This will probably change to
+`actor/repo/branch` as it's easy to cause issues with concurrent builds right now.
+However we can't accept destroying the builder after each use, so we'll likely
+choose `actor/repo/branch` with the expectation of one build at a time under those
+constraints. Some external caching might need to be contrived between builders for
+deduplication but with care such that malicious actors cannot poison data used
+by other actors, otherwise it defeats the purpose of builder isolation.

docker/bake.sh

@@ -0,0 +1,118 @@
+#!/bin/bash
+set -eo pipefail
+
+BASEDIR=$(dirname "$0")
+
+CI="${CI:-false}"
+CI_VERBOSE="${CI_VERBOSE:-false}"
+CI_VERBOSE_ENV="${CI_VERBOSE_ENV:-$CI_VERBOSE}"
+CI_SILENT_BAKE="${CI_SILENT_BAKE:-false}"
+CI_PRINT_BAKE="${CI_PRINT_BAKE:-$CI_VERBOSE}"
+
+default_cargo_profiles='["test"]'
+default_feat_sets='["all"]'
+default_rust_toolchains='["nightly"]'
+default_rust_targets='["x86_64-unknown-linux-gnu"]'
+default_sys_names='["debian"]'
+default_sys_versions='["testing-slim"]'
+default_sys_targets='["x86_64-v1-linux-gnu"]'
+
+if test ! -z "$cargo_profile"; then
+    env_cargo_profiles="[\"${cargo_profile}\"]"
+fi
+
+if test ! -z "$feat_set"; then
+    env_feat_sets="[\"${feat_set}\"]"
+fi
+
+if test ! -z "$rust_target"; then
+    env_rust_targets="[\"${rust_target}\"]"
+fi
+
+if test ! -z "$rust_toolchain"; then
+    env_rust_toolchains="[\"${rust_toolchain}\"]"
+fi
+
+if test ! -z "$sys_name"; then
+    env_sys_names="[\"${sys_name}\"]"
+fi
+
+if test ! -z "$sys_target"; then
+    env_sys_targets="[\"${sys_target}\"]"
+fi
+
+if test ! -z "$sys_version"; then
+    env_sys_versions="[\"${sys_version}\"]"
+fi
+
+set -a
+bake_target="${bake_target:-$@}"
+cargo_profiles="${env_cargo_profiles:-$default_cargo_profiles}"
+feat_sets="${env_feat_sets:-$default_feat_sets}"
+rust_targets="${env_rust_targets:-$default_rust_targets}"
+rust_toolchains="${env_rust_toolchains:-$default_rust_toolchains}"
+sys_names="${env_sys_names:-$default_sys_names}"
+sys_targets="${env_sys_targets:-$default_sys_targets}"
+sys_versions="${env_sys_versions:-$default_sys_versions}"
+
+docker_dir="$PWD/$BASEDIR"
+builder_name="${GITHUB_ACTOR:-owo}"
+toolchain_toml="$docker_dir/../rust-toolchain.toml"
+rust_msrv=$(grep "channel = " "$toolchain_toml" | cut -d'=' -f2 | sed 's/\s"\|"$//g')
+rocksdb_opt_level=3
+rocksdb_portable=1
+git_checkout="${git_checkout:-HEAD}"
+use_chef="true"
+set +a
+
+###############################################################################
+
+export DOCKER_BUILDKIT=1
+if test "$CI" = "true"; then
+    export BUILDKIT_PROGRESS="plain"
+fi
+
+args=""
+args="$args --provenance=false"
+args="$args --builder ${builder_name}"
+#args="$args --set *.platform=${sys_platform}"
+
+if test "$CI" = "true"; then
+	args="$args --allow=network.host"
+fi
+
+if test "$(uname)" = "Darwin"; then
+    nprocs=$(sysctl -n hw.logicalcpu)
+    args="$args --set *.args.nprocs=${nprocs}"
+    :
+else
+    nprocs=$(nproc)
+    args="$args --set *.args.nprocs=${nprocs}"
+    :
+fi
+
+if test "$CI_SILENT_BAKE" = "true"; then
+	args="$args --progress=quiet"
+fi
+
+arg="$args -f $BASEDIR/bake.hcl"
+trap 'set +x; date; echo -e "\033[1;41;37mERROR\033[0m"' ERR
+
+if test "$CI_VERBOSE_ENV" = "true"; then
+	date
+	env
+fi
+
+if test "$CI_PRINT_BAKE" = "true"; then
+    docker buildx bake --print $arg $bake_target
+fi
+
+if test "$NO_BAKE" = "1"; then
+    exit 0
+fi
+
+trap '' ERR
+set -ux
+docker buildx bake $arg $bake_target
+set +x
+echo -e "\033[1;42;30mACCEPT\033[0m"

docker/complement.sh

@@ -0,0 +1,105 @@
+#!/bin/bash
+set -eo pipefail
+
+BASEDIR=$(dirname "$0")
+
+CI="${CI:-false}"
+CI_VERBOSE="${CI_VERBOSE_ENV:-false}"
+CI_VERBOSE_ENV="${CI_VERBOSE_ENV:-$CI_VERBOSE}"
+
+default_cargo_profile="test"
+default_feat_set="all"
+default_rust_toolchain="nightly"
+default_rust_target="x86_64-unknown-linux-gnu"
+default_sys_name="debian"
+default_sys_target="x86_64-v1-linux-gnu"
+default_sys_version="testing-slim"
+
+default_complement_verbose=0
+default_complement_dirty=0
+default_complement_count=1
+default_complement_parallel=1
+default_complement_shuffle=0
+default_complement_timeout="1h"
+default_complement_run=".*"
+
+run="${1:-$default_complement_run}"
+skip=""
+skip="${skip}TestToDeviceMessagesOverFederation/stopped_server"
+skip="${skip}|TestToDeviceMessagesOverFederation/interrupted_connectivity"
+skip="${skip}|TestRoomCreate/Parallel/POST_/createRoom_makes_a_room_with_a_topic_and_writes_rich_topic_representation"
+skip="${skip}|TestRoomCreate/Parallel/POST_/createRoom_makes_a_room_with_a_topic_via_initial_state_overwritten_by_topic"
+skip="${skip}|TestLogin/parallel/POST_/"
+skip="${skip}|TestUnbanViaInvite"
+skip="${skip}|TestRoomState/Parallel/GET_/publicRooms_lists_newly-created_room"
+skip="${skip}|TestThreadReceiptsInSyncMSC4102"
+
+set -a
+cargo_profile="${cargo_profile:-$default_cargo_profile}"
+feat_set="${feat_set:-$default_feat_set}"
+rust_target="${rust_target:-$default_rust_target}"
+rust_toolchain="${rust_toolchain:-$default_rust_toolchain}"
+sys_name="${sys_name:-$default_sys_name}"
+sys_target="${sys_target:-$default_sys_target}"
+sys_version="${sys_version:-$default_sys_version}"
+
+runner_name=$(echo $RUNNER_NAME | cut -d"." -f1)
+runner_num=$(echo $RUNNER_NAME | cut -d"." -f2)
+set +a
+
+###############################################################################
+
+envs=""
+envs="$envs -e complement_verbose=${complement_verbose:-$default_complement_verbose}"
+envs="$envs -e complement_count=${complement_count:-$default_complement_count}"
+envs="$envs -e complement_dirty=${complement_dirty:-$default_complement_dirty}"
+envs="$envs -e complement_parallel=${complement_parallel:-$default_complement_parallel}"
+envs="$envs -e complement_shuffle=${complement_shuffle:-$default_complement_shuffle}"
+envs="$envs -e complement_timeout=${complement_timeout:-$default_complement_timeout}"
+envs="$envs -e complement_skip=${complement_skip:-$skip}"
+envs="$envs -e complement_run=${1:-$default_complement_run}"
+
+set -x
+tester_image="complement-tester--${sys_name}--${sys_version}--${sys_target}"
+testee_image="complement-testee--${cargo_profile}--${rust_toolchain}--${rust_target}--${feat_set}--${sys_name}--${sys_version}--${sys_target}"
+name="complement_tester__${sys_name}__${sys_version}__${sys_target}"
+sock="/var/run/docker.sock"
+arg="--name $name -v $sock:$sock --network=host $envs $tester_image ${testee_image}"
+set +x
+
+if test "$CI_VERBOSE_ENV" = "true"; then
+	date
+	env
+fi
+
+docker rm -f "$name" 2>/dev/null
+
+arg="-d $arg"
+cid=$(docker run $arg)
+
+if test "$CI" = "true"; then
+	echo -n "$cid" > "$name"
+fi
+
+output_src="$cid:/usr/src/complement/full_output.jsonl"
+output_dst="tests/complement/logs.jsonl"
+extract_output() {
+	docker cp "$output_src" "$output_dst"
+}
+
+result_src="$cid:/usr/src/complement/new_results.jsonl"
+result_dst="tests/complement/results.jsonl"
+extract_results() {
+	docker cp "$result_src" "$result_dst"
+}
+
+trap 'extract_output; set +x; date; echo -e "\033[1;41;37mERROR\033[0m"' ERR
+trap 'docker container stop $cid; extract_output' INT
+docker logs -f "$cid"
+docker wait "$cid" 2>/dev/null
+
+extract_results
+git diff -U0 --color --shortstat "$result_dst" | (grep "$run" || true)
+
+git diff --quiet --exit-code "$result_dst"
+echo -e "\033[1;42;30mACCEPT\033[0m"

docs/CODE_OF_CONDUCT.md

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

docs/README.md

@@ -0,0 +1 @@
+SUMMARY.md

docs/SUMMARY.md

@@ -1,15 +1,18 @@
 # Summary
 
 - [Introduction](introduction.md)
-- [Differences from upstream Conduit](differences.md)
 - [Configuration](configuration.md)
   - [Examples](configuration/examples.md)
 - [Deploying](deploying.md)
   - [Generic](deploying/generic.md)
+    - [Reverse Proxy - Caddy](deploying/reverse-proxy-caddy.md)
+    - [Reverse Proxy - Nginx](deploying/reverse-proxy-nginx.md)
   - [NixOS](deploying/nixos.md)
   - [Docker](deploying/docker.md)
+  - [Kubernetes](deploying/kubernetes.md)
   - [Arch Linux](deploying/arch-linux.md)
   - [Debian](deploying/debian.md)
+  - [Red Hat](deploying/redhat.md)
   - [FreeBSD](deploying/freebsd.md)
 - [TURN](turn.md)
 - [Appservices](appservices.md)
@@ -19,4 +22,4 @@ # Summary
   - [Contributing](contributing.md)
   - [Testing](development/testing.md)
   - [Hot Reloading ("Live" Development)](development/hot_reload.md)
-- [conduwuit Community Code of Conduct](conduwuit_coc.md)
+- [Tuwunel Community Code of Conduct](CODE_OF_CONDUCT.md)

docs/appservices.md

@@ -3,8 +3,8 @@ # 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).
+[#tuwunel:tuwunel.chat](https://matrix.to/#/#tuwunel:tuwunel.chat) or
+[open an issue on GitHub](https://github.com/matrix-construct/tuwunel/issues/new).
 
 ## Set up the appservice - general instructions
 
@@ -14,7 +14,7 @@ ## Set up the appservice - general instructions
 
 At some point the appservice guide should ask you to add a registration yaml
 file to the homeserver. In Synapse you would do this by adding the path to the
-homeserver.yaml, but in conduwuit you can do this from within Matrix:
+homeserver.yaml, but in tuwunel you can do this from within Matrix:
 
 First, go into the `#admins` room of your homeserver. The first person that
 registered on the homeserver automatically joins it. Then send a message into
@@ -37,9 +37,9 @@ ## Set up the appservice - general instructions
 
 The server bot should answer with `Appservices (1): your-bridge`
 
-Then you are done. conduwuit will send messages to the appservices and the
+Then you are done. Tuwunel will send messages to the appservices and the
 appservice can send requests to the homeserver. You don't need to restart
-conduwuit, but if it doesn't work, restarting while the appservice is running
+tuwunel, but if it doesn't work, restarting while the appservice is running
 could help.
 
 ## Appservice-specific instructions

docs/conduwuit_coc.md

@@ -1,93 +0,0 @@
-# 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,24 +1,30 @@
 # Configuration
 
-This chapter describes various ways to configure conduwuit.
+This chapter describes various ways to configure Tuwunel.
 
 ## Basics
 
-conduwuit uses a config file for the majority of the settings, but also supports
+Tuwunel 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.
+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.
+Tuwunel by specifying the `-c`, `--config` flag. It is also possible to specify
+more than one config file.
+
+Alternatively, you can use the environment variable `TUWUNEL_CONFIG` to specify
+the config file to used. Conduit's environment variables are supported for 
+backwards compatibility.
+
+> [!IMPORTANT]
+> It is bad practice to uncomment default options without changing them. Many
+> defaults are updated by developers as features evolve and can be essential
+> to expected server function.
 
 ## Option commandline flag
 
-conduwuit supports setting individual config options in TOML format from the
+Tuwunel 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\"`.
 
@@ -31,18 +37,48 @@ ## Option commandline flag
 - `--option log=\"debug\"` works ✅
 - `--option server_name='"example.com'"` works ✅
 
+## Relevance of configuration settings
+
+There is a specific sequence for reading and overwriting the settings. The
+latest setting takes precedence and defines the configuration.
+
+1. Set in `CONDUIT_CONFIG`.
+2. Set in `CONDUWUIT_CONFIG`.
+3. Set in `TUWUNEL_CONFIG`.
+4. Set in the first config file on the command line (e.g. `-c config_file_1.toml`).
+5. Set in the second config file on the command line (e.g. `-c config_file_2.toml`).
+6. Set in any additional config file on the command line (e.g. `-c config_file_n.toml`).
+7. Set within the options (again, the latest option in the list overrides).
+
+
+## Execute commandline flag
+
+Tuwunel 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
+`./tuwunel --execute "users create_user june"`
+
+An example output of a success is:
+```
+INFO tuwunel_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_`.
+prefixed with `TUWUNEL_`.
 
 For example, if the setting you are changing is `max_request_size`, then the
-environment variable to set is `CONDUWUIT_MAX_REQUEST_SIZE`.
+environment variable to set is `TUWUNEL_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`
+`[global.well_known]`, use the `__` suffix split: `TUWUNEL_WELL_KNOWN__SERVER`
 
-Conduit's environment variables are supported for backwards compatibility (e.g.
-`CONDUIT_SERVER_NAME`).
+Conduit and conduwuit's environment variables are supported for backwards
+compatibility (e.g. `CONDUIT_SERVER_NAME` or `CONDUWUIT_SERVER_NAME`).

docs/configuration/examples.md

@@ -4,7 +4,7 @@ ## Example configuration
 <summary>Example configuration</summary>
 
 ```toml
-{{#include ../../conduwuit-example.toml}}
+{{#include ../../tuwunel-example.toml}}
 ```
 
 </details>
@@ -15,7 +15,7 @@ ## Debian systemd unit file
 <summary>Debian systemd unit file</summary>
 
 ```
-{{#include ../../debian/conduwuit.service}}
+{{#include ../../debian/tuwunel.service}}
 ```
 
 </details>
@@ -26,7 +26,7 @@ ## Arch Linux systemd unit file
 <summary>Arch Linux systemd unit file</summary>
 
 ```
-{{#include ../../arch/conduwuit.service}}
+{{#include ../../arch/tuwunel.service}}
 ```
 
 </details>

docs/contributing.md

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

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

docs/deploying/README.md

@@ -0,0 +1 @@
+SUMMARY.md

docs/deploying/SUMMARY.md

@@ -0,0 +1,11 @@
+# Deployment Guides
+
+- [Generic](generic.md)
+- [NixOS](nixos.md)
+- [Docker](docker.md)
+- [Kubernetes](kubernetes.md)
+- [Arch Linux](arch-linux.md)
+- [Debian](debian.md)
+- [Red Hat](redhat.md)
+- [FreeBSD](freebsd.md)
+- [Podman systemd](podman-systemd.md)

docs/deploying/arch-linux.md

@@ -1,15 +1,15 @@
-# conduwuit for Arch Linux
+# Tuwunel for Arch Linux
 
-Currently conduwuit is only on the Arch User Repository (AUR).
+Currently Tuwunel 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
+The Tuwunel AUR packages are community maintained and are not maintained by
+Tuwunel 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
+- [tuwunel](https://aur.archlinux.org/packages/tuwunel) - latest tagged
+tuwunel
+- [tuwunel-git](https://aur.archlinux.org/packages/tuwunel-git) - latest git
+tuwunel from `main` branch
+- [tuwunel-bin](https://aur.archlinux.org/packages/tuwunel-bin) - latest
+tagged tuwunel static binary

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

@@ -1,43 +1,47 @@
-# conduwuit - Behind Traefik Reverse Proxy
+# tuwunel - Behind Traefik Reverse Proxy
 
 services:
-    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 # EDIT THIS
-            CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit
-            CONDUWUIT_DATABASE_BACKEND: rocksdb
-            CONDUWUIT_PORT: 6167
-            CONDUWUIT_MAX_REQUEST_SIZE: 20_000_000 # in bytes, ~20 MB
-            CONDUWUIT_ALLOW_REGISTRATION: 'true'
-            CONDUWUIT_ALLOW_FEDERATION: 'true'
-            CONDUWUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
-            CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
-            #CONDUWUIT_LOG: warn,state_res=warn
-            CONDUWUIT_ADDRESS: 0.0.0.0
-            #CONDUWUIT_CONFIG: '/etc/conduwuit.toml' # Uncomment if you mapped config toml above
-        #cpuset: "0-4" # Uncomment to limit to specific CPU cores
+  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: jevolk/tuwunel:latest
+    restart: unless-stopped
+    volumes:
+      - db:/var/lib/tuwunel
+      #- ./tuwunel.toml:/etc/tuwunel.toml
+    networks:
+      - proxy
+    environment:
+      TUWUNEL_SERVER_NAME: your.server.name.example # EDIT THIS
+      TUWUNEL_DATABASE_PATH: /var/lib/tuwunel
+      TUWUNEL_PORT: 6167 # should match the loadbalancer traefik label
+      TUWUNEL_MAX_REQUEST_SIZE: 20000000 # in bytes, ~20 MB
+      TUWUNEL_ALLOW_REGISTRATION: 'true'
+      TUWUNEL_REGISTRATION_TOKEN: 'YOUR_TOKEN' # A registration token is required when registration is allowed.
+      #TUWUNEL_YES_I_AM_VERY_VERY_SURE_I_WANT_AN_OPEN_REGISTRATION_SERVER_PRONE_TO_ABUSE: 'true'
+      TUWUNEL_ALLOW_FEDERATION: 'true'
+      TUWUNEL_TRUSTED_SERVERS: '["matrix.org"]'
+      #TUWUNEL_LOG: warn,state_res=warn
+      TUWUNEL_ADDRESS: 0.0.0.0
+      #TUWUNEL_CONFIG: '/etc/tuwunel.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 TUWUNEL_WELL_KNOWN
+      # variable / config option, there are multiple ways to do this, e.g. in the tuwunel.toml file, and in a separate
+      # see the override file for more information about delegation
+      TUWUNEL_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: # tuwunel 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 conduwuit
+    ###       Domain or Subdomain for the communication between Element and tuwunel
     ### Config-Docs: https://github.com/vector-im/element-web/blob/develop/docs/config.md
     # element-web:
     #     image: vectorim/element-web:latest
@@ -50,10 +54,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,44 +1,37 @@
-# conduwuit - Traefik Reverse Proxy Labels
+# tuwunel - 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-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.routers.to-tuwunel.rule=Host(`<SUBDOMAIN>.<DOMAIN>`)"  # Change to the address on which tuwunel is hosted
+      - "traefik.http.routers.to-tuwunel.tls=true"
+      - "traefik.http.routers.to-tuwunel.tls.certresolver=letsencrypt"
+      - "traefik.http.routers.to-tuwunel.middlewares=cors-headers@docker"
+      - "traefik.http.services.to_tuwunel.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 tuwunel 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

@@ -1,6 +1,6 @@
 services:
     caddy:
-    # This compose file uses caddy-docker-proxy as the reverse proxy for conduwuit!
+    # This compose file uses caddy-docker-proxy as the reverse proxy for tuwunel!
     # For more info, visit https://github.com/lucaslorentz/caddy-docker-proxy
         image: lucaslorentz/caddy-docker-proxy:ci-alpine
         ports:
@@ -20,26 +20,26 @@ services:
             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,
+        ### If you already built the tuwunel image with 'docker build' or want to use a registry image,
         ### then you are ready to go.
-        image: girlbossceo/conduwuit:latest
+        image: jevolk/tuwunel:latest
         restart: unless-stopped
         volumes:
-            - db:/var/lib/conduwuit
-            #- ./conduwuit.toml:/etc/conduwuit.toml
+            - db:/var/lib/tuwunel
+            #- ./tuwunel.toml:/etc/tuwunel.toml
         environment:
-            CONDUWUIT_SERVER_NAME: example.com # EDIT THIS
-            CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit
-            CONDUWUIT_DATABASE_BACKEND: rocksdb
-            CONDUWUIT_PORT: 6167
-            CONDUWUIT_MAX_REQUEST_SIZE: 20_000_000 # in bytes, ~20 MB
-            CONDUWUIT_ALLOW_REGISTRATION: 'true'
-            CONDUWUIT_ALLOW_FEDERATION: 'true'
-            CONDUWUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
-            CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
-            #CONDUWUIT_LOG: warn,state_res=warn
-            CONDUWUIT_ADDRESS: 0.0.0.0
-            #CONDUWUIT_CONFIG: '/etc/conduwuit.toml' # Uncomment if you mapped config toml above
+            TUWUNEL_SERVER_NAME: example.com # EDIT THIS
+            TUWUNEL_DATABASE_PATH: /var/lib/tuwunel
+            TUWUNEL_PORT: 6167
+            TUWUNEL_MAX_REQUEST_SIZE: 20000000 # in bytes, ~20 MB
+            TUWUNEL_ALLOW_REGISTRATION: 'true'
+            TUWUNEL_REGISTRATION_TOKEN: 'YOUR_TOKEN' # A registration token is required when registration is allowed.
+            #TUWUNEL_YES_I_AM_VERY_VERY_SURE_I_WANT_AN_OPEN_REGISTRATION_SERVER_PRONE_TO_ABUSE: 'true'
+            TUWUNEL_ALLOW_FEDERATION: 'true'
+            TUWUNEL_TRUSTED_SERVERS: '["matrix.org"]'
+            #TUWUNEL_LOG: warn,state_res=warn
+            TUWUNEL_ADDRESS: 0.0.0.0
+            #TUWUNEL_CONFIG: '/etc/tuwunel.toml' # Uncomment if you mapped config toml above
         networks:
             - caddy
         labels:

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

@@ -1,46 +1,55 @@
-# conduwuit - Behind Traefik Reverse Proxy
+# tuwunel - Behind Traefik Reverse Proxy
 
 services:
-    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:/srv/conduwuit/.local/share/conduwuit
-            #- ./conduwuit.toml:/etc/conduwuit.toml
-        networks:
-            - proxy
-        environment:
-            CONDUWUIT_SERVER_NAME: your.server.name # EDIT THIS
-            CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
-            CONDUWUIT_ALLOW_REGISTRATION : 'true'
-            #CONDUWUIT_CONFIG: '/etc/conduwuit.toml' # Uncomment if you mapped config toml above
-            ### Uncomment and change values as desired
-            # CONDUWUIT_ADDRESS: 0.0.0.0
-            # CONDUWUIT_PORT: 6167
-            # CONDUWUIT_LOG: info  # default is: "warn,state_res=warn"
-            # CONDUWUIT_ALLOW_JAEGER: 'false'
-            # CONDUWUIT_ALLOW_ENCRYPTION: 'true'
-            # CONDUWUIT_ALLOW_FEDERATION: 'true'
-            # CONDUWUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
-            # CONDUWUIT_DATABASE_PATH: /srv/conduwuit/.local/share/conduwuit
-            # CONDUWUIT_WORKERS: 10
-            # CONDUWUIT_MAX_REQUEST_SIZE: 20000000  # in bytes, ~20 MB
+  homeserver:
+    ### If you already built the tuwunel image with 'docker build' or want to use the Docker Hub image,
+    ### then you are ready to go.
+    image: jevolk/tuwunel:latest
+    restart: unless-stopped
+    volumes:
+      - db:/var/lib/tuwunel
+      #- ./tuwunel.toml:/etc/tuwunel.toml
+    networks:
+      - proxy
+    environment:
+      TUWUNEL_SERVER_NAME: your.server.name.example # EDIT THIS
+      TUWUNEL_TRUSTED_SERVERS: '["matrix.org"]'
+      TUWUNEL_ALLOW_REGISTRATION: 'false' # After setting a secure registration token, you can enable this
+      TUWUNEL_REGISTRATION_TOKEN: "" # This is a token you can use to register on the server
+      #TUWUNEL_REGISTRATION_TOKEN_FILE: "" # Alternatively you can configure a path to a token file to read
+      TUWUNEL_ADDRESS: 0.0.0.0
+      TUWUNEL_PORT: 6167 # you need to match this with the traefik load balancer label if you're want to change it
+      TUWUNEL_DATABASE_PATH: /var/lib/tuwunel
+      #TUWUNEL_CONFIG: '/etc/conduit.toml' # Uncomment if you mapped config toml above
+      ### Uncomment and change values as desired, note that tuwunel 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
+      # TUWUNEL_LOG: info  # default is: "warn,state_res=warn"
+      # TUWUNEL_ALLOW_ENCRYPTION: 'true'
+      # TUWUNEL_ALLOW_FEDERATION: 'true'
+      # TUWUNEL_ALLOW_INCOMING_PRESENCE: true
+      # TUWUNEL_ALLOW_OUTGOING_PRESENCE: true
+      # TUWUNEL_ALLOW_LOCAL_PRESENCE: true
+      # TUWUNEL_WORKERS: 10
+      # TUWUNEL_MAX_REQUEST_SIZE: 20000000  # in bytes, ~20 MB
+      # TUWUNEL_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 TUWUNEL_WELL_KNOWN
+      # variable / config option, there are multiple ways to do this, e.g. in the tuwunel.toml file, and in a separate
+      # reverse proxy, but since you do not have a reverse proxy and following this guide, this example is included
+      TUWUNEL_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: # tuwunel 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 conduwuit
+    ###       Domain or Subdomain for the communication between Element and tuwunel
     ### Config-Docs: https://github.com/vector-im/element-web/blob/develop/docs/config.md
     # element-web:
     #     image: vectorim/element-web:latest
@@ -52,29 +61,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:
@@ -82,3 +141,5 @@ volumes:
 
 networks:
     proxy:
+
+# vim: ts=2:sw=2:expandtab

docs/deploying/docker-compose.yml

@@ -1,33 +1,33 @@
-# conduwuit
+# tuwunel
 
 services:
     homeserver:
-        ### If you already built the conduwuit image with 'docker build' or want to use a registry image,
+        ### If you already built the tuwunel image with 'docker build' or want to use a registry image,
         ### then you are ready to go.
-        image: girlbossceo/conduwuit:latest
+        image: jevolk/tuwunel:latest
         restart: unless-stopped
         ports:
             - 8448:6167
         volumes:
-            - db:/var/lib/conduwuit
-            #- ./conduwuit.toml:/etc/conduwuit.toml
+            - db:/var/lib/tuwunel
+            #- ./tuwunel.toml:/etc/tuwunel.toml
         environment:
-            CONDUWUIT_SERVER_NAME: your.server.name # EDIT THIS
-            CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit
-            CONDUWUIT_DATABASE_BACKEND: rocksdb
-            CONDUWUIT_PORT: 6167
-            CONDUWUIT_MAX_REQUEST_SIZE: 20_000_000 # in bytes, ~20 MB
-            CONDUWUIT_ALLOW_REGISTRATION: 'true'
-            CONDUWUIT_ALLOW_FEDERATION: 'true'
-            CONDUWUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
-            CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
-            #CONDUWUIT_LOG: warn,state_res=warn
-            CONDUWUIT_ADDRESS: 0.0.0.0
-            #CONDUWUIT_CONFIG: '/etc/conduwuit.toml' # Uncomment if you mapped config toml above
+            TUWUNEL_SERVER_NAME: your.server.name # EDIT THIS
+            TUWUNEL_DATABASE_PATH: /var/lib/tuwunel
+            TUWUNEL_PORT: 6167
+            TUWUNEL_MAX_REQUEST_SIZE: 20000000 # in bytes, ~20 MB
+            TUWUNEL_ALLOW_REGISTRATION: 'true'
+            TUWUNEL_REGISTRATION_TOKEN: 'YOUR_TOKEN' # A registration token is required when registration is allowed.
+            #TUWUNEL_YES_I_AM_VERY_VERY_SURE_I_WANT_AN_OPEN_REGISTRATION_SERVER_PRONE_TO_ABUSE: 'true'
+            TUWUNEL_ALLOW_FEDERATION: 'true'
+            TUWUNEL_TRUSTED_SERVERS: '["matrix.org"]'
+            #TUWUNEL_LOG: warn,state_res=warn
+            TUWUNEL_ADDRESS: 0.0.0.0
+            #TUWUNEL_CONFIG: '/etc/tuwunel.toml' # Uncomment if you mapped config toml above
     #
     ### Uncomment if you want to use your own Element-Web App.
     ### Note: You need to provide a config.json for Element and you also need a second
-    ###       Domain or Subdomain for the communication between Element and conduwuit
+    ###       Domain or Subdomain for the communication between Element and tuwunel
     ### Config-Docs: https://github.com/vector-im/element-web/blob/develop/docs/config.md
     # element-web:
     #     image: vectorim/element-web:latest

docs/deploying/docker.md

@@ -1,66 +1,48 @@
-# conduwuit for Docker
+# tuwunel for Docker
 
 ## Docker
 
-To run conduwuit with Docker you can either build the image yourself or pull it
+To run tuwunel with Docker you can either build the image yourself or pull it
 from a registry.
 
 ### Use a registry
 
-OCI images for conduwuit are available in the registries listed below.
+OCI images for tuwunel are available in the registries listed below.
 
-| Registry        | Image
-| Size                          | Notes                  | | --------------- |
---------------------------------------------------------------- |
------------------------------ | ---------------------- | | GitHub Registry |
-[ghcr.io/girlbossceo/conduwuit:latest][gh] | ![Image Size][shield-latest]  |
-Stable tagged image.          | | GitLab Registry |
-[registry.gitlab.com/conduwuit/conduwuit:latest][gl] | ![Image
-Size][shield-latest]  | Stable tagged image.          | | Docker Hub      |
-[docker.io/girlbossceo/conduwuit:latest][dh]             | ![Image
-Size][shield-latest]  | Stable tagged image.          | | GitHub Registry |
-[ghcr.io/girlbossceo/conduwuit:main][gh]   | ![Image Size][shield-main]    |
-Stable main branch.   | | GitLab Registry |
-[registry.gitlab.com/conduwuit/conduwuit:main][gl]   | ![Image
-Size][shield-main]    | Stable main branch.   | | Docker Hub      |
-[docker.io/girlbossceo/conduwuit:main][dh]               | ![Image
-Size][shield-main]    | Stable main branch.   |
+| Registry        | Image                                                           | Size                          | Notes                  |
+| --------------- | --------------------------------------------------------------- | ----------------------------- | ---------------------- |
+| GitHub Registry | [ghcr.io/matrix-construct/tuwunel:latest][gh] | ![Image Size][shield-latest]  | Stable latest tagged image.          |
+| Docker Hub      | [docker.io/jevolk/tuwunel:latest][dh]             | ![Image Size][shield-latest]  | Stable latest tagged image.          |
+| GitHub Registry | [ghcr.io/matrix-construct/tuwunel:main][gh]   | ![Image Size][shield-main]    | Stable main branch.   |
+| Docker Hub      | [docker.io/jevolk/tuwunel:main][dh]               | ![Image Size][shield-main]    | Stable main branch.   |
 
-[dh]: https://hub.docker.com/r/girlbossceo/conduwuit
-[gh]: https://github.com/girlbossceo/conduwuit/pkgs/container/conduwuit
-[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
-
-Use
-
-```bash docker image pull <link> ```
-
-to pull it to your machine.
+[dh]: https://hub.docker.com/r/jevolk/tuwunel
+[gh]: https://github.com/matrix-construct/tuwunel/pkgs/container/tuwunel
+[shield-latest]: https://img.shields.io/docker/image-size/jevolk/tuwunel/latest
+[shield-main]: https://img.shields.io/docker/image-size/jevolk/tuwunel/main
 
 ### Run
 
 When you have the image you can simply run it with
 
-```bash 
-docker run -d -p 8448:6167 \ 
-    -v db:/var/lib/conduwuit/ \ 
-    -e CONDUWUIT_SERVER_NAME="your.server.name" \ 
-    -e CONDUWUIT_DATABASE_BACKEND="rocksdb" \ 
-    -e CONDUWUIT_ALLOW_REGISTRATION=false \
-    --name conduit <link> 
+```bash
+docker run -d -p 8448:6167 \
+    -v db:/var/lib/tuwunel/ \
+    -e TUWUNEL_SERVER_NAME="your.server.name" \
+    -e TUWUNEL_ALLOW_REGISTRATION=false \
+    --name tuwunel $LINK
 ```
 
 or you can use [docker compose](#docker-compose).
 
 The `-d` flag lets the container run in detached mode. You may supply an
-optional `conduwuit.toml` config file, the example config can be found
+optional `tuwunel.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
+change config values on the fly. You can even configure tuwunel 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`
+If you just want to test tuwunel for a short time, you can use the `--rm`
 flag, which will clean up everything related to your container after you stop
 it.
 
@@ -88,25 +70,14 @@ ### Docker-compose
 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 ```
+```bash
+docker network create caddy
+```
 
 After that, you can rename it so it matches `docker-compose.yml` and spin up the
 containers!
 
-Additional info about deploying conduwuit can be found [here](generic.md).
-
-### Build
-
-To build the conduwuit image with docker-compose, you first need to open and
-modify the `docker-compose.yml` file. There you need to comment the `image:`
-option and uncomment the `build:` option. Then call docker compose with:
-
-```bash 
-docker compose up
-```
-
-This will also start the container right afterwards, so if want it to run in
-detached mode, you also should use the `-d` flag.
+Additional info about deploying tuwunel can be found [here](generic.md).
 
 ### Run
 
@@ -120,6 +91,30 @@ ### Run
 
 > **Note:** Don't forget to modify and adjust the compose file to your needs.
 
+### Nix build
+
+Tuwunel's Nix images are built using [`buildLayeredImage`][nix-buildlayeredimage].
+This ensures all OCI images are repeatable and reproducible by anyone, keeps the
+images lightweight, and can be built offline.
+
+This also ensures portability of our images because `buildLayeredImage` builds
+OCI images, not Docker images, and works with other container software.
+
+The OCI images are OS-less with only a very minimal environment of the `tini`
+init system, CA certificates, and the tuwunel 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)
+
 ### Use Traefik as Proxy
 
 As a container user, you probably know about Traefik. It is a easy to use
@@ -128,10 +123,10 @@ ### Use Traefik as Proxy
 [`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml) (or
 [`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)) and
 [`docker-compose.override.yml`](docker-compose.override.yml), it is equally easy
-to deploy and use conduwuit, with a little caveat. If you already took a look at
+to deploy and use tuwunel, 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
+serve any kind of content, but for tuwunel to federate, we need to either
 expose ports `443` and `8448` or serve two endpoints `.well-known/matrix/client`
 and `.well-known/matrix/server`.
 
@@ -141,3 +136,6 @@ ### Use Traefik as Proxy
 ## Voice communication
 
 See the [TURN](../turn.md) page.
+
+[nix-buildlayeredimage]: https://ryantm.github.io/nixpkgs/builders/images/dockertools/#ssec-pkgs-dockerTools-buildLayeredImage
+[oci-image-def]: https://github.com/jevolk/tuwunel/blob/main/nix/pkgs/oci-image/default.nix

docs/deploying/freebsd.md

@@ -1,11 +1,6 @@
-# conduwuit for FreeBSD
+# Tuwunel for FreeBSD
 
-conduwuit at the moment does not provide FreeBSD builds. Building conduwuit on
-FreeBSD requires a specific environment variable to use the system prebuilt
-RocksDB library instead of rust-rocksdb / rust-librocksdb-sys which does *not*
-work and will cause a build error or coredump.
+Tuwunel at the moment does not provide FreeBSD builds or have FreeBSD packaging, however Tuwunel does
+build and work on FreeBSD using the system-provided RocksDB.
 
-Use the following environment variable: `ROCKSDB_LIB_DIR=/usr/local/lib`
-
-Such example commandline with it can be: `ROCKSDB_LIB_DIR=/usr/local/lib cargo
-build --release`
+Contributions for getting Tuwunel into ports are welcome.

docs/deploying/generic.md

@@ -1,123 +1,200 @@
 # Generic deployment documentation
 
-> ## Getting help
+> [!TIP]
 >
-> 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).
+> Getting help: If you run into any problems while setting up Tuwunel
+> [open an issue on GitHub](https://github.com/matrix-construct/tuwunel/issues/new).
 
-## Installing conduwuit
+## Installing Tuwunel
 
-You may simply download the binary that fits your machine. Run `uname -m` to see
-what you need.
+### Static prebuilt binary
 
-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 packages.
-These binaries have jemalloc and io_uring statically linked and included with
-them.
+You may simply download the binary that fits your machine architecture (x86_64
+or aarch64). Run `uname -m` to see what you need.
+
+Prebuilt fully static binaries can be downloaded from the latest tagged
+release [here](https://github.com/matrix-construct/tuwunel/releases/latest) or
+`main` CI branch workflow artifact output. These also include `.deb` packages
+for Debian or Ubuntu and `.rpm` packages for Red Hat or Fedora.
+
+For the **best** performance; if using an `x86_64` CPU made in the last ~10 years,
+we recommend using the `-v3-` optimised packages. See below for a command to check
+what your system supports. If the server refuses to start or exits with an "Illegal
+Instruction" error you will need `-v2-` or `-v1-` packages instead. The database
+backend, RocksDB, benefits from `-v2-` or greater as it features performance
+critical hardware accelerated CRC32 hashing/checksumming.
+
+Linux users can run this script to display which optimization levels they may
+choose:
+```
+cat /proc/cpuinfo | grep -Po '(avx|sse)[235]' | sort -u | sed 's/avx5/v4/;s/avx2/v3/;s/sse3/v2/;s/sse2/v1/' | sort
+```
+
+### Compiling
 
 Alternatively, you may compile the binary yourself. We recommend using
-[Lix](https://lix.systems) to build conduwuit as this has the most guaranteed
-reproducibiltiy and easiest to get a build environment and output going.
+Nix to build tuwunel as this has the most
+guaranteed reproducibiltiy and easiest to get a build environment and output
+going. This also allows easy cross-compilation.
 
-Otherwise, follow standard Rust project build guides (installing git and cloning
-the repo, getting the Rust toolchain via rustup, installing LLVM toolchain +
-libclang for RocksDB, installing liburing for io_uring and RocksDB, etc).
+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/tuwunel`. This is reproducible with the static binaries produced
+in our CI.
 
-## Adding a conduwuit user
+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
 
-While conduwuit can run as any user it is better to use dedicated users for
+You can build Tuwunel using `cargo build --release --all-features`
+
+## Adding a Tuwunel user
+
+While Tuwunel can run as any user it is better to use dedicated users for
 different services. This also allows you to make sure that the file permissions
 are correctly set up.
 
-In Debian or Fedora/RHEL, you can use this command to create a conduwuit user:
+In Debian, you can use this command to create a Tuwunel user:
 
 ```bash
-sudo adduser --system conduwuit --group --disabled-login --no-create-home 
+sudo adduser --system tuwunel --group --disabled-login --no-create-home
 ```
 
-For distros without `adduser`:
+For distros without `adduser` (or where it's a symlink to `useradd`):
 
-```bash sudo useradd -r --shell /usr/bin/nologin --no-create-home conduwuit ```
+```bash
+sudo useradd -r --shell /usr/bin/nologin --no-create-home tuwunel
+```
 
 ## 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. Tuwunel 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
+If Tuwunel 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
 
-The systemd unit for conduwuit can be found
-[here](../configuration/examples.md#example-systemd-unit-file). You may need to
-change the `ExecStart=` path to where you placed the conduwuit binary.
+Two example systemd units for Tuwunel 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 Tuwunel
+binary if it is not `/usr/bin/tuwunel`.
 
-## Creating the conduwuit configuration file
+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.
 
-Now we need to create the conduwuit's config file in
-`/etc/conduwuit/conduwuit.toml`. The example config can be found at
-[conduwuit-example.toml](../configuration/examples.md).**Please take a moment to
-read it. You need to change at least the server name.**
+If you are using a different `database_path` other than the systemd unit
+configured default `/var/lib/tuwunel`, you need to add your path to the
+systemd unit's `ReadWritePaths=`. This can be done by either directly editing
+`tuwunel.service` and reloading systemd, or running `systemctl edit tuwunel.service`
+and entering the following:
+
+```
+[Service]
+ReadWritePaths=/path/to/custom/database/path
+```
+
+## Creating the Tuwunel configuration file
+
+Now we need to create the Tuwunel's config file in
+`/etc/tuwunel/tuwunel.toml`. The example config can be found at
+[tuwunel-example.toml](../configuration/examples.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
 
-If you are using a dedicated user for conduwuit, you will need to allow it to
+If you are using a dedicated user for Tuwunel, you will need to allow it to
 read the config. To do that you can run this:
 
 ```bash
-sudo chown -R root:root /etc/conduwuit sudo chmod -R 755 /etc/conduwuit
+sudo chown -R root:root /etc/tuwunel
+sudo chmod -R 755 /etc/tuwunel
 ```
 
 If you use the default database path you also need to run this:
 
-```bash 
-sudo mkdir -p /var/lib/conduwuit/ sudo chown -R conduwuit:conduwuit
-/var/lib/conduwuit/ sudo chmod 700 /var/lib/conduwuit/ 
+```bash
+sudo mkdir -p /var/lib/tuwunel/
+sudo chown -R tuwunel:tuwunel /var/lib/tuwunel/
+sudo chmod 700 /var/lib/tuwunel/
 ```
 
 ## Setting up the Reverse Proxy
 
-Refer to the documentation or various guides online of your chosen reverse proxy
-software. A [Caddy](https://caddyserver.com/) example will be provided as this
-is the recommended reverse proxy for new users and is very trivial to use
-(handles TLS, reverse proxy headers, etc transparently with proper defaults).
+We recommend Caddy as a reverse proxy, as it is trivial to use, handling TLS certificates, reverse proxy headers, etc. transparently with proper defaults. However, Nginx is also well-supported and widely used.
 
-Lighttpd is not supported as it seems to mess with the `X-Matrix` Authorization
-header, making federation non-functional. If using Apache, you need to use
-`nocanon` to prevent this.
+**Choose your reverse proxy:**
 
-### Caddy
+- **[Caddy Setup Guide](reverse-proxy-caddy.md)** - Recommended for ease of use and automatic TLS
+- **[Nginx Setup Guide](reverse-proxy-nginx.md)** - Popular choice with extensive documentation
 
-Create `/etc/caddy/conf.d/conduwuit_caddyfile` and enter this (substitute for
-your server name).
+### Quick Overview
 
-```caddy
-your.server.name, your.server.name:8448 { # TCP reverse_proxy
-    127.0.0.1:6167
-    # UNIX socket 
-    #reverse_proxy unix//run/conduwuit/conduwuit.sock 
-}
+Regardless of which reverse proxy you choose, you will need to:
+
+1. **Reverse proxy the following routes:**
+   - `/_matrix/` - core Matrix C-S and S-S APIs
+   - `/_tuwunel/` - ad-hoc Tuwunel routes such as `/local_user_count` and `/server_version`
+
+2. **Optionally reverse proxy (recommended):**
+   - `/.well-known/matrix/client` and `/.well-known/matrix/server` if using Tuwunel to perform delegation (see the `[global.well_known]` config section)
+   - `/.well-known/matrix/support` if using Tuwunel to send the homeserver admin contact and support page (formerly known as MSC1929)
+   - `/` if you would like to see `hewwo from tuwunel woof!` at the root
+
+3. **Handle ports:**
+   - Port 443 (HTTPS) for client-server API
+   - Port 8448 for federation (if federating with other homeservers)
+
+See the following spec pages for more details on well-known 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://matrix.org/.well-known/matrix/server>
+- <https://matrix.org/.well-known/matrix/client>
+
+### Other Reverse Proxies
+
+_Specific contributions for other proxies are welcome!_
+
+**Not Recommended:**
+- **Apache**: While possible, Apache requires special configuration (`nocanon` in `ProxyPass`) to prevent corruption of the `X-Matrix` header.
+- **Lighttpd**: Its proxy module alters the `X-Matrix` authorization header, breaking federation functionality.
+
+## You are done
+
+Now you can start Tuwunel with:
+
+```bash
+sudo systemctl start tuwunel
 ```
 
-That's it! Just start and enable the service and you're set.
-
-```bash sudo systemctl enable --now caddy ```
-
-## You're done
-
-Now you can start conduwuit with:
-
-```bash sudo systemctl start conduwuit ```
-
 Set it to start automatically when your system boots with:
 
-```bash sudo systemctl enable conduwuit ```
+```bash
+sudo systemctl enable tuwunel
+```
 
 ## How do I know it works?
 
@@ -127,10 +204,15 @@ ## How do I know it works?
 You can also use these commands as a quick health check (replace
 `your.server.name`).
 
-```bash $ curl https://your.server.name/_conduwuit/server_version
+```bash
+curl https://your.server.name/_tuwunel/server_version
 
-# If using port 8448 $ curl
-https://your.server.name:8448/_conduwuit/server_version ```
+# If using port 8448
+curl https://your.server.name:8448/_tuwunel/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

docs/deploying/kubernetes.md

@@ -0,0 +1,9 @@
+# Tuwunel for Kubernetes
+
+Tuwunel doesn't support horizontal scalability or distributed loading
+natively, however a community maintained Helm Chart is available here to run
+Tuwunel on Kubernetes: <https://github.com/AreYouLoco/tuwunel-helm> and the
+legacy conduwuit version: <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 Tuwunel maintainers.

docs/deploying/nixos.md

@@ -1,38 +1,109 @@
-# conduwuit for NixOS
+_This file may be out of date. Please help us update it_
 
-conduwuit can be acquired by [Lix][lix] from various places:
+# Tuwunel for NixOS
+
+Tuwunel can be acquired by Nix from various places:
 
 * The `flake.nix` at the root of the repo
 * The `default.nix` at the root of the repo
-* From conduwuit's binary cache
+* From Tuwunel's binary cache
 
-A binary cache for conduwuit that the CI/CD publishes to is available at the
+A community maintained NixOS package is available at [`tuwunel`](https://search.nixos.org/packages?channel=unstable&show=tuwunel&from=0&size=50&sort=relevance&type=packages&query=tuwunel)
+
+### Binary cache
+
+A binary cache for Tuwunel 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
+```
+https://attic.kennel.juneis.dog/conduit
 conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk=
 
 https://attic.kennel.juneis.dog/conduwuit
-conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE= ```
+conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE=
+```
 
-The binary caches have been recreated recently due to attic issues. The old
-public keys were:
+The binary caches were recreated some months ago due to attic issues. The old public
+keys were:
 
-``` conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg=
+```
+conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg=
+conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw=
+```
 
-conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw= ```
+If needed, we have a binary cache on Cachix but it is only limited to 5GB:
 
-If specifying a URL in your flake, please use the GitHub remote:
-`github:girlbossceo/conduwuit`
+```
+https://conduwuit.cachix.org
+conduwuit.cachix.org-1:MFRm6jcnfTf0jSAbmvLfhO3KBMt4px+1xaereWXp8Xg=
+```
 
-The `flake.nix` and `default.nix` do not (currently) provide a NixOS module, so
-(for now) [`services.matrix-conduit`][module] from Nixpkgs should be used to
-configure conduwuit.
+If specifying a Git remote URL in your flake, you can use any remotes that
+are specified on the README (the mirrors), such as the GitHub: `github:matrix-construct/tuwunel`
 
-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.
+### 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
+Tuwunel.
+
+### 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 Tuwunel from the `flake.nix`
+or `default.nix` and set [`services.matrix-conduit.package`][package]
+appropriately to use Tuwunel instead of Conduit.
+
+### UNIX sockets
+
+Due to the lack of a Tuwunel 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 Tuwunel NixOS configuration module, developed and
+published by the community, would be appreciated.
+
+### jemalloc and hardened profile
+
+Tuwunel 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 Tuwunel, or
+disable jemalloc like so:
+
+```nix
+let
+    tuwunel = pkgs.unstable.tuwunel.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/deploying/podman-systemd.md

@@ -0,0 +1,16 @@
+# tuwunel in Podman systemd
+
+Copy [tuwunel.container](tuwunel.container) to ~/.config/containers/systemd/tuwunel.container.
+Reload daemon:
+```
+systemctl --user daemon-reload
+```
+Start the service:
+```
+systemctl --user start tuwunel
+```
+
+To check the logs, run:
+```
+journalctl -eu tuwunel.container --user
+```

docs/deploying/redhat.md

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

docs/deploying/reverse-proxy-caddy.md

@@ -0,0 +1,48 @@
+# Reverse Proxy Setup - Caddy
+
+[<= Back to Generic Deployment Guide](generic.md#setting-up-the-reverse-proxy)
+
+We recommend Caddy as a reverse proxy, as it is trivial to use, handling TLS certificates, reverse proxy headers, etc. transparently with proper defaults.
+
+## Installation
+
+Install Caddy via your preferred method. Refer to the [official Caddy installation guide](https://caddyserver.com/docs/install) for your distribution.
+
+## Configuration
+
+After installing Caddy, create `/etc/caddy/conf.d/tuwunel_caddyfile` and enter this (substitute `your.server.name` with your actual server name):
+
+```caddyfile
+your.server.name, your.server.name:8448 {
+    # TCP reverse_proxy
+    reverse_proxy localhost:8008
+    # UNIX socket (alternative - comment out the line above and uncomment this)
+    #reverse_proxy unix//run/tuwunel/tuwunel.sock
+}
+```
+
+### What this does
+
+- Handles both port 443 (HTTPS) and port 8448 (Matrix federation) automatically
+- Automatically provisions and renews TLS certificates via Let's Encrypt
+- Sets all necessary reverse proxy headers correctly
+- Routes all traffic to Tuwunel listening on `localhost:8008`
+
+That's it! Just start and enable the service and you're set.
+
+```bash
+sudo systemctl enable --now caddy
+```
+
+## Verification
+
+After starting Caddy, verify it's working by checking:
+
+```bash
+curl https://your.server.name/_tuwunel/server_version
+curl https://your.server.name:8448/_tuwunel/server_version
+```
+
+---
+
+[=> Continue with "You're Done"](generic.md#you-are-done)

docs/deploying/reverse-proxy-nginx.md

@@ -0,0 +1,164 @@
+# Reverse Proxy Setup - Nginx
+
+[<= Back to Generic Deployment Guide](generic.md#setting-up-the-reverse-proxy)
+
+This guide shows you how to configure Nginx as a reverse proxy for Tuwunel with TLS support.
+
+## Installation
+
+Install Nginx via your preferred method. Most distributions include Nginx in their package repositories:
+
+```bash
+# Debian/Ubuntu
+sudo apt install nginx
+
+# Red Hat/Fedora
+sudo dnf install nginx
+
+# Arch Linux
+sudo pacman -S nginx
+```
+
+## Configuration
+
+Create a new configuration file at `/etc/nginx/sites-available/tuwunel` (or `/etc/nginx/conf.d/tuwunel.conf` on some distributions):
+
+```nginx
+# Client-Server API over HTTPS (port 443)
+server {
+  listen 443 ssl http2;
+  listen [::]:443 ssl http2;
+  server_name matrix.example.com;
+
+  # Nginx standard body size is 1MB, which is quite small for media uploads
+  # Increase this to match the max_request_size in your tuwunel.toml
+  client_max_body_size 100M;
+
+  # Forward requests to Tuwunel (listening on 127.0.0.1:8008)
+  location / {
+    proxy_pass http://127.0.0.1:8008;
+
+    # Preserve host and scheme - critical for proper Matrix operation
+    proxy_set_header Host $host;
+    proxy_set_header X-Forwarded-For $remote_addr;
+    proxy_set_header X-Forwarded-Proto https;
+  }
+
+  # TLS configuration (Let's Encrypt example using certbot)
+  ssl_certificate /etc/letsencrypt/live/matrix.example.com/fullchain.pem;
+  ssl_certificate_key /etc/letsencrypt/live/matrix.example.com/privkey.pem;
+}
+
+# Matrix Federation over HTTPS (port 8448)
+# Only needed if you want to federate with other homeservers
+# Don't forget to open port 8448 in your firewall!
+server {
+  listen 8448 ssl http2;
+  listen [::]:8448 ssl http2;
+  server_name matrix.example.com;
+
+  # Same body size increase for larger files
+  client_max_body_size 100M;
+
+  # Forward to the same local port as client-server API
+  location / {
+    proxy_pass http://127.0.0.1:8008;
+    proxy_set_header Host $host;
+    proxy_set_header X-Forwarded-For $remote_addr;
+    proxy_set_header X-Forwarded-Proto https;
+  }
+
+  # TLS configuration (same certificates as above)
+  ssl_certificate /etc/letsencrypt/live/matrix.example.com/fullchain.pem;
+  ssl_certificate_key /etc/letsencrypt/live/matrix.example.com/privkey.pem;
+}
+```
+
+### Important Notes
+
+- **Replace `matrix.example.com`** with your actual server name
+- **`client_max_body_size`**: Must match or exceed `max_request_size` in your `tuwunel.toml`
+- **Do NOT use `$request_uri`** in `proxy_pass` - while some guides suggest this, it's not necessary for Tuwunel and can cause issues
+- **IPv6**: The `listen [::]:443` and `listen [::]:8448` lines enable IPv6 support. Remove them if you don't need IPv6
+
+### TLS Certificates
+
+The example above uses Let's Encrypt certificates via certbot. To obtain certificates:
+
+```bash
+sudo certbot certonly --nginx -d matrix.example.com
+```
+
+Certbot will automatically handle renewal. Make sure to reload Nginx after certificate renewal:
+
+```bash
+sudo systemctl reload nginx
+```
+
+### Optional: Timeout Configuration
+
+The default Nginx timeouts are usually sufficient for Matrix operations. Element's long-polling `/sync` requests typically run for 30 seconds, which is within Nginx's default timeouts.
+
+However, if you experience federation retries or dropped long-poll connections, you can extend the timeouts by adding these lines inside your `location /` blocks:
+
+```nginx
+location / {
+  proxy_pass http://127.0.0.1:8008;
+  proxy_set_header Host $host;
+  proxy_set_header X-Forwarded-For $remote_addr;
+  proxy_set_header X-Forwarded-Proto https;
+
+  # Optional: Extend timeouts if experiencing issues
+  proxy_read_timeout 300s;
+  proxy_send_timeout 300s;
+}
+```
+
+## Enable the Configuration
+
+If using sites-available/sites-enabled structure:
+
+```bash
+sudo ln -s /etc/nginx/sites-available/tuwunel /etc/nginx/sites-enabled/
+```
+
+Test the configuration:
+
+```bash
+sudo nginx -t
+```
+
+If the test passes, reload Nginx:
+
+```bash
+sudo systemctl reload nginx
+```
+
+Enable Nginx to start on boot:
+
+```bash
+sudo systemctl enable nginx
+```
+
+## Verification
+
+After configuring Nginx, verify it's working by checking:
+
+```bash
+curl https://matrix.example.com/_tuwunel/server_version
+curl https://matrix.example.com:8448/_tuwunel/server_version
+```
+
+## Troubleshooting
+
+### Apache Compatibility Note
+
+If you're considering Apache instead of Nginx: Apache is not well-suited as a reverse proxy for Matrix homeservers. If you must use Apache, you need to use `nocanon` in your `ProxyPass` directive to prevent httpd from corrupting the `X-Matrix` authorization header, which will break federation.
+
+### Lighttpd is Not Supported
+
+Lighttpd has known issues with the `X-Matrix` authorization header, making federation non-functional. We do not recommend using Lighttpd with Tuwunel.
+
+---
+
+[=> Continue with "You're Done"](generic.md#you-are-done)

docs/deploying/tuwunel.container

@@ -0,0 +1,9 @@
+[Container]
+Environment=TUWUNEL_SERVER_NAME=your.domain.here TUWUNEL_DATABASE_PATH=/var/lib/tuwunel TUWUNEL_PORT=6167 TUWUNEL_MAX_REQUEST_SIZE=20000000 TUWUNEL_ALLOW_REGISTRATION=true TUWUNEL_REGISTRATION_TOKEN=YOUR_TOKEN TUWUNEL_ALLOW_FEDERATION=true TUWUNEL_TRUSTED_SERVERS=["matrix.org"] TUWUNEL_ADDRESS=0.0.0.0 # Add TUWUNEL_CONFIG: '/etc/tuwunel.toml' if the config is mapped
+Image=docker.io/jevolk/tuwunel:latest
+PublishPort=8448:6167
+Volume=/path/to/db:/var/lib/tuwunel
+#Volume=/path/to/tuwunel.toml:/etc/tuwunel.toml #Uncomment to use the config file
+
+[Service]
+Restart=always

docs/development.md

@@ -1,48 +1,118 @@
 # Development
 
 Information about developing the project. If you are only interested in using
-it, you can safely ignore this section. If you plan on contributing, see the
-[contributor's guide](contributing.md).
+it, you can safely ignore this page. If you plan on contributing, see the
+[contributor's guide](./contributing.md).
 
-## List of forked dependencies During conduwuit development, we have had to fork
+## Tuwunel project layout
+
+Tuwunel 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 Tuwunel 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 Tuwunel 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 "Tuwunel 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 = ["tuwunel-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 Tuwunel 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
+development (unresponsive or slow upstream), Tuwunel-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, client/server interop
+- [ruma/ruma][1]: <https://github.com/matrix-construct/ruma> - 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, GCC build fix, and logging callback C API for Rust tracing
-integration
-- [tikv/jemallocator][3]: <https://github.com/girlbossceo/jemallocator> - musl
-builds seem to be broken on upstream
+- [facebook/rocksdb][2]: <https://github.com/matrix-construct/rocksdb> - liburing
+build fixes and GCC debug build fix
+- [tikv/jemallocator][3]: <https://github.com/matrix-construct/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 CLI
+<https://github.com/matrix-construct/rustyline-async> - tab completion callback and
+`CTRL+\` signal quit event for Tuwunel console CLI
 - [rust-rocksdb/rust-rocksdb][5]:
-<https://github.com/girlbossceo/rust-rocksdb-zaidoon1> - [`@zaidoon1`'s][8] fork
-has quicker updates, more up to date dependencies. Our changes fix musl build
-issues, Rust part of the logging callback C API, removes unnecessary `gtest`
-include, and uses our RocksDB and jemallocator
-- [tokio-rs/tracing][6]: <https://github.com/girlbossceo/tracing> - Implements
+<https://github.com/matrix-construct/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/matrix-construct/tracing> - Implements
 `Clone` for `EnvFilter` to support dynamically changing tracing envfilter's
 alongside other logging/metrics things
 
 ## Debugging with `tokio-console`
 
 [`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,
+`tokio-console`-enabled build of Tuwunel, enable the `tokio_console` feature,
 disable the default `release_max_log_level` feature, and set the `--cfg
 tokio_unstable` flag to enable experimental tokio APIs. A build might look like
 this:
 
-```bash RUSTFLAGS="--cfg tokio_unstable" cargo build \ --release \
---no-default-features \
---features=systemd,element_hacks,gzip_compression,brotli_compression,zstd_compression,tokio_console
+```bash
+RUSTFLAGS="--cfg tokio_unstable" cargo +nightly build \
+    --release \
+    --no-default-features \
+    --features=systemd,element_hacks,gzip_compression,brotli_compression,zstd_compression,tokio_console
 ```
 
+You will also need to enable the `tokio_console` config option in Tuwunel 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/
@@ -51,3 +121,11 @@ ## Debugging with `tokio-console`
 [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

@@ -1,8 +1,11 @@
 # 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
+When developing in debug-builds with the nightly toolchain, Tuwunel 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
@@ -39,7 +42,7 @@ ### Requirements
 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
+linkers, and please let us know in the [Tuwunel 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
@@ -49,13 +52,13 @@ ### 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
+0. Have patience. Don't hesitate to join the [Tuwunel 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
+   override set nightly` in your local Tuwunel directory, or use `cargo
 +nightly` for all actions.
 
 2. Uncomment `cargo-features` at the top level / root Cargo.toml
@@ -82,14 +85,14 @@ ### Usage
    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
+9. In your Tuwunel server terminal, hit/send `CTRL+C` signal. This will tell
+   Tuwunel 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
+To shutdown Tuwunel 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
@@ -98,7 +101,7 @@ ### Usage
 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
+the [Tuwunel 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
@@ -133,7 +136,7 @@ ### Addendum
 **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
+![Tuwunel'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
@@ -144,7 +147,7 @@ ### Addendum
 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
+![Tuwunel'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
@@ -193,5 +196,5 @@ ### Interesting related issues/bugs
 [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
+[7]: https://matrix.to/#/#tuwunel:tuwunel.chat
 [8]: https://crates.io/crates/libloading

docs/development/testing.md

@@ -5,12 +5,11 @@ ## Complement
 Have a look at [Complement's repository][complement] for an explanation of what
 it is.
 
-To test against Complement, with [Lix][lix] and direnv installed and set up, you
-can:
+To test against Complement, with Nix 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. This will also output the OCI image
+* 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 OCI image outputted to `result` (it's a `.tar.gz` file)
@@ -18,6 +17,15 @@ ## Complement
 output from the commit/revision you want to test (e.g. from main)
 [here][ci-workflows]
 
-[lix]: https://lix.systems/
-[ci-workflows]: https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml?query=event%3Apush+is%3Asuccess+actor%3Agirlbossceo
+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/matrix-construct/complement>
+
+[ci-workflows]: https://github.com/matrix-construct/tuwunel/actions/workflows/ci.yml?query=event%3Apush+is%3Asuccess+actor%3Ajevolk
 [complement]: https://github.com/matrix-org/complement
+[direnv]: https://direnv.net/docs/hook.html

docs/differences.md

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

docs/introduction.md

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

docs/maintenance.md

@@ -1,14 +1,14 @@
-# Maintaining your conduwuit setup
+# Maintaining your Tuwunel setup
 
 ## Moderation
 
-conduwuit has moderation through admin room commands. "binary commands" (medium
+Tuwunel 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:
+Tuwunel has moderation admin commands for:
 
 - managing room aliases (`!admin rooms alias`)
 - managing room directory (`!admin rooms directory`)
@@ -22,23 +22,59 @@ ## Moderation
 Any commands with `-list` in them will require a codeblock in the message with
 each object being newline delimited. An example of doing this is:
 
-```` !admin rooms moderation ban-list-of-rooms ``` !roomid1:server.name
-!roomid2:server.name !roomid3:server.name ``` ````
+````
+!admin rooms moderation ban-list-of-rooms
+```
+!roomid1:server.name
+#badroomalias1:server.name
+!roomid2:server.name
+!roomid3:server.name
+#badroomalias2:server.name
+```
+````
 
-## Database
+## Database (RocksDB)
 
-If using RocksDB, there's very little you need to do. Compaction is ran
-automatically based on various defined thresholds tuned for conduwuit to be high
-performance with the least I/O amplifcation or overhead. Manually running
-compaction is not recommended, or compaction via a timer. RocksDB is built with
-io_uring support via liburing for async read I/O.
+Generally there is very little you need to do. [Compaction][rocksdb-compaction]
+is ran automatically based on various defined thresholds tuned for Tuwunel 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 may benefit from disabling compression on RocksDB if CoW is in use.
+the RocksDB section in the [example config](configuration/examples.md).
 
-RocksDB troubleshooting can be found [in the RocksDB section of
-troubleshooting](troubleshooting.md).
+btrfs users have reported that database compression does not need to be disabled
+on Tuwunel 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 Tuwunel has already
+configured to only store up to 3 RocksDB `LOG` files due to generally 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
 
@@ -52,7 +88,7 @@ ## Backups
 
 To restore a backup from an online RocksDB backup:
 
-- shutdown conduwuit
+- shutdown Tuwunel
 - 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
@@ -63,9 +99,9 @@ ## Backups
 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
+- start up Tuwunel again and it should open as normal
 
-If you'd like to do an offline backup, shutdown conduwuit and copy your
+If you'd like to do an offline backup, shutdown Tuwunel and copy your
 `database_path` directory elsewhere. This can be restored with no modifications
 needed.
 
@@ -74,7 +110,7 @@ ## Backups
 
 ## Media
 
-Media still needs various work, however conduwuit implements media deletion via:
+Media still needs various work, however Tuwunel implements media deletion via:
 
 - MXC URI or Event ID (unencrypted and attempts to find the MXC URI in the
 event)
@@ -82,16 +118,18 @@ ## Media
 - 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
+See the `!admin media` command for further information. All media in Tuwunel
 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
+Repo](https://github.com/t2bot/matrix-media-repo). Tuwunel 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
+`media/` works. Tuwunel 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

@@ -1,90 +1,193 @@
-# Troubleshooting conduwuit
+# Troubleshooting Tuwunel
 
-> ## 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.
->
+> [!IMPORTANT]
 > 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.
+> your Docker setup. We must remain focused on supporting Tuwunel issues and
+> cannot budget our time for generic Docker support. Compose file issues or
+> Dockerhub image issues are okay if they are something we can fix.
+
+## Tuwunel 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>"` Tuwunel binary
+argument once to invite yourslf to the admin room on startup
+- Use the Tuwunel 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
+properly functional when running Tuwunel, 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
+This is **not** a Tuwunel issue, and is purely a Docker issue. It is not
 sustainable for heavy DNS activity which is normal for Matrix federation. The
 workarounds for this are:
 - Use DNS over TCP via the config option `query_over_tcp_only = true`
 - Don't use Docker's default DNS setup and instead allow the container to use
 and communicate with your host's DNS servers (host's `/etc/resolv.conf`)
 
-## Rocksdb / database issues
+#### DNS No connections available error message
 
-#### Direct IO
+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).
 
-Some filesystems may not like RocksDB using [Direct
-IO](https://github.com/facebook/rocksdb/wiki/Direct-IO). Direct IO is for
-non-buffered I/O which improves conduwuit performance, but at least FUSE is a
-filesystem potentially known to not like this. See the [example
-config](configuration/examples.md) for disabling it if needed. Issues from
-Direct IO on unsupported filesystems are usually shown as startup errors.
+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.
+
+Tuwunel 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 Tuwunel config.
+
+Raising `dns_cache_entries` in Tuwunel 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.
+There are many causes and varieties of database corruption. There are several
+methods for mitigation, each with outcomes ranging from a recovered state down
+to a savage state. This guide has been simplified into a set of universal steps
+which everyone can follow from the top until they have recovered or reach the
+end. The details and implications will be explained within each step.
 
-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.
+> [!TIP]
+> All command-line `-O` options can be expressed as environment variables or in
+> the config file based on your deployment's requirements. Note that
+> `--maintenance` is equivalent to configuring `startup_netburst = false` and
+> `listening = false`.
 
-RocksDB has the following recovery modes:
+> [!IMPORTANT]
+> Always create a backup of the database before running any operation. This is
+> critical for steps 3 and above.
 
-- `TolerateCorruptedTailRecords`
-- `AbsoluteConsistency`
-- `PointInTime`
-- `SkipAnyCorruptedRecord`
+**0. Start the server with the following options:**
 
-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.
+`tuwunel --maintenance -O rocksdb_recovery_mode=0`
 
-`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.
+This is actually a "control" and not a method of recovery. If the server starts
+you either do not have corruption or have deep corruption indicated by very
+specific errors from rocksdb citing corruption during runtime. If you are
+certain there is deep corruption skip to step 4, otherwise you are finished
+without any modifications.
 
-With this in mind:
+**1. Start the server in Tolerate-Corrupted-Tail-Records mode:**
 
-- 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
+`tuwunel --maintenance -O rocksdb_recovery_mode=1`
+
+The most common corruption scenario is from a loss of power to the hardware
+(not an application crash, though it is still possible). This is remediated
+by dropping the most recently written record. It is highly unlikely there will
+be any impact on the application from this loss. In the best-case the same data
+is often re-requested over the federation or replaced by a client. In the
+worst-case clients may need to clear-cache & reload to guarantee correctness.
+If the server starts you are finished.
+
+**2. Start the server in Point-In-Time mode:**
+
+`tuwunel --maintenance -O rocksdb_recovery_mode=2`
+
+Similar to the corruption scenario above but for more severe cases. The most
+recent records are discarded back to the point where there is no corruption.
+It is highly unlikely there will be any impact on the application from this
+loss, but it is more likely than above that clients may need to clear-cache
+& reload to correctly resynchronize with the server.
+
+**3. Start the server in Skip-Any-Corrupted-Record mode:**
+
+> [!WARNING]
+> Salvage mode potentially impacting the application's ability to function.
+> We cannot provide support for users who have entered this mode.
+
+`tuwunel --maintenance -O rocksdb_recovery_mode=3`
+
+Similar to the prior corruption scenarios but for the most severe cases.
+The database will be inconsistent. It is theoretically possible for the
+server to continue functioning without notable issue in the best case, but
+it is completely uncertain what the effect of this operation will be. If
+the server starts you should immediately export your messages, encryption
+keys, etc, in a salvage effort and prepare to reinstall.
+
+**4. Start the server in repair mode.**
+
+> [!WARNING]
+> Salvage mode potentially impacting the application's ability to function.
+> We cannot provide support for users who have entered this mode.
+
+> [!CAUTION]
+> Always create a backup of the database before entering this mode. The repair
+> is not configurable and not interactive. It may automatically remove more
+> data than anticipated, preventing further salvage efforts.
+
+`tuwunel --maintenance -O rocksdb_repair=true`
+
+For corruption affecting the bulk database tables not covered by any journal.
+This will leave the database in an inconsistent and unpredictable state. It
+is theoretically possible to continue operating the server depending on which
+records were dropped, such as some historical records which are no longer
+essential. Nevertheless the impact of this operation is impossible to assess
+and a successful recovery should be used to salvage data prior to reinstall.
+
+Once finished, restart the server without `rocksdb_repair`. If no errors
+persist, restart the server again without maintenance mode.
+
+**5. Utilize an external repair tool.**
+
+> [!WARNING]
+> Salvage mode potentially impacting the application's ability to function.
+> We cannot provide support for users who have entered this mode.
+
+```
+git clone https://github.com/facebook/rocksdb
+cd rocksdb
+make -j$(nproc) ldb
+./ldb repair --db=/var/lib/tuwunel/ 2>./repair-log.txt
+```
+
+For situations when the repair mode in step 4 failed or produced unexpected
+results.
 
 ## Debugging
 
@@ -94,24 +197,50 @@ ## Debugging
 
 #### Debug/Trace log level
 
-conduwuit builds without debug or trace log levels by default for at least
-performance reasons. This may change in the future and/or binaries providing
-such configurations may be provided. If you need to access debug/trace log
-levels, you will need to build without the `release_max_log_level` feature.
+Tuwunel 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 release-logging binaries
+and images.
 
 #### Changing log level dynamically
 
-conduwuit supports changing the tracing log environment filter on-the-fly using
-the admin command `!admin debug change-log-level`. This accepts a string
-**without quotes** the same format as the `log` config option.
+Tuwunel 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`. This takes a server
-name and goes through the server discovery process and queries
+Tuwunel 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, you can see conduwuit's
-jemalloc memory stats by using `!admin debug memory-stats`
+When using jemalloc with jemallocator's `stats` feature (`--enable-stats`), you
+can see Tuwunel'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 Tuwunel 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,6 +1,6 @@
 # Setting up TURN/STURN
 
-In order to make or receive calls, a TURN server is required. conduwuit suggests
+In order to make or receive calls, a TURN server is required. Tuwunel suggests
 using [Coturn](https://github.com/coturn/coturn) for this purpose, which is also
 available as a Docker image.
 
@@ -17,9 +17,25 @@ ### Configuration
 A common way to generate a suitable alphanumeric secret key is by using `pwgen
 -s 64 1`.
 
-These same values need to be set in conduwuit. See the [example
+These same values need to be set in Tuwunel. See the [example
 config](configuration/examples.md) in the TURN section for configuring these and
-restart conduwuit after.
+restart Tuwunel 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 Tuwunel which disables
+authentication for the TURN URI endpoint `/_matrix/client/v3/voip/turnServer`
 
 ### Run
 

engage.toml

@@ -1,208 +0,0 @@
-interpreter = ["bash", "-euo", "pipefail", "-c"]
-
-[[task]]
-name = "engage"
-group = "versions"
-script = "engage --version"
-
-[[task]]
-name = "nix"
-group = "versions"
-script = "nix --version"
-
-[[task]]
-name = "direnv"
-group = "versions"
-script = "direnv --version"
-
-[[task]]
-name = "rustc"
-group = "versions"
-script = "rustc --version"
-
-[[task]]
-name = "cargo"
-group = "versions"
-script = "cargo --version"
-
-[[task]]
-name = "cargo-fmt"
-group = "versions"
-script = "cargo fmt --version"
-
-[[task]]
-name = "rustdoc"
-group = "versions"
-script = "rustdoc --version"
-
-[[task]]
-name = "cargo-clippy"
-group = "versions"
-script = "cargo clippy -- --version"
-
-[[task]]
-name = "cargo-audit"
-group = "versions"
-script = "cargo audit --version"
-
-[[task]]
-name = "cargo-deb"
-group = "versions"
-script = "cargo deb --version"
-
-[[task]]
-name = "lychee"
-group = "versions"
-script = "lychee --version"
-
-[[task]]
-name = "markdownlint"
-group = "versions"
-script = "markdownlint --version"
-
-[[task]]
-name = "dpkg"
-group = "versions"
-script = "dpkg --version"
-
-[[task]]
-name = "cargo-audit"
-group = "security"
-script = "cargo audit -D warnings -D unmaintained -D unsound -D yanked"
-
-[[task]]
-name = "cargo-fmt"
-group = "lints"
-script = """
-cargo fmt --check -- --color=always
-"""
-
-[[task]]
-name = "cargo-doc"
-group = "lints"
-script = """
-env DIRENV_DEVSHELL=all-features \
-    RUSTDOCFLAGS="-D warnings" \
-    direnv exec . \
-    cargo doc \
-        --workspace \
-        --profile test \
-        --all-features \
-        --no-deps \
-        --document-private-items \
-        --color always
-"""
-
-[[task]]
-name = "clippy/default"
-group = "lints"
-script = """
-cargo clippy \
-    --workspace \
-    --profile test \
-    --all-targets \
-    --color=always \
-    -- \
-    -D warnings
-"""
-
-[[task]]
-name = "clippy/all"
-group = "lints"
-script = """
-env DIRENV_DEVSHELL=all-features \
-    direnv exec . \
-    cargo clippy \
-        --workspace \
-        --profile test \
-        --all-targets \
-        --all-features \
-        --color=always \
-        -- \
-        -D warnings
-"""
-
-[[task]]
-name = "clippy/jemalloc"
-group = "lints"
-script = """
-cargo clippy \
-    --workspace \
-    --profile test \
-    --features jemalloc \
-    --all-targets \
-    --color=always \
-    -- \
-    -D warnings
-"""
-
-#[[task]]
-#name = "clippy/hardened_malloc"
-#group = "lints"
-#script = """
-#cargo clippy \
-#    --workspace \
-#    --features hardened_malloc \
-#    --all-targets \
-#    --color=always \
-#    -- \
-#    -D warnings
-#"""
-
-[[task]]
-name = "lychee"
-group = "lints"
-script = "lychee --verbose --offline docs *.md --exclude development.md"
-
-[[task]]
-name = "markdownlint"
-group = "lints"
-script = "markdownlint docs *.md || true" # TODO: fix the ton of markdown lints so we can drop `|| true`
-
-[[task]]
-name = "cargo/all"
-group = "tests"
-script = """
-env DIRENV_DEVSHELL=all-features \
-    direnv exec . \
-    cargo test \
-        --workspace \
-        --profile test \
-        --all-targets \
-        --all-features \
-        --color=always \
-        -- \
-        --color=always
-"""
-
-[[task]]
-name = "cargo/default"
-group = "tests"
-script = """
-cargo test \
-    --workspace \
-    --profile test \
-    --all-targets \
-    --color=always \
-    -- \
-    --color=always
-"""
-
-# Ensure that the flake's default output can build and run without crashing
-#
-# This is a dynamically-linked jemalloc build, which is a case not covered by
-# our other tests. We've had linking problems in the past with dynamic
-# jemalloc builds that usually show up as an immediate segfault or "invalid free"
-[[task]]
-name = "nix-default"
-group = "tests"
-script = """
-env DIRENV_DEVSHELL=dynamic \
-    CARGO_PROFILE="test" \
-    direnv exec . \
-    bin/nix-build-and-cache just .#default-test
-env DIRENV_DEVSHELL=dynamic \
-    CARGO_PROFILE="test" \
-    direnv exec . \
-    nix run -L .#default-test -- --help && nix run -L .#default-test -- --version
-"""

flake.lock

@@ -4,16 +4,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": 1724226964,
-        "narHash": "sha256-cltFh4su2vcFidxKp7LuEgX3ZGLfPy0DCdrQZ/QTe68=",
+        "lastModified": 1758711588,
+        "narHash": "sha256-0nZlCCDC5PfndsQJXXtcyrtrfW49I3KadGMDlutzaGU=",
         "owner": "zhaofengli",
         "repo": "attic",
-        "rev": "6d9aeaef0a067d664cb11bb7704f7ec373d47fb2",
+        "rev": "12cbeca141f46e1ade76728bce8adc447f2166c6",
         "type": "github"
       },
       "original": {
@@ -26,16 +27,16 @@
     "cachix": {
       "inputs": {
         "devenv": "devenv",
-        "flake-compat": "flake-compat_3",
+        "flake-compat": "flake-compat_2",
         "git-hooks": "git-hooks",
-        "nixpkgs": "nixpkgs_3"
+        "nixpkgs": "nixpkgs_2"
       },
       "locked": {
-        "lastModified": 1724232775,
-        "narHash": "sha256-6u2DycIEgrgNYlLxyGqdFVmBNiKIitnQKJ1pbRP5oko=",
+        "lastModified": 1763236786,
+        "narHash": "sha256-JB19RGXDr6loKSdqwvA15jhRHwf6+9Crq2glqqVar84=",
         "owner": "cachix",
         "repo": "cachix",
-        "rev": "03b6cb3f953097bff378fb8b9ea094bd091a4ec7",
+        "rev": "938a275857047c300596092beaabaee6d892e243",
         "type": "github"
       },
       "original": {
@@ -47,33 +48,36 @@
     },
     "cachix_2": {
       "inputs": {
-        "devenv": "devenv_2",
+        "devenv": [
+          "cachix",
+          "devenv"
+        ],
         "flake-compat": [
+          "cachix",
+          "devenv"
+        ],
+        "git-hooks": [
           "cachix",
           "devenv",
-          "flake-compat"
+          "git-hooks"
         ],
         "nixpkgs": [
           "cachix",
           "devenv",
           "nixpkgs"
-        ],
-        "pre-commit-hooks": [
-          "cachix",
-          "devenv",
-          "pre-commit-hooks"
         ]
       },
       "locked": {
-        "lastModified": 1712055811,
-        "narHash": "sha256-7FcfMm5A/f02yyzuavJe06zLa9hcMHsagE28ADcmQvk=",
+        "lastModified": 1752264895,
+        "narHash": "sha256-1zBPE/PNAkPNUsOWFET4J0cjlvziH8DOekesDmjND+w=",
         "owner": "cachix",
         "repo": "cachix",
-        "rev": "02e38da89851ec7fec3356a5c04bc8349cae0e30",
+        "rev": "47053aef762f452e816e44eb9a23fbc3827b241a",
         "type": "github"
       },
       "original": {
         "owner": "cachix",
+        "ref": "latest",
         "repo": "cachix",
         "type": "github"
       }
@@ -81,33 +85,27 @@
     "complement": {
       "flake": false,
       "locked": {
-        "lastModified": 1722323564,
-        "narHash": "sha256-6w6/N8walz4Ayc9zu7iySqJRmGFukhkaICLn4dweAcA=",
-        "owner": "matrix-org",
+        "lastModified": 1761739261,
+        "narHash": "sha256-XdzSBbJIYG6thrHbo44/qBiMu5R4bayfy/dlWo9AXBA=",
+        "owner": "matrix-construct",
         "repo": "complement",
-        "rev": "6e4426a9e63233f9821a4d2382bfed145244183f",
+        "rev": "350d7666cab14cb0051ef53da7a1b0b3216d7269",
         "type": "github"
       },
       "original": {
-        "owner": "matrix-org",
+        "owner": "matrix-construct",
         "ref": "main",
         "repo": "complement",
         "type": "github"
       }
     },
     "crane": {
-      "inputs": {
-        "nixpkgs": [
-          "attic",
-          "nixpkgs"
-        ]
-      },
       "locked": {
-        "lastModified": 1722960479,
-        "narHash": "sha256-NhCkJJQhD5GUib8zN9JrmYGMwt4lCRp6ZVNzIiYCl0Y=",
+        "lastModified": 1751562746,
+        "narHash": "sha256-smpugNIkmDeicNz301Ll1bD7nFOty97T79m4GUMUczA=",
         "owner": "ipetkov",
         "repo": "crane",
-        "rev": "4c6c77920b8d44cd6660c1621dea6b3fc4b4c4f4",
+        "rev": "aed2020fd3dc26e1e857d4107a5a67a33ab6c1fd",
         "type": "github"
       },
       "original": {
@@ -117,17 +115,12 @@
       }
     },
     "crane_2": {
-      "inputs": {
-        "nixpkgs": [
-          "nixpkgs"
-        ]
-      },
       "locked": {
-        "lastModified": 1724006180,
-        "narHash": "sha256-PVxPj0Ga2fMYMtcT9ARCthF+4U71YkOT7ZjgD/vf1Aw=",
+        "lastModified": 1763511871,
+        "narHash": "sha256-KKZWi+ij7oT0Ag8yC6MQkzfHGcytyjMJDD+47ZV1YNU=",
         "owner": "ipetkov",
         "repo": "crane",
-        "rev": "7ce92819802bc583b7e82ebc08013a530f22209f",
+        "rev": "099f9014bc8d0cd6e445470ea1df0fd691d5a548",
         "type": "github"
       },
       "original": {
@@ -144,22 +137,23 @@
           "cachix",
           "flake-compat"
         ],
-        "nix": "nix_2",
+        "flake-parts": "flake-parts_2",
+        "git-hooks": [
+          "cachix",
+          "git-hooks"
+        ],
+        "nix": "nix",
         "nixpkgs": [
           "cachix",
           "nixpkgs"
-        ],
-        "pre-commit-hooks": [
-          "cachix",
-          "git-hooks"
         ]
       },
       "locked": {
-        "lastModified": 1723156315,
-        "narHash": "sha256-0JrfahRMJ37Rf1i0iOOn+8Z4CLvbcGNwa2ChOAVrp/8=",
+        "lastModified": 1760560333,
+        "narHash": "sha256-goJQdVl9oDgCxF9CggPUw1DvB4gsot1jzMmz9px8Du8=",
         "owner": "cachix",
         "repo": "devenv",
-        "rev": "ff5eb4f2accbcda963af67f1a1159e3f6c7f5f91",
+        "rev": "0a4043938f540027e562c5a0feebbe6be872c3ea",
         "type": "github"
       },
       "original": {
@@ -168,39 +162,6 @@
         "type": "github"
       }
     },
-    "devenv_2": {
-      "inputs": {
-        "flake-compat": [
-          "cachix",
-          "devenv",
-          "cachix",
-          "flake-compat"
-        ],
-        "nix": "nix",
-        "nixpkgs": "nixpkgs_2",
-        "poetry2nix": "poetry2nix",
-        "pre-commit-hooks": [
-          "cachix",
-          "devenv",
-          "cachix",
-          "pre-commit-hooks"
-        ]
-      },
-      "locked": {
-        "lastModified": 1708704632,
-        "narHash": "sha256-w+dOIW60FKMaHI1q5714CSibk99JfYxm0CzTinYWr+Q=",
-        "owner": "cachix",
-        "repo": "devenv",
-        "rev": "2ee4450b0f4b95a1b90f2eb5ffea98b90e48c196",
-        "type": "github"
-      },
-      "original": {
-        "owner": "cachix",
-        "ref": "python-rewrite",
-        "repo": "devenv",
-        "type": "github"
-      }
-    },
     "fenix": {
       "inputs": {
         "nixpkgs": [
@@ -209,11 +170,11 @@
         "rust-analyzer-src": "rust-analyzer-src"
       },
       "locked": {
-        "lastModified": 1724221791,
-        "narHash": "sha256-mKX67QPnUybOopVph/LhOV1G/H4EvPxDIfSmbufrVdA=",
+        "lastModified": 1763707297,
+        "narHash": "sha256-Bd9VGavwFBLpyU4pjiWfv73gUibNj8dc3xmOW8ff3bI=",
         "owner": "nix-community",
         "repo": "fenix",
-        "rev": "e88b38a5a3834e039d413a88f8150a75ef6453ef",
+        "rev": "7c2d3a165a4a080fdcb6c191d8f9768281c99f75",
         "type": "github"
       },
       "original": {
@@ -226,11 +187,11 @@
     "flake-compat": {
       "flake": false,
       "locked": {
-        "lastModified": 1696426674,
-        "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=",
+        "lastModified": 1747046372,
+        "narHash": "sha256-CIVLLkVgvHYbgI2UpXvIIBJ12HWgX+fjA8Xf8PUmqCY=",
         "owner": "edolstra",
         "repo": "flake-compat",
-        "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33",
+        "rev": "9100a0f413b0c601e0533d1d94ffd501ce2e7885",
         "type": "github"
       },
       "original": {
@@ -242,11 +203,11 @@
     "flake-compat_2": {
       "flake": false,
       "locked": {
-        "lastModified": 1673956053,
-        "narHash": "sha256-4gtG9iQuiKITOjNQQeQIpoIB6b16fm+504Ch3sNKLd8=",
+        "lastModified": 1747046372,
+        "narHash": "sha256-CIVLLkVgvHYbgI2UpXvIIBJ12HWgX+fjA8Xf8PUmqCY=",
         "owner": "edolstra",
         "repo": "flake-compat",
-        "rev": "35bb57c0c8d8b62bbfd284272c928ceb64ddbde9",
+        "rev": "9100a0f413b0c601e0533d1d94ffd501ce2e7885",
         "type": "github"
       },
       "original": {
@@ -258,27 +219,11 @@
     "flake-compat_3": {
       "flake": false,
       "locked": {
-        "lastModified": 1696426674,
-        "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=",
+        "lastModified": 1761588595,
+        "narHash": "sha256-XKUZz9zewJNUj46b4AJdiRZJAvSZ0Dqj2BNfXvFlJC4=",
         "owner": "edolstra",
         "repo": "flake-compat",
-        "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33",
-        "type": "github"
-      },
-      "original": {
-        "owner": "edolstra",
-        "repo": "flake-compat",
-        "type": "github"
-      }
-    },
-    "flake-compat_4": {
-      "flake": false,
-      "locked": {
-        "lastModified": 1696426674,
-        "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=",
-        "owner": "edolstra",
-        "repo": "flake-compat",
-        "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33",
+        "rev": "f387cd2afec9419c8ee37694406ca490c3f34ee5",
         "type": "github"
       },
       "original": {
@@ -288,52 +233,59 @@
         "type": "github"
       }
     },
+    "flake-parts": {
+      "inputs": {
+        "nixpkgs-lib": [
+          "attic",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1751413152,
+        "narHash": "sha256-Tyw1RjYEsp5scoigs1384gIg6e0GoBVjms4aXFfRssQ=",
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
+        "rev": "77826244401ea9de6e3bac47c2db46005e1f30b5",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
+        "type": "github"
+      }
+    },
+    "flake-parts_2": {
+      "inputs": {
+        "nixpkgs-lib": [
+          "cachix",
+          "devenv",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1756770412,
+        "narHash": "sha256-+uWLQZccFHwqpGqr2Yt5VsW/PbeJVTn9Dk6SHWhNRPw=",
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
+        "rev": "4524271976b625a4a605beefd893f270620fd751",
+        "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",
-        "type": "github"
-      },
-      "original": {
-        "owner": "numtide",
-        "repo": "flake-utils",
-        "type": "github"
-      }
-    },
-    "flake-utils_2": {
-      "inputs": {
-        "systems": "systems_2"
-      },
-      "locked": {
-        "lastModified": 1689068808,
-        "narHash": "sha256-6ixXo3wt24N/melDWjq70UuHQLxGV8jZvooRanIHXw0=",
-        "owner": "numtide",
-        "repo": "flake-utils",
-        "rev": "919d646de7be200f3bf08cb76ae1f09402b6f9b4",
-        "type": "github"
-      },
-      "original": {
-        "owner": "numtide",
-        "repo": "flake-utils",
-        "type": "github"
-      }
-    },
-    "flake-utils_3": {
-      "inputs": {
-        "systems": "systems_3"
-      },
-      "locked": {
-        "lastModified": 1710146030,
-        "narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=",
-        "owner": "numtide",
-        "repo": "flake-utils",
-        "rev": "b1d9ab70662946ef0850d488da1c9019f3a9752a",
+        "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
         "type": "github"
       },
       "original": {
@@ -353,15 +305,14 @@
         "nixpkgs": [
           "cachix",
           "nixpkgs"
-        ],
-        "nixpkgs-stable": "nixpkgs-stable_2"
+        ]
       },
       "locked": {
-        "lastModified": 1723202784,
-        "narHash": "sha256-qbhjc/NEGaDbyy0ucycubq4N3//gDFFH3DOmp1D3u1Q=",
+        "lastModified": 1760392170,
+        "narHash": "sha256-WftxJgr2MeDDFK47fQKywzC72L2jRc/PWcyGdjaDzkw=",
         "owner": "cachix",
         "repo": "git-hooks.nix",
-        "rev": "c7012d0c18567c889b948781bc74a501e92275d1",
+        "rev": "46d55f0aeb1d567a78223e69729734f3dca25a85",
         "type": "github"
       },
       "original": {
@@ -395,11 +346,11 @@
     "liburing": {
       "flake": false,
       "locked": {
-        "lastModified": 1724199144,
-        "narHash": "sha256-MVjnwO6EbKzzSrU51dSseLarZ1fRp+6SagAf/nE/XZU=",
+        "lastModified": 1763758538,
+        "narHash": "sha256-cDsxLOqeC7imBcArolTHvejSnWoadgpvDy1DJ2/3MOw=",
         "owner": "axboe",
         "repo": "liburing",
-        "rev": "2d4e799017d64cd2f8304503eef9064931bb3fbd",
+        "rev": "e1ef1e680ee38ed9116989155fca47921698c25f",
         "type": "github"
       },
       "original": {
@@ -411,38 +362,57 @@
     },
     "nix": {
       "inputs": {
-        "flake-compat": "flake-compat_2",
-        "nixpkgs": [
+        "flake-compat": [
           "cachix",
           "devenv",
+          "flake-compat"
+        ],
+        "flake-parts": [
+          "cachix",
+          "devenv",
+          "flake-parts"
+        ],
+        "git-hooks-nix": [
+          "cachix",
+          "devenv",
+          "git-hooks"
+        ],
+        "nixpkgs": [
           "cachix",
           "devenv",
           "nixpkgs"
         ],
-        "nixpkgs-regression": "nixpkgs-regression"
+        "nixpkgs-23-11": [
+          "cachix",
+          "devenv"
+        ],
+        "nixpkgs-regression": [
+          "cachix",
+          "devenv"
+        ]
       },
       "locked": {
-        "lastModified": 1712911606,
-        "narHash": "sha256-BGvBhepCufsjcUkXnEEXhEVjwdJAwPglCC2+bInc794=",
-        "owner": "domenkozar",
+        "lastModified": 1758763079,
+        "narHash": "sha256-Bx1A+lShhOWwMuy3uDzZQvYiBKBFcKwy6G6NEohhv6A=",
+        "owner": "cachix",
         "repo": "nix",
-        "rev": "b24a9318ea3f3600c1e24b4a00691ee912d4de12",
+        "rev": "6f0140527c2b0346df4afad7497baa08decb929f",
         "type": "github"
       },
       "original": {
-        "owner": "domenkozar",
-        "ref": "devenv-2.21",
+        "owner": "cachix",
+        "ref": "devenv-2.30.5",
         "repo": "nix",
         "type": "github"
       }
     },
     "nix-filter": {
       "locked": {
-        "lastModified": 1710156097,
-        "narHash": "sha256-1Wvk8UP7PXdf8bCCaEoMnOT1qe5/Duqgj+rL8sRQsSM=",
+        "lastModified": 1757882181,
+        "narHash": "sha256-+cCxYIh2UNalTz364p+QYmWHs0P+6wDhiWR4jDIKQIU=",
         "owner": "numtide",
         "repo": "nix-filter",
-        "rev": "3342559a24e85fc164b295c3444e8a139924675b",
+        "rev": "59c44d1909c72441144b93cf0f054be7fe764de5",
         "type": "github"
       },
       "original": {
@@ -455,20 +425,16 @@
     "nix-github-actions": {
       "inputs": {
         "nixpkgs": [
-          "cachix",
-          "devenv",
-          "cachix",
-          "devenv",
-          "poetry2nix",
+          "attic",
           "nixpkgs"
         ]
       },
       "locked": {
-        "lastModified": 1688870561,
-        "narHash": "sha256-4UYkifnPEw1nAzqqPOTL2MvWtm3sNGw1UTYTalkTcGY=",
+        "lastModified": 1737420293,
+        "narHash": "sha256-F1G5ifvqTpJq7fdkT34e/Jy9VCyzd5XfJ9TO8fHhJWE=",
         "owner": "nix-community",
         "repo": "nix-github-actions",
-        "rev": "165b1650b753316aa7f1787f3005a8d2da0f5301",
+        "rev": "f4158fa080ef4503c8f4c820967d946c2af31ec9",
         "type": "github"
       },
       "original": {
@@ -477,42 +443,13 @@
         "type": "github"
       }
     },
-    "nix_2": {
-      "inputs": {
-        "flake-compat": [
-          "cachix",
-          "devenv",
-          "flake-compat"
-        ],
-        "nixpkgs": [
-          "cachix",
-          "devenv",
-          "nixpkgs"
-        ],
-        "nixpkgs-regression": "nixpkgs-regression_2"
-      },
-      "locked": {
-        "lastModified": 1712911606,
-        "narHash": "sha256-BGvBhepCufsjcUkXnEEXhEVjwdJAwPglCC2+bInc794=",
-        "owner": "domenkozar",
-        "repo": "nix",
-        "rev": "b24a9318ea3f3600c1e24b4a00691ee912d4de12",
-        "type": "github"
-      },
-      "original": {
-        "owner": "domenkozar",
-        "ref": "devenv-2.21",
-        "repo": "nix",
-        "type": "github"
-      }
-    },
     "nixpkgs": {
       "locked": {
-        "lastModified": 1723827930,
-        "narHash": "sha256-EU+W5F6y2CVNxGrGIMpY7nSVYq72WRChYxF4zpjx0y4=",
+        "lastModified": 1751949589,
+        "narHash": "sha256-mgFxAPLWw0Kq+C8P3dRrZrOYEQXOtKuYVlo9xvPntt8=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "d4a7a4d0e066278bfb0d77bd2a7adde1c0ec9e3d",
+        "rev": "9b008d60392981ad674e04016d25619281550a9d",
         "type": "github"
       },
       "original": {
@@ -522,77 +459,45 @@
         "type": "github"
       }
     },
-    "nixpkgs-regression": {
-      "locked": {
-        "lastModified": 1643052045,
-        "narHash": "sha256-uGJ0VXIhWKGXxkeNnq4TvV3CIOkUJ3PAoLZ3HMzNVMw=",
-        "owner": "NixOS",
-        "repo": "nixpkgs",
-        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
-        "type": "github"
-      },
-      "original": {
-        "owner": "NixOS",
-        "repo": "nixpkgs",
-        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
-        "type": "github"
-      }
-    },
-    "nixpkgs-regression_2": {
-      "locked": {
-        "lastModified": 1643052045,
-        "narHash": "sha256-uGJ0VXIhWKGXxkeNnq4TvV3CIOkUJ3PAoLZ3HMzNVMw=",
-        "owner": "NixOS",
-        "repo": "nixpkgs",
-        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
-        "type": "github"
-      },
-      "original": {
-        "owner": "NixOS",
-        "repo": "nixpkgs",
-        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
-        "type": "github"
-      }
-    },
     "nixpkgs-stable": {
       "locked": {
-        "lastModified": 1720535198,
-        "narHash": "sha256-zwVvxrdIzralnSbcpghA92tWu2DV2lwv89xZc8MTrbg=",
+        "lastModified": 1751741127,
+        "narHash": "sha256-t75Shs76NgxjZSgvvZZ9qOmz5zuBE8buUaYD28BMTxg=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "205fd4226592cc83fd4c0885a3e4c9c400efabb5",
+        "rev": "29e290002bfff26af1db6f64d070698019460302",
         "type": "github"
       },
       "original": {
         "owner": "NixOS",
-        "ref": "nixos-23.11",
-        "repo": "nixpkgs",
-        "type": "github"
-      }
-    },
-    "nixpkgs-stable_2": {
-      "locked": {
-        "lastModified": 1720386169,
-        "narHash": "sha256-NGKVY4PjzwAa4upkGtAMz1npHGoRzWotlSnVlqI40mo=",
-        "owner": "NixOS",
-        "repo": "nixpkgs",
-        "rev": "194846768975b7ad2c4988bdb82572c00222c0d7",
-        "type": "github"
-      },
-      "original": {
-        "owner": "NixOS",
-        "ref": "nixos-24.05",
+        "ref": "nixos-25.05",
         "repo": "nixpkgs",
         "type": "github"
       }
     },
     "nixpkgs_2": {
       "locked": {
-        "lastModified": 1692808169,
-        "narHash": "sha256-x9Opq06rIiwdwGeK2Ykj69dNc2IvUH1fY55Wm7atwrE=",
+        "lastModified": 1760524057,
+        "narHash": "sha256-EVAqOteLBFmd7pKkb0+FIUyzTF61VKi7YmvP1tw4nEw=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "9201b5ff357e781bf014d0330d18555695df7ba8",
+        "rev": "544961dfcce86422ba200ed9a0b00dd4b1486ec5",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs_3": {
+      "locked": {
+        "lastModified": 1763618868,
+        "narHash": "sha256-v5afmLjn/uyD9EQuPBn7nZuaZVV9r+JerayK/4wvdWA=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "a8d610af3f1a5fb71e23e08434d8d61a466fc942",
         "type": "github"
       },
       "original": {
@@ -602,77 +507,19 @@
         "type": "github"
       }
     },
-    "nixpkgs_3": {
-      "locked": {
-        "lastModified": 1722813957,
-        "narHash": "sha256-IAoYyYnED7P8zrBFMnmp7ydaJfwTnwcnqxUElC1I26Y=",
-        "owner": "NixOS",
-        "repo": "nixpkgs",
-        "rev": "cb9a96f23c491c081b38eab96d22fa958043c9fa",
-        "type": "github"
-      },
-      "original": {
-        "owner": "NixOS",
-        "ref": "nixos-unstable",
-        "repo": "nixpkgs",
-        "type": "github"
-      }
-    },
-    "nixpkgs_4": {
-      "locked": {
-        "lastModified": 1724271409,
-        "narHash": "sha256-z4nw9HxkaXEn+5OT8ljLVL2oataHvAzUQ1LEi8Fp+SY=",
-        "owner": "NixOS",
-        "repo": "nixpkgs",
-        "rev": "36a9aeaaa17a2d4348498275f9fe530cd4f9e519",
-        "type": "github"
-      },
-      "original": {
-        "owner": "NixOS",
-        "ref": "nixos-unstable",
-        "repo": "nixpkgs",
-        "type": "github"
-      }
-    },
-    "poetry2nix": {
-      "inputs": {
-        "flake-utils": "flake-utils_2",
-        "nix-github-actions": "nix-github-actions",
-        "nixpkgs": [
-          "cachix",
-          "devenv",
-          "cachix",
-          "devenv",
-          "nixpkgs"
-        ]
-      },
-      "locked": {
-        "lastModified": 1692876271,
-        "narHash": "sha256-IXfZEkI0Mal5y1jr6IRWMqK8GW2/f28xJenZIPQqkY0=",
-        "owner": "nix-community",
-        "repo": "poetry2nix",
-        "rev": "d5006be9c2c2417dafb2e2e5034d83fabd207ee3",
-        "type": "github"
-      },
-      "original": {
-        "owner": "nix-community",
-        "repo": "poetry2nix",
-        "type": "github"
-      }
-    },
     "rocksdb": {
       "flake": false,
       "locked": {
-        "lastModified": 1724285323,
-        "narHash": "sha256-k60kreKQ0v+bQ16yBd2SfLYpuNjMw2qoRmZL/S3k6CU=",
-        "owner": "girlbossceo",
+        "lastModified": 1763593074,
+        "narHash": "sha256-aOV/jJjRjNJ3hrRqhCsXlIz05NvEhDF/j5Q5UOQuvp8=",
+        "owner": "matrix-construct",
         "repo": "rocksdb",
-        "rev": "5a67ad7ce46328578ee5587fb0c23faa03d14e67",
+        "rev": "9a3a213b55df0b11408102c899a940675c0d90e4",
         "type": "github"
       },
       "original": {
-        "owner": "girlbossceo",
-        "ref": "v9.5.2",
+        "owner": "matrix-construct",
+        "ref": "tuwunel-changes",
         "repo": "rocksdb",
         "type": "github"
       }
@@ -684,22 +531,22 @@
         "complement": "complement",
         "crane": "crane_2",
         "fenix": "fenix",
-        "flake-compat": "flake-compat_4",
-        "flake-utils": "flake-utils_3",
+        "flake-compat": "flake-compat_3",
+        "flake-utils": "flake-utils",
         "liburing": "liburing",
         "nix-filter": "nix-filter",
-        "nixpkgs": "nixpkgs_4",
+        "nixpkgs": "nixpkgs_3",
         "rocksdb": "rocksdb"
       }
     },
     "rust-analyzer-src": {
       "flake": false,
       "locked": {
-        "lastModified": 1724153119,
-        "narHash": "sha256-WxpvDJDttkINkXmUA/W5o11lwLPYhATAgu0QUAacZ2g=",
+        "lastModified": 1763648203,
+        "narHash": "sha256-/WJdebbRD+m5vr2xy/bJdCpqd7YHSMapjuXAM/0lvtA=",
         "owner": "rust-lang",
         "repo": "rust-analyzer",
-        "rev": "3723e5910c14f0ffbd13de474b8a8fcc74db04ce",
+        "rev": "eaaa2da9fbbfd7a79ff501e0563351cb2004574a",
         "type": "github"
       },
       "original": {
@@ -723,36 +570,6 @@
         "repo": "default",
         "type": "github"
       }
-    },
-    "systems_2": {
-      "locked": {
-        "lastModified": 1681028828,
-        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
-        "owner": "nix-systems",
-        "repo": "default",
-        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
-        "type": "github"
-      },
-      "original": {
-        "owner": "nix-systems",
-        "repo": "default",
-        "type": "github"
-      }
-    },
-    "systems_3": {
-      "locked": {
-        "lastModified": 1681028828,
-        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
-        "owner": "nix-systems",
-        "repo": "default",
-        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
-        "type": "github"
-      },
-      "original": {
-        "owner": "nix-systems",
-        "repo": "default",
-        "type": "github"
-      }
     }
   },
   "root": "root",

flake.nix

@@ -2,14 +2,14 @@
   inputs = {
     attic.url = "github:zhaofengli/attic?ref=main";
     cachix.url = "github:cachix/cachix?ref=master";
-    complement = { url = "github:matrix-org/complement?ref=main"; flake = false; };
-    crane = { url = "github:ipetkov/crane?ref=master"; inputs.nixpkgs.follows = "nixpkgs"; };
+    complement = { url = "github:matrix-construct/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:girlbossceo/rocksdb?ref=v9.5.2"; flake = false; };
+    nixpkgs.url = "github:NixOS/nixpkgs?ref=nixpkgs-unstable";
+    rocksdb = { url = "github:matrix-construct/rocksdb?ref=tuwunel-changes"; flake = false; };
     liburing = { url = "github:axboe/liburing?ref=master"; flake = false; };
   };
 
@@ -18,7 +18,6 @@
     let
       pkgsHost = import inputs.nixpkgs{
         inherit system;
-        config.permittedInsecurePackages = [ "olm-3.2.16" ];
       };
       pkgsHostStatic = pkgsHost.pkgsStatic;
 
@@ -27,7 +26,7 @@
         file = ./rust-toolchain.toml;
 
         # See also `rust-toolchain.toml`
-        sha256 = "sha256-3jVIIf5XPnUU1CRaTyAiO0XHVbJl12MSx3eucTXCjtE=";
+        sha256 = "sha256-+9FmLhAOezBZCOziO0Qct1NOrfpjNsXxc/8I0c7BdKE=";
       };
 
       mkScope = pkgs: pkgs.lib.makeScope pkgs.newScope (self: {
@@ -38,7 +37,23 @@
         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 (final: old: {
           src = inputs.rocksdb;
           version = pkgs.lib.removePrefix
             "v"
@@ -47,19 +62,39 @@
           # 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 = [];
+          postPatch =
+            pkgs.lib.optionalString (pkgs.lib.versionOlder final.version "8") ''
+              # Fix gcc-13 build failures due to missing <cstdint> and
+              # <system_error> includes, fixed upstream since 8.x
+              sed -e '1i #include <cstdint>' -i db/compaction/compaction_iteration_stats.h
+              sed -e '1i #include <cstdint>' -i table/block_based/data_block_hash_index.h
+              sed -e '1i #include <cstdint>' -i util/string_util.h
+              sed -e '1i #include <cstdint>' -i include/rocksdb/utilities/checkpoint.h
+            '';
           cmakeFlags = pkgs.lib.subtractLists
             [
-              # no real reason to have snappy, no one uses this
+              # 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
@@ -76,18 +111,20 @@
           # preInstall hooks has stuff for messing with ldb/sst_dump which we dont need or use
           preInstall = "";
         });
-        # TODO: remove once https://github.com/NixOS/nixpkgs/pull/314945 is available
-        liburing = pkgs.liburing.overrideAttrs (old: {
-          # the configure script doesn't support these, and unconditionally
-          # builds both static and dynamic libraries.
-          configureFlags = pkgs.lib.subtractLists
-            [ "--enable-static" "--disable-shared" ]
-            old.configureFlags;
-        });
       });
 
       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 // {
@@ -100,9 +137,9 @@
           # code.
           COMPLEMENT_SRC = inputs.complement.outPath;
 
-          # Needed for Complement
-          CGO_CFLAGS = "-I${scope.pkgs.olm}/include";
-          CGO_LDFLAGS = "-L${scope.pkgs.olm}/lib";
+          # Needed for Complement: <https://github.com/golang/go/issues/52690>
+          CGO_CFLAGS = "-Wl,--no-gc-sections";
+          CGO_LDFLAGS = "-Wl,--no-gc-sections";
         };
 
         # Development tools
@@ -116,8 +153,11 @@
           toolchain
         ]
         ++ (with pkgsHost.pkgs; [
-          engage
+          # Required by hardened-malloc.rs dep
+          binutils
+
           cargo-audit
+          cargo-auditable
 
           # Needed for producing Debian packages
           cargo-deb
@@ -125,11 +165,14 @@
           # 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
@@ -142,36 +185,62 @@
 
           # used for rust caching in CI to speed it up
           sccache
-
-          # needed so we can get rid of gcc and other unused deps that bloat OCI images
-          removeReferencesTo
-        ])
+        ]
+        # liburing is Linux-exclusive
+        ++ lib.optional stdenv.hostPlatform.isLinux liburing
+        ++ lib.optional stdenv.hostPlatform.isLinux numactl)
         ++ scope.main.buildInputs
         ++ scope.main.propagatedBuildInputs
         ++ scope.main.nativeBuildInputs;
-
-        meta.broken = scope.main.meta.broken;
       };
     in
     {
       packages = {
-        default = scopeHost.main;
+        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"
+                # tuwunel_mods is a development-only hot reload feature
+                "tuwunel_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
+                "tuwunel_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
+                "tuwunel_mods"
+            ];
         };
         all-features = scopeHost.main.override {
             all_features = true;
             disable_features = [
-                # this is non-functional on nix for some reason
-                "hardened_malloc"
                 # dont include experimental features
                 "experimental"
+                # 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
+                "tuwunel_mods"
             ];
         };
         all-features-debug = scopeHost.main.override {
@@ -180,23 +249,26 @@
             # debug build users expect full logs
             disable_release_max_log_level = true;
             disable_features = [
-                # this is non-functional on nix for some reason
-                "hardened_malloc"
                 # dont include experimental features
                 "experimental"
+                # this is non-functional on nix for some reason
+                "tuwunel_mods"
             ];
         };
-        hmalloc = scopeHost.main.override { features = ["hardened_malloc"]; };
 
         oci-image = scopeHost.oci-image;
         oci-image-all-features = scopeHost.oci-image.override {
           main = scopeHost.main.override {
             all_features = true;
             disable_features = [
-                # this is non-functional on nix for some reason
-                "hardened_malloc"
                 # dont include experimental features
                 "experimental"
+                # jemalloc profiling/stats features are expensive and shouldn't
+                # be expected on non-debug builds.
+                "jemalloc_prof"
+                "jemalloc_stats"
+                # tuwunel_mods is a development-only hot reload feature
+                "tuwunel_mods"
             ];
           };
         };
@@ -207,23 +279,20 @@
             # debug build users expect full logs
             disable_release_max_log_level = true;
             disable_features = [
-                # this is non-functional on nix for some reason
-                "hardened_malloc"
                 # dont include experimental features
                 "experimental"
+                # tuwunel_mods is a development-only hot reload feature
+                "tuwunel_mods"
             ];
           };
         };
-        oci-image-hmalloc = scopeHost.oci-image.override {
-          main = scopeHost.main.override {
-            features = ["hardened_malloc"];
-          };
-        };
 
         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
@@ -232,14 +301,7 @@
             (crossSystem:
               let
                 binaryName = "static-${crossSystem}";
-                pkgsCrossStatic =
-                  (import inputs.nixpkgs {
-                    inherit system;
-                    crossSystem = {
-                      config = crossSystem;
-                    };
-                  }).pkgsStatic;
-                scopeCrossStatic = mkScope pkgsCrossStatic;
+                scopeCrossStatic = mkCrossScope crossSystem;
               in
               [
                 # An output for a statically-linked binary
@@ -248,6 +310,15 @@
                   value = scopeCrossStatic.main;
                 }
 
+                # An output for a statically-linked binary with x86_64 haswell
+                # target optimisations
+                {
+                  name = "${binaryName}-x86_64-haswell-optimised";
+                  value = scopeCrossStatic.main.override {
+                    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";
@@ -265,6 +336,12 @@
                   value = scopeCrossStatic.main.override {
                     profile = "test";
                     disable_release_max_log_level = true;
+                    disable_features = [
+                        # dont include experimental features
+                        "experimental"
+                        # tuwunel_mods is a development-only hot reload feature
+                        "tuwunel_mods"
+                    ];
                   };
                 }
 
@@ -274,14 +351,38 @@
                   value = scopeCrossStatic.main.override {
                     all_features = true;
                     disable_features = [
-                        # this is non-functional on nix for some reason
-                        "hardened_malloc"
                         # dont include experimental features
                         "experimental"
+                        # jemalloc profiling/stats features are expensive and shouldn't
+                        # be expected on non-debug builds.
+                        "jemalloc_prof"
+                        "jemalloc_stats"
+                        # tuwunel_mods is a development-only hot reload feature
+                        "tuwunel_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"
+                        # tuwunel_mods is a development-only hot reload feature
+                        "tuwunel_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";
@@ -291,28 +392,31 @@
                     # debug build users expect full logs
                     disable_release_max_log_level = true;
                     disable_features = [
-                        # this is non-functional on nix for some reason
-                        "hardened_malloc"
                         # dont include experimental features
                         "experimental"
+                        # tuwunel_mods is a development-only hot reload feature
+                        "tuwunel_mods"
                     ];
                   };
                 }
 
-                # An output for a statically-linked binary with hardened_malloc
-                {
-                  name = "${binaryName}-hmalloc";
-                  value = scopeCrossStatic.main.override {
-                    features = ["hardened_malloc"];
-                  };
-                }
-
                 # An output for an OCI image based on that binary
                 {
                   name = "oci-image-${crossSystem}";
                   value = scopeCrossStatic.oci-image;
                 }
 
+                # An output for an OCI image based on that binary with x86_64 haswell
+                # target optimisations
+                {
+                  name = "oci-image-${crossSystem}-x86_64-haswell-optimised";
+                  value = scopeCrossStatic.oci-image.override {
+                    main = scopeCrossStatic.main.override {
+                      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";
@@ -332,48 +436,73 @@
                     main = scopeCrossStatic.main.override {
                       all_features = true;
                       disable_features = [
-                          # this is non-functional on nix for some reason
-                          "hardened_malloc"
-                          # dont include experimental features
-                          "experimental"
+                        # dont include experimental features
+                        "experimental"
+                        # jemalloc profiling/stats features are expensive and shouldn't
+                        # be expected on non-debug builds.
+                        "jemalloc_prof"
+                        "jemalloc_stats"
+                        # tuwunel_mods is a development-only hot reload feature
+                        "tuwunel_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"
+                        # tuwunel_mods is a development-only hot reload feature
+                        "tuwunel_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 = [
-                            # this is non-functional on nix for some reason
-                            "hardened_malloc"
-                            # dont include experimental features
-                            "experimental"
-                        ];
+                      profile = "dev";
+                      all_features = true;
+                      # debug build users expect full logs
+                      disable_release_max_log_level = true;
+                      disable_features = [
+                        # dont include experimental features
+                        "experimental"
+                        # tuwunel_mods is a development-only hot reload feature
+                        "tuwunel_mods"
+                      ];
                     };
                   };
                 }
 
-                # An output for an OCI image based on that binary with hardened_malloc
+                # An output for a complement OCI image for the specified platform
                 {
-                  name = "oci-image-${crossSystem}-hmalloc";
-                  value = scopeCrossStatic.oci-image.override {
-                    main = scopeCrossStatic.main.override {
-                      features = ["hardened_malloc"];
-                    };
-                  };
+                  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"
             ]
           )
         );
@@ -384,10 +513,14 @@
           main = prev.main.override {
             all_features = true;
             disable_features = [
-                # this is non-functional on nix for some reason
-                "hardened_malloc"
                 # dont include experimental features
                 "experimental"
+                # jemalloc profiling/stats features are expensive and shouldn't
+                # be expected on non-debug builds.
+                "jemalloc_prof"
+                "jemalloc_stats"
+                # tuwunel_mods is a development-only hot reload feature
+                "tuwunel_mods"
             ];
         };
         }));

nix/pkgs/book/default.nix

@@ -13,12 +13,16 @@ stdenv.mkDerivation {
     root = inputs.self;
     include = [
       "book.toml"
-      "conduwuit-example.toml"
+      "tuwunel-example.toml"
+      "CODE_OF_CONDUCT.md"
       "CONTRIBUTING.md"
       "README.md"
-      "debian/conduwuit.service"
+      "development.md"
+      "debian/tuwunel.service"
       "debian/README.md"
-      "arch/conduwuit.service"
+      "arch/tuwunel.service"
+      "rpm/tuwunel.service"
+      "rpm/README.md"
       "docs"
       "theme"
     ];