Compare commits
No commits in common. "main" and "phonemain" have entirely different histories.
926 changed files with 24587 additions and 116482 deletions
|
|
@ -1,27 +0,0 @@
|
||||||
[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)
|
|
||||||
|
|
@ -1,2 +0,0 @@
|
||||||
[alias]
|
|
||||||
xtask = "run --package xtask --"
|
|
||||||
|
|
@ -1,28 +1,9 @@
|
||||||
# Local build and dev artifacts
|
servers
|
||||||
target/
|
compose.yml
|
||||||
!target/debug/conduwuit
|
node_modules
|
||||||
|
|
||||||
# Docker files
|
|
||||||
Dockerfile*
|
|
||||||
|
|
||||||
# IDE files
|
|
||||||
.vscode
|
|
||||||
.idea
|
|
||||||
*.iml
|
|
||||||
|
|
||||||
# Git folder
|
|
||||||
# .git
|
|
||||||
.gitea
|
|
||||||
.gitlab
|
|
||||||
.github
|
|
||||||
.forgejo
|
|
||||||
|
|
||||||
# Dot files
|
|
||||||
.env
|
|
||||||
.gitignore
|
.gitignore
|
||||||
|
Dockerfile
|
||||||
# Toml files
|
.svelte-kit
|
||||||
rustfmt.toml
|
build
|
||||||
|
output
|
||||||
# Documentation
|
.git
|
||||||
#*.md
|
|
||||||
|
|
@ -1,32 +1,6 @@
|
||||||
# EditorConfig is awesome: https://EditorConfig.org
|
|
||||||
|
|
||||||
root = true
|
root = true
|
||||||
|
[*.{js,ts,svelte}]
|
||||||
[*]
|
|
||||||
charset = utf-8
|
charset = utf-8
|
||||||
end_of_line = lf
|
|
||||||
tab_width = 4
|
|
||||||
indent_size = 4
|
|
||||||
indent_style = space
|
|
||||||
insert_final_newline = true
|
|
||||||
max_line_length = 120
|
|
||||||
|
|
||||||
[*.{md,txt}]
|
|
||||||
indent_style = space
|
|
||||||
indent_size = 4
|
|
||||||
max_line_length = 80
|
|
||||||
|
|
||||||
[*.nix]
|
|
||||||
indent_size = 2
|
|
||||||
|
|
||||||
[*.rs]
|
|
||||||
indent_style = tab
|
|
||||||
max_line_length = 98
|
|
||||||
|
|
||||||
[*.yml]
|
|
||||||
indent_size = 2
|
|
||||||
indent_style = space
|
|
||||||
|
|
||||||
[*.json]
|
|
||||||
indent_size = 4
|
|
||||||
indent_style = space
|
indent_style = space
|
||||||
|
indent_size = 4
|
||||||
9
.envrc
9
.envrc
|
|
@ -1,9 +0,0 @@
|
||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
dotenv_if_exists
|
|
||||||
|
|
||||||
if [ -f /etc/os-release ] && grep -q '^ID=nixos' /etc/os-release; then
|
|
||||||
use flake ".#${DIRENV_DEVSHELL:-default}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
PATH_add bin
|
|
||||||
|
|
@ -1,110 +0,0 @@
|
||||||
name: create-manifest
|
|
||||||
description: |
|
|
||||||
Create and push a multi-platform Docker manifest from individual platform digests.
|
|
||||||
Handles downloading digests, creating manifest lists, and pushing to registry.
|
|
||||||
|
|
||||||
inputs:
|
|
||||||
digest_pattern:
|
|
||||||
description: Glob pattern to match digest artifacts (e.g. "digests-linux-{amd64,arm64}")
|
|
||||||
required: true
|
|
||||||
tag_suffix:
|
|
||||||
description: Suffix to add to all Docker tags (e.g. "-maxperf")
|
|
||||||
required: false
|
|
||||||
default: ""
|
|
||||||
images:
|
|
||||||
description: Container registry images (newline-separated)
|
|
||||||
required: true
|
|
||||||
registry_user:
|
|
||||||
description: Registry username for authentication
|
|
||||||
required: false
|
|
||||||
registry_password:
|
|
||||||
description: Registry password for authentication
|
|
||||||
required: false
|
|
||||||
|
|
||||||
outputs:
|
|
||||||
version:
|
|
||||||
description: The version tag created for the manifest
|
|
||||||
value: ${{ steps.meta.outputs.version }}
|
|
||||||
tags:
|
|
||||||
description: All tags created for the manifest
|
|
||||||
value: ${{ steps.meta.outputs.tags }}
|
|
||||||
|
|
||||||
runs:
|
|
||||||
using: composite
|
|
||||||
steps:
|
|
||||||
- run: mkdir -p digests
|
|
||||||
shell: bash
|
|
||||||
- name: Download digests
|
|
||||||
if: ${{ env.BUILTIN_REGISTRY_ENABLED == 'true' }}
|
|
||||||
uses: forgejo/download-artifact@v4
|
|
||||||
with:
|
|
||||||
path: digests
|
|
||||||
pattern: ${{ inputs.digest_pattern }}
|
|
||||||
merge-multiple: true
|
|
||||||
|
|
||||||
- name: Login to builtin registry
|
|
||||||
if: ${{ env.BUILTIN_REGISTRY_ENABLED == 'true' }}
|
|
||||||
uses: docker/login-action@v4
|
|
||||||
with:
|
|
||||||
registry: ${{ env.BUILTIN_REGISTRY }}
|
|
||||||
username: ${{ inputs.registry_user }}
|
|
||||||
password: ${{ inputs.registry_password }}
|
|
||||||
|
|
||||||
- name: Set up Docker Buildx
|
|
||||||
if: ${{ env.BUILTIN_REGISTRY_ENABLED == 'true' }}
|
|
||||||
uses: docker/setup-buildx-action@v4
|
|
||||||
with:
|
|
||||||
# Use persistent BuildKit if BUILDKIT_ENDPOINT is set (e.g. tcp://buildkit:8125)
|
|
||||||
driver: ${{ env.BUILDKIT_ENDPOINT != '' && 'remote' || 'docker-container' }}
|
|
||||||
endpoint: ${{ env.BUILDKIT_ENDPOINT || '' }}
|
|
||||||
|
|
||||||
- name: Extract metadata (tags) for Docker
|
|
||||||
if: ${{ env.BUILTIN_REGISTRY_ENABLED == 'true' }}
|
|
||||||
id: meta
|
|
||||||
uses: docker/metadata-action@v6
|
|
||||||
with:
|
|
||||||
flavor: |
|
|
||||||
latest=auto
|
|
||||||
suffix=${{ inputs.tag_suffix }},onlatest=true
|
|
||||||
tags: |
|
|
||||||
type=semver,pattern={{version}},prefix=v
|
|
||||||
type=semver,pattern={{major}}.{{minor}},enable=${{ !startsWith(github.ref, 'refs/tags/v0.0.') }},prefix=v
|
|
||||||
type=semver,pattern={{major}},enable=${{ !startsWith(github.ref, 'refs/tags/v0.') }},prefix=v
|
|
||||||
type=ref,event=branch,prefix=${{ format('refs/heads/{0}', github.event.repository.default_branch) != github.ref && 'branch-' || '' }},
|
|
||||||
type=ref,event=pr
|
|
||||||
type=sha,format=short
|
|
||||||
images: ${{ inputs.images }}
|
|
||||||
# default labels & annotations: https://github.com/docker/metadata-action/blob/master/src/meta.ts#L509
|
|
||||||
env:
|
|
||||||
DOCKER_METADATA_ANNOTATIONS_LEVELS: index
|
|
||||||
|
|
||||||
- name: Create manifest list and push
|
|
||||||
if: ${{ env.BUILTIN_REGISTRY_ENABLED == 'true' }}
|
|
||||||
working-directory: digests
|
|
||||||
shell: bash
|
|
||||||
env:
|
|
||||||
IMAGES: ${{ inputs.images }}
|
|
||||||
run: |
|
|
||||||
set -o xtrace
|
|
||||||
IFS=$'\n'
|
|
||||||
IMAGES_LIST=($IMAGES)
|
|
||||||
ANNOTATIONS_LIST=($DOCKER_METADATA_OUTPUT_ANNOTATIONS)
|
|
||||||
TAGS_LIST=($DOCKER_METADATA_OUTPUT_TAGS)
|
|
||||||
for REPO in "${IMAGES_LIST[@]}"; do
|
|
||||||
docker buildx imagetools create \
|
|
||||||
$(for tag in "${TAGS_LIST[@]}"; do echo "--tag"; echo "$tag"; done) \
|
|
||||||
$(for annotation in "${ANNOTATIONS_LIST[@]}"; do echo "--annotation"; echo "$annotation"; done) \
|
|
||||||
$(for reference in *; do printf "$REPO@sha256:%s\n" $reference; done)
|
|
||||||
done
|
|
||||||
|
|
||||||
- name: Inspect image
|
|
||||||
if: ${{ env.BUILTIN_REGISTRY_ENABLED == 'true' }}
|
|
||||||
shell: bash
|
|
||||||
env:
|
|
||||||
IMAGES: ${{ inputs.images }}
|
|
||||||
run: |
|
|
||||||
set -o xtrace
|
|
||||||
IMAGES_LIST=($IMAGES)
|
|
||||||
for REPO in "${IMAGES_LIST[@]}"; do
|
|
||||||
docker buildx imagetools inspect $REPO:${{ steps.meta.outputs.version }}
|
|
||||||
done
|
|
||||||
|
|
@ -1,169 +0,0 @@
|
||||||
name: prepare-docker-build
|
|
||||||
description: |
|
|
||||||
Prepare the Docker build environment for Continuwuity builds.
|
|
||||||
Sets up Rust toolchain, Docker Buildx, caching, and extracts metadata for Docker builds.
|
|
||||||
|
|
||||||
inputs:
|
|
||||||
platform:
|
|
||||||
description: Target platform (e.g. linux/amd64, linux/arm64)
|
|
||||||
required: true
|
|
||||||
slug:
|
|
||||||
description: Platform slug for artifact naming (e.g. linux-amd64, linux-arm64)
|
|
||||||
required: true
|
|
||||||
target_cpu:
|
|
||||||
description: Target CPU architecture (e.g. haswell, empty for base)
|
|
||||||
required: false
|
|
||||||
default: ""
|
|
||||||
profile:
|
|
||||||
description: Cargo build profile (release or release-max-perf)
|
|
||||||
required: true
|
|
||||||
images:
|
|
||||||
description: Container registry images (newline-separated)
|
|
||||||
required: true
|
|
||||||
registry_user:
|
|
||||||
description: Registry username for authentication
|
|
||||||
required: false
|
|
||||||
registry_password:
|
|
||||||
description: Registry password for authentication
|
|
||||||
required: false
|
|
||||||
|
|
||||||
outputs:
|
|
||||||
cpu_suffix:
|
|
||||||
description: CPU suffix for artifact naming
|
|
||||||
value: ${{ steps.cpu-suffix.outputs.suffix }}
|
|
||||||
metadata_labels:
|
|
||||||
description: Docker labels for the image
|
|
||||||
value: ${{ steps.meta.outputs.labels }}
|
|
||||||
metadata_annotations:
|
|
||||||
description: Docker annotations for the image
|
|
||||||
value: ${{ steps.meta.outputs.annotations }}
|
|
||||||
|
|
||||||
runs:
|
|
||||||
using: composite
|
|
||||||
steps:
|
|
||||||
- name: Set CPU suffix variable
|
|
||||||
id: cpu-suffix
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
if [[ -n "${{ inputs.target_cpu }}" ]]; then
|
|
||||||
echo "suffix=-${{ inputs.target_cpu }}" >> $GITHUB_OUTPUT
|
|
||||||
echo "CPU_SUFFIX=-${{ inputs.target_cpu }}" >> $GITHUB_ENV
|
|
||||||
else
|
|
||||||
echo "suffix=" >> $GITHUB_OUTPUT
|
|
||||||
echo "CPU_SUFFIX=" >> $GITHUB_ENV
|
|
||||||
fi
|
|
||||||
|
|
||||||
- name: Echo matrix configuration
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
echo "Platform: ${{ inputs.platform }}"
|
|
||||||
echo "Slug: ${{ inputs.slug }}"
|
|
||||||
echo "Target CPU: ${{ inputs.target_cpu }}"
|
|
||||||
echo "Profile: ${{ inputs.profile }}"
|
|
||||||
|
|
||||||
- name: Install rust
|
|
||||||
if: ${{ env.BUILDKIT_ENDPOINT == '' }}
|
|
||||||
id: rust-toolchain
|
|
||||||
uses: ./.forgejo/actions/rust-toolchain
|
|
||||||
|
|
||||||
- name: Set up Docker Buildx
|
|
||||||
uses: docker/setup-buildx-action@v4
|
|
||||||
with:
|
|
||||||
# Use persistent BuildKit if BUILDKIT_ENDPOINT is set (e.g. tcp://buildkit:8125)
|
|
||||||
driver: ${{ env.BUILDKIT_ENDPOINT != '' && 'remote' || 'docker-container' }}
|
|
||||||
endpoint: ${{ env.BUILDKIT_ENDPOINT || '' }}
|
|
||||||
|
|
||||||
- name: Set up QEMU
|
|
||||||
if: ${{ env.BUILDKIT_ENDPOINT == '' }}
|
|
||||||
uses: docker/setup-qemu-action@v3
|
|
||||||
|
|
||||||
- name: Login to builtin registry
|
|
||||||
if: ${{ env.BUILTIN_REGISTRY_ENABLED == 'true' }}
|
|
||||||
uses: docker/login-action@v4
|
|
||||||
with:
|
|
||||||
registry: ${{ env.BUILTIN_REGISTRY }}
|
|
||||||
username: ${{ inputs.registry_user }}
|
|
||||||
password: ${{ inputs.registry_password }}
|
|
||||||
|
|
||||||
- name: Extract metadata (labels, annotations) for Docker
|
|
||||||
id: meta
|
|
||||||
uses: docker/metadata-action@v6
|
|
||||||
with:
|
|
||||||
images: ${{ inputs.images }}
|
|
||||||
# default labels & annotations: https://github.com/docker/metadata-action/blob/master/src/meta.ts#L509
|
|
||||||
env:
|
|
||||||
DOCKER_METADATA_ANNOTATIONS_LEVELS: manifest,index
|
|
||||||
|
|
||||||
- name: Get short git commit SHA
|
|
||||||
id: sha
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
calculatedSha=$(git rev-parse --short ${{ github.sha }})
|
|
||||||
echo "COMMIT_SHORT_SHA=$calculatedSha" >> $GITHUB_ENV
|
|
||||||
echo "Short SHA: $calculatedSha"
|
|
||||||
|
|
||||||
- name: Get Git commit timestamps
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
timestamp=$(git log -1 --pretty=%ct)
|
|
||||||
echo "TIMESTAMP=$timestamp" >> $GITHUB_ENV
|
|
||||||
echo "Commit timestamp: $timestamp"
|
|
||||||
|
|
||||||
- uses: ./.forgejo/actions/timelord
|
|
||||||
id: timelord
|
|
||||||
|
|
||||||
- name: Cache Rust registry
|
|
||||||
if: ${{ env.BUILDKIT_ENDPOINT == '' }}
|
|
||||||
uses: actions/cache@v3
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
.cargo/git
|
|
||||||
.cargo/git/checkouts
|
|
||||||
.cargo/registry
|
|
||||||
.cargo/registry/src
|
|
||||||
key: continuwuity-rust-registry-image-${{hashFiles('**/Cargo.lock') }}
|
|
||||||
|
|
||||||
- name: Cache cargo target
|
|
||||||
if: ${{ env.BUILDKIT_ENDPOINT == '' }}
|
|
||||||
id: cache-cargo-target
|
|
||||||
uses: actions/cache@v3
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
cargo-target${{ env.CPU_SUFFIX }}-${{ inputs.slug }}-${{ inputs.profile }}
|
|
||||||
key: continuwuity-cargo-target${{ env.CPU_SUFFIX }}-${{ inputs.slug }}-${{ inputs.profile }}-${{hashFiles('**/Cargo.lock') }}-${{steps.rust-toolchain.outputs.rustc_version}}
|
|
||||||
|
|
||||||
- name: Cache apt cache
|
|
||||||
if: ${{ env.BUILDKIT_ENDPOINT == '' }}
|
|
||||||
id: cache-apt
|
|
||||||
uses: actions/cache@v3
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
var-cache-apt-${{ inputs.slug }}
|
|
||||||
key: continuwuity-var-cache-apt-${{ inputs.slug }}
|
|
||||||
|
|
||||||
- name: Cache apt lib
|
|
||||||
if: ${{ env.BUILDKIT_ENDPOINT == '' }}
|
|
||||||
id: cache-apt-lib
|
|
||||||
uses: actions/cache@v3
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
var-lib-apt-${{ inputs.slug }}
|
|
||||||
key: continuwuity-var-lib-apt-${{ inputs.slug }}
|
|
||||||
|
|
||||||
- name: inject cache into docker
|
|
||||||
if: ${{ env.BUILDKIT_ENDPOINT == '' }}
|
|
||||||
uses: https://github.com/reproducible-containers/buildkit-cache-dance@v3.3.2
|
|
||||||
with:
|
|
||||||
cache-map: |
|
|
||||||
{
|
|
||||||
".cargo/registry": "/usr/local/cargo/registry",
|
|
||||||
".cargo/git/db": "/usr/local/cargo/git/db",
|
|
||||||
"cargo-target${{ env.CPU_SUFFIX }}-${{ inputs.slug }}-${{ inputs.profile }}": {
|
|
||||||
"target": "/app/target",
|
|
||||||
"id": "cargo-target${{ env.CPU_SUFFIX }}-${{ inputs.slug }}-${{ inputs.profile }}"
|
|
||||||
},
|
|
||||||
"var-cache-apt-${{ inputs.slug }}": "/var/cache/apt",
|
|
||||||
"var-lib-apt-${{ inputs.slug }}": "/var/lib/apt",
|
|
||||||
"${{ steps.timelord.outputs.database-path }}":"/timelord"
|
|
||||||
}
|
|
||||||
skip-extraction: ${{ steps.cache.outputs.cache-hit }}
|
|
||||||
|
|
@ -1,63 +0,0 @@
|
||||||
name: rust-toolchain
|
|
||||||
description: |
|
|
||||||
Install a Rust toolchain using rustup.
|
|
||||||
See https://rust-lang.github.io/rustup/concepts/toolchains.html#toolchain-specification
|
|
||||||
for more information about toolchains.
|
|
||||||
inputs:
|
|
||||||
toolchain:
|
|
||||||
description: |
|
|
||||||
Rust toolchain name.
|
|
||||||
See https://rust-lang.github.io/rustup/concepts/toolchains.html#toolchain-specification
|
|
||||||
required: false
|
|
||||||
target:
|
|
||||||
description: Target triple to install for this toolchain
|
|
||||||
required: false
|
|
||||||
components:
|
|
||||||
description: Space-separated list of components to be additionally installed for a new toolchain
|
|
||||||
required: false
|
|
||||||
outputs:
|
|
||||||
rustc_version:
|
|
||||||
description: The rustc version installed
|
|
||||||
value: ${{ steps.rustc-version.outputs.version }}
|
|
||||||
rustup_version:
|
|
||||||
description: The rustup version installed
|
|
||||||
value: ${{ steps.rustup-version.outputs.version }}
|
|
||||||
|
|
||||||
runs:
|
|
||||||
using: composite
|
|
||||||
steps:
|
|
||||||
- name: Check if rustup is already installed
|
|
||||||
shell: bash
|
|
||||||
id: rustup-version
|
|
||||||
run: |
|
|
||||||
echo "version=$(rustup --version)" >> $GITHUB_OUTPUT
|
|
||||||
- name: Cache rustup toolchains
|
|
||||||
if: steps.rustup-version.outputs.version == ''
|
|
||||||
uses: actions/cache@v3
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
~/.rustup
|
|
||||||
!~/.rustup/tmp
|
|
||||||
!~/.rustup/downloads
|
|
||||||
# Requires repo to be cloned if toolchain is not specified
|
|
||||||
key: continuwuity-${{ runner.os }}-rustup-${{ inputs.toolchain || hashFiles('**/rust-toolchain.toml') }}
|
|
||||||
- name: Install Rust toolchain
|
|
||||||
if: steps.rustup-version.outputs.version == ''
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
if ! command -v rustup &> /dev/null ; then
|
|
||||||
curl --proto '=https' --tlsv1.2 --retry 10 --retry-connrefused -fsSL "https://sh.rustup.rs" | sh -s -- --default-toolchain none -y
|
|
||||||
echo "${CARGO_HOME:-$HOME/.cargo}/bin" >> $GITHUB_PATH
|
|
||||||
fi
|
|
||||||
- shell: bash
|
|
||||||
run: |
|
|
||||||
set -x
|
|
||||||
${{ inputs.toolchain && format('rustup override set {0}', inputs.toolchain) }}
|
|
||||||
${{ inputs.target && format('rustup target add {0}', inputs.target) }}
|
|
||||||
${{ inputs.components && format('rustup component add {0}', inputs.components) }}
|
|
||||||
cargo --version
|
|
||||||
rustc --version
|
|
||||||
- id: rustc-version
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
echo "version=$(rustc --version)" >> $GITHUB_OUTPUT
|
|
||||||
|
|
@ -1,23 +0,0 @@
|
||||||
name: sccache
|
|
||||||
description: |
|
|
||||||
Install sccache for caching builds in GitHub Actions.
|
|
||||||
|
|
||||||
|
|
||||||
runs:
|
|
||||||
using: composite
|
|
||||||
steps:
|
|
||||||
- name: Install sccache
|
|
||||||
uses: https://git.tomfos.tr/tom/sccache-action@v1
|
|
||||||
- name: Configure sccache
|
|
||||||
uses: https://github.com/actions/github-script@v8
|
|
||||||
with:
|
|
||||||
script: |
|
|
||||||
core.exportVariable('ACTIONS_RESULTS_URL', process.env.ACTIONS_RESULTS_URL || '');
|
|
||||||
core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');
|
|
||||||
- shell: bash
|
|
||||||
run: |
|
|
||||||
echo "SCCACHE_GHA_ENABLED=true" >> $GITHUB_ENV
|
|
||||||
echo "RUSTC_WRAPPER=sccache" >> $GITHUB_ENV
|
|
||||||
echo "CMAKE_C_COMPILER_LAUNCHER=sccache" >> $GITHUB_ENV
|
|
||||||
echo "CMAKE_CXX_COMPILER_LAUNCHER=sccache" >> $GITHUB_ENV
|
|
||||||
echo "CMAKE_CUDA_COMPILER_LAUNCHER=sccache" >> $GITHUB_ENV
|
|
||||||
|
|
@ -1,167 +0,0 @@
|
||||||
name: setup-llvm-with-apt
|
|
||||||
description: |
|
|
||||||
Set up LLVM toolchain with APT package management and smart caching.
|
|
||||||
Supports cross-compilation architectures and additional package installation.
|
|
||||||
|
|
||||||
Creates symlinks in /usr/bin: clang, clang++, lld, llvm-ar, llvm-ranlib
|
|
||||||
|
|
||||||
inputs:
|
|
||||||
dpkg-arch:
|
|
||||||
description: 'Debian architecture for cross-compilation (e.g. arm64)'
|
|
||||||
required: false
|
|
||||||
default: ''
|
|
||||||
extra-packages:
|
|
||||||
description: 'Additional APT packages to install (space-separated)'
|
|
||||||
required: false
|
|
||||||
default: ''
|
|
||||||
llvm-version:
|
|
||||||
description: 'LLVM version to install'
|
|
||||||
required: false
|
|
||||||
default: '20'
|
|
||||||
|
|
||||||
outputs:
|
|
||||||
llvm-version:
|
|
||||||
description: 'Installed LLVM version'
|
|
||||||
value: ${{ steps.configure.outputs.version }}
|
|
||||||
|
|
||||||
runs:
|
|
||||||
using: composite
|
|
||||||
steps:
|
|
||||||
- name: Detect runner OS
|
|
||||||
id: runner-os
|
|
||||||
uses: https://git.tomfos.tr/actions/detect-versions@v1
|
|
||||||
|
|
||||||
- name: Configure cross-compilation architecture
|
|
||||||
if: inputs.dpkg-arch != ''
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
echo "🏗️ Adding ${{ inputs.dpkg-arch }} architecture"
|
|
||||||
sudo dpkg --add-architecture ${{ inputs.dpkg-arch }}
|
|
||||||
|
|
||||||
# Restrict default sources to amd64
|
|
||||||
sudo sed -i 's/^deb http/deb [arch=amd64] http/g' /etc/apt/sources.list
|
|
||||||
sudo sed -i 's/^deb https/deb [arch=amd64] https/g' /etc/apt/sources.list
|
|
||||||
|
|
||||||
# Add ports sources for foreign architecture
|
|
||||||
sudo tee /etc/apt/sources.list.d/${{ inputs.dpkg-arch }}.list > /dev/null <<EOF
|
|
||||||
deb [arch=${{ inputs.dpkg-arch }}] http://ports.ubuntu.com/ubuntu-ports/ jammy main restricted universe multiverse
|
|
||||||
deb [arch=${{ inputs.dpkg-arch }}] http://ports.ubuntu.com/ubuntu-ports/ jammy-updates main restricted universe multiverse
|
|
||||||
deb [arch=${{ inputs.dpkg-arch }}] http://ports.ubuntu.com/ubuntu-ports/ jammy-security main restricted universe multiverse
|
|
||||||
EOF
|
|
||||||
|
|
||||||
echo "✅ Architecture ${{ inputs.dpkg-arch }} configured"
|
|
||||||
|
|
||||||
- name: Start LLVM cache group
|
|
||||||
shell: bash
|
|
||||||
run: echo "::group::📦 Restoring LLVM cache"
|
|
||||||
|
|
||||||
- name: Check for LLVM cache
|
|
||||||
id: cache
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
/usr/bin/clang-*
|
|
||||||
/usr/bin/clang++-*
|
|
||||||
/usr/bin/lld-*
|
|
||||||
/usr/bin/llvm-*
|
|
||||||
/usr/lib/llvm-*/
|
|
||||||
/usr/lib/x86_64-linux-gnu/libLLVM*.so*
|
|
||||||
/usr/lib/x86_64-linux-gnu/libclang*.so*
|
|
||||||
/etc/apt/sources.list.d/archive_uri-*
|
|
||||||
/etc/apt/trusted.gpg.d/apt.llvm.org.asc
|
|
||||||
key: continuwuity-llvm-${{ steps.runner-os.outputs.slug }}-${{ steps.runner-os.outputs.arch }}-v${{ inputs.llvm-version }}-${{ hashFiles('**/Cargo.lock', 'rust-toolchain.toml') }}
|
|
||||||
|
|
||||||
- name: End LLVM cache group
|
|
||||||
shell: bash
|
|
||||||
run: echo "::endgroup::"
|
|
||||||
|
|
||||||
- name: Check and install LLVM if needed
|
|
||||||
id: llvm-setup
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
echo "🔍 Checking for LLVM ${{ inputs.llvm-version }}..."
|
|
||||||
|
|
||||||
# Check both binaries and libraries exist
|
|
||||||
if [ -f "/usr/bin/clang-${{ inputs.llvm-version }}" ] && \
|
|
||||||
[ -f "/usr/bin/clang++-${{ inputs.llvm-version }}" ] && \
|
|
||||||
[ -f "/usr/bin/lld-${{ inputs.llvm-version }}" ] && \
|
|
||||||
([ -f "/usr/lib/x86_64-linux-gnu/libLLVM.so.${{ inputs.llvm-version }}.1" ] || \
|
|
||||||
[ -f "/usr/lib/x86_64-linux-gnu/libLLVM-${{ inputs.llvm-version }}.so.1" ] || \
|
|
||||||
[ -f "/usr/lib/llvm-${{ inputs.llvm-version }}/lib/libLLVM.so" ]); then
|
|
||||||
echo "✅ LLVM ${{ inputs.llvm-version }} found and verified"
|
|
||||||
echo "needs-install=false" >> $GITHUB_OUTPUT
|
|
||||||
else
|
|
||||||
echo "📦 LLVM ${{ inputs.llvm-version }} not found or incomplete - installing..."
|
|
||||||
|
|
||||||
echo "::group::🔧 Installing LLVM ${{ inputs.llvm-version }}"
|
|
||||||
wget -O - https://apt.llvm.org/llvm.sh | bash -s -- ${{ inputs.llvm-version }}
|
|
||||||
echo "::endgroup::"
|
|
||||||
|
|
||||||
if [ ! -f "/usr/bin/clang-${{ inputs.llvm-version }}" ]; then
|
|
||||||
echo "❌ Failed to install LLVM ${{ inputs.llvm-version }}"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "✅ Installed LLVM ${{ inputs.llvm-version }}"
|
|
||||||
echo "needs-install=true" >> $GITHUB_OUTPUT
|
|
||||||
fi
|
|
||||||
|
|
||||||
- name: Prepare for additional packages
|
|
||||||
if: inputs.extra-packages != ''
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
# Update APT if LLVM was cached (installer script already does apt-get update)
|
|
||||||
if [[ "${{ steps.llvm-setup.outputs.needs-install }}" != "true" ]]; then
|
|
||||||
echo "::group::📦 Running apt-get update (LLVM cached, extra packages needed)"
|
|
||||||
sudo apt-get update
|
|
||||||
echo "::endgroup::"
|
|
||||||
fi
|
|
||||||
echo "::group::📦 Installing additional packages"
|
|
||||||
|
|
||||||
- name: Install additional packages
|
|
||||||
if: inputs.extra-packages != ''
|
|
||||||
uses: https://github.com/awalsh128/cache-apt-pkgs-action@latest
|
|
||||||
with:
|
|
||||||
packages: ${{ inputs.extra-packages }}
|
|
||||||
version: 1.0
|
|
||||||
|
|
||||||
- name: End package installation group
|
|
||||||
if: inputs.extra-packages != ''
|
|
||||||
shell: bash
|
|
||||||
run: echo "::endgroup::"
|
|
||||||
|
|
||||||
- name: Configure LLVM environment
|
|
||||||
id: configure
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
echo "::group::🔧 Configuring LLVM ${{ inputs.llvm-version }} environment"
|
|
||||||
|
|
||||||
# Create symlinks
|
|
||||||
sudo ln -sf "/usr/bin/clang-${{ inputs.llvm-version }}" /usr/bin/clang
|
|
||||||
sudo ln -sf "/usr/bin/clang++-${{ inputs.llvm-version }}" /usr/bin/clang++
|
|
||||||
sudo ln -sf "/usr/bin/lld-${{ inputs.llvm-version }}" /usr/bin/lld
|
|
||||||
sudo ln -sf "/usr/bin/llvm-ar-${{ inputs.llvm-version }}" /usr/bin/llvm-ar
|
|
||||||
sudo ln -sf "/usr/bin/llvm-ranlib-${{ inputs.llvm-version }}" /usr/bin/llvm-ranlib
|
|
||||||
echo " ✓ Created symlinks"
|
|
||||||
|
|
||||||
# Setup library paths
|
|
||||||
LLVM_LIB_PATH="/usr/lib/llvm-${{ inputs.llvm-version }}/lib"
|
|
||||||
if [ -d "$LLVM_LIB_PATH" ]; then
|
|
||||||
echo "LD_LIBRARY_PATH=${LLVM_LIB_PATH}:${LD_LIBRARY_PATH:-}" >> $GITHUB_ENV
|
|
||||||
echo "LIBCLANG_PATH=${LLVM_LIB_PATH}" >> $GITHUB_ENV
|
|
||||||
|
|
||||||
echo "$LLVM_LIB_PATH" | sudo tee "/etc/ld.so.conf.d/llvm-${{ inputs.llvm-version }}.conf" > /dev/null
|
|
||||||
sudo ldconfig
|
|
||||||
echo " ✓ Configured library paths"
|
|
||||||
else
|
|
||||||
# Fallback to standard library location
|
|
||||||
if [ -d "/usr/lib/x86_64-linux-gnu" ]; then
|
|
||||||
echo "LIBCLANG_PATH=/usr/lib/x86_64-linux-gnu" >> $GITHUB_ENV
|
|
||||||
echo " ✓ Using fallback library path"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Set output
|
|
||||||
echo "version=${{ inputs.llvm-version }}" >> $GITHUB_OUTPUT
|
|
||||||
echo "::endgroup::"
|
|
||||||
echo "✅ LLVM ready: $(clang --version | head -1)"
|
|
||||||
|
|
@ -1,247 +0,0 @@
|
||||||
name: setup-rust
|
|
||||||
description: |
|
|
||||||
Set up Rust toolchain with sccache for compilation caching.
|
|
||||||
Respects rust-toolchain.toml by default or accepts explicit version override.
|
|
||||||
|
|
||||||
inputs:
|
|
||||||
cache-key-suffix:
|
|
||||||
description: 'Optional suffix for cache keys (e.g. platform identifier)'
|
|
||||||
required: false
|
|
||||||
default: ''
|
|
||||||
rust-components:
|
|
||||||
description: 'Additional Rust components to install (space-separated)'
|
|
||||||
required: false
|
|
||||||
default: ''
|
|
||||||
rust-target:
|
|
||||||
description: 'Rust target triple (e.g. x86_64-unknown-linux-gnu)'
|
|
||||||
required: false
|
|
||||||
default: ''
|
|
||||||
rust-version:
|
|
||||||
description: 'Rust version to install (e.g. nightly). Defaults to the version specified in rust-toolchain.toml'
|
|
||||||
required: false
|
|
||||||
default: ''
|
|
||||||
sccache-cache-limit:
|
|
||||||
description: 'Maximum size limit for sccache local cache (e.g. 2G, 500M)'
|
|
||||||
required: false
|
|
||||||
default: '2G'
|
|
||||||
github-token:
|
|
||||||
description: 'GitHub token for downloading sccache from GitHub releases'
|
|
||||||
required: false
|
|
||||||
default: ''
|
|
||||||
|
|
||||||
outputs:
|
|
||||||
rust-version:
|
|
||||||
description: 'Installed Rust version'
|
|
||||||
value: ${{ steps.rust-setup.outputs.version }}
|
|
||||||
|
|
||||||
runs:
|
|
||||||
using: composite
|
|
||||||
steps:
|
|
||||||
- name: Detect runner OS
|
|
||||||
id: runner-os
|
|
||||||
uses: https://git.tomfos.tr/actions/detect-versions@v1
|
|
||||||
|
|
||||||
- name: Configure Cargo environment
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
# Use workspace-relative paths for better control and consistency
|
|
||||||
echo "CARGO_HOME=${{ github.workspace }}/.cargo" >> $GITHUB_ENV
|
|
||||||
echo "CARGO_TARGET_DIR=${{ github.workspace }}/target" >> $GITHUB_ENV
|
|
||||||
echo "SCCACHE_DIR=${{ github.workspace }}/.sccache" >> $GITHUB_ENV
|
|
||||||
echo "RUSTUP_HOME=${{ github.workspace }}/.rustup" >> $GITHUB_ENV
|
|
||||||
|
|
||||||
# Limit binstall resolution timeout to avoid GitHub rate limit delays
|
|
||||||
echo "BINSTALL_MAXIMUM_RESOLUTION_TIMEOUT=10" >> $GITHUB_ENV
|
|
||||||
|
|
||||||
# Ensure directories exist for first run
|
|
||||||
mkdir -p "${{ github.workspace }}/.cargo"
|
|
||||||
mkdir -p "${{ github.workspace }}/.sccache"
|
|
||||||
mkdir -p "${{ github.workspace }}/target"
|
|
||||||
mkdir -p "${{ github.workspace }}/.rustup"
|
|
||||||
|
|
||||||
- name: Start registry/toolchain restore group
|
|
||||||
shell: bash
|
|
||||||
run: echo "::group::📦 Restoring registry and toolchain caches"
|
|
||||||
|
|
||||||
- name: Cache toolchain binaries
|
|
||||||
id: toolchain-cache
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
.cargo/bin
|
|
||||||
.rustup/toolchains
|
|
||||||
.rustup/update-hashes
|
|
||||||
# Shared toolchain cache across all Rust versions
|
|
||||||
key: continuwuity-toolchain-${{ steps.runner-os.outputs.slug }}-${{ steps.runner-os.outputs.arch }}
|
|
||||||
|
|
||||||
- name: Cache Cargo registry and git
|
|
||||||
id: registry-cache
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
.cargo/registry/index
|
|
||||||
.cargo/registry/cache
|
|
||||||
.cargo/git/db
|
|
||||||
# Registry cache saved per workflow, restored from any workflow's cache
|
|
||||||
# Each workflow maintains its own registry that accumulates its needed crates
|
|
||||||
key: continuwuity-cargo-registry-${{ steps.runner-os.outputs.slug }}-${{ steps.runner-os.outputs.arch }}-${{ github.workflow }}
|
|
||||||
restore-keys: |
|
|
||||||
continuwuity-cargo-registry-${{ steps.runner-os.outputs.slug }}-${{ steps.runner-os.outputs.arch }}-
|
|
||||||
|
|
||||||
- name: End registry/toolchain restore group
|
|
||||||
shell: bash
|
|
||||||
run: echo "::endgroup::"
|
|
||||||
|
|
||||||
- name: Setup Rust toolchain
|
|
||||||
shell: bash
|
|
||||||
id: rust-setup
|
|
||||||
run: |
|
|
||||||
# Install rustup if not already cached
|
|
||||||
if ! command -v rustup &> /dev/null; then
|
|
||||||
echo "::group::📦 Installing rustup"
|
|
||||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --no-modify-path --default-toolchain none
|
|
||||||
source "$CARGO_HOME/env"
|
|
||||||
echo "::endgroup::"
|
|
||||||
else
|
|
||||||
echo "✅ rustup already available"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Setup the appropriate Rust version
|
|
||||||
if [[ -n "${{ inputs.rust-version }}" ]]; then
|
|
||||||
echo "::group::📦 Setting up Rust ${{ inputs.rust-version }}"
|
|
||||||
# Set override first to prevent rust-toolchain.toml from auto-installing
|
|
||||||
rustup override set ${{ inputs.rust-version }} 2>/dev/null || true
|
|
||||||
|
|
||||||
# Check if we need to install/update the toolchain
|
|
||||||
if rustup toolchain list | grep -q "^${{ inputs.rust-version }}-"; then
|
|
||||||
rustup update ${{ inputs.rust-version }}
|
|
||||||
else
|
|
||||||
rustup toolchain install ${{ inputs.rust-version }} --profile minimal -c cargo,clippy,rustfmt
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
echo "::group::📦 Setting up Rust from rust-toolchain.toml"
|
|
||||||
rustup show
|
|
||||||
fi
|
|
||||||
|
|
||||||
RUST_VERSION=$(rustc --version | cut -d' ' -f2)
|
|
||||||
echo "version=$RUST_VERSION" >> $GITHUB_OUTPUT
|
|
||||||
|
|
||||||
echo "::endgroup::"
|
|
||||||
|
|
||||||
- name: Install Rust components
|
|
||||||
if: inputs.rust-components != ''
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
echo "📦 Installing components: ${{ inputs.rust-components }}"
|
|
||||||
rustup component add ${{ inputs.rust-components }}
|
|
||||||
|
|
||||||
- name: Install Rust target
|
|
||||||
if: inputs.rust-target != ''
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
echo "📦 Installing target: ${{ inputs.rust-target }}"
|
|
||||||
rustup target add ${{ inputs.rust-target }}
|
|
||||||
|
|
||||||
- name: Start build cache restore group
|
|
||||||
shell: bash
|
|
||||||
run: echo "::group::📦 Restoring build cache"
|
|
||||||
|
|
||||||
- name: Setup sccache
|
|
||||||
uses: https://git.tomfos.tr/tom/sccache-action@v1
|
|
||||||
|
|
||||||
- name: Cache dependencies
|
|
||||||
id: deps-cache
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
target/**/.fingerprint
|
|
||||||
target/**/deps
|
|
||||||
target/**/*.d
|
|
||||||
target/**/.cargo-lock
|
|
||||||
target/**/CACHEDIR.TAG
|
|
||||||
target/**/.rustc_info.json
|
|
||||||
/timelord/
|
|
||||||
# Dependencies cache - based on Cargo.lock, survives source code changes
|
|
||||||
key: >-
|
|
||||||
continuwuity-deps-${{ steps.runner-os.outputs.slug }}-${{ steps.runner-os.outputs.arch }}-${{ steps.rust-setup.outputs.version }}${{ inputs.cache-key-suffix && format('-{0}', inputs.cache-key-suffix) || '' }}-${{ hashFiles('rust-toolchain.toml', '**/Cargo.lock') }}
|
|
||||||
restore-keys: |
|
|
||||||
continuwuity-deps-${{ steps.runner-os.outputs.slug }}-${{ steps.runner-os.outputs.arch }}-${{ steps.rust-setup.outputs.version }}${{ inputs.cache-key-suffix && format('-{0}', inputs.cache-key-suffix) || '' }}-
|
|
||||||
|
|
||||||
- name: Cache incremental compilation
|
|
||||||
id: incremental-cache
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
target/**/incremental
|
|
||||||
# Incremental cache - based on source code changes
|
|
||||||
key: >-
|
|
||||||
continuwuity-incremental-${{ steps.runner-os.outputs.slug }}-${{ steps.runner-os.outputs.arch }}-${{ steps.rust-setup.outputs.version }}${{ inputs.cache-key-suffix && format('-{0}', inputs.cache-key-suffix) || '' }}-${{ hashFiles('rust-toolchain.toml', '**/Cargo.lock') }}-${{ hashFiles('**/*.rs', '**/Cargo.toml') }}
|
|
||||||
restore-keys: |
|
|
||||||
continuwuity-incremental-${{ steps.runner-os.outputs.slug }}-${{ steps.runner-os.outputs.arch }}-${{ steps.rust-setup.outputs.version }}${{ inputs.cache-key-suffix && format('-{0}', inputs.cache-key-suffix) || '' }}-${{ hashFiles('rust-toolchain.toml', '**/Cargo.lock') }}-
|
|
||||||
continuwuity-incremental-${{ steps.runner-os.outputs.slug }}-${{ steps.runner-os.outputs.arch }}-${{ steps.rust-setup.outputs.version }}${{ inputs.cache-key-suffix && format('-{0}', inputs.cache-key-suffix) || '' }}-
|
|
||||||
|
|
||||||
- name: End build cache restore group
|
|
||||||
shell: bash
|
|
||||||
run: echo "::endgroup::"
|
|
||||||
|
|
||||||
- name: Configure PATH and install tools
|
|
||||||
shell: bash
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ inputs.github-token }}
|
|
||||||
run: |
|
|
||||||
# Add .cargo/bin to PATH permanently for all subsequent steps
|
|
||||||
echo "${{ github.workspace }}/.cargo/bin" >> $GITHUB_PATH
|
|
||||||
|
|
||||||
# For this step only, we need to add it to PATH since GITHUB_PATH takes effect in the next step
|
|
||||||
export PATH="${{ github.workspace }}/.cargo/bin:$PATH"
|
|
||||||
|
|
||||||
# Install cargo-binstall for fast binary installations
|
|
||||||
if command -v cargo-binstall &> /dev/null; then
|
|
||||||
echo "✅ cargo-binstall already available"
|
|
||||||
else
|
|
||||||
echo "::group::📦 Installing cargo-binstall"
|
|
||||||
curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
|
|
||||||
echo "::endgroup::"
|
|
||||||
fi
|
|
||||||
|
|
||||||
if command -v prek &> /dev/null; then
|
|
||||||
echo "✅ prek already available"
|
|
||||||
else
|
|
||||||
echo "::group::📦 Installing prek"
|
|
||||||
# prek isn't regularly published to crates.io, so we use git source
|
|
||||||
cargo-binstall -y --no-symlinks --git https://github.com/j178/prek prek
|
|
||||||
echo "::endgroup::"
|
|
||||||
fi
|
|
||||||
|
|
||||||
if command -v timelord &> /dev/null; then
|
|
||||||
echo "✅ timelord already available"
|
|
||||||
else
|
|
||||||
echo "::group::📦 Installing timelord"
|
|
||||||
cargo-binstall -y --no-symlinks timelord-cli
|
|
||||||
echo "::endgroup::"
|
|
||||||
fi
|
|
||||||
|
|
||||||
- name: Configure sccache environment
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
echo "RUSTC_WRAPPER=sccache" >> $GITHUB_ENV
|
|
||||||
echo "CMAKE_C_COMPILER_LAUNCHER=sccache" >> $GITHUB_ENV
|
|
||||||
echo "CMAKE_CXX_COMPILER_LAUNCHER=sccache" >> $GITHUB_ENV
|
|
||||||
echo "CMAKE_CUDA_COMPILER_LAUNCHER=sccache" >> $GITHUB_ENV
|
|
||||||
echo "SCCACHE_GHA_ENABLED=true" >> $GITHUB_ENV
|
|
||||||
|
|
||||||
# Configure incremental compilation GC
|
|
||||||
# If we restored from old cache (partial hit), clean up aggressively
|
|
||||||
if [[ "${{ steps.build-cache.outputs.cache-hit }}" != "true" ]]; then
|
|
||||||
echo "♻️ Partial cache hit - enabling cache cleanup"
|
|
||||||
echo "CARGO_INCREMENTAL_GC_THRESHOLD=5" >> $GITHUB_ENV
|
|
||||||
fi
|
|
||||||
|
|
||||||
- name: Output version and summary
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
echo "📋 Setup complete:"
|
|
||||||
echo " Rust: $(rustc --version)"
|
|
||||||
echo " Cargo: $(cargo --version)"
|
|
||||||
echo " prek: $(prek --version 2>/dev/null || echo 'installed')"
|
|
||||||
echo " timelord: $(timelord --version 2>/dev/null || echo 'installed')"
|
|
||||||
|
|
@ -1,120 +0,0 @@
|
||||||
name: timelord
|
|
||||||
description: |
|
|
||||||
Use timelord to set file timestamps with git-warp-time fallback for cache misses
|
|
||||||
inputs:
|
|
||||||
key:
|
|
||||||
description: |
|
|
||||||
The key to use for caching the timelord data.
|
|
||||||
required: false
|
|
||||||
default: ''
|
|
||||||
path:
|
|
||||||
description: |
|
|
||||||
The path to the directory to be timestamped.
|
|
||||||
required: false
|
|
||||||
default: ''
|
|
||||||
|
|
||||||
outputs:
|
|
||||||
database-path:
|
|
||||||
description: Path to timelord database
|
|
||||||
value: '${{ env.TIMELORD_CACHE_PATH }}'
|
|
||||||
|
|
||||||
runs:
|
|
||||||
using: composite
|
|
||||||
steps:
|
|
||||||
- name: Set defaults
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
echo "TIMELORD_KEY=${{ inputs.key || format('timelord-v1-{0}-{1}', github.repository, hashFiles('**/*.rs', '**/Cargo.toml', '**/Cargo.lock')) }}" >> $GITHUB_ENV
|
|
||||||
echo "TIMELORD_PATH=${{ inputs.path || '.' }}" >> $GITHUB_ENV
|
|
||||||
echo "TIMELORD_CACHE_PATH=$HOME/.cache/timelord" >> $GITHUB_ENV
|
|
||||||
echo "PATH=$HOME/.cargo/bin:/usr/share/rust/.cargo/bin:$PATH" >> $GITHUB_ENV
|
|
||||||
|
|
||||||
- name: Restore binary cache
|
|
||||||
id: binary-cache
|
|
||||||
uses: actions/cache/restore@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
/usr/share/rust/.cargo/bin
|
|
||||||
~/.cargo/bin
|
|
||||||
key: continuwuity-timelord-binaries
|
|
||||||
|
|
||||||
- name: Check if binaries need installation
|
|
||||||
shell: bash
|
|
||||||
id: check-binaries
|
|
||||||
run: |
|
|
||||||
NEED_INSTALL=false
|
|
||||||
|
|
||||||
# Ensure ~/.cargo/bin exists
|
|
||||||
mkdir -p ~/.cargo/bin
|
|
||||||
|
|
||||||
# Check and move timelord if needed
|
|
||||||
if [ -f /usr/share/rust/.cargo/bin/timelord ] && [ ! -f ~/.cargo/bin/timelord ]; then
|
|
||||||
echo "Moving timelord from /usr/share/rust/.cargo/bin to ~/.cargo/bin"
|
|
||||||
mv /usr/share/rust/.cargo/bin/timelord ~/.cargo/bin/
|
|
||||||
fi
|
|
||||||
if [ ! -f ~/.cargo/bin/timelord ]; then
|
|
||||||
echo "timelord-cli not found, needs installation"
|
|
||||||
NEED_INSTALL=true
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Check and move git-warp-time if needed
|
|
||||||
if [ -f /usr/share/rust/.cargo/bin/git-warp-time ] && [ ! -f ~/.cargo/bin/git-warp-time ]; then
|
|
||||||
echo "Moving git-warp-time from /usr/share/rust/.cargo/bin to ~/.cargo/bin"
|
|
||||||
mv /usr/share/rust/.cargo/bin/git-warp-time ~/.cargo/bin/
|
|
||||||
fi
|
|
||||||
if [ ! -f ~/.cargo/bin/git-warp-time ]; then
|
|
||||||
echo "git-warp-time not found, needs installation"
|
|
||||||
NEED_INSTALL=true
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "need-install=$NEED_INSTALL" >> $GITHUB_OUTPUT
|
|
||||||
|
|
||||||
- name: Install timelord-cli and git-warp-time
|
|
||||||
if: steps.check-binaries.outputs.need-install == 'true'
|
|
||||||
uses: https://github.com/taiki-e/install-action@v2
|
|
||||||
with:
|
|
||||||
tool: git-warp-time,timelord-cli@3.0.1
|
|
||||||
|
|
||||||
- name: Save binary cache
|
|
||||||
if: steps.check-binaries.outputs.need-install == 'true'
|
|
||||||
uses: actions/cache/save@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
/usr/share/rust/.cargo/bin
|
|
||||||
~/.cargo/bin
|
|
||||||
key: continuwuity-timelord-binaries
|
|
||||||
|
|
||||||
|
|
||||||
- name: Restore timelord cache with fallbacks
|
|
||||||
id: timelord-restore
|
|
||||||
uses: actions/cache/restore@v4
|
|
||||||
with:
|
|
||||||
path: ${{ env.TIMELORD_CACHE_PATH }}
|
|
||||||
key: ${{ env.TIMELORD_KEY }}
|
|
||||||
restore-keys: |
|
|
||||||
continuwuity-timelord-${{ github.repository }}-
|
|
||||||
|
|
||||||
- name: Initialize timestamps on complete cache miss
|
|
||||||
if: steps.timelord-restore.outputs.cache-hit != 'true'
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
echo "Complete timelord cache miss - running git-warp-time"
|
|
||||||
git fetch --unshallow
|
|
||||||
if [ "${{ env.TIMELORD_PATH }}" = "." ]; then
|
|
||||||
git-warp-time --quiet
|
|
||||||
else
|
|
||||||
git-warp-time --quiet ${{ env.TIMELORD_PATH }}
|
|
||||||
fi
|
|
||||||
echo "Git timestamps restored"
|
|
||||||
|
|
||||||
- name: Run timelord sync
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
mkdir -p ${{ env.TIMELORD_CACHE_PATH }}
|
|
||||||
timelord sync --source-dir ${{ env.TIMELORD_PATH }} --cache-dir ${{ env.TIMELORD_CACHE_PATH }}
|
|
||||||
|
|
||||||
- name: Save updated timelord cache immediately
|
|
||||||
uses: actions/cache/save@v4
|
|
||||||
with:
|
|
||||||
path: ${{ env.TIMELORD_CACHE_PATH }}
|
|
||||||
key: ${{ env.TIMELORD_KEY }}
|
|
||||||
|
|
@ -1,70 +0,0 @@
|
||||||
name: upload-docker-artifacts
|
|
||||||
description: |
|
|
||||||
Upload Docker build artifacts including binary and digest files.
|
|
||||||
Handles artifact naming and conditional digest uploads for registry publishing.
|
|
||||||
|
|
||||||
inputs:
|
|
||||||
slug:
|
|
||||||
description: Platform slug for artifact naming (e.g. linux-amd64, linux-arm64)
|
|
||||||
required: true
|
|
||||||
cpu_suffix:
|
|
||||||
description: CPU suffix for artifact naming (e.g. -haswell)
|
|
||||||
required: false
|
|
||||||
default: ""
|
|
||||||
artifact_suffix:
|
|
||||||
description: Suffix for binary artifacts (e.g. -maxperf)
|
|
||||||
required: false
|
|
||||||
default: ""
|
|
||||||
digest_suffix:
|
|
||||||
description: Suffix for digest artifacts (e.g. -maxperf)
|
|
||||||
required: false
|
|
||||||
default: ""
|
|
||||||
digest:
|
|
||||||
description: The digest of the built Docker image
|
|
||||||
required: true
|
|
||||||
|
|
||||||
outputs:
|
|
||||||
binary_artifact_name:
|
|
||||||
description: The name of the uploaded binary artifact
|
|
||||||
value: conduwuit${{ inputs.cpu_suffix }}-${{ inputs.slug }}${{ inputs.artifact_suffix }}
|
|
||||||
|
|
||||||
runs:
|
|
||||||
using: composite
|
|
||||||
steps:
|
|
||||||
- name: Export digest
|
|
||||||
if: ${{ env.BUILTIN_REGISTRY_ENABLED == 'true' }}
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
mkdir -p /tmp/digests
|
|
||||||
digest="${{ inputs.digest }}"
|
|
||||||
echo "🔍 Build step digest output: '$digest'"
|
|
||||||
if [[ -z "$digest" ]]; then
|
|
||||||
echo "❌ ERROR: No digest found from build step"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
digest_file="/tmp/digests/${digest#sha256:}"
|
|
||||||
echo "📁 Creating digest file: $digest_file"
|
|
||||||
touch "$digest_file"
|
|
||||||
echo "✅ Digest file created successfully"
|
|
||||||
echo "📋 Contents of /tmp/digests:"
|
|
||||||
ls -la /tmp/digests/
|
|
||||||
|
|
||||||
- name: Rename extracted binary
|
|
||||||
shell: bash
|
|
||||||
run: mv /tmp/binaries/sbin/conduwuit /tmp/binaries/conduwuit${{ inputs.cpu_suffix }}-${{ inputs.slug }}${{ inputs.artifact_suffix }}
|
|
||||||
|
|
||||||
- name: Upload binary artifact
|
|
||||||
uses: forgejo/upload-artifact@v4
|
|
||||||
with:
|
|
||||||
name: conduwuit${{ inputs.cpu_suffix }}-${{ inputs.slug }}${{ inputs.artifact_suffix }}
|
|
||||||
path: /tmp/binaries/conduwuit${{ inputs.cpu_suffix }}-${{ inputs.slug }}${{ inputs.artifact_suffix }}
|
|
||||||
if-no-files-found: error
|
|
||||||
|
|
||||||
- name: Upload digest
|
|
||||||
if: ${{ env.BUILTIN_REGISTRY_ENABLED == 'true' }}
|
|
||||||
uses: forgejo/upload-artifact@v4
|
|
||||||
with:
|
|
||||||
name: digests${{ inputs.digest_suffix }}-${{ inputs.slug }}${{ inputs.cpu_suffix }}
|
|
||||||
path: /tmp/digests/*
|
|
||||||
if-no-files-found: error
|
|
||||||
retention-days: 5
|
|
||||||
|
|
@ -1,82 +0,0 @@
|
||||||
---
|
|
||||||
name: 'New pull request'
|
|
||||||
about: 'Open a new pull request to contribute to continuwuity'
|
|
||||||
ref: 'main'
|
|
||||||
---
|
|
||||||
|
|
||||||
<!--
|
|
||||||
In order to help reviewers know what your pull request does at a glance, you should ensure that
|
|
||||||
|
|
||||||
1. Your PR title is a short, single sentence describing what you changed
|
|
||||||
2. You have described in more detail what you have changed, why you have changed it, what the
|
|
||||||
intended effect is, and why you think this will be beneficial to the project.
|
|
||||||
|
|
||||||
If you have made any potentially strange/questionable design choices, but didn't feel they'd benefit
|
|
||||||
from code comments, please don't mention them here - after opening your pull request,
|
|
||||||
go to "files changed", and click on the "+" symbol in the line number gutter,
|
|
||||||
and attach comments to the lines that you think would benefit from some clarification.
|
|
||||||
-->
|
|
||||||
|
|
||||||
This pull request...
|
|
||||||
|
|
||||||
<!-- Example:
|
|
||||||
This pull request allows us to warp through time and space ten times faster than before by
|
|
||||||
double-inverting the warp drive with hyperheated jump fluid, both making the drive faster and more
|
|
||||||
efficient. This resolves the common issue where we have to wait more than 10 milliseconds to
|
|
||||||
engage, use, and disengage the warp drive when travelling between galaxies.
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!-- Closes: #... -->
|
|
||||||
<!-- Fixes: #... -->
|
|
||||||
<!-- Uncomment the above line(s) if your pull request fixes an issue or closes another pull request
|
|
||||||
by superseding it. Replace `#...` with the issue/pr number, such as `#123`. -->
|
|
||||||
|
|
||||||
**Pull request checklist:**
|
|
||||||
|
|
||||||
<!-- You need to complete these before your PR can be considered.
|
|
||||||
If you aren't sure about some, feel free to ask for clarification in #dev:continuwuity.org. -->
|
|
||||||
- [ ] This pull request targets the `main` branch, and the branch is named something other than
|
|
||||||
`main`.
|
|
||||||
- [ ] I have written an appropriate pull request title and my description is clear.
|
|
||||||
- [ ] I understand I am responsible for the contents of this pull request.
|
|
||||||
- I have followed the [contributing guidelines][c1]:
|
|
||||||
- [ ] My contribution follows the [code style][c2], if applicable.
|
|
||||||
- [ ] I ran [pre-commit checks][c1pc] before opening/drafting this pull request.
|
|
||||||
- [ ] I have [tested my contribution][c1t] (or proof-read it for documentation-only changes)
|
|
||||||
myself, if applicable. This includes ensuring code compiles.
|
|
||||||
- [ ] My commit messages follow the [commit message format][c1cm] and are descriptive.
|
|
||||||
- [ ] I have written a [news fragment][n1] for this PR, if applicable<!--(can be done after hitting open!)-->.
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Notes on these requirements:
|
|
||||||
|
|
||||||
- While not required, we encourage you to sign your commits with GPG or SSH to attest the
|
|
||||||
authenticity of your changes.
|
|
||||||
- While we allow LLM-assisted contributions, we do not appreciate contributions that are
|
|
||||||
low quality, which is typical of machine-generated contributions that have not had a lot of love
|
|
||||||
and care from a human. Please do not open a PR if all you have done is asked ChatGPT to tidy up
|
|
||||||
the codebase with a +-100,000 diff.
|
|
||||||
- In the case of code style violations, reviewers may leave review comments/change requests
|
|
||||||
indicating what the ideal change would look like. For example, a reviewer may suggest you lower
|
|
||||||
a log level, or use `match` instead of `if/else` etc.
|
|
||||||
- In the case of code style violations, pre-commit check failures, minor things like typos/spelling
|
|
||||||
errors, and in some cases commit format violations, reviewers may modify your branch directly,
|
|
||||||
typically by making changes and adding a commit. Particularly in the latter case, a reviewer may
|
|
||||||
rebase your commits to squash "spammy" ones (like "fix", "fix", "actually fix"), and reword
|
|
||||||
commit messages that don't satisfy the format.
|
|
||||||
- Pull requests MUST pass the `Checks` CI workflows to be capable of being merged. This can only be
|
|
||||||
bypassed in exceptional circumstances.
|
|
||||||
If your CI flakes, let us know in matrix:r/dev:continuwuity.org.
|
|
||||||
- Pull requests have to be based on the latest `main` commit before being merged. If the main branch
|
|
||||||
changes while you're making your changes, you should make sure you rebase on main before
|
|
||||||
opening a PR. Your branch will be rebased on main before it is merged if it has fallen behind.
|
|
||||||
- We typically only do fast-forward merges, so your entire commit log will be included. Once in
|
|
||||||
main, it's difficult to get out cleanly, so put on your best dress, smile for the cameras!
|
|
||||||
-->
|
|
||||||
|
|
||||||
[c1]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md
|
|
||||||
[c2]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/docs/development/code_style.mdx
|
|
||||||
[c1pc]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#pre-commit-checks
|
|
||||||
[c1t]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#running-tests-locally
|
|
||||||
[c1cm]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#commit-messages
|
|
||||||
[n1]: https://towncrier.readthedocs.io/en/stable/tutorial.html#creating-news-fragments
|
|
||||||
|
|
@ -1,72 +0,0 @@
|
||||||
version: 1
|
|
||||||
|
|
||||||
x-source: &source forgejo.ellis.link/continuwuation/continuwuity
|
|
||||||
|
|
||||||
x-tags:
|
|
||||||
releases: &tags-releases
|
|
||||||
tags:
|
|
||||||
allow:
|
|
||||||
- "latest"
|
|
||||||
- "v[0-9]+\\.[0-9]+\\.[0-9]+(-[a-z0-9\\.]+)?"
|
|
||||||
- "v[0-9]+\\.[0-9]+"
|
|
||||||
- "v[0-9]+"
|
|
||||||
main: &tags-main
|
|
||||||
tags:
|
|
||||||
allow:
|
|
||||||
- "latest"
|
|
||||||
- "v[0-9]+\\.[0-9]+\\.[0-9]+(-[a-z0-9\\.]+)?"
|
|
||||||
- "v[0-9]+\\.[0-9]+"
|
|
||||||
- "v[0-9]+"
|
|
||||||
- "main"
|
|
||||||
commits: &tags-commits
|
|
||||||
tags:
|
|
||||||
allow:
|
|
||||||
- "latest"
|
|
||||||
- "v[0-9]+\\.[0-9]+\\.[0-9]+(-[a-z0-9\\.]+)?"
|
|
||||||
- "v[0-9]+\\.[0-9]+"
|
|
||||||
- "v[0-9]+"
|
|
||||||
- "main"
|
|
||||||
- "sha-[a-f0-9]+"
|
|
||||||
all: &tags-all
|
|
||||||
tags:
|
|
||||||
allow:
|
|
||||||
- ".*"
|
|
||||||
|
|
||||||
# Registry credentials
|
|
||||||
creds:
|
|
||||||
- registry: forgejo.ellis.link
|
|
||||||
user: "{{env \"BUILTIN_REGISTRY_USER\"}}"
|
|
||||||
pass: "{{env \"BUILTIN_REGISTRY_PASSWORD\"}}"
|
|
||||||
- registry: registry.gitlab.com
|
|
||||||
user: "{{env \"GITLAB_USERNAME\"}}"
|
|
||||||
pass: "{{env \"GITLAB_TOKEN\"}}"
|
|
||||||
- registry: git.nexy7574.co.uk
|
|
||||||
user: "{{env \"N7574_GIT_USERNAME\"}}"
|
|
||||||
pass: "{{env \"N7574_GIT_TOKEN\"}}"
|
|
||||||
- registry: ghcr.io
|
|
||||||
user: "{{env \"GH_PACKAGES_USER\"}}"
|
|
||||||
pass: "{{env \"GH_PACKAGES_TOKEN\"}}"
|
|
||||||
- registry: docker.io
|
|
||||||
user: "{{env \"DOCKER_MIRROR_USER\"}}"
|
|
||||||
pass: "{{env \"DOCKER_MIRROR_TOKEN\"}}"
|
|
||||||
|
|
||||||
# Global defaults
|
|
||||||
defaults:
|
|
||||||
parallel: 3
|
|
||||||
interval: 2h
|
|
||||||
digestTags: true
|
|
||||||
|
|
||||||
# Sync configuration - each registry gets different image sets
|
|
||||||
sync:
|
|
||||||
- source: *source
|
|
||||||
target: registry.gitlab.com/continuwuity/continuwuity
|
|
||||||
type: repository
|
|
||||||
<<: *tags-main
|
|
||||||
- source: *source
|
|
||||||
target: ghcr.io/continuwuity/continuwuity
|
|
||||||
type: repository
|
|
||||||
<<: *tags-main
|
|
||||||
- source: *source
|
|
||||||
target: docker.io/jadedblueeyes/continuwuity
|
|
||||||
type: repository
|
|
||||||
<<: *tags-main
|
|
||||||
|
|
@ -1,170 +0,0 @@
|
||||||
name: Build / Debian DEB
|
|
||||||
|
|
||||||
concurrency:
|
|
||||||
group: "build-debian-${{ forge.ref }}"
|
|
||||||
cancel-in-progress: true
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
tags:
|
|
||||||
- "v*.*.*"
|
|
||||||
workflow_dispatch:
|
|
||||||
schedule:
|
|
||||||
- cron: '30 0 * * *'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
container: [ "ubuntu-latest", "ubuntu-previous", "debian-latest", "debian-oldstable" ]
|
|
||||||
container:
|
|
||||||
image: "ghcr.io/tcpipuk/act-runner:${{ matrix.container }}"
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Get Debian version
|
|
||||||
id: debian-version
|
|
||||||
run: |
|
|
||||||
VERSION=$(cat /etc/debian_version)
|
|
||||||
DISTRIBUTION=$(lsb_release -sc 2>/dev/null)
|
|
||||||
echo "version=$VERSION" >> $GITHUB_OUTPUT
|
|
||||||
echo "distribution=$DISTRIBUTION" >> $GITHUB_OUTPUT
|
|
||||||
echo "Debian distribution: $DISTRIBUTION ($VERSION)"
|
|
||||||
#- name: Work around llvm-project#153385
|
|
||||||
# id: llvm-workaround
|
|
||||||
# run: |
|
|
||||||
# if [ -f /usr/share/apt/default-sequoia.config ]; then
|
|
||||||
# echo "Applying workaround for llvm-project#153385"
|
|
||||||
# mkdir -p /etc/crypto-policies/back-ends/
|
|
||||||
# cp /usr/share/apt/default-sequoia.config /etc/crypto-policies/back-ends/apt-sequoia.config
|
|
||||||
# sed -i 's/\(sha1\.second_preimage_resistance = \)2026-02-01/\12026-06-01/' /etc/crypto-policies/back-ends/apt-sequoia.config
|
|
||||||
# else
|
|
||||||
# echo "No workaround needed for llvm-project#153385"
|
|
||||||
# fi
|
|
||||||
- name: Pick compatible clang version
|
|
||||||
id: clang-version
|
|
||||||
run: |
|
|
||||||
# both latest need to use clang-23, but oldstable and previous can just use clang
|
|
||||||
if [[ "${{ matrix.container }}" == "ubuntu-latest" ]]; then
|
|
||||||
echo "Using clang-23 package for ${{ matrix.container }}"
|
|
||||||
echo "version=clang-23" >> $GITHUB_OUTPUT
|
|
||||||
else
|
|
||||||
echo "Using default clang package for ${{ matrix.container }}"
|
|
||||||
echo "version=clang" >> $GITHUB_OUTPUT
|
|
||||||
fi
|
|
||||||
|
|
||||||
- name: Checkout repository with full history
|
|
||||||
uses: actions/checkout@v6
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
ref: ${{ github.ref_name }}
|
|
||||||
|
|
||||||
- name: Cache Cargo registry
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
~/.cargo/registry
|
|
||||||
~/.cargo/git
|
|
||||||
key: cargo-debian-${{ steps.debian-version.outputs.distribution }}-${{ hashFiles('**/Cargo.lock') }}
|
|
||||||
restore-keys: |
|
|
||||||
cargo-debian-${{ steps.debian-version.outputs.distribution }}-
|
|
||||||
|
|
||||||
- name: Setup sccache
|
|
||||||
uses: https://git.tomfos.tr/tom/sccache-action@v1
|
|
||||||
|
|
||||||
- name: Configure sccache environment
|
|
||||||
run: |
|
|
||||||
echo "RUSTC_WRAPPER=sccache" >> $GITHUB_ENV
|
|
||||||
echo "CMAKE_C_COMPILER_LAUNCHER=sccache" >> $GITHUB_ENV
|
|
||||||
echo "CMAKE_CXX_COMPILER_LAUNCHER=sccache" >> $GITHUB_ENV
|
|
||||||
echo "SCCACHE_CACHE_SIZE=10G" >> $GITHUB_ENV
|
|
||||||
# Aggressive GC since cache restores don't increment counter
|
|
||||||
echo "CARGO_INCREMENTAL_GC_TRIGGER=5" >> $GITHUB_ENV
|
|
||||||
|
|
||||||
- name: Setup Rust
|
|
||||||
uses: ./.forgejo/actions/setup-rust
|
|
||||||
with:
|
|
||||||
github-token: ${{ secrets.GH_PUBLIC_RO }}
|
|
||||||
|
|
||||||
- name: Get package version and component
|
|
||||||
id: package-meta
|
|
||||||
run: |
|
|
||||||
BASE_VERSION=$(cargo metadata --no-deps --format-version 1 | jq -r ".packages[] | select(.name == \"conduwuit\").version" | sed 's/[^a-zA-Z0-9.+]/~/g')
|
|
||||||
# VERSION is the package version, COMPONENT is used in
|
|
||||||
# apt's repository config like a git repo branch
|
|
||||||
if [[ "${{ forge.ref }}" == "refs/tags/"* ]]; then
|
|
||||||
# Use the "stable" component for tagged releases
|
|
||||||
COMPONENT="stable"
|
|
||||||
VERSION=$BASE_VERSION
|
|
||||||
else
|
|
||||||
# Use the "dev" component for development builds
|
|
||||||
SHA=$(echo "${{ forge.sha }}" | cut -c1-7)
|
|
||||||
DATE=$(date +%Y%m%d)
|
|
||||||
if [ "${{ forge.ref_name }}" = "main" ]; then
|
|
||||||
COMPONENT="dev"
|
|
||||||
else
|
|
||||||
# Use the sanitized ref name as the component for feature branches
|
|
||||||
COMPONENT="dev-$(echo '${{ forge.ref_name }}' | sed 's/[^a-zA-Z0-9.+]/-/g' | tr '[:upper:]' '[:lower:]' | cut -c1-30)"
|
|
||||||
fi
|
|
||||||
CLEAN_COMPONENT=$(echo $COMPONENT | sed 's/[^a-zA-Z0-9.+]/~/g')
|
|
||||||
VERSION="$BASE_VERSION~git$DATE.$SHA-$CLEAN_COMPONENT"
|
|
||||||
fi
|
|
||||||
echo "component=$COMPONENT" >> $GITHUB_OUTPUT
|
|
||||||
echo "version=$VERSION" >> $GITHUB_OUTPUT
|
|
||||||
echo "Component: $COMPONENT"
|
|
||||||
echo "Version: $VERSION"
|
|
||||||
|
|
||||||
- name: Install cargo-deb
|
|
||||||
run: |
|
|
||||||
if command -v cargo-deb &> /dev/null; then
|
|
||||||
echo "cargo-deb already available"
|
|
||||||
else
|
|
||||||
echo "Installing cargo-deb"
|
|
||||||
cargo-binstall -y --no-symlinks cargo-deb
|
|
||||||
fi
|
|
||||||
|
|
||||||
- name: Install build dependencies
|
|
||||||
run: |
|
|
||||||
apt-get update -y
|
|
||||||
# Build dependencies for rocksdb
|
|
||||||
apt-get install -y liburing-dev ${{ steps.clang-version.outputs.version }}
|
|
||||||
|
|
||||||
- name: Run cargo-deb
|
|
||||||
id: cargo-deb
|
|
||||||
run: |
|
|
||||||
DEB_PATH=$(cargo deb --deb-version ${{ steps.package-meta.outputs.version }})
|
|
||||||
echo "path=$DEB_PATH" >> $GITHUB_OUTPUT
|
|
||||||
|
|
||||||
- name: Test deb installation
|
|
||||||
run: |
|
|
||||||
echo "Installing: ${{ steps.cargo-deb.outputs.path }}"
|
|
||||||
|
|
||||||
apt-get install -y ${{ steps.cargo-deb.outputs.path }}
|
|
||||||
|
|
||||||
dpkg -s continuwuity
|
|
||||||
|
|
||||||
[ -f /usr/bin/conduwuit ] && echo "✅ Binary installed successfully"
|
|
||||||
[ -f /usr/lib/systemd/system/conduwuit.service ] && echo "✅ Systemd service installed"
|
|
||||||
[ -f /etc/conduwuit/conduwuit.toml ] && echo "✅ Config file installed"
|
|
||||||
|
|
||||||
- name: Upload deb artifact
|
|
||||||
uses: forgejo/upload-artifact@v4
|
|
||||||
with:
|
|
||||||
name: continuwuity-${{ steps.debian-version.outputs.distribution }}
|
|
||||||
path: ${{ steps.cargo-deb.outputs.path }}
|
|
||||||
|
|
||||||
- name: Publish to Forgejo package registry
|
|
||||||
if: ${{ forge.event_name == 'push' || forge.event_name == 'workflow_dispatch' || forge.event_name == 'schedule' }}
|
|
||||||
run: |
|
|
||||||
OWNER="continuwuation"
|
|
||||||
DISTRIBUTION=${{ steps.debian-version.outputs.distribution }}
|
|
||||||
COMPONENT=${{ steps.package-meta.outputs.component }}
|
|
||||||
DEB=${{ steps.cargo-deb.outputs.path }}
|
|
||||||
|
|
||||||
echo "Publishing: $DEB in component $COMPONENT for distribution $DISTRIBUTION"
|
|
||||||
|
|
||||||
curl --fail-with-body \
|
|
||||||
-X PUT \
|
|
||||||
-H "Authorization: token ${{ secrets.BUILTIN_REGISTRY_PASSWORD || secrets.GITHUB_TOKEN }}" \
|
|
||||||
--upload-file "$DEB" \
|
|
||||||
"${{ forge.server_url }}/api/packages/$OWNER/debian/pool/$DISTRIBUTION/$COMPONENT/upload"
|
|
||||||
|
|
@ -1,390 +0,0 @@
|
||||||
name: Build / Fedora RPM
|
|
||||||
|
|
||||||
concurrency:
|
|
||||||
group: "build-fedora-${{ github.ref }}"
|
|
||||||
cancel-in-progress: true
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
tags:
|
|
||||||
- "v*.*.*"
|
|
||||||
# paths:
|
|
||||||
# - 'pkg/fedora/**'
|
|
||||||
# - 'src/**'
|
|
||||||
# - 'Cargo.toml'
|
|
||||||
# - 'Cargo.lock'
|
|
||||||
# - '.forgejo/workflows/build-fedora.yml'
|
|
||||||
workflow_dispatch:
|
|
||||||
schedule:
|
|
||||||
- cron: '30 0 * * *'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: fedora-latest
|
|
||||||
steps:
|
|
||||||
- name: Detect Fedora version
|
|
||||||
id: fedora
|
|
||||||
run: |
|
|
||||||
VERSION=$(rpm -E %fedora)
|
|
||||||
echo "version=$VERSION" >> $GITHUB_OUTPUT
|
|
||||||
echo "Fedora version: $VERSION"
|
|
||||||
|
|
||||||
- name: Checkout repository with full history
|
|
||||||
uses: actions/checkout@v6
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
ref: ${{ github.ref_name }}
|
|
||||||
|
|
||||||
|
|
||||||
- name: Cache DNF packages
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
/var/cache/dnf
|
|
||||||
/var/cache/yum
|
|
||||||
key: dnf-fedora${{ steps.fedora.outputs.version }}-${{ hashFiles('pkg/fedora/continuwuity.spec.rpkg') }}-v1
|
|
||||||
restore-keys: |
|
|
||||||
dnf-fedora${{ steps.fedora.outputs.version }}-
|
|
||||||
|
|
||||||
- name: Cache Cargo registry
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
~/.cargo/registry
|
|
||||||
~/.cargo/git
|
|
||||||
key: cargo-fedora${{ steps.fedora.outputs.version }}-${{ hashFiles('**/Cargo.lock') }}
|
|
||||||
restore-keys: |
|
|
||||||
cargo-fedora${{ steps.fedora.outputs.version }}-
|
|
||||||
|
|
||||||
- name: Cache Rust build dependencies
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
~/rpmbuild/BUILD/*/target/release/deps
|
|
||||||
~/rpmbuild/BUILD/*/target/release/build
|
|
||||||
~/rpmbuild/BUILD/*/target/release/.fingerprint
|
|
||||||
~/rpmbuild/BUILD/*/target/release/incremental
|
|
||||||
key: rust-deps-fedora${{ steps.fedora.outputs.version }}-${{ hashFiles('**/Cargo.lock') }}
|
|
||||||
restore-keys: |
|
|
||||||
rust-deps-fedora${{ steps.fedora.outputs.version }}-
|
|
||||||
|
|
||||||
- name: Setup sccache
|
|
||||||
uses: https://git.tomfos.tr/tom/sccache-action@v1
|
|
||||||
|
|
||||||
- name: Configure sccache environment
|
|
||||||
run: |
|
|
||||||
echo "RUSTC_WRAPPER=sccache" >> $GITHUB_ENV
|
|
||||||
echo "CMAKE_C_COMPILER_LAUNCHER=sccache" >> $GITHUB_ENV
|
|
||||||
echo "CMAKE_CXX_COMPILER_LAUNCHER=sccache" >> $GITHUB_ENV
|
|
||||||
echo "SCCACHE_CACHE_SIZE=10G" >> $GITHUB_ENV
|
|
||||||
# Aggressive GC since cache restores don't increment counter
|
|
||||||
echo "CARGO_INCREMENTAL_GC_TRIGGER=5" >> $GITHUB_ENV
|
|
||||||
|
|
||||||
- name: Install base RPM tools
|
|
||||||
run: |
|
|
||||||
dnf install -y --setopt=keepcache=1 \
|
|
||||||
fedora-packager \
|
|
||||||
python3-pip \
|
|
||||||
rpm-sign \
|
|
||||||
rpkg \
|
|
||||||
wget
|
|
||||||
|
|
||||||
- name: Setup build environment and build SRPM
|
|
||||||
run: |
|
|
||||||
git config --global --add safe.directory "$GITHUB_WORKSPACE"
|
|
||||||
git config --global user.email "ci@continuwuity.org"
|
|
||||||
git config --global user.name "Continuwuity"
|
|
||||||
|
|
||||||
rpmdev-setuptree
|
|
||||||
|
|
||||||
cd "$GITHUB_WORKSPACE"
|
|
||||||
|
|
||||||
# Determine release suffix and version based on ref type and branch
|
|
||||||
if [[ "${{ github.ref }}" == "refs/tags/"* ]]; then
|
|
||||||
# Tags get clean version numbers for stable releases
|
|
||||||
RELEASE_SUFFIX=""
|
|
||||||
TAG_NAME="${{ github.ref_name }}"
|
|
||||||
# Extract version from tag (remove v prefix if present)
|
|
||||||
TAG_VERSION=$(echo "$TAG_NAME" | sed 's/^v//')
|
|
||||||
|
|
||||||
# Create spec file with tag version
|
|
||||||
sed -e "s/^Version:.*$/Version: $TAG_VERSION/" \
|
|
||||||
-e "s/^Release:.*$/Release: 1%{?dist}/" \
|
|
||||||
pkg/fedora/continuwuity.spec.rpkg > continuwuity.spec.rpkg
|
|
||||||
elif [ "${{ github.ref_name }}" = "main" ]; then
|
|
||||||
# Main branch gets .dev suffix
|
|
||||||
RELEASE_SUFFIX=".dev"
|
|
||||||
|
|
||||||
# Replace the Release line to include our suffix
|
|
||||||
sed "s/^Release:.*$/Release: 1${RELEASE_SUFFIX}%{?dist}/" \
|
|
||||||
pkg/fedora/continuwuity.spec.rpkg > continuwuity.spec.rpkg
|
|
||||||
else
|
|
||||||
# Other branches get sanitized branch name as suffix
|
|
||||||
SAFE_BRANCH=$(echo "${{ github.ref_name }}" | sed 's/[^a-zA-Z0-9]/_/g' | cut -c1-20)
|
|
||||||
RELEASE_SUFFIX=".${SAFE_BRANCH}"
|
|
||||||
|
|
||||||
# Replace the Release line to include our suffix
|
|
||||||
sed "s/^Release:.*$/Release: 1${RELEASE_SUFFIX}%{?dist}/" \
|
|
||||||
pkg/fedora/continuwuity.spec.rpkg > continuwuity.spec.rpkg
|
|
||||||
fi
|
|
||||||
|
|
||||||
rpkg srpm --outdir "$HOME/rpmbuild/SRPMS"
|
|
||||||
|
|
||||||
ls -la $HOME/rpmbuild/SRPMS/
|
|
||||||
|
|
||||||
|
|
||||||
- name: Install build dependencies from SRPM
|
|
||||||
run: |
|
|
||||||
SRPM=$(find "$HOME/rpmbuild/SRPMS" -name "*.src.rpm" | head -1)
|
|
||||||
|
|
||||||
if [ -z "$SRPM" ]; then
|
|
||||||
echo "Error: No SRPM file found"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "Installing build dependencies from: $(basename $SRPM)"
|
|
||||||
dnf builddep -y "$SRPM"
|
|
||||||
|
|
||||||
- name: Build RPM from SRPM
|
|
||||||
run: |
|
|
||||||
SRPM=$(find "$HOME/rpmbuild/SRPMS" -name "*.src.rpm" | head -1)
|
|
||||||
|
|
||||||
if [ -z "$SRPM" ]; then
|
|
||||||
echo "Error: No SRPM file found"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "Building from SRPM: $SRPM"
|
|
||||||
|
|
||||||
rpmbuild --rebuild "$SRPM" \
|
|
||||||
--define "_topdir $HOME/rpmbuild" \
|
|
||||||
--define "_sourcedir $GITHUB_WORKSPACE" \
|
|
||||||
--nocheck # Skip %check section to avoid test dependencies
|
|
||||||
|
|
||||||
|
|
||||||
- name: Test RPM installation
|
|
||||||
run: |
|
|
||||||
# Find the main binary RPM (exclude debug and source RPMs)
|
|
||||||
RPM=$(find "$HOME/rpmbuild/RPMS" -name "continuwuity-*.rpm" \
|
|
||||||
! -name "*debuginfo*" \
|
|
||||||
! -name "*debugsource*" \
|
|
||||||
! -name "*.src.rpm" | head -1)
|
|
||||||
|
|
||||||
if [ -z "$RPM" ]; then
|
|
||||||
echo "Error: No binary RPM file found"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "Testing installation of: $RPM"
|
|
||||||
|
|
||||||
# Dry run first
|
|
||||||
rpm -qpi "$RPM"
|
|
||||||
echo ""
|
|
||||||
rpm -qpl "$RPM"
|
|
||||||
|
|
||||||
# Actually install it
|
|
||||||
dnf install -y "$RPM"
|
|
||||||
|
|
||||||
# Verify installation
|
|
||||||
rpm -qa | grep continuwuity
|
|
||||||
|
|
||||||
# Check that the binary exists
|
|
||||||
[ -f /usr/bin/conduwuit ] && echo "✅ Binary installed successfully"
|
|
||||||
[ -f /usr/lib/systemd/system/conduwuit.service ] && echo "✅ Systemd service installed"
|
|
||||||
[ -f /etc/conduwuit/conduwuit.toml ] && echo "✅ Config file installed"
|
|
||||||
|
|
||||||
- name: List built packages
|
|
||||||
run: |
|
|
||||||
echo "Binary RPMs:"
|
|
||||||
find "$HOME/rpmbuild/RPMS" -name "*.rpm" -type f -exec ls -la {} \;
|
|
||||||
|
|
||||||
echo ""
|
|
||||||
echo "Source RPMs:"
|
|
||||||
find "$HOME/rpmbuild/SRPMS" -name "*.rpm" -type f -exec ls -la {} \;
|
|
||||||
|
|
||||||
- name: Collect artifacts
|
|
||||||
run: |
|
|
||||||
mkdir -p artifacts
|
|
||||||
|
|
||||||
find "$HOME/rpmbuild/RPMS" -name "*.rpm" -type f -exec cp {} artifacts/ \;
|
|
||||||
find "$HOME/rpmbuild/SRPMS" -name "*.rpm" -type f -exec cp {} artifacts/ \;
|
|
||||||
|
|
||||||
cd artifacts
|
|
||||||
echo "Build Information:" > BUILD_INFO.txt
|
|
||||||
echo "==================" >> BUILD_INFO.txt
|
|
||||||
echo "Git commit: ${{ github.sha }}" >> BUILD_INFO.txt
|
|
||||||
echo "Git branch: ${{ github.ref_name }}" >> BUILD_INFO.txt
|
|
||||||
echo "Build date: $(date -u +%Y-%m-%d_%H:%M:%S_UTC)" >> BUILD_INFO.txt
|
|
||||||
echo "" >> BUILD_INFO.txt
|
|
||||||
echo "Package contents:" >> BUILD_INFO.txt
|
|
||||||
echo "-----------------" >> BUILD_INFO.txt
|
|
||||||
for rpm in *.rpm; do
|
|
||||||
echo "" >> BUILD_INFO.txt
|
|
||||||
echo "File: $rpm" >> BUILD_INFO.txt
|
|
||||||
rpm -qpi "$rpm" 2>/dev/null | grep -E "^(Name|Version|Release|Architecture|Size)" >> BUILD_INFO.txt
|
|
||||||
done
|
|
||||||
|
|
||||||
ls -la
|
|
||||||
|
|
||||||
- name: Upload binary RPM artifact
|
|
||||||
run: |
|
|
||||||
# Find the main binary RPM (exclude debug and source RPMs)
|
|
||||||
BIN_RPM=$(find artifacts -name "continuwuity-*.rpm" \
|
|
||||||
! -name "*debuginfo*" \
|
|
||||||
! -name "*debugsource*" \
|
|
||||||
! -name "*.src.rpm" \
|
|
||||||
-type f)
|
|
||||||
|
|
||||||
mkdir -p upload-bin
|
|
||||||
cp $BIN_RPM upload-bin/
|
|
||||||
|
|
||||||
- name: Upload binary RPM
|
|
||||||
uses: forgejo/upload-artifact@v4
|
|
||||||
with:
|
|
||||||
name: continuwuity
|
|
||||||
path: upload-bin/
|
|
||||||
|
|
||||||
- name: Upload debug RPM artifact
|
|
||||||
uses: forgejo/upload-artifact@v4
|
|
||||||
with:
|
|
||||||
name: continuwuity-debug
|
|
||||||
path: artifacts/*debuginfo*.rpm
|
|
||||||
|
|
||||||
- name: Publish to RPM Package Registry
|
|
||||||
if: ${{ github.event_name == 'push' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' }}
|
|
||||||
run: |
|
|
||||||
# Find the main binary RPM (exclude debug and source RPMs)
|
|
||||||
RPM=$(find artifacts -name "continuwuity-*.rpm" \
|
|
||||||
! -name "*debuginfo*" \
|
|
||||||
! -name "*debugsource*" \
|
|
||||||
! -name "*.src.rpm" \
|
|
||||||
-type f | head -1)
|
|
||||||
|
|
||||||
if [ -z "$RPM" ]; then
|
|
||||||
echo "No binary RPM found to publish"
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
RPM_BASENAME=$(basename "$RPM")
|
|
||||||
echo "Publishing: $RPM_BASENAME"
|
|
||||||
|
|
||||||
# Determine the group based on ref type and branch
|
|
||||||
if [[ "${{ github.ref }}" == "refs/tags/"* ]]; then
|
|
||||||
GROUP="stable"
|
|
||||||
# For tags, extract the tag name for version info
|
|
||||||
TAG_NAME="${{ github.ref_name }}"
|
|
||||||
elif [ "${{ github.ref_name }}" = "main" ]; then
|
|
||||||
GROUP="dev"
|
|
||||||
else
|
|
||||||
# Use sanitized branch name as group for feature branches
|
|
||||||
GROUP=$(echo "${{ github.ref_name }}" | sed 's/[^a-zA-Z0-9]/-/g' | tr '[:upper:]' '[:lower:]' | cut -c1-30)
|
|
||||||
fi
|
|
||||||
|
|
||||||
PACKAGE_INFO=$(rpm -qpi "$RPM" 2>/dev/null)
|
|
||||||
PACKAGE_NAME=$(echo "$PACKAGE_INFO" | grep "^Name" | awk '{print $3}')
|
|
||||||
PACKAGE_VERSION=$(echo "$PACKAGE_INFO" | grep "^Version" | awk '{print $3}')
|
|
||||||
PACKAGE_RELEASE=$(echo "$PACKAGE_INFO" | grep "^Release" | awk '{print $3}')
|
|
||||||
PACKAGE_ARCH=$(echo "$PACKAGE_INFO" | grep "^Architecture" | awk '{print $2}')
|
|
||||||
|
|
||||||
# Full version includes release
|
|
||||||
FULL_VERSION="${PACKAGE_VERSION}-${PACKAGE_RELEASE}"
|
|
||||||
|
|
||||||
# Forgejo's RPM registry cannot overwrite existing packages, so we must delete first
|
|
||||||
# 404 is OK if package doesn't exist yet
|
|
||||||
echo "Removing any existing package: $PACKAGE_NAME-$FULL_VERSION.$PACKAGE_ARCH"
|
|
||||||
RESPONSE=$(curl -s -w "\n%{http_code}" -X DELETE \
|
|
||||||
-H "Authorization: token ${{ secrets.BUILTIN_REGISTRY_PASSWORD || secrets.GITHUB_TOKEN }}" \
|
|
||||||
"https://forgejo.ellis.link/api/packages/continuwuation/rpm/$GROUP/package/$PACKAGE_NAME/$FULL_VERSION/$PACKAGE_ARCH")
|
|
||||||
HTTP_CODE=$(echo "$RESPONSE" | tail -n1)
|
|
||||||
|
|
||||||
if [ "$HTTP_CODE" != "204" ] && [ "$HTTP_CODE" != "404" ]; then
|
|
||||||
echo "ERROR: Failed to delete package (HTTP $HTTP_CODE)"
|
|
||||||
echo "$RESPONSE" | head -n -1
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
curl --fail-with-body \
|
|
||||||
-X PUT \
|
|
||||||
-H "Authorization: token ${{ secrets.BUILTIN_REGISTRY_PASSWORD || secrets.GITHUB_TOKEN }}" \
|
|
||||||
-H "Content-Type: application/x-rpm" \
|
|
||||||
-T "$RPM" \
|
|
||||||
"https://forgejo.ellis.link/api/packages/continuwuation/rpm/$GROUP/upload?sign=true"
|
|
||||||
|
|
||||||
echo ""
|
|
||||||
echo "✅ Published binary RPM to: https://forgejo.ellis.link/continuwuation/-/packages/rpm/continuwuity/"
|
|
||||||
echo "Group: $GROUP"
|
|
||||||
|
|
||||||
# Upload debug RPMs to separate group
|
|
||||||
DEBUG_RPMS=$(find artifacts -name "*debuginfo*.rpm")
|
|
||||||
if [ -n "$DEBUG_RPMS" ]; then
|
|
||||||
echo ""
|
|
||||||
echo "Publishing debug RPMs to group: ${GROUP}-debug"
|
|
||||||
|
|
||||||
for DEBUG_RPM in $DEBUG_RPMS; do
|
|
||||||
echo "Publishing: $(basename "$DEBUG_RPM")"
|
|
||||||
|
|
||||||
DEBUG_INFO=$(rpm -qpi "$DEBUG_RPM" 2>/dev/null)
|
|
||||||
DEBUG_NAME=$(echo "$DEBUG_INFO" | grep "^Name" | awk '{print $3}')
|
|
||||||
DEBUG_VERSION=$(echo "$DEBUG_INFO" | grep "^Version" | awk '{print $3}')
|
|
||||||
DEBUG_RELEASE=$(echo "$DEBUG_INFO" | grep "^Release" | awk '{print $3}')
|
|
||||||
DEBUG_ARCH=$(echo "$DEBUG_INFO" | grep "^Architecture" | awk '{print $2}')
|
|
||||||
DEBUG_FULL_VERSION="${DEBUG_VERSION}-${DEBUG_RELEASE}"
|
|
||||||
|
|
||||||
# Must delete existing package first (Forgejo limitation)
|
|
||||||
RESPONSE=$(curl -s -w "\n%{http_code}" -X DELETE \
|
|
||||||
-H "Authorization: token ${{ secrets.BUILTIN_REGISTRY_PASSWORD || secrets.GITHUB_TOKEN }}" \
|
|
||||||
"https://forgejo.ellis.link/api/packages/continuwuation/rpm/${GROUP}-debug/package/$DEBUG_NAME/$DEBUG_FULL_VERSION/$DEBUG_ARCH")
|
|
||||||
HTTP_CODE=$(echo "$RESPONSE" | tail -n1)
|
|
||||||
|
|
||||||
if [ "$HTTP_CODE" != "204" ] && [ "$HTTP_CODE" != "404" ]; then
|
|
||||||
echo "ERROR: Failed to delete debug package (HTTP $HTTP_CODE)"
|
|
||||||
echo "$RESPONSE" | head -n -1
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
curl --fail-with-body \
|
|
||||||
-X PUT \
|
|
||||||
-H "Authorization: token ${{ secrets.BUILTIN_REGISTRY_PASSWORD || secrets.GITHUB_TOKEN }}" \
|
|
||||||
-H "Content-Type: application/x-rpm" \
|
|
||||||
-T "$DEBUG_RPM" \
|
|
||||||
"https://forgejo.ellis.link/api/packages/continuwuation/rpm/${GROUP}-debug/upload?sign=true"
|
|
||||||
done
|
|
||||||
|
|
||||||
echo "✅ Published debug RPMs to group: ${GROUP}-debug"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Also upload the SRPM to separate group
|
|
||||||
SRPM=$(find artifacts -name "*.src.rpm" | head -1)
|
|
||||||
if [ -n "$SRPM" ]; then
|
|
||||||
echo ""
|
|
||||||
echo "Publishing source RPM: $(basename "$SRPM")"
|
|
||||||
echo "Publishing to group: ${GROUP}-src"
|
|
||||||
|
|
||||||
SRPM_INFO=$(rpm -qpi "$SRPM" 2>/dev/null)
|
|
||||||
SRPM_NAME=$(echo "$SRPM_INFO" | grep "^Name" | awk '{print $3}')
|
|
||||||
SRPM_VERSION=$(echo "$SRPM_INFO" | grep "^Version" | awk '{print $3}')
|
|
||||||
SRPM_RELEASE=$(echo "$SRPM_INFO" | grep "^Release" | awk '{print $3}')
|
|
||||||
SRPM_FULL_VERSION="${SRPM_VERSION}-${SRPM_RELEASE}"
|
|
||||||
|
|
||||||
# Must delete existing SRPM first (Forgejo limitation)
|
|
||||||
echo "Removing any existing SRPM: $SRPM_NAME-$SRPM_FULL_VERSION.src"
|
|
||||||
RESPONSE=$(curl -s -w "\n%{http_code}" -X DELETE \
|
|
||||||
-H "Authorization: token ${{ secrets.BUILTIN_REGISTRY_PASSWORD || secrets.GITHUB_TOKEN }}" \
|
|
||||||
"https://forgejo.ellis.link/api/packages/continuwuation/rpm/${GROUP}-src/package/$SRPM_NAME/$SRPM_FULL_VERSION/src")
|
|
||||||
HTTP_CODE=$(echo "$RESPONSE" | tail -n1)
|
|
||||||
|
|
||||||
if [ "$HTTP_CODE" != "204" ] && [ "$HTTP_CODE" != "404" ]; then
|
|
||||||
echo "ERROR: Failed to delete SRPM (HTTP $HTTP_CODE)"
|
|
||||||
echo "$RESPONSE" | head -n -1
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
curl --fail-with-body \
|
|
||||||
-X PUT \
|
|
||||||
-H "Authorization: token ${{ secrets.BUILTIN_REGISTRY_PASSWORD || secrets.GITHUB_TOKEN }}" \
|
|
||||||
-H "Content-Type: application/x-rpm" \
|
|
||||||
-T "$SRPM" \
|
|
||||||
"https://forgejo.ellis.link/api/packages/continuwuation/rpm/${GROUP}-src/upload?sign=true"
|
|
||||||
|
|
||||||
echo "✅ Published source RPM to group: ${GROUP}-src"
|
|
||||||
fi
|
|
||||||
|
|
@ -1,71 +0,0 @@
|
||||||
name: Documentation
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
tags:
|
|
||||||
- "v*"
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
concurrency:
|
|
||||||
group: "pages-${{ github.ref }}"
|
|
||||||
cancel-in-progress: true
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
docs:
|
|
||||||
name: Build and Deploy Documentation
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
if: secrets.CLOUDFLARE_API_TOKEN != ''
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Sync repository
|
|
||||||
uses: actions/checkout@v6
|
|
||||||
with:
|
|
||||||
persist-credentials: false
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
- name: Detect runner environment
|
|
||||||
id: runner-env
|
|
||||||
uses: https://git.tomfos.tr/actions/detect-versions@v1
|
|
||||||
|
|
||||||
- name: Setup Node.js
|
|
||||||
if: steps.runner-env.outputs.node_major == '' || steps.runner-env.outputs.node_major < '20'
|
|
||||||
uses: https://github.com/actions/setup-node@v6
|
|
||||||
with:
|
|
||||||
node-version: 22
|
|
||||||
|
|
||||||
- name: Cache npm dependencies
|
|
||||||
uses: actions/cache@v3
|
|
||||||
with:
|
|
||||||
path: ~/.npm
|
|
||||||
key: continuwuity-rspress-${{ steps.runner-env.outputs.slug }}-${{ steps.runner-env.outputs.arch }}-node-${{ steps.runner-env.outputs.node_version }}-${{ hashFiles('package-lock.json') }}
|
|
||||||
restore-keys: |
|
|
||||||
continuwuity-rspress-${{ steps.runner-env.outputs.slug }}-${{ steps.runner-env.outputs.arch }}-node-${{ steps.runner-env.outputs.node_version }}-
|
|
||||||
continuwuity-rspress-${{ steps.runner-env.outputs.slug }}-${{ steps.runner-env.outputs.arch }}-node-
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: npm ci
|
|
||||||
|
|
||||||
- name: Build Rspress documentation
|
|
||||||
run: npm run docs:build
|
|
||||||
|
|
||||||
- name: Install Wrangler
|
|
||||||
run: npm install --save-dev wrangler@latest
|
|
||||||
|
|
||||||
- name: Deploy to Cloudflare Pages (Production)
|
|
||||||
if: github.ref == 'refs/heads/main' && vars.CLOUDFLARE_PROJECT_NAME != ''
|
|
||||||
uses: https://github.com/cloudflare/wrangler-action@v3
|
|
||||||
with:
|
|
||||||
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
|
||||||
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
|
||||||
command: pages deploy ./doc_build --branch="main" --commit-dirty=true --project-name="${{ vars.CLOUDFLARE_PROJECT_NAME }}"
|
|
||||||
|
|
||||||
- name: Deploy to Cloudflare Pages (Preview)
|
|
||||||
if: github.ref != 'refs/heads/main' && vars.CLOUDFLARE_PROJECT_NAME != ''
|
|
||||||
uses: https://github.com/cloudflare/wrangler-action@v3
|
|
||||||
with:
|
|
||||||
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
|
||||||
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
|
||||||
command: pages deploy ./doc_build --branch="${{ github.head_ref || github.ref_name }}" --commit-dirty=true --project-name="${{ vars.CLOUDFLARE_PROJECT_NAME }}"
|
|
||||||
|
|
@ -1,132 +0,0 @@
|
||||||
name: Deploy Element Web
|
|
||||||
|
|
||||||
on:
|
|
||||||
schedule:
|
|
||||||
- cron: "0 0 * * *"
|
|
||||||
workflow_dispatch:
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- ".forgejo/workflows/element.yml"
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
paths:
|
|
||||||
- ".forgejo/workflows/element.yml"
|
|
||||||
|
|
||||||
concurrency:
|
|
||||||
group: "element-${{ github.ref }}"
|
|
||||||
cancel-in-progress: true
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build-and-deploy:
|
|
||||||
name: 🏗️ Build and Deploy
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: 📦 Setup Node.js
|
|
||||||
uses: https://github.com/actions/setup-node@v6
|
|
||||||
with:
|
|
||||||
node-version: "22"
|
|
||||||
|
|
||||||
- name: 🔨 Clone, setup, and build Element Web
|
|
||||||
run: |
|
|
||||||
echo "Cloning Element Web..."
|
|
||||||
git clone https://github.com/maunium/element-web
|
|
||||||
cd element-web
|
|
||||||
git checkout develop
|
|
||||||
git pull
|
|
||||||
|
|
||||||
echo "Cloning matrix-js-sdk..."
|
|
||||||
git clone https://github.com/matrix-org/matrix-js-sdk.git
|
|
||||||
|
|
||||||
echo "Installing Yarn..."
|
|
||||||
npm install -g yarn
|
|
||||||
|
|
||||||
echo "Installing dependencies..."
|
|
||||||
yarn install
|
|
||||||
|
|
||||||
echo "Preparing build environment..."
|
|
||||||
mkdir -p .home
|
|
||||||
|
|
||||||
echo "Cleaning up specific node_modules paths..."
|
|
||||||
rm -rf node_modules/@types/eslint-scope/ matrix-*-sdk/node_modules/@types/eslint-scope || echo "Cleanup paths not found, continuing."
|
|
||||||
|
|
||||||
echo "Getting matrix-js-sdk commit hash..."
|
|
||||||
cd matrix-js-sdk
|
|
||||||
jsver=$(git rev-parse HEAD)
|
|
||||||
jsver=${jsver:0:12}
|
|
||||||
cd ..
|
|
||||||
echo "matrix-js-sdk version hash: $jsver"
|
|
||||||
|
|
||||||
echo "Getting element-web commit hash..."
|
|
||||||
ver=$(git rev-parse HEAD)
|
|
||||||
ver=${ver:0:12}
|
|
||||||
echo "element-web version hash: $ver"
|
|
||||||
|
|
||||||
chmod +x ./build-sh
|
|
||||||
|
|
||||||
export VERSION="$ver-js-$jsver"
|
|
||||||
echo "Building Element Web version: $VERSION"
|
|
||||||
./build-sh
|
|
||||||
|
|
||||||
echo "Checking for build output..."
|
|
||||||
ls -la webapp/
|
|
||||||
|
|
||||||
- name: ⚙️ Create config.json
|
|
||||||
run: |
|
|
||||||
cat <<EOF > ./element-web/webapp/config.json
|
|
||||||
{
|
|
||||||
"default_server_name": "continuwuity.org",
|
|
||||||
"default_server_config": {
|
|
||||||
"m.homeserver": {
|
|
||||||
"base_url": "https://matrix.continuwuity.org"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"default_country_code": "GB",
|
|
||||||
"default_theme": "dark",
|
|
||||||
"mobile_guide_toast": false,
|
|
||||||
"show_labs_settings": true,
|
|
||||||
"room_directory": [
|
|
||||||
"continuwuity.org",
|
|
||||||
"matrixrooms.info"
|
|
||||||
],
|
|
||||||
"settings_defaults": {
|
|
||||||
"UIFeature.urlPreviews": true,
|
|
||||||
"UIFeature.feedback": false,
|
|
||||||
"UIFeature.voip": false,
|
|
||||||
"UIFeature.shareQrCode": false,
|
|
||||||
"UIFeature.shareSocial": false,
|
|
||||||
"UIFeature.locationSharing": false,
|
|
||||||
"enableSyntaxHighlightLanguageDetection": true
|
|
||||||
},
|
|
||||||
"features": {
|
|
||||||
"feature_pinning": true,
|
|
||||||
"feature_custom_themes": true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
EOF
|
|
||||||
echo "Created ./element-web/webapp/config.json"
|
|
||||||
cat ./element-web/webapp/config.json
|
|
||||||
|
|
||||||
- name: 📤 Upload Artifact
|
|
||||||
uses: forgejo/upload-artifact@v4
|
|
||||||
with:
|
|
||||||
name: element-web
|
|
||||||
path: ./element-web/webapp/
|
|
||||||
retention-days: 14
|
|
||||||
|
|
||||||
- name: 🛠️ Install Wrangler
|
|
||||||
run: npm install --save-dev wrangler@latest
|
|
||||||
|
|
||||||
- name: 🚀 Deploy to Cloudflare Pages
|
|
||||||
if: vars.CLOUDFLARE_PROJECT_NAME != ''
|
|
||||||
id: deploy
|
|
||||||
uses: https://github.com/cloudflare/wrangler-action@v3
|
|
||||||
with:
|
|
||||||
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
|
||||||
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
|
||||||
command: >-
|
|
||||||
pages deploy ./element-web/webapp
|
|
||||||
--branch="${{ github.ref == 'refs/heads/main' && 'main' || github.head_ref || github.ref_name }}"
|
|
||||||
--commit-dirty=true
|
|
||||||
--project-name="${{ vars.CLOUDFLARE_PROJECT_NAME }}-element"
|
|
||||||
|
|
@ -1,68 +0,0 @@
|
||||||
name: Mirror Container Images
|
|
||||||
|
|
||||||
on:
|
|
||||||
schedule:
|
|
||||||
# Run every 2 hours
|
|
||||||
- cron: "0 */2 * * *"
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
dry_run:
|
|
||||||
description: 'Dry run (check only, no actual mirroring)'
|
|
||||||
required: false
|
|
||||||
default: false
|
|
||||||
type: boolean
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
paths:
|
|
||||||
# Re-run when config changes
|
|
||||||
- '.forgejo/regsync/regsync.yml'
|
|
||||||
- '.forgejo/workflows/mirror-images.yml'
|
|
||||||
concurrency:
|
|
||||||
group: "mirror-images"
|
|
||||||
cancel-in-progress: true
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
mirror-images:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
env:
|
|
||||||
BUILTIN_REGISTRY_USER: ${{ vars.BUILTIN_REGISTRY_USER }}
|
|
||||||
BUILTIN_REGISTRY_PASSWORD: ${{ secrets.BUILTIN_REGISTRY_PASSWORD }}
|
|
||||||
GITLAB_USERNAME: ${{ vars.GITLAB_USERNAME }}
|
|
||||||
GITLAB_TOKEN: ${{ secrets.GITLAB_TOKEN }}
|
|
||||||
N7574_GIT_USERNAME: ${{ vars.N7574_GIT_USERNAME }}
|
|
||||||
N7574_GIT_TOKEN: ${{ secrets.N7574_GIT_TOKEN }}
|
|
||||||
GH_PACKAGES_USER: ${{ vars.GH_PACKAGES_USER }}
|
|
||||||
GH_PACKAGES_TOKEN: ${{ secrets.GH_PACKAGES_TOKEN }}
|
|
||||||
DOCKER_MIRROR_USER: ${{ vars.DOCKER_MIRROR_USER }}
|
|
||||||
DOCKER_MIRROR_TOKEN: ${{ secrets.DOCKER_MIRROR_TOKEN }}
|
|
||||||
steps:
|
|
||||||
- name: Checkout repository
|
|
||||||
uses: actions/checkout@v6
|
|
||||||
with:
|
|
||||||
persist-credentials: false
|
|
||||||
|
|
||||||
# - uses: https://github.com/actions/create-github-app-token@v2
|
|
||||||
# id: app-token
|
|
||||||
# with:
|
|
||||||
# app-id: ${{ vars.GH_APP_ID }}
|
|
||||||
# private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
|
|
||||||
# github-api-url: https://api.github.com
|
|
||||||
# owner: continuwuity
|
|
||||||
# repositories: continuwuity
|
|
||||||
|
|
||||||
- name: Install regctl
|
|
||||||
uses: https://forgejo.ellis.link/continuwuation/regclient-actions/regctl-installer@main
|
|
||||||
with:
|
|
||||||
binary: regsync
|
|
||||||
|
|
||||||
- name: Check what images need mirroring
|
|
||||||
run: |
|
|
||||||
echo "Checking images that need mirroring..."
|
|
||||||
regsync check -c .forgejo/regsync/regsync.yml -v info
|
|
||||||
|
|
||||||
- name: Mirror images
|
|
||||||
if: ${{ !inputs.dry_run }}
|
|
||||||
run: |
|
|
||||||
echo "Starting image mirroring..."
|
|
||||||
regsync once -c .forgejo/regsync/regsync.yml -v info
|
|
||||||
|
|
@ -1,83 +0,0 @@
|
||||||
name: Checks / Prek
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
fast-checks:
|
|
||||||
name: Pre-commit & Formatting
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Checkout repository
|
|
||||||
uses: actions/checkout@v6
|
|
||||||
with:
|
|
||||||
persist-credentials: false
|
|
||||||
|
|
||||||
- name: Setup Rust nightly
|
|
||||||
uses: ./.forgejo/actions/setup-rust
|
|
||||||
with:
|
|
||||||
rust-version: nightly
|
|
||||||
github-token: ${{ secrets.GH_PUBLIC_RO }}
|
|
||||||
|
|
||||||
- name: Run prek
|
|
||||||
run: |
|
|
||||||
prek run \
|
|
||||||
--all-files \
|
|
||||||
--hook-stage manual \
|
|
||||||
--show-diff-on-failure \
|
|
||||||
--color=always \
|
|
||||||
-v
|
|
||||||
|
|
||||||
- name: Check Rust formatting
|
|
||||||
run: |
|
|
||||||
cargo +nightly fmt --all -- --check && \
|
|
||||||
echo "✅ Formatting check passed" || \
|
|
||||||
exit 1
|
|
||||||
|
|
||||||
clippy-and-tests:
|
|
||||||
name: Clippy and Cargo Tests
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Checkout repository
|
|
||||||
uses: actions/checkout@v6
|
|
||||||
with:
|
|
||||||
persist-credentials: false
|
|
||||||
|
|
||||||
- name: Setup LLVM
|
|
||||||
uses: ./.forgejo/actions/setup-llvm-with-apt
|
|
||||||
with:
|
|
||||||
extra-packages: liburing-dev liburing2
|
|
||||||
|
|
||||||
- name: Setup Rust with caching
|
|
||||||
uses: ./.forgejo/actions/setup-rust
|
|
||||||
with:
|
|
||||||
github-token: ${{ secrets.GH_PUBLIC_RO }}
|
|
||||||
|
|
||||||
- name: Run Clippy lints
|
|
||||||
run: |
|
|
||||||
cargo clippy \
|
|
||||||
--workspace \
|
|
||||||
--features full \
|
|
||||||
--locked \
|
|
||||||
--no-deps \
|
|
||||||
--profile test \
|
|
||||||
-- \
|
|
||||||
-D warnings
|
|
||||||
|
|
||||||
- name: Run Cargo tests
|
|
||||||
run: |
|
|
||||||
cargo test \
|
|
||||||
--workspace \
|
|
||||||
--features full \
|
|
||||||
--locked \
|
|
||||||
--profile test \
|
|
||||||
--all-targets \
|
|
||||||
--no-fail-fast
|
|
||||||
|
|
@ -1,197 +0,0 @@
|
||||||
name: Release Docker Image
|
|
||||||
concurrency:
|
|
||||||
group: "release-image-${{ github.ref }}"
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
paths-ignore:
|
|
||||||
- "*.md"
|
|
||||||
- "**/*.md"
|
|
||||||
- ".gitlab-ci.yml"
|
|
||||||
- ".gitignore"
|
|
||||||
- "renovate.json"
|
|
||||||
- "pkg/**"
|
|
||||||
- "docs/**"
|
|
||||||
tags:
|
|
||||||
- "v*.*.*"
|
|
||||||
# Allows you to run this workflow manually from the Actions tab
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
env:
|
|
||||||
BUILTIN_REGISTRY: forgejo.ellis.link
|
|
||||||
BUILTIN_REGISTRY_ENABLED: "${{ ((vars.BUILTIN_REGISTRY_USER && secrets.BUILTIN_REGISTRY_PASSWORD) || (github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false)) && 'true' || 'false' }}"
|
|
||||||
IMAGE_PATH: forgejo.ellis.link/continuwuation/continuwuity
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build-release:
|
|
||||||
name: "Build ${{ matrix.slug }} (release)"
|
|
||||||
runs-on: dind
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
packages: write
|
|
||||||
attestations: write
|
|
||||||
id-token: write
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
include:
|
|
||||||
- platform: "linux/amd64"
|
|
||||||
slug: "linux-amd64"
|
|
||||||
- platform: "linux/arm64"
|
|
||||||
slug: "linux-arm64"
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Checkout repository
|
|
||||||
uses: actions/checkout@v6
|
|
||||||
with:
|
|
||||||
persist-credentials: false
|
|
||||||
- name: Prepare Docker build environment
|
|
||||||
id: prepare
|
|
||||||
uses: ./.forgejo/actions/prepare-docker-build
|
|
||||||
with:
|
|
||||||
platform: ${{ matrix.platform }}
|
|
||||||
slug: ${{ matrix.slug }}
|
|
||||||
target_cpu: ""
|
|
||||||
profile: "release"
|
|
||||||
images: ${{ env.IMAGE_PATH }}
|
|
||||||
registry_user: ${{ vars.BUILTIN_REGISTRY_USER || github.actor }}
|
|
||||||
registry_password: ${{ secrets.BUILTIN_REGISTRY_PASSWORD || secrets.GITHUB_TOKEN }}
|
|
||||||
- name: Build and push Docker image by digest
|
|
||||||
id: build
|
|
||||||
uses: docker/build-push-action@v7
|
|
||||||
with:
|
|
||||||
context: .
|
|
||||||
file: "docker/Dockerfile"
|
|
||||||
build-args: |
|
|
||||||
GIT_COMMIT_HASH=${{ github.sha }}
|
|
||||||
GIT_COMMIT_HASH_SHORT=${{ env.COMMIT_SHORT_SHA }}
|
|
||||||
GIT_REMOTE_URL=${{github.event.repository.html_url }}
|
|
||||||
GIT_REMOTE_COMMIT_URL=${{github.event.head_commit.url }}
|
|
||||||
CARGO_INCREMENTAL=${{ env.BUILDKIT_ENDPOINT != '' && '1' || '0' }}
|
|
||||||
TARGET_CPU=
|
|
||||||
RUST_PROFILE=release
|
|
||||||
platforms: ${{ matrix.platform }}
|
|
||||||
labels: ${{ steps.prepare.outputs.metadata_labels }}
|
|
||||||
annotations: ${{ steps.prepare.outputs.metadata_annotations }}
|
|
||||||
cache-from: type=gha
|
|
||||||
# cache-to: type=gha,mode=max
|
|
||||||
sbom: true
|
|
||||||
outputs: |
|
|
||||||
${{ env.BUILTIN_REGISTRY_ENABLED == 'true' && format('type=image,"name={0}",push-by-digest=true,name-canonical=true,push=true', env.IMAGE_PATH) || format('type=image,"name={0}",push=false', env.IMAGE_PATH) }}
|
|
||||||
type=local,dest=/tmp/binaries
|
|
||||||
env:
|
|
||||||
SOURCE_DATE_EPOCH: ${{ env.TIMESTAMP }}
|
|
||||||
- name: Upload Docker artifacts
|
|
||||||
uses: ./.forgejo/actions/upload-docker-artifacts
|
|
||||||
with:
|
|
||||||
slug: ${{ matrix.slug }}
|
|
||||||
cpu_suffix: ${{ steps.prepare.outputs.cpu_suffix }}
|
|
||||||
artifact_suffix: ""
|
|
||||||
digest_suffix: ""
|
|
||||||
digest: ${{ steps.build.outputs.digest }}
|
|
||||||
|
|
||||||
merge-release:
|
|
||||||
name: "Create Multi-arch Release Manifest"
|
|
||||||
runs-on: dind
|
|
||||||
needs: build-release
|
|
||||||
steps:
|
|
||||||
- name: Checkout repository
|
|
||||||
uses: actions/checkout@v6
|
|
||||||
with:
|
|
||||||
persist-credentials: false
|
|
||||||
- name: Create multi-platform manifest
|
|
||||||
uses: ./.forgejo/actions/create-docker-manifest
|
|
||||||
with:
|
|
||||||
digest_pattern: "digests-linux-{amd64,arm64}"
|
|
||||||
tag_suffix: ""
|
|
||||||
images: ${{ env.IMAGE_PATH }}
|
|
||||||
registry_user: ${{ vars.BUILTIN_REGISTRY_USER || github.actor }}
|
|
||||||
registry_password: ${{ secrets.BUILTIN_REGISTRY_PASSWORD || secrets.GITHUB_TOKEN }}
|
|
||||||
|
|
||||||
build-maxperf:
|
|
||||||
name: "Build ${{ matrix.slug }} (max-perf)"
|
|
||||||
runs-on: dind
|
|
||||||
needs: build-release
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
packages: write
|
|
||||||
attestations: write
|
|
||||||
id-token: write
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
include:
|
|
||||||
- platform: "linux/amd64"
|
|
||||||
slug: "linux-amd64"
|
|
||||||
target_cpu: "haswell"
|
|
||||||
- platform: "linux/arm64"
|
|
||||||
slug: "linux-arm64"
|
|
||||||
target_cpu: ""
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Checkout repository
|
|
||||||
uses: actions/checkout@v6
|
|
||||||
with:
|
|
||||||
persist-credentials: false
|
|
||||||
- name: Prepare max-perf Docker build environment
|
|
||||||
id: prepare
|
|
||||||
uses: ./.forgejo/actions/prepare-docker-build
|
|
||||||
with:
|
|
||||||
platform: ${{ matrix.platform }}
|
|
||||||
slug: ${{ matrix.slug }}
|
|
||||||
target_cpu: ${{ matrix.target_cpu }}
|
|
||||||
profile: "release-max-perf"
|
|
||||||
images: ${{ env.IMAGE_PATH }}
|
|
||||||
registry_user: ${{ vars.BUILTIN_REGISTRY_USER || github.actor }}
|
|
||||||
registry_password: ${{ secrets.BUILTIN_REGISTRY_PASSWORD || secrets.GITHUB_TOKEN }}
|
|
||||||
- name: Build and push max-perf Docker image by digest
|
|
||||||
id: build
|
|
||||||
uses: docker/build-push-action@v7
|
|
||||||
with:
|
|
||||||
context: .
|
|
||||||
file: "docker/Dockerfile"
|
|
||||||
build-args: |
|
|
||||||
GIT_COMMIT_HASH=${{ github.sha }}
|
|
||||||
GIT_COMMIT_HASH_SHORT=${{ env.COMMIT_SHORT_SHA }}
|
|
||||||
GIT_REMOTE_URL=${{github.event.repository.html_url }}
|
|
||||||
GIT_REMOTE_COMMIT_URL=${{github.event.head_commit.url }}
|
|
||||||
CARGO_INCREMENTAL=${{ env.BUILDKIT_ENDPOINT != '' && '1' || '0' }}
|
|
||||||
TARGET_CPU=${{ matrix.target_cpu }}
|
|
||||||
RUST_PROFILE=release-max-perf
|
|
||||||
platforms: ${{ matrix.platform }}
|
|
||||||
labels: ${{ steps.prepare.outputs.metadata_labels }}
|
|
||||||
annotations: ${{ steps.prepare.outputs.metadata_annotations }}
|
|
||||||
cache-from: type=gha
|
|
||||||
# cache-to: type=gha,mode=max
|
|
||||||
sbom: true
|
|
||||||
outputs: |
|
|
||||||
${{ env.BUILTIN_REGISTRY_ENABLED == 'true' && format('type=image,"name={0}",push-by-digest=true,name-canonical=true,push=true', env.IMAGE_PATH) || format('type=image,"name={0}",push=false', env.IMAGE_PATH) }}
|
|
||||||
type=local,dest=/tmp/binaries
|
|
||||||
env:
|
|
||||||
SOURCE_DATE_EPOCH: ${{ env.TIMESTAMP }}
|
|
||||||
- name: Upload max-perf Docker artifacts
|
|
||||||
uses: ./.forgejo/actions/upload-docker-artifacts
|
|
||||||
with:
|
|
||||||
slug: ${{ matrix.slug }}
|
|
||||||
cpu_suffix: ${{ steps.prepare.outputs.cpu_suffix }}
|
|
||||||
artifact_suffix: "-maxperf"
|
|
||||||
digest_suffix: "-maxperf"
|
|
||||||
digest: ${{ steps.build.outputs.digest }}
|
|
||||||
|
|
||||||
merge-maxperf:
|
|
||||||
name: "Create Max-Perf Manifest"
|
|
||||||
runs-on: dind
|
|
||||||
needs: build-maxperf
|
|
||||||
steps:
|
|
||||||
- name: Checkout repository
|
|
||||||
uses: actions/checkout@v6
|
|
||||||
with:
|
|
||||||
persist-credentials: false
|
|
||||||
- name: Create max-perf manifest
|
|
||||||
uses: ./.forgejo/actions/create-docker-manifest
|
|
||||||
with:
|
|
||||||
digest_pattern: "digests-maxperf-linux-{amd64-haswell,arm64}"
|
|
||||||
tag_suffix: "-maxperf"
|
|
||||||
images: ${{ env.IMAGE_PATH }}
|
|
||||||
registry_user: ${{ vars.BUILTIN_REGISTRY_USER || github.actor }}
|
|
||||||
registry_password: ${{ secrets.BUILTIN_REGISTRY_PASSWORD || secrets.GITHUB_TOKEN }}
|
|
||||||
|
|
@ -1,132 +0,0 @@
|
||||||
name: Maintenance / Renovate
|
|
||||||
|
|
||||||
enable-email-notifications: true
|
|
||||||
|
|
||||||
on:
|
|
||||||
schedule:
|
|
||||||
# Run at 5am UTC daily to avoid late-night dev
|
|
||||||
- cron: '0 5 * * *'
|
|
||||||
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
dryRun:
|
|
||||||
description: 'Dry run mode'
|
|
||||||
required: false
|
|
||||||
default: ''
|
|
||||||
type: choice
|
|
||||||
options:
|
|
||||||
- ''
|
|
||||||
- 'extract'
|
|
||||||
- 'lookup'
|
|
||||||
- 'full'
|
|
||||||
logLevel:
|
|
||||||
description: 'Log level'
|
|
||||||
required: false
|
|
||||||
default: 'info'
|
|
||||||
type: choice
|
|
||||||
options:
|
|
||||||
- 'debug'
|
|
||||||
- 'info'
|
|
||||||
- 'warning'
|
|
||||||
- 'critical'
|
|
||||||
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
paths:
|
|
||||||
# Re-run when config changes
|
|
||||||
- '.forgejo/workflows/renovate.yml'
|
|
||||||
- 'renovate.json'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
renovate:
|
|
||||||
name: Renovate
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
container:
|
|
||||||
image: ghcr.io/renovatebot/renovate:43.59.4@sha256:f951508dea1e7d71cbe6deca298ab0a05488e7631229304813f630cc06010892
|
|
||||||
options: --tmpfs /tmp:exec
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v6
|
|
||||||
with:
|
|
||||||
show-progress: false
|
|
||||||
|
|
||||||
- name: print node heap
|
|
||||||
run: /usr/local/renovate/node -e 'console.log(`node heap limit = ${require("v8").getHeapStatistics().heap_size_limit / (1024 * 1024)} Mb`)'
|
|
||||||
|
|
||||||
- name: Restore renovate repo cache
|
|
||||||
uses: actions/cache/restore@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
/tmp/renovate/cache/renovate/repository
|
|
||||||
key: renovate-repo-cache-${{ github.run_id }}
|
|
||||||
restore-keys: |
|
|
||||||
renovate-repo-cache-
|
|
||||||
|
|
||||||
- name: Restore renovate package cache
|
|
||||||
uses: actions/cache/restore@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
/tmp/renovate/cache/renovate/renovate-cache-sqlite
|
|
||||||
key: renovate-package-cache-${{ github.run_id }}
|
|
||||||
restore-keys: |
|
|
||||||
renovate-package-cache-
|
|
||||||
|
|
||||||
- name: Restore renovate OSV cache
|
|
||||||
uses: actions/cache/restore@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
/tmp/osv
|
|
||||||
key: renovate-osv-cache-${{ github.run_id }}
|
|
||||||
restore-keys: |
|
|
||||||
renovate-osv-cache-
|
|
||||||
|
|
||||||
- name: Self-hosted Renovate
|
|
||||||
run: renovate
|
|
||||||
env:
|
|
||||||
LOG_LEVEL: ${{ inputs.logLevel || 'info' }}
|
|
||||||
RENOVATE_DRY_RUN: ${{ inputs.dryRun || 'false' }}
|
|
||||||
|
|
||||||
RENOVATE_PLATFORM: forgejo
|
|
||||||
RENOVATE_ENDPOINT: ${{ github.server_url }}
|
|
||||||
RENOVATE_AUTODISCOVER: 'false'
|
|
||||||
RENOVATE_REPOSITORIES: '["${{ github.repository }}"]'
|
|
||||||
|
|
||||||
RENOVATE_GIT_TIMEOUT: 60000
|
|
||||||
|
|
||||||
RENOVATE_REQUIRE_CONFIG: 'required'
|
|
||||||
RENOVATE_ONBOARDING: 'false'
|
|
||||||
RENOVATE_INHERIT_CONFIG: 'true'
|
|
||||||
|
|
||||||
RENOVATE_GITHUB_TOKEN_WARN: 'false'
|
|
||||||
RENOVATE_TOKEN: ${{ secrets.RENOVATE_TOKEN }}
|
|
||||||
GITHUB_COM_TOKEN: ${{ secrets.GH_PUBLIC_RO || secrets.GH_TOKEN }}
|
|
||||||
|
|
||||||
RENOVATE_REPOSITORY_CACHE: 'enabled'
|
|
||||||
RENOVATE_X_SQLITE_PACKAGE_CACHE: 'true'
|
|
||||||
OSV_OFFLINE_ROOT_DIR: /tmp/osv
|
|
||||||
|
|
||||||
- name: Save renovate repo cache
|
|
||||||
if: always()
|
|
||||||
uses:
|
|
||||||
actions/cache/save@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
/tmp/renovate/cache/renovate/repository
|
|
||||||
key: renovate-repo-cache-${{ github.run_id }}
|
|
||||||
|
|
||||||
- name: Save renovate package cache
|
|
||||||
if: always()
|
|
||||||
uses: actions/cache/save@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
/tmp/renovate/cache/renovate/renovate-cache-sqlite
|
|
||||||
key: renovate-package-cache-${{ github.run_id }}
|
|
||||||
|
|
||||||
- name: Save renovate OSV cache
|
|
||||||
if: always()
|
|
||||||
uses: actions/cache/save@v4
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
/tmp/osv
|
|
||||||
key: renovate-osv-cache-${{ github.run_id }}
|
|
||||||
|
|
@ -1,121 +0,0 @@
|
||||||
name: Update flake hashes
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- "Cargo.lock"
|
|
||||||
- "Cargo.toml"
|
|
||||||
- "rust-toolchain.toml"
|
|
||||||
- "nix/**/*"
|
|
||||||
- ".forgejo/workflows/update-flake-hashes.yml"
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
update-flake-hashes:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v6
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
fetch-tags: false
|
|
||||||
fetch-single-branch: true
|
|
||||||
submodules: false
|
|
||||||
persist-credentials: true
|
|
||||||
token: ${{ secrets.FORGEJO_TOKEN }}
|
|
||||||
|
|
||||||
- uses: https://github.com/cachix/install-nix-action@19effe9fe722874e6d46dd7182e4b8b7a43c4a99 # v31.10.0
|
|
||||||
with:
|
|
||||||
nix_path: nixpkgs=channel:nixos-unstable
|
|
||||||
|
|
||||||
# We can skip getting a toolchain hash if this was ran as a dispatch with the intent
|
|
||||||
# to update just the rocksdb hash. If this was ran as a dispatch and the toolchain
|
|
||||||
# files are changed, we still update them, as well as the rocksdb import.
|
|
||||||
- name: Detect changed files
|
|
||||||
id: changes
|
|
||||||
run: |
|
|
||||||
git fetch origin ${{ github.base_ref }} --depth=1 || true
|
|
||||||
if [ -n "${{ github.event.pull_request.base.sha }}" ]; then
|
|
||||||
base=${{ github.event.pull_request.base.sha }}
|
|
||||||
else
|
|
||||||
base=$(git rev-parse HEAD~1)
|
|
||||||
fi
|
|
||||||
echo "Base: $base"
|
|
||||||
echo "HEAD: $(git rev-parse HEAD)"
|
|
||||||
git diff --name-only $base HEAD > changed_files.txt
|
|
||||||
echo "detected changes in $(cat changed_files.txt)"
|
|
||||||
# Join files with commas
|
|
||||||
files=$(paste -sd, changed_files.txt)
|
|
||||||
echo "files=$files" >> $FORGEJO_OUTPUT
|
|
||||||
|
|
||||||
- name: Debug output
|
|
||||||
run: |
|
|
||||||
echo "State of output"
|
|
||||||
echo "Changed files: ${{ steps.changes.outputs.files }}"
|
|
||||||
|
|
||||||
- name: Get new toolchain hash
|
|
||||||
if: contains(steps.changes.outputs.files, 'Cargo.toml') || contains(steps.changes.outputs.files, 'Cargo.lock') || contains(steps.changes.outputs.files, 'rust-toolchain.toml')
|
|
||||||
run: |
|
|
||||||
# Set the current sha256 to an empty hash to make `nix build` calculate a new one
|
|
||||||
awk '/fromToolchainFile *\{/{found=1; print; next} found && /sha256 =/{sub(/sha256 = .*/, "sha256 = lib.fakeSha256;"); found=0} 1' nix/packages/rust.nix > temp.nix
|
|
||||||
mv temp.nix nix/packages/rust.nix
|
|
||||||
|
|
||||||
# Build continuwuity and filter for the new hash
|
|
||||||
# We do `|| true` because we want this to fail without stopping the workflow
|
|
||||||
nix build .#default 2>&1 | tee >(grep 'got:' | awk '{print $2}' > new_toolchain_hash.txt) || true
|
|
||||||
|
|
||||||
# Place the new hash in place of the empty hash
|
|
||||||
new_hash=$(cat new_toolchain_hash.txt)
|
|
||||||
sed -i "s|lib.fakeSha256|\"$new_hash\"|" nix/packages/rust.nix
|
|
||||||
|
|
||||||
echo "New hash:"
|
|
||||||
awk -F'"' '/fromToolchainFile/{found=1; next} found && /sha256 =/{print $2; found=0}' nix/packages/rust.nix
|
|
||||||
echo "Expected new hash:"
|
|
||||||
cat new_toolchain_hash.txt
|
|
||||||
|
|
||||||
rm new_toolchain_hash.txt
|
|
||||||
|
|
||||||
- name: Get new rocksdb hash
|
|
||||||
if: contains(steps.changes.outputs.files, '.nix') || contains(steps.changes.outputs.files, 'flake.lock')
|
|
||||||
run: |
|
|
||||||
# Set the current sha256 to an empty hash to make `nix build` calculate a new one
|
|
||||||
awk '/repo = "rocksdb";/{found=1; print; next} found && /sha256 =/{sub(/sha256 = .*/, "sha256 = lib.fakeSha256;"); found=0} 1' nix/packages/rocksdb/package.nix > temp.nix
|
|
||||||
mv temp.nix nix/packages/rocksdb/package.nix
|
|
||||||
|
|
||||||
# Build continuwuity and filter for the new hash
|
|
||||||
# We do `|| true` because we want this to fail without stopping the workflow
|
|
||||||
nix build .#default 2>&1 | tee >(grep 'got:' | awk '{print $2}' > new_rocksdb_hash.txt) || true
|
|
||||||
|
|
||||||
# Place the new hash in place of the empty hash
|
|
||||||
new_hash=$(cat new_rocksdb_hash.txt)
|
|
||||||
sed -i "s|lib.fakeSha256|\"$new_hash\"|" nix/packages/rocksdb/package.nix
|
|
||||||
|
|
||||||
echo "New hash:"
|
|
||||||
awk -F'"' '/repo = "rocksdb";/{found=1; next} found && /sha256 =/{print $2; found=0}' nix/packages/rocksdb/package.nix
|
|
||||||
echo "Expected new hash:"
|
|
||||||
cat new_rocksdb_hash.txt
|
|
||||||
|
|
||||||
rm new_rocksdb_hash.txt
|
|
||||||
|
|
||||||
- name: Show diff
|
|
||||||
run: git diff flake.nix nix
|
|
||||||
|
|
||||||
- name: Push changes
|
|
||||||
run: |
|
|
||||||
set -euo pipefail
|
|
||||||
|
|
||||||
if git diff --quiet --exit-code; then
|
|
||||||
echo "No changes to commit."
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
git config user.email "renovate@mail.ellis.link"
|
|
||||||
git config user.name "renovate"
|
|
||||||
|
|
||||||
REF="${{ github.head_ref }}"
|
|
||||||
|
|
||||||
git fetch origin "$REF"
|
|
||||||
git checkout "$REF"
|
|
||||||
|
|
||||||
git commit -a -m "chore(Nix): Updated flake hashes"
|
|
||||||
|
|
||||||
git push origin HEAD:refs/heads/"$REF"
|
|
||||||
|
|
@ -1,9 +0,0 @@
|
||||||
# .git-blame-ignore-revs
|
|
||||||
# adds a proper rustfmt.toml and formats the entire codebase
|
|
||||||
1d1ac065141181438e744e7d8abd0e45f75a2f91
|
|
||||||
f419c64aca300a338096b4e0db4c73ace54f23d0
|
|
||||||
# use chain_width 60
|
|
||||||
162948313c212193965dece50b816ef0903172ba
|
|
||||||
5998a0d883d31b866f7c8c46433a8857eae51a89
|
|
||||||
# trailing whitespace and newlines
|
|
||||||
46c193e74b2ce86c48ce802333a0aabce37fd6e9
|
|
||||||
89
.gitattributes
vendored
89
.gitattributes
vendored
|
|
@ -1,87 +1,2 @@
|
||||||
# taken from https://github.com/gitattributes/gitattributes/blob/46a8961ad73f5bd4d8d193708840fbc9e851d702/Rust.gitattributes
|
# Auto detect text files and perform LF normalization
|
||||||
# Auto detect text files and perform normalization
|
* text=auto
|
||||||
* 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
|
|
||||||
|
|
|
||||||
4
.github/FUNDING.yml
vendored
4
.github/FUNDING.yml
vendored
|
|
@ -1,4 +0,0 @@
|
||||||
github: [JadedBlueEyes, nexy7574, gingershaped]
|
|
||||||
custom:
|
|
||||||
- https://timedout.uk/donate.html
|
|
||||||
- https://jade.ellis.link/sponsors
|
|
||||||
106
.gitignore
vendored
106
.gitignore
vendored
|
|
@ -1,104 +1,4 @@
|
||||||
# Local environment overrides
|
node_modules
|
||||||
/.env
|
|
||||||
|
|
||||||
# CMake
|
servers/*.ign
|
||||||
cmake-build-*/
|
.parcel-cache
|
||||||
|
|
||||||
# IntelliJ
|
|
||||||
.idea/
|
|
||||||
out/
|
|
||||||
*.iml
|
|
||||||
modules.xml
|
|
||||||
*.ipr
|
|
||||||
|
|
||||||
# mpeltonen/sbt-idea plugin
|
|
||||||
.idea_modules/
|
|
||||||
|
|
||||||
# Linux backup files
|
|
||||||
*~
|
|
||||||
|
|
||||||
# temporary files which can be created if a process still has a handle open of a deleted file
|
|
||||||
.fuse_hidden*
|
|
||||||
|
|
||||||
# KDE directory preferences
|
|
||||||
.directory
|
|
||||||
|
|
||||||
# Linux trash folder which might appear on any partition or disk
|
|
||||||
.Trash-*
|
|
||||||
|
|
||||||
# .nfs files are created when an open file is removed but is still being accessed
|
|
||||||
.nfs*
|
|
||||||
|
|
||||||
# Rust
|
|
||||||
/target
|
|
||||||
|
|
||||||
### vscode ###
|
|
||||||
.vscode/*
|
|
||||||
!.vscode/tasks.json
|
|
||||||
!.vscode/launch.json
|
|
||||||
!.vscode/extensions.json
|
|
||||||
*.code-workspace
|
|
||||||
|
|
||||||
### Windows ###
|
|
||||||
# Windows thumbnail cache files
|
|
||||||
Thumbs.db
|
|
||||||
Thumbs.db:encryptable
|
|
||||||
ehthumbs.db
|
|
||||||
ehthumbs_vista.db
|
|
||||||
|
|
||||||
# Dump file
|
|
||||||
*.stackdump
|
|
||||||
|
|
||||||
# Folder config file
|
|
||||||
[Dd]esktop.ini
|
|
||||||
|
|
||||||
# Recycle Bin used on file shares
|
|
||||||
$RECYCLE.BIN/
|
|
||||||
|
|
||||||
# Windows shortcuts
|
|
||||||
*.lnk
|
|
||||||
|
|
||||||
# Conduit
|
|
||||||
conduit.toml
|
|
||||||
conduit.db
|
|
||||||
|
|
||||||
# Etc.
|
|
||||||
**/*.rs.bk
|
|
||||||
cached_target
|
|
||||||
|
|
||||||
# Nix artifacts
|
|
||||||
/result*
|
|
||||||
|
|
||||||
# Direnv cache
|
|
||||||
/.direnv
|
|
||||||
|
|
||||||
test-conduit/
|
|
||||||
test-conduit.toml
|
|
||||||
|
|
||||||
# Gitlab CI cache
|
|
||||||
/.gitlab-ci.d
|
|
||||||
|
|
||||||
# mdbook output
|
|
||||||
/public/
|
|
||||||
|
|
||||||
# macOS
|
|
||||||
.DS_Store
|
|
||||||
|
|
||||||
# VS Code
|
|
||||||
.vscode/
|
|
||||||
|
|
||||||
# Zed
|
|
||||||
.zed/
|
|
||||||
|
|
||||||
# idk where you're coming from, but i'm tired of you
|
|
||||||
rustc-ice-*
|
|
||||||
|
|
||||||
# complement test logs are huge
|
|
||||||
tests/test_results/complement/test_logs.jsonl
|
|
||||||
|
|
||||||
# Node
|
|
||||||
node_modules/
|
|
||||||
|
|
||||||
# Rspress
|
|
||||||
doc_build/
|
|
||||||
.rspress/
|
|
||||||
18
.mailmap
18
.mailmap
|
|
@ -1,18 +0,0 @@
|
||||||
AlexPewMaster <git@alex.unbox.at> <68469103+AlexPewMaster@users.noreply.github.com>
|
|
||||||
Daniel Wiesenberg <weasy@hotmail.de> <weasy666@gmail.com>
|
|
||||||
Devin Ragotzy <devin.ragotzy@gmail.com> <d6ragotzy@wmich.edu>
|
|
||||||
Devin Ragotzy <devin.ragotzy@gmail.com> <dragotzy7460@mail.kvcc.edu>
|
|
||||||
Ginger <ginger@gingershaped.computer> <75683114+gingershaped@users.noreply.github.com>
|
|
||||||
Jonas Platte <jplatte+git@posteo.de> <jplatte+gitlab@posteo.de>
|
|
||||||
Jonas Zohren <git-pbkyr@jzohren.de> <gitlab-jfowl-0ux98@sh14.de>
|
|
||||||
Jonathan de Jong <jonathan@automatia.nl> <jonathandejong02@gmail.com>
|
|
||||||
June Clementine Strawberry <june@3.dog> <june@girlboss.ceo>
|
|
||||||
June Clementine Strawberry <june@3.dog> <strawberry@pupbrain.dev>
|
|
||||||
June Clementine Strawberry <june@3.dog> <strawberry@puppygock.gay>
|
|
||||||
Olivia Lee <olivia@computer.surgery> <benjamin@computer.surgery>
|
|
||||||
Rudi Floren <rudi.floren@gmail.com> <rudi.floren@googlemail.com>
|
|
||||||
Tamara Schmitz <tamara.zoe.schmitz@posteo.de> <15906939+tamara-schmitz@users.noreply.github.com>
|
|
||||||
Timo Kösters <timo@koesters.xyz>
|
|
||||||
nexy7574 <git@nexy7574.co.uk> <nex@noreply.forgejo.ellis.link>
|
|
||||||
nexy7574 <git@nexy7574.co.uk> <nex@noreply.localhost>
|
|
||||||
x4u <xi.zhu@protonmail.ch> <14617923-x4u@users.noreply.gitlab.com>
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
.gitignore
|
|
||||||
|
|
@ -1,59 +0,0 @@
|
||||||
default_install_hook_types:
|
|
||||||
- pre-commit
|
|
||||||
- pre-push
|
|
||||||
- commit-msg
|
|
||||||
default_stages:
|
|
||||||
- pre-commit
|
|
||||||
- manual
|
|
||||||
|
|
||||||
repos:
|
|
||||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
||||||
rev: v6.0.0
|
|
||||||
hooks:
|
|
||||||
- id: fix-byte-order-marker
|
|
||||||
- id: check-case-conflict
|
|
||||||
- id: check-symlinks
|
|
||||||
- id: destroyed-symlinks
|
|
||||||
- id: check-yaml
|
|
||||||
- id: check-json
|
|
||||||
- id: check-toml
|
|
||||||
- id: end-of-file-fixer
|
|
||||||
- id: trailing-whitespace
|
|
||||||
- id: mixed-line-ending
|
|
||||||
- id: check-merge-conflict
|
|
||||||
- id: check-added-large-files
|
|
||||||
|
|
||||||
- repo: https://github.com/crate-ci/typos
|
|
||||||
rev: v1.44.0
|
|
||||||
hooks:
|
|
||||||
- id: typos
|
|
||||||
- id: typos
|
|
||||||
name: commit-msg-typos
|
|
||||||
stages: [commit-msg]
|
|
||||||
|
|
||||||
- repo: https://github.com/crate-ci/committed
|
|
||||||
rev: v1.1.11
|
|
||||||
hooks:
|
|
||||||
- id: committed
|
|
||||||
|
|
||||||
- repo: local
|
|
||||||
hooks:
|
|
||||||
- id: cargo-fmt
|
|
||||||
name: cargo fmt
|
|
||||||
entry: cargo +nightly fmt --
|
|
||||||
language: system
|
|
||||||
types: [rust]
|
|
||||||
pass_filenames: false
|
|
||||||
stages:
|
|
||||||
- pre-commit
|
|
||||||
|
|
||||||
- repo: local
|
|
||||||
hooks:
|
|
||||||
- id: cargo-clippy
|
|
||||||
name: cargo clippy
|
|
||||||
entry: cargo clippy -- -D warnings
|
|
||||||
language: system
|
|
||||||
pass_filenames: false
|
|
||||||
types: [rust]
|
|
||||||
stages:
|
|
||||||
- pre-push
|
|
||||||
28
.typos.toml
28
.typos.toml
|
|
@ -1,28 +0,0 @@
|
||||||
[files]
|
|
||||||
extend-exclude = ["*.csr", "*.lock", "pnpm-lock.yaml"]
|
|
||||||
|
|
||||||
[default]
|
|
||||||
|
|
||||||
extend-ignore-re = [
|
|
||||||
"(?Rm)^.*(#|//|<!--)\\s*spellchecker:disable-line(\\s*-->)$", # Ignore a line by making it trail with a `spellchecker:disable-line` comment
|
|
||||||
"^[0-9a-f]{7,}$", # Commit hashes
|
|
||||||
"4BA7",
|
|
||||||
# some heuristics for base64 strings
|
|
||||||
"[A-Za-z0-9+=]{72,}",
|
|
||||||
"([A-Za-z0-9+=]|\\\\\\s\\*){72,}",
|
|
||||||
"[0-9+][A-Za-z0-9+]{30,}[a-z0-9+]",
|
|
||||||
"\\$[A-Z0-9+][A-Za-z0-9+]{6,}[a-z0-9+]",
|
|
||||||
"\\b[a-z0-9+/=][A-Za-z0-9+/=]{7,}[a-z0-9+/=][A-Z]\\b",
|
|
||||||
# In the renovate config
|
|
||||||
".ontainer"
|
|
||||||
]
|
|
||||||
|
|
||||||
[default.extend-words]
|
|
||||||
"allocatedp" = "allocatedp"
|
|
||||||
"conduwuit" = "conduwuit"
|
|
||||||
"continuwuity" = "continuwuity"
|
|
||||||
"continuwity" = "continuwuity"
|
|
||||||
"execuse" = "execuse"
|
|
||||||
"oltp" = "OTLP"
|
|
||||||
|
|
||||||
rememvering = "remembering"
|
|
||||||
11
.vscode/settings.json
vendored
11
.vscode/settings.json
vendored
|
|
@ -1,11 +0,0 @@
|
||||||
{
|
|
||||||
"cSpell.words": [
|
|
||||||
"Forgejo",
|
|
||||||
"appservice",
|
|
||||||
"appservices",
|
|
||||||
"conduwuit",
|
|
||||||
"continuwuity",
|
|
||||||
"homeserver",
|
|
||||||
"homeservers"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
179
CHANGELOG.md
179
CHANGELOG.md
|
|
@ -1,179 +0,0 @@
|
||||||
# Continuwuity 0.5.6 (2026-03-03)
|
|
||||||
|
|
||||||
## Security
|
|
||||||
|
|
||||||
- Admin escape commands received over federation will never be executed, as this is never valid in a genuine situation. Contributed by @Jade.
|
|
||||||
- Fixed data amplification vulnerability (CWE-409) that affected configurations with server-side compression enabled (non-default). Contributed by @nex.
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
- Outgoing presence is now disabled by default, and the config option documentation has been adjusted to more accurately represent the weight of presence, typing indicators, and read receipts. Contributed by @nex. ([#1399](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1399))
|
|
||||||
- Improved the concurrency handling of federation transactions, vastly improving performance and reliability by more accurately handling inbound transactions and reducing the amount of repeated wasted work. Contributed by @nex and @Jade. ([#1428](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1428))
|
|
||||||
- Added [MSC3202](https://github.com/matrix-org/matrix-spec-proposals/pull/3202) Device masquerading (not all of MSC3202). This should fix issues with enabling [MSC4190](https://github.com/matrix-org/matrix-spec-proposals/pull/4190) for some Mautrix bridges. Contributed by @Jade ([#1435](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1435))
|
|
||||||
- Added [MSC3814](https://github.com/matrix-org/matrix-spec-proposals/pull/3814) Dehydrated Devices - you can now decrypt messages sent while all devices were logged out. ([#1436](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1436))
|
|
||||||
- Implement [MSC4143](https://github.com/matrix-org/matrix-spec-proposals/pull/4143) MatrixRTC transport discovery endpoint. Move RTC foci configuration from `[global.well_known]` to a new `[global.matrix_rtc]` section with a `foci` field. Contributed by @0xnim ([#1442](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1442))
|
|
||||||
- Updated `list-backups` admin command to output one backup per line. ([#1394](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1394))
|
|
||||||
- Improved URL preview fetching with a more compatible user agent for sites like YouTube Music. Added `!admin media delete-url-preview <url>` command to clear cached URL previews that were stuck and broken. ([#1434](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1434))
|
|
||||||
|
|
||||||
## Bugfixes
|
|
||||||
|
|
||||||
- Removed non-compliant nor functional room alias lookups over federation. Contributed by @nex ([#1393](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1393))
|
|
||||||
- Removed ability to set rocksdb as read only. Doing so would cause unintentional and buggy behaviour. Contributed by @Terryiscool160. ([#1418](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1418))
|
|
||||||
- Fixed a startup crash in the sender service if we can't detect the number of CPU cores, even if the `sender_workers` config option is set correctly. Contributed by @katie. ([#1421](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1421))
|
|
||||||
- Removed the `allow_public_room_directory_without_auth` config option. Contributed by @0xnim. ([#1441](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1441))
|
|
||||||
- Fixed sliding sync v5 list ranges always starting from 0, causing extra rooms to be unnecessarily processed and returned. Contributed by @0xnim ([#1445](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1445))
|
|
||||||
- Fixed a bug that (repairably) caused a room split between continuwuity and non-continuwuity servers when the room had both `m.room.policy` and `org.matrix.msc4284.policy` in its room state. Contributed by @nex ([#1481](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1481))
|
|
||||||
- Fixed `!admin media delete --mxc <url>` responding with an error message when the media was deleted successfully. Contributed by @lynxize
|
|
||||||
- Fixed spurious 404 media errors in the logs. Contributed by @benbot.
|
|
||||||
- Fixed spurious warn about needed backfill via federation for non-federated rooms. Contributed by @kraem.
|
|
||||||
|
|
||||||
# Continuwuity v0.5.5 (2026-02-15)
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
- Added unstable support for [MSC4406:
|
|
||||||
`M_SENDER_IGNORED`](https://github.com/matrix-org/matrix-spec-proposals/pull/4406).
|
|
||||||
Contributed by @nex ([#1308](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1308))
|
|
||||||
- Introduce a resolver command to allow flushing a server from the cache or to flush the complete cache. Contributed by
|
|
||||||
@Omar007 ([#1349](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1349))
|
|
||||||
- Improved the handling of restricted join rules and improved the performance of local-first joins. Contributed by
|
|
||||||
@nex. ([#1368](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1368))
|
|
||||||
- You can now set a custom User Agent for URL previews; the default one has been modified to be less likely to be
|
|
||||||
rejected. Contributed by @trashpanda ([#1372](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1372))
|
|
||||||
- Improved the first-time setup experience for new homeserver administrators:
|
|
||||||
- Account registration is disabled on the first run, except for with a new special registration token that is logged
|
|
||||||
to the console.
|
|
||||||
- Other helpful information is logged to the console as well, including a giant warning if open registration is
|
|
||||||
enabled.
|
|
||||||
- The default index page now says to check the console for setup instructions if no accounts have been created.
|
|
||||||
- Once the first admin account is created, an improved welcome message is sent to the admin room.
|
|
||||||
|
|
||||||
Contributed by @ginger.
|
|
||||||
|
|
||||||
## Bugfixes
|
|
||||||
|
|
||||||
- Fixed invites sent to other users in the same homeserver not being properly sent down sync. Users with missing or
|
|
||||||
broken invites should clear their client caches after updating to make them appear. ([#1249](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1249))
|
|
||||||
- LDAP-enabled servers will no longer have all admins demoted when LDAP-controlled admins are not configured.
|
|
||||||
Contributed by @Jade ([#1307](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1307))
|
|
||||||
- Fixed sliding sync not resolving wildcard state key requests, enabling Video/Audio calls in Element X. ([#1370](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1370))
|
|
||||||
|
|
||||||
## Misc
|
|
||||||
|
|
||||||
- #1344
|
|
||||||
|
|
||||||
# Continuwuity v0.5.4 (2026-02-08)
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
- The announcement checker will now announce errors it encounters in the first run to the admin room, plus a few other
|
|
||||||
misc improvements. Contributed by @Jade ([#1288](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1288))
|
|
||||||
- Drastically improved the performance and reliability of account deactivations. Contributed by
|
|
||||||
@nex ([#1314](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1314))
|
|
||||||
- Refuse to process requests for and events in rooms that we no longer have any local users in (reduces state resets
|
|
||||||
and improves performance). Contributed by
|
|
||||||
@nex ([#1316](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1316))
|
|
||||||
- Added server-specific admin API routes to ban and unban rooms, for use with moderation bots. Contributed by @nex
|
|
||||||
([#1301](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1301))
|
|
||||||
|
|
||||||
## Bugfixes
|
|
||||||
|
|
||||||
- Fix the generated configuration containing uncommented optional sections. Contributed by
|
|
||||||
@Jade ([#1290](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1290))
|
|
||||||
- Fixed specification non-compliance when handling remote media errors. Contributed by
|
|
||||||
@nex ([#1298](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1298))
|
|
||||||
- UIAA requests which check for out-of-band success (sent by matrix-js-sdk) will no longer create unhelpful errors in
|
|
||||||
the logs. Contributed by @ginger ([#1305](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1305))
|
|
||||||
- Use exists instead of contains to save writing to a buffer in `src/service/users/mod.rs`: `is_login_disabled`.
|
|
||||||
Contributed
|
|
||||||
by @aprilgrimoire. ([#1340](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1340))
|
|
||||||
- Fixed backtraces being swallowed during panics. Contributed by
|
|
||||||
@jade ([#1337](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1337))
|
|
||||||
- Fixed a potential vulnerability that could allow an evil remote server to return malicious events during the room join
|
|
||||||
and knock process. Contributed by @nex, reported by violet & [mat](https://matdoes.dev).
|
|
||||||
- Fixed a race condition that could result in outlier PDUs being incorrectly marked as visible to a remote server.
|
|
||||||
Contributed by @nex, reported by violet & [mat](https://matdoes.dev).
|
|
||||||
- ACLs are no longer case-sensitive. Contributed by @nex, reported by [vel](matrix:u/vel:nhjkl.com?action=chat).
|
|
||||||
|
|
||||||
## Docs
|
|
||||||
|
|
||||||
- Fixed Fedora install instructions. Contributed by
|
|
||||||
@julian45 ([#1342](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1342))
|
|
||||||
|
|
||||||
# Continuwuity 0.5.3 (2026-01-12)
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
- Improve the display of nested configuration with the `!admin server show-config` command. Contributed by
|
|
||||||
@Jade ([#1279](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1279))
|
|
||||||
|
|
||||||
## Bugfixes
|
|
||||||
|
|
||||||
- Fixed `M_BAD_JSON` error when sending invites to other servers or when providing joins. Contributed by
|
|
||||||
@nex ([#1286](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1286))
|
|
||||||
|
|
||||||
## Docs
|
|
||||||
|
|
||||||
- Improve admin command documentation generation. Contributed by
|
|
||||||
@ginger ([#1280](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1280))
|
|
||||||
|
|
||||||
## Misc
|
|
||||||
|
|
||||||
- Improve timeout-related code for federation and URL previews. Contributed by
|
|
||||||
@Jade ([#1278](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1278))
|
|
||||||
|
|
||||||
# Continuwuity 0.5.2 (2026-01-09)
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
- Added support for issuing additional registration tokens, stored in the database, which supplement the existing
|
|
||||||
registration token hardcoded in the config file. These tokens may optionally expire after a certain number of uses or
|
|
||||||
after a certain amount of time has passed. Additionally, the `registration_token_file` configuration option is
|
|
||||||
superseded by this feature and **has been removed**. Use the new `!admin token` command family to manage registration
|
|
||||||
tokens. Contributed by @ginger (#783).
|
|
||||||
- Implemented a configuration defined admin list independent of the admin room. Contributed by
|
|
||||||
@Terryiscool160. ([#1253](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1253))
|
|
||||||
- Added support for invite and join anti-spam via Draupnir and Meowlnir, similar to that of synapse-http-antispam.
|
|
||||||
Contributed by @nex. ([#1263](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1263))
|
|
||||||
- Implemented account locking functionality, to complement user suspension. Contributed by
|
|
||||||
@nex. ([#1266](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1266))
|
|
||||||
- Added admin command to forcefully log out all of a user's existing sessions. Contributed by
|
|
||||||
@nex. ([#1271](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1271))
|
|
||||||
- Implemented toggling the ability for an account to log in without mutating any of its data. Contributed by @nex. (
|
|
||||||
[#1272](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1272))
|
|
||||||
- Add support for custom room create event timestamps, to allow generating custom prefixes in hashed room IDs.
|
|
||||||
Contributed by @nex. ([#1277](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1277))
|
|
||||||
- Certain potentially dangerous admin commands are now restricted to only be usable in the admin room and server
|
|
||||||
console. Contributed by @ginger.
|
|
||||||
|
|
||||||
## Bugfixes
|
|
||||||
|
|
||||||
- Fixed unreliable room summary fetching and improved error messages. Contributed by
|
|
||||||
@nex. ([#1257](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1257))
|
|
||||||
- Client requested timeout parameter is now applied to e2ee key lookups and claims. Related federation requests are now
|
|
||||||
also concurrent. Contributed by @nex. ([#1261](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1261))
|
|
||||||
- Fixed the whoami endpoint returning HTTP 404 instead of HTTP 403, which confused some appservices. Contributed by
|
|
||||||
@nex. ([#1276](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1276))
|
|
||||||
|
|
||||||
## Misc
|
|
||||||
|
|
||||||
- The `console` feature is now enabled by default, allowing the server console to be used for running admin commands
|
|
||||||
directly. To automatically open the console on startup, set the `admin_console_automatic` config option to `true`.
|
|
||||||
Contributed by @ginger.
|
|
||||||
- We now (finally) document our container image mirrors. Contributed by @Jade
|
|
||||||
|
|
||||||
# Continuwuity 0.5.0 (2025-12-30)
|
|
||||||
|
|
||||||
**This release contains a CRITICAL vulnerability patch, and you must update as soon as possible**
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
- Enabled the OTLP exporter in default builds, and allow configuring the exporter protocol. (
|
|
||||||
@Jade). ([#1251](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1251))
|
|
||||||
|
|
||||||
## Bug Fixes
|
|
||||||
|
|
||||||
- Don't allow admin room upgrades, as this can break the admin room (
|
|
||||||
@timedout) ([#1245](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1245))
|
|
||||||
- Fix invalid creators in power levels during upgrade to v12 (
|
|
||||||
@timedout) ([#1245](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1245))
|
|
||||||
|
|
@ -1,131 +0,0 @@
|
||||||
# Contributor Covenant Code of Conduct
|
|
||||||
|
|
||||||
## Our Pledge
|
|
||||||
|
|
||||||
We as members, contributors, and leaders pledge to make participation in our
|
|
||||||
community a harassment-free experience for everyone, regardless of age, body
|
|
||||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
||||||
identity and expression, level of experience, education, socio-economic status,
|
|
||||||
nationality, personal appearance, race, caste, color, religion, or sexual
|
|
||||||
identity and orientation.
|
|
||||||
|
|
||||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
||||||
diverse, inclusive, and healthy community.
|
|
||||||
|
|
||||||
## 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
|
|
||||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
||||||
and learning from the experience
|
|
||||||
* Focusing on what is best not just for us as individuals, but for the overall
|
|
||||||
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
|
|
||||||
* Publishing others' private information, such as a physical or email address,
|
|
||||||
without their explicit permission
|
|
||||||
* Other conduct which could reasonably be considered inappropriate in a
|
|
||||||
professional setting
|
|
||||||
|
|
||||||
## Enforcement Responsibilities
|
|
||||||
|
|
||||||
Community leaders are responsible for clarifying and enforcing our standards of
|
|
||||||
acceptable behavior and will take appropriate and fair corrective action in
|
|
||||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
||||||
or harmful.
|
|
||||||
|
|
||||||
Community leaders have the right and responsibility to remove, edit, or reject
|
|
||||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
||||||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
||||||
decisions when appropriate.
|
|
||||||
|
|
||||||
## Scope
|
|
||||||
|
|
||||||
This Code of Conduct applies within all community spaces, and also applies when
|
|
||||||
an individual is officially representing the community in public spaces.
|
|
||||||
Examples of representing our community include using an official e-mail address,
|
|
||||||
posting via an official social media account, or acting as an appointed
|
|
||||||
representative at an online or offline event.
|
|
||||||
|
|
||||||
## Enforcement
|
|
||||||
|
|
||||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
||||||
reported to the community leaders responsible for enforcement over Matrix at [#continuwuity:continuwuity.org](https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org) or email at <tom@tcpip.uk>, <jade@continuwuity.org> and <nex@continuwuity.org> respectively.
|
|
||||||
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
|
|
||||||
|
|
||||||
Community leaders will follow these Community Impact Guidelines in determining
|
|
||||||
the consequences for any action they deem in violation of this Code of Conduct:
|
|
||||||
|
|
||||||
### 1. Correction
|
|
||||||
|
|
||||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
||||||
unprofessional or unwelcome in the community.
|
|
||||||
|
|
||||||
**Consequence**: A private, written warning from community leaders, providing
|
|
||||||
clarity around the nature of the violation and an explanation of why the
|
|
||||||
behavior was inappropriate. A public apology may be requested.
|
|
||||||
|
|
||||||
### 2. Warning
|
|
||||||
|
|
||||||
**Community Impact**: A violation through a single incident or series of
|
|
||||||
actions.
|
|
||||||
|
|
||||||
**Consequence**: A warning with consequences for continued behavior. No
|
|
||||||
interaction with the people involved, including unsolicited interaction with
|
|
||||||
those enforcing the Code of Conduct, for a specified period of time. This
|
|
||||||
includes avoiding interactions in community spaces as well as external channels
|
|
||||||
like social media. Violating these terms may lead to a temporary or permanent
|
|
||||||
ban.
|
|
||||||
|
|
||||||
### 3. Temporary Ban
|
|
||||||
|
|
||||||
**Community Impact**: A serious violation of community standards, including
|
|
||||||
sustained inappropriate behavior.
|
|
||||||
|
|
||||||
**Consequence**: A temporary ban from any sort of interaction or public
|
|
||||||
communication with the community for a specified period of time. No public or
|
|
||||||
private interaction with the people involved, including unsolicited interaction
|
|
||||||
with those enforcing the Code of Conduct, is allowed during this period.
|
|
||||||
Violating these terms may lead to a permanent ban.
|
|
||||||
|
|
||||||
### 4. Permanent Ban
|
|
||||||
|
|
||||||
**Community Impact**: Demonstrating a pattern of violation of community
|
|
||||||
standards, including sustained inappropriate behavior, harassment of an
|
|
||||||
individual, or aggression toward or disparagement of classes of individuals.
|
|
||||||
|
|
||||||
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
||||||
community.
|
|
||||||
|
|
||||||
## Attribution
|
|
||||||
|
|
||||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
||||||
version 2.1, available at
|
|
||||||
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
|
||||||
|
|
||||||
Community Impact Guidelines were inspired by
|
|
||||||
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
|
||||||
|
|
||||||
For answers to common questions about this code of conduct, see the FAQ at
|
|
||||||
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
|
||||||
[https://www.contributor-covenant.org/translations][translations].
|
|
||||||
|
|
||||||
[homepage]: https://www.contributor-covenant.org
|
|
||||||
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
||||||
[Mozilla CoC]: https://github.com/mozilla/diversity
|
|
||||||
[FAQ]: https://www.contributor-covenant.org/faq
|
|
||||||
[translations]: https://www.contributor-covenant.org/translations
|
|
||||||
177
CONTRIBUTING.md
177
CONTRIBUTING.md
|
|
@ -1,177 +0,0 @@
|
||||||
# Contributing guide
|
|
||||||
|
|
||||||
This page is about contributing to Continuwuity. The
|
|
||||||
[development](/development/index.mdx) and [code style guide](/development/code_style.mdx) pages 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 [#continuwuity:continuwuity.org][continuwuity-matrix],
|
|
||||||
and comment on it.
|
|
||||||
|
|
||||||
### Code Style
|
|
||||||
|
|
||||||
Please review and follow the [code style guide](/development/code_style.mdx) for formatting, linting, naming conventions, and other code standards.
|
|
||||||
|
|
||||||
### Pre-commit Checks
|
|
||||||
|
|
||||||
Continuwuity uses pre-commit hooks to enforce various coding standards and catch common issues before they're committed. These checks include:
|
|
||||||
|
|
||||||
- Code formatting and linting
|
|
||||||
- Typo detection (both in code and commit messages)
|
|
||||||
- Checking for large files
|
|
||||||
- Ensuring proper line endings and no trailing whitespace
|
|
||||||
- Validating YAML, JSON, and TOML files
|
|
||||||
- Checking for merge conflicts
|
|
||||||
|
|
||||||
You can run these checks locally by installing [prek](https://github.com/j178/prek):
|
|
||||||
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Install prek using cargo-binstall
|
|
||||||
cargo binstall prek
|
|
||||||
|
|
||||||
# Install git hooks to run checks automatically
|
|
||||||
prek install
|
|
||||||
|
|
||||||
# Run all checks
|
|
||||||
prek --all-files
|
|
||||||
```
|
|
||||||
|
|
||||||
Alternatively, you can use [pre-commit](https://pre-commit.com/):
|
|
||||||
```bash
|
|
||||||
# Requires python
|
|
||||||
|
|
||||||
# Install pre-commit
|
|
||||||
pip install pre-commit
|
|
||||||
|
|
||||||
# Install the hooks
|
|
||||||
pre-commit install
|
|
||||||
|
|
||||||
# Run all checks manually
|
|
||||||
pre-commit run --all-files
|
|
||||||
```
|
|
||||||
|
|
||||||
These same checks are run in CI via the prek-checks workflow to ensure consistency. These must pass before the PR is merged.
|
|
||||||
|
|
||||||
### Running tests locally
|
|
||||||
|
|
||||||
Tests, compilation, and linting can be run with standard Cargo commands:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Run tests
|
|
||||||
cargo test
|
|
||||||
|
|
||||||
# Check compilation
|
|
||||||
cargo check --workspace --features full
|
|
||||||
|
|
||||||
# Run lints
|
|
||||||
cargo clippy --workspace --features full
|
|
||||||
# Auto-fix: cargo clippy --workspace --features full --fix --allow-staged;
|
|
||||||
|
|
||||||
# Format code (must use nightly)
|
|
||||||
cargo +nightly fmt
|
|
||||||
```
|
|
||||||
|
|
||||||
### Matrix tests
|
|
||||||
|
|
||||||
Continuwuity uses [Complement][complement] for Matrix protocol compliance testing. Complement tests are run manually by developers, and documentation on how to run these tests locally is currently being developed.
|
|
||||||
|
|
||||||
If your changes are done to fix Matrix tests, please note that in your pull request. If more Complement tests start failing from your changes, please review the logs and determine if they're intended or not.
|
|
||||||
|
|
||||||
[Sytest][sytest] is currently unsupported.
|
|
||||||
|
|
||||||
### Writing documentation
|
|
||||||
|
|
||||||
Continuwuity's website uses [`rspress`][rspress] and is deployed via CI using Cloudflare Pages
|
|
||||||
in the [`documentation.yml`][documentation.yml] workflow file. All documentation is in the `docs/`
|
|
||||||
directory at the top level.
|
|
||||||
|
|
||||||
To load the documentation locally:
|
|
||||||
|
|
||||||
1. Install NodeJS and npm from their [official website][nodejs-download] or via your package manager of choice
|
|
||||||
|
|
||||||
2. From the project's root directory, install the relevant npm modules
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm ci
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Make changes to the document pages as you see fit
|
|
||||||
|
|
||||||
4. Generate a live preview of the documentation
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run docs:dev
|
|
||||||
```
|
|
||||||
|
|
||||||
A webserver for the docs will be spun up for you (e.g. at `http://localhost:3000`). Any changes you make to the documentation will be live-reloaded on the webpage.
|
|
||||||
|
|
||||||
Alternatively, you can build the documentation using `npm run docs:build` - the output of this will be in the `/doc_build` directory. Once you're happy with your documentation updates, you can commit the changes.
|
|
||||||
|
|
||||||
### Commit Messages
|
|
||||||
|
|
||||||
Continuwuity follows the [Conventional Commits](https://www.conventionalcommits.org/) specification for commit messages. This provides a standardized format that makes the commit history more readable and enables automated tools to generate changelogs.
|
|
||||||
|
|
||||||
The basic structure is:
|
|
||||||
|
|
||||||
```
|
|
||||||
<type>[(optional scope)]: <description>
|
|
||||||
|
|
||||||
[optional body]
|
|
||||||
|
|
||||||
[optional footer(s)]
|
|
||||||
```
|
|
||||||
|
|
||||||
The allowed types for commits are:
|
|
||||||
- `fix`: Bug fixes
|
|
||||||
- `feat`: New features
|
|
||||||
- `docs`: Documentation changes
|
|
||||||
- `style`: Changes that don't affect the meaning of the code (formatting, etc.)
|
|
||||||
- `refactor`: Code changes that neither fix bugs nor add features
|
|
||||||
- `perf`: Performance improvements
|
|
||||||
- `test`: Adding or fixing tests
|
|
||||||
- `build`: Changes to the build system or dependencies
|
|
||||||
- `ci`: Changes to CI configuration
|
|
||||||
- `chore`: Other changes that don't modify source or test files
|
|
||||||
|
|
||||||
Examples:
|
|
||||||
```
|
|
||||||
feat: add user authentication
|
|
||||||
fix(database): resolve connection pooling issue
|
|
||||||
docs: update installation instructions
|
|
||||||
```
|
|
||||||
|
|
||||||
The project uses the `committed` hook to validate commit messages in pre-commit. This ensures all commits follow the conventional format.
|
|
||||||
|
|
||||||
### Creating pull requests
|
|
||||||
|
|
||||||
Please try to keep contributions to the Forgejo Instance. While the mirrors of continuwuity
|
|
||||||
allow for pull/merge requests, there is no guarantee the maintainers will see them in a timely
|
|
||||||
manner. Additionally, please mark WIP or unfinished or incomplete PRs as drafts.
|
|
||||||
This prevents us from having to ping once in a while to double check the status
|
|
||||||
of it, especially when the CI completed successfully and everything so it
|
|
||||||
*looks* done.
|
|
||||||
|
|
||||||
Before submitting a pull request, please ensure:
|
|
||||||
1. Your code passes all CI checks (formatting, linting, typo detection, etc.)
|
|
||||||
2. Your code follows the [code style guide](/development/code_style.md)
|
|
||||||
3. Your commit messages follow the conventional commits format
|
|
||||||
4. Tests are added for new functionality
|
|
||||||
5. Documentation is updated if needed
|
|
||||||
|
|
||||||
Direct all PRs/MRs to the `main` branch.
|
|
||||||
|
|
||||||
By sending a pull request or patch, you are agreeing that your changes are
|
|
||||||
allowed to be licenced under the Apache-2.0 licence and all of your conduct is
|
|
||||||
in line with the Contributor's Covenant, and continuwuity's Code of Conduct.
|
|
||||||
|
|
||||||
Contribution by users who violate either of these code of conducts may not have
|
|
||||||
their contributions accepted. This includes users who have been banned from
|
|
||||||
continuwuity Matrix rooms for Code of Conduct violations.
|
|
||||||
|
|
||||||
[issues]: https://forgejo.ellis.link/continuwuation/continuwuity/issues
|
|
||||||
[continuwuity-matrix]: https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org
|
|
||||||
[complement]: https://github.com/matrix-org/complement/
|
|
||||||
[sytest]: https://github.com/matrix-org/sytest/
|
|
||||||
[nodejs-download]: https://nodejs.org/en/download
|
|
||||||
[rspress]: https://rspress.rs/
|
|
||||||
[documentation.yml]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/.forgejo/workflows/documentation.yml
|
|
||||||
6937
Cargo.lock
generated
6937
Cargo.lock
generated
File diff suppressed because it is too large
Load diff
974
Cargo.toml
974
Cargo.toml
|
|
@ -1,974 +0,0 @@
|
||||||
[workspace]
|
|
||||||
resolver = "2"
|
|
||||||
members = ["src/*", "xtask/"]
|
|
||||||
default-members = ["src/*"]
|
|
||||||
|
|
||||||
[workspace.package]
|
|
||||||
authors = ["Continuwuity Team and contributors <team@continuwuity.org>"]
|
|
||||||
description = "A Matrix homeserver written in Rust, the official continuation of the conduwuit homeserver."
|
|
||||||
edition = "2024"
|
|
||||||
homepage = "https://continuwuity.org/"
|
|
||||||
license = "Apache-2.0"
|
|
||||||
# See also `rust-toolchain.toml`
|
|
||||||
readme = "README.md"
|
|
||||||
repository = "https://forgejo.ellis.link/continuwuation/continuwuity"
|
|
||||||
version = "0.5.7-alpha.1"
|
|
||||||
|
|
||||||
[workspace.metadata.crane]
|
|
||||||
name = "conduwuit"
|
|
||||||
|
|
||||||
[workspace.dependencies.arrayvec]
|
|
||||||
version = "0.7.6"
|
|
||||||
features = ["serde"]
|
|
||||||
|
|
||||||
[workspace.dependencies.smallvec]
|
|
||||||
version = "1.14.0"
|
|
||||||
features = [
|
|
||||||
"const_generics",
|
|
||||||
"const_new",
|
|
||||||
"serde",
|
|
||||||
"union",
|
|
||||||
"write",
|
|
||||||
]
|
|
||||||
|
|
||||||
[workspace.dependencies.smallstr]
|
|
||||||
version = "0.3"
|
|
||||||
features = ["ffi", "std", "union"]
|
|
||||||
|
|
||||||
[workspace.dependencies.const-str]
|
|
||||||
version = "0.7.0"
|
|
||||||
|
|
||||||
[workspace.dependencies.ctor]
|
|
||||||
version = "0.6.0"
|
|
||||||
|
|
||||||
[workspace.dependencies.cargo_toml]
|
|
||||||
version = "0.22"
|
|
||||||
default-features = false
|
|
||||||
features = ["features"]
|
|
||||||
|
|
||||||
[workspace.dependencies.toml]
|
|
||||||
version = "0.9.5"
|
|
||||||
default-features = false
|
|
||||||
features = ["parse"]
|
|
||||||
|
|
||||||
[workspace.dependencies.sanitize-filename]
|
|
||||||
version = "0.6.0"
|
|
||||||
|
|
||||||
[workspace.dependencies.base64]
|
|
||||||
version = "0.22.1"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
# used for TURN server authentication
|
|
||||||
[workspace.dependencies.hmac]
|
|
||||||
version = "0.12.1"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
# used for checking if an IP is in specific subnets / CIDR ranges easier
|
|
||||||
[workspace.dependencies.ipaddress]
|
|
||||||
version = "0.1.3"
|
|
||||||
|
|
||||||
[workspace.dependencies.rand]
|
|
||||||
version = "0.10.0"
|
|
||||||
|
|
||||||
# Used for the http request / response body type for Ruma endpoints used with reqwest
|
|
||||||
[workspace.dependencies.bytes]
|
|
||||||
version = "1.10.1"
|
|
||||||
|
|
||||||
[workspace.dependencies.http-body-util]
|
|
||||||
version = "0.1.3"
|
|
||||||
|
|
||||||
[workspace.dependencies.http]
|
|
||||||
version = "1.3.1"
|
|
||||||
|
|
||||||
[workspace.dependencies.regex]
|
|
||||||
version = "1.11.1"
|
|
||||||
|
|
||||||
[workspace.dependencies.axum]
|
|
||||||
version = "0.8.8"
|
|
||||||
default-features = false
|
|
||||||
features = [
|
|
||||||
"form",
|
|
||||||
"http1",
|
|
||||||
"http2",
|
|
||||||
"json",
|
|
||||||
"matched-path",
|
|
||||||
"tokio",
|
|
||||||
"tracing",
|
|
||||||
]
|
|
||||||
|
|
||||||
[workspace.dependencies.axum-extra]
|
|
||||||
version = "0.12.0"
|
|
||||||
default-features = false
|
|
||||||
features = ["typed-header", "tracing", "cookie"]
|
|
||||||
|
|
||||||
[workspace.dependencies.axum-server]
|
|
||||||
version = "0.7.2"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
# to listen on both HTTP and HTTPS if listening on TLS dierctly from conduwuit for complement or sytest
|
|
||||||
[workspace.dependencies.axum-server-dual-protocol]
|
|
||||||
version = "0.7"
|
|
||||||
|
|
||||||
[workspace.dependencies.axum-client-ip]
|
|
||||||
version = "0.7"
|
|
||||||
|
|
||||||
[workspace.dependencies.tower]
|
|
||||||
version = "0.5.2"
|
|
||||||
default-features = false
|
|
||||||
features = ["util"]
|
|
||||||
|
|
||||||
[workspace.dependencies.tower-http]
|
|
||||||
version = "0.6.8"
|
|
||||||
default-features = false
|
|
||||||
features = [
|
|
||||||
"add-extension",
|
|
||||||
"catch-panic",
|
|
||||||
"cors",
|
|
||||||
"sensitive-headers",
|
|
||||||
"set-header",
|
|
||||||
"timeout",
|
|
||||||
"trace",
|
|
||||||
"util",
|
|
||||||
]
|
|
||||||
|
|
||||||
[workspace.dependencies.rustls]
|
|
||||||
version = "0.23.25"
|
|
||||||
default-features = false
|
|
||||||
features = ["aws_lc_rs"]
|
|
||||||
|
|
||||||
[workspace.dependencies.reqwest]
|
|
||||||
version = "0.12.15"
|
|
||||||
default-features = false
|
|
||||||
features = [
|
|
||||||
"rustls-tls-native-roots",
|
|
||||||
"socks",
|
|
||||||
"hickory-dns",
|
|
||||||
"http2",
|
|
||||||
"stream",
|
|
||||||
]
|
|
||||||
|
|
||||||
[workspace.dependencies.serde]
|
|
||||||
version = "1.0.219"
|
|
||||||
default-features = false
|
|
||||||
features = ["rc"]
|
|
||||||
|
|
||||||
[workspace.dependencies.serde_json]
|
|
||||||
version = "1.0.140"
|
|
||||||
default-features = false
|
|
||||||
features = ["raw_value"]
|
|
||||||
|
|
||||||
# Used for appservice registration files
|
|
||||||
[workspace.dependencies.serde-saphyr]
|
|
||||||
version = "0.0.21"
|
|
||||||
|
|
||||||
# Used to load forbidden room/user regex from config
|
|
||||||
[workspace.dependencies.serde_regex]
|
|
||||||
version = "1.1.0"
|
|
||||||
|
|
||||||
# Used for ruma wrapper
|
|
||||||
[workspace.dependencies.serde_html_form]
|
|
||||||
version = "0.2.6"
|
|
||||||
|
|
||||||
# Used for password hashing
|
|
||||||
[workspace.dependencies.argon2]
|
|
||||||
version = "0.5.3"
|
|
||||||
features = ["alloc", "rand"]
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
# Used to generate thumbnails for images & blurhashes
|
|
||||||
[workspace.dependencies.image]
|
|
||||||
version = "0.25.5"
|
|
||||||
default-features = false
|
|
||||||
features = [
|
|
||||||
"jpeg",
|
|
||||||
"png",
|
|
||||||
"gif",
|
|
||||||
"webp",
|
|
||||||
]
|
|
||||||
|
|
||||||
[workspace.dependencies.blurhash]
|
|
||||||
version = "0.2.3"
|
|
||||||
default-features = false
|
|
||||||
features = [
|
|
||||||
"fast-linear-to-srgb",
|
|
||||||
"image",
|
|
||||||
]
|
|
||||||
|
|
||||||
# logging
|
|
||||||
[workspace.dependencies.log]
|
|
||||||
version = "0.4.27"
|
|
||||||
default-features = false
|
|
||||||
[workspace.dependencies.tracing]
|
|
||||||
version = "0.1.41"
|
|
||||||
default-features = false
|
|
||||||
[workspace.dependencies.tracing-subscriber]
|
|
||||||
version = "0.3.20"
|
|
||||||
default-features = false
|
|
||||||
features = ["env-filter", "std", "tracing", "tracing-log", "ansi", "fmt"]
|
|
||||||
[workspace.dependencies.tracing-journald]
|
|
||||||
version = "0.3.1"
|
|
||||||
[workspace.dependencies.tracing-core]
|
|
||||||
version = "0.1.34"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
# for URL previews
|
|
||||||
[workspace.dependencies.webpage]
|
|
||||||
version = "2.0.1"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
# used for conduwuit's CLI and admin room command parsing
|
|
||||||
[workspace.dependencies.clap]
|
|
||||||
version = "4.5.35"
|
|
||||||
default-features = false
|
|
||||||
features = [
|
|
||||||
"derive",
|
|
||||||
"env",
|
|
||||||
"error-context",
|
|
||||||
"help",
|
|
||||||
"std",
|
|
||||||
"string",
|
|
||||||
"usage",
|
|
||||||
]
|
|
||||||
|
|
||||||
[workspace.dependencies.futures]
|
|
||||||
version = "0.3.31"
|
|
||||||
default-features = false
|
|
||||||
features = ["std", "async-await"]
|
|
||||||
|
|
||||||
[workspace.dependencies.tokio]
|
|
||||||
version = "1.44.2"
|
|
||||||
default-features = false
|
|
||||||
features = [
|
|
||||||
"fs",
|
|
||||||
"net",
|
|
||||||
"macros",
|
|
||||||
"sync",
|
|
||||||
"signal",
|
|
||||||
"time",
|
|
||||||
"rt-multi-thread",
|
|
||||||
"io-util",
|
|
||||||
"tracing",
|
|
||||||
]
|
|
||||||
|
|
||||||
[workspace.dependencies.tokio-metrics]
|
|
||||||
version = "0.4.0"
|
|
||||||
|
|
||||||
[workspace.dependencies.libloading]
|
|
||||||
version = "0.9.0"
|
|
||||||
|
|
||||||
# Validating urls in config, was already a transitive dependency
|
|
||||||
[workspace.dependencies.url]
|
|
||||||
version = "2.5.4"
|
|
||||||
default-features = false
|
|
||||||
features = ["serde"]
|
|
||||||
|
|
||||||
# standard date and time tools
|
|
||||||
[workspace.dependencies.chrono]
|
|
||||||
version = "0.4.38"
|
|
||||||
features = ["alloc", "std"]
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
[workspace.dependencies.hyper]
|
|
||||||
version = "1.6.0"
|
|
||||||
default-features = false
|
|
||||||
features = [
|
|
||||||
"server",
|
|
||||||
"http1",
|
|
||||||
"http2",
|
|
||||||
]
|
|
||||||
|
|
||||||
[workspace.dependencies.hyper-util]
|
|
||||||
version = "=0.1.17"
|
|
||||||
default-features = false
|
|
||||||
features = [
|
|
||||||
"server-auto",
|
|
||||||
"server-graceful",
|
|
||||||
"tokio",
|
|
||||||
]
|
|
||||||
|
|
||||||
# to support multiple variations of setting a config option
|
|
||||||
[workspace.dependencies.either]
|
|
||||||
version = "1.15.0"
|
|
||||||
default-features = false
|
|
||||||
features = ["serde"]
|
|
||||||
|
|
||||||
# Used for reading the configuration from continuwuity.toml & environment variables
|
|
||||||
[workspace.dependencies.figment]
|
|
||||||
version = "0.10.19"
|
|
||||||
default-features = false
|
|
||||||
features = ["env", "toml"]
|
|
||||||
|
|
||||||
[workspace.dependencies.hickory-resolver]
|
|
||||||
version = "0.25.2"
|
|
||||||
default-features = false
|
|
||||||
features = [
|
|
||||||
"serde",
|
|
||||||
"system-config",
|
|
||||||
"tokio",
|
|
||||||
]
|
|
||||||
|
|
||||||
# Used for conduwuit::Error type
|
|
||||||
[workspace.dependencies.thiserror]
|
|
||||||
version = "2.0.12"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
# Used when hashing the state
|
|
||||||
[workspace.dependencies.ring]
|
|
||||||
version = "0.17.14"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
# Used to make working with iterators easier, was already a transitive depdendency
|
|
||||||
[workspace.dependencies.itertools]
|
|
||||||
version = "0.14.0"
|
|
||||||
|
|
||||||
# to parse user-friendly time durations in admin commands
|
|
||||||
#TODO: overlaps chrono?
|
|
||||||
[workspace.dependencies.cyborgtime]
|
|
||||||
version = "2.1.1"
|
|
||||||
|
|
||||||
# used for MPSC channels
|
|
||||||
[workspace.dependencies.loole]
|
|
||||||
version = "0.4.0"
|
|
||||||
|
|
||||||
# used for MPMC channels
|
|
||||||
[workspace.dependencies.async-channel]
|
|
||||||
version = "2.3.1"
|
|
||||||
|
|
||||||
[workspace.dependencies.async-trait]
|
|
||||||
version = "0.1.88"
|
|
||||||
|
|
||||||
[workspace.dependencies.lru-cache]
|
|
||||||
version = "0.1.2"
|
|
||||||
|
|
||||||
# Used for matrix spec type definitions and helpers
|
|
||||||
[workspace.dependencies.ruma]
|
|
||||||
git = "https://forgejo.ellis.link/continuwuation/ruwuma"
|
|
||||||
#branch = "conduwuit-changes"
|
|
||||||
rev = "bb12ed288a31a23aa11b10ba0fad22b7f985eb88"
|
|
||||||
features = [
|
|
||||||
"compat",
|
|
||||||
"rand",
|
|
||||||
"appservice-api-c",
|
|
||||||
"client-api",
|
|
||||||
"federation-api",
|
|
||||||
"markdown",
|
|
||||||
"push-gateway-api-c",
|
|
||||||
"unstable-exhaustive-types",
|
|
||||||
"ring-compat",
|
|
||||||
"compat-upload-signatures",
|
|
||||||
"identifiers-validation",
|
|
||||||
"unstable-unspecified",
|
|
||||||
"unstable-msc2448",
|
|
||||||
"unstable-msc2666",
|
|
||||||
"unstable-msc2867",
|
|
||||||
"unstable-msc2870",
|
|
||||||
"unstable-msc3026",
|
|
||||||
"unstable-msc3061",
|
|
||||||
"unstable-msc3814",
|
|
||||||
"unstable-msc3245",
|
|
||||||
"unstable-msc3266",
|
|
||||||
"unstable-msc3381", # polls
|
|
||||||
"unstable-msc3489", # beacon / live location
|
|
||||||
"unstable-msc3575",
|
|
||||||
"unstable-msc3930", # polls push rules
|
|
||||||
"unstable-msc4075",
|
|
||||||
"unstable-msc4095",
|
|
||||||
"unstable-msc4121",
|
|
||||||
"unstable-msc4125",
|
|
||||||
"unstable-msc4155",
|
|
||||||
"unstable-msc4186",
|
|
||||||
"unstable-msc4203", # sending to-device events to appservices
|
|
||||||
"unstable-msc4210", # remove legacy mentions
|
|
||||||
"unstable-extensible-events",
|
|
||||||
"unstable-pdu",
|
|
||||||
"unstable-msc4155",
|
|
||||||
"unstable-msc4143", # livekit well_known response
|
|
||||||
"unstable-msc4284"
|
|
||||||
]
|
|
||||||
|
|
||||||
[workspace.dependencies.rust-rocksdb]
|
|
||||||
git = "https://forgejo.ellis.link/continuwuation/rust-rocksdb-zaidoon1"
|
|
||||||
rev = "61d9d23872197e9ace4a477f2617d5c9f50ecb23"
|
|
||||||
default-features = false
|
|
||||||
features = [
|
|
||||||
"multi-threaded-cf",
|
|
||||||
"mt_static",
|
|
||||||
"lz4",
|
|
||||||
"zstd",
|
|
||||||
"bzip2",
|
|
||||||
]
|
|
||||||
|
|
||||||
[workspace.dependencies.sha2]
|
|
||||||
version = "0.10.8"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
[workspace.dependencies.sha1]
|
|
||||||
version = "0.10.6"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
# optional opentelemetry, performance measurements, flamegraphs, etc for performance measurements and monitoring
|
|
||||||
[workspace.dependencies.opentelemetry]
|
|
||||||
version = "0.31.0"
|
|
||||||
|
|
||||||
[workspace.dependencies.tracing-flame]
|
|
||||||
version = "0.2.0"
|
|
||||||
|
|
||||||
[workspace.dependencies.tracing-opentelemetry]
|
|
||||||
version = "0.32.0"
|
|
||||||
|
|
||||||
[workspace.dependencies.opentelemetry_sdk]
|
|
||||||
version = "0.31.0"
|
|
||||||
features = ["rt-tokio"]
|
|
||||||
|
|
||||||
[workspace.dependencies.opentelemetry-otlp]
|
|
||||||
version = "0.31.0"
|
|
||||||
features = ["http", "grpc-tonic", "trace", "logs", "metrics"]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# optional sentry metrics for crash/panic reporting
|
|
||||||
[workspace.dependencies.sentry]
|
|
||||||
version = "0.46.0"
|
|
||||||
default-features = false
|
|
||||||
features = [
|
|
||||||
"backtrace",
|
|
||||||
"contexts",
|
|
||||||
"debug-images",
|
|
||||||
"panic",
|
|
||||||
"rustls",
|
|
||||||
"tower",
|
|
||||||
"tower-http",
|
|
||||||
"tracing",
|
|
||||||
"reqwest",
|
|
||||||
"log",
|
|
||||||
]
|
|
||||||
|
|
||||||
[workspace.dependencies.sentry-tracing]
|
|
||||||
version = "0.46.0"
|
|
||||||
[workspace.dependencies.sentry-tower]
|
|
||||||
version = "0.46.0"
|
|
||||||
|
|
||||||
# jemalloc usage
|
|
||||||
[workspace.dependencies.tikv-jemalloc-sys]
|
|
||||||
git = "https://forgejo.ellis.link/continuwuation/jemallocator"
|
|
||||||
rev = "82af58d6a13ddd5dcdc7d4e91eae3b63292995b8"
|
|
||||||
default-features = false
|
|
||||||
features = [
|
|
||||||
"background_threads_runtime_support",
|
|
||||||
"unprefixed_malloc_on_supported_platforms",
|
|
||||||
]
|
|
||||||
[workspace.dependencies.tikv-jemallocator]
|
|
||||||
git = "https://forgejo.ellis.link/continuwuation/jemallocator"
|
|
||||||
rev = "82af58d6a13ddd5dcdc7d4e91eae3b63292995b8"
|
|
||||||
default-features = false
|
|
||||||
features = [
|
|
||||||
"background_threads_runtime_support",
|
|
||||||
"unprefixed_malloc_on_supported_platforms",
|
|
||||||
]
|
|
||||||
[workspace.dependencies.tikv-jemalloc-ctl]
|
|
||||||
git = "https://forgejo.ellis.link/continuwuation/jemallocator"
|
|
||||||
rev = "82af58d6a13ddd5dcdc7d4e91eae3b63292995b8"
|
|
||||||
default-features = false
|
|
||||||
features = ["use_std"]
|
|
||||||
|
|
||||||
[workspace.dependencies.console-subscriber]
|
|
||||||
version = "0.5"
|
|
||||||
|
|
||||||
[workspace.dependencies.nix]
|
|
||||||
version = "0.31.0"
|
|
||||||
default-features = false
|
|
||||||
features = ["resource"]
|
|
||||||
|
|
||||||
[workspace.dependencies.sd-notify]
|
|
||||||
version = "0.4.5"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
[workspace.dependencies.hardened_malloc-rs]
|
|
||||||
version = "0.1.2"
|
|
||||||
default-features = false
|
|
||||||
features = [
|
|
||||||
"static",
|
|
||||||
"gcc",
|
|
||||||
"light",
|
|
||||||
]
|
|
||||||
|
|
||||||
[workspace.dependencies.rustyline-async]
|
|
||||||
version = "0.4.3"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
[workspace.dependencies.termimad]
|
|
||||||
version = "0.34.0"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
[workspace.dependencies.checked_ops]
|
|
||||||
version = "0.1"
|
|
||||||
|
|
||||||
[workspace.dependencies.syn]
|
|
||||||
version = "2.0"
|
|
||||||
default-features = false
|
|
||||||
features = ["full", "extra-traits"]
|
|
||||||
|
|
||||||
[workspace.dependencies.quote]
|
|
||||||
version = "1.0"
|
|
||||||
|
|
||||||
[workspace.dependencies.proc-macro2]
|
|
||||||
version = "1.0"
|
|
||||||
|
|
||||||
[workspace.dependencies.parking_lot]
|
|
||||||
version = "0.12.4"
|
|
||||||
features = ["hardware-lock-elision", "deadlock_detection"] # TODO: Check if deadlock_detection has a perf impact, if it does only enable with debug_assertions
|
|
||||||
|
|
||||||
# Use this when extending with_lock::WithLock to parking_lot
|
|
||||||
[workspace.dependencies.lock_api]
|
|
||||||
version = "0.4.13"
|
|
||||||
|
|
||||||
[workspace.dependencies.bytesize]
|
|
||||||
version = "2.0"
|
|
||||||
|
|
||||||
[workspace.dependencies.core_affinity]
|
|
||||||
version = "0.8.1"
|
|
||||||
|
|
||||||
[workspace.dependencies.libc]
|
|
||||||
version = "0.2"
|
|
||||||
|
|
||||||
[workspace.dependencies.num-traits]
|
|
||||||
version = "0.2"
|
|
||||||
|
|
||||||
[workspace.dependencies.minicbor]
|
|
||||||
version = "2.1.1"
|
|
||||||
features = ["std"]
|
|
||||||
|
|
||||||
[workspace.dependencies.minicbor-serde]
|
|
||||||
version = "0.6.0"
|
|
||||||
features = ["std"]
|
|
||||||
|
|
||||||
[workspace.dependencies.maplit]
|
|
||||||
version = "1.0.2"
|
|
||||||
|
|
||||||
[workspace.dependencies.ldap3]
|
|
||||||
version = "0.12.0"
|
|
||||||
default-features = false
|
|
||||||
features = ["sync", "tls-rustls", "rustls-provider"]
|
|
||||||
|
|
||||||
[workspace.dependencies.resolv-conf]
|
|
||||||
version = "0.7.5"
|
|
||||||
|
|
||||||
[workspace.dependencies.yansi]
|
|
||||||
version = "1.0.1"
|
|
||||||
|
|
||||||
[workspace.dependencies.askama]
|
|
||||||
version = "0.15.0"
|
|
||||||
|
|
||||||
#
|
|
||||||
# Patches
|
|
||||||
#
|
|
||||||
|
|
||||||
# backport of [https://github.com/tokio-rs/tracing/pull/2956] to the 0.1.x branch of tracing.
|
|
||||||
# we can switch back to upstream if #2956 is merged and backported in the upstream repo.
|
|
||||||
|
|
||||||
|
|
||||||
# adds a tab completion callback: https://forgejo.ellis.link/continuwuation/rustyline-async/src/branch/main/.patchy/0002-add-tab-completion-callback.patch
|
|
||||||
# adds event for CTRL+\: https://forgejo.ellis.link/continuwuation/rustyline-async/src/branch/main/.patchy/0001-add-event-for-ctrl.patch
|
|
||||||
[patch.crates-io.rustyline-async]
|
|
||||||
git = "https://forgejo.ellis.link/continuwuation/rustyline-async"
|
|
||||||
rev = "e9f01cf8c6605483cb80b3b0309b400940493d7f"
|
|
||||||
|
|
||||||
# adds LIFO queue scheduling; this should be updated with PR progress.
|
|
||||||
[patch.crates-io.event-listener]
|
|
||||||
git = "https://forgejo.ellis.link/continuwuation/event-listener"
|
|
||||||
rev = "fe4aebeeaae435af60087ddd56b573a2e0be671d"
|
|
||||||
[patch.crates-io.async-channel]
|
|
||||||
git = "https://forgejo.ellis.link/continuwuation/async-channel"
|
|
||||||
rev = "92e5e74063bf2a3b10414bcc8a0d68b235644280"
|
|
||||||
|
|
||||||
# adds affinity masks for selecting more than one core at a time
|
|
||||||
[patch.crates-io.core_affinity]
|
|
||||||
git = "https://forgejo.ellis.link/continuwuation/core_affinity_rs"
|
|
||||||
rev = "9c8e51510c35077df888ee72a36b4b05637147da"
|
|
||||||
|
|
||||||
# reverts hyperium#148 conflicting with our delicate federation resolver hooks
|
|
||||||
[patch.crates-io.hyper-util]
|
|
||||||
git = "https://forgejo.ellis.link/continuwuation/hyper-util"
|
|
||||||
rev = "5886d5292bf704c246206ad72d010d674a7b77d0"
|
|
||||||
|
|
||||||
#
|
|
||||||
# Our crates
|
|
||||||
#
|
|
||||||
|
|
||||||
[workspace.dependencies.conduwuit-router]
|
|
||||||
package = "conduwuit_router"
|
|
||||||
path = "src/router"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
[workspace.dependencies.conduwuit-admin]
|
|
||||||
package = "conduwuit_admin"
|
|
||||||
path = "src/admin"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
[workspace.dependencies.conduwuit-api]
|
|
||||||
package = "conduwuit_api"
|
|
||||||
path = "src/api"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
[workspace.dependencies.conduwuit-service]
|
|
||||||
package = "conduwuit_service"
|
|
||||||
path = "src/service"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
[workspace.dependencies.conduwuit-database]
|
|
||||||
package = "conduwuit_database"
|
|
||||||
path = "src/database"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
[workspace.dependencies.conduwuit-core]
|
|
||||||
package = "conduwuit_core"
|
|
||||||
path = "src/core"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
[workspace.dependencies.conduwuit-macros]
|
|
||||||
package = "conduwuit_macros"
|
|
||||||
path = "src/macros"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
[workspace.dependencies.conduwuit-web]
|
|
||||||
package = "conduwuit_web"
|
|
||||||
path = "src/web"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
|
|
||||||
[workspace.dependencies.conduwuit-build-metadata]
|
|
||||||
package = "conduwuit_build_metadata"
|
|
||||||
path = "src/build_metadata"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
|
|
||||||
[workspace.dependencies.conduwuit]
|
|
||||||
package = "conduwuit"
|
|
||||||
path = "src/main"
|
|
||||||
|
|
||||||
###############################################################################
|
|
||||||
#
|
|
||||||
# Release profiles
|
|
||||||
#
|
|
||||||
|
|
||||||
[profile.release]
|
|
||||||
strip = "symbols"
|
|
||||||
lto = "thin"
|
|
||||||
|
|
||||||
# release profile with debug symbols
|
|
||||||
[profile.release-debuginfo]
|
|
||||||
inherits = "release"
|
|
||||||
debug = "full"
|
|
||||||
strip = "none"
|
|
||||||
|
|
||||||
[profile.release-high-perf]
|
|
||||||
inherits = "release"
|
|
||||||
lto = "fat"
|
|
||||||
codegen-units = 1
|
|
||||||
panic = "abort"
|
|
||||||
|
|
||||||
# do not use without profile-rustflags enabled
|
|
||||||
[profile.release-max-perf]
|
|
||||||
inherits = "release"
|
|
||||||
strip = "symbols"
|
|
||||||
lto = "fat"
|
|
||||||
|
|
||||||
[profile.release-max-perf.build-override]
|
|
||||||
inherits = "release-max-perf"
|
|
||||||
opt-level = 0
|
|
||||||
codegen-units = 32
|
|
||||||
#rustflags = [
|
|
||||||
# '-Crelocation-model=pic',
|
|
||||||
# '-Ctarget-feature=-crt-static',
|
|
||||||
# '-Clink-arg=-Wl,--no-gc-sections',
|
|
||||||
#]
|
|
||||||
|
|
||||||
[profile.release-max-perf.package.conduwuit_macros]
|
|
||||||
inherits = "release-max-perf.build-override"
|
|
||||||
#rustflags = [
|
|
||||||
# '-Crelocation-model=pic',
|
|
||||||
# '-Ctarget-feature=-crt-static',
|
|
||||||
#]
|
|
||||||
|
|
||||||
[profile.bench]
|
|
||||||
inherits = "release"
|
|
||||||
#rustflags = [
|
|
||||||
# "-Cremark=all",
|
|
||||||
# '-Ztime-passes',
|
|
||||||
# '-Ztime-llvm-passes',
|
|
||||||
#]
|
|
||||||
|
|
||||||
###############################################################################
|
|
||||||
#
|
|
||||||
# Developer profile
|
|
||||||
#
|
|
||||||
|
|
||||||
# To enable hot-reloading:
|
|
||||||
# 1. Uncomment all of the rustflags here.
|
|
||||||
# 2. Uncomment crate-type=dylib in src/*/Cargo.toml
|
|
||||||
#
|
|
||||||
# opt-level, mir-opt-level, validate-mir are not known to interfere with reloading
|
|
||||||
# and can be raised if build times are tolerable.
|
|
||||||
|
|
||||||
[profile.dev]
|
|
||||||
debug = "full"
|
|
||||||
opt-level = 0
|
|
||||||
panic = "unwind"
|
|
||||||
debug-assertions = true
|
|
||||||
incremental = true
|
|
||||||
#rustflags = [
|
|
||||||
# '--cfg', 'conduwuit_mods',
|
|
||||||
# '-Ztime-passes',
|
|
||||||
# '-Zmir-opt-level=0',
|
|
||||||
# '-Zvalidate-mir=false',
|
|
||||||
# '-Ztls-model=global-dynamic',
|
|
||||||
# '-Cprefer-dynamic=true',
|
|
||||||
# '-Zstaticlib-prefer-dynamic=true',
|
|
||||||
# '-Zstaticlib-allow-rdylib-deps=true',
|
|
||||||
# '-Zpacked-bundled-libs=false',
|
|
||||||
# '-Zplt=true',
|
|
||||||
# '-Crpath=true',
|
|
||||||
# '-Clink-arg=-Wl,--as-needed',
|
|
||||||
# '-Clink-arg=-Wl,--allow-shlib-undefined',
|
|
||||||
# '-Clink-arg=-Wl,-z,keep-text-section-prefix',
|
|
||||||
# '-Clink-arg=-Wl,-z,lazy',
|
|
||||||
#]
|
|
||||||
|
|
||||||
[profile.dev.package.conduwuit_core]
|
|
||||||
inherits = "dev"
|
|
||||||
[profile.dev.package.conduwuit]
|
|
||||||
inherits = "dev"
|
|
||||||
#rustflags = [
|
|
||||||
# '--cfg', 'conduwuit_mods',
|
|
||||||
# '-Ztime-passes',
|
|
||||||
# '-Zmir-opt-level=0',
|
|
||||||
# '-Zvalidate-mir=false',
|
|
||||||
# '-Ztls-model=global-dynamic',
|
|
||||||
# '-Cprefer-dynamic=true',
|
|
||||||
# '-Zexport-executable-symbols=true',
|
|
||||||
# '-Zplt=true',
|
|
||||||
# '-Crpath=true',
|
|
||||||
# '-Clink-arg=-Wl,--as-needed',
|
|
||||||
# '-Clink-arg=-Wl,--allow-shlib-undefined',
|
|
||||||
# '-Clink-arg=-Wl,--export-dynamic',
|
|
||||||
# '-Clink-arg=-Wl,-z,lazy',
|
|
||||||
#]
|
|
||||||
|
|
||||||
[profile.dev.package.'*']
|
|
||||||
inherits = "dev"
|
|
||||||
debug = 'limited'
|
|
||||||
codegen-units = 1
|
|
||||||
opt-level = 'z'
|
|
||||||
#rustflags = [
|
|
||||||
# '--cfg', 'conduwuit_mods',
|
|
||||||
# '-Ztls-model=global-dynamic',
|
|
||||||
# '-Cprefer-dynamic=true',
|
|
||||||
# '-Zstaticlib-prefer-dynamic=true',
|
|
||||||
# '-Zstaticlib-allow-rdylib-deps=true',
|
|
||||||
# '-Zpacked-bundled-libs=true',
|
|
||||||
# '-Zplt=true',
|
|
||||||
# '-Clink-arg=-Wl,--as-needed',
|
|
||||||
# '-Clink-arg=-Wl,-z,lazy',
|
|
||||||
# '-Clink-arg=-Wl,-z,nodelete',
|
|
||||||
#]
|
|
||||||
|
|
||||||
# primarily used for CI
|
|
||||||
[profile.test]
|
|
||||||
inherits = "dev"
|
|
||||||
strip = false
|
|
||||||
opt-level = 0
|
|
||||||
codegen-units = 16
|
|
||||||
|
|
||||||
[profile.test.package.'*']
|
|
||||||
inherits = "dev"
|
|
||||||
debug = 0
|
|
||||||
strip = false
|
|
||||||
opt-level = 0
|
|
||||||
codegen-units = 16
|
|
||||||
|
|
||||||
###############################################################################
|
|
||||||
#
|
|
||||||
# Linting
|
|
||||||
#
|
|
||||||
|
|
||||||
[workspace.lints.rust]
|
|
||||||
absolute-paths-not-starting-with-crate = "warn"
|
|
||||||
#box-pointers = "warn"
|
|
||||||
deprecated-in-future = "warn"
|
|
||||||
elided-lifetimes-in-paths = "warn"
|
|
||||||
explicit-outlives-requirements = "warn"
|
|
||||||
ffi-unwind-calls = "warn"
|
|
||||||
keyword-idents = "warn"
|
|
||||||
macro-use-extern-crate = "warn"
|
|
||||||
meta-variable-misuse = "warn"
|
|
||||||
missing-abi = "warn"
|
|
||||||
#missing-copy-implementations = "warn" # TODO
|
|
||||||
#missing-debug-implementations = "warn" # TODO
|
|
||||||
non-ascii-idents = "warn"
|
|
||||||
rust-2021-incompatible-closure-captures = "warn"
|
|
||||||
rust-2021-incompatible-or-patterns = "warn"
|
|
||||||
rust-2021-prefixes-incompatible-syntax = "warn"
|
|
||||||
rust-2021-prelude-collisions = "warn"
|
|
||||||
single-use-lifetimes = "warn"
|
|
||||||
trivial-casts = "warn"
|
|
||||||
trivial-numeric-casts = "warn"
|
|
||||||
unit-bindings = "warn"
|
|
||||||
#unnameable-types = "warn" # TODO
|
|
||||||
unreachable-pub = "warn"
|
|
||||||
unsafe-op-in-unsafe-fn = "warn"
|
|
||||||
unstable-features = "warn"
|
|
||||||
unused-extern-crates = "warn"
|
|
||||||
unused-import-braces = "warn"
|
|
||||||
unused-lifetimes = "warn"
|
|
||||||
unused-macro-rules = "warn"
|
|
||||||
unused-qualifications = "warn"
|
|
||||||
#unused-results = "warn" # TODO
|
|
||||||
|
|
||||||
## some sadness
|
|
||||||
mismatched_lifetime_syntaxes = "allow" # TODO!
|
|
||||||
let_underscore_drop = "allow"
|
|
||||||
missing_docs = "allow"
|
|
||||||
# cfgs cannot be limited to expected cfgs or their de facto non-transitive/opt-in use-case e.g.
|
|
||||||
# tokio_unstable will warn.
|
|
||||||
unexpected_cfgs = "allow"
|
|
||||||
# this seems to suggest broken code and is not working correctly
|
|
||||||
unused_braces = "allow"
|
|
||||||
# buggy, but worth checking on occasionally
|
|
||||||
unused_crate_dependencies = "allow"
|
|
||||||
unsafe_code = "allow"
|
|
||||||
variant_size_differences = "allow"
|
|
||||||
|
|
||||||
# we check nightly clippy lints
|
|
||||||
unknown_lints = "allow"
|
|
||||||
|
|
||||||
#######################################
|
|
||||||
#
|
|
||||||
# Clippy lints
|
|
||||||
#
|
|
||||||
|
|
||||||
[workspace.lints.clippy]
|
|
||||||
|
|
||||||
###################
|
|
||||||
cargo = { level = "warn", priority = -1 }
|
|
||||||
# Nobody except for us should be consuming these crates, they don't need metadata
|
|
||||||
cargo_common_metadata = { level = "allow" }
|
|
||||||
|
|
||||||
## some sadness
|
|
||||||
multiple_crate_versions = { level = "allow", priority = 1 }
|
|
||||||
|
|
||||||
###################
|
|
||||||
complexity = { level = "warn", priority = -1 }
|
|
||||||
|
|
||||||
###################
|
|
||||||
correctness = { level = "warn", priority = -1 }
|
|
||||||
|
|
||||||
###################
|
|
||||||
nursery = { level = "warn", priority = -1 }
|
|
||||||
|
|
||||||
## some sadness
|
|
||||||
missing_const_for_fn = { level = "allow", priority = 1 } # TODO
|
|
||||||
option_if_let_else = { level = "allow", priority = 1 } # TODO
|
|
||||||
redundant_pub_crate = { level = "allow", priority = 1 } # TODO
|
|
||||||
significant_drop_in_scrutinee = { level = "allow", priority = 1 } # TODO
|
|
||||||
significant_drop_tightening = { level = "allow", priority = 1 } # TODO
|
|
||||||
|
|
||||||
###################
|
|
||||||
pedantic = { level = "warn", priority = -1 }
|
|
||||||
|
|
||||||
## some sadness
|
|
||||||
too_long_first_doc_paragraph = { level = "allow", priority = 1 }
|
|
||||||
doc_markdown = { level = "allow", priority = 1 }
|
|
||||||
enum_glob_use = { level = "allow", priority = 1 }
|
|
||||||
if_not_else = { level = "allow", priority = 1 }
|
|
||||||
if_then_some_else_none = { level = "allow", priority = 1 }
|
|
||||||
inline_always = { level = "allow", priority = 1 }
|
|
||||||
match_bool = { level = "allow", priority = 1 }
|
|
||||||
missing_docs_in_private_items = { level = "allow", priority = 1 }
|
|
||||||
missing_errors_doc = { level = "allow", priority = 1 }
|
|
||||||
missing_panics_doc = { level = "allow", priority = 1 }
|
|
||||||
module_name_repetitions = { level = "allow", priority = 1 }
|
|
||||||
needless_continue = { level = "allow", priority = 1 }
|
|
||||||
no_effect_underscore_binding = { level = "allow", priority = 1 }
|
|
||||||
similar_names = { level = "allow", priority = 1 }
|
|
||||||
single_match_else = { level = "allow", priority = 1 }
|
|
||||||
struct_excessive_bools = { level = "allow", priority = 1 }
|
|
||||||
struct_field_names = { level = "allow", priority = 1 }
|
|
||||||
unnecessary_wraps = { level = "allow", priority = 1 }
|
|
||||||
unused_async = { level = "allow", priority = 1 }
|
|
||||||
|
|
||||||
###################
|
|
||||||
perf = { level = "warn", priority = -1 }
|
|
||||||
|
|
||||||
###################
|
|
||||||
#restriction = "warn"
|
|
||||||
|
|
||||||
#allow_attributes = "warn" # UNSTABLE
|
|
||||||
arithmetic_side_effects = "warn"
|
|
||||||
as_conversions = "warn"
|
|
||||||
as_underscore = "warn"
|
|
||||||
assertions_on_result_states = "warn"
|
|
||||||
dbg_macro = "warn"
|
|
||||||
default_union_representation = "warn"
|
|
||||||
deref_by_slicing = "warn"
|
|
||||||
empty_drop = "warn"
|
|
||||||
empty_structs_with_brackets = "warn"
|
|
||||||
exit = "warn"
|
|
||||||
filetype_is_file = "warn"
|
|
||||||
float_cmp_const = "warn"
|
|
||||||
fn_to_numeric_cast_any = "warn"
|
|
||||||
format_push_string = "warn"
|
|
||||||
get_unwrap = "warn"
|
|
||||||
impl_trait_in_params = "warn"
|
|
||||||
let_underscore_untyped = "warn"
|
|
||||||
lossy_float_literal = "warn"
|
|
||||||
mem_forget = "warn"
|
|
||||||
missing_assert_message = "warn"
|
|
||||||
mutex_atomic = "warn"
|
|
||||||
pub_without_shorthand = "warn"
|
|
||||||
rc_buffer = "warn"
|
|
||||||
rc_mutex = "warn"
|
|
||||||
redundant_type_annotations = "warn"
|
|
||||||
rest_pat_in_fully_bound_structs = "warn"
|
|
||||||
semicolon_outside_block = "warn"
|
|
||||||
str_to_string = "warn"
|
|
||||||
string_lit_chars_any = "warn"
|
|
||||||
string_slice = "warn"
|
|
||||||
|
|
||||||
suspicious_xor_used_as_pow = "warn"
|
|
||||||
tests_outside_test_module = "warn"
|
|
||||||
try_err = "warn"
|
|
||||||
undocumented_unsafe_blocks = "warn"
|
|
||||||
unnecessary_safety_comment = "warn"
|
|
||||||
unnecessary_safety_doc = "warn"
|
|
||||||
unnecessary_self_imports = "warn"
|
|
||||||
unneeded_field_pattern = "warn"
|
|
||||||
unseparated_literal_suffix = "warn"
|
|
||||||
#unwrap_used = "warn" # TODO
|
|
||||||
verbose_file_reads = "warn"
|
|
||||||
|
|
||||||
###################
|
|
||||||
style = { level = "warn", priority = -1 }
|
|
||||||
|
|
||||||
## some sadness
|
|
||||||
# trivial assertions are quite alright
|
|
||||||
assertions_on_constants = { level = "allow", priority = 1 }
|
|
||||||
module_inception = { level = "allow", priority = 1 }
|
|
||||||
obfuscated_if_else = { level = "allow", priority = 1 }
|
|
||||||
|
|
||||||
###################
|
|
||||||
suspicious = { level = "warn", priority = -1 }
|
|
||||||
|
|
||||||
## some sadness
|
|
||||||
let_underscore_future = { level = "allow", priority = 1 }
|
|
||||||
|
|
||||||
# rust doesnt understand conduwuit's custom log macros
|
|
||||||
literal_string_with_formatting_args = { level = "allow", priority = 1 }
|
|
||||||
|
|
||||||
|
|
||||||
needless_raw_string_hashes = "allow"
|
|
||||||
|
|
||||||
# TODO: Enable this lint & fix all instances
|
|
||||||
collapsible_if = "allow"
|
|
||||||
|
|
||||||
# TODO: break these apart
|
|
||||||
cognitive_complexity = "allow"
|
|
||||||
202
LICENSE
202
LICENSE
|
|
@ -1,202 +0,0 @@
|
||||||
|
|
||||||
Apache License
|
|
||||||
Version 2.0, January 2004
|
|
||||||
http://www.apache.org/licenses/
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
||||||
|
|
||||||
1. Definitions.
|
|
||||||
|
|
||||||
"License" shall mean the terms and conditions for use, reproduction,
|
|
||||||
and distribution as defined by Sections 1 through 9 of this document.
|
|
||||||
|
|
||||||
"Licensor" shall mean the copyright owner or entity authorized by
|
|
||||||
the copyright owner that is granting the License.
|
|
||||||
|
|
||||||
"Legal Entity" shall mean the union of the acting entity and all
|
|
||||||
other entities that control, are controlled by, or are under common
|
|
||||||
control with that entity. For the purposes of this definition,
|
|
||||||
"control" means (i) the power, direct or indirect, to cause the
|
|
||||||
direction or management of such entity, whether by contract or
|
|
||||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
||||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
||||||
|
|
||||||
"You" (or "Your") shall mean an individual or Legal Entity
|
|
||||||
exercising permissions granted by this License.
|
|
||||||
|
|
||||||
"Source" form shall mean the preferred form for making modifications,
|
|
||||||
including but not limited to software source code, documentation
|
|
||||||
source, and configuration files.
|
|
||||||
|
|
||||||
"Object" form shall mean any form resulting from mechanical
|
|
||||||
transformation or translation of a Source form, including but
|
|
||||||
not limited to compiled object code, generated documentation,
|
|
||||||
and conversions to other media types.
|
|
||||||
|
|
||||||
"Work" shall mean the work of authorship, whether in Source or
|
|
||||||
Object form, made available under the License, as indicated by a
|
|
||||||
copyright notice that is included in or attached to the work
|
|
||||||
(an example is provided in the Appendix below).
|
|
||||||
|
|
||||||
"Derivative Works" shall mean any work, whether in Source or Object
|
|
||||||
form, that is based on (or derived from) the Work and for which the
|
|
||||||
editorial revisions, annotations, elaborations, or other modifications
|
|
||||||
represent, as a whole, an original work of authorship. For the purposes
|
|
||||||
of this License, Derivative Works shall not include works that remain
|
|
||||||
separable from, or merely link (or bind by name) to the interfaces of,
|
|
||||||
the Work and Derivative Works thereof.
|
|
||||||
|
|
||||||
"Contribution" shall mean any work of authorship, including
|
|
||||||
the original version of the Work and any modifications or additions
|
|
||||||
to that Work or Derivative Works thereof, that is intentionally
|
|
||||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
||||||
or by an individual or Legal Entity authorized to submit on behalf of
|
|
||||||
the copyright owner. For the purposes of this definition, "submitted"
|
|
||||||
means any form of electronic, verbal, or written communication sent
|
|
||||||
to the Licensor or its representatives, including but not limited to
|
|
||||||
communication on electronic mailing lists, source code control systems,
|
|
||||||
and issue tracking systems that are managed by, or on behalf of, the
|
|
||||||
Licensor for the purpose of discussing and improving the Work, but
|
|
||||||
excluding communication that is conspicuously marked or otherwise
|
|
||||||
designated in writing by the copyright owner as "Not a Contribution."
|
|
||||||
|
|
||||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
||||||
on behalf of whom a Contribution has been received by Licensor and
|
|
||||||
subsequently incorporated within the Work.
|
|
||||||
|
|
||||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
copyright license to reproduce, prepare Derivative Works of,
|
|
||||||
publicly display, publicly perform, sublicense, and distribute the
|
|
||||||
Work and such Derivative Works in Source or Object form.
|
|
||||||
|
|
||||||
3. Grant of Patent License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
(except as stated in this section) patent license to make, have made,
|
|
||||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
||||||
where such license applies only to those patent claims licensable
|
|
||||||
by such Contributor that are necessarily infringed by their
|
|
||||||
Contribution(s) alone or by combination of their Contribution(s)
|
|
||||||
with the Work to which such Contribution(s) was submitted. If You
|
|
||||||
institute patent litigation against any entity (including a
|
|
||||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
||||||
or a Contribution incorporated within the Work constitutes direct
|
|
||||||
or contributory patent infringement, then any patent licenses
|
|
||||||
granted to You under this License for that Work shall terminate
|
|
||||||
as of the date such litigation is filed.
|
|
||||||
|
|
||||||
4. Redistribution. You may reproduce and distribute copies of the
|
|
||||||
Work or Derivative Works thereof in any medium, with or without
|
|
||||||
modifications, and in Source or Object form, provided that You
|
|
||||||
meet the following conditions:
|
|
||||||
|
|
||||||
(a) You must give any other recipients of the Work or
|
|
||||||
Derivative Works a copy of this License; and
|
|
||||||
|
|
||||||
(b) You must cause any modified files to carry prominent notices
|
|
||||||
stating that You changed the files; and
|
|
||||||
|
|
||||||
(c) You must retain, in the Source form of any Derivative Works
|
|
||||||
that You distribute, all copyright, patent, trademark, and
|
|
||||||
attribution notices from the Source form of the Work,
|
|
||||||
excluding those notices that do not pertain to any part of
|
|
||||||
the Derivative Works; and
|
|
||||||
|
|
||||||
(d) If the Work includes a "NOTICE" text file as part of its
|
|
||||||
distribution, then any Derivative Works that You distribute must
|
|
||||||
include a readable copy of the attribution notices contained
|
|
||||||
within such NOTICE file, excluding those notices that do not
|
|
||||||
pertain to any part of the Derivative Works, in at least one
|
|
||||||
of the following places: within a NOTICE text file distributed
|
|
||||||
as part of the Derivative Works; within the Source form or
|
|
||||||
documentation, if provided along with the Derivative Works; or,
|
|
||||||
within a display generated by the Derivative Works, if and
|
|
||||||
wherever such third-party notices normally appear. The contents
|
|
||||||
of the NOTICE file are for informational purposes only and
|
|
||||||
do not modify the License. You may add Your own attribution
|
|
||||||
notices within Derivative Works that You distribute, alongside
|
|
||||||
or as an addendum to the NOTICE text from the Work, provided
|
|
||||||
that such additional attribution notices cannot be construed
|
|
||||||
as modifying the License.
|
|
||||||
|
|
||||||
You may add Your own copyright statement to Your modifications and
|
|
||||||
may provide additional or different license terms and conditions
|
|
||||||
for use, reproduction, or distribution of Your modifications, or
|
|
||||||
for any such Derivative Works as a whole, provided Your use,
|
|
||||||
reproduction, and distribution of the Work otherwise complies with
|
|
||||||
the conditions stated in this License.
|
|
||||||
|
|
||||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
||||||
any Contribution intentionally submitted for inclusion in the Work
|
|
||||||
by You to the Licensor shall be under the terms and conditions of
|
|
||||||
this License, without any additional terms or conditions.
|
|
||||||
Notwithstanding the above, nothing herein shall supersede or modify
|
|
||||||
the terms of any separate license agreement you may have executed
|
|
||||||
with Licensor regarding such Contributions.
|
|
||||||
|
|
||||||
6. Trademarks. This License does not grant permission to use the trade
|
|
||||||
names, trademarks, service marks, or product names of the Licensor,
|
|
||||||
except as required for reasonable and customary use in describing the
|
|
||||||
origin of the Work and reproducing the content of the NOTICE file.
|
|
||||||
|
|
||||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
||||||
agreed to in writing, Licensor provides the Work (and each
|
|
||||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
||||||
implied, including, without limitation, any warranties or conditions
|
|
||||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
||||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
||||||
appropriateness of using or redistributing the Work and assume any
|
|
||||||
risks associated with Your exercise of permissions under this License.
|
|
||||||
|
|
||||||
8. Limitation of Liability. In no event and under no legal theory,
|
|
||||||
whether in tort (including negligence), contract, or otherwise,
|
|
||||||
unless required by applicable law (such as deliberate and grossly
|
|
||||||
negligent acts) or agreed to in writing, shall any Contributor be
|
|
||||||
liable to You for damages, including any direct, indirect, special,
|
|
||||||
incidental, or consequential damages of any character arising as a
|
|
||||||
result of this License or out of the use or inability to use the
|
|
||||||
Work (including but not limited to damages for loss of goodwill,
|
|
||||||
work stoppage, computer failure or malfunction, or any and all
|
|
||||||
other commercial damages or losses), even if such Contributor
|
|
||||||
has been advised of the possibility of such damages.
|
|
||||||
|
|
||||||
9. Accepting Warranty or Additional Liability. While redistributing
|
|
||||||
the Work or Derivative Works thereof, You may choose to offer,
|
|
||||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
||||||
or other liability obligations and/or rights consistent with this
|
|
||||||
License. However, in accepting such obligations, You may act only
|
|
||||||
on Your own behalf and on Your sole responsibility, not on behalf
|
|
||||||
of any other Contributor, and only if You agree to indemnify,
|
|
||||||
defend, and hold each Contributor harmless for any liability
|
|
||||||
incurred by, or claims asserted against, such Contributor by reason
|
|
||||||
of your accepting any such warranty or additional liability.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
APPENDIX: How to apply the Apache License to your work.
|
|
||||||
|
|
||||||
To apply the Apache License to your work, attach the following
|
|
||||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
||||||
replaced with your own identifying information. (Don't include
|
|
||||||
the brackets!) The text should be enclosed in the appropriate
|
|
||||||
comment syntax for the file format. We also recommend that a
|
|
||||||
file or class name and description of purpose be included on the
|
|
||||||
same "printed page" as the copyright notice for easier
|
|
||||||
identification within third-party archives.
|
|
||||||
|
|
||||||
Copyright 2023 June
|
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
you may not use this file except in compliance with the License.
|
|
||||||
You may obtain a copy of the License at
|
|
||||||
|
|
||||||
http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
See the License for the specific language governing permissions and
|
|
||||||
limitations under the License.
|
|
||||||
129
README.md
129
README.md
|
|
@ -1,129 +0,0 @@
|
||||||
# continuwuity
|
|
||||||
|
|
||||||
<!-- ANCHOR: catchphrase -->
|
|
||||||
|
|
||||||
## A community-driven [Matrix](https://matrix.org/) homeserver in Rust
|
|
||||||
|
|
||||||
[](https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org) [](https://matrix.to/#/#space:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ANCHOR_END: catchphrase -->
|
|
||||||
|
|
||||||
[continuwuity] is a Matrix homeserver written in Rust.
|
|
||||||
It's the official community continuation of the [conduwuit](https://github.com/girlbossceo/conduwuit) homeserver.
|
|
||||||
|
|
||||||
<!-- ANCHOR: body -->
|
|
||||||
|
|
||||||
[](https://forgejo.ellis.link/continuwuation/continuwuity) [](https://forgejo.ellis.link/continuwuation/continuwuity/stars) [](https://forgejo.ellis.link/continuwuation/continuwuity/issues?state=open) [](https://forgejo.ellis.link/continuwuation/continuwuity/pulls?state=open)
|
|
||||||
|
|
||||||
[](https://github.com/continuwuity/continuwuity) [](https://github.com/continuwuity/continuwuity/stargazers)
|
|
||||||
|
|
||||||
[](https://gitlab.com/continuwuity/continuwuity) [](https://gitlab.com/continuwuity/continuwuity/-/starrers)
|
|
||||||
|
|
||||||
[](https://codeberg.org/continuwuity/continuwuity) [](https://codeberg.org/continuwuity/continuwuity/stars)
|
|
||||||
|
|
||||||
### Why does this exist?
|
|
||||||
|
|
||||||
The original conduwuit project has been archived and is no longer maintained. Rather than letting this Rust-based Matrix homeserver disappear, a group of community contributors have forked the project to continue its development, fix outstanding issues, and add new features.
|
|
||||||
|
|
||||||
We aim to provide a stable, well-maintained alternative for current conduwuit users and welcome newcomers seeking a lightweight, efficient Matrix homeserver.
|
|
||||||
|
|
||||||
### Who are we?
|
|
||||||
|
|
||||||
We are a group of Matrix enthusiasts, developers and system administrators who have used conduwuit and believe in its potential. Our team includes both previous
|
|
||||||
contributors to the original project and new developers who want to help maintain and improve this important piece of Matrix infrastructure.
|
|
||||||
|
|
||||||
We operate as an open community project, welcoming contributions from anyone interested in improving continuwuity.
|
|
||||||
|
|
||||||
### What is Matrix?
|
|
||||||
|
|
||||||
[Matrix](https://matrix.org) is an open, federated, and extensible network for
|
|
||||||
decentralized communication. Users from any Matrix homeserver can chat with users from all
|
|
||||||
other homeservers over federation. Matrix is designed to be extensible and built on top of.
|
|
||||||
You can even use bridges such as Matrix Appservices to communicate with users outside of Matrix, like a community on Discord.
|
|
||||||
|
|
||||||
### What are the project's goals?
|
|
||||||
|
|
||||||
Continuwuity aims to:
|
|
||||||
|
|
||||||
- Maintain a stable, reliable Matrix homeserver implementation in Rust
|
|
||||||
- Improve compatibility and specification compliance with the Matrix protocol
|
|
||||||
- Fix bugs and performance issues from the original conduwuit
|
|
||||||
- Add missing features needed by homeserver administrators
|
|
||||||
- Provide comprehensive documentation and easy deployment options
|
|
||||||
- Create a sustainable development model for long-term maintenance
|
|
||||||
- Keep a lightweight, efficient codebase that can run on modest hardware
|
|
||||||
|
|
||||||
### Can I try it out?
|
|
||||||
|
|
||||||
Check out the [documentation](https://continuwuity.org) for installation instructions.
|
|
||||||
|
|
||||||
If you want to try it out as a user, we have some partnered homeservers you can use:
|
|
||||||
* You can head over to [https://federated.nexus](https://federated.nexus/) in your browser.
|
|
||||||
* Hit the `Apply to Join` button. Once your request has been accepted, you will receive an email with your username and password.
|
|
||||||
* Head over to [https://app.federated.nexus](https://app.federated.nexus/) and you can sign in there, or use any other matrix chat client you wish elsewhere.
|
|
||||||
* Your username for matrix will be in the form of `@username:federated.nexus`, however you can simply use the `username` part to log in. Your password is your password.
|
|
||||||
|
|
||||||
* There's also [https://continuwuity.rocks/](https://continuwuity.rocks/). You can register a new account using Cinny via [this convenient link](https://app.cinny.in/register/continuwuity.rocks), or you can use Element or another matrix client *that supports registration*.
|
|
||||||
|
|
||||||
### What are we working on?
|
|
||||||
|
|
||||||
We're working our way through all of the issues in the [Forgejo project](https://forgejo.ellis.link/continuwuation/continuwuity/issues).
|
|
||||||
|
|
||||||
- [Packaging & availability in more places](https://forgejo.ellis.link/continuwuation/continuwuity/issues/747)
|
|
||||||
- [Appservices bugs & features](https://forgejo.ellis.link/continuwuation/continuwuity/issues?q=&type=all&state=open&labels=178&milestone=0&assignee=0&poster=0)
|
|
||||||
- [Improving compatibility and spec compliance](https://forgejo.ellis.link/continuwuation/continuwuity/issues?labels=119)
|
|
||||||
- Automated testing
|
|
||||||
- [Admin API](https://forgejo.ellis.link/continuwuation/continuwuity/issues/748)
|
|
||||||
- [Policy-list controlled moderation](https://forgejo.ellis.link/continuwuation/continuwuity/issues/750)
|
|
||||||
|
|
||||||
### Can I migrate my data from x?
|
|
||||||
|
|
||||||
- Conduwuit: Yes
|
|
||||||
- Conduit: No, database is now incompatible
|
|
||||||
- Grapevine: No, database is now incompatible
|
|
||||||
- Dendrite: No
|
|
||||||
- Synapse: No
|
|
||||||
|
|
||||||
We haven't written up a guide on migrating from incompatible homeservers yet. Reach out to us if you need to do this!
|
|
||||||
|
|
||||||
<!-- ANCHOR_END: body -->
|
|
||||||
|
|
||||||
## Contribution
|
|
||||||
|
|
||||||
### Development flow
|
|
||||||
|
|
||||||
- Features / changes must developed in a separate branch
|
|
||||||
- For each change, create a descriptive PR
|
|
||||||
- Your code will be reviewed by one or more of the continuwuity developers
|
|
||||||
- The branch will be deployed live on multiple tester's matrix servers to shake out bugs
|
|
||||||
- Once all testers and reviewers have agreed, the PR will be merged to the main branch
|
|
||||||
- The main branch will have nightly builds deployed to users on the cutting edge
|
|
||||||
- Every week or two, a new release is cut.
|
|
||||||
|
|
||||||
The main branch is always green!
|
|
||||||
|
|
||||||
|
|
||||||
### Policy on pulling from other forks
|
|
||||||
|
|
||||||
We welcome contributions from other forks of conduwuit, subject to our review process.
|
|
||||||
When incorporating code from other forks:
|
|
||||||
|
|
||||||
- All external contributions must go through our standard PR process
|
|
||||||
- Code must meet our quality standards and pass tests
|
|
||||||
- Code changes will require testing on multiple test servers before merging
|
|
||||||
- Attribution will be given to original authors and forks
|
|
||||||
- We prioritize stability and compatibility when evaluating external contributions
|
|
||||||
- Features that align with our project goals will be given priority consideration
|
|
||||||
|
|
||||||
<!-- ANCHOR: footer -->
|
|
||||||
|
|
||||||
#### Contact
|
|
||||||
|
|
||||||
Join our [Matrix room](https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org) and [space](https://matrix.to/#/#space:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org) to chat with us about the project!
|
|
||||||
|
|
||||||
<!-- ANCHOR_END: footer -->
|
|
||||||
|
|
||||||
|
|
||||||
[continuwuity]: https://forgejo.ellis.link/continuwuation/continuwuity
|
|
||||||
63
SECURITY.md
63
SECURITY.md
|
|
@ -1,63 +0,0 @@
|
||||||
# Security Policy for Continuwuity
|
|
||||||
|
|
||||||
This document outlines the security policy for Continuwuity. Our goal is to maintain a secure platform for all users, and we take security matters seriously.
|
|
||||||
|
|
||||||
## Supported Versions
|
|
||||||
|
|
||||||
We provide security updates for the following versions of Continuwuity:
|
|
||||||
|
|
||||||
| Version | Supported |
|
|
||||||
| -------------- |:----------------:|
|
|
||||||
| Latest release | ✅ |
|
|
||||||
| Main branch | ✅ |
|
|
||||||
| Older releases | ❌ |
|
|
||||||
|
|
||||||
We may backport fixes to the previous release at our discretion, but we don't guarantee this.
|
|
||||||
|
|
||||||
## Reporting a Vulnerability
|
|
||||||
|
|
||||||
### Responsible Disclosure
|
|
||||||
|
|
||||||
We appreciate the efforts of security researchers and the community in identifying and reporting vulnerabilities. To ensure that potential vulnerabilities are addressed properly, please follow these guidelines:
|
|
||||||
|
|
||||||
1. **Contact members of the team directly** over E2EE private message.
|
|
||||||
- [@jade:ellis.link](https://matrix.to/#/@jade:ellis.link)
|
|
||||||
- [@nex:nexy7574.co.uk](https://matrix.to/#/@nex:nexy7574.co.uk)
|
|
||||||
2. **Email the security team** at [security@continuwuity.org](mailto:security@continuwuity.org). This is not E2EE, so don't include sensitive details.
|
|
||||||
3. **Do not disclose the vulnerability publicly** until it has been addressed
|
|
||||||
4. **Provide detailed information** about the vulnerability, including:
|
|
||||||
- A clear description of the issue
|
|
||||||
- Steps to reproduce
|
|
||||||
- Potential impact
|
|
||||||
- Any possible mitigations
|
|
||||||
- Version(s) affected, including specific commits if possible
|
|
||||||
|
|
||||||
If you have any doubts about a potential security vulnerability, contact us via private channels first! We'd prefer that you bother us, instead of having a vulnerability disclosed without a fix.
|
|
||||||
|
|
||||||
### What to Expect
|
|
||||||
|
|
||||||
When you report a security vulnerability:
|
|
||||||
|
|
||||||
1. **Acknowledgment**: We will acknowledge receipt of your report.
|
|
||||||
2. **Assessment**: We will assess the vulnerability and determine its impact on our users
|
|
||||||
3. **Updates**: We will provide updates on our progress in addressing the vulnerability, and may request you help test mitigations
|
|
||||||
4. **Resolution**: Once resolved, we will notify you and discuss coordinated disclosure
|
|
||||||
5. **Credit**: We will recognize your contribution (unless you prefer to remain anonymous)
|
|
||||||
|
|
||||||
## Security Update Process
|
|
||||||
|
|
||||||
When security vulnerabilities are identified:
|
|
||||||
|
|
||||||
1. We will develop and test fixes in a private fork
|
|
||||||
2. Security updates will be released as soon as possible
|
|
||||||
3. Release notes will include information about the vulnerabilities, avoiding details that could facilitate exploitation where possible
|
|
||||||
4. Critical security updates may be backported to the previous stable release
|
|
||||||
|
|
||||||
## Additional Resources
|
|
||||||
|
|
||||||
- [Matrix Security Disclosure Policy](https://matrix.org/security-disclosure-policy/)
|
|
||||||
- [Continuwuity Documentation](https://continuwuity.org/introduction)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
This security policy was last updated on May 25, 2025.
|
|
||||||
|
|
@ -1,67 +0,0 @@
|
||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
set -euo pipefail
|
|
||||||
|
|
||||||
# The root path where complement is available.
|
|
||||||
COMPLEMENT_SRC="${COMPLEMENT_SRC:-$1}"
|
|
||||||
|
|
||||||
# A `.jsonl` file to write test logs to
|
|
||||||
LOG_FILE="${2:-tests/test_results/complement/test_logs.jsonl}"
|
|
||||||
|
|
||||||
# A `.jsonl` file to write test results to
|
|
||||||
RESULTS_FILE="${3:-tests/test_results/complement/test_results.jsonl}"
|
|
||||||
|
|
||||||
# The base docker image to use for complement tests
|
|
||||||
# You can build the default with `docker build -t continuwuity:complement -f ./docker/complement.Dockerfile .`
|
|
||||||
# after running `cargo build`. Only the debug binary is used.
|
|
||||||
COMPLEMENT_BASE_IMAGE="${COMPLEMENT_BASE_IMAGE:-continuwuity:complement}"
|
|
||||||
|
|
||||||
# Complement tests that are skipped due to flakiness/reliability issues or we don't implement such features and won't for a long time
|
|
||||||
SKIPPED_COMPLEMENT_TESTS='TestPartialStateJoin.*|TestRoomDeleteAlias/Parallel/Regular_users_can_add_and_delete_aliases_when_m.*|TestRoomDeleteAlias/Parallel/Can_delete_canonical_alias|TestUnbanViaInvite.*|TestRoomState/Parallel/GET_/publicRooms_lists.*"|TestRoomDeleteAlias/Parallel/Users_with_sufficient_power-level_can_delete_other.*'
|
|
||||||
|
|
||||||
# $COMPLEMENT_SRC needs to be a directory to Complement source code
|
|
||||||
if [ -f "$COMPLEMENT_SRC" ]; then
|
|
||||||
echo "\$COMPLEMENT_SRC must be a directory/path to Complement source code"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
# quick test to make sure we can actually write to $LOG_FILE and $RESULTS_FILE
|
|
||||||
touch $LOG_FILE && rm -v $LOG_FILE
|
|
||||||
touch $RESULTS_FILE && rm -v $RESULTS_FILE
|
|
||||||
|
|
||||||
toplevel="$(git rev-parse --show-toplevel)"
|
|
||||||
|
|
||||||
pushd "$toplevel" > /dev/null
|
|
||||||
|
|
||||||
|
|
||||||
echo ""
|
|
||||||
echo "running go test with:"
|
|
||||||
echo "\$COMPLEMENT_SRC: $COMPLEMENT_SRC"
|
|
||||||
echo "\$COMPLEMENT_BASE_IMAGE: $COMPLEMENT_BASE_IMAGE"
|
|
||||||
echo "\$RESULTS_FILE: $RESULTS_FILE"
|
|
||||||
echo "\$LOG_FILE: $LOG_FILE"
|
|
||||||
echo ""
|
|
||||||
|
|
||||||
# It's okay (likely, even) that `go test` exits nonzero
|
|
||||||
# `COMPLEMENT_ENABLE_DIRTY_RUNS=1` reuses the same complement container for faster complement, at the possible expense of test environment pollution
|
|
||||||
set +o pipefail
|
|
||||||
env \
|
|
||||||
-C "$COMPLEMENT_SRC" \
|
|
||||||
COMPLEMENT_BASE_IMAGE="$COMPLEMENT_BASE_IMAGE" \
|
|
||||||
go test -tags="conduwuit_blacklist" -skip="$SKIPPED_COMPLEMENT_TESTS" -v -timeout 1h -json ./tests/... | tee "$LOG_FILE"
|
|
||||||
set -o pipefail
|
|
||||||
|
|
||||||
# Post-process the results into an easy-to-compare format, sorted by Test name for reproducible results
|
|
||||||
jq -s -c 'sort_by(.Test)[]' < "$LOG_FILE" | jq -c '
|
|
||||||
select(
|
|
||||||
(.Action == "pass" or .Action == "fail" or .Action == "skip")
|
|
||||||
and .Test != null
|
|
||||||
) | {Action: .Action, Test: .Test}
|
|
||||||
' > "$RESULTS_FILE"
|
|
||||||
|
|
||||||
echo ""
|
|
||||||
echo ""
|
|
||||||
echo "complement logs saved at $LOG_FILE"
|
|
||||||
echo "complement results saved at $RESULTS_FILE"
|
|
||||||
echo ""
|
|
||||||
echo ""
|
|
||||||
|
|
@ -1,110 +0,0 @@
|
||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
set -eo pipefail
|
|
||||||
|
|
||||||
toplevel="$(git rev-parse --show-toplevel)"
|
|
||||||
|
|
||||||
# Build just the single installable and forward any other arguments too
|
|
||||||
just() {
|
|
||||||
# uses nix-output-monitor (nom) if available
|
|
||||||
if command -v nom &> /dev/null; then
|
|
||||||
nom build "$@"
|
|
||||||
else
|
|
||||||
nix build -L "$@"
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ -z "$ATTIC_TOKEN" ]; then
|
|
||||||
echo "\$ATTIC_TOKEN is unset, skipping uploading to the binary cache"
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
|
|
||||||
# historical "conduit" store for compatibility purposes, same as conduwuit
|
|
||||||
nix run --inputs-from "$toplevel" attic -- \
|
|
||||||
login \
|
|
||||||
conduit \
|
|
||||||
"${ATTIC_ENDPOINT:-https://attic.kennel.juneis.dog/conduit}" \
|
|
||||||
"$ATTIC_TOKEN"
|
|
||||||
|
|
||||||
# Find all output paths of the installables and their build dependencies
|
|
||||||
#readarray -t derivations < <(nix path-info --derivation "$@")
|
|
||||||
derivations=()
|
|
||||||
while IFS=$'\n' read derivation; do
|
|
||||||
derivations+=("$derivation")
|
|
||||||
done < <(nix path-info --derivation "$@")
|
|
||||||
|
|
||||||
cache=()
|
|
||||||
for derivation in "${derivations[@]}"; do
|
|
||||||
cache+=(
|
|
||||||
"$(nix-store --query --requisites --include-outputs "$derivation")"
|
|
||||||
)
|
|
||||||
done
|
|
||||||
|
|
||||||
withattic() {
|
|
||||||
nix shell --inputs-from "$toplevel" attic --command xargs attic push "$@" <<< "${cache[*]}"
|
|
||||||
}
|
|
||||||
# Upload them to Attic (conduit store)
|
|
||||||
#
|
|
||||||
# Use `xargs` and a here-string because something would probably explode if
|
|
||||||
# several thousand arguments got passed to a command at once. Hopefully no
|
|
||||||
# store paths include a newline in them.
|
|
||||||
(
|
|
||||||
IFS=$'\n'
|
|
||||||
withattic conduit || withattic conduit || withattic conduit || true
|
|
||||||
)
|
|
||||||
|
|
||||||
# main "conduwuit" store
|
|
||||||
nix run --inputs-from "$toplevel" attic -- \
|
|
||||||
login \
|
|
||||||
conduwuit \
|
|
||||||
"${ATTIC_ENDPOINT:-https://attic.kennel.juneis.dog/conduwuit}" \
|
|
||||||
"$ATTIC_TOKEN"
|
|
||||||
|
|
||||||
# Upload them to Attic (conduwuit store) and Cachix
|
|
||||||
#
|
|
||||||
# Use `xargs` and a here-string because something would probably explode if
|
|
||||||
# several thousand arguments got passed to a command at once. Hopefully no
|
|
||||||
# store paths include a newline in them.
|
|
||||||
(
|
|
||||||
IFS=$'\n'
|
|
||||||
withattic conduwuit || withattic conduwuit || withattic conduwuit || true
|
|
||||||
|
|
||||||
# push to cachix if available
|
|
||||||
if [ "$CACHIX_AUTH_TOKEN" ]; then
|
|
||||||
nix shell --inputs-from "$toplevel" cachix -c xargs \
|
|
||||||
cachix push conduwuit <<< "${cache[*]}"
|
|
||||||
fi
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
# Build and cache things needed for CI
|
|
||||||
ci() {
|
|
||||||
cache=(
|
|
||||||
--inputs-from "$toplevel"
|
|
||||||
|
|
||||||
# Keep sorted
|
|
||||||
#"$toplevel#devShells.x86_64-linux.default"
|
|
||||||
#"$toplevel#devShells.x86_64-linux.all-features"
|
|
||||||
attic#default
|
|
||||||
cachix#default
|
|
||||||
nixpkgs#direnv
|
|
||||||
nixpkgs#jq
|
|
||||||
nixpkgs#nix-direnv
|
|
||||||
)
|
|
||||||
|
|
||||||
just "${cache[@]}"
|
|
||||||
}
|
|
||||||
|
|
||||||
# Build and cache *all* the package outputs from the flake.nix
|
|
||||||
packages() {
|
|
||||||
declare -a cache="($(
|
|
||||||
nix flake show --json 2> /dev/null |
|
|
||||||
nix run --inputs-from "$toplevel" nixpkgs#jq -- \
|
|
||||||
-r \
|
|
||||||
'.packages."x86_64-linux" | keys | map("'"$toplevel"'#" + .) | @sh'
|
|
||||||
))"
|
|
||||||
|
|
||||||
just "${cache[@]}"
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
eval "$@"
|
|
||||||
23
book.toml
23
book.toml
|
|
@ -1,23 +0,0 @@
|
||||||
[book]
|
|
||||||
title = "continuwuity"
|
|
||||||
description = "continuwuity is a community continuation of the conduwuit Matrix homeserver, written in Rust."
|
|
||||||
language = "en"
|
|
||||||
authors = ["The continuwuity Community"]
|
|
||||||
text-direction = "ltr"
|
|
||||||
src = "docs"
|
|
||||||
|
|
||||||
[build]
|
|
||||||
build-dir = "public"
|
|
||||||
create-missing = true
|
|
||||||
extra-watch-dirs = ["debian", "docs"]
|
|
||||||
|
|
||||||
[rust]
|
|
||||||
edition = "2024"
|
|
||||||
|
|
||||||
[output.html]
|
|
||||||
edit-url-template = "https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/{path}"
|
|
||||||
git-repository-url = "https://forgejo.ellis.link/continuwuation/continuwuity"
|
|
||||||
git-repository-icon = "fa-git-alt"
|
|
||||||
|
|
||||||
[output.html.search]
|
|
||||||
limit-results = 15
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Added support for using an admin command to issue self-service password reset links.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Stopped left rooms from being unconditionally sent on initial sync, hopefully fixing spurious appearances of left rooms in some clients (and making sync faster as a bonus). Contributed by @ginger
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Add Space permission cascading: power levels cascade from Spaces to child rooms, role-based room access with custom roles, continuous enforcement (auto-join/kick), and admin commands for role management. Server-wide default controlled by `space_permission_cascading` config flag (off by default), with per-Space overrides via `!admin space roles enable/disable <space>`.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Fixed corrupted appservice registrations causing the server to enter a crash loop. Contributed by @nex.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Re-added support for reading registration tokens from a file. Contributed by @ginger and @benbot.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Prevent removing the admin room alias (`#admins`) to avoid accidentally breaking admin room functionality. Contributed by @0xnim
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Add new config option to allow or disallow search engine indexing through a `<meta ../>` tag. Defaults to blocking indexing (`content="noindex"`). Contributed by @s1lv3r and @ginger.
|
|
||||||
32
clippy.toml
32
clippy.toml
|
|
@ -1,32 +0,0 @@
|
||||||
array-size-threshold = 4096
|
|
||||||
cognitive-complexity-threshold = 94 # TODO reduce me ALARA
|
|
||||||
excessive-nesting-threshold = 11 # TODO reduce me to 4 or 5
|
|
||||||
future-size-threshold = 7745 # TODO reduce me ALARA
|
|
||||||
stack-size-threshold = 196608 # TODO reduce me ALARA
|
|
||||||
too-many-lines-threshold = 780 # TODO reduce me to <= 100
|
|
||||||
type-complexity-threshold = 250 # reduce me to ~200
|
|
||||||
large-error-threshold = 256 # TODO reduce me ALARA
|
|
||||||
|
|
||||||
disallowed-macros = [
|
|
||||||
{ path = "log::error", reason = "use conduwuit_core::error" },
|
|
||||||
{ path = "log::warn", reason = "use conduwuit_core::warn" },
|
|
||||||
{ path = "log::info", reason = "use conduwuit_core::info" },
|
|
||||||
{ path = "log::debug", reason = "use conduwuit_core::debug" },
|
|
||||||
{ path = "log::trace", reason = "use conduwuit_core::trace" },
|
|
||||||
]
|
|
||||||
|
|
||||||
[[disallowed-methods]]
|
|
||||||
path = "tokio::spawn"
|
|
||||||
reason = "use and pass conduwuit_core::server::Server::runtime() to spawn from"
|
|
||||||
|
|
||||||
[[disallowed-methods]]
|
|
||||||
path = "reqwest::Response::bytes"
|
|
||||||
reason = "bytes is unsafe, use limit_read via the conduwuit_core::utils::LimitReadExt trait instead"
|
|
||||||
|
|
||||||
[[disallowed-methods]]
|
|
||||||
path = "reqwest::Response::text"
|
|
||||||
reason = "text is unsafe, use limit_read_text via the conduwuit_core::utils::LimitReadExt trait instead"
|
|
||||||
|
|
||||||
[[disallowed-methods]]
|
|
||||||
path = "reqwest::Response::json"
|
|
||||||
reason = "json is unsafe, use limit_read_text via the conduwuit_core::utils::LimitReadExt trait instead"
|
|
||||||
|
|
@ -1,3 +0,0 @@
|
||||||
style = "conventional"
|
|
||||||
subject_length = 72
|
|
||||||
allowed_types = ["ci", "build", "fix", "feat", "chore", "docs", "style", "refactor", "perf", "test"]
|
|
||||||
|
|
@ -1,67 +0,0 @@
|
||||||
#!/usr/bin/env bash
|
|
||||||
set -xe
|
|
||||||
# If we have no $SERVER_NAME set, abort
|
|
||||||
if [ -z "$SERVER_NAME" ]; then
|
|
||||||
echo "SERVER_NAME is not set, aborting"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
# If /complement/ca/ca.crt or /complement/ca/ca.key are missing, abort
|
|
||||||
if [ ! -f /complement/ca/ca.crt ] || [ ! -f /complement/ca/ca.key ]; then
|
|
||||||
echo "/complement/ca/ca.crt or /complement/ca/ca.key is missing, aborting"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Add the root cert to the local trust store
|
|
||||||
echo 'Installing Complement CA certificate to local trust store'
|
|
||||||
cp /complement/ca/ca.crt /usr/local/share/ca-certificates/complement-ca.crt
|
|
||||||
update-ca-certificates
|
|
||||||
|
|
||||||
# Sign a certificate for our $SERVER_NAME
|
|
||||||
echo "Generating and signing certificate for $SERVER_NAME"
|
|
||||||
openssl genrsa -out "/$SERVER_NAME.key" 2048
|
|
||||||
|
|
||||||
echo "Generating CSR for $SERVER_NAME"
|
|
||||||
openssl req -new -sha256 \
|
|
||||||
-key "/$SERVER_NAME.key" \
|
|
||||||
-out "/$SERVER_NAME.csr" \
|
|
||||||
-subj "/C=US/ST=CA/O=Continuwuity, Inc./CN=$SERVER_NAME"\
|
|
||||||
-addext "subjectAltName=DNS:$SERVER_NAME"
|
|
||||||
openssl req -in "$SERVER_NAME.csr" -noout -text
|
|
||||||
|
|
||||||
echo "Signing certificate for $SERVER_NAME with Complement CA"
|
|
||||||
cat <<EOF > ./cert.ext
|
|
||||||
authorityKeyIdentifier=keyid,issuer
|
|
||||||
basicConstraints = CA:FALSE
|
|
||||||
keyUsage = digitalSignature, keyEncipherment, dataEncipherment, nonRepudiation
|
|
||||||
extendedKeyUsage = serverAuth
|
|
||||||
subjectAltName = @alt_names
|
|
||||||
[alt_names]
|
|
||||||
DNS.1 = *.docker.internal
|
|
||||||
DNS.2 = hs1
|
|
||||||
DNS.3 = hs2
|
|
||||||
DNS.4 = hs3
|
|
||||||
DNS.5 = hs4
|
|
||||||
DNS.6 = $SERVER_NAME
|
|
||||||
IP.1 = 127.0.0.1
|
|
||||||
EOF
|
|
||||||
openssl x509 \
|
|
||||||
-req \
|
|
||||||
-in "/$SERVER_NAME.csr" \
|
|
||||||
-CA /complement/ca/ca.crt \
|
|
||||||
-CAkey /complement/ca/ca.key \
|
|
||||||
-CAcreateserial \
|
|
||||||
-out "/$SERVER_NAME.crt" \
|
|
||||||
-days 1 \
|
|
||||||
-sha256 \
|
|
||||||
-extfile ./cert.ext
|
|
||||||
|
|
||||||
# Tell continuwuity where to find the certs
|
|
||||||
export CONTINUWUITY_TLS__KEY="/$SERVER_NAME.key"
|
|
||||||
export CONTINUWUITY_TLS__CERTS="/$SERVER_NAME.crt"
|
|
||||||
# And who it is
|
|
||||||
export CONTINUWUITY_SERVER_NAME="$SERVER_NAME"
|
|
||||||
|
|
||||||
echo "Starting Continuwuity with SERVER_NAME=$SERVER_NAME"
|
|
||||||
# Start continuwuity
|
|
||||||
/usr/local/bin/conduwuit --config /etc/continuwuity/config.toml
|
|
||||||
|
|
@ -1,53 +0,0 @@
|
||||||
# ============================================= #
|
|
||||||
# Complement pre-filled configuration file #
|
|
||||||
#
|
|
||||||
# DANGER: THIS FILE FORCES INSECURE VALUES. #
|
|
||||||
# DO NOT USE OUTSIDE THE TEST SUITE ENV! #
|
|
||||||
# ============================================= #
|
|
||||||
[global]
|
|
||||||
address = "0.0.0.0"
|
|
||||||
allow_device_name_federation = true
|
|
||||||
allow_guest_registration = true
|
|
||||||
allow_public_room_directory_over_federation = true
|
|
||||||
allow_registration = true
|
|
||||||
database_path = "/database"
|
|
||||||
log = "trace,h2=debug,hyper=debug,conduwuit_database=warn,conduwuit_service::manager=info,conduwuit_api::router=error,conduwuit_router=error,tower_http=error"
|
|
||||||
port = [8008, 8448]
|
|
||||||
trusted_servers = []
|
|
||||||
only_query_trusted_key_servers = false
|
|
||||||
query_trusted_key_servers_first = false
|
|
||||||
query_trusted_key_servers_first_on_join = false
|
|
||||||
yes_i_am_very_very_sure_i_want_an_open_registration_server_prone_to_abuse = true
|
|
||||||
ip_range_denylist = []
|
|
||||||
url_preview_domain_contains_allowlist = ["*"]
|
|
||||||
url_preview_domain_explicit_denylist = ["*"]
|
|
||||||
media_compat_file_link = false
|
|
||||||
media_startup_check = true
|
|
||||||
prune_missing_media = true
|
|
||||||
log_colors = false
|
|
||||||
admin_room_notices = false
|
|
||||||
allow_check_for_updates = false
|
|
||||||
intentionally_unknown_config_option_for_testing = true
|
|
||||||
rocksdb_log_level = "info"
|
|
||||||
rocksdb_max_log_files = 1
|
|
||||||
rocksdb_recovery_mode = 0
|
|
||||||
rocksdb_paranoid_file_checks = true
|
|
||||||
log_guest_registrations = false
|
|
||||||
allow_legacy_media = true
|
|
||||||
startup_netburst = true
|
|
||||||
startup_netburst_keep = -1
|
|
||||||
allow_invalid_tls_certificates_yes_i_know_what_the_fuck_i_am_doing_with_this_and_i_know_this_is_insecure = true
|
|
||||||
dns_timeout = 60
|
|
||||||
dns_attempts = 20
|
|
||||||
request_conn_timeout = 60
|
|
||||||
request_timeout = 120
|
|
||||||
well_known_conn_timeout = 60
|
|
||||||
well_known_timeout = 60
|
|
||||||
federation_idle_timeout = 300
|
|
||||||
sender_timeout = 300
|
|
||||||
sender_idle_timeout = 300
|
|
||||||
sender_retry_backoff_limit = 300
|
|
||||||
force_disable_first_run_mode = true
|
|
||||||
|
|
||||||
[global.tls]
|
|
||||||
dual_protocol = true
|
|
||||||
114
compose.yml
Normal file
114
compose.yml
Normal file
|
|
@ -0,0 +1,114 @@
|
||||||
|
# podman save --format oci-archive jade-website-frontend:latest | gzip | ssh core@176.126.240.240 -T "zcat | podman load"
|
||||||
|
# podman compose create
|
||||||
|
# let containers = podman ps -a --format json | from json | where Labels."com.docker.compose.project" == "jade-website"
|
||||||
|
|
||||||
|
# podman compose create; let containers = podman ps -a --format json | from json | where Labels."com.docker.compose.project" == "jade-website"; podman kube generate ($containers | get Id) | save deployment.yml
|
||||||
|
# echo deployment.yml | ssh core@176.126.240.240 -T "cat > deployment.yml"
|
||||||
|
# $containers.1.Labels | to yaml
|
||||||
|
|
||||||
|
# podman kube generate -s ($containers | get Id) --podman-only | ssh core@176.126.240.240 -T "cat > deployment.yml"
|
||||||
|
|
||||||
|
|
||||||
|
version: '2'
|
||||||
|
services:
|
||||||
|
jade-website-frontend:
|
||||||
|
image: jade-website-frontend:latest
|
||||||
|
build:
|
||||||
|
context: .
|
||||||
|
dockerfile: packages/website/Dockerfile
|
||||||
|
restart: unless-stopped
|
||||||
|
# ports:
|
||||||
|
# - 3000:3000
|
||||||
|
networks:
|
||||||
|
- proxy
|
||||||
|
# deploy:
|
||||||
|
|
||||||
|
labels:
|
||||||
|
- "traefik.enable=true"
|
||||||
|
- "traefik.docker.network=proxy" # Change this to the name of your Traefik docker proxy network
|
||||||
|
|
||||||
|
# - "traefik.http.routers.to-website.rule=Host(`jade.ellis.link`)"
|
||||||
|
# - "traefik.http.routers.to-website.entrypoints=http"
|
||||||
|
- "traefik.http.routers.to-website.rule=Host(`jade.ellis.link.localhost`)"
|
||||||
|
- "traefik.http.routers.to-website.entrypoints=http"
|
||||||
|
# - "traefik.http.routers.to-website.tls=true"
|
||||||
|
# - "traefik.http.routers.to-website.tls.certresolver=letsencrypt"
|
||||||
|
# - "traefik.http.routers.to-website.middlewares=cors-headers@docker"
|
||||||
|
|
||||||
|
# - "traefik.http.middlewares.cors-headers.headers.accessControlAllowOriginList=*"
|
||||||
|
# - "traefik.http.middlewares.cors-headers.headers.accessControlAllowHeaders=Origin, X-Requested-With, Content-Type, Accept, Authorization"
|
||||||
|
# - "traefik.http.middlewares.cors-headers.headers.accessControlAllowMethods=GET, POST, PUT, DELETE, OPTIONS"
|
||||||
|
|
||||||
|
|
||||||
|
traefik:
|
||||||
|
image: "traefik:latest"
|
||||||
|
container_name: "traefik"
|
||||||
|
restart: "unless-stopped"
|
||||||
|
# privileged: true
|
||||||
|
security_opt:
|
||||||
|
- "label=type:container_runtime_t"
|
||||||
|
command:
|
||||||
|
- "--log.level=DEBUG"
|
||||||
|
- "--providers.docker=true"
|
||||||
|
- "--providers.docker.exposedbydefault=false"
|
||||||
|
- "--entrypoints.http.address=:8080"
|
||||||
|
# - "--entrypoints.https.address=:443"
|
||||||
|
# - "--acme"
|
||||||
|
# - "--certificatesresolvers.letsencrypt.acme.email='jade@ellis.link'"
|
||||||
|
# - "--certificatesresolvers.letsencrypt.acme.storage=/certificates/acme.json"
|
||||||
|
|
||||||
|
# - "--certificatesresolvers.letsencrypt.acme.httpchallenge=true"
|
||||||
|
# - "--certificatesresolvers.letsencrypt.acme.httpChallenge.entryPoint=http"
|
||||||
|
# - "--certificatesresolvers.lets-encrypt.acme.tlschallenge=true"
|
||||||
|
|
||||||
|
# - "--entrypoints.http.http.redirections.entryPoint.to=https"
|
||||||
|
# - "--entrypoints.http.http.redirections.entryPoint.scheme=https"
|
||||||
|
|
||||||
|
# - --api.dashboard=true
|
||||||
|
# - --api.insecure=true
|
||||||
|
ports:
|
||||||
|
# - "80:80"
|
||||||
|
# - "443:443"
|
||||||
|
- "8080:8080"
|
||||||
|
volumes:
|
||||||
|
- "/run/user/1000/podman/podman.sock:/var/run/docker.sock"
|
||||||
|
# - "/var/run/docker.sock:/var/run/docker.sock:ro"
|
||||||
|
- "traefik-public-certificates:/certificates"
|
||||||
|
# - "./traefik_config:/etc/traefik"
|
||||||
|
# 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"
|
||||||
|
|
||||||
|
networks:
|
||||||
|
- proxy
|
||||||
|
|
||||||
|
networks:
|
||||||
|
proxy:
|
||||||
|
# external: true
|
||||||
|
enable_ipv6: true
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
traefik-public-certificates:
|
||||||
|
# mkdir -p ~/.config/containers/systemd
|
||||||
|
# nano ~/.config/containers/systemd/deployment.kube
|
||||||
|
|
||||||
|
# [Unit]
|
||||||
|
# Description=Deployment via kubernetes
|
||||||
|
# Before=local-fs.target
|
||||||
|
# [Kube]
|
||||||
|
# Yaml=/var/home/core/deployment.yml
|
||||||
|
# [Install]
|
||||||
|
# # Start by default on boot
|
||||||
|
# WantedBy=multi-user.target default.target
|
||||||
|
|
||||||
|
# systemctl --user daemon-reload
|
||||||
|
# systemctl --user start deployment.service
|
||||||
File diff suppressed because it is too large
Load diff
10
default.nix
10
default.nix
|
|
@ -1,10 +0,0 @@
|
||||||
(import
|
|
||||||
(
|
|
||||||
let lock = builtins.fromJSON (builtins.readFile ./flake.lock); in
|
|
||||||
fetchTarball {
|
|
||||||
url = lock.nodes.flake-compat.locked.url or "https://github.com/edolstra/flake-compat/archive/${lock.nodes.flake-compat.locked.rev}.tar.gz";
|
|
||||||
sha256 = lock.nodes.flake-compat.locked.narHash;
|
|
||||||
}
|
|
||||||
)
|
|
||||||
{ src = ./.; }
|
|
||||||
).defaultNix
|
|
||||||
2
deploy_website.nu
Normal file
2
deploy_website.nu
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
podman build . -f packages/website/Dockerfile -t jade-website-frontend:latest;
|
||||||
|
podman save --format oci-archive jade-website-frontend:latest | gzip | ssh fedora@213.32.25.24 -T "sudo sh -c ' zcat > /opt/images/jade-website-frontend'"
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
docs/development/index.mdx
|
|
||||||
|
|
@ -1,284 +0,0 @@
|
||||||
ARG RUST_VERSION=1
|
|
||||||
ARG DEBIAN_VERSION=bookworm
|
|
||||||
|
|
||||||
FROM --platform=$BUILDPLATFORM docker.io/tonistiigi/xx AS xx
|
|
||||||
FROM --platform=$BUILDPLATFORM rust:${RUST_VERSION}-slim-${DEBIAN_VERSION} AS base
|
|
||||||
FROM --platform=$BUILDPLATFORM rust:${RUST_VERSION}-slim-${DEBIAN_VERSION} AS toolchain
|
|
||||||
|
|
||||||
# Prevent deletion of apt cache
|
|
||||||
RUN rm -f /etc/apt/apt.conf.d/docker-clean
|
|
||||||
|
|
||||||
# Match Rustc version as close as possible
|
|
||||||
# rustc -vV
|
|
||||||
ARG LLVM_VERSION=20
|
|
||||||
# ENV RUSTUP_TOOLCHAIN=${RUST_VERSION}
|
|
||||||
|
|
||||||
# Install repo tools
|
|
||||||
# Line one: compiler tools
|
|
||||||
# Line two: curl, for downloading binaries
|
|
||||||
# Line three: for xx-verify
|
|
||||||
RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
|
|
||||||
--mount=type=cache,target=/var/lib/apt,sharing=locked \
|
|
||||||
apt-get update && apt-get install -y \
|
|
||||||
pkg-config make jq \
|
|
||||||
curl git software-properties-common \
|
|
||||||
file
|
|
||||||
|
|
||||||
# LLVM packages
|
|
||||||
RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
|
|
||||||
--mount=type=cache,target=/var/lib/apt,sharing=locked \
|
|
||||||
curl https://apt.llvm.org/llvm.sh > llvm.sh && \
|
|
||||||
chmod +x llvm.sh && \
|
|
||||||
./llvm.sh ${LLVM_VERSION} && \
|
|
||||||
rm llvm.sh
|
|
||||||
|
|
||||||
# Create symlinks for LLVM tools
|
|
||||||
RUN <<EOF
|
|
||||||
set -o xtrace
|
|
||||||
# clang
|
|
||||||
ln -s /usr/bin/clang-${LLVM_VERSION} /usr/bin/clang
|
|
||||||
ln -s "/usr/bin/clang++-${LLVM_VERSION}" "/usr/bin/clang++"
|
|
||||||
# lld
|
|
||||||
ln -s /usr/bin/ld64.lld-${LLVM_VERSION} /usr/bin/ld64.lld
|
|
||||||
ln -s /usr/bin/ld.lld-${LLVM_VERSION} /usr/bin/ld.lld
|
|
||||||
ln -s /usr/bin/lld-${LLVM_VERSION} /usr/bin/lld
|
|
||||||
ln -s /usr/bin/lld-link-${LLVM_VERSION} /usr/bin/lld-link
|
|
||||||
ln -s /usr/bin/wasm-ld-${LLVM_VERSION} /usr/bin/wasm-ld
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# Developer tool versions
|
|
||||||
# renovate: datasource=github-releases depName=cargo-bins/cargo-binstall
|
|
||||||
ENV BINSTALL_VERSION=1.17.7
|
|
||||||
# renovate: datasource=github-releases depName=psastras/sbom-rs
|
|
||||||
ENV CARGO_SBOM_VERSION=0.9.1
|
|
||||||
# renovate: datasource=crate depName=lddtree
|
|
||||||
ENV LDDTREE_VERSION=0.5.0
|
|
||||||
# renovate: datasource=crate depName=timelord-cli
|
|
||||||
ENV TIMELORD_VERSION=3.0.1
|
|
||||||
|
|
||||||
# Install unpackaged tools
|
|
||||||
RUN <<EOF
|
|
||||||
set -o xtrace
|
|
||||||
curl --retry 5 -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
|
|
||||||
cargo binstall --no-confirm cargo-sbom --version $CARGO_SBOM_VERSION
|
|
||||||
cargo binstall --no-confirm lddtree --version $LDDTREE_VERSION
|
|
||||||
cargo binstall --no-confirm timelord-cli --version $TIMELORD_VERSION
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# Set up xx (cross-compilation scripts)
|
|
||||||
COPY --from=xx / /
|
|
||||||
ARG TARGETPLATFORM
|
|
||||||
|
|
||||||
# Install libraries linked by the binary
|
|
||||||
# xx-* are xx-specific meta-packages
|
|
||||||
RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
|
|
||||||
--mount=type=cache,target=/var/lib/apt,sharing=locked \
|
|
||||||
xx-apt-get install -y \
|
|
||||||
xx-c-essentials xx-cxx-essentials pkg-config \
|
|
||||||
liburing-dev
|
|
||||||
|
|
||||||
# Set up Rust toolchain
|
|
||||||
WORKDIR /app
|
|
||||||
COPY ./rust-toolchain.toml .
|
|
||||||
RUN rustc --version \
|
|
||||||
&& xx-cargo --setup-target-triple
|
|
||||||
|
|
||||||
# Build binary
|
|
||||||
# Configure incremental compilation based on build context
|
|
||||||
ARG CARGO_INCREMENTAL=0
|
|
||||||
RUN echo "CARGO_INCREMENTAL=${CARGO_INCREMENTAL}" >> /etc/environment
|
|
||||||
|
|
||||||
# Configure pkg-config
|
|
||||||
RUN <<EOF
|
|
||||||
set -o xtrace
|
|
||||||
if command -v "$(xx-info)-pkg-config" >/dev/null 2>/dev/null; then
|
|
||||||
echo "PKG_CONFIG_LIBDIR=/usr/lib/$(xx-info)/pkgconfig" >> /etc/environment
|
|
||||||
echo "PKG_CONFIG=/usr/bin/$(xx-info)-pkg-config" >> /etc/environment
|
|
||||||
fi
|
|
||||||
echo "PKG_CONFIG_ALLOW_CROSS=true" >> /etc/environment
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# Configure cc to use clang version
|
|
||||||
RUN <<EOF
|
|
||||||
set -o xtrace
|
|
||||||
echo "CC=clang" >> /etc/environment
|
|
||||||
echo "CXX=clang++" >> /etc/environment
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# Cross-language LTO
|
|
||||||
RUN <<EOF
|
|
||||||
set -o xtrace
|
|
||||||
echo "CFLAGS=-flto" >> /etc/environment
|
|
||||||
echo "CXXFLAGS=-flto" >> /etc/environment
|
|
||||||
# Linker is set to target-compatible clang by xx
|
|
||||||
echo "RUSTFLAGS='-Clinker-plugin-lto -Clink-arg=-fuse-ld=lld'" >> /etc/environment
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# Apply CPU-specific optimizations if TARGET_CPU is provided
|
|
||||||
ARG TARGET_CPU
|
|
||||||
|
|
||||||
RUN <<EOF
|
|
||||||
set -o allexport
|
|
||||||
set -o xtrace
|
|
||||||
. /etc/environment
|
|
||||||
if [ -n "${TARGET_CPU}" ]; then
|
|
||||||
echo "CFLAGS='${CFLAGS} -march=${TARGET_CPU}'" >> /etc/environment
|
|
||||||
echo "CXXFLAGS='${CXXFLAGS} -march=${TARGET_CPU}'" >> /etc/environment
|
|
||||||
echo "RUSTFLAGS='${RUSTFLAGS} -C target-cpu=${TARGET_CPU}'" >> /etc/environment
|
|
||||||
fi
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# Prepare output directories
|
|
||||||
RUN mkdir /out
|
|
||||||
|
|
||||||
FROM toolchain AS builder
|
|
||||||
|
|
||||||
|
|
||||||
# Get source
|
|
||||||
COPY . .
|
|
||||||
|
|
||||||
# Restore timestamps from timelord cache if available
|
|
||||||
RUN --mount=type=cache,target=/timelord/ \
|
|
||||||
echo "Restoring timestamps from timelord cache"; \
|
|
||||||
timelord sync --source-dir /app --cache-dir /timelord;
|
|
||||||
|
|
||||||
ARG TARGETPLATFORM
|
|
||||||
|
|
||||||
# Verify environment configuration
|
|
||||||
RUN xx-cargo --print-target-triple
|
|
||||||
|
|
||||||
# Conduwuit version info
|
|
||||||
ARG GIT_COMMIT_HASH
|
|
||||||
ARG GIT_COMMIT_HASH_SHORT
|
|
||||||
ARG GIT_REMOTE_URL
|
|
||||||
ARG GIT_REMOTE_COMMIT_URL
|
|
||||||
ARG CONDUWUIT_VERSION_EXTRA
|
|
||||||
ARG CONTINUWUITY_VERSION_EXTRA
|
|
||||||
ENV GIT_COMMIT_HASH=$GIT_COMMIT_HASH
|
|
||||||
ENV GIT_COMMIT_HASH_SHORT=$GIT_COMMIT_HASH_SHORT
|
|
||||||
ENV GIT_REMOTE_URL=$GIT_REMOTE_URL
|
|
||||||
ENV GIT_REMOTE_COMMIT_URL=$GIT_REMOTE_COMMIT_URL
|
|
||||||
ENV CONDUWUIT_VERSION_EXTRA=$CONDUWUIT_VERSION_EXTRA
|
|
||||||
ENV CONTINUWUITY_VERSION_EXTRA=$CONTINUWUITY_VERSION_EXTRA
|
|
||||||
|
|
||||||
ARG RUST_PROFILE=release
|
|
||||||
ARG CARGO_FEATURES="default,http3"
|
|
||||||
|
|
||||||
# Build the binary
|
|
||||||
RUN --mount=type=cache,target=/usr/local/cargo/registry \
|
|
||||||
--mount=type=cache,target=/usr/local/cargo/git/db \
|
|
||||||
--mount=type=cache,target=/app/target,id=continuwuity-cargo-target-${TARGET_CPU}-${TARGETPLATFORM}-${RUST_PROFILE} \
|
|
||||||
bash <<'EOF'
|
|
||||||
set -o allexport
|
|
||||||
set -o xtrace
|
|
||||||
. /etc/environment
|
|
||||||
|
|
||||||
# Check if http3 feature is enabled and set appropriate RUSTFLAGS
|
|
||||||
if echo "${CARGO_FEATURES}" | grep -q "http3"; then
|
|
||||||
export RUSTFLAGS="${RUSTFLAGS} --cfg reqwest_unstable"
|
|
||||||
else
|
|
||||||
export RUSTFLAGS="${RUSTFLAGS}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
RUST_PROFILE_DIR="${RUST_PROFILE}"
|
|
||||||
if [[ "${RUST_PROFILE}" == "dev" ]]; then
|
|
||||||
RUST_PROFILE_DIR="debug"
|
|
||||||
fi
|
|
||||||
|
|
||||||
TARGET_DIR=($(cargo metadata --no-deps --format-version 1 | \
|
|
||||||
jq -r ".target_directory"))
|
|
||||||
mkdir /out/sbin
|
|
||||||
PACKAGE=conduwuit
|
|
||||||
xx-cargo build --locked --profile ${RUST_PROFILE} \
|
|
||||||
--no-default-features --features ${CARGO_FEATURES} \
|
|
||||||
-p $PACKAGE;
|
|
||||||
BINARIES=($(cargo metadata --no-deps --format-version 1 | \
|
|
||||||
jq -r ".packages[] | select(.name == \"$PACKAGE\") | .targets[] | select( .kind | map(. == \"bin\") | any ) | .name"))
|
|
||||||
for BINARY in "${BINARIES[@]}"; do
|
|
||||||
echo $BINARY
|
|
||||||
xx-verify $TARGET_DIR/$(xx-cargo --print-target-triple)/${RUST_PROFILE_DIR}/$BINARY
|
|
||||||
cp $TARGET_DIR/$(xx-cargo --print-target-triple)/${RUST_PROFILE_DIR}/$BINARY /out/sbin/$BINARY
|
|
||||||
done
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# Generate Software Bill of Materials (SBOM)
|
|
||||||
RUN --mount=type=cache,target=/usr/local/cargo/registry \
|
|
||||||
--mount=type=cache,target=/usr/local/cargo/git/db \
|
|
||||||
bash <<'EOF'
|
|
||||||
set -o xtrace
|
|
||||||
mkdir /out/sbom
|
|
||||||
typeset -A PACKAGES
|
|
||||||
for BINARY in /out/sbin/*; do
|
|
||||||
BINARY_BASE=$(basename ${BINARY})
|
|
||||||
package=$(cargo metadata --no-deps --format-version 1 | jq -r ".packages[] | select(.targets[] | select( .kind | map(. == \"bin\") | any ) | .name == \"$BINARY_BASE\") | .name")
|
|
||||||
if [ -z "$package" ]; then
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
PACKAGES[$package]=1
|
|
||||||
done
|
|
||||||
for PACKAGE in $(echo ${!PACKAGES[@]}); do
|
|
||||||
echo $PACKAGE
|
|
||||||
cargo sbom --cargo-package $PACKAGE > /out/sbom/$PACKAGE.spdx.json
|
|
||||||
done
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# Extract dynamically linked dependencies
|
|
||||||
RUN <<'DEPS_EOF'
|
|
||||||
set -o xtrace
|
|
||||||
mkdir /out/libs /out/libs-root
|
|
||||||
|
|
||||||
# Process each binary
|
|
||||||
for BINARY in /out/sbin/*; do
|
|
||||||
if lddtree_output=$(lddtree "$BINARY" 2>/dev/null) && [ -n "$lddtree_output" ]; then
|
|
||||||
echo "$lddtree_output" | awk '{print $(NF-0) " " $1}' | sort -u -k 1,1 | \
|
|
||||||
awk '{dest = ($2 ~ /^\//) ? "/out/libs-root" $2 : "/out/libs/" $2; print "install -D " $1 " " dest}' | \
|
|
||||||
while read cmd; do eval "$cmd"; done
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
# Show what will be copied to runtime
|
|
||||||
echo "=== Libraries being copied to runtime image:"
|
|
||||||
find /out/libs* -type f 2>/dev/null | sort || echo "No libraries found"
|
|
||||||
DEPS_EOF
|
|
||||||
|
|
||||||
FROM ubuntu:latest AS prepper
|
|
||||||
|
|
||||||
# Create layer structure
|
|
||||||
RUN mkdir -p /layer1/etc/ssl/certs \
|
|
||||||
/layer2/usr/lib \
|
|
||||||
/layer3/sbin /layer3/sbom
|
|
||||||
|
|
||||||
# Copy SSL certs and root-path libraries to layer1 (ultra-stable)
|
|
||||||
COPY --from=base /etc/ssl/certs /layer1/etc/ssl/certs
|
|
||||||
COPY --from=builder /out/libs-root/ /layer1/
|
|
||||||
|
|
||||||
# Copy application libraries to layer2 (semi-stable)
|
|
||||||
COPY --from=builder /out/libs/ /layer2/usr/lib/
|
|
||||||
|
|
||||||
# Copy binaries and SBOM to layer3 (volatile)
|
|
||||||
COPY --from=builder /out/sbin/ /layer3/sbin/
|
|
||||||
COPY --from=builder /out/sbom/ /layer3/sbom/
|
|
||||||
|
|
||||||
# Fix permissions after copying
|
|
||||||
RUN chmod -R 755 /layer1 /layer2 /layer3
|
|
||||||
|
|
||||||
FROM scratch
|
|
||||||
|
|
||||||
WORKDIR /
|
|
||||||
|
|
||||||
# Copy ultra-stable layer (SSL certs, system libraries)
|
|
||||||
COPY --from=prepper /layer1/ /
|
|
||||||
|
|
||||||
# Copy semi-stable layer (application libraries)
|
|
||||||
COPY --from=prepper /layer2/ /
|
|
||||||
|
|
||||||
# Copy volatile layer (binaries, SBOM)
|
|
||||||
COPY --from=prepper /layer3/ /
|
|
||||||
|
|
||||||
# Inform linker where to find libraries
|
|
||||||
ENV LD_LIBRARY_PATH=/usr/lib
|
|
||||||
|
|
||||||
# Continuwuity default port
|
|
||||||
EXPOSE 8008
|
|
||||||
|
|
||||||
CMD ["/sbin/conduwuit"]
|
|
||||||
|
|
@ -1,11 +0,0 @@
|
||||||
FROM ubuntu:latest
|
|
||||||
EXPOSE 8008
|
|
||||||
EXPOSE 8448
|
|
||||||
RUN apt-get update && apt-get install -y ca-certificates liburing2 && rm -rf /var/lib/apt/lists/*
|
|
||||||
RUN mkdir -p /etc/continuwuity /var/lib/continuwuity /usr/local/bin/
|
|
||||||
COPY complement/complement-entrypoint.sh /usr/local/bin/complement-entrypoint.sh
|
|
||||||
COPY complement/complement.config.toml /etc/continuwuity/config.toml
|
|
||||||
COPY target/debug/conduwuit /usr/local/bin/conduwuit
|
|
||||||
RUN chmod +x /usr/local/bin/conduwuit /usr/local/bin/complement-entrypoint.sh
|
|
||||||
#HEALTHCHECK --interval=30s --timeout=5s CMD curl --fail http://localhost:8008/_continuwuity/server_version || exit 1
|
|
||||||
ENTRYPOINT ["/usr/local/bin/complement-entrypoint.sh"]
|
|
||||||
|
|
@ -1,200 +0,0 @@
|
||||||
# Why does this exist?
|
|
||||||
# Debian doesn't provide prebuilt musl packages
|
|
||||||
# rocksdb requires a prebuilt liburing, and linking fails if a gnu one is provided
|
|
||||||
|
|
||||||
ARG RUST_VERSION=1
|
|
||||||
ARG ALPINE_VERSION=3.22
|
|
||||||
|
|
||||||
FROM --platform=$BUILDPLATFORM docker.io/tonistiigi/xx AS xx
|
|
||||||
FROM --platform=$BUILDPLATFORM rust:${RUST_VERSION}-alpine${ALPINE_VERSION} AS base
|
|
||||||
FROM --platform=$BUILDPLATFORM rust:${RUST_VERSION}-alpine${ALPINE_VERSION} AS toolchain
|
|
||||||
|
|
||||||
# Install repo tools and dependencies
|
|
||||||
RUN --mount=type=cache,target=/etc/apk/cache apk add \
|
|
||||||
build-base pkgconfig make jq bash \
|
|
||||||
curl git file \
|
|
||||||
llvm-dev clang clang-static lld
|
|
||||||
|
|
||||||
|
|
||||||
# Developer tool versions
|
|
||||||
# renovate: datasource=github-releases depName=cargo-bins/cargo-binstall
|
|
||||||
ENV BINSTALL_VERSION=1.17.7
|
|
||||||
# renovate: datasource=github-releases depName=psastras/sbom-rs
|
|
||||||
ENV CARGO_SBOM_VERSION=0.9.1
|
|
||||||
# renovate: datasource=crate depName=lddtree
|
|
||||||
ENV LDDTREE_VERSION=0.5.0
|
|
||||||
|
|
||||||
# Install unpackaged tools
|
|
||||||
RUN <<EOF
|
|
||||||
set -o xtrace
|
|
||||||
curl --retry 5 -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
|
|
||||||
cargo binstall --no-confirm cargo-sbom --version $CARGO_SBOM_VERSION
|
|
||||||
cargo binstall --no-confirm lddtree --version $LDDTREE_VERSION
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# Set up xx (cross-compilation scripts)
|
|
||||||
COPY --from=xx / /
|
|
||||||
ARG TARGETPLATFORM
|
|
||||||
|
|
||||||
# Install libraries linked by the binary
|
|
||||||
RUN --mount=type=cache,target=/etc/apk/cache xx-apk add musl-dev gcc g++ liburing-dev
|
|
||||||
|
|
||||||
# Set up Rust toolchain
|
|
||||||
WORKDIR /app
|
|
||||||
COPY ./rust-toolchain.toml .
|
|
||||||
RUN rustc --version \
|
|
||||||
&& xx-cargo --setup-target-triple
|
|
||||||
|
|
||||||
# Build binary
|
|
||||||
# We disable incremental compilation to save disk space, as it only produces a minimal speedup for this case.
|
|
||||||
RUN echo "CARGO_INCREMENTAL=0" >> /etc/environment
|
|
||||||
|
|
||||||
# Configure pkg-config
|
|
||||||
RUN <<EOF
|
|
||||||
set -o xtrace
|
|
||||||
if command -v "$(xx-info)-pkg-config" >/dev/null 2>/dev/null; then
|
|
||||||
echo "PKG_CONFIG_LIBDIR=/usr/lib/$(xx-info)/pkgconfig" >> /etc/environment
|
|
||||||
echo "PKG_CONFIG=/usr/bin/$(xx-info)-pkg-config" >> /etc/environment
|
|
||||||
fi
|
|
||||||
echo "PKG_CONFIG_ALLOW_CROSS=true" >> /etc/environment
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# Configure cc to use clang version
|
|
||||||
RUN <<EOF
|
|
||||||
set -o xtrace
|
|
||||||
echo "CC=clang" >> /etc/environment
|
|
||||||
echo "CXX=clang++" >> /etc/environment
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# Cross-language LTO
|
|
||||||
RUN <<EOF
|
|
||||||
set -o xtrace
|
|
||||||
echo "CFLAGS=-flto" >> /etc/environment
|
|
||||||
echo "CXXFLAGS=-flto" >> /etc/environment
|
|
||||||
# Linker is set to target-compatible clang by xx
|
|
||||||
echo "RUSTFLAGS='-Clinker-plugin-lto -Clink-arg=-fuse-ld=lld'" >> /etc/environment
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# Apply CPU-specific optimizations if TARGET_CPU is provided
|
|
||||||
ARG TARGET_CPU
|
|
||||||
|
|
||||||
RUN <<EOF
|
|
||||||
set -o allexport
|
|
||||||
set -o xtrace
|
|
||||||
. /etc/environment
|
|
||||||
if [ -n "${TARGET_CPU}" ]; then
|
|
||||||
echo "CFLAGS='${CFLAGS} -march=${TARGET_CPU}'" >> /etc/environment
|
|
||||||
echo "CXXFLAGS='${CXXFLAGS} -march=${TARGET_CPU}'" >> /etc/environment
|
|
||||||
echo "RUSTFLAGS='${RUSTFLAGS} -C target-cpu=${TARGET_CPU}'" >> /etc/environment
|
|
||||||
fi
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# Prepare output directories
|
|
||||||
RUN mkdir /out
|
|
||||||
|
|
||||||
FROM toolchain AS builder
|
|
||||||
|
|
||||||
|
|
||||||
# Get source
|
|
||||||
COPY . .
|
|
||||||
|
|
||||||
ARG TARGETPLATFORM
|
|
||||||
|
|
||||||
# Verify environment configuration
|
|
||||||
RUN xx-cargo --print-target-triple
|
|
||||||
|
|
||||||
# Conduwuit version info
|
|
||||||
ARG GIT_COMMIT_HASH
|
|
||||||
ARG GIT_COMMIT_HASH_SHORT
|
|
||||||
ARG GIT_REMOTE_URL
|
|
||||||
ARG GIT_REMOTE_COMMIT_URL
|
|
||||||
ARG CONDUWUIT_VERSION_EXTRA
|
|
||||||
ARG CONTINUWUITY_VERSION_EXTRA
|
|
||||||
ENV GIT_COMMIT_HASH=$GIT_COMMIT_HASH
|
|
||||||
ENV GIT_COMMIT_HASH_SHORT=$GIT_COMMIT_HASH_SHORT
|
|
||||||
ENV GIT_REMOTE_URL=$GIT_REMOTE_URL
|
|
||||||
ENV GIT_REMOTE_COMMIT_URL=$GIT_REMOTE_COMMIT_URL
|
|
||||||
ENV CONDUWUIT_VERSION_EXTRA=$CONDUWUIT_VERSION_EXTRA
|
|
||||||
ENV CONTINUWUITY_VERSION_EXTRA=$CONTINUWUITY_VERSION_EXTRA
|
|
||||||
|
|
||||||
ARG RUST_PROFILE=release
|
|
||||||
|
|
||||||
# Build the binary
|
|
||||||
RUN --mount=type=cache,target=/usr/local/cargo/registry \
|
|
||||||
--mount=type=cache,target=/usr/local/cargo/git/db \
|
|
||||||
--mount=type=cache,target=/app/target,id=continuwuity-cargo-target-${TARGET_CPU}-${TARGETPLATFORM}-musl-${RUST_PROFILE} \
|
|
||||||
bash <<'EOF'
|
|
||||||
set -o allexport
|
|
||||||
set -o xtrace
|
|
||||||
. /etc/environment
|
|
||||||
TARGET_DIR=($(cargo metadata --no-deps --format-version 1 | \
|
|
||||||
jq -r ".target_directory"))
|
|
||||||
mkdir /out/sbin
|
|
||||||
PACKAGE=conduwuit
|
|
||||||
xx-cargo build --locked --profile ${RUST_PROFILE} \
|
|
||||||
-p $PACKAGE --no-default-features --features bindgen-static,release_max_log_level,standard;
|
|
||||||
BINARIES=($(cargo metadata --no-deps --format-version 1 | \
|
|
||||||
jq -r ".packages[] | select(.name == \"$PACKAGE\") | .targets[] | select( .kind | map(. == \"bin\") | any ) | .name"))
|
|
||||||
for BINARY in "${BINARIES[@]}"; do
|
|
||||||
echo $BINARY
|
|
||||||
xx-verify $TARGET_DIR/$(xx-cargo --print-target-triple)/release/$BINARY
|
|
||||||
cp $TARGET_DIR/$(xx-cargo --print-target-triple)/release/$BINARY /out/sbin/$BINARY
|
|
||||||
done
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# Generate Software Bill of Materials (SBOM)
|
|
||||||
RUN --mount=type=cache,target=/usr/local/cargo/registry \
|
|
||||||
--mount=type=cache,target=/usr/local/cargo/git/db \
|
|
||||||
bash <<'EOF'
|
|
||||||
set -o xtrace
|
|
||||||
mkdir /out/sbom
|
|
||||||
typeset -A PACKAGES
|
|
||||||
for BINARY in /out/sbin/*; do
|
|
||||||
BINARY_BASE=$(basename ${BINARY})
|
|
||||||
package=$(cargo metadata --no-deps --format-version 1 | jq -r ".packages[] | select(.targets[] | select( .kind | map(. == \"bin\") | any ) | .name == \"$BINARY_BASE\") | .name")
|
|
||||||
if [ -z "$package" ]; then
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
PACKAGES[$package]=1
|
|
||||||
done
|
|
||||||
for PACKAGE in $(echo ${!PACKAGES[@]}); do
|
|
||||||
echo $PACKAGE
|
|
||||||
cargo sbom --cargo-package $PACKAGE > /out/sbom/$PACKAGE.spdx.json
|
|
||||||
done
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# Extract dynamically linked dependencies
|
|
||||||
RUN <<EOF
|
|
||||||
set -o xtrace
|
|
||||||
mkdir /out/libs
|
|
||||||
mkdir /out/libs-root
|
|
||||||
for BINARY in /out/sbin/*; do
|
|
||||||
lddtree "$BINARY" | awk '{print $(NF-0) " " $1}' | sort -u -k 1,1 | awk '{print "install", "-D", $1, (($2 ~ /^\//) ? "/out/libs-root" $2 : "/out/libs/" $2)}' | xargs -I {} sh -c {}
|
|
||||||
done
|
|
||||||
EOF
|
|
||||||
|
|
||||||
FROM scratch
|
|
||||||
|
|
||||||
WORKDIR /
|
|
||||||
|
|
||||||
# Copy root certs for tls into image
|
|
||||||
# You can also mount the certs from the host
|
|
||||||
# --volume /etc/ssl/certs:/etc/ssl/certs:ro
|
|
||||||
COPY --from=base /etc/ssl/certs /etc/ssl/certs
|
|
||||||
|
|
||||||
# Copy our build
|
|
||||||
COPY --from=builder /out/sbin/ /sbin/
|
|
||||||
# Copy SBOM
|
|
||||||
COPY --from=builder /out/sbom/ /sbom/
|
|
||||||
|
|
||||||
# Copy dynamic libraries to root
|
|
||||||
COPY --from=builder /out/libs-root/ /
|
|
||||||
COPY --from=builder /out/libs/ /usr/lib/
|
|
||||||
|
|
||||||
# Inform linker where to find libraries
|
|
||||||
ENV LD_LIBRARY_PATH=/usr/lib
|
|
||||||
|
|
||||||
# Continuwuity default port
|
|
||||||
EXPOSE 8008
|
|
||||||
|
|
||||||
CMD ["/sbin/conduwuit"]
|
|
||||||
|
|
@ -1,85 +0,0 @@
|
||||||
[
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "introduction",
|
|
||||||
"label": "Continuwuity"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "configuration",
|
|
||||||
"label": "Configuration"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "dir",
|
|
||||||
"name": "deploying",
|
|
||||||
"label": "Deploying"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "dir",
|
|
||||||
"name": "calls",
|
|
||||||
"label": "Calls"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "appservices",
|
|
||||||
"label": "Appservices"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "maintenance",
|
|
||||||
"label": "Maintenance"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "troubleshooting",
|
|
||||||
"label": "Troubleshooting"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "dir",
|
|
||||||
"name": "advanced",
|
|
||||||
"label": "Advanced"
|
|
||||||
},
|
|
||||||
"security",
|
|
||||||
{
|
|
||||||
"type": "dir-section-header",
|
|
||||||
"name": "community",
|
|
||||||
"label": "Community",
|
|
||||||
"collapsible": true,
|
|
||||||
"collapsed": false
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "divider"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "dir-section-header",
|
|
||||||
"name": "development",
|
|
||||||
"label": "Development",
|
|
||||||
"collapsible": true,
|
|
||||||
"collapsed": false
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "divider"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "section-header",
|
|
||||||
"label": "Reference"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"label": "Configuration Reference",
|
|
||||||
"name": "/reference/config"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"label": "Environment Variables",
|
|
||||||
"name": "/reference/environment-variables"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "dir",
|
|
||||||
"label": "Admin Command Reference",
|
|
||||||
"name": "/reference/admin/"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "divider"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
|
|
@ -1,42 +0,0 @@
|
||||||
[
|
|
||||||
{
|
|
||||||
"text": "Guide",
|
|
||||||
"link": "/introduction",
|
|
||||||
"activeMatch": "^/(introduction|configuration|deploying|calls|appservices|maintenance|troubleshooting|advanced)"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"text": "Development",
|
|
||||||
"link": "/development/index",
|
|
||||||
"activeMatch": "^/development/"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"text": "Reference",
|
|
||||||
"items": [
|
|
||||||
{
|
|
||||||
"text": "Configuration Reference",
|
|
||||||
"link": "/reference/config"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"text": "Admin Command Reference",
|
|
||||||
"link": "/reference/admin/"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"text": "Community",
|
|
||||||
"items": [
|
|
||||||
{
|
|
||||||
"text": "Community Guidelines",
|
|
||||||
"link": "/community/guidelines"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"text": "Become a Partnered Homeserver!",
|
|
||||||
"link": "/community/ops-guidelines"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"text": "Security",
|
|
||||||
"link": "/security"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
[
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "delegation",
|
|
||||||
"label": "Delegation / split-domain"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
|
|
@ -1,206 +0,0 @@
|
||||||
# Delegation/split-domain deployment
|
|
||||||
|
|
||||||
Matrix allows clients and servers to discover a homeserver's "true" destination via **`.well-known` delegation**. This is especially useful if you would like to:
|
|
||||||
|
|
||||||
- Serve Continuwuity on a subdomain while having only the base domain for your usernames
|
|
||||||
- Use a port other than `:8448` for server-to-server connections
|
|
||||||
|
|
||||||
This guide will show you how to have `@user:example.com` usernames while serving Continuwuity on `https://matrix.example.com`. It assumes you are using port 443 for both client-to-server connections and server-to-server federation.
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
First, ensure you have set up A/AAAA records for `matrix.example.com` and `example.com` pointing to your IP.
|
|
||||||
|
|
||||||
Then, ensure that the `server_name` field matches your intended username suffix. If this is not the case, you **MUST** wipe the database directory and reinstall Continuwuity with your desired `server_name`.
|
|
||||||
|
|
||||||
Then, in the `[global.well_known]` section of your config file, add the following fields:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[global.well_known]
|
|
||||||
|
|
||||||
client = "https://matrix.example.com"
|
|
||||||
|
|
||||||
# port number MUST be specified
|
|
||||||
server = "matrix.example.com:443"
|
|
||||||
|
|
||||||
# (optional) customize your support contacts
|
|
||||||
#support_page =
|
|
||||||
#support_role = "m.role.admin"
|
|
||||||
#support_email =
|
|
||||||
#support_mxid = "@user:example.com"
|
|
||||||
```
|
|
||||||
|
|
||||||
Alternatively if you are using Docker, you can set the `CONTINUWUITY_WELL_KNOWN` environment variable as below:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
services:
|
|
||||||
continuwuity:
|
|
||||||
...
|
|
||||||
environment:
|
|
||||||
CONTINUWUITY_WELL_KNOWN: |
|
|
||||||
{
|
|
||||||
client=https://matrix.example.com,
|
|
||||||
server=matrix.example.com:443
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Serving with a reverse proxy
|
|
||||||
|
|
||||||
After doing the steps above, Continuwuity will serve these 3 JSON files:
|
|
||||||
|
|
||||||
- `/.well-known/matrix/client`: for Client-Server discovery
|
|
||||||
- `/.well-known/matrix/server`: for Server-Server (federation) discovery
|
|
||||||
- `/.well-known/matrix/support`: admin contact details (strongly recommended to have)
|
|
||||||
|
|
||||||
To enable full discovery, you will need to reverse proxy these paths from the base domain back to Continuwuity.
|
|
||||||
|
|
||||||
<details>
|
|
||||||
|
|
||||||
<summary>For Caddy</summary>
|
|
||||||
|
|
||||||
```
|
|
||||||
matrix.example.com:443 {
|
|
||||||
reverse_proxy 127.0.0.1:8008
|
|
||||||
}
|
|
||||||
|
|
||||||
example.com:443 {
|
|
||||||
reverse_proxy /.well-known/matrix* 127.0.0.1:8008
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
|
|
||||||
<summary>For Traefik (via Docker labels)</summary>
|
|
||||||
|
|
||||||
```
|
|
||||||
services:
|
|
||||||
continuwuity:
|
|
||||||
...
|
|
||||||
labels:
|
|
||||||
- "traefik.enable=true"
|
|
||||||
- "traefik.http.routers.continuwuity.rule=(Host(`matrix.example.com`) || (Host(`example.com`) && PathPrefix(`/.well-known/matrix`)))"
|
|
||||||
- "traefik.http.routers.continuwuity.service=continuwuity"
|
|
||||||
- "traefik.http.services.continuwuity.loadbalancer.server.port=8008"
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
Restart Continuwuity and your reverse proxy. Once that's done, visit these routes and check that the responses match the examples below:
|
|
||||||
|
|
||||||
<details open>
|
|
||||||
|
|
||||||
<summary>`https://example.com/.well-known/matrix/server`</summary>
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"m.server": "matrix.example.com:443"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details open>
|
|
||||||
|
|
||||||
<summary>`https://example.com/.well-known/matrix/client`</summary>
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"m.homeserver": {
|
|
||||||
"base_url": "https://matrix.example.com/"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
## Troubleshooting
|
|
||||||
|
|
||||||
### Cannot log in with web clients
|
|
||||||
|
|
||||||
Make sure there is an `Access-Control-Allow-Origin: *` header in your `/.well-known/matrix/client` path. While Continuwuity serves this header by default, it may be dropped by reverse proxies or other middlewares.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Using SRV records (not recommended)
|
|
||||||
|
|
||||||
:::warning
|
|
||||||
The following methods are **not recommended** due to increased complexity with little benefits. If you have already set up `.well-known` delegation as above, you can safely skip this part.
|
|
||||||
:::
|
|
||||||
|
|
||||||
The following methods uses SRV DNS records and only work with federation traffic. They are only included for completeness.
|
|
||||||
|
|
||||||
<details>
|
|
||||||
|
|
||||||
<summary>Using only SRV records</summary>
|
|
||||||
|
|
||||||
If you can't set up `/.well-known/matrix/server` on :443 for some reason, you can set up a SRV record (via your DNS provider) as below:
|
|
||||||
|
|
||||||
- Service and name: `_matrix-fed._tcp.example.com.`
|
|
||||||
- Priority: `10` (can be any number)
|
|
||||||
- Weight: `10` (can be any number)
|
|
||||||
- Port: `443`
|
|
||||||
- Target: `matrix.example.com.`
|
|
||||||
|
|
||||||
On the target's IP at port 443, you must configure a valid route and cert for your server name, `example.com`. Therefore, this method only works to redirect traffic into the right IP/port combo, and can not delegate your federation to a different domain.
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
|
|
||||||
<summary>Using SRV records + .well-known</summary>
|
|
||||||
|
|
||||||
You can also set up `/.well-known/matrix/server` with a delegated domain but no ports:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[global.well_known]
|
|
||||||
server = "matrix.example.com"
|
|
||||||
```
|
|
||||||
|
|
||||||
Then, set up a SRV record (via your DNS provider) to announce the port number as below:
|
|
||||||
|
|
||||||
- Service and name: `_matrix-fed._tcp.matrix.example.com.`
|
|
||||||
- Priority: `10` (can be any number)
|
|
||||||
- Weight: `10` (can be any number)
|
|
||||||
- Port: `443`
|
|
||||||
- Target: `matrix.example.com.`
|
|
||||||
|
|
||||||
On the target's IP at port 443, you'll need to provide a valid route and cert for `matrix.example.com`. It provides the same feature as pure `.well-known` delegation, albeit with more parts to handle.
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
|
|
||||||
<summary>Using SRV records as a fallback for .well-known delegation</summary>
|
|
||||||
|
|
||||||
Assume your delegation is as below:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[global.well_known]
|
|
||||||
server = "example.com:443"
|
|
||||||
```
|
|
||||||
|
|
||||||
If your Continuwuity instance becomes temporarily unreachable, other servers will not be able to find your `/.well-known/matrix/server` file, and defaults to using `server_name:8448`. This incorrect cache can persist for a long time, and would hinder re-federation when your server eventually comes back online.
|
|
||||||
|
|
||||||
If you want other servers to default to using port :443 even when it is offline, you could set up a SRV record (via your DNS provider) as follows:
|
|
||||||
|
|
||||||
- Service and name: `_matrix-fed._tcp.example.com.`
|
|
||||||
- Priority: `10` (can be any number)
|
|
||||||
- Weight: `10` (can be any number)
|
|
||||||
- Port: `443`
|
|
||||||
- Target: `example.com.`
|
|
||||||
|
|
||||||
On the target's IP at port 443, you'll need to provide a valid route and cert for `example.com`.
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related Documentation
|
|
||||||
|
|
||||||
See the following Matrix Specs for full details on client/server resolution mechanisms:
|
|
||||||
|
|
||||||
- [Server-to-Server resolution](https://spec.matrix.org/v1.17/server-server-api/#resolving-server-names) (see this for more information on SRV records)
|
|
||||||
- [Client-to-Server resolution](https://spec.matrix.org/v1.17/client-server-api/#server-discovery)
|
|
||||||
- [MSC1929: Homeserver Admin Contact and Support page](https://github.com/matrix-org/matrix-spec-proposals/pull/1929)
|
|
||||||
|
|
@ -1,53 +0,0 @@
|
||||||
# Setting up Appservices
|
|
||||||
|
|
||||||
## Getting help
|
|
||||||
|
|
||||||
If you run into any problems while setting up an Appservice: ask us in
|
|
||||||
[#continuwuity:continuwuity.org](https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org) or
|
|
||||||
[open an issue on Forgejo](https://forgejo.ellis.link/continuwuation/continuwuity/issues/new).
|
|
||||||
|
|
||||||
## Set up the appservice - general instructions
|
|
||||||
|
|
||||||
Follow whatever instructions are given by the appservice. This usually includes
|
|
||||||
downloading, changing its config (setting domain, homeserver url, port etc.) and
|
|
||||||
later starting it.
|
|
||||||
|
|
||||||
At some point the appservice guide should ask you to add a registration yaml
|
|
||||||
file to the homeserver. In Synapse you would do this by adding the path to the
|
|
||||||
homeserver.yaml, but in Continuwuity you can do this from within Matrix:
|
|
||||||
|
|
||||||
First, go into the `#admins` room of your homeserver. The first person that
|
|
||||||
registered on the homeserver automatically joins it. Then send a message into
|
|
||||||
the room like this:
|
|
||||||
|
|
||||||
!admin appservices register
|
|
||||||
```
|
|
||||||
paste
|
|
||||||
the
|
|
||||||
contents
|
|
||||||
of
|
|
||||||
the
|
|
||||||
yaml
|
|
||||||
registration
|
|
||||||
here
|
|
||||||
```
|
|
||||||
|
|
||||||
You can confirm it worked by sending a message like this:
|
|
||||||
`!admin appservices list`
|
|
||||||
|
|
||||||
The server bot should answer with `Appservices (1): your-bridge`
|
|
||||||
|
|
||||||
Then you are done. Continuwuity will send messages to the appservices and the
|
|
||||||
appservice can send requests to the homeserver. You don't need to restart
|
|
||||||
Continuwuity, but if it doesn't work, restarting while the appservice is running
|
|
||||||
could help.
|
|
||||||
|
|
||||||
## Appservice-specific instructions
|
|
||||||
|
|
||||||
### Remove an appservice
|
|
||||||
|
|
||||||
To remove an appservice go to your admin room and execute
|
|
||||||
|
|
||||||
`!admin appservices unregister <name>`
|
|
||||||
|
|
||||||
where `<name>` one of the output of `appservices list`.
|
|
||||||
|
|
@ -1,13 +0,0 @@
|
||||||
# Calls
|
|
||||||
|
|
||||||
Matrix supports two types of calls:
|
|
||||||
|
|
||||||
- Element Call powered by [MatrixRTC](https://half-shot.github.io/msc-crafter/#msc/4143) and [LiveKit](https://github.com/livekit/livekit)
|
|
||||||
- Legacy calls, sometimes using Jitsi
|
|
||||||
|
|
||||||
Both types of calls are supported by different sets of clients, but most clients are moving towards MatrixRTC / Element Call.
|
|
||||||
|
|
||||||
For either one to work correctly, you have to do some additional setup.
|
|
||||||
|
|
||||||
- For legacy calls to work, you need to set up a TURN/STUN server. [Read the TURN guide for tips on how to set up coturn](./calls/turn.mdx)
|
|
||||||
- For MatrixRTC / Element Call to work, you have to set up the LiveKit backend (foci). LiveKit also uses TURN/STUN to increase reliability, so you might want to configure your TURN server first. [Read the LiveKit guide](./calls/livekit.mdx)
|
|
||||||
|
|
@ -1,12 +0,0 @@
|
||||||
[
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "turn",
|
|
||||||
"label": "TURN"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "livekit",
|
|
||||||
"label": "MatrixRTC / LiveKit"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
|
|
@ -1,240 +0,0 @@
|
||||||
# Matrix RTC/Element Call Setup
|
|
||||||
|
|
||||||
:::info
|
|
||||||
This guide assumes that you are using docker compose for deployment. LiveKit only provides Docker images.
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Instructions
|
|
||||||
|
|
||||||
### 1. Domain
|
|
||||||
|
|
||||||
LiveKit should live on its own domain or subdomain. In this guide we use `livekit.example.com` - this should be replaced with a domain you control.
|
|
||||||
|
|
||||||
Make sure the DNS record for the (sub)domain you plan to use is pointed to your server.
|
|
||||||
|
|
||||||
### 2. Services
|
|
||||||
|
|
||||||
Using LiveKit with Matrix requires two services - Livekit itself, and a service (`lk-jwt-service`) that grants Matrix users permission to connect to it.
|
|
||||||
|
|
||||||
You must generate a key and secret to allow the Matrix service to authenticate with LiveKit. `LK_MATRIX_KEY` should be around 20 random characters, and `LK_MATRIX_SECRET` should be around 64. Remember to replace these with the actual values!
|
|
||||||
|
|
||||||
:::tip Generating the secrets
|
|
||||||
LiveKit provides a utility to generate secure random keys
|
|
||||||
```bash
|
|
||||||
docker run --rm livekit/livekit-server:latest generate-keys
|
|
||||||
```
|
|
||||||
:::
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
services:
|
|
||||||
lk-jwt-service:
|
|
||||||
image: ghcr.io/element-hq/lk-jwt-service:latest
|
|
||||||
container_name: lk-jwt-service
|
|
||||||
environment:
|
|
||||||
- LIVEKIT_JWT_BIND=:8081
|
|
||||||
- LIVEKIT_URL=wss://livekit.example.com
|
|
||||||
- LIVEKIT_KEY=LK_MATRIX_KEY
|
|
||||||
- LIVEKIT_SECRET=LK_MATRIX_SECRET
|
|
||||||
- LIVEKIT_FULL_ACCESS_HOMESERVERS=example.com
|
|
||||||
restart: unless-stopped
|
|
||||||
ports:
|
|
||||||
- "8081:8081"
|
|
||||||
|
|
||||||
livekit:
|
|
||||||
image: livekit/livekit-server:latest
|
|
||||||
container_name: livekit
|
|
||||||
command: --config /etc/livekit.yaml
|
|
||||||
restart: unless-stopped
|
|
||||||
volumes:
|
|
||||||
- ./livekit.yaml:/etc/livekit.yaml:ro
|
|
||||||
network_mode: "host" # /!\ LiveKit binds to all addresses by default.
|
|
||||||
# Make sure port 7880 is blocked by your firewall to prevent access bypassing your reverse proxy
|
|
||||||
# Alternatively, uncomment the lines below and comment `network_mode: "host"` above to specify port mappings.
|
|
||||||
# ports:
|
|
||||||
# - "127.0.0.1:7880:7880/tcp"
|
|
||||||
# - "7881:7881/tcp"
|
|
||||||
# - "50100-50200:50100-50200/udp"
|
|
||||||
```
|
|
||||||
|
|
||||||
Next, we need to configure LiveKit. In the same directory, create `livekit.yaml` with the following content - remembering to replace `LK_MATRIX_KEY` and `LK_MATRIX_SECRET` with the values you generated:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
port: 7880
|
|
||||||
bind_addresses:
|
|
||||||
- ""
|
|
||||||
rtc:
|
|
||||||
tcp_port: 7881
|
|
||||||
port_range_start: 50100
|
|
||||||
port_range_end: 50200
|
|
||||||
use_external_ip: true
|
|
||||||
enable_loopback_candidate: false
|
|
||||||
keys:
|
|
||||||
LK_MATRIX_KEY: LK_MATRIX_SECRET
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Firewall hints
|
|
||||||
|
|
||||||
You will need to allow ports `7881/tcp` and `50100:50200/udp` through your firewall. If you use UFW, the commands are: `ufw allow 7881/tcp` and `ufw allow 50100:50200/udp`.
|
|
||||||
|
|
||||||
### 3. Telling clients where to find LiveKit
|
|
||||||
|
|
||||||
To tell clients where to find LiveKit, you need to add the address of your `lk-jwt-service` to the `[global.matrix_rtc]` config section using the `foci` option.
|
|
||||||
|
|
||||||
The variable should be a list of servers serving as MatrixRTC endpoints. Clients discover these via the `/_matrix/client/v1/rtc/transports` endpoint (MSC4143).
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[global.matrix_rtc]
|
|
||||||
foci = [
|
|
||||||
{ type = "livekit", livekit_service_url = "https://livekit.example.com" },
|
|
||||||
]
|
|
||||||
```
|
|
||||||
|
|
||||||
Remember to replace the URL with the address you are deploying your instance of lk-jwt-service to.
|
|
||||||
|
|
||||||
### 4. Configure your Reverse Proxy
|
|
||||||
|
|
||||||
Reverse proxies can be configured in many different ways - so we can't provide a step by step for this.
|
|
||||||
|
|
||||||
By default, all routes should be forwarded to Livekit with the exception of the following path prefixes, which should be forwarded to the JWT/Authentication service:
|
|
||||||
|
|
||||||
- `/sfu/get`
|
|
||||||
- `/healthz`
|
|
||||||
- `/get_token`
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Example caddy config</summary>
|
|
||||||
```
|
|
||||||
matrix-rtc.example.com {
|
|
||||||
|
|
||||||
# for lk-jwt-service
|
|
||||||
@lk-jwt-service path /sfu/get* /healthz* /get_token*
|
|
||||||
route @lk-jwt-service {
|
|
||||||
reverse_proxy 127.0.0.1:8081
|
|
||||||
}
|
|
||||||
|
|
||||||
# for livekit
|
|
||||||
reverse_proxy 127.0.0.1:7880
|
|
||||||
}
|
|
||||||
```
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Example nginx config</summary>
|
|
||||||
```
|
|
||||||
server {
|
|
||||||
server_name matrix-rtc.example.com;
|
|
||||||
|
|
||||||
# for lk-jwt-service
|
|
||||||
location ~ ^/(sfu/get|healthz|get_token) {
|
|
||||||
proxy_pass http://127.0.0.1:8081$request_uri;
|
|
||||||
proxy_set_header X-Forwarded-For $remote_addr;
|
|
||||||
proxy_set_header X-Real-IP $remote_addr;
|
|
||||||
proxy_set_header Host $http_host;
|
|
||||||
proxy_buffering off;
|
|
||||||
}
|
|
||||||
|
|
||||||
# for livekit
|
|
||||||
location / {
|
|
||||||
proxy_pass http://127.0.0.1:7880$request_uri;
|
|
||||||
proxy_set_header X-Forwarded-For $remote_addr;
|
|
||||||
proxy_set_header X-Real-IP $remote_addr;
|
|
||||||
proxy_set_header Host $http_host;
|
|
||||||
proxy_buffering off;
|
|
||||||
|
|
||||||
# websocket
|
|
||||||
proxy_http_version 1.1;
|
|
||||||
proxy_set_header Upgrade $http_upgrade;
|
|
||||||
proxy_set_header Connection $connection_upgrade;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Note that for websockets to work, you need to have this somewhere outside your server block:
|
|
||||||
```
|
|
||||||
map $http_upgrade $connection_upgrade {
|
|
||||||
default upgrade;
|
|
||||||
'' close;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Example traefik router</summary>
|
|
||||||
```
|
|
||||||
# on LiveKit itself
|
|
||||||
traefik.http.routers.livekit.rule=Host(`livekit.example.com`)
|
|
||||||
# on the JWT service
|
|
||||||
traefik.http.routers.livekit-jwt.rule=Host(`livekit.example.com`) && (PathPrefix(`/sfu/get`) || PathPrefix(`/healthz`) || PathPrefix(`/get_token`))
|
|
||||||
```
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
### 6. Start Everything
|
|
||||||
|
|
||||||
Start up the services using your usual method - for example `docker compose up -d`.
|
|
||||||
|
|
||||||
## Additional Configuration
|
|
||||||
|
|
||||||
### TURN Integration
|
|
||||||
|
|
||||||
If you've already set up coturn, there may be a port clash between the two services. To fix this, make sure the `min-port` and `max-port` for coturn so it doesn't overlap with LiveKit's range:
|
|
||||||
|
|
||||||
```ini
|
|
||||||
min-port=50201
|
|
||||||
max-port=65535
|
|
||||||
```
|
|
||||||
|
|
||||||
To improve LiveKit's reliability, you can configure it to use your coturn server.
|
|
||||||
|
|
||||||
Generate a long random secret for LiveKit, and add it to your coturn config under the `static-auth-secret` option. You can add as many secrets as you want - so set a different one for each thing using your TURN server.
|
|
||||||
|
|
||||||
Then configure livekit, making sure to replace `COTURN_SECRET`:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# livekit.yaml
|
|
||||||
rtc:
|
|
||||||
turn_servers:
|
|
||||||
- host: coturn.ellis.link
|
|
||||||
port: 3478
|
|
||||||
protocol: tcp
|
|
||||||
secret: "COTURN_SECRET"
|
|
||||||
- host: coturn.ellis.link
|
|
||||||
port: 5349
|
|
||||||
protocol: tls # Only if you've set up TLS in your coturn
|
|
||||||
secret: "COTURN_SECRET"
|
|
||||||
- host: coturn.ellis.link
|
|
||||||
port: 3478
|
|
||||||
protocol: udp
|
|
||||||
secret: "COTURN_SECRET"
|
|
||||||
```
|
|
||||||
|
|
||||||
## LiveKit's built in TURN server
|
|
||||||
|
|
||||||
Livekit includes a built in TURN server which can be used in place of an external option. This TURN server will only work with Livekit, so you can't use it for legacy Matrix calling - or anything else.
|
|
||||||
|
|
||||||
If you don't want to set up a separate TURN server, you can enable this with the following changes:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
### add this to livekit.yaml ###
|
|
||||||
turn:
|
|
||||||
enabled: true
|
|
||||||
udp_port: 3478
|
|
||||||
relay_range_start: 50300
|
|
||||||
relay_range_end: 50400
|
|
||||||
domain: matrix-rtc.example.com
|
|
||||||
```
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
### Add these to docker-compose ###
|
|
||||||
- "3478:3478/udp"
|
|
||||||
- "50300-50400:50300-50400/udp"
|
|
||||||
```
|
|
||||||
|
|
||||||
### Related Documentation
|
|
||||||
|
|
||||||
- [LiveKit GitHub](https://github.com/livekit/livekit)
|
|
||||||
- [LiveKit Connection Tester](https://livekit.io/connection-test) - use with the token returned by `/sfu/get` or `/get_token`
|
|
||||||
- [MatrixRTC proposal](https://half-shot.github.io/msc-crafter/#msc/4143)
|
|
||||||
- [Synapse documentation](https://github.com/element-hq/element-call/blob/livekit/docs/self-hosting.md)
|
|
||||||
- [Community guide](https://tomfos.tr/matrix/livekit/)
|
|
||||||
- [Community guide](https://blog.kimiblock.top/2024/12/24/hosting-element-call/)
|
|
||||||
|
|
@ -1,214 +0,0 @@
|
||||||
# Setting up TURN/STUN
|
|
||||||
|
|
||||||
[TURN](https://en.wikipedia.org/wiki/Traversal_Using_Relays_around_NAT) and [STUN](https://en.wikipedia.org/wiki/STUN) are used as a component in many calling systems. Matrix uses them directly for legacy calls and indirectly for MatrixRTC via Livekit.
|
|
||||||
|
|
||||||
Continuwuity recommends using [Coturn](https://github.com/coturn/coturn) as your TURN/STUN server, which is available as a Docker image or a distro package.
|
|
||||||
|
|
||||||
## Installing Coturn
|
|
||||||
|
|
||||||
### Configuration
|
|
||||||
|
|
||||||
Create a configuration file called `coturn.conf` containing:
|
|
||||||
|
|
||||||
```ini
|
|
||||||
use-auth-secret
|
|
||||||
static-auth-secret=<a secret key>
|
|
||||||
realm=<your server domain>
|
|
||||||
```
|
|
||||||
|
|
||||||
:::tip Generating a secure secret
|
|
||||||
A common way to generate a suitable alphanumeric secret key is by using:
|
|
||||||
```bash
|
|
||||||
pwgen -s 64 1
|
|
||||||
```
|
|
||||||
:::
|
|
||||||
|
|
||||||
#### Port Configuration
|
|
||||||
|
|
||||||
By default, coturn uses the following ports:
|
|
||||||
- `3478` (UDP/TCP): Standard TURN/STUN port
|
|
||||||
- `5349` (UDP/TCP): TURN/STUN over TLS
|
|
||||||
- `49152-65535` (UDP): Media relay ports
|
|
||||||
|
|
||||||
If you're also running LiveKit, you'll need to avoid port conflicts. Configure non-overlapping port ranges:
|
|
||||||
|
|
||||||
```ini
|
|
||||||
# In coturn.conf
|
|
||||||
min-port=50201
|
|
||||||
max-port=65535
|
|
||||||
```
|
|
||||||
|
|
||||||
This leaves ports `50100-50200` available for LiveKit's default configuration.
|
|
||||||
|
|
||||||
### Running with Docker
|
|
||||||
|
|
||||||
Run the [Coturn](https://hub.docker.com/r/coturn/coturn) image using:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker run -d --network=host \
|
|
||||||
-v $(pwd)/coturn.conf:/etc/coturn/turnserver.conf \
|
|
||||||
coturn/coturn
|
|
||||||
```
|
|
||||||
|
|
||||||
### Running with Docker Compose
|
|
||||||
|
|
||||||
Create a `docker-compose.yml` file and run `docker compose up -d`:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
version: '3'
|
|
||||||
services:
|
|
||||||
turn:
|
|
||||||
container_name: coturn-server
|
|
||||||
image: docker.io/coturn/coturn
|
|
||||||
restart: unless-stopped
|
|
||||||
network_mode: "host"
|
|
||||||
volumes:
|
|
||||||
- ./coturn.conf:/etc/coturn/turnserver.conf
|
|
||||||
```
|
|
||||||
|
|
||||||
:::info Why host networking?
|
|
||||||
Coturn uses host networking mode because it needs to bind to multiple ports and work with various network protocols. Using host networking is better for performance, and reduces configuration complexity. To understand alternative configuration options, visit [Coturn's Docker documentation](https://github.com/coturn/coturn/blob/master/docker/coturn/README.md).
|
|
||||||
:::
|
|
||||||
|
|
||||||
### Security Recommendations
|
|
||||||
|
|
||||||
For security best practices, see Synapse's [Coturn documentation](https://element-hq.github.io/synapse/latest/turn-howto.html), which includes important firewall and access control recommendations.
|
|
||||||
|
|
||||||
## Configuring Continuwuity
|
|
||||||
|
|
||||||
Once your TURN server is running, configure Continuwuity to provide credentials to clients. Add the following to your Continuwuity configuration file:
|
|
||||||
|
|
||||||
### Shared Secret Authentication (Recommended)
|
|
||||||
|
|
||||||
This is the most secure method and generates time-limited credentials automatically:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
# TURN URIs that clients should connect to
|
|
||||||
turn_uris = [
|
|
||||||
"turn:coturn.example.com?transport=udp",
|
|
||||||
"turn:coturn.example.com?transport=tcp",
|
|
||||||
"turns:coturn.example.com?transport=udp",
|
|
||||||
"turns:coturn.example.com?transport=tcp"
|
|
||||||
]
|
|
||||||
|
|
||||||
# Shared secret for generating credentials (must match coturn's static-auth-secret)
|
|
||||||
turn_secret = "<your coturn static-auth-secret>"
|
|
||||||
|
|
||||||
# Optional: Read secret from a file instead (takes priority over turn_secret)
|
|
||||||
# turn_secret_file = "/etc/continuwuity/.turn_secret"
|
|
||||||
|
|
||||||
# TTL for generated credentials in seconds (default: 86400 = 24 hours)
|
|
||||||
turn_ttl = 86400
|
|
||||||
```
|
|
||||||
|
|
||||||
:::tip Using TLS
|
|
||||||
The `turns:` URI prefix instructs clients to connect to TURN over TLS, which is highly recommended for security. Make sure you've configured TLS in your coturn server first.
|
|
||||||
:::
|
|
||||||
|
|
||||||
### Static Credentials (Alternative)
|
|
||||||
|
|
||||||
If you prefer static username/password credentials instead of shared secrets:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
turn_uris = [
|
|
||||||
"turn:coturn.example.com?transport=udp",
|
|
||||||
"turn:coturn.example.com?transport=tcp"
|
|
||||||
]
|
|
||||||
|
|
||||||
turn_username = "your_username"
|
|
||||||
turn_password = "your_password"
|
|
||||||
```
|
|
||||||
|
|
||||||
:::warning
|
|
||||||
Static credentials are less secure than shared secrets because they don't expire and must be configured in coturn separately. It is strongly advised you use shared secret authentication.
|
|
||||||
:::
|
|
||||||
|
|
||||||
### Guest Access
|
|
||||||
|
|
||||||
By default, TURN credentials require client authentication. To allow unauthenticated access:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
turn_allow_guests = true
|
|
||||||
```
|
|
||||||
|
|
||||||
:::caution
|
|
||||||
This is not recommended as it allows unauthenticated users to access your TURN server, potentially enabling abuse by bots. All major Matrix clients that support legacy calls *also* support authenticated TURN access.
|
|
||||||
:::
|
|
||||||
|
|
||||||
### Important Notes
|
|
||||||
|
|
||||||
- Replace `coturn.example.com` with your actual TURN server domain (the `realm` from coturn.conf)
|
|
||||||
- The `turn_secret` must match the `static-auth-secret` in your coturn configuration
|
|
||||||
- Restart or reload Continuwuity after making configuration changes
|
|
||||||
|
|
||||||
## Testing Your TURN Server
|
|
||||||
|
|
||||||
### Testing Credentials
|
|
||||||
|
|
||||||
Verify that Continuwuity is correctly serving TURN credentials to clients:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl "https://matrix.example.com/_matrix/client/r0/voip/turnServer" \
|
|
||||||
-H "Authorization: Bearer <your_client_token>" | jq
|
|
||||||
```
|
|
||||||
|
|
||||||
You should receive a response like this:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"username": "1752792167:@jade:example.com",
|
|
||||||
"password": "KjlDlawdPbU9mvP4bhdV/2c/h65=",
|
|
||||||
"uris": [
|
|
||||||
"turns:coturn.example.com?transport=udp",
|
|
||||||
"turns:coturn.example.com?transport=tcp",
|
|
||||||
"turn:coturn.example.com?transport=udp",
|
|
||||||
"turn:coturn.example.com?transport=tcp"
|
|
||||||
],
|
|
||||||
"ttl": 86400
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
:::note MSC4166 Compliance
|
|
||||||
If no TURN URIs are configured (`turn_uris` is empty), Continuwuity will return a 404 Not Found response, as specified in MSC4166.
|
|
||||||
:::
|
|
||||||
|
|
||||||
### Testing Connectivity
|
|
||||||
|
|
||||||
Use [Trickle ICE](https://webrtc.github.io/samples/src/content/peerconnection/trickle-ice/) to verify that the TURN credentials actually work:
|
|
||||||
|
|
||||||
1. Copy the credentials from the response above
|
|
||||||
2. Paste them into the Trickle ICE testing tool
|
|
||||||
3. Click "Gather candidates"
|
|
||||||
4. Look for successful `relay` candidates in the results
|
|
||||||
|
|
||||||
If you see relay candidates, your TURN server is working correctly!
|
|
||||||
|
|
||||||
## Troubleshooting
|
|
||||||
|
|
||||||
### Clients can't connect to TURN server
|
|
||||||
|
|
||||||
- Verify firewall rules allow the necessary ports (3478, 5349, and your media port range)
|
|
||||||
- Check that DNS resolves correctly for your TURN domain
|
|
||||||
- Ensure your `turn_secret` matches coturn's `static-auth-secret`
|
|
||||||
- Test with Trickle ICE to isolate the issue
|
|
||||||
|
|
||||||
### Port conflicts with LiveKit
|
|
||||||
|
|
||||||
- Make sure coturn's `min-port` starts above LiveKit's `port_range_end` (default: 50200)
|
|
||||||
- Or adjust LiveKit's port range to avoid coturn's default range
|
|
||||||
|
|
||||||
### 404 when calling turnServer endpoint
|
|
||||||
|
|
||||||
- Verify that `turn_uris` is not empty in your Continuwuity config
|
|
||||||
- This behavior is correct per MSC4166 if no TURN URIs are configured
|
|
||||||
|
|
||||||
### Credentials expire too quickly
|
|
||||||
|
|
||||||
- Adjust the `turn_ttl` value in your Continuwuity configuration
|
|
||||||
- Default is 86400 seconds (24 hours)
|
|
||||||
|
|
||||||
### Related Documentation
|
|
||||||
|
|
||||||
- [MatrixRTC/LiveKit Setup](./livekit.mdx) - Configure group calling with LiveKit
|
|
||||||
- [Coturn GitHub](https://github.com/coturn/coturn) - Official coturn repository
|
|
||||||
- [Synapse TURN Guide](https://element-hq.github.io/synapse/latest/turn-howto.html) - Additional security recommendations
|
|
||||||
|
|
@ -1,12 +0,0 @@
|
||||||
[
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "guidelines",
|
|
||||||
"label": "Community Guidelines"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "ops-guidelines",
|
|
||||||
"label": "Partnered Homeserver Guidelines"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
|
|
@ -1,139 +0,0 @@
|
||||||
# Continuwuity Community Guidelines
|
|
||||||
|
|
||||||
Welcome to the Continuwuity commuwunity! We're excited to have you here. Continuwuity is a
|
|
||||||
continuation of the conduwuit homeserver, which in turn 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 welcoming environment for everyone.
|
|
||||||
These guidelines apply to all Continuwuity spaces, including our Matrix rooms and any other
|
|
||||||
community channels that reference them. We've written these guidelines to help us all create an
|
|
||||||
environment where everyone feels safe and respected.
|
|
||||||
|
|
||||||
For code and contribution guidelines, please refer to the
|
|
||||||
[Contributor's Covenant](https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CODE_OF_CONDUCT.md).
|
|
||||||
Below are additional guidelines specific to the Continuwuity community.
|
|
||||||
|
|
||||||
## Our Values and Expected Behaviors
|
|
||||||
|
|
||||||
We strive to create a community based on mutual respect, collaboration, and inclusivity. We expect
|
|
||||||
all members to:
|
|
||||||
|
|
||||||
1. **Be Respectful and Inclusive**: Treat everyone with respect. We're committed to a community
|
|
||||||
where everyone feels safe, regardless of background, identity, or experience. Discrimination,
|
|
||||||
harassment, or hate speech won't be tolerated. Remember that each person experiences the world
|
|
||||||
differently; share your own perspective and be open to learning about others'.
|
|
||||||
|
|
||||||
2. **Be Positive and Constructive**: Engage in discussions constructively and support each other.
|
|
||||||
If you feel angry or frustrated, take a break before participating. Approach disagreements with
|
|
||||||
the goal of understanding, not winning. Focus on the issue, not the person.
|
|
||||||
|
|
||||||
3. **Communicate Clearly and Kindly**: Our community includes neurodivergent individuals and those
|
|
||||||
who may not appreciate sarcasm or subtlety. Communicate clearly and kindly. Avoid ambiguity and
|
|
||||||
ensure your messages can be easily understood by all. Avoid placing the burden of education on
|
|
||||||
marginalized groups; please make an effort to look into your questions before asking others for
|
|
||||||
detailed explanations.
|
|
||||||
|
|
||||||
4. **Be Open to Improving Inclusivity**: Actively participate in making our community more inclusive.
|
|
||||||
Report behaviour that contradicts these guidelines (see Reporting and Enforcement below) and be
|
|
||||||
open to constructive feedback aimed at improving our community. Understand that discussing
|
|
||||||
negative experiences can be emotionally taxing; focus on the message, not the tone.
|
|
||||||
|
|
||||||
5. **Commit to Our Values**: Building an inclusive community requires ongoing effort from everyone.
|
|
||||||
Recognise that addressing bias and discrimination is a continuous process that needs commitment
|
|
||||||
and action from all members.
|
|
||||||
|
|
||||||
## Unacceptable Behaviors
|
|
||||||
|
|
||||||
To ensure everyone feels safe and welcome, the following behaviors are considered unacceptable
|
|
||||||
within the Continuwuity community:
|
|
||||||
|
|
||||||
* **Harassment and Discrimination**: Avoid offensive comments related to background, family status,
|
|
||||||
gender, gender identity or expression, marital status, sex, sexual orientation, native language,
|
|
||||||
age, ability, race and/or ethnicity, caste, national origin, socioeconomic status, religion,
|
|
||||||
geographic location, or any other dimension of diversity. Don't deliberately misgender someone or
|
|
||||||
question the legitimacy of their gender identity.
|
|
||||||
|
|
||||||
* **Violence and Threats**: Do not engage in any form of violence or threats, including inciting
|
|
||||||
violence towards anyone or encouraging self-harm. Posting or threatening to post someone else's
|
|
||||||
personally identifying information ("doxxing") is also forbidden.
|
|
||||||
|
|
||||||
* **Personal Attacks**: Disagreements happen, but they should never turn into personal attacks.
|
|
||||||
Don't insult, demean, or belittle others.
|
|
||||||
|
|
||||||
* **Unwelcome Attention or Contact**: Avoid unwelcome sexual attention, inappropriate physical
|
|
||||||
contact (or simulation thereof), sexualized comments, jokes, or imagery.
|
|
||||||
|
|
||||||
* **Disruption**: Do not engage in sustained disruption of discussions, events, or other
|
|
||||||
community activities.
|
|
||||||
|
|
||||||
* **Bad Faith Actions**: Do not intentionally make false reports or otherwise abuse the reporting
|
|
||||||
process.
|
|
||||||
|
|
||||||
This is not an exhaustive list. Any behaviour that makes others feel unsafe or unwelcome may be
|
|
||||||
subject to enforcement action.
|
|
||||||
|
|
||||||
## Matrix Community
|
|
||||||
|
|
||||||
These Community Guidelines apply to the entire
|
|
||||||
[Continuwuity Matrix Space](https://matrix.to/#/#space:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org) and its rooms, including:
|
|
||||||
|
|
||||||
### [#continuwuity:continuwuity.org](https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org)
|
|
||||||
|
|
||||||
This room is for support and discussions about Continuwuity. Ask questions, share insights, and help
|
|
||||||
each other out while adhering to these guidelines.
|
|
||||||
|
|
||||||
We ask that this room remain focused on the Continuwuity software specifically: the team are
|
|
||||||
typically happy to engage in conversations about related subjects in the off-topic room.
|
|
||||||
|
|
||||||
### [#offtopic:continuwuity.org](https://matrix.to/#/#offtopic:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org)
|
|
||||||
|
|
||||||
For off-topic community conversations about any subject. While this room allows for a wide range of
|
|
||||||
topics, the same guidelines apply. Please keep discussions respectful and inclusive, and avoid
|
|
||||||
divisive or stressful subjects like specific country/world politics unless handled with exceptional
|
|
||||||
care and respect for diverse viewpoints.
|
|
||||||
|
|
||||||
General topics, such as world events, are welcome as long as they follow the guidelines. If a member
|
|
||||||
of the team asks for the conversation to end, please respect their decision.
|
|
||||||
|
|
||||||
### [#dev:continuwuity.org](https://matrix.to/#/#dev:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org)
|
|
||||||
|
|
||||||
This room is dedicated to discussing active development of Continuwuity, including ongoing issues or
|
|
||||||
code development. Collaboration here must follow these guidelines, and please consider raising
|
|
||||||
[an issue](https://forgejo.ellis.link/continuwuation/continuwuity/issues) on the repository to help
|
|
||||||
track progress.
|
|
||||||
|
|
||||||
## Reporting and Enforcement
|
|
||||||
|
|
||||||
We take these Community Guidelines seriously to protect our community members. If you witness or
|
|
||||||
experience unacceptable behaviour, or have any other concerns, please report it.
|
|
||||||
|
|
||||||
**How to Report:**
|
|
||||||
|
|
||||||
* **Alert Moderators in the Room:** If you feel comfortable doing so, you can address the issue
|
|
||||||
publicly in the relevant room by mentioning the moderation bot, `@rock:continuwuity.org`, which
|
|
||||||
will immediately alert all available moderators.
|
|
||||||
* **Direct Message:** If you're not comfortable raising the issue publicly, please send a direct
|
|
||||||
message (DM) to one of the room moderators.
|
|
||||||
|
|
||||||
Reports will be handled with discretion. We will investigate promptly and thoroughly.
|
|
||||||
|
|
||||||
**Enforcement Actions:**
|
|
||||||
|
|
||||||
Anyone asked to stop unacceptable behaviour is expected to comply immediately. Failure to do so, or
|
|
||||||
engaging in prohibited behaviour, may result in enforcement action. Moderators may take actions they
|
|
||||||
deem appropriate, including but not limited to:
|
|
||||||
|
|
||||||
1. **Warning**: A direct message or public warning identifying the violation and requesting
|
|
||||||
corrective action.
|
|
||||||
2. **Temporary Mute**: Temporary restriction from participating in discussions for a specified
|
|
||||||
period.
|
|
||||||
3. **Kick or Ban**: Removal from a room (kick) or the entire community space (ban). Egregious or
|
|
||||||
repeated violations may result in an immediate ban. Bans are typically permanent and reviewed
|
|
||||||
only in exceptional circumstances.
|
|
||||||
|
|
||||||
Retaliation against those who report concerns in good faith will not be tolerated and will be
|
|
||||||
subject to the same enforcement actions.
|
|
||||||
|
|
||||||
Together, let's build and maintain a community where everyone feels valued, safe, and respected.
|
|
||||||
|
|
||||||
— The Continuwuity Moderation Team
|
|
||||||
|
|
@ -1,32 +0,0 @@
|
||||||
# Partnered Homeserver Operator Requirements
|
|
||||||
> _So you want to be an officially sanctioned public Continuwuity homeserver operator?_
|
|
||||||
|
|
||||||
Thank you for your interest in the project! There's a few things we need from you first to make sure your homeserver meets our quality standards and that you are prepared to handle the additional workload introduced by operating a public chat service.
|
|
||||||
|
|
||||||
## Stuff you must have
|
|
||||||
if you don't do these things we will tell you to go away
|
|
||||||
|
|
||||||
- Your homeserver must be running an up-to-date version of Continuwuity
|
|
||||||
- You must have a CAPTCHA, external registration system, or apply-to-join system that provides one-time-use invite codes (we do not accept fully open nor static token registration)
|
|
||||||
- Your homeserver must have support details listed in [`/.well-known/matrix/support`](https://spec.matrix.org/v1.17/client-server-api/#getwell-knownmatrixsupport)
|
|
||||||
- Your rules and guidelines must align with [the project's own code of conduct](guidelines).
|
|
||||||
- You must be reasonably responsive (i.e. don't leave us hanging for a week if we alert you to an issue on your server)
|
|
||||||
- Your homeserver's community rooms (if any) must be protected by a moderation bot subscribed to policy lists like the Community Moderation Effort (you can get one from https://asgard.chat if you don't want to run your own)
|
|
||||||
|
|
||||||
## Stuff we encourage you to have
|
|
||||||
not strictly required but we will consider your request more strongly if you have it
|
|
||||||
|
|
||||||
- You should have automated moderation tooling that can automatically suspend abusive users on your homeserver who are added to policy lists
|
|
||||||
- You should have multiple server administrators (increased bus factor)
|
|
||||||
- You should have a terms of service and privacy policy prominently available
|
|
||||||
|
|
||||||
## Stuff you get
|
|
||||||
|
|
||||||
- Prominent listing in our README!
|
|
||||||
- A gold star sticker
|
|
||||||
- Access to a low noise room for more direct communication with maintainers and collaboration with fellow operators
|
|
||||||
- Read-only access to the continuwuity internal ban list
|
|
||||||
- Early notice of upcoming releases
|
|
||||||
|
|
||||||
## Sound good?
|
|
||||||
To get started, ping a team member in [our main chatroom](https://matrix.to/#/#continuwuity:continuwuity.org) and ask to be added to the list.
|
|
||||||
|
|
@ -1,67 +0,0 @@
|
||||||
# Configuration
|
|
||||||
|
|
||||||
This chapter describes various ways to configure Continuwuity.
|
|
||||||
|
|
||||||
## Basics
|
|
||||||
|
|
||||||
Continuwuity 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](./reference/config.mdx) for all of those
|
|
||||||
settings.
|
|
||||||
|
|
||||||
The config file to use can be specified on the commandline when running
|
|
||||||
Continuwuity by specifying the `-c`, `--config` flag. Alternatively, you can use
|
|
||||||
the environment variable `CONTINUWUITY_CONFIG` to specify the config file to be
|
|
||||||
used; see [the section on environment variables](#environment-variables) for
|
|
||||||
more information.
|
|
||||||
|
|
||||||
## Option commandline flag
|
|
||||||
|
|
||||||
Continuwuity supports setting individual config options in TOML format from the
|
|
||||||
`-O` / `--option` flag. For example, you can set your server name via `-O
|
|
||||||
server_name=\"example.com\"`.
|
|
||||||
|
|
||||||
Note that the config is parsed as TOML, and shells like bash will remove quotes.
|
|
||||||
So unfortunately it is required to escape quotes if the config option takes a
|
|
||||||
string. This does not apply to options that take booleans or numbers:
|
|
||||||
- `--option allow_registration=true` works ✅
|
|
||||||
- `-O max_request_size=99999999` works ✅
|
|
||||||
- `-O server_name=example.com` does not work ❌
|
|
||||||
- `--option log=\"debug\"` works ✅
|
|
||||||
- `--option server_name='"example.com'"` works ✅
|
|
||||||
|
|
||||||
## Execute commandline flag
|
|
||||||
|
|
||||||
Continuwuity supports running admin commands on startup using the commandline
|
|
||||||
argument `--execute`. The most notable use for this is to create an admin user
|
|
||||||
on first startup.
|
|
||||||
|
|
||||||
The syntax of this is a standard admin command without the prefix such as
|
|
||||||
`./conduwuit --execute "users create_user june"`
|
|
||||||
|
|
||||||
An example output of a success is:
|
|
||||||
```
|
|
||||||
INFO conduwuit_service::admin::startup: Startup command #0 completed:
|
|
||||||
Created user with user_id: @june:girlboss.ceo and password: `<redacted>`
|
|
||||||
```
|
|
||||||
|
|
||||||
This commandline argument can be paired with the `--option` flag.
|
|
||||||
|
|
||||||
## Environment variables
|
|
||||||
|
|
||||||
All of the settings that are found in the config file can be specified by using
|
|
||||||
environment variables. The environment variable names should be all caps and
|
|
||||||
prefixed with `CONTINUWUITY_`.
|
|
||||||
|
|
||||||
For example, if the setting you are changing is `max_request_size`, then the
|
|
||||||
environment variable to set is `CONTINUWUITY_MAX_REQUEST_SIZE`.
|
|
||||||
|
|
||||||
To modify config options not in the `[global]` context such as
|
|
||||||
`[global.well_known]`, use the `__` suffix split:
|
|
||||||
`CONTINUWUITY_WELL_KNOWN__SERVER`
|
|
||||||
|
|
||||||
Conduit and conduwuit's environment variables are also supported for backwards
|
|
||||||
compatibility, via the `CONDUIT_` and `CONDUWUIT_` prefixes respectively (e.g.
|
|
||||||
`CONDUIT_SERVER_NAME`).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../CONTRIBUTING.md
|
|
||||||
|
|
@ -1,3 +0,0 @@
|
||||||
# Deploying
|
|
||||||
|
|
||||||
This chapter describes various ways to deploy Continuwuity.
|
|
||||||
|
|
@ -1,42 +0,0 @@
|
||||||
[
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "generic",
|
|
||||||
"label": "Generic"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "docker",
|
|
||||||
"label": "Docker"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "debian",
|
|
||||||
"label": "Debian"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "fedora",
|
|
||||||
"label": "Fedora"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "nixos",
|
|
||||||
"label": "NixOS"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "arch-linux",
|
|
||||||
"label": "Arch Linux"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "kubernetes",
|
|
||||||
"label": "Kubernetes"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "freebsd",
|
|
||||||
"label": "FreeBSD"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
|
|
@ -1,5 +0,0 @@
|
||||||
# Continuwuity for Arch Linux
|
|
||||||
|
|
||||||
Continuwuity is available in the `archlinuxcn` repository and AUR with the same package name `continuwuity`, which includes the latest tagged version. The development version is available on AUR as `continuwuity-git`.
|
|
||||||
|
|
||||||
Simply install the `continuwuity` package. Configure the service in `/etc/conduwuit/conduwuit.toml`, then enable and start the continuwuity.service.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../pkg/debian/README.md
|
|
||||||
|
|
@ -1,76 +0,0 @@
|
||||||
# Continuwuity - Behind Traefik Reverse Proxy
|
|
||||||
|
|
||||||
services:
|
|
||||||
homeserver:
|
|
||||||
### If you already built the continuwuity image with 'docker build' or want to use the Docker Hub image,
|
|
||||||
### then you are ready to go.
|
|
||||||
image: forgejo.ellis.link/continuwuation/continuwuity:latest
|
|
||||||
restart: unless-stopped
|
|
||||||
command: /sbin/conduwuit
|
|
||||||
volumes:
|
|
||||||
- db:/var/lib/continuwuity
|
|
||||||
#- ./continuwuity.toml:/etc/continuwuity.toml
|
|
||||||
networks:
|
|
||||||
- proxy
|
|
||||||
labels:
|
|
||||||
- "traefik.enable=true"
|
|
||||||
- "traefik.http.routers.continuwuity.rule=(Host(`matrix.example.com`) || (Host(`example.com`) && PathPrefix(`/.well-known/matrix`)))"
|
|
||||||
- "traefik.http.routers.continuwuity.entrypoints=websecure" # your HTTPS entry point
|
|
||||||
- "traefik.http.routers.continuwuity.tls=true"
|
|
||||||
- "traefik.http.routers.continuwuity.service=continuwuity"
|
|
||||||
- "traefik.http.services.continuwuity.loadbalancer.server.port=6167"
|
|
||||||
# possibly, depending on your config:
|
|
||||||
# - "traefik.http.routers.continuwuity.tls.certresolver=letsencrypt"
|
|
||||||
environment:
|
|
||||||
CONTINUWUITY_SERVER_NAME: your.server.name.example # EDIT THIS
|
|
||||||
CONTINUWUITY_DATABASE_PATH: /var/lib/continuwuity
|
|
||||||
CONTINUWUITY_PORT: 6167 # should match the loadbalancer traefik label
|
|
||||||
CONTINUWUITY_MAX_REQUEST_SIZE: 20000000 # in bytes, ~20 MB
|
|
||||||
CONTINUWUITY_ALLOW_REGISTRATION: 'true'
|
|
||||||
CONTINUWUITY_REGISTRATION_TOKEN: 'YOUR_TOKEN' # A registration token is required when registration is allowed.
|
|
||||||
#CONTINUWUITY_YES_I_AM_VERY_VERY_SURE_I_WANT_AN_OPEN_REGISTRATION_SERVER_PRONE_TO_ABUSE: 'true'
|
|
||||||
CONTINUWUITY_ALLOW_FEDERATION: 'true'
|
|
||||||
CONTINUWUITY_ALLOW_CHECK_FOR_UPDATES: 'true'
|
|
||||||
CONTINUWUITY_TRUSTED_SERVERS: '["matrix.org"]'
|
|
||||||
#CONTINUWUITY_LOG: warn,state_res=warn
|
|
||||||
CONTINUWUITY_ADDRESS: 0.0.0.0
|
|
||||||
#CONTINUWUITY_CONFIG: '/etc/continuwuity.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 CONTINUWUITY_WELL_KNOWN
|
|
||||||
# variable / config option, there are multiple ways to do this, e.g. in the continuwuity.toml file, and in a separate
|
|
||||||
# see the override file for more information about delegation
|
|
||||||
CONTINUWUITY_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: # Continuwuity 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 Continuwuity
|
|
||||||
### Config-Docs: https://github.com/vector-im/element-web/blob/develop/docs/config.md
|
|
||||||
# element-web:
|
|
||||||
# image: vectorim/element-web:latest
|
|
||||||
# restart: unless-stopped
|
|
||||||
# volumes:
|
|
||||||
# - ./element_config.json:/app/config.json
|
|
||||||
# networks:
|
|
||||||
# - proxy
|
|
||||||
# depends_on:
|
|
||||||
# - homeserver
|
|
||||||
|
|
||||||
volumes:
|
|
||||||
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
|
|
||||||
|
|
||||||
# vim: ts=2:sw=2:expandtab
|
|
||||||
|
|
@ -1,36 +0,0 @@
|
||||||
# Continuwuity - 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
|
|
||||||
|
|
||||||
- "traefik.http.routers.to-continuwuity.rule=Host(`<SUBDOMAIN>.<DOMAIN>`)" # Change to the address on which Continuwuity is hosted
|
|
||||||
- "traefik.http.routers.to-continuwuity.tls=true"
|
|
||||||
- "traefik.http.routers.to-continuwuity.tls.certresolver=letsencrypt"
|
|
||||||
- "traefik.http.routers.to-continuwuity.middlewares=cors-headers@docker"
|
|
||||||
- "traefik.http.services.to_continuwuity.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"
|
|
||||||
|
|
||||||
# If you want to have your account on <DOMAIN>, but host Continuwuity 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"
|
|
||||||
|
|
||||||
### 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"
|
|
||||||
|
|
||||||
# vim: ts=2:sw=2:expandtab
|
|
||||||
|
|
@ -1,60 +0,0 @@
|
||||||
services:
|
|
||||||
caddy:
|
|
||||||
# This compose file uses caddy-docker-proxy as the reverse proxy for Continuwuity!
|
|
||||||
# For more info, visit https://github.com/lucaslorentz/caddy-docker-proxy
|
|
||||||
image: lucaslorentz/caddy-docker-proxy:ci-alpine
|
|
||||||
ports:
|
|
||||||
- 80:80
|
|
||||||
- 443:443
|
|
||||||
environment:
|
|
||||||
- CADDY_INGRESS_NETWORKS=caddy
|
|
||||||
networks:
|
|
||||||
- caddy
|
|
||||||
volumes:
|
|
||||||
- /var/run/docker.sock:/var/run/docker.sock
|
|
||||||
- ./data:/data
|
|
||||||
restart: unless-stopped
|
|
||||||
labels:
|
|
||||||
caddy: example.com
|
|
||||||
caddy.reverse_proxy: /.well-known/matrix/* homeserver:6167
|
|
||||||
|
|
||||||
homeserver:
|
|
||||||
### If you already built the Continuwuity image with 'docker build' or want to use a registry image,
|
|
||||||
### then you are ready to go.
|
|
||||||
image: forgejo.ellis.link/continuwuation/continuwuity:latest
|
|
||||||
restart: unless-stopped
|
|
||||||
command: /sbin/conduwuit
|
|
||||||
volumes:
|
|
||||||
- db:/var/lib/continuwuity
|
|
||||||
- /etc/resolv.conf:/etc/resolv.conf:ro # Use the host's DNS resolver rather than Docker's.
|
|
||||||
#- ./continuwuity.toml:/etc/continuwuity.toml
|
|
||||||
environment:
|
|
||||||
CONTINUWUITY_SERVER_NAME: example.com # EDIT THIS
|
|
||||||
CONTINUWUITY_DATABASE_PATH: /var/lib/continuwuity
|
|
||||||
CONTINUWUITY_PORT: 6167
|
|
||||||
CONTINUWUITY_MAX_REQUEST_SIZE: 20000000 # in bytes, ~20 MB
|
|
||||||
CONTINUWUITY_ALLOW_REGISTRATION: 'true'
|
|
||||||
CONTINUWUITY_REGISTRATION_TOKEN: 'YOUR_TOKEN' # A registration token is required when registration is allowed.
|
|
||||||
#CONTINUWUITY_YES_I_AM_VERY_VERY_SURE_I_WANT_AN_OPEN_REGISTRATION_SERVER_PRONE_TO_ABUSE: 'true'
|
|
||||||
CONTINUWUITY_ALLOW_FEDERATION: 'true'
|
|
||||||
CONTINUWUITY_ALLOW_CHECK_FOR_UPDATES: 'true'
|
|
||||||
CONTINUWUITY_TRUSTED_SERVERS: '["matrix.org"]'
|
|
||||||
#CONTINUWUITY_LOG: warn,state_res=warn
|
|
||||||
CONTINUWUITY_ADDRESS: 0.0.0.0
|
|
||||||
#CONTINUWUITY_CONFIG: '/etc/continuwuity.toml' # Uncomment if you mapped config toml above
|
|
||||||
|
|
||||||
# Required for .well-known delegation - edit these according to your chosen domain
|
|
||||||
CONTINUWUITY_WELL_KNOWN__CLIENT: https://matrix.example.com
|
|
||||||
CONTINUWUITY_WELL_KNOWN__SERVER: matrix.example.com:443
|
|
||||||
networks:
|
|
||||||
- caddy
|
|
||||||
labels:
|
|
||||||
caddy: matrix.example.com
|
|
||||||
caddy.reverse_proxy: "{{upstreams 6167}}"
|
|
||||||
|
|
||||||
volumes:
|
|
||||||
db:
|
|
||||||
|
|
||||||
networks:
|
|
||||||
caddy:
|
|
||||||
external: true
|
|
||||||
|
|
@ -1,160 +0,0 @@
|
||||||
# Continuwuity - Behind Traefik Reverse Proxy
|
|
||||||
|
|
||||||
services:
|
|
||||||
homeserver:
|
|
||||||
### If you already built the Continuwuity image with 'docker build' or want to use the Docker Hub image,
|
|
||||||
### then you are ready to go.
|
|
||||||
image: forgejo.ellis.link/continuwuation/continuwuity:latest
|
|
||||||
restart: unless-stopped
|
|
||||||
command: /sbin/conduwuit
|
|
||||||
volumes:
|
|
||||||
- db:/var/lib/continuwuity
|
|
||||||
- /etc/resolv.conf:/etc/resolv.conf:ro # Use the host's DNS resolver rather than Docker's.
|
|
||||||
#- ./continuwuity.toml:/etc/continuwuity.toml
|
|
||||||
networks:
|
|
||||||
- proxy
|
|
||||||
labels:
|
|
||||||
- "traefik.enable=true"
|
|
||||||
- "traefik.http.routers.continuwuity.rule=(Host(`matrix.example.com`) || (Host(`example.com`) && PathPrefix(`/.well-known/matrix`)))"
|
|
||||||
- "traefik.http.routers.continuwuity.entrypoints=websecure"
|
|
||||||
- "traefik.http.routers.continuwuity.tls.certresolver=letsencrypt"
|
|
||||||
- "traefik.http.services.continuwuity.loadbalancer.server.port=6167"
|
|
||||||
# Uncomment and adjust the following if you want to use middleware
|
|
||||||
# - "traefik.http.routers.continuwuity.middlewares=secureHeaders@file"
|
|
||||||
environment:
|
|
||||||
CONTINUWUITY_SERVER_NAME: your.server.name.example # EDIT THIS
|
|
||||||
CONTINUWUITY_TRUSTED_SERVERS: '["matrix.org"]'
|
|
||||||
CONTINUWUITY_ALLOW_REGISTRATION: 'false' # After setting a secure registration token, you can enable this
|
|
||||||
CONTINUWUITY_REGISTRATION_TOKEN: "" # This is a token you can use to register on the server
|
|
||||||
#CONTINUWUITY_REGISTRATION_TOKEN_FILE: "" # Alternatively you can configure a path to a token file to read
|
|
||||||
CONTINUWUITY_ADDRESS: 0.0.0.0
|
|
||||||
CONTINUWUITY_PORT: 6167 # you need to match this with the traefik load balancer label if you're want to change it
|
|
||||||
CONTINUWUITY_DATABASE_PATH: /var/lib/continuwuity
|
|
||||||
#CONTINUWUITY_CONFIG: '/etc/continuwuity.toml' # Uncomment if you mapped config toml above
|
|
||||||
### Uncomment and change values as desired, note that Continuwuity 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
|
|
||||||
# CONTINUWUITY_LOG: info # default is: "warn,state_res=warn"
|
|
||||||
# CONTINUWUITY_ALLOW_ENCRYPTION: 'true'
|
|
||||||
# CONTINUWUITY_ALLOW_FEDERATION: 'true'
|
|
||||||
# CONTINUWUITY_ALLOW_CHECK_FOR_UPDATES: 'true'
|
|
||||||
# CONTINUWUITY_ALLOW_INCOMING_PRESENCE: true
|
|
||||||
# CONTINUWUITY_ALLOW_OUTGOING_PRESENCE: true
|
|
||||||
# CONTINUWUITY_ALLOW_LOCAL_PRESENCE: true
|
|
||||||
# CONTINUWUITY_WORKERS: 10
|
|
||||||
# CONTINUWUITY_MAX_REQUEST_SIZE: 20000000 # in bytes, ~20 MB
|
|
||||||
# CONTINUWUITY_NEW_USER_DISPLAYNAME_SUFFIX = "🏳<200d>⚧"
|
|
||||||
|
|
||||||
# We need some way to serve the client and server .well-known json. The simplest way is via the CONTINUWUITY_WELL_KNOWN
|
|
||||||
# variable / config option, there are multiple ways to do this, e.g. in the continuwuity.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
|
|
||||||
CONTINUWUITY_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: # Continuwuity 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 Continuwuity
|
|
||||||
### Config-Docs: https://github.com/vector-im/element-web/blob/develop/docs/config.md
|
|
||||||
# element-web:
|
|
||||||
# image: vectorim/element-web:latest
|
|
||||||
# restart: unless-stopped
|
|
||||||
# volumes:
|
|
||||||
# - ./element_config.json:/app/config.json
|
|
||||||
# networks:
|
|
||||||
# - proxy
|
|
||||||
# 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: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=web"
|
|
||||||
- "traefik.http.routers.redirs.middlewares=redirect-to-https"
|
|
||||||
|
|
||||||
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"
|
|
||||||
|
|
||||||
# Since Traefik 3.6.3, paths with certain "encoded characters" are now blocked by default; we need a couple, or else things *will* break
|
|
||||||
TRAEFIK_ENTRYPOINTS_WEBSECURE_HTTP_ENCODEDCHARACTERS_ALLOWENCODEDSLASH: true
|
|
||||||
TRAEFIK_ENTRYPOINTS_WEBSECURE_HTTP_ENCODEDCHARACTERS_ALLOWENCODEDHASH: true
|
|
||||||
|
|
||||||
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:
|
|
||||||
acme:
|
|
||||||
|
|
||||||
networks:
|
|
||||||
proxy:
|
|
||||||
|
|
||||||
# vim: ts=2:sw=2:expandtab
|
|
||||||
|
|
@ -1,45 +0,0 @@
|
||||||
# Continuwuity
|
|
||||||
|
|
||||||
services:
|
|
||||||
homeserver:
|
|
||||||
### If you already built the Continuwuity image with 'docker build' or want to use a registry image,
|
|
||||||
### then you are ready to go.
|
|
||||||
image: forgejo.ellis.link/continuwuation/continuwuity:latest
|
|
||||||
restart: unless-stopped
|
|
||||||
command: /sbin/conduwuit
|
|
||||||
ports:
|
|
||||||
- 8448:6167
|
|
||||||
volumes:
|
|
||||||
- db:/var/lib/continuwuity
|
|
||||||
#- ./continuwuity.toml:/etc/continuwuity.toml
|
|
||||||
environment:
|
|
||||||
CONTINUWUITY_SERVER_NAME: your.server.name # EDIT THIS
|
|
||||||
CONTINUWUITY_DATABASE_PATH: /var/lib/continuwuity
|
|
||||||
CONTINUWUITY_PORT: 6167
|
|
||||||
CONTINUWUITY_MAX_REQUEST_SIZE: 20000000 # in bytes, ~20 MB
|
|
||||||
CONTINUWUITY_ALLOW_REGISTRATION: 'true'
|
|
||||||
CONTINUWUITY_REGISTRATION_TOKEN: 'YOUR_TOKEN' # A registration token is required when registration is allowed.
|
|
||||||
#CONTINUWUITY_YES_I_AM_VERY_VERY_SURE_I_WANT_AN_OPEN_REGISTRATION_SERVER_PRONE_TO_ABUSE: 'true'
|
|
||||||
CONTINUWUITY_ALLOW_FEDERATION: 'true'
|
|
||||||
CONTINUWUITY_ALLOW_CHECK_FOR_UPDATES: 'true'
|
|
||||||
CONTINUWUITY_TRUSTED_SERVERS: '["matrix.org"]'
|
|
||||||
#CONTINUWUITY_LOG: warn,state_res=warn
|
|
||||||
CONTINUWUITY_ADDRESS: 0.0.0.0
|
|
||||||
#CONTINUWUITY_CONFIG: '/etc/continuwuity.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 Continuwuity
|
|
||||||
### Config-Docs: https://github.com/vector-im/element-web/blob/develop/docs/config.md
|
|
||||||
# element-web:
|
|
||||||
# image: vectorim/element-web:latest
|
|
||||||
# restart: unless-stopped
|
|
||||||
# ports:
|
|
||||||
# - 8009:80
|
|
||||||
# volumes:
|
|
||||||
# - ./element_config.json:/app/config.json
|
|
||||||
# depends_on:
|
|
||||||
# - homeserver
|
|
||||||
|
|
||||||
volumes:
|
|
||||||
db:
|
|
||||||
|
|
@ -1,257 +0,0 @@
|
||||||
# Continuwuity for Docker
|
|
||||||
|
|
||||||
## Docker
|
|
||||||
|
|
||||||
To run Continuwuity with Docker, you can either build the image yourself or pull
|
|
||||||
it from a registry.
|
|
||||||
|
|
||||||
### Use a registry
|
|
||||||
|
|
||||||
Available OCI images:
|
|
||||||
|
|
||||||
| Registry | Image | Notes |
|
|
||||||
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
|
||||||
| Forgejo Registry | [forgejo.ellis.link/continuwuation/continuwuity:latest](https://forgejo.ellis.link/continuwuation/-/packages/container/continuwuity/latest) | Latest tagged image. |
|
|
||||||
| Forgejo Registry | [forgejo.ellis.link/continuwuation/continuwuity:main](https://forgejo.ellis.link/continuwuation/-/packages/container/continuwuity/main) | Main branch image. |
|
|
||||||
| Forgejo Registry | [forgejo.ellis.link/continuwuation/continuwuity:latest-maxperf](https://forgejo.ellis.link/continuwuation/-/packages/container/continuwuity/latest-maxperf) | [Performance optimised version.](./generic.mdx#performance-optimised-builds) |
|
|
||||||
| Forgejo Registry | [forgejo.ellis.link/continuwuation/continuwuity:main-maxperf](https://forgejo.ellis.link/continuwuation/-/packages/container/continuwuity/main-maxperf) | [Performance optimised version.](./generic.mdx#performance-optimised-builds) |
|
|
||||||
|
|
||||||
**Example:**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker image pull forgejo.ellis.link/continuwuation/continuwuity:main-maxperf
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Mirrors
|
|
||||||
|
|
||||||
Images are mirrored to multiple locations automatically, on a schedule:
|
|
||||||
|
|
||||||
- `ghcr.io/continuwuity/continuwuity`
|
|
||||||
- `docker.io/jadedblueeyes/continuwuity`
|
|
||||||
- `registry.gitlab.com/continuwuity/continuwuity`
|
|
||||||
- `git.nexy7574.co.uk/mirrored/continuwuity` (releases only, no `main`)
|
|
||||||
|
|
||||||
### Quick Run
|
|
||||||
|
|
||||||
Get a working Continuwuity server with an admin user in four steps:
|
|
||||||
|
|
||||||
#### Prerequisites
|
|
||||||
|
|
||||||
Continuwuity requires HTTPS for Matrix federation. You'll need:
|
|
||||||
|
|
||||||
- A domain name pointing to your server
|
|
||||||
- A reverse proxy with SSL/TLS certificates (Traefik, Caddy, nginx, etc.)
|
|
||||||
|
|
||||||
See [Docker Compose](#docker-compose) for complete examples.
|
|
||||||
|
|
||||||
#### Environment Variables
|
|
||||||
|
|
||||||
- `CONTINUWUITY_SERVER_NAME` - Your Matrix server's domain name
|
|
||||||
- `CONTINUWUITY_DATABASE_PATH` - Where to store your database (must match the
|
|
||||||
volume mount)
|
|
||||||
- `CONTINUWUITY_ADDRESS` - Bind address (use `0.0.0.0` to listen on all
|
|
||||||
interfaces)
|
|
||||||
- `CONTINUWUITY_ALLOW_REGISTRATION` - Set to `false` to disable registration, or
|
|
||||||
use with `CONTINUWUITY_REGISTRATION_TOKEN` to require a token (see
|
|
||||||
[reference](../reference/environment-variables.mdx#registration--user-configuration)
|
|
||||||
for details)
|
|
||||||
|
|
||||||
See the
|
|
||||||
[Environment Variables Reference](../reference/environment-variables.mdx) for
|
|
||||||
more configuration options.
|
|
||||||
|
|
||||||
#### 1. Pull the image
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker pull forgejo.ellis.link/continuwuation/continuwuity:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 2. Start the server with initial admin user
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker run -d \
|
|
||||||
-p 6167:6167 \
|
|
||||||
-v continuwuity_db:/var/lib/continuwuity \
|
|
||||||
-e CONTINUWUITY_SERVER_NAME="matrix.example.com" \
|
|
||||||
-e CONTINUWUITY_DATABASE_PATH="/var/lib/continuwuity" \
|
|
||||||
-e CONTINUWUITY_ADDRESS="0.0.0.0" \
|
|
||||||
-e CONTINUWUITY_ALLOW_REGISTRATION="false" \
|
|
||||||
--name continuwuity \
|
|
||||||
forgejo.ellis.link/continuwuation/continuwuity:latest \
|
|
||||||
/sbin/conduwuit --execute "users create-user admin"
|
|
||||||
```
|
|
||||||
|
|
||||||
Replace `matrix.example.com` with your actual server name and `admin` with
|
|
||||||
your preferred username.
|
|
||||||
|
|
||||||
#### 3. Get your admin password
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker logs continuwuity 2>&1 | grep "Created user"
|
|
||||||
```
|
|
||||||
|
|
||||||
You'll see output like:
|
|
||||||
|
|
||||||
```
|
|
||||||
Created user with user_id: @admin:matrix.example.com and password: `[auto-generated-password]`
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 4. Configure your reverse proxy
|
|
||||||
|
|
||||||
Configure your reverse proxy to forward HTTPS traffic to Continuwuity. See
|
|
||||||
[Docker Compose](#docker-compose) for examples.
|
|
||||||
|
|
||||||
Once configured, log in with any Matrix client using `@admin:matrix.example.com`
|
|
||||||
and the generated password. You'll automatically be invited to the admin room
|
|
||||||
where you can manage your server.
|
|
||||||
|
|
||||||
### Docker Compose
|
|
||||||
|
|
||||||
Docker Compose is the recommended deployment method. These examples include
|
|
||||||
reverse proxy configurations for Matrix federation.
|
|
||||||
|
|
||||||
#### Matrix Federation Requirements
|
|
||||||
|
|
||||||
For Matrix federation to work, you need to serve `.well-known/matrix/client` and
|
|
||||||
`.well-known/matrix/server` endpoints. You can achieve this either by:
|
|
||||||
|
|
||||||
1. **Using a well-known service** - The compose files below include an nginx
|
|
||||||
container to serve these files
|
|
||||||
2. **Using Continuwuity's built-in delegation** (easier for Traefik) - Configure
|
|
||||||
delegation files in your config, then proxy `/.well-known/matrix/*` to
|
|
||||||
Continuwuity
|
|
||||||
|
|
||||||
**Traefik example using built-in delegation:**
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
labels:
|
|
||||||
traefik.http.routers.continuwuity.rule: >-
|
|
||||||
(Host(`matrix.example.com`) ||
|
|
||||||
(Host(`example.com`) && PathPrefix(`/.well-known/matrix`)))
|
|
||||||
```
|
|
||||||
|
|
||||||
This routes your Matrix domain and well-known paths to Continuwuity.
|
|
||||||
|
|
||||||
#### Creating Your First Admin User
|
|
||||||
|
|
||||||
Add the `--execute` command to create an admin user on first startup. In your
|
|
||||||
compose file, add under the `continuwuity` service:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
services:
|
|
||||||
continuwuity:
|
|
||||||
image: forgejo.ellis.link/continuwuation/continuwuity:latest
|
|
||||||
command: /sbin/conduwuit --execute "users create-user admin"
|
|
||||||
# ... rest of configuration
|
|
||||||
```
|
|
||||||
|
|
||||||
Then retrieve the auto-generated password:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker compose logs continuwuity | grep "Created user"
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Choose Your Reverse Proxy
|
|
||||||
|
|
||||||
Select the compose file that matches your setup:
|
|
||||||
|
|
||||||
:::note DNS Performance
|
|
||||||
Docker's default DNS resolver can cause performance issues with Matrix
|
|
||||||
federation. If you experience slow federation or DNS timeouts, you may need to
|
|
||||||
use your host's DNS resolver instead. Add this volume mount to the
|
|
||||||
`continuwuity` service:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
volumes:
|
|
||||||
- /etc/resolv.conf:/etc/resolv.conf:ro
|
|
||||||
```
|
|
||||||
|
|
||||||
See [Troubleshooting - DNS Issues](../troubleshooting.mdx#potential-dns-issues-when-using-docker)
|
|
||||||
for more details and alternative solutions.
|
|
||||||
:::
|
|
||||||
|
|
||||||
##### For existing Traefik setup
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>docker-compose.for-traefik.yml</summary>
|
|
||||||
|
|
||||||
```yaml file="./docker-compose.for-traefik.yml"
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
##### With Traefik included
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>docker-compose.with-traefik.yml</summary>
|
|
||||||
|
|
||||||
```yaml file="./docker-compose.with-traefik.yml"
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
##### With Caddy Docker Proxy
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>docker-compose.with-caddy.yml</summary>
|
|
||||||
|
|
||||||
Replace all `example.com` placeholders with your own domain.
|
|
||||||
|
|
||||||
```yaml file="./docker-compose.with-caddy.yml"
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
If you don't already have a network for Caddy to monitor, create one first:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker network create caddy
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
##### For other reverse proxies
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>docker-compose.yml</summary>
|
|
||||||
|
|
||||||
```yaml file="./docker-compose.yml"
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
##### Override file for customisation
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>docker-compose.override.yml</summary>
|
|
||||||
|
|
||||||
```yaml file="./docker-compose.override.yml"
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
#### Starting Your Server
|
|
||||||
|
|
||||||
1. Choose your compose file and rename it to `docker-compose.yml`
|
|
||||||
2. If using the override file, rename it to `docker-compose.override.yml` and
|
|
||||||
edit your values
|
|
||||||
3. Start the server:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker compose up -d
|
|
||||||
```
|
|
||||||
|
|
||||||
See the [generic deployment guide](generic.mdx) for more deployment options.
|
|
||||||
|
|
||||||
### Building Custom Images
|
|
||||||
|
|
||||||
For information on building your own Continuwuity Docker images, see the
|
|
||||||
[Building Docker Images](../development/index.mdx#building-docker-images)
|
|
||||||
section in the development documentation.
|
|
||||||
|
|
||||||
## Voice communication
|
|
||||||
|
|
||||||
See the [Calls](../calls.mdx) page.
|
|
||||||
|
|
@ -1,189 +0,0 @@
|
||||||
# RPM Installation Guide
|
|
||||||
|
|
||||||
Continuwuity is available as RPM packages for Fedora and compatible distributions.
|
|
||||||
We do not currently have infrastructure to build RPMs for RHEL and compatible distributions, but this is a work in progress.
|
|
||||||
|
|
||||||
The RPM packaging files are maintained in the `fedora/` directory:
|
|
||||||
- `continuwuity.spec.rpkg` - RPM spec file using rpkg macros for building from git
|
|
||||||
- `continuwuity.service` - Systemd service file for the server
|
|
||||||
- `RPM-GPG-KEY-continuwuity.asc` - GPG public key for verifying signed packages
|
|
||||||
|
|
||||||
RPM packages built by CI are signed with our GPG key (RSA, ID: `6595 E8DB 9191 D39A 46D6 A514 4BA7 F590 DF0B AA1D`). # spellchecker:disable-line
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Import the signing key
|
|
||||||
sudo rpm --import https://forgejo.ellis.link/api/packages/continuwuation/rpm/repository.key
|
|
||||||
|
|
||||||
# Verify a downloaded package
|
|
||||||
rpm --checksig continuwuity-*.rpm
|
|
||||||
```
|
|
||||||
|
|
||||||
## Installation methods
|
|
||||||
|
|
||||||
**Stable releases** (recommended)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Add the repository and install
|
|
||||||
sudo dnf config-manager addrepo --from-repofile=https://forgejo.ellis.link/api/packages/continuwuation/rpm/stable.repo
|
|
||||||
sudo dnf install continuwuity
|
|
||||||
```
|
|
||||||
|
|
||||||
**Development builds** from main branch
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Add the dev repository and install
|
|
||||||
sudo dnf config-manager addrepo --from-repofile=https://forgejo.ellis.link/api/packages/continuwuation/rpm/dev.repo
|
|
||||||
sudo dnf install continuwuity
|
|
||||||
```
|
|
||||||
|
|
||||||
**Feature branch builds** (example: `tom/new-feature`)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Branch names are sanitized (slashes become hyphens, lowercase only)
|
|
||||||
sudo dnf config-manager addrepo --from-repofile=https://forgejo.ellis.link/api/packages/continuwuation/rpm/tom-new-feature.repo
|
|
||||||
sudo dnf install continuwuity
|
|
||||||
```
|
|
||||||
|
|
||||||
**Manual repository configuration** (alternative method)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cat << 'EOF' | sudo tee /etc/yum.repos.d/continuwuity.repo
|
|
||||||
[continuwuity]
|
|
||||||
name=Continuwuity - Matrix homeserver
|
|
||||||
baseurl=https://forgejo.ellis.link/api/packages/continuwuation/rpm/stable
|
|
||||||
enabled=1
|
|
||||||
gpgcheck=1
|
|
||||||
gpgkey=https://forgejo.ellis.link/api/packages/continuwuation/rpm/repository.key
|
|
||||||
EOF
|
|
||||||
|
|
||||||
sudo dnf install continuwuity
|
|
||||||
```
|
|
||||||
|
|
||||||
## Package management
|
|
||||||
|
|
||||||
**Automatic updates** with DNF Automatic
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Install and configure
|
|
||||||
sudo dnf install dnf-automatic
|
|
||||||
sudo nano /etc/dnf/automatic.conf # Set: apply_updates = yes
|
|
||||||
sudo systemctl enable --now dnf-automatic.timer
|
|
||||||
```
|
|
||||||
|
|
||||||
**Manual updates**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Check for updates
|
|
||||||
sudo dnf check-update continuwuity
|
|
||||||
|
|
||||||
# Update to latest version
|
|
||||||
sudo dnf update continuwuity
|
|
||||||
```
|
|
||||||
|
|
||||||
**Switching channels** (stable/dev/feature branches)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# List enabled repositories
|
|
||||||
dnf repolist | grep continuwuation
|
|
||||||
|
|
||||||
# Disable current repository
|
|
||||||
sudo dnf config-manager --set-disabled continuwuation-stable # or -dev, or branch name
|
|
||||||
|
|
||||||
# Enable desired repository
|
|
||||||
sudo dnf config-manager --set-enabled continuwuation-dev # or -stable, or branch name
|
|
||||||
|
|
||||||
# Update to the new channel's version
|
|
||||||
sudo dnf update continuwuity
|
|
||||||
```
|
|
||||||
|
|
||||||
**Verifying installation**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Check installed version
|
|
||||||
rpm -q continuwuity
|
|
||||||
|
|
||||||
# View package information
|
|
||||||
rpm -qi continuwuity
|
|
||||||
|
|
||||||
# List installed files
|
|
||||||
rpm -ql continuwuity
|
|
||||||
|
|
||||||
# Verify package integrity
|
|
||||||
rpm -V continuwuity
|
|
||||||
```
|
|
||||||
|
|
||||||
## Service management and removal
|
|
||||||
|
|
||||||
**Systemd service commands**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Start the service
|
|
||||||
sudo systemctl start conduwuit
|
|
||||||
|
|
||||||
# Enable on boot
|
|
||||||
sudo systemctl enable conduwuit
|
|
||||||
|
|
||||||
# Check status
|
|
||||||
sudo systemctl status conduwuit
|
|
||||||
|
|
||||||
# View logs
|
|
||||||
sudo journalctl -u conduwuit -f
|
|
||||||
```
|
|
||||||
|
|
||||||
**Uninstallation**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Stop and disable the service
|
|
||||||
sudo systemctl stop conduwuit
|
|
||||||
sudo systemctl disable conduwuit
|
|
||||||
|
|
||||||
# Remove the package
|
|
||||||
sudo dnf remove continuwuity
|
|
||||||
|
|
||||||
# Remove the repository (optional)
|
|
||||||
sudo rm /etc/yum.repos.d/continuwuation-*.repo
|
|
||||||
```
|
|
||||||
|
|
||||||
## Troubleshooting
|
|
||||||
|
|
||||||
**GPG key errors**: Temporarily disable GPG checking
|
|
||||||
|
|
||||||
```bash
|
|
||||||
sudo dnf --nogpgcheck install continuwuity
|
|
||||||
```
|
|
||||||
|
|
||||||
**Repository metadata issues**: Clear and rebuild cache
|
|
||||||
|
|
||||||
```bash
|
|
||||||
sudo dnf clean all
|
|
||||||
sudo dnf makecache
|
|
||||||
```
|
|
||||||
|
|
||||||
**Finding specific versions**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# List all available versions
|
|
||||||
dnf --showduplicates list continuwuity
|
|
||||||
|
|
||||||
# Install a specific version
|
|
||||||
sudo dnf install continuwuity-<version>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Building locally
|
|
||||||
|
|
||||||
Build the RPM locally using rpkg:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Install dependencies
|
|
||||||
sudo dnf install rpkg rpm-build cargo-rpm-macros systemd-rpm-macros
|
|
||||||
|
|
||||||
# Clone the repository
|
|
||||||
git clone https://forgejo.ellis.link/continuwuation/continuwuity.git
|
|
||||||
cd continuwuity
|
|
||||||
|
|
||||||
# Build SRPM
|
|
||||||
rpkg srpm
|
|
||||||
|
|
||||||
# Build RPM
|
|
||||||
rpmbuild --rebuild *.src.rpm
|
|
||||||
```
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
# Continuwuity for FreeBSD
|
|
||||||
|
|
||||||
Continuwuity doesn't provide official FreeBSD packages; however, a community-maintained set of packages is available on [Forgejo](https://forgejo.ellis.link/katie/continuwuity-bsd). Note that these are provided as standalone packages and are not part of a FreeBSD package repository (yet), so updates need to be downloaded and installed manually.
|
|
||||||
|
|
||||||
Please see the installation instructions in that repository. Direct any questions to its issue tracker or to [@katie:kat5.dev](https://matrix.to/#/@katie:kat5.dev).
|
|
||||||
|
|
||||||
For general BSD support, please join our [Continuwuity BSD](https://matrix.to/#/%23bsd:continuwuity.org) community room.
|
|
||||||
|
|
@ -1,287 +0,0 @@
|
||||||
# Generic deployment documentation
|
|
||||||
|
|
||||||
> ### Getting help
|
|
||||||
>
|
|
||||||
> If you run into any problems while setting up Continuwuity, ask us in
|
|
||||||
> `#continuwuity:continuwuity.org` or [open an issue on
|
|
||||||
> Forgejo](https://forgejo.ellis.link/continuwuation/continuwuity/issues/new).
|
|
||||||
|
|
||||||
## Installing Continuwuity
|
|
||||||
|
|
||||||
### Prebuilt binary
|
|
||||||
|
|
||||||
Download the binary for your architecture (x86_64 or aarch64) -
|
|
||||||
run the `uname -m` to check which you need.
|
|
||||||
|
|
||||||
Prebuilt binaries are available from:
|
|
||||||
- **Tagged releases**: [Latest release page](https://forgejo.ellis.link/continuwuation/continuwuity/releases/latest)
|
|
||||||
- **Development builds**: CI artifacts from the `main` branch
|
|
||||||
(includes Debian/Ubuntu packages)
|
|
||||||
|
|
||||||
When browsing CI artifacts, `ci-bins` contains binaries organised
|
|
||||||
by commit hash, while `releases` contains tagged versions. Sort
|
|
||||||
by last modified date to find the most recent builds.
|
|
||||||
|
|
||||||
The binaries require jemalloc and io_uring on the host system. Currently
|
|
||||||
we can't cross-build static binaries - contributions are welcome here.
|
|
||||||
|
|
||||||
#### Performance-optimised builds
|
|
||||||
|
|
||||||
For x86_64 systems with CPUs from the last ~15 years, use the
|
|
||||||
`-haswell-` optimised binaries for best performance. These
|
|
||||||
binaries enable hardware-accelerated CRC32 checksumming in
|
|
||||||
RocksDB, which significantly improves database performance.
|
|
||||||
The haswell instruction set provides an excellent balance of
|
|
||||||
compatibility and speed.
|
|
||||||
|
|
||||||
If you're using Docker instead, equivalent performance-optimised
|
|
||||||
images are available with the `-maxperf` suffix (e.g.
|
|
||||||
`forgejo.ellis.link/continuwuation/continuwuity:latest-maxperf`).
|
|
||||||
These images use the `release-max-perf`
|
|
||||||
build profile with
|
|
||||||
[link-time optimisation (LTO)](https://doc.rust-lang.org/cargo/reference/profiles.html#lto)
|
|
||||||
and, for amd64, target the haswell CPU architecture.
|
|
||||||
|
|
||||||
### Compiling
|
|
||||||
|
|
||||||
Alternatively, you may compile the binary yourself.
|
|
||||||
|
|
||||||
### Building with the Rust toolchain
|
|
||||||
|
|
||||||
If wanting to build using standard Rust toolchains, make sure you install:
|
|
||||||
|
|
||||||
- (On linux) `liburing-dev` on the compiling machine, and `liburing` on the target host
|
|
||||||
- (On linux) `pkg-config` on the compiling machine to allow finding `liburing`
|
|
||||||
- A C++ compiler and (on linux) `libclang` for RocksDB
|
|
||||||
|
|
||||||
You can build Continuwuity using `cargo build --release`.
|
|
||||||
|
|
||||||
Continuwuity supports various optional features that can be enabled during compilation. Please see the Cargo.toml file for a comprehensive list, or ask in our rooms.
|
|
||||||
|
|
||||||
### Building with Nix
|
|
||||||
|
|
||||||
If you prefer, you can use Nix (or [Lix](https://lix.systems)) to build Continuwuity. This provides improved reproducibility and makes it easy to set up a build environment and generate output. This approach also allows for easy cross-compilation.
|
|
||||||
|
|
||||||
You can run the `nix build -L .#static-x86_64-linux-musl-all-features` or
|
|
||||||
`nix build -L .#static-aarch64-linux-musl-all-features` commands based
|
|
||||||
on architecture to cross-compile the necessary static binary located at
|
|
||||||
`result/bin/conduwuit`. This is reproducible with the static binaries produced
|
|
||||||
in our CI.
|
|
||||||
|
|
||||||
## Adding a Continuwuity user
|
|
||||||
|
|
||||||
While Continuwuity can run as any user, it is better to use dedicated users for
|
|
||||||
different services. This also ensures that the file permissions
|
|
||||||
are set up correctly.
|
|
||||||
|
|
||||||
In Debian, you can use this command to create a Continuwuity user:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
sudo adduser --system continuwuity --group --disabled-login --no-create-home
|
|
||||||
```
|
|
||||||
|
|
||||||
For distros without `adduser` (or where it's a symlink to `useradd`):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
sudo useradd -r --shell /usr/bin/nologin --no-create-home continuwuity
|
|
||||||
```
|
|
||||||
|
|
||||||
## Forwarding ports in the firewall or the router
|
|
||||||
|
|
||||||
Matrix's default federation port is 8448, and clients must use port 443.
|
|
||||||
If you would like to use only port 443 or a different port, you will need to set up
|
|
||||||
delegation. Continuwuity has configuration options for delegation, or you can configure
|
|
||||||
your reverse proxy to manually serve the necessary JSON files for delegation
|
|
||||||
(see the `[global.well_known]` config section).
|
|
||||||
|
|
||||||
If Continuwuity runs behind a router or in a container and has a different public
|
|
||||||
IP address than the host system, you need to forward these public ports directly
|
|
||||||
or indirectly to the port mentioned in the configuration.
|
|
||||||
|
|
||||||
Note for NAT users: if you have trouble connecting to your server from inside
|
|
||||||
your network, check if your router 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
|
|
||||||
|
|
||||||
You can find an example unit for continuwuity below.
|
|
||||||
You may need to change the `ExecStart=` path to match where you placed the Continuwuity
|
|
||||||
binary if it is not in `/usr/bin/conduwuit`.
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
If you are using a different `database_path` than the systemd unit's
|
|
||||||
configured default `/var/lib/conduwuit`, you need to add your path to the
|
|
||||||
systemd unit's `ReadWritePaths=`. You can do this by either directly editing
|
|
||||||
`conduwuit.service` and reloading systemd, or by running `systemctl edit conduwuit.service`
|
|
||||||
and entering the following:
|
|
||||||
|
|
||||||
```
|
|
||||||
[Service]
|
|
||||||
ReadWritePaths=/path/to/custom/database/path
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### Example systemd Unit File
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Click to expand systemd unit file (conduwuit.service)</summary>
|
|
||||||
|
|
||||||
|
|
||||||
```ini file="../../pkg/conduwuit.service"
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
You can also [view the file on Foregejo](https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/pkg/conduwuit.service).
|
|
||||||
|
|
||||||
## Creating the Continuwuity configuration file
|
|
||||||
|
|
||||||
Now you need to create the Continuwuity configuration file in
|
|
||||||
`/etc/conduwuit/conduwuit.toml`. You can find an example configuration at
|
|
||||||
[conduwuit-example.toml](../reference/config.mdx).
|
|
||||||
|
|
||||||
**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 Continuwuity, you need to allow it to
|
|
||||||
read the configuration. To do this, run:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
sudo chown -R root:root /etc/conduwuit
|
|
||||||
sudo chmod -R 755 /etc/conduwuit
|
|
||||||
```
|
|
||||||
|
|
||||||
If you use the default database path you also need to run this:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
sudo mkdir -p /var/lib/conduwuit/
|
|
||||||
sudo chown -R continuwuity:continuwuity /var/lib/conduwuit/
|
|
||||||
sudo chmod 700 /var/lib/conduwuit/
|
|
||||||
```
|
|
||||||
|
|
||||||
## Setting up the Reverse Proxy
|
|
||||||
|
|
||||||
We recommend Caddy as a reverse proxy because it is trivial to use and handles TLS certificates, reverse proxy headers, etc. transparently with proper defaults.
|
|
||||||
For other software, please refer to their respective documentation or online guides.
|
|
||||||
|
|
||||||
### Caddy
|
|
||||||
|
|
||||||
After installing Caddy via your preferred method, create `/etc/caddy/conf.d/conduwuit_caddyfile`
|
|
||||||
and enter the following (substitute your actual server name):
|
|
||||||
|
|
||||||
```
|
|
||||||
your.server.name, your.server.name:8448 {
|
|
||||||
# TCP reverse_proxy
|
|
||||||
reverse_proxy 127.0.0.1:6167
|
|
||||||
# UNIX socket
|
|
||||||
#reverse_proxy unix//run/conduwuit/conduwuit.sock
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
That's it! Just start and enable the service and you're set.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
sudo systemctl enable --now caddy
|
|
||||||
```
|
|
||||||
|
|
||||||
### Other Reverse Proxies
|
|
||||||
|
|
||||||
As we prefer our users to use Caddy, we do not provide configuration files for other proxies.
|
|
||||||
|
|
||||||
You will need to reverse proxy everything under the following routes:
|
|
||||||
- `/_matrix/` - core Matrix C-S and S-S APIs
|
|
||||||
- `/_conduwuit/` and/or `/_continuwuity/` - ad-hoc Continuwuity routes such as `/local_user_count` and
|
|
||||||
`/server_version`
|
|
||||||
|
|
||||||
You can optionally reverse proxy the following individual routes:
|
|
||||||
- `/.well-known/matrix/client` and `/.well-known/matrix/server` if using
|
|
||||||
Continuwuity to perform delegation (see the `[global.well_known]` config section)
|
|
||||||
- `/.well-known/matrix/support` if using Continuwuity to send the homeserver admin
|
|
||||||
contact and support page (formerly known as MSC1929)
|
|
||||||
- `/` if you would like to see `hewwo from conduwuit woof!` at the root
|
|
||||||
|
|
||||||
See the following spec pages for more details on these files:
|
|
||||||
- [`/.well-known/matrix/server`](https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixserver)
|
|
||||||
- [`/.well-known/matrix/client`](https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixclient)
|
|
||||||
- [`/.well-known/matrix/support`](https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixsupport)
|
|
||||||
|
|
||||||
Examples of delegation:
|
|
||||||
- https://continuwuity.org/.well-known/matrix/server
|
|
||||||
- https://continuwuity.org/.well-known/matrix/client
|
|
||||||
- https://ellis.link/.well-known/matrix/server
|
|
||||||
- https://ellis.link/.well-known/matrix/client
|
|
||||||
|
|
||||||
For Apache and Nginx there are many examples available online.
|
|
||||||
|
|
||||||
Lighttpd is not supported as it appears to interfere with the `X-Matrix` Authorization
|
|
||||||
header, making federation non-functional. If you find a workaround, please share it so we can add it to this documentation.
|
|
||||||
|
|
||||||
If using Apache, you need to use `nocanon` in your `ProxyPass` directive to prevent httpd from interfering with the `X-Matrix` header (note that Apache is not ideal as a general reverse proxy, so we discourage using it if alternatives are available).
|
|
||||||
|
|
||||||
If using Nginx, you need to pass the request URI to Continuwuity using `$request_uri`, like this:
|
|
||||||
- `proxy_pass http://127.0.0.1:6167$request_uri;`
|
|
||||||
- `proxy_pass http://127.0.0.1:6167;`
|
|
||||||
|
|
||||||
Nginx users need to increase the `client_max_body_size` setting (default is 1M) to match the
|
|
||||||
`max_request_size` defined in conduwuit.toml.
|
|
||||||
|
|
||||||
## You're done
|
|
||||||
|
|
||||||
Now you can start Continuwuity with:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
sudo systemctl start conduwuit
|
|
||||||
```
|
|
||||||
|
|
||||||
Set it to start automatically when your system boots with:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
sudo systemctl enable conduwuit
|
|
||||||
```
|
|
||||||
|
|
||||||
## How do I know it works?
|
|
||||||
|
|
||||||
You can open [a Matrix client](https://matrix.org/ecosystem/clients), enter your
|
|
||||||
homeserver address, and try to register.
|
|
||||||
|
|
||||||
You can also use these commands as a quick health check (replace
|
|
||||||
`your.server.name`).
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl https://your.server.name/_conduwuit/server_version
|
|
||||||
|
|
||||||
# If using port 8448
|
|
||||||
curl https://your.server.name:8448/_conduwuit/server_version
|
|
||||||
|
|
||||||
# If federation is enabled
|
|
||||||
curl https://your.server.name:8448/_matrix/federation/v1/version
|
|
||||||
```
|
|
||||||
|
|
||||||
- To check if your server can communicate with other homeservers, use the
|
|
||||||
[Matrix Federation Tester](https://federationtester.mtrnord.blog/). If you can
|
|
||||||
register but cannot join federated rooms, check your configuration and verify
|
|
||||||
that port 8448 is open and forwarded correctly.
|
|
||||||
|
|
||||||
# What's next?
|
|
||||||
|
|
||||||
## Audio/Video calls
|
|
||||||
|
|
||||||
For Audio/Video call functionality see the [Calls](../calls.md) page.
|
|
||||||
|
|
||||||
## Appservices
|
|
||||||
|
|
||||||
If you want to set up an appservice, take a look at the [Appservice
|
|
||||||
Guide](../appservices.md).
|
|
||||||
|
|
@ -1,112 +0,0 @@
|
||||||
# Continuwuity for Kubernetes
|
|
||||||
|
|
||||||
Continuwuity doesn't support horizontal scalability or distributed loading
|
|
||||||
natively. However, a deployment in Kubernetes is very similar to the docker
|
|
||||||
setup. This is because Continuwuity can be fully configured using environment
|
|
||||||
variables. A sample StatefulSet is shared below. The only thing missing is
|
|
||||||
a PVC definition (named `continuwuity-data`) for the volume mounted to
|
|
||||||
the StatefulSet, an Ingress resources to point your webserver to the
|
|
||||||
Continuwuity Pods, and a Service resource (targeting `app.kubernetes.io/name: continuwuity`)
|
|
||||||
to glue the Ingress and Pod together.
|
|
||||||
|
|
||||||
Carefully go through the `env` section and add, change, and remove any env vars you like using the [Configuration reference](https://continuwuity.org/reference/config.html)
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
apiVersion: apps/v1
|
|
||||||
kind: StatefulSet
|
|
||||||
metadata:
|
|
||||||
name: continuwuity
|
|
||||||
namespace: matrix
|
|
||||||
labels:
|
|
||||||
app.kubernetes.io/name: continuwuity
|
|
||||||
spec:
|
|
||||||
replicas: 1
|
|
||||||
serviceName: continuwuity
|
|
||||||
podManagementPolicy: Parallel
|
|
||||||
selector:
|
|
||||||
matchLabels:
|
|
||||||
app.kubernetes.io/name: continuwuity
|
|
||||||
template:
|
|
||||||
metadata:
|
|
||||||
labels:
|
|
||||||
app.kubernetes.io/name: continuwuity
|
|
||||||
spec:
|
|
||||||
securityContext:
|
|
||||||
sysctls:
|
|
||||||
- name: net.ipv4.ip_unprivileged_port_start
|
|
||||||
value: "0"
|
|
||||||
containers:
|
|
||||||
- name: continuwuity
|
|
||||||
# use a sha hash <3
|
|
||||||
image: forgejo.ellis.link/continuwuation/continuwuity:latest
|
|
||||||
command: ["/sbin/conduwuit"]
|
|
||||||
imagePullPolicy: IfNotPresent
|
|
||||||
ports:
|
|
||||||
- name: http
|
|
||||||
containerPort: 80
|
|
||||||
volumeMounts:
|
|
||||||
- mountPath: /data
|
|
||||||
name: data
|
|
||||||
subPath: data
|
|
||||||
securityContext:
|
|
||||||
capabilities:
|
|
||||||
add:
|
|
||||||
- NET_BIND_SERVICE
|
|
||||||
env:
|
|
||||||
- name: TOKIO_WORKER_THREADS
|
|
||||||
value: "2"
|
|
||||||
- name: CONTINUWUITY_SERVER_NAME
|
|
||||||
value: "example.com"
|
|
||||||
- name: CONTINUWUITY_DATABASE_PATH
|
|
||||||
value: "/data/db"
|
|
||||||
- name: CONTINUWUITY_DATABASE_BACKEND
|
|
||||||
value: "rocksdb"
|
|
||||||
- name: CONTINUWUITY_PORT
|
|
||||||
value: "80"
|
|
||||||
- name: CONTINUWUITY_MAX_REQUEST_SIZE
|
|
||||||
value: "20000000"
|
|
||||||
- name: CONTINUWUITY_ALLOW_FEDERATION
|
|
||||||
value: "true"
|
|
||||||
- name: CONTINUWUITY_TRUSTED_SERVERS
|
|
||||||
value: '["matrix.org"]'
|
|
||||||
- name: CONTINUWUITY_ADDRESS
|
|
||||||
value: "0.0.0.0"
|
|
||||||
- name: CONTINUWUITY_ROCKSDB_PARALLELISM_THREADS
|
|
||||||
value: "1"
|
|
||||||
- name: CONTINUWUITY_WELL_KNOWN__SERVER
|
|
||||||
value: "matrix.example.com:443"
|
|
||||||
- name: CONTINUWUITY_WELL_KNOWN__CLIENT
|
|
||||||
value: "https://matrix.example.com"
|
|
||||||
- name: CONTINUWUITY_ALLOW_REGISTRATION
|
|
||||||
value: "false"
|
|
||||||
- name: RUST_LOG
|
|
||||||
value: info
|
|
||||||
readinessProbe:
|
|
||||||
httpGet:
|
|
||||||
path: /_matrix/federation/v1/version
|
|
||||||
port: http
|
|
||||||
periodSeconds: 4
|
|
||||||
failureThreshold: 5
|
|
||||||
resources:
|
|
||||||
# Continuwuity might use quite some RAM :3
|
|
||||||
requests:
|
|
||||||
cpu: "2"
|
|
||||||
memory: "512Mi"
|
|
||||||
limits:
|
|
||||||
cpu: "4"
|
|
||||||
memory: "2048Mi"
|
|
||||||
volumes:
|
|
||||||
- name: data
|
|
||||||
persistentVolumeClaim:
|
|
||||||
claimName: continuwuity-data
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Apart from manually configuring the containers,
|
|
||||||
[a community-maintained Helm Chart is available here to run
|
|
||||||
conduwuit on Kubernetes](https://gitlab.cronce.io/charts/conduwuit)
|
|
||||||
|
|
||||||
This should be compatible with Continuwuity, but you will need to change the image reference.
|
|
||||||
|
|
||||||
If changes need to be made, please reach out to the maintainer, as this is not maintained or controlled by the Continuwuity maintainers.
|
|
||||||
|
|
@ -1,130 +0,0 @@
|
||||||
# Continuwuity for NixOS
|
|
||||||
|
|
||||||
NixOS packages Continuwuity as `matrix-continuwuity`. This package includes both the Continuwuity software and a dedicated NixOS module for configuration and deployment.
|
|
||||||
|
|
||||||
## Installation methods
|
|
||||||
|
|
||||||
You can acquire Continuwuity with Nix (or [Lix][lix]) from these sources:
|
|
||||||
|
|
||||||
* Directly from Nixpkgs using the official package (`pkgs.matrix-continuwuity`)
|
|
||||||
* The `flake.nix` at the root of the Continuwuity repo
|
|
||||||
* The `default.nix` at the root of the Continuwuity repo
|
|
||||||
|
|
||||||
## NixOS module
|
|
||||||
|
|
||||||
Continuwuity now has an official NixOS module that simplifies configuration and deployment. The module is available in Nixpkgs as `services.matrix-continuwuity` from NixOS 25.05.
|
|
||||||
|
|
||||||
Here's a basic example of how to use the module:
|
|
||||||
|
|
||||||
```nix
|
|
||||||
{ config, pkgs, ... }:
|
|
||||||
|
|
||||||
{
|
|
||||||
services.matrix-continuwuity = {
|
|
||||||
enable = true;
|
|
||||||
settings = {
|
|
||||||
global = {
|
|
||||||
server_name = "example.com";
|
|
||||||
# Listening on localhost by default
|
|
||||||
# address and port are handled automatically
|
|
||||||
allow_registration = false;
|
|
||||||
allow_encryption = true;
|
|
||||||
allow_federation = true;
|
|
||||||
trusted_servers = [ "matrix.org" ];
|
|
||||||
};
|
|
||||||
};
|
|
||||||
};
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Available options
|
|
||||||
|
|
||||||
The NixOS module provides these configuration options:
|
|
||||||
|
|
||||||
- `enable`: Enable the Continuwuity service
|
|
||||||
- `user`: The user to run Continuwuity as (defaults to "continuwuity")
|
|
||||||
- `group`: The group to run Continuwuity as (defaults to "continuwuity")
|
|
||||||
- `extraEnvironment`: Extra environment variables to pass to the Continuwuity server
|
|
||||||
- `package`: The Continuwuity package to use
|
|
||||||
- `settings`: The Continuwuity configuration (in TOML format)
|
|
||||||
|
|
||||||
Use the `settings` option to configure Continuwuity itself. See the [example configuration file](../reference/config.mdx) for all available options.
|
|
||||||
|
|
||||||
### UNIX sockets
|
|
||||||
|
|
||||||
The NixOS module natively supports UNIX sockets through the `global.unix_socket_path` option. When using UNIX sockets, set `global.address` to `null`:
|
|
||||||
|
|
||||||
```nix
|
|
||||||
services.matrix-continuwuity = {
|
|
||||||
enable = true;
|
|
||||||
settings = {
|
|
||||||
global = {
|
|
||||||
server_name = "example.com";
|
|
||||||
address = null; # Must be null when using unix_socket_path
|
|
||||||
unix_socket_path = "/run/continuwuity/continuwuity.sock";
|
|
||||||
unix_socket_perms = 660; # Default permissions for the socket
|
|
||||||
# ...
|
|
||||||
};
|
|
||||||
};
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
The module automatically sets the correct `RestrictAddressFamilies` in the systemd service configuration to allow access to UNIX sockets.
|
|
||||||
|
|
||||||
### RocksDB database
|
|
||||||
|
|
||||||
Continuwuity exclusively uses RocksDB as its database backend. The system configures the database path automatically to `/var/lib/continuwuity/` and you cannot change it due to the service's reliance on systemd's StateDir.
|
|
||||||
|
|
||||||
If you're migrating from Conduit with SQLite, use this [tool to migrate a Conduit SQLite database to RocksDB](https://github.com/ShadowJonathan/conduit_toolbox/).
|
|
||||||
|
|
||||||
### jemalloc and hardened profile
|
|
||||||
|
|
||||||
Continuwuity uses jemalloc by default. This may interfere with the [`hardened.nix` profile][hardened.nix] because it uses `scudo` by default. Either disable/hide `scudo` from Continuwuity or disable jemalloc like this:
|
|
||||||
|
|
||||||
```nix
|
|
||||||
services.matrix-continuwuity = {
|
|
||||||
enable = true;
|
|
||||||
package = pkgs.matrix-continuwuity.override {
|
|
||||||
enableJemalloc = false;
|
|
||||||
};
|
|
||||||
# ...
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Upgrading from Conduit
|
|
||||||
|
|
||||||
If you previously used Conduit with the `services.matrix-conduit` module:
|
|
||||||
|
|
||||||
1. Ensure your Conduit uses the RocksDB backend, or migrate from SQLite using the [migration tool](https://github.com/ShadowJonathan/conduit_toolbox/)
|
|
||||||
2. Switch to the new module by changing `services.matrix-conduit` to `services.matrix-continuwuity` in your configuration
|
|
||||||
3. Update any custom configuration to match the new module's structure
|
|
||||||
|
|
||||||
## Reverse proxy configuration
|
|
||||||
|
|
||||||
You'll need to set up a reverse proxy (like nginx or caddy) to expose Continuwuity to the internet. Configure your reverse proxy to forward requests to `/_matrix` on port 443 and 8448 to your Continuwuity instance.
|
|
||||||
|
|
||||||
Here's an example nginx configuration:
|
|
||||||
|
|
||||||
```nginx
|
|
||||||
server {
|
|
||||||
listen 443 ssl;
|
|
||||||
listen [::]:443 ssl;
|
|
||||||
listen 8448 ssl;
|
|
||||||
listen [::]:8448 ssl;
|
|
||||||
|
|
||||||
server_name example.com;
|
|
||||||
|
|
||||||
# SSL configuration here...
|
|
||||||
|
|
||||||
location /_matrix/ {
|
|
||||||
proxy_pass http://127.0.0.1:6167$request_uri;
|
|
||||||
proxy_set_header Host $host;
|
|
||||||
proxy_set_header X-Real-IP $remote_addr;
|
|
||||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
|
||||||
proxy_set_header X-Forwarded-Proto $scheme;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
[lix]: https://lix.systems/
|
|
||||||
[hardened.nix]: https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/profiles/hardened.nix
|
|
||||||
|
|
@ -1,27 +0,0 @@
|
||||||
[
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "index",
|
|
||||||
"label": "Development Guide"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "contributing",
|
|
||||||
"label": "Contributing"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "code_style",
|
|
||||||
"label": "Code Style Guide"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "testing",
|
|
||||||
"label": "Testing"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "file",
|
|
||||||
"name": "hot_reload",
|
|
||||||
"label": "Hot Reloading"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 76 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 61 KiB |
|
|
@ -1,331 +0,0 @@
|
||||||
# Code Style Guide
|
|
||||||
|
|
||||||
This guide outlines the coding standards and best practices for Continuwuity development. These guidelines help avoid bugs and maintain code consistency, readability, and quality across the project.
|
|
||||||
|
|
||||||
These guidelines apply to new code on a best-effort basis. When modifying existing code, follow existing patterns in the immediate area you're changing and then gradually improve code style when making substantial changes.
|
|
||||||
|
|
||||||
## General Principles
|
|
||||||
|
|
||||||
- **Clarity over cleverness**: Write code that is easy to understand and maintain
|
|
||||||
- **Consistency**: Pragmatically follow existing patterns in the codebase, rather than adding new dependencies.
|
|
||||||
- **Safety**: Prefer safe, explicit code over unsafe code with implicit requirements
|
|
||||||
- **Performance**: Consider performance implications, but not at the expense of correctness or maintainability
|
|
||||||
|
|
||||||
## Formatting and Linting
|
|
||||||
|
|
||||||
All code must satisfy lints (clippy, rustc, rustdoc, etc) and be formatted using **nightly** rustfmt (`cargo +nightly fmt`). Many of the `rustfmt.toml` features depend on the nightly toolchain.
|
|
||||||
|
|
||||||
If you need to allow a lint, ensure it's either obvious why (e.g. clippy saying redundant clone but it's actually required) or add a comment explaining the reason. Do not write inefficient code just to satisfy lints. If a lint is wrong and provides a less efficient solution, allow the lint and mention that in a comment.
|
|
||||||
|
|
||||||
If making large formatting changes across unrelated files, create a separate commit so it can be added to the `.git-blame-ignore-revs` file.
|
|
||||||
|
|
||||||
## Rust-Specific Guidelines
|
|
||||||
|
|
||||||
### Naming Conventions
|
|
||||||
|
|
||||||
Follow standard Rust naming conventions as outlined in the [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/naming.html):
|
|
||||||
|
|
||||||
- Use `snake_case` for functions, variables, and modules
|
|
||||||
- Use `PascalCase` for types, traits, and enum variants
|
|
||||||
- Use `SCREAMING_SNAKE_CASE` for constants and statics
|
|
||||||
- Use descriptive names that clearly indicate purpose
|
|
||||||
|
|
||||||
```rs
|
|
||||||
// Good
|
|
||||||
fn process_user_request(user_id: &UserId) -> Result<Response, Error> { ... }
|
|
||||||
|
|
||||||
const MAX_RETRY_ATTEMPTS: usize = 3;
|
|
||||||
|
|
||||||
struct UserSession {
|
|
||||||
session_id: String,
|
|
||||||
created_at: SystemTime,
|
|
||||||
}
|
|
||||||
|
|
||||||
// Avoid
|
|
||||||
fn proc_reqw(id: &str) -> Result<Resp, Err> { ... }
|
|
||||||
```
|
|
||||||
|
|
||||||
### Error Handling
|
|
||||||
|
|
||||||
- Use `Result<T, E>` for operations that can fail
|
|
||||||
- Prefer specific error types over generic ones
|
|
||||||
- Use `?` operator for error propagation
|
|
||||||
- Provide meaningful error messages
|
|
||||||
- If needed, create or use an error enum.
|
|
||||||
|
|
||||||
```rs
|
|
||||||
// Good
|
|
||||||
fn parse_server_name(input: &str) -> Result<ServerName, InvalidServerNameError> {
|
|
||||||
ServerName::parse(input)
|
|
||||||
.map_err(|_| InvalidServerNameError::new(input))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Avoid
|
|
||||||
fn parse_server_name(input: &str) -> Result<ServerName, Box<dyn Error>> {
|
|
||||||
Ok(ServerName::parse(input).unwrap())
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Option Handling
|
|
||||||
|
|
||||||
- Prefer explicit `Option` handling over unwrapping
|
|
||||||
- Use combinators like `map`, `and_then`, `unwrap_or_else` when appropriate
|
|
||||||
|
|
||||||
```rs
|
|
||||||
// Good
|
|
||||||
let display_name = user.display_name
|
|
||||||
.as_ref()
|
|
||||||
.map(|name| name.trim())
|
|
||||||
.filter(|name| !name.is_empty())
|
|
||||||
.unwrap_or(&user.localpart);
|
|
||||||
|
|
||||||
// Avoid
|
|
||||||
let display_name = if user.display_name.is_some() {
|
|
||||||
user.display_name.as_ref().unwrap()
|
|
||||||
} else {
|
|
||||||
&user.localpart
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Logging Guidelines
|
|
||||||
|
|
||||||
### Structured Logging
|
|
||||||
|
|
||||||
**Always use structured logging instead of string interpolation.** This improves log parsing, filtering, and observability.
|
|
||||||
|
|
||||||
```rs
|
|
||||||
// Good - structured parameters
|
|
||||||
debug!(
|
|
||||||
room_id = %room_id,
|
|
||||||
user_id = %user_id,
|
|
||||||
event_type = ?event.event_type(),
|
|
||||||
"Processing room event"
|
|
||||||
);
|
|
||||||
|
|
||||||
info!(
|
|
||||||
server_name = %server_name,
|
|
||||||
response_time_ms = response_time.as_millis(),
|
|
||||||
"Federation request completed successfully"
|
|
||||||
);
|
|
||||||
|
|
||||||
// Avoid - string interpolation
|
|
||||||
debug!("Processing room event for {room_id} from {user_id}");
|
|
||||||
info!("Federation request to {server_name} took {response_time:?}");
|
|
||||||
```
|
|
||||||
|
|
||||||
### Log Levels
|
|
||||||
|
|
||||||
Use appropriate log levels:
|
|
||||||
|
|
||||||
- `error!`: Unrecoverable errors that affect functionality
|
|
||||||
- `warn!`: Potentially problematic situations that don't stop execution
|
|
||||||
- `info!`: General information about application flow
|
|
||||||
- `debug!`: Detailed information for debugging
|
|
||||||
- `trace!`: Very detailed information, typically only useful during development
|
|
||||||
|
|
||||||
Keep in mind the frequency that the log will be reached, and the relevancy to a server operator.
|
|
||||||
|
|
||||||
```rs
|
|
||||||
// Good
|
|
||||||
error!(
|
|
||||||
error = ?err,
|
|
||||||
room_id = %room_id,
|
|
||||||
"Failed to send event to room"
|
|
||||||
);
|
|
||||||
|
|
||||||
warn!(
|
|
||||||
server_name = %server_name,
|
|
||||||
attempt = retry_count,
|
|
||||||
"Federation request failed, retrying"
|
|
||||||
);
|
|
||||||
|
|
||||||
info!(
|
|
||||||
user_id = %user_id,
|
|
||||||
"User registered successfully"
|
|
||||||
);
|
|
||||||
|
|
||||||
debug!(
|
|
||||||
event_id = %event_id,
|
|
||||||
auth_events = ?auth_event_ids,
|
|
||||||
"Validating event authorization"
|
|
||||||
);
|
|
||||||
```
|
|
||||||
|
|
||||||
### Sensitive Information
|
|
||||||
|
|
||||||
Never log sensitive information such as:
|
|
||||||
- Access tokens
|
|
||||||
- Passwords
|
|
||||||
- Private keys
|
|
||||||
- Personal user data (unless specifically needed for debugging)
|
|
||||||
|
|
||||||
```rs
|
|
||||||
// Good
|
|
||||||
debug!(
|
|
||||||
user_id = %user_id,
|
|
||||||
session_id = %session_id,
|
|
||||||
"Processing authenticated request"
|
|
||||||
);
|
|
||||||
|
|
||||||
// Avoid
|
|
||||||
debug!(
|
|
||||||
user_id = %user_id,
|
|
||||||
access_token = %access_token,
|
|
||||||
"Processing authenticated request"
|
|
||||||
);
|
|
||||||
```
|
|
||||||
|
|
||||||
## Lock Management
|
|
||||||
|
|
||||||
### Explicit Lock Scopes
|
|
||||||
|
|
||||||
**Always use closure guards instead of implicitly dropped guards.** This makes lock scopes explicit and helps prevent deadlocks.
|
|
||||||
|
|
||||||
Use the `WithLock` trait from `core::utils::with_lock`:
|
|
||||||
|
|
||||||
```rs
|
|
||||||
use conduwuit::utils::with_lock::WithLock;
|
|
||||||
|
|
||||||
// Good - explicit closure guard
|
|
||||||
shared_data.with_lock(|data| {
|
|
||||||
data.counter += 1;
|
|
||||||
data.last_updated = SystemTime::now();
|
|
||||||
// Lock is explicitly released here
|
|
||||||
});
|
|
||||||
|
|
||||||
// Avoid - implicit guard
|
|
||||||
{
|
|
||||||
let mut data = shared_data.lock().unwrap();
|
|
||||||
data.counter += 1;
|
|
||||||
data.last_updated = SystemTime::now();
|
|
||||||
// Lock released when guard goes out of scope - less explicit
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
For async contexts, use the async variant:
|
|
||||||
|
|
||||||
```rs
|
|
||||||
use conduwuit::utils::with_lock::WithLockAsync;
|
|
||||||
|
|
||||||
// Good - async closure guard
|
|
||||||
async_shared_data.with_lock(|data| {
|
|
||||||
data.process_async_update();
|
|
||||||
}).await;
|
|
||||||
```
|
|
||||||
|
|
||||||
### Lock Ordering
|
|
||||||
|
|
||||||
When acquiring multiple locks, always acquire them in a consistent order to prevent deadlocks:
|
|
||||||
|
|
||||||
```rs
|
|
||||||
// Good - consistent ordering (e.g., by memory address or logical hierarchy)
|
|
||||||
let locks = [&lock_a, &lock_b, &lock_c];
|
|
||||||
locks.sort_by_key(|lock| lock as *const _ as usize);
|
|
||||||
|
|
||||||
for lock in locks {
|
|
||||||
lock.with_lock(|data| {
|
|
||||||
// Process data
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// Avoid - inconsistent ordering that can cause deadlocks
|
|
||||||
lock_b.with_lock(|data_b| {
|
|
||||||
lock_a.with_lock(|data_a| {
|
|
||||||
// Deadlock risk if another thread acquires in A->B order
|
|
||||||
});
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
### Code Comments
|
|
||||||
|
|
||||||
- Reference related documentation or parts of the specification
|
|
||||||
- When a task has multiple ways of being achieved, explain your reasoning for your decision
|
|
||||||
- Update comments when code changes
|
|
||||||
|
|
||||||
```rs
|
|
||||||
/// Processes a federation request with automatic retries and backoff.
|
|
||||||
///
|
|
||||||
/// Implements exponential backoff to handle temporary
|
|
||||||
/// network issues and server overload gracefully.
|
|
||||||
pub async fn send_federation_request(
|
|
||||||
destination: &ServerName,
|
|
||||||
request: FederationRequest,
|
|
||||||
) -> Result<FederationResponse, FederationError> {
|
|
||||||
// Retry with exponential backoff because federation can be flaky
|
|
||||||
// due to network issues or temporary server overload
|
|
||||||
let mut retry_delay = Duration::from_millis(100);
|
|
||||||
|
|
||||||
for attempt in 1..=MAX_RETRIES {
|
|
||||||
match try_send_request(destination, &request).await {
|
|
||||||
Ok(response) => return Ok(response),
|
|
||||||
Err(err) if err.is_retriable() && attempt < MAX_RETRIES => {
|
|
||||||
warn!(
|
|
||||||
destination = %destination,
|
|
||||||
attempt = attempt,
|
|
||||||
error = ?err,
|
|
||||||
retry_delay_ms = retry_delay.as_millis(),
|
|
||||||
"Federation request failed, retrying"
|
|
||||||
);
|
|
||||||
|
|
||||||
tokio::time::sleep(retry_delay).await;
|
|
||||||
retry_delay *= 2; // Exponential backoff
|
|
||||||
}
|
|
||||||
Err(err) => return Err(err),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
unreachable!("Loop should have returned or failed by now")
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Async Patterns
|
|
||||||
|
|
||||||
- Use `async`/`await` appropriately
|
|
||||||
- Avoid blocking operations in async contexts
|
|
||||||
- Consider using `tokio::task::spawn_blocking` for CPU-intensive work
|
|
||||||
|
|
||||||
```rs
|
|
||||||
// Good - non-blocking async operation
|
|
||||||
pub async fn fetch_user_profile(
|
|
||||||
&self,
|
|
||||||
user_id: &UserId,
|
|
||||||
) -> Result<UserProfile, Error> {
|
|
||||||
let profile = self.db
|
|
||||||
.get_user_profile(user_id)
|
|
||||||
.await?;
|
|
||||||
|
|
||||||
Ok(profile)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Good - CPU-intensive work moved to blocking thread
|
|
||||||
pub async fn generate_thumbnail(
|
|
||||||
&self,
|
|
||||||
image_data: Vec<u8>,
|
|
||||||
) -> Result<Vec<u8>, Error> {
|
|
||||||
tokio::task::spawn_blocking(move || {
|
|
||||||
image::generate_thumbnail(image_data)
|
|
||||||
})
|
|
||||||
.await
|
|
||||||
.map_err(|_| Error::TaskJoinError)?
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Inclusivity and Diversity Guidelines
|
|
||||||
|
|
||||||
All code and documentation must be written with inclusivity and diversity in mind. This ensures our software is welcoming and accessible to all users and contributors. Follow the [Google guide on writing inclusive code and documentation](https://developers.google.com/style/inclusive-documentation) for comprehensive guidance.
|
|
||||||
|
|
||||||
The following types of language are explicitly forbidden in all code, comments, documentation, and commit messages:
|
|
||||||
|
|
||||||
**Ableist language:** Avoid terms like "sanity check", "crazy", "insane", "cripple", or "blind to". Use alternatives like "validation", "unexpected", "disable", or "unaware of".
|
|
||||||
|
|
||||||
**Socially-charged technical terms:** Replace overly divisive terminology with neutral alternatives:
|
|
||||||
- "whitelist/blacklist" → "allowlist/denylist" or "permitted/blocked"
|
|
||||||
- "master/slave" → "primary/replica", "controller/worker", or "parent/child"
|
|
||||||
|
|
||||||
When working with external dependencies that use non-inclusive terminology, avoid propagating them in your own APIs and variable names.
|
|
||||||
|
|
||||||
Use diverse examples in documentation that avoid culturally-specific references, assumptions about user demographics, or unnecessarily gendered language. Design with accessibility and inclusivity in mind by providing clear error messages and considering diverse user needs.
|
|
||||||
|
|
||||||
This software is intended to be used by everyone regardless of background, identity, or ability. Write code and documentation that reflects this commitment to inclusivity.
|
|
||||||
|
|
@ -1,203 +0,0 @@
|
||||||
# Contributing guide
|
|
||||||
|
|
||||||
This page is about contributing to Continuwuity. The
|
|
||||||
[development](./index.mdx) and [code style guide](./code_style.mdx) pages 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 [#continuwuity:continuwuity.org][continuwuity-matrix],
|
|
||||||
and comment on it.
|
|
||||||
|
|
||||||
### Code Style
|
|
||||||
|
|
||||||
Please review and follow the [code style guide](./code_style) for formatting, linting, naming conventions, and other code standards.
|
|
||||||
|
|
||||||
### Pre-commit Checks
|
|
||||||
|
|
||||||
Continuwuity uses pre-commit hooks to enforce various coding standards and catch common issues before they're committed. These checks include:
|
|
||||||
|
|
||||||
- Code formatting and linting
|
|
||||||
- Typo detection (both in code and commit messages)
|
|
||||||
- Checking for large files
|
|
||||||
- Ensuring proper line endings and no trailing whitespace
|
|
||||||
- Validating YAML, JSON, and TOML files
|
|
||||||
- Checking for merge conflicts
|
|
||||||
|
|
||||||
You can run these checks locally by installing [prefligit](https://github.com/j178/prefligit):
|
|
||||||
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Requires UV: https://docs.astral.sh/uv/getting-started/installation/
|
|
||||||
# Mac/linux: curl -LsSf https://astral.sh/uv/install.sh | sh
|
|
||||||
# Windows: powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
|
|
||||||
|
|
||||||
# Install prefligit using cargo-binstall
|
|
||||||
cargo binstall prefligit
|
|
||||||
|
|
||||||
# Install git hooks to run checks automatically
|
|
||||||
prefligit install
|
|
||||||
|
|
||||||
# Run all checks
|
|
||||||
prefligit --all-files
|
|
||||||
```
|
|
||||||
|
|
||||||
Alternatively, you can use [pre-commit](https://pre-commit.com/):
|
|
||||||
```bash
|
|
||||||
# Requires python
|
|
||||||
|
|
||||||
# Install pre-commit
|
|
||||||
pip install pre-commit
|
|
||||||
|
|
||||||
# Install the hooks
|
|
||||||
pre-commit install
|
|
||||||
|
|
||||||
# Run all checks manually
|
|
||||||
pre-commit run --all-files
|
|
||||||
```
|
|
||||||
|
|
||||||
These same checks are run in CI via the prefligit-checks workflow to ensure consistency. These must pass before the PR is merged.
|
|
||||||
|
|
||||||
### Running tests locally
|
|
||||||
|
|
||||||
Tests, compilation, and linting can be run with standard Cargo commands:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Run tests
|
|
||||||
cargo test
|
|
||||||
|
|
||||||
# Check compilation
|
|
||||||
cargo check --workspace --features full
|
|
||||||
|
|
||||||
# Run lints
|
|
||||||
cargo clippy --workspace --features full
|
|
||||||
# Auto-fix: cargo clippy --workspace --features full --fix --allow-staged;
|
|
||||||
|
|
||||||
# Format code (must use nightly)
|
|
||||||
cargo +nightly fmt
|
|
||||||
```
|
|
||||||
|
|
||||||
### Matrix tests
|
|
||||||
|
|
||||||
Continuwuity uses [Complement][complement] for Matrix protocol compliance testing. Complement tests are run manually by developers, and documentation on how to run these tests locally is currently being developed.
|
|
||||||
|
|
||||||
If your changes are done to fix Matrix tests, please note that in your pull request. If more Complement tests start failing from your changes, please review the logs and determine if they're intended or not.
|
|
||||||
|
|
||||||
[Sytest][sytest] is currently unsupported.
|
|
||||||
|
|
||||||
### Writing documentation
|
|
||||||
|
|
||||||
Continuwuity's website uses [`mdbook`][mdbook] and is deployed via CI using Cloudflare Pages
|
|
||||||
in the [`documentation.yml`][documentation.yml] workflow file. All documentation is in the `docs/`
|
|
||||||
directory at the top level.
|
|
||||||
|
|
||||||
To build the documentation locally:
|
|
||||||
|
|
||||||
1. Install mdbook if you don't have it already:
|
|
||||||
```bash
|
|
||||||
cargo install mdbook # or cargo binstall, or another method
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Build the documentation:
|
|
||||||
```bash
|
|
||||||
mdbook build
|
|
||||||
```
|
|
||||||
|
|
||||||
The output of the mdbook generation is in `public/`. You can open the HTML files directly in your browser without needing a web server.
|
|
||||||
|
|
||||||
|
|
||||||
### Commit Messages
|
|
||||||
|
|
||||||
Continuwuity follows the [Conventional Commits](https://www.conventionalcommits.org/) specification for commit messages. This provides a standardized format that makes the commit history more readable and enables automated tools to generate changelogs.
|
|
||||||
|
|
||||||
The basic structure is:
|
|
||||||
|
|
||||||
```
|
|
||||||
<type>[(optional scope)]: <description>
|
|
||||||
|
|
||||||
[optional body]
|
|
||||||
|
|
||||||
[optional footer(s)]
|
|
||||||
```
|
|
||||||
|
|
||||||
The allowed types for commits are:
|
|
||||||
- `fix`: Bug fixes
|
|
||||||
- `feat`: New features
|
|
||||||
- `docs`: Documentation changes
|
|
||||||
- `style`: Changes that don't affect the meaning of the code (formatting, etc.)
|
|
||||||
- `refactor`: Code changes that neither fix bugs nor add features
|
|
||||||
- `perf`: Performance improvements
|
|
||||||
- `test`: Adding or fixing tests
|
|
||||||
- `build`: Changes to the build system or dependencies
|
|
||||||
- `ci`: Changes to CI configuration
|
|
||||||
- `chore`: Other changes that don't modify source or test files
|
|
||||||
|
|
||||||
Examples:
|
|
||||||
```
|
|
||||||
feat: add user authentication
|
|
||||||
fix(database): resolve connection pooling issue
|
|
||||||
docs: update installation instructions
|
|
||||||
```
|
|
||||||
|
|
||||||
The project uses the `committed` hook to validate commit messages in pre-commit. This ensures all commits follow the conventional format.
|
|
||||||
|
|
||||||
### Creating pull requests
|
|
||||||
|
|
||||||
Please try to keep contributions to the Forgejo Instance. While the mirrors of continuwuity
|
|
||||||
allow for pull/merge requests, there is no guarantee the maintainers will see them in a timely
|
|
||||||
manner. Additionally, please mark WIP or unfinished or incomplete PRs as drafts.
|
|
||||||
This prevents us from having to ping once in a while to double check the status
|
|
||||||
of it, especially when the CI completed successfully and everything so it
|
|
||||||
*looks* done.
|
|
||||||
|
|
||||||
Before submitting a pull request, please ensure:
|
|
||||||
1. Your code passes all CI checks (formatting, linting, typo detection, etc.). Run pre-commit for this.
|
|
||||||
2. Your code follows the [code style guide](./code_style)
|
|
||||||
3. Your commit messages follow the conventional commits format
|
|
||||||
4. Tests are added for new functionality
|
|
||||||
5. Documentation is updated if needed
|
|
||||||
6. You have written a [news fragment](#writing-news-fragments) for your changes
|
|
||||||
|
|
||||||
Direct all PRs/MRs to the `main` branch.
|
|
||||||
|
|
||||||
By sending a pull request or patch, you are agreeing that your changes are
|
|
||||||
allowed to be licenced under the Apache-2.0 licence and all of your conduct is
|
|
||||||
in line with the Contributor's Covenant, and continuwuity's Code of Conduct.
|
|
||||||
|
|
||||||
Contribution by users who violate either of these code of conducts may not have
|
|
||||||
their contributions accepted. This includes users who have been banned from
|
|
||||||
continuwuity Matrix rooms for Code of Conduct violations.
|
|
||||||
|
|
||||||
[issues]: https://forgejo.ellis.link/continuwuation/continuwuity/issues
|
|
||||||
[continuwuity-matrix]: https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org
|
|
||||||
[complement]: https://github.com/matrix-org/complement/
|
|
||||||
[sytest]: https://github.com/matrix-org/sytest/
|
|
||||||
[mdbook]: https://rust-lang.github.io/mdBook/
|
|
||||||
[documentation.yml]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/.forgejo/workflows/documentation.yml
|
|
||||||
|
|
||||||
#### Writing news fragments
|
|
||||||
|
|
||||||
In order to make writing our changelogs easier, we make use of [Towncrier]. Towncrier builds changelogs based on
|
|
||||||
"news fragments", which are little markdown files in the `changelog.d/` directory that describe individual changes.
|
|
||||||
|
|
||||||
When you make a pull request that changes functionality, fixes a bug, or adds documentation, please add a news fragment
|
|
||||||
describing your change. The file name *MUST* be in the format of `{pull_request_number}.{type}`, where `{type}` is one
|
|
||||||
of the following:
|
|
||||||
|
|
||||||
- `feature` - for new features
|
|
||||||
- `bugfix` - for bug fixes
|
|
||||||
- `doc` - for documentation changes
|
|
||||||
- `misc` - for other changes that don't fit the above categories
|
|
||||||
|
|
||||||
For example:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ echo "Fixed the quantum flux stabiliser. Contributed by @alice." > changelog.d/42.bugfix
|
|
||||||
```
|
|
||||||
|
|
||||||
(Note: If you want to credit yourself, you should reference your forgejo handle, however links to other platforms are also acceptable.)
|
|
||||||
|
|
||||||
When the next release is made, Towncrier will automatically include your news fragment in the changelog.
|
|
||||||
|
|
||||||
You can read more about writing news fragments in the [Towncrier tutorial][tt].
|
|
||||||
|
|
||||||
[Towncrier]: https://towncrier.readthedocs.io/
|
|
||||||
[tt]: https://towncrier.readthedocs.io/en/stable/tutorial.html#creating-news-fragments
|
|
||||||
|
|
@ -1,200 +0,0 @@
|
||||||
# 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, Continuwuity is modular
|
|
||||||
using dynamic libraries and various parts of the application are hot-reloadable
|
|
||||||
while the server is running: http api handlers, admin commands, services,
|
|
||||||
database, etc. These are all split up into individual workspace crates as seen
|
|
||||||
in the `src/` directory. Changes to sourcecode in a crate rebuild that crate and
|
|
||||||
subsequent crates depending on it. Reloading then occurs for the changed crates.
|
|
||||||
|
|
||||||
Release builds still produce static binaries which are unaffected. Rust's
|
|
||||||
soundness guarantees are in full force. Thus you cannot hot-reload release
|
|
||||||
binaries.
|
|
||||||
|
|
||||||
### Requirements
|
|
||||||
|
|
||||||
Currently, this development setup only works on x86_64 and aarch64 Linux glibc.
|
|
||||||
[musl explicitly does not support hot reloadable libraries, and does not
|
|
||||||
implement `dlclose`][2]. macOS does not fully support our usage of `RTLD_GLOBAL`
|
|
||||||
possibly due to some thread-local issues. [This Rust issue][3] may be of
|
|
||||||
relevance, specifically [this comment][4]. It may be possible to get it working
|
|
||||||
on only very modern macOS versions such as at least Sonoma, as currently loading
|
|
||||||
dylibs is supported, but not unloading them in our setup, and the cited comment
|
|
||||||
mentions an Apple WWDC confirming there have been TLS changes to somewhat make
|
|
||||||
this possible.
|
|
||||||
|
|
||||||
As mentioned above this requires the nightly toolchain. This is due to reliance
|
|
||||||
on various Cargo.toml features that are only available on nightly, most
|
|
||||||
specifically `RUSTFLAGS` in Cargo.toml. Some of the implementation could also be
|
|
||||||
simpler based on other various nightly features. We hope lots of nightly
|
|
||||||
features start making it out of nightly sooner as there have been dozens of very
|
|
||||||
helpful features that have been stuck in nightly ("unstable") for at least 5+
|
|
||||||
years that would make this simpler. We encourage greater community consensus to
|
|
||||||
move these features into stability.
|
|
||||||
|
|
||||||
This currently only works on x86_64/aarch64 Linux with a glibc C library. musl C
|
|
||||||
library, macOS, and likely other host architectures are not supported (if other
|
|
||||||
architectures work, feel free to let us know and/or make a PR updating this).
|
|
||||||
This should work on GNU ld and lld (rust-lld) and gcc/clang, however if you
|
|
||||||
happen to have linker issues it's recommended to try using `mold` or `gold`
|
|
||||||
linkers, and please let us know in the [Continuwuity Matrix room][7] the linker
|
|
||||||
error and what linker solved this issue so we can figure out a solution. Ideally
|
|
||||||
there should be minimal friction to using this, and in the future a build script
|
|
||||||
(`build.rs`) may be suitable to making this easier to use if the capabilities
|
|
||||||
allow us.
|
|
||||||
|
|
||||||
### Usage
|
|
||||||
|
|
||||||
As of 19 May 2024, the instructions for using this are:
|
|
||||||
|
|
||||||
0. Have patience. Don't hesitate to join the [Continuwuity 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 Continuwuity directory, or use `cargo
|
|
||||||
+nightly` for all actions.
|
|
||||||
|
|
||||||
2. Uncomment `cargo-features` at the top level / root Cargo.toml
|
|
||||||
|
|
||||||
3. Scroll down to the `# Developer profile` section and uncomment ALL the
|
|
||||||
rustflags for each dev profile and their respective packages.
|
|
||||||
|
|
||||||
4. In each workspace crate's Cargo.toml (everything under `src/*` AND
|
|
||||||
`deps/rust-rocksdb/Cargo.toml`), uncomment the `dylib` crate type under
|
|
||||||
`[lib]`.
|
|
||||||
|
|
||||||
5. Due to [this rpath issue][5], you must export the `LD_LIBRARY_PATH`
|
|
||||||
environment variable to your nightly Rust toolchain library directory. If
|
|
||||||
using rustup (hopefully), use this: `export
|
|
||||||
LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$HOME/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/`
|
|
||||||
|
|
||||||
6. Start the server. You can use `cargo +nightly run` for this along with the
|
|
||||||
standard.
|
|
||||||
|
|
||||||
7. Make some changes where you need to.
|
|
||||||
|
|
||||||
8. In a separate terminal window in the same directory (or using a terminal
|
|
||||||
multiplexer like tmux), run the *build* Cargo command `cargo +nightly build`.
|
|
||||||
Cargo should only rebuild what was changed / what's necessary, so it should
|
|
||||||
not be rebuilding all the crates.
|
|
||||||
|
|
||||||
9. In your Continuwuity server terminal, hit/send `CTRL+C` signal. This will tell
|
|
||||||
Continuwuity 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 Continuwuity in this setup, hit/send `CTRL+\`. Normal builds still
|
|
||||||
shutdown with `CTRL+C` as usual.
|
|
||||||
|
|
||||||
Steps 1 - 5 are the initial first-time steps for using this. To remove the hot
|
|
||||||
reload setup, revert/comment all the Cargo.toml changes.
|
|
||||||
|
|
||||||
As mentioned in the requirements section, if you happen to have some linker
|
|
||||||
issues, try using the `-fuse-ld=` rustflag and specify mold or gold in all the
|
|
||||||
`rustflags` definitions in the top level Cargo.toml, and please let us know in
|
|
||||||
the [Continuwuity Matrix room][7] the problem. mold can be installed typically
|
|
||||||
through your distro, and gold is provided by the binutils package.
|
|
||||||
|
|
||||||
It's possible a helper script can be made to do all of this, or most preferably
|
|
||||||
a specially made build script (build.rs). `cargo watch` support will be
|
|
||||||
implemented soon which will eliminate the need to manually run `cargo build` all
|
|
||||||
together.
|
|
||||||
|
|
||||||
### Addendum
|
|
||||||
|
|
||||||
Conduit was inherited as a single crate without modularity or reloading in its
|
|
||||||
design. Reasonable partitioning and abstraction allowed a split into several
|
|
||||||
crates, though many circular dependencies had to be corrected. The resulting
|
|
||||||
crates now form a directed graph as depicted in figures below. The interfacing
|
|
||||||
between these crates is still extremely broad which is not mitigable.
|
|
||||||
|
|
||||||
Initially [hot_lib_reload][6] was investigated but found appropriate for a
|
|
||||||
project designed with modularity through limited interfaces, not a large and
|
|
||||||
complex existing codebase. Instead a bespoke solution built directly on
|
|
||||||
[libloading][8] satisfied our constraints. This required relatively minimal
|
|
||||||
modifications and zero maintenance burden compared to what would be required
|
|
||||||
otherwise. The technical difference lies with relocation processing: we leverage
|
|
||||||
global bindings (`RTLD_GLOBAL`) in a very intentional way. Most libraries and
|
|
||||||
off-the-shelf module systems (such as [hot_lib_reload][6]) restrict themselves
|
|
||||||
to local bindings (`RTLD_LOCAL`). This allows them to release software to
|
|
||||||
multiple platforms with much greater consistency, but at the cost of burdening
|
|
||||||
applications to explicitly manage these bindings. In our case with an optional
|
|
||||||
feature for developers, we shrug any such requirement to enjoy the cost/benefit
|
|
||||||
on platforms where global relocations are properly cooperative.
|
|
||||||
|
|
||||||
To make use of `RTLD_GLOBAL` the application has to be oriented as a directed
|
|
||||||
acyclic graph. The primary rule is simple and illustrated in the figure below:
|
|
||||||
**no crate is allowed to call a function or use a variable from a crate below
|
|
||||||
it.**
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
When a symbol is referenced between crates they become bound: **crates cannot be
|
|
||||||
unloaded until their calling crates are first unloaded.** Thus we start the
|
|
||||||
reloading process from the crate which has no callers. There is a small problem
|
|
||||||
though: the first crate is called by the base executable itself! This is solved
|
|
||||||
by using an `RTLD_LOCAL` binding for just one link between the main executable
|
|
||||||
and the first crate, freeing the executable from all modules as no global
|
|
||||||
binding ever occurs between them.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
Proper resource management is essential for reliable reloading to occur. This is
|
|
||||||
a very basic ask in RAII-idiomatic Rust and the exposure to reloading hazards is
|
|
||||||
remarkably low, generally stemming from poor patterns and practices.
|
|
||||||
Unfortunately static analysis doesn't enforce reload-safety programmatically
|
|
||||||
(though it could one day), for now hazards can be avoided by knowing a few basic
|
|
||||||
do's and dont's:
|
|
||||||
|
|
||||||
1. Understand that code is memory. Just like one is forbidden from referencing
|
|
||||||
free'd memory, one must not transfer control to free'd code. Exposure to this
|
|
||||||
is primarily from two things:
|
|
||||||
|
|
||||||
- Callbacks, which this project makes very little use of.
|
|
||||||
- Async tasks, which are addressed below.
|
|
||||||
|
|
||||||
2. Tie all resources to a scope or object lifetime with greatest possible
|
|
||||||
symmetry (locality). For our purposes this applies to code resources, which
|
|
||||||
means async blocks and tokio tasks.
|
|
||||||
|
|
||||||
- **Never spawn a task without receiving and storing its JoinHandle**.
|
|
||||||
- **Always wait on join handles** before leaving a scope or in another cleanup
|
|
||||||
function called by an owning scope.
|
|
||||||
|
|
||||||
3. Know any minor specific quirks documented in code or here:
|
|
||||||
|
|
||||||
- Don't use `tokio::spawn`, instead use our `Handle` in `core/server.rs`, which
|
|
||||||
is reachable in most of the codebase via `services()` or other state. This is
|
|
||||||
due to some bugs or assumptions made in tokio, as it happens in `unsafe {}`
|
|
||||||
blocks, which are mitigated by circumventing some thread-local variables. Using
|
|
||||||
runtime handles is good practice in any case.
|
|
||||||
|
|
||||||
The initial implementation PR is available [here][1].
|
|
||||||
|
|
||||||
### Interesting related issues/bugs
|
|
||||||
|
|
||||||
- [DT_RUNPATH produced in binary with rpath = true is wrong (cargo)][5]
|
|
||||||
- [Disabling MIR Optimization in Rust Compilation
|
|
||||||
(cargo)](https://internals.rust-lang.org/t/disabling-mir-optimization-in-rust-compilation/19066/5)
|
|
||||||
- [Workspace-level metadata
|
|
||||||
(cargo-deb)](https://github.com/kornelski/cargo-deb/issues/68)
|
|
||||||
|
|
||||||
[1]: https://forgejo.ellis.link/continuwuation/continuwuity/pulls/387
|
|
||||||
[2]: https://wiki.musl-libc.org/functional-differences-from-glibc.html#Unloading-libraries
|
|
||||||
[3]: https://github.com/rust-lang/rust/issues/28794
|
|
||||||
[4]: https://github.com/rust-lang/rust/issues/28794#issuecomment-368693049
|
|
||||||
[5]: https://github.com/rust-lang/cargo/issues/12746
|
|
||||||
[6]: https://crates.io/crates/hot-lib-reloader/
|
|
||||||
[7]: https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org
|
|
||||||
[8]: https://crates.io/crates/libloading
|
|
||||||
|
|
@ -1,203 +0,0 @@
|
||||||
# Development
|
|
||||||
|
|
||||||
Information about developing the project. If you are only interested in using
|
|
||||||
it, you can safely ignore this page. If you plan on contributing, see the
|
|
||||||
[contributor's guide](./contributing.mdx) and
|
|
||||||
[code style guide](./code_style.mdx).
|
|
||||||
|
|
||||||
## Continuwuity project layout
|
|
||||||
|
|
||||||
Continuwuity 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 Continuwuity 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 Continuwuity 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 "Continuwuity as a library" where specific parts can simply be
|
|
||||||
swapped out. There is evidence Conduit wanted to go this route too as `axum` is
|
|
||||||
technically an optional feature in Conduit, and can be compiled without the
|
|
||||||
binary or axum library for handling inbound web requests; but it was never
|
|
||||||
completed or worked.
|
|
||||||
|
|
||||||
See the Rust documentation on [Workspaces][workspaces] for general questions and
|
|
||||||
information on Cargo workspaces.
|
|
||||||
|
|
||||||
## Adding compile-time [features][features]
|
|
||||||
|
|
||||||
If you'd like to add a compile-time feature, you must first define it in the
|
|
||||||
`main` workspace crate located in `src/main/Cargo.toml`. The feature must enable
|
|
||||||
a feature in the other workspace crate(s) you intend to use it in. Then the said
|
|
||||||
workspace crate(s) must define the feature there in its `Cargo.toml`.
|
|
||||||
|
|
||||||
So, if this is adding a feature to the API such as `woof`, you define the
|
|
||||||
feature in the `api` crate's `Cargo.toml` as `woof = []`. The feature definition
|
|
||||||
in `main`'s `Cargo.toml` will be `woof = ["conduwuit-api/woof"]`.
|
|
||||||
|
|
||||||
The rationale for this is due to Rust / Cargo not supporting ["workspace level
|
|
||||||
features"][9], we must make a choice of; either scattering features all over the
|
|
||||||
workspace crates, making it difficult for anyone to add or remove default
|
|
||||||
features; or define all the features in one central workspace crate that
|
|
||||||
propagate down/up to the other workspace crates. It is a Cargo pitfall, and we'd
|
|
||||||
like to see better developer UX in Rust's Workspaces.
|
|
||||||
|
|
||||||
Additionally, the definition of one single place makes "feature collection" in
|
|
||||||
our Nix flake a million times easier instead of collecting and deduping them all
|
|
||||||
from searching in all the workspace crates' `Cargo.toml`s. Though we wouldn't
|
|
||||||
need to do this if Rust supported workspace-level features to begin with.
|
|
||||||
|
|
||||||
## List of forked dependencies
|
|
||||||
|
|
||||||
During Continuwuity (and prior projects) development, we have had to fork some
|
|
||||||
dependencies to support our use-cases. These forks exist for various reasons
|
|
||||||
including features that upstream projects won't accept, faster-paced
|
|
||||||
development, Continuwuity-specific usecases, or lack of time to upstream
|
|
||||||
changes.
|
|
||||||
|
|
||||||
All forked dependencies are maintained under the
|
|
||||||
[continuwuation organization on Forgejo](https://forgejo.ellis.link/continuwuation):
|
|
||||||
|
|
||||||
- [ruwuma][continuwuation-ruwuma] - Fork of [ruma/ruma][ruma] with various
|
|
||||||
performance improvements, more features and better client/server interop
|
|
||||||
- [rocksdb][continuwuation-rocksdb] - Fork of [facebook/rocksdb][rocksdb] via
|
|
||||||
[`@zaidoon1`][8] with liburing build fixes and GCC debug build fixes
|
|
||||||
- [jemallocator][continuwuation-jemallocator] - Fork of
|
|
||||||
[tikv/jemallocator][jemallocator] fixing musl builds, suspicious code, and
|
|
||||||
adding support for redzones in Valgrind
|
|
||||||
- [rustyline-async][continuwuation-rustyline-async] - Fork of
|
|
||||||
[zyansheep/rustyline-async][rustyline-async] with tab completion callback and
|
|
||||||
`CTRL+\` signal quit event for Continuwuity console CLI
|
|
||||||
- [rust-rocksdb][continuwuation-rust-rocksdb] - Fork of
|
|
||||||
[rust-rocksdb/rust-rocksdb][rust-rocksdb] fixing musl build issues, removing
|
|
||||||
unnecessary `gtest` include, and using our RocksDB and jemallocator forks
|
|
||||||
- [tracing][continuwuation-tracing] - Fork of [tokio-rs/tracing][tracing]
|
|
||||||
implementing `Clone` for `EnvFilter` to support dynamically changing tracing
|
|
||||||
environments
|
|
||||||
|
|
||||||
## Debugging with `tokio-console`
|
|
||||||
|
|
||||||
[`tokio-console`][7] can be a useful tool for debugging and profiling. To make a
|
|
||||||
`tokio-console`-enabled build of Continuwuity, 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 +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 Continuwuity
|
|
||||||
when starting it. This was due to tokio-console causing gradual memory
|
|
||||||
leak/usage if left enabled.
|
|
||||||
|
|
||||||
## Building Docker Images
|
|
||||||
|
|
||||||
Official Continuwuity images are built using **Docker Buildx** and the
|
|
||||||
Dockerfile found at [`docker/Dockerfile`][dockerfile-path].
|
|
||||||
|
|
||||||
The images are compatible with Docker and other container runtimes like Podman
|
|
||||||
or containerd.
|
|
||||||
|
|
||||||
The images _do not contain a shell_. They contain only the Continuwuity binary,
|
|
||||||
required libraries, TLS certificates, and metadata.
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Click to view the Dockerfile</summary>
|
|
||||||
|
|
||||||
You can also
|
|
||||||
|
|
||||||
<a
|
|
||||||
href="<https://forgejo.ellis.link/continuwuation/continuwuation/src/branch/main/docker/Dockerfile>"
|
|
||||||
target="_blank"
|
|
||||||
>
|
|
||||||
view the Dockerfile on Forgejo
|
|
||||||
</a>
|
|
||||||
.
|
|
||||||
|
|
||||||
```dockerfile file="../../docker/Dockerfile"
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
### Building Locally
|
|
||||||
|
|
||||||
To build an image locally using Docker Buildx:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Build for the current platform and load into the local Docker daemon
|
|
||||||
docker buildx build --load --tag continuwuity:latest -f docker/Dockerfile .
|
|
||||||
|
|
||||||
# Example: Build for specific platforms and push to a registry
|
|
||||||
# docker buildx build --platform linux/amd64,linux/arm64 --tag registry.io/org/continuwuity:latest -f docker/Dockerfile . --push
|
|
||||||
|
|
||||||
# Example: Build binary optimised for the current CPU (standard release profile)
|
|
||||||
# docker buildx build --load \
|
|
||||||
# --tag continuwuity:latest \
|
|
||||||
# --build-arg TARGET_CPU=native \
|
|
||||||
# -f docker/Dockerfile .
|
|
||||||
|
|
||||||
# Example: Build maxperf variant (release-max-perf profile with LTO)
|
|
||||||
# docker buildx build --load \
|
|
||||||
# --tag continuwuity:latest-maxperf \
|
|
||||||
# --build-arg TARGET_CPU=native \
|
|
||||||
# --build-arg RUST_PROFILE=release-max-perf \
|
|
||||||
# -f docker/Dockerfile .
|
|
||||||
```
|
|
||||||
|
|
||||||
Refer to the Docker Buildx documentation for more advanced build options.
|
|
||||||
|
|
||||||
[dockerfile-path]:
|
|
||||||
https://forgejo.ellis.link/continuwuation/continuwuation/src/branch/main/docker/Dockerfile
|
|
||||||
[continuwuation-ruwuma]: https://forgejo.ellis.link/continuwuation/ruwuma
|
|
||||||
[continuwuation-rocksdb]: https://forgejo.ellis.link/continuwuation/rocksdb
|
|
||||||
[continuwuation-jemallocator]:
|
|
||||||
https://forgejo.ellis.link/continuwuation/jemallocator
|
|
||||||
[continuwuation-rustyline-async]:
|
|
||||||
https://forgejo.ellis.link/continuwuation/rustyline-async
|
|
||||||
[continuwuation-rust-rocksdb]:
|
|
||||||
https://forgejo.ellis.link/continuwuation/rust-rocksdb
|
|
||||||
[continuwuation-tracing]: https://forgejo.ellis.link/continuwuation/tracing
|
|
||||||
[ruma]: https://github.com/ruma/ruma/
|
|
||||||
[rocksdb]: https://github.com/facebook/rocksdb/
|
|
||||||
[jemallocator]: https://github.com/tikv/jemallocator/
|
|
||||||
[rustyline-async]: https://github.com/zyansheep/rustyline-async/
|
|
||||||
[rust-rocksdb]: https://github.com/rust-rocksdb/rust-rocksdb/
|
|
||||||
[tracing]: 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
|
|
||||||
|
|
@ -1,32 +0,0 @@
|
||||||
# Testing
|
|
||||||
|
|
||||||
## Complement
|
|
||||||
|
|
||||||
Have a look at [Complement's repository][complement] for an explanation of what
|
|
||||||
it is.
|
|
||||||
|
|
||||||
To test against Complement, with Nix (or [Lix](https://lix.systems) and
|
|
||||||
[direnv installed and set up][direnv] (run `direnv allow` after setting up the hook), you can:
|
|
||||||
|
|
||||||
* Run `./bin/complement "$COMPLEMENT_SRC"` to build a Complement image, run
|
|
||||||
the tests, and output the logs and results to the specified paths. This will also output the OCI image
|
|
||||||
at `result`
|
|
||||||
* Run `nix build .#complement` from the root of the repository to just build a
|
|
||||||
Complement OCI image outputted to `result` (it's a `.tar.gz` file)
|
|
||||||
* Or download the latest Complement OCI image from the CI workflow artifacts
|
|
||||||
output from the commit/revision you want to test (e.g. from main)
|
|
||||||
[here][ci-workflows]
|
|
||||||
|
|
||||||
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 [continuwuation/complement](https://forgejo.ellis.link/continuwuation/complement)
|
|
||||||
|
|
||||||
[ci-workflows]:
|
|
||||||
https://forgejo.ellis.link/continuwuation/continuwuity/actions/?workflow=ci.yml&actor=0&status=1
|
|
||||||
[complement]: https://github.com/matrix-org/complement
|
|
||||||
[direnv]: https://direnv.net/docs/hook.html
|
|
||||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Reference in a new issue