mirror of
https://forgejo.ellis.link/continuwuation/continuwuity.git
synced 2025-06-26 22:56:36 +02:00
Compare commits
114 commits
v0.5.0-rc.
...
main
Author | SHA1 | Date | |
---|---|---|---|
|
db58d841aa | ||
|
f1ca84fcaf | ||
|
63962fc040 | ||
|
a24278dc1b | ||
|
b787e97dc1 | ||
|
eb75c4ecb0 | ||
|
9bbe333082 | ||
|
3177545a6f | ||
|
4a289a9fee | ||
|
4d69a1ad51 | ||
|
4f174324ba | ||
|
2ecbd75d64 | ||
|
a682e9dbb8 | ||
|
46c193e74b | ||
|
93719018a8 | ||
|
70df8364b3 | ||
|
bae8192fb3 | ||
|
add5c7052c | ||
|
01200d9b54 | ||
|
0ba4a265be | ||
|
08fbcbba69 | ||
|
b526935d45 | ||
|
a737d845a4 | ||
|
e508b1197f | ||
|
d6fd30393c | ||
|
6e16a6ef8f | ||
|
0870c8d647 | ||
|
d0f00e6f5c | ||
|
5d44653e3a | ||
|
44e60d0ea6 | ||
|
d7514178ab | ||
|
1d45e0b68c | ||
|
3c44dccd65 | ||
|
b57be072c7 | ||
|
ea5dc8e09d | ||
|
b9d60c64e5 | ||
|
94ae824149 | ||
|
640714922b | ||
|
2b268fdaf3 | ||
|
e8d823a653 | ||
|
0ba77674c7 | ||
|
2ccbd7d60b | ||
|
60960c6e09 | ||
|
ce40304667 | ||
|
dcbc4b54c5 | ||
|
fce024b30b | ||
|
3e4e696761 | ||
|
f605913ea9 | ||
|
44302ce732 | ||
|
bfb0a2b76a | ||
|
fcd5669aa1 | ||
|
9b8b37f162 | ||
|
7a46563f23 | ||
|
1bf6537319 | ||
|
4ed04b343a | ||
|
a4ad72e11d | ||
|
1f57508879 | ||
|
a325dfa56a | ||
|
b5d2ef9a4a | ||
|
e200a7d991 | ||
|
034762c619 | ||
|
e31d261e66 | ||
|
c5db43ba9a | ||
|
ec08e16b9f | ||
|
f14725a51b | ||
|
d03325c65a | ||
|
066794fe90 | ||
|
beee996f72 | ||
|
7c58e40c96 | ||
|
5577ddca27 | ||
|
c0f46269b5 | ||
|
01594a6243 | ||
|
d78fc53577 | ||
|
e3ae024ed3 | ||
|
fb9d4c30f4 | ||
|
cbcf4300df | ||
|
a98da7d942 | ||
|
e1655edd83 | ||
|
4158c1cf62 | ||
|
edd5fc6c7e | ||
|
6b0288dd4c | ||
|
90f1a193e3 | ||
|
a9a478f077 | ||
|
b2620e6922 | ||
|
60caa448b0 | ||
|
eb886b6760 | ||
|
73c991edd0 | ||
|
c698d65a92 | ||
|
1a5ab33852 | ||
|
77c4f9ff2f | ||
|
dcbacb5b78 | ||
|
c203c1fead | ||
|
cdf105a24e | ||
|
859ec56b4f | ||
|
45872ede7a | ||
|
f83238df78 | ||
|
4c8dfc4c2c | ||
|
bfd7ab5a22 | ||
|
ee11afb460 | ||
|
1d840950b3 | ||
|
f791dc6918 | ||
|
3eb4ee7af1 | ||
|
8f21403796 | ||
|
4fbecca2d3 | ||
|
0307238bf8 | ||
|
1d42b88f50 | ||
|
81f8151aca | ||
|
66e8cd8908 | ||
|
7beff25d3d | ||
|
0c302f3137 | ||
|
c7ac2483a9 | ||
|
c68378ffe3 | ||
|
fbd404fa84 | ||
|
ff93cfdc64 |
124 changed files with 3304 additions and 1751 deletions
|
@ -11,10 +11,11 @@ docker/
|
||||||
*.iml
|
*.iml
|
||||||
|
|
||||||
# Git folder
|
# Git folder
|
||||||
.git
|
# .git
|
||||||
.gitea
|
.gitea
|
||||||
.gitlab
|
.gitlab
|
||||||
.github
|
.github
|
||||||
|
.forgejo
|
||||||
|
|
||||||
# Dot files
|
# Dot files
|
||||||
.env
|
.env
|
||||||
|
|
|
@ -22,3 +22,7 @@ indent_size = 2
|
||||||
[*.rs]
|
[*.rs]
|
||||||
indent_style = tab
|
indent_style = tab
|
||||||
max_line_length = 98
|
max_line_length = 98
|
||||||
|
|
||||||
|
[*.yml]
|
||||||
|
indent_size = 2
|
||||||
|
indent_style = space
|
||||||
|
|
27
.forgejo/actions/prefligit/action.yml
Normal file
27
.forgejo/actions/prefligit/action.yml
Normal file
|
@ -0,0 +1,27 @@
|
||||||
|
name: prefligit
|
||||||
|
description: |
|
||||||
|
Runs prefligit, pre-commit reimplemented in Rust.
|
||||||
|
inputs:
|
||||||
|
extra_args:
|
||||||
|
description: options to pass to pre-commit run
|
||||||
|
required: false
|
||||||
|
default: '--all-files'
|
||||||
|
|
||||||
|
runs:
|
||||||
|
using: composite
|
||||||
|
steps:
|
||||||
|
- name: Install uv
|
||||||
|
uses: https://github.com/astral-sh/setup-uv@v6
|
||||||
|
with:
|
||||||
|
enable-cache: true
|
||||||
|
ignore-nothing-to-cache: true
|
||||||
|
- name: Install Prefligit
|
||||||
|
shell: bash
|
||||||
|
run: |
|
||||||
|
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/j178/prefligit/releases/download/v0.0.10/prefligit-installer.sh | sh
|
||||||
|
- uses: actions/cache@v3
|
||||||
|
with:
|
||||||
|
path: ~/.cache/prefligit
|
||||||
|
key: prefligit-0|${{ hashFiles('.pre-commit-config.yaml') }}
|
||||||
|
- run: prefligit run --show-diff-on-failure --color=always -v ${{ inputs.extra_args }}
|
||||||
|
shell: bash
|
63
.forgejo/actions/rust-toolchain/action.yml
Normal file
63
.forgejo/actions/rust-toolchain/action.yml
Normal file
|
@ -0,0 +1,63 @@
|
||||||
|
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: ${{ 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
|
29
.forgejo/actions/sccache/action.yml
Normal file
29
.forgejo/actions/sccache/action.yml
Normal file
|
@ -0,0 +1,29 @@
|
||||||
|
name: sccache
|
||||||
|
description: |
|
||||||
|
Install sccache for caching builds in GitHub Actions.
|
||||||
|
|
||||||
|
inputs:
|
||||||
|
token:
|
||||||
|
description: 'A Github PAT'
|
||||||
|
required: false
|
||||||
|
|
||||||
|
runs:
|
||||||
|
using: composite
|
||||||
|
steps:
|
||||||
|
- name: Install sccache
|
||||||
|
uses: https://github.com/mozilla-actions/sccache-action@v0.0.9
|
||||||
|
with:
|
||||||
|
token: ${{ inputs.token }}
|
||||||
|
- name: Configure sccache
|
||||||
|
uses: https://github.com/actions/github-script@v7
|
||||||
|
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
|
46
.forgejo/actions/timelord/action.yml
Normal file
46
.forgejo/actions/timelord/action.yml
Normal file
|
@ -0,0 +1,46 @@
|
||||||
|
name: timelord
|
||||||
|
description: |
|
||||||
|
Use timelord to set file timestamps
|
||||||
|
inputs:
|
||||||
|
key:
|
||||||
|
description: |
|
||||||
|
The key to use for caching the timelord data.
|
||||||
|
This should be unique to the repository and the runner.
|
||||||
|
required: true
|
||||||
|
default: timelord-v0
|
||||||
|
path:
|
||||||
|
description: |
|
||||||
|
The path to the directory to be timestamped.
|
||||||
|
This should be the root of the repository.
|
||||||
|
required: true
|
||||||
|
default: .
|
||||||
|
|
||||||
|
runs:
|
||||||
|
using: composite
|
||||||
|
steps:
|
||||||
|
- name: Cache timelord-cli installation
|
||||||
|
id: cache-timelord-bin
|
||||||
|
uses: actions/cache@v3
|
||||||
|
with:
|
||||||
|
path: ~/.cargo/bin/timelord
|
||||||
|
key: timelord-cli-v3.0.1
|
||||||
|
- name: Install timelord-cli
|
||||||
|
uses: https://github.com/cargo-bins/cargo-binstall@main
|
||||||
|
if: steps.cache-timelord-bin.outputs.cache-hit != 'true'
|
||||||
|
- run: cargo binstall timelord-cli@3.0.1
|
||||||
|
shell: bash
|
||||||
|
if: steps.cache-timelord-bin.outputs.cache-hit != 'true'
|
||||||
|
|
||||||
|
- name: Load timelord files
|
||||||
|
uses: actions/cache/restore@v3
|
||||||
|
with:
|
||||||
|
path: /timelord/
|
||||||
|
key: ${{ inputs.key }}
|
||||||
|
- name: Run timelord to set timestamps
|
||||||
|
shell: bash
|
||||||
|
run: timelord sync --source-dir ${{ inputs.path }} --cache-dir /timelord/
|
||||||
|
- name: Save timelord
|
||||||
|
uses: actions/cache/save@v3
|
||||||
|
with:
|
||||||
|
path: /timelord/
|
||||||
|
key: ${{ inputs.key }}
|
|
@ -16,7 +16,8 @@ concurrency:
|
||||||
jobs:
|
jobs:
|
||||||
docs:
|
docs:
|
||||||
name: Build and Deploy Documentation
|
name: Build and Deploy Documentation
|
||||||
runs-on: not-nexy
|
runs-on: ubuntu-latest
|
||||||
|
if: secrets.CLOUDFLARE_API_TOKEN != ''
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Sync repository
|
- name: Sync repository
|
||||||
|
@ -41,6 +42,7 @@ jobs:
|
||||||
# Copy the Matrix .well-known files
|
# Copy the Matrix .well-known files
|
||||||
cp ./docs/static/server ./public/.well-known/matrix/server
|
cp ./docs/static/server ./public/.well-known/matrix/server
|
||||||
cp ./docs/static/client ./public/.well-known/matrix/client
|
cp ./docs/static/client ./public/.well-known/matrix/client
|
||||||
|
cp ./docs/static/client ./public/.well-known/matrix/support
|
||||||
cp ./docs/static/announcements.json ./public/.well-known/continuwuity/announcements
|
cp ./docs/static/announcements.json ./public/.well-known/continuwuity/announcements
|
||||||
cp ./docs/static/announcements.schema.json ./public/schema/announcements.schema.json
|
cp ./docs/static/announcements.schema.json ./public/schema/announcements.schema.json
|
||||||
# Copy the custom headers file
|
# Copy the custom headers file
|
||||||
|
@ -56,17 +58,17 @@ jobs:
|
||||||
run: npm install --save-dev wrangler@latest
|
run: npm install --save-dev wrangler@latest
|
||||||
|
|
||||||
- name: Deploy to Cloudflare Pages (Production)
|
- name: Deploy to Cloudflare Pages (Production)
|
||||||
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
|
if: github.ref == 'refs/heads/main' && vars.CLOUDFLARE_PROJECT_NAME != ''
|
||||||
uses: https://github.com/cloudflare/wrangler-action@v3
|
uses: https://github.com/cloudflare/wrangler-action@v3
|
||||||
with:
|
with:
|
||||||
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
||||||
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
||||||
command: pages deploy ./public --branch=main --commit-dirty=true --project-name=${{ vars.CLOUDFLARE_PROJECT_NAME }}"
|
command: pages deploy ./public --branch="main" --commit-dirty=true --project-name="${{ vars.CLOUDFLARE_PROJECT_NAME }}"
|
||||||
|
|
||||||
- name: Deploy to Cloudflare Pages (Preview)
|
- name: Deploy to Cloudflare Pages (Preview)
|
||||||
if: ${{ github.event_name != 'push' || github.ref != 'refs/heads/main' }}
|
if: github.ref != 'refs/heads/main' && vars.CLOUDFLARE_PROJECT_NAME != ''
|
||||||
uses: https://github.com/cloudflare/wrangler-action@v3
|
uses: https://github.com/cloudflare/wrangler-action@v3
|
||||||
with:
|
with:
|
||||||
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
||||||
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
||||||
command: pages deploy ./public --branch=${{ github.head_ref }} --commit-dirty=true --project-name=${{ vars.CLOUDFLARE_PROJECT_NAME }}"
|
command: pages deploy ./public --branch="${{ github.head_ref || github.ref_name }}" --commit-dirty=true --project-name="${{ vars.CLOUDFLARE_PROJECT_NAME }}"
|
||||||
|
|
127
.forgejo/workflows/element.yml
Normal file
127
.forgejo/workflows/element.yml
Normal file
|
@ -0,0 +1,127 @@
|
||||||
|
name: Deploy Element Web
|
||||||
|
|
||||||
|
on:
|
||||||
|
schedule:
|
||||||
|
- cron: "0 0 * * *"
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: "element-${{ github.ref }}"
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build-and-deploy:
|
||||||
|
name: Build and Deploy Element Web
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Setup Node.js
|
||||||
|
uses: https://code.forgejo.org/actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: "20"
|
||||||
|
|
||||||
|
- 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: https://code.forgejo.org/actions/upload-artifact@v3
|
||||||
|
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 (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 ./element-web/webapp --branch="main" --commit-dirty=true --project-name="${{ vars.CLOUDFLARE_PROJECT_NAME }}-element"
|
||||||
|
|
||||||
|
- 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 ./element-web/webapp --branch="${{ github.head_ref || github.ref_name }}" --commit-dirty=true --project-name="${{ vars.CLOUDFLARE_PROJECT_NAME }}-element"
|
22
.forgejo/workflows/prefligit-checks.yml
Normal file
22
.forgejo/workflows/prefligit-checks.yml
Normal file
|
@ -0,0 +1,22 @@
|
||||||
|
name: Checks / Prefligit
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
pull_request:
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
prefligit:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
env:
|
||||||
|
FROM_REF: ${{ github.event.pull_request.base.sha || (!github.event.forced && ( github.event.before != '0000000000000000000000000000000000000000' && github.event.before || github.sha )) || format('{0}~', github.sha) }}
|
||||||
|
TO_REF: ${{ github.sha }}
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
persist-credentials: false
|
||||||
|
- uses: ./.forgejo/actions/prefligit
|
||||||
|
with:
|
||||||
|
extra_args: --all-files --hook-stage manual
|
|
@ -3,14 +3,16 @@ concurrency:
|
||||||
group: "release-image-${{ github.ref }}"
|
group: "release-image-${{ github.ref }}"
|
||||||
|
|
||||||
on:
|
on:
|
||||||
pull_request:
|
|
||||||
push:
|
push:
|
||||||
paths-ignore:
|
paths-ignore:
|
||||||
- '.gitlab-ci.yml'
|
- "*.md"
|
||||||
- '.gitignore'
|
- "**/*.md"
|
||||||
- 'renovate.json'
|
- ".gitlab-ci.yml"
|
||||||
- 'debian/**'
|
- ".gitignore"
|
||||||
- 'docker/**'
|
- "renovate.json"
|
||||||
|
- "debian/**"
|
||||||
|
- "docker/**"
|
||||||
|
- "docs/**"
|
||||||
# Allows you to run this workflow manually from the Actions tab
|
# Allows you to run this workflow manually from the Actions tab
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
|
@ -18,7 +20,6 @@ env:
|
||||||
BUILTIN_REGISTRY: forgejo.ellis.link
|
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' }}"
|
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' }}"
|
||||||
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
define-variables:
|
define-variables:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
@ -48,6 +49,7 @@ jobs:
|
||||||
const platforms = ['linux/amd64', 'linux/arm64']
|
const platforms = ['linux/amd64', 'linux/arm64']
|
||||||
core.setOutput('build_matrix', JSON.stringify({
|
core.setOutput('build_matrix', JSON.stringify({
|
||||||
platform: platforms,
|
platform: platforms,
|
||||||
|
target_cpu: ['base'],
|
||||||
include: platforms.map(platform => { return {
|
include: platforms.map(platform => { return {
|
||||||
platform,
|
platform,
|
||||||
slug: platform.replace('/', '-')
|
slug: platform.replace('/', '-')
|
||||||
|
@ -56,7 +58,6 @@ jobs:
|
||||||
|
|
||||||
build-image:
|
build-image:
|
||||||
runs-on: dind
|
runs-on: dind
|
||||||
container: ghcr.io/catthehacker/ubuntu:act-latest
|
|
||||||
needs: define-variables
|
needs: define-variables
|
||||||
permissions:
|
permissions:
|
||||||
contents: read
|
contents: read
|
||||||
|
@ -64,38 +65,32 @@ jobs:
|
||||||
attestations: write
|
attestations: write
|
||||||
id-token: write
|
id-token: write
|
||||||
strategy:
|
strategy:
|
||||||
matrix: {
|
matrix:
|
||||||
"include": [
|
|
||||||
{
|
{
|
||||||
"platform": "linux/amd64",
|
"target_cpu": ["base"],
|
||||||
"slug": "linux-amd64"
|
"profile": ["release"],
|
||||||
},
|
"include":
|
||||||
{
|
[
|
||||||
"platform": "linux/arm64",
|
{ "platform": "linux/amd64", "slug": "linux-amd64" },
|
||||||
"slug": "linux-arm64"
|
{ "platform": "linux/arm64", "slug": "linux-arm64" },
|
||||||
}
|
|
||||||
],
|
],
|
||||||
"platform": [
|
"platform": ["linux/amd64", "linux/arm64"],
|
||||||
"linux/amd64",
|
|
||||||
"linux/arm64"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Echo strategy
|
- name: Echo strategy
|
||||||
run: echo '${{ toJSON(fromJSON(needs.define-variables.outputs.build_matrix)) }}'
|
run: echo '${{ toJSON(fromJSON(needs.define-variables.outputs.build_matrix)) }}'
|
||||||
- name: Echo matrix
|
- name: Echo matrix
|
||||||
run: echo '${{ toJSON(matrix) }}'
|
run: echo '${{ toJSON(matrix) }}'
|
||||||
|
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
persist-credentials: false
|
persist-credentials: false
|
||||||
- run: |
|
- name: Install rust
|
||||||
if ! command -v rustup &> /dev/null ; then
|
id: rust-toolchain
|
||||||
curl --proto '=https' --tlsv1.2 --retry 10 --retry-connrefused -fsSL "https://sh.rustup.rs" | sh -s -- --default-toolchain none -y
|
uses: ./.forgejo/actions/rust-toolchain
|
||||||
echo "${CARGO_HOME:-$HOME/.cargo}/bin" >> $GITHUB_PATH
|
|
||||||
fi
|
|
||||||
- uses: https://github.com/cargo-bins/cargo-binstall@main
|
|
||||||
- run: cargo binstall timelord-cli@3.0.1
|
|
||||||
- name: Set up Docker Buildx
|
- name: Set up Docker Buildx
|
||||||
uses: docker/setup-buildx-action@v3
|
uses: docker/setup-buildx-action@v3
|
||||||
- name: Set up QEMU
|
- name: Set up QEMU
|
||||||
|
@ -129,18 +124,58 @@ jobs:
|
||||||
echo "COMMIT_SHORT_SHA=$calculatedSha" >> $GITHUB_ENV
|
echo "COMMIT_SHORT_SHA=$calculatedSha" >> $GITHUB_ENV
|
||||||
- name: Get Git commit timestamps
|
- name: Get Git commit timestamps
|
||||||
run: echo "TIMESTAMP=$(git log -1 --pretty=%ct)" >> $GITHUB_ENV
|
run: echo "TIMESTAMP=$(git log -1 --pretty=%ct)" >> $GITHUB_ENV
|
||||||
- name: Set up timelord
|
|
||||||
uses: actions/cache/restore@v3
|
- uses: ./.forgejo/actions/timelord
|
||||||
with:
|
with:
|
||||||
path: /timelord/
|
|
||||||
key: timelord-v0 # Cache is already split per runner
|
|
||||||
- name: Run timelord to set timestamps
|
|
||||||
run: timelord sync --source-dir . --cache-dir /timelord/
|
|
||||||
- name: Save timelord
|
|
||||||
uses: actions/cache/save@v3
|
|
||||||
with:
|
|
||||||
path: /timelord/
|
|
||||||
key: timelord-v0
|
key: timelord-v0
|
||||||
|
path: .
|
||||||
|
|
||||||
|
- name: Cache Rust registry
|
||||||
|
uses: actions/cache@v3
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
.cargo/git
|
||||||
|
.cargo/git/checkouts
|
||||||
|
.cargo/registry
|
||||||
|
.cargo/registry/src
|
||||||
|
key: rust-registry-image-${{hashFiles('**/Cargo.lock') }}
|
||||||
|
- name: Cache cargo target
|
||||||
|
id: cache-cargo-target
|
||||||
|
uses: actions/cache@v3
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
cargo-target-${{ matrix.target_cpu }}-${{ matrix.slug }}-${{ matrix.profile }}
|
||||||
|
key: cargo-target-${{ matrix.target_cpu }}-${{ matrix.slug }}-${{ matrix.profile }}-${{hashFiles('**/Cargo.lock') }}-${{steps.rust-toolchain.outputs.rustc_version}}
|
||||||
|
- name: Cache apt cache
|
||||||
|
id: cache-apt
|
||||||
|
uses: actions/cache@v3
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
var-cache-apt-${{ matrix.slug }}
|
||||||
|
key: var-cache-apt-${{ matrix.slug }}
|
||||||
|
- name: Cache apt lib
|
||||||
|
id: cache-apt-lib
|
||||||
|
uses: actions/cache@v3
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
var-lib-apt-${{ matrix.slug }}
|
||||||
|
key: var-lib-apt-${{ matrix.slug }}
|
||||||
|
- name: inject cache into docker
|
||||||
|
uses: https://github.com/reproducible-containers/buildkit-cache-dance@v3.1.0
|
||||||
|
with:
|
||||||
|
cache-map: |
|
||||||
|
{
|
||||||
|
".cargo/registry": "/usr/local/cargo/registry",
|
||||||
|
".cargo/git/db": "/usr/local/cargo/git/db",
|
||||||
|
"cargo-target-${{ matrix.target_cpu }}-${{ matrix.slug }}-${{ matrix.profile }}": {
|
||||||
|
"target": "/app/target",
|
||||||
|
"id": "cargo-target-${{ matrix.target_cpu }}-${{ matrix.slug }}-${{ matrix.profile }}"
|
||||||
|
},
|
||||||
|
"var-cache-apt-${{ matrix.slug }}": "/var/cache/apt",
|
||||||
|
"var-lib-apt-${{ matrix.slug }}": "/var/lib/apt"
|
||||||
|
}
|
||||||
|
skip-extraction: ${{ steps.cache.outputs.cache-hit }}
|
||||||
|
|
||||||
- name: Build and push Docker image by digest
|
- name: Build and push Docker image by digest
|
||||||
id: build
|
id: build
|
||||||
uses: docker/build-push-action@v6
|
uses: docker/build-push-action@v6
|
||||||
|
@ -148,12 +183,15 @@ jobs:
|
||||||
context: .
|
context: .
|
||||||
file: "docker/Dockerfile"
|
file: "docker/Dockerfile"
|
||||||
build-args: |
|
build-args: |
|
||||||
CONDUWUIT_VERSION_EXTRA=${{ env.COMMIT_SHORT_SHA }}
|
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 }}
|
||||||
platforms: ${{ matrix.platform }}
|
platforms: ${{ matrix.platform }}
|
||||||
labels: ${{ steps.meta.outputs.labels }}
|
labels: ${{ steps.meta.outputs.labels }}
|
||||||
annotations: ${{ steps.meta.outputs.annotations }}
|
annotations: ${{ steps.meta.outputs.annotations }}
|
||||||
cache-from: type=gha
|
cache-from: type=gha
|
||||||
cache-to: type=gha,mode=max
|
# cache-to: type=gha,mode=max
|
||||||
sbom: true
|
sbom: true
|
||||||
outputs: type=image,"name=${{ needs.define-variables.outputs.images_list }}",push-by-digest=true,name-canonical=true,push=true
|
outputs: type=image,"name=${{ needs.define-variables.outputs.images_list }}",push-by-digest=true,name-canonical=true,push=true
|
||||||
env:
|
env:
|
||||||
|
@ -176,7 +214,6 @@ jobs:
|
||||||
|
|
||||||
merge:
|
merge:
|
||||||
runs-on: dind
|
runs-on: dind
|
||||||
container: ghcr.io/catthehacker/ubuntu:act-latest
|
|
||||||
needs: [define-variables, build-image]
|
needs: [define-variables, build-image]
|
||||||
steps:
|
steps:
|
||||||
- name: Download digests
|
- name: Download digests
|
||||||
|
@ -204,7 +241,7 @@ jobs:
|
||||||
type=semver,pattern=v{{version}}
|
type=semver,pattern=v{{version}}
|
||||||
type=semver,pattern=v{{major}}.{{minor}},enable=${{ !startsWith(github.ref, 'refs/tags/v0.0.') }}
|
type=semver,pattern=v{{major}}.{{minor}},enable=${{ !startsWith(github.ref, 'refs/tags/v0.0.') }}
|
||||||
type=semver,pattern=v{{major}},enable=${{ !startsWith(github.ref, 'refs/tags/v0.') }}
|
type=semver,pattern=v{{major}},enable=${{ !startsWith(github.ref, 'refs/tags/v0.') }}
|
||||||
type=ref,event=branch,prefix=${{ format('refs/heads/{0}', github.event.repository.default_branch) 1= github.ref && 'branch-' || '' }}
|
type=ref,event=branch,prefix=${{ format('refs/heads/{0}', github.event.repository.default_branch) != github.ref && 'branch-' || '' }}
|
||||||
type=ref,event=pr
|
type=ref,event=pr
|
||||||
type=sha,format=long
|
type=sha,format=long
|
||||||
images: ${{needs.define-variables.outputs.images}}
|
images: ${{needs.define-variables.outputs.images}}
|
||||||
|
|
142
.forgejo/workflows/rust-checks.yml
Normal file
142
.forgejo/workflows/rust-checks.yml
Normal file
|
@ -0,0 +1,142 @@
|
||||||
|
name: Checks / Rust
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
format:
|
||||||
|
name: Format
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
persist-credentials: false
|
||||||
|
|
||||||
|
- name: Install rust
|
||||||
|
uses: ./.forgejo/actions/rust-toolchain
|
||||||
|
with:
|
||||||
|
toolchain: "nightly"
|
||||||
|
components: "rustfmt"
|
||||||
|
|
||||||
|
- name: Check formatting
|
||||||
|
run: |
|
||||||
|
cargo +nightly fmt --all -- --check
|
||||||
|
|
||||||
|
clippy:
|
||||||
|
name: Clippy
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
persist-credentials: false
|
||||||
|
|
||||||
|
- name: Install rust
|
||||||
|
uses: ./.forgejo/actions/rust-toolchain
|
||||||
|
|
||||||
|
- 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: ${{ vars.GH_APP_OWNER }}
|
||||||
|
repositories: ""
|
||||||
|
- name: Install sccache
|
||||||
|
uses: ./.forgejo/actions/sccache
|
||||||
|
with:
|
||||||
|
token: ${{ steps.app-token.outputs.token }}
|
||||||
|
- run: sudo apt-get update
|
||||||
|
- name: Install system dependencies
|
||||||
|
uses: https://github.com/awalsh128/cache-apt-pkgs-action@v1
|
||||||
|
with:
|
||||||
|
packages: clang liburing-dev
|
||||||
|
version: 1
|
||||||
|
- name: Cache Rust registry
|
||||||
|
uses: actions/cache@v3
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.cargo/git
|
||||||
|
!~/.cargo/git/checkouts
|
||||||
|
~/.cargo/registry
|
||||||
|
!~/.cargo/registry/src
|
||||||
|
key: rust-registry-${{hashFiles('**/Cargo.lock') }}
|
||||||
|
- name: Timelord
|
||||||
|
uses: ./.forgejo/actions/timelord
|
||||||
|
with:
|
||||||
|
key: sccache-v0
|
||||||
|
path: .
|
||||||
|
- name: Clippy
|
||||||
|
run: |
|
||||||
|
cargo clippy \
|
||||||
|
--workspace \
|
||||||
|
--locked \
|
||||||
|
--no-deps \
|
||||||
|
--profile test \
|
||||||
|
-- \
|
||||||
|
-D warnings
|
||||||
|
|
||||||
|
- name: Show sccache stats
|
||||||
|
if: always()
|
||||||
|
run: sccache --show-stats
|
||||||
|
|
||||||
|
cargo-test:
|
||||||
|
name: Cargo Test
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
persist-credentials: false
|
||||||
|
|
||||||
|
- name: Install rust
|
||||||
|
uses: ./.forgejo/actions/rust-toolchain
|
||||||
|
|
||||||
|
- 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: ${{ vars.GH_APP_OWNER }}
|
||||||
|
repositories: ""
|
||||||
|
- name: Install sccache
|
||||||
|
uses: ./.forgejo/actions/sccache
|
||||||
|
with:
|
||||||
|
token: ${{ steps.app-token.outputs.token }}
|
||||||
|
- run: sudo apt-get update
|
||||||
|
- name: Install system dependencies
|
||||||
|
uses: https://github.com/awalsh128/cache-apt-pkgs-action@v1
|
||||||
|
with:
|
||||||
|
packages: clang liburing-dev
|
||||||
|
version: 1
|
||||||
|
- name: Cache Rust registry
|
||||||
|
uses: actions/cache@v3
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.cargo/git
|
||||||
|
!~/.cargo/git/checkouts
|
||||||
|
~/.cargo/registry
|
||||||
|
!~/.cargo/registry/src
|
||||||
|
key: rust-registry-${{hashFiles('**/Cargo.lock') }}
|
||||||
|
- name: Timelord
|
||||||
|
uses: ./.forgejo/actions/timelord
|
||||||
|
with:
|
||||||
|
key: sccache-v0
|
||||||
|
path: .
|
||||||
|
- name: Cargo Test
|
||||||
|
run: |
|
||||||
|
cargo test \
|
||||||
|
--workspace \
|
||||||
|
--locked \
|
||||||
|
--profile test \
|
||||||
|
--all-targets \
|
||||||
|
--no-fail-fast
|
||||||
|
|
||||||
|
- name: Show sccache stats
|
||||||
|
if: always()
|
||||||
|
run: sccache --show-stats
|
|
@ -5,3 +5,5 @@ f419c64aca300a338096b4e0db4c73ace54f23d0
|
||||||
# use chain_width 60
|
# use chain_width 60
|
||||||
162948313c212193965dece50b816ef0903172ba
|
162948313c212193965dece50b816ef0903172ba
|
||||||
5998a0d883d31b866f7c8c46433a8857eae51a89
|
5998a0d883d31b866f7c8c46433a8857eae51a89
|
||||||
|
# trailing whitespace and newlines
|
||||||
|
46c193e74b2ce86c48ce802333a0aabce37fd6e9
|
||||||
|
|
47
.pre-commit-config.yaml
Normal file
47
.pre-commit-config.yaml
Normal file
|
@ -0,0 +1,47 @@
|
||||||
|
default_install_hook_types:
|
||||||
|
- pre-commit
|
||||||
|
- commit-msg
|
||||||
|
default_stages:
|
||||||
|
- pre-commit
|
||||||
|
- manual
|
||||||
|
|
||||||
|
repos:
|
||||||
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||||
|
rev: v5.0.0
|
||||||
|
hooks:
|
||||||
|
- id: check-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.26.0
|
||||||
|
hooks:
|
||||||
|
- id: typos
|
||||||
|
- id: typos
|
||||||
|
name: commit-msg-typos
|
||||||
|
stages: [commit-msg]
|
||||||
|
|
||||||
|
- repo: https://github.com/crate-ci/committed
|
||||||
|
rev: v1.1.7
|
||||||
|
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
|
9
.typos.toml
Normal file
9
.typos.toml
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
[files]
|
||||||
|
extend-exclude = ["*.csr"]
|
||||||
|
|
||||||
|
[default.extend-words]
|
||||||
|
"allocatedp" = "allocatedp"
|
||||||
|
"conduwuit" = "conduwuit"
|
||||||
|
"continuwuity" = "continuwuity"
|
||||||
|
"continuwity" = "continuwuity"
|
||||||
|
"execuse" = "execuse"
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
# Contributor Covenant Code of Conduct
|
# Contributor Covenant Code of Conduct
|
||||||
|
|
||||||
## Our Pledge
|
## Our Pledge
|
||||||
|
@ -60,8 +59,7 @@ representative at an online or offline event.
|
||||||
## Enforcement
|
## Enforcement
|
||||||
|
|
||||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
reported to the community leaders responsible for enforcement over email at
|
reported to the community leaders responsible for enforcement over Matrix at [#continuwuity:continuwuity.org](https://matrix.to/#/#continuwuity:continuwuity.org) or email at <tom@tcpip.uk>, <jade@continuwuity.org> and <nex@continuwuity.org> respectively.
|
||||||
<strawberry@puppygock.gay> or over Matrix at @strawberry:puppygock.gay.
|
|
||||||
All complaints will be reviewed and investigated promptly and fairly.
|
All complaints will be reviewed and investigated promptly and fairly.
|
||||||
|
|
||||||
All community leaders are obligated to respect the privacy and security of the
|
All community leaders are obligated to respect the privacy and security of the
|
||||||
|
|
187
CONTRIBUTING.md
187
CONTRIBUTING.md
|
@ -1,16 +1,16 @@
|
||||||
# Contributing guide
|
# Contributing guide
|
||||||
|
|
||||||
This page is for about contributing to conduwuit. The
|
This page is about contributing to Continuwuity. The
|
||||||
[development](./development.md) page may be of interest for you as well.
|
[development](./development.md) page may be of interest for you as well.
|
||||||
|
|
||||||
If you would like to work on an [issue][issues] that is not assigned, preferably
|
If you would like to work on an [issue][issues] that is not assigned, preferably
|
||||||
ask in the Matrix room first at [#conduwuit:puppygock.gay][conduwuit-matrix],
|
ask in the Matrix room first at [#continuwuity:continuwuity.org][continuwuity-matrix],
|
||||||
and comment on it.
|
and comment on it.
|
||||||
|
|
||||||
### Linting and Formatting
|
### Linting and Formatting
|
||||||
|
|
||||||
It is mandatory all your changes satisfy the lints (clippy, rustc, rustdoc, etc)
|
It is mandatory all your changes satisfy the lints (clippy, rustc, rustdoc, etc)
|
||||||
and your code is formatted via the **nightly** `cargo fmt`. A lot of the
|
and your code is formatted via the **nightly** rustfmt (`cargo +nightly fmt`). A lot of the
|
||||||
`rustfmt.toml` features depend on nightly toolchain. It would be ideal if they
|
`rustfmt.toml` features depend on nightly toolchain. It would be ideal if they
|
||||||
weren't nightly-exclusive features, but they currently still are. CI's rustfmt
|
weren't nightly-exclusive features, but they currently still are. CI's rustfmt
|
||||||
uses nightly.
|
uses nightly.
|
||||||
|
@ -21,67 +21,91 @@ comment saying why. Do not write inefficient code for the sake of satisfying
|
||||||
lints. If a lint is wrong and provides a more inefficient solution or
|
lints. If a lint is wrong and provides a more inefficient solution or
|
||||||
suggestion, allow the lint and mention that in a comment.
|
suggestion, allow the lint and mention that in a comment.
|
||||||
|
|
||||||
### Running CI tests locally
|
### Pre-commit Checks
|
||||||
|
|
||||||
conduwuit's CI for tests, linting, formatting, audit, etc use
|
Continuwuity uses pre-commit hooks to enforce various coding standards and catch common issues before they're committed. These checks include:
|
||||||
[`engage`][engage]. engage can be installed from nixpkgs or `cargo install
|
|
||||||
engage`. conduwuit's Nix flake devshell has the nixpkgs engage with `direnv`.
|
|
||||||
Use `engage --help` for more usage details.
|
|
||||||
|
|
||||||
To test, format, lint, etc that CI would do, install engage, allow the `.envrc`
|
- Code formatting and linting
|
||||||
file using `direnv allow`, and run `engage`.
|
- 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
|
||||||
|
|
||||||
All of the tasks are defined at the [engage.toml][engage.toml] file. You can
|
You can run these checks locally by installing [prefligit](https://github.com/j178/prefligit):
|
||||||
view all of them neatly by running `engage list`
|
|
||||||
|
|
||||||
If you would like to run only a specific engage task group, use `just`:
|
|
||||||
|
|
||||||
- `engage just <group>`
|
```bash
|
||||||
- Example: `engage just lints`
|
# Install prefligit using cargo-binstall
|
||||||
|
cargo binstall prefligit
|
||||||
|
|
||||||
If you would like to run a specific engage task in a specific group, use `just
|
# Install git hooks to run checks automatically
|
||||||
<GROUP> [TASK]`: `engage just lints cargo-fmt`
|
prefligit install
|
||||||
|
|
||||||
The following binaries are used in [`engage.toml`][engage.toml]:
|
# Run all checks
|
||||||
|
prefligit --all-files
|
||||||
|
```
|
||||||
|
|
||||||
- [`engage`][engage]
|
Alternatively, you can use [pre-commit](https://pre-commit.com/):
|
||||||
- `nix`
|
```bash
|
||||||
- [`direnv`][direnv]
|
# Install pre-commit
|
||||||
- `rustc`
|
pip install pre-commit
|
||||||
- `cargo`
|
|
||||||
- `cargo-fmt`
|
# Install the hooks
|
||||||
- `rustdoc`
|
pre-commit install
|
||||||
- `cargo-clippy`
|
|
||||||
- [`cargo-audit`][cargo-audit]
|
# Run all checks manually
|
||||||
- [`cargo-deb`][cargo-deb]
|
pre-commit run --all-files
|
||||||
- [`lychee`][lychee]
|
```
|
||||||
- [`markdownlint-cli`][markdownlint-cli]
|
|
||||||
- `dpkg`
|
These same checks are run in CI via the prefligit-checks workflow to ensure consistency.
|
||||||
|
|
||||||
|
### Running tests locally
|
||||||
|
|
||||||
|
Tests, compilation, and linting can be run with standard Cargo commands:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Run tests
|
||||||
|
cargo test
|
||||||
|
|
||||||
|
# Check compilation
|
||||||
|
cargo check --workspace
|
||||||
|
|
||||||
|
# Run lints
|
||||||
|
cargo clippy --workspace
|
||||||
|
# Auto-fix: cargo clippy --workspace --fix --allow-staged;
|
||||||
|
|
||||||
|
# Format code (must use nightly)
|
||||||
|
cargo +nightly fmt
|
||||||
|
```
|
||||||
|
|
||||||
### Matrix tests
|
### Matrix tests
|
||||||
|
|
||||||
CI runs [Complement][complement], but currently does not fail if results from
|
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.
|
||||||
the checked-in results differ with the new results. If your changes are done to
|
|
||||||
fix Matrix tests, note that in your pull request. If more Complement tests start
|
|
||||||
failing from your changes, please review the logs (they are uploaded as
|
|
||||||
artifacts) and determine if they're intended or not.
|
|
||||||
|
|
||||||
If you'd like to run Complement locally using Nix, see the
|
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.
|
||||||
[testing](development/testing.md) page.
|
|
||||||
|
|
||||||
[Sytest][sytest] support will come soon.
|
[Sytest][sytest] is currently unsupported.
|
||||||
|
|
||||||
### Writing documentation
|
### Writing documentation
|
||||||
|
|
||||||
conduwuit's website uses [`mdbook`][mdbook] and deployed via CI using GitHub
|
Continuwuity's website uses [`mdbook`][mdbook] and is deployed via CI using Cloudflare Pages
|
||||||
Pages in the [`documentation.yml`][documentation.yml] workflow file with Nix's
|
in the [`documentation.yml`][documentation.yml] workflow file. All documentation is in the `docs/`
|
||||||
mdbook in the devshell. All documentation is in the `docs/` directory at the top
|
directory at the top level.
|
||||||
level. The compiled mdbook website is also uploaded as an artifact.
|
|
||||||
|
|
||||||
To build the documentation using Nix, run: `bin/nix-build-and-cache just .#book`
|
To build the documentation locally:
|
||||||
|
|
||||||
The output of the mdbook generation is in `result/`. mdbooks can be opened in
|
1. Install mdbook if you don't have it already:
|
||||||
your browser from the individual HTML files without any web server needed.
|
```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.
|
||||||
|
|
||||||
### Inclusivity and Diversity
|
### Inclusivity and Diversity
|
||||||
|
|
||||||
|
@ -109,41 +133,70 @@ Rust's default style and standards with regards to [function names, variable
|
||||||
names, comments](https://rust-lang.github.io/api-guidelines/naming.html), etc
|
names, comments](https://rust-lang.github.io/api-guidelines/naming.html), etc
|
||||||
applies here.
|
applies here.
|
||||||
|
|
||||||
|
### 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
|
### Creating pull requests
|
||||||
|
|
||||||
Please try to keep contributions to the GitHub. While the mirrors of conduwuit
|
Please try to keep contributions to the Forgejo Instance. While the mirrors of continuwuity
|
||||||
allow for pull/merge requests, there is no guarantee I will see them in a timely
|
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.
|
manner. Additionally, please mark WIP or unfinished or incomplete PRs as drafts.
|
||||||
This prevents me from having to ping once in a while to double check the status
|
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
|
of it, especially when the CI completed successfully and everything so it
|
||||||
*looks* done.
|
*looks* done.
|
||||||
|
|
||||||
If you open a pull request on one of the mirrors, it is your responsibility to
|
Before submitting a pull request, please ensure:
|
||||||
inform me about its existence. In the future I may try to solve this with more
|
1. Your code passes all CI checks (formatting, linting, typo detection, etc.)
|
||||||
repo bots in the conduwuit Matrix room. There is no mailing list or email-patch
|
2. Your commit messages follow the conventional commits format
|
||||||
support on the sr.ht mirror, but if you'd like to email me a git patch you can
|
3. Tests are added for new functionality
|
||||||
do so at `strawberry@puppygock.gay`.
|
4. Documentation is updated if needed
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Direct all PRs/MRs to the `main` branch.
|
Direct all PRs/MRs to the `main` branch.
|
||||||
|
|
||||||
By sending a pull request or patch, you are agreeing that your changes are
|
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
|
allowed to be licenced under the Apache-2.0 licence and all of your conduct is
|
||||||
in line with the Contributor's Covenant, and conduwuit's Code of Conduct.
|
in line with the Contributor's Covenant, and continuwuity's Code of Conduct.
|
||||||
|
|
||||||
Contribution by users who violate either of these code of conducts will not have
|
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
|
their contributions accepted. This includes users who have been banned from
|
||||||
conduwuit Matrix rooms for Code of Conduct violations.
|
continuwuity Matrix rooms for Code of Conduct violations.
|
||||||
|
|
||||||
[issues]: https://github.com/girlbossceo/conduwuit/issues
|
[issues]: https://forgejo.ellis.link/continuwuation/continuwuity/issues
|
||||||
[conduwuit-matrix]: https://matrix.to/#/#conduwuit:puppygock.gay
|
[continuwuity-matrix]: https://matrix.to/#/#continuwuity:continuwuity.org
|
||||||
[complement]: https://github.com/matrix-org/complement/
|
[complement]: https://github.com/matrix-org/complement/
|
||||||
[engage.toml]: https://github.com/girlbossceo/conduwuit/blob/main/engage.toml
|
|
||||||
[engage]: https://charles.page.computer.surgery/engage/
|
|
||||||
[sytest]: https://github.com/matrix-org/sytest/
|
[sytest]: https://github.com/matrix-org/sytest/
|
||||||
[cargo-deb]: https://github.com/kornelski/cargo-deb
|
|
||||||
[lychee]: https://github.com/lycheeverse/lychee
|
|
||||||
[markdownlint-cli]: https://github.com/igorshubovych/markdownlint-cli
|
|
||||||
[cargo-audit]: https://github.com/RustSec/rustsec/tree/main/cargo-audit
|
|
||||||
[direnv]: https://direnv.net/
|
|
||||||
[mdbook]: https://rust-lang.github.io/mdBook/
|
[mdbook]: https://rust-lang.github.io/mdBook/
|
||||||
[documentation.yml]: https://github.com/girlbossceo/conduwuit/blob/main/.github/workflows/documentation.yml
|
[documentation.yml]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/.forgejo/workflows/documentation.yml
|
||||||
|
|
1074
Cargo.lock
generated
1074
Cargo.lock
generated
File diff suppressed because it is too large
Load diff
37
Cargo.toml
37
Cargo.toml
|
@ -21,7 +21,7 @@ license = "Apache-2.0"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
repository = "https://forgejo.ellis.link/continuwuation/continuwuity"
|
repository = "https://forgejo.ellis.link/continuwuation/continuwuity"
|
||||||
rust-version = "1.86.0"
|
rust-version = "1.86.0"
|
||||||
version = "0.5.0-rc.5"
|
version = "0.5.0-rc.6"
|
||||||
|
|
||||||
[workspace.metadata.crane]
|
[workspace.metadata.crane]
|
||||||
name = "conduwuit"
|
name = "conduwuit"
|
||||||
|
@ -298,7 +298,7 @@ version = "1.15.0"
|
||||||
default-features = false
|
default-features = false
|
||||||
features = ["serde"]
|
features = ["serde"]
|
||||||
|
|
||||||
# Used for reading the configuration from conduwuit.toml & environment variables
|
# Used for reading the configuration from continuwuity.toml & environment variables
|
||||||
[workspace.dependencies.figment]
|
[workspace.dependencies.figment]
|
||||||
version = "0.10.19"
|
version = "0.10.19"
|
||||||
default-features = false
|
default-features = false
|
||||||
|
@ -350,7 +350,7 @@ version = "0.1.2"
|
||||||
[workspace.dependencies.ruma]
|
[workspace.dependencies.ruma]
|
||||||
git = "https://forgejo.ellis.link/continuwuation/ruwuma"
|
git = "https://forgejo.ellis.link/continuwuation/ruwuma"
|
||||||
#branch = "conduwuit-changes"
|
#branch = "conduwuit-changes"
|
||||||
rev = "fa3c868e5a1c049dc9472310dc4955289a96bb35"
|
rev = "d6870a7fb7f6cccff63f7fd0ff6c581bad80e983"
|
||||||
features = [
|
features = [
|
||||||
"compat",
|
"compat",
|
||||||
"rand",
|
"rand",
|
||||||
|
@ -556,11 +556,11 @@ rev = "1e64095a8051a1adf0d1faa307f9f030889ec2aa"
|
||||||
git = "https://forgejo.ellis.link/continuwuation/tracing"
|
git = "https://forgejo.ellis.link/continuwuation/tracing"
|
||||||
rev = "1e64095a8051a1adf0d1faa307f9f030889ec2aa"
|
rev = "1e64095a8051a1adf0d1faa307f9f030889ec2aa"
|
||||||
|
|
||||||
# adds a tab completion callback: https://forgejo.ellis.link/continuwuation/rustyline-async/commit/de26100b0db03e419a3d8e1dd26895d170d1fe50
|
# 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/commit/67d8c49aeac03a5ef4e818f663eaa94dd7bf339b
|
# 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]
|
[patch.crates-io.rustyline-async]
|
||||||
git = "https://forgejo.ellis.link/continuwuation/rustyline-async"
|
git = "https://forgejo.ellis.link/continuwuation/rustyline-async"
|
||||||
rev = "deaeb0694e2083f53d363b648da06e10fc13900c"
|
rev = "e9f01cf8c6605483cb80b3b0309b400940493d7f"
|
||||||
|
|
||||||
# adds LIFO queue scheduling; this should be updated with PR progress.
|
# adds LIFO queue scheduling; this should be updated with PR progress.
|
||||||
[patch.crates-io.event-listener]
|
[patch.crates-io.event-listener]
|
||||||
|
@ -580,12 +580,11 @@ rev = "9c8e51510c35077df888ee72a36b4b05637147da"
|
||||||
git = "https://forgejo.ellis.link/continuwuation/hyper-util"
|
git = "https://forgejo.ellis.link/continuwuation/hyper-util"
|
||||||
rev = "e4ae7628fe4fcdacef9788c4c8415317a4489941"
|
rev = "e4ae7628fe4fcdacef9788c4c8415317a4489941"
|
||||||
|
|
||||||
# allows no-aaaa option in resolv.conf
|
# Allows no-aaaa option in resolv.conf
|
||||||
# bumps rust edition and toolchain to 1.86.0 and 2024
|
# Use 1-indexed line numbers when displaying parse error messages
|
||||||
# use sat_add on line number errors
|
|
||||||
[patch.crates-io.resolv-conf]
|
[patch.crates-io.resolv-conf]
|
||||||
git = "https://forgejo.ellis.link/continuwuation/resolv-conf"
|
git = "https://forgejo.ellis.link/continuwuation/resolv-conf"
|
||||||
rev = "200e958941d522a70c5877e3d846f55b5586c68d"
|
rev = "56251316cc4127bcbf36e68ce5e2093f4d33e227"
|
||||||
|
|
||||||
#
|
#
|
||||||
# Our crates
|
# Our crates
|
||||||
|
@ -626,6 +625,17 @@ package = "conduwuit_macros"
|
||||||
path = "src/macros"
|
path = "src/macros"
|
||||||
default-features = false
|
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
|
||||||
|
|
||||||
###############################################################################
|
###############################################################################
|
||||||
#
|
#
|
||||||
# Release profiles
|
# Release profiles
|
||||||
|
@ -734,7 +744,6 @@ incremental = true
|
||||||
|
|
||||||
[profile.dev.package.conduwuit_core]
|
[profile.dev.package.conduwuit_core]
|
||||||
inherits = "dev"
|
inherits = "dev"
|
||||||
incremental = false
|
|
||||||
#rustflags = [
|
#rustflags = [
|
||||||
# '--cfg', 'conduwuit_mods',
|
# '--cfg', 'conduwuit_mods',
|
||||||
# '-Ztime-passes',
|
# '-Ztime-passes',
|
||||||
|
@ -774,7 +783,6 @@ inherits = "dev"
|
||||||
[profile.dev.package.'*']
|
[profile.dev.package.'*']
|
||||||
inherits = "dev"
|
inherits = "dev"
|
||||||
debug = 'limited'
|
debug = 'limited'
|
||||||
incremental = false
|
|
||||||
codegen-units = 1
|
codegen-units = 1
|
||||||
opt-level = 'z'
|
opt-level = 'z'
|
||||||
#rustflags = [
|
#rustflags = [
|
||||||
|
@ -796,7 +804,6 @@ inherits = "dev"
|
||||||
strip = false
|
strip = false
|
||||||
opt-level = 0
|
opt-level = 0
|
||||||
codegen-units = 16
|
codegen-units = 16
|
||||||
incremental = false
|
|
||||||
|
|
||||||
[profile.test.package.'*']
|
[profile.test.package.'*']
|
||||||
inherits = "dev"
|
inherits = "dev"
|
||||||
|
@ -804,7 +811,6 @@ debug = 0
|
||||||
strip = false
|
strip = false
|
||||||
opt-level = 0
|
opt-level = 0
|
||||||
codegen-units = 16
|
codegen-units = 16
|
||||||
incremental = false
|
|
||||||
|
|
||||||
###############################################################################
|
###############################################################################
|
||||||
#
|
#
|
||||||
|
@ -981,3 +987,6 @@ let_underscore_future = { level = "allow", priority = 1 }
|
||||||
|
|
||||||
# rust doesnt understand conduwuit's custom log macros
|
# rust doesnt understand conduwuit's custom log macros
|
||||||
literal_string_with_formatting_args = { level = "allow", priority = 1 }
|
literal_string_with_formatting_args = { level = "allow", priority = 1 }
|
||||||
|
|
||||||
|
|
||||||
|
needless_raw_string_hashes = "allow"
|
||||||
|
|
16
README.md
16
README.md
|
@ -11,12 +11,19 @@ It's a community continuation of the [conduwuit](https://github.com/girlbossceo/
|
||||||
|
|
||||||
<!-- ANCHOR: body -->
|
<!-- 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?
|
### 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.
|
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 Conduit users and welcome newcomers seeking a lightweight, efficient Matrix homeserver.
|
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?
|
### Who are we?
|
||||||
|
|
||||||
|
@ -46,15 +53,14 @@ Continuwuity aims to:
|
||||||
|
|
||||||
### Can I try it out?
|
### Can I try it out?
|
||||||
|
|
||||||
Not right now. We've still got work to do!
|
Check out the [documentation](introduction) for installation instructions.
|
||||||
|
|
||||||
|
There are currently no open registration Continuwuity instances available.
|
||||||
|
|
||||||
### What are we working on?
|
### 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).
|
We're working our way through all of the issues in the [Forgejo project](https://forgejo.ellis.link/continuwuation/continuwuity/issues).
|
||||||
|
|
||||||
- [Replacing old conduwuit links with working continuwuity links](https://forgejo.ellis.link/continuwuation/continuwuity/issues/742)
|
|
||||||
- [Getting CI and docs deployment working on the new Forgejo project](https://forgejo.ellis.link/continuwuation/continuwuity/issues/740)
|
|
||||||
- [Packaging & availability in more places](https://forgejo.ellis.link/continuwuation/continuwuity/issues/747)
|
- [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)
|
- [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)
|
- [Improving compatibility and spec compliance](https://forgejo.ellis.link/continuwuation/continuwuity/issues?labels=119)
|
||||||
|
@ -105,7 +111,7 @@ When incorporating code from other forks:
|
||||||
|
|
||||||
#### Contact
|
#### Contact
|
||||||
|
|
||||||
<!-- TODO: contact details -->
|
Join our [Matrix room](https://matrix.to/#/#continuwuity:continuwuity.org) and [space](https://matrix.to/#/#space:continuwuity.org) to chat with us about the project!
|
||||||
|
|
||||||
<!-- ANCHOR_END: footer -->
|
<!-- ANCHOR_END: footer -->
|
||||||
|
|
||||||
|
|
63
SECURITY.md
Normal file
63
SECURITY.md
Normal file
|
@ -0,0 +1,63 @@
|
||||||
|
# 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,8 +1,9 @@
|
||||||
[Unit]
|
[Unit]
|
||||||
Description=conduwuit Matrix homeserver
|
|
||||||
|
Description=Continuwuity - Matrix homeserver
|
||||||
Wants=network-online.target
|
Wants=network-online.target
|
||||||
After=network-online.target
|
After=network-online.target
|
||||||
Documentation=https://conduwuit.puppyirl.gay/
|
Documentation=https://continuwuity.org/
|
||||||
RequiresMountsFor=/var/lib/private/conduwuit
|
RequiresMountsFor=/var/lib/private/conduwuit
|
||||||
Alias=matrix-conduwuit.service
|
Alias=matrix-conduwuit.service
|
||||||
|
|
||||||
|
@ -59,7 +60,8 @@ StateDirectory=conduwuit
|
||||||
RuntimeDirectory=conduwuit
|
RuntimeDirectory=conduwuit
|
||||||
RuntimeDirectoryMode=0750
|
RuntimeDirectoryMode=0750
|
||||||
|
|
||||||
Environment="CONDUWUIT_CONFIG=/etc/conduwuit/conduwuit.toml"
|
Environment=CONTINUWUITY_CONFIG=${CREDENTIALS_DIRECTORY}/config.toml
|
||||||
|
LoadCredential=config.toml:/etc/conduwuit/conduwuit.toml
|
||||||
BindPaths=/var/lib/private/conduwuit:/var/lib/matrix-conduit
|
BindPaths=/var/lib/private/conduwuit:/var/lib/matrix-conduit
|
||||||
BindPaths=/var/lib/private/conduwuit:/var/lib/private/matrix-conduit
|
BindPaths=/var/lib/private/conduwuit:/var/lib/private/matrix-conduit
|
||||||
|
|
||||||
|
|
2
committed.toml
Normal file
2
committed.toml
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
style = "conventional"
|
||||||
|
allowed_types = ["ci", "build", "fix", "feat", "chore", "docs", "style", "refactor", "perf", "test"]
|
|
@ -1,4 +1,4 @@
|
||||||
### conduwuit Configuration
|
### continuwuity Configuration
|
||||||
###
|
###
|
||||||
### THIS FILE IS GENERATED. CHANGES/CONTRIBUTIONS IN THE REPO WILL BE
|
### THIS FILE IS GENERATED. CHANGES/CONTRIBUTIONS IN THE REPO WILL BE
|
||||||
### OVERWRITTEN!
|
### OVERWRITTEN!
|
||||||
|
@ -13,7 +13,7 @@
|
||||||
### that say "YOU NEED TO EDIT THIS".
|
### that say "YOU NEED TO EDIT THIS".
|
||||||
###
|
###
|
||||||
### For more information, see:
|
### For more information, see:
|
||||||
### https://conduwuit.puppyirl.gay/configuration.html
|
### https://continuwuity.org/configuration.html
|
||||||
|
|
||||||
[global]
|
[global]
|
||||||
|
|
||||||
|
@ -21,7 +21,7 @@
|
||||||
# suffix for user and room IDs/aliases.
|
# suffix for user and room IDs/aliases.
|
||||||
#
|
#
|
||||||
# See the docs for reverse proxying and delegation:
|
# See the docs for reverse proxying and delegation:
|
||||||
# https://conduwuit.puppyirl.gay/deploying/generic.html#setting-up-the-reverse-proxy
|
# https://continuwuity.org/deploying/generic.html#setting-up-the-reverse-proxy
|
||||||
#
|
#
|
||||||
# Also see the `[global.well_known]` config section at the very bottom.
|
# Also see the `[global.well_known]` config section at the very bottom.
|
||||||
#
|
#
|
||||||
|
@ -32,11 +32,11 @@
|
||||||
# YOU NEED TO EDIT THIS. THIS CANNOT BE CHANGED AFTER WITHOUT A DATABASE
|
# YOU NEED TO EDIT THIS. THIS CANNOT BE CHANGED AFTER WITHOUT A DATABASE
|
||||||
# WIPE.
|
# WIPE.
|
||||||
#
|
#
|
||||||
# example: "conduwuit.woof"
|
# example: "continuwuity.org"
|
||||||
#
|
#
|
||||||
#server_name =
|
#server_name =
|
||||||
|
|
||||||
# The default address (IPv4 or IPv6) conduwuit will listen on.
|
# The default address (IPv4 or IPv6) continuwuity will listen on.
|
||||||
#
|
#
|
||||||
# If you are using Docker or a container NAT networking setup, this must
|
# If you are using Docker or a container NAT networking setup, this must
|
||||||
# be "0.0.0.0".
|
# be "0.0.0.0".
|
||||||
|
@ -46,10 +46,10 @@
|
||||||
#
|
#
|
||||||
#address = ["127.0.0.1", "::1"]
|
#address = ["127.0.0.1", "::1"]
|
||||||
|
|
||||||
# The port(s) conduwuit will listen on.
|
# The port(s) continuwuity will listen on.
|
||||||
#
|
#
|
||||||
# For reverse proxying, see:
|
# For reverse proxying, see:
|
||||||
# https://conduwuit.puppyirl.gay/deploying/generic.html#setting-up-the-reverse-proxy
|
# https://continuwuity.org/deploying/generic.html#setting-up-the-reverse-proxy
|
||||||
#
|
#
|
||||||
# If you are using Docker, don't change this, you'll need to map an
|
# If you are using Docker, don't change this, you'll need to map an
|
||||||
# external port to this.
|
# external port to this.
|
||||||
|
@ -58,16 +58,17 @@
|
||||||
#
|
#
|
||||||
#port = 8008
|
#port = 8008
|
||||||
|
|
||||||
# The UNIX socket conduwuit will listen on.
|
# The UNIX socket continuwuity will listen on.
|
||||||
#
|
#
|
||||||
# conduwuit cannot listen on both an IP address and a UNIX socket. If
|
# continuwuity cannot listen on both an IP address and a UNIX socket. If
|
||||||
# listening on a UNIX socket, you MUST remove/comment the `address` key.
|
# listening on a UNIX socket, you MUST remove/comment the `address` key.
|
||||||
#
|
#
|
||||||
# Remember to make sure that your reverse proxy has access to this socket
|
# Remember to make sure that your reverse proxy has access to this socket
|
||||||
# file, either by adding your reverse proxy to the 'conduwuit' group or
|
# file, either by adding your reverse proxy to the appropriate user group
|
||||||
# granting world R/W permissions with `unix_socket_perms` (666 minimum).
|
# or granting world R/W permissions with `unix_socket_perms` (666
|
||||||
|
# minimum).
|
||||||
#
|
#
|
||||||
# example: "/run/conduwuit/conduwuit.sock"
|
# example: "/run/continuwuity/continuwuity.sock"
|
||||||
#
|
#
|
||||||
#unix_socket_path =
|
#unix_socket_path =
|
||||||
|
|
||||||
|
@ -75,23 +76,23 @@
|
||||||
#
|
#
|
||||||
#unix_socket_perms = 660
|
#unix_socket_perms = 660
|
||||||
|
|
||||||
# This is the only directory where conduwuit will save its data, including
|
# This is the only directory where continuwuity will save its data,
|
||||||
# media. Note: this was previously "/var/lib/matrix-conduit".
|
# including media. Note: this was previously "/var/lib/matrix-conduit".
|
||||||
#
|
#
|
||||||
# YOU NEED TO EDIT THIS.
|
# YOU NEED TO EDIT THIS.
|
||||||
#
|
#
|
||||||
# example: "/var/lib/conduwuit"
|
# example: "/var/lib/continuwuity"
|
||||||
#
|
#
|
||||||
#database_path =
|
#database_path =
|
||||||
|
|
||||||
# conduwuit supports online database backups using RocksDB's Backup engine
|
# continuwuity supports online database backups using RocksDB's Backup
|
||||||
# API. To use this, set a database backup path that conduwuit can write
|
# engine API. To use this, set a database backup path that continuwuity
|
||||||
# to.
|
# can write to.
|
||||||
#
|
#
|
||||||
# For more information, see:
|
# For more information, see:
|
||||||
# https://conduwuit.puppyirl.gay/maintenance.html#backups
|
# https://continuwuity.org/maintenance.html#backups
|
||||||
#
|
#
|
||||||
# example: "/opt/conduwuit-db-backups"
|
# example: "/opt/continuwuity-db-backups"
|
||||||
#
|
#
|
||||||
#database_backup_path =
|
#database_backup_path =
|
||||||
|
|
||||||
|
@ -112,14 +113,14 @@
|
||||||
#
|
#
|
||||||
#new_user_displayname_suffix = "🏳️⚧️"
|
#new_user_displayname_suffix = "🏳️⚧️"
|
||||||
|
|
||||||
# If enabled, conduwuit will send a simple GET request periodically to
|
# If enabled, continuwuity will send a simple GET request periodically to
|
||||||
# `https://continuwuity.org/.well-known/continuwuity/announcements` for any new
|
# `https://continuwuity.org/.well-known/continuwuity/announcements` for any new
|
||||||
# announcements or major updates. This is not an update check endpoint.
|
# announcements or major updates. This is not an update check endpoint.
|
||||||
#
|
#
|
||||||
#allow_announcements_check =
|
#allow_announcements_check = true
|
||||||
|
|
||||||
# Set this to any float value to multiply conduwuit's in-memory LRU caches
|
# Set this to any float value to multiply continuwuity's in-memory LRU
|
||||||
# with such as "auth_chain_cache_capacity".
|
# caches with such as "auth_chain_cache_capacity".
|
||||||
#
|
#
|
||||||
# May be useful if you have significant memory to spare to increase
|
# May be useful if you have significant memory to spare to increase
|
||||||
# performance.
|
# performance.
|
||||||
|
@ -131,7 +132,7 @@
|
||||||
#
|
#
|
||||||
#cache_capacity_modifier = 1.0
|
#cache_capacity_modifier = 1.0
|
||||||
|
|
||||||
# Set this to any float value in megabytes for conduwuit to tell the
|
# Set this to any float value in megabytes for continuwuity to tell the
|
||||||
# database engine that this much memory is available for database read
|
# database engine that this much memory is available for database read
|
||||||
# caches.
|
# caches.
|
||||||
#
|
#
|
||||||
|
@ -145,7 +146,7 @@
|
||||||
#
|
#
|
||||||
#db_cache_capacity_mb = varies by system
|
#db_cache_capacity_mb = varies by system
|
||||||
|
|
||||||
# Set this to any float value in megabytes for conduwuit to tell the
|
# Set this to any float value in megabytes for continuwuity to tell the
|
||||||
# database engine that this much memory is available for database write
|
# database engine that this much memory is available for database write
|
||||||
# caches.
|
# caches.
|
||||||
#
|
#
|
||||||
|
@ -250,9 +251,9 @@
|
||||||
# Enable using *only* TCP for querying your specified nameservers instead
|
# Enable using *only* TCP for querying your specified nameservers instead
|
||||||
# of UDP.
|
# of UDP.
|
||||||
#
|
#
|
||||||
# If you are running conduwuit in a container environment, this config
|
# If you are running continuwuity in a container environment, this config
|
||||||
# option may need to be enabled. For more details, see:
|
# option may need to be enabled. For more details, see:
|
||||||
# https://conduwuit.puppyirl.gay/troubleshooting.html#potential-dns-issues-when-using-docker
|
# https://continuwuity.org/troubleshooting.html#potential-dns-issues-when-using-docker
|
||||||
#
|
#
|
||||||
#query_over_tcp_only = false
|
#query_over_tcp_only = false
|
||||||
|
|
||||||
|
@ -418,9 +419,9 @@
|
||||||
# tokens. Multiple tokens can be added if you separate them with
|
# tokens. Multiple tokens can be added if you separate them with
|
||||||
# whitespace
|
# whitespace
|
||||||
#
|
#
|
||||||
# conduwuit must be able to access the file, and it must not be empty
|
# continuwuity must be able to access the file, and it must not be empty
|
||||||
#
|
#
|
||||||
# example: "/etc/conduwuit/.reg_token"
|
# example: "/etc/continuwuity/.reg_token"
|
||||||
#
|
#
|
||||||
#registration_token_file =
|
#registration_token_file =
|
||||||
|
|
||||||
|
@ -512,16 +513,16 @@
|
||||||
#allow_room_creation = true
|
#allow_room_creation = true
|
||||||
|
|
||||||
# Set to false to disable users from joining or creating room versions
|
# Set to false to disable users from joining or creating room versions
|
||||||
# that aren't officially supported by conduwuit.
|
# that aren't officially supported by continuwuity.
|
||||||
#
|
#
|
||||||
# conduwuit officially supports room versions 6 - 11.
|
# continuwuity officially supports room versions 6 - 11.
|
||||||
#
|
#
|
||||||
# conduwuit has slightly experimental (though works fine in practice)
|
# continuwuity has slightly experimental (though works fine in practice)
|
||||||
# support for versions 3 - 5.
|
# support for versions 3 - 5.
|
||||||
#
|
#
|
||||||
#allow_unstable_room_versions = true
|
#allow_unstable_room_versions = true
|
||||||
|
|
||||||
# Default room version conduwuit will create rooms with.
|
# Default room version continuwuity will create rooms with.
|
||||||
#
|
#
|
||||||
# Per spec, room version 11 is the default.
|
# Per spec, room version 11 is the default.
|
||||||
#
|
#
|
||||||
|
@ -587,7 +588,7 @@
|
||||||
# Servers listed here will be used to gather public keys of other servers
|
# Servers listed here will be used to gather public keys of other servers
|
||||||
# (notary trusted key servers).
|
# (notary trusted key servers).
|
||||||
#
|
#
|
||||||
# Currently, conduwuit doesn't support inbound batched key requests, so
|
# Currently, continuwuity doesn't support inbound batched key requests, so
|
||||||
# this list should only contain other Synapse servers.
|
# this list should only contain other Synapse servers.
|
||||||
#
|
#
|
||||||
# example: ["matrix.org", "tchncs.de"]
|
# example: ["matrix.org", "tchncs.de"]
|
||||||
|
@ -628,7 +629,7 @@
|
||||||
#
|
#
|
||||||
#trusted_server_batch_size = 1024
|
#trusted_server_batch_size = 1024
|
||||||
|
|
||||||
# Max log level for conduwuit. Allows debug, info, warn, or error.
|
# Max log level for continuwuity. Allows debug, info, warn, or error.
|
||||||
#
|
#
|
||||||
# See also:
|
# See also:
|
||||||
# https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives
|
# https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives
|
||||||
|
@ -649,8 +650,9 @@
|
||||||
#
|
#
|
||||||
#log_span_events = "none"
|
#log_span_events = "none"
|
||||||
|
|
||||||
# Configures whether CONDUWUIT_LOG EnvFilter matches values using regular
|
# Configures whether CONTINUWUITY_LOG EnvFilter matches values using
|
||||||
# expressions. See the tracing_subscriber documentation on Directives.
|
# regular expressions. See the tracing_subscriber documentation on
|
||||||
|
# Directives.
|
||||||
#
|
#
|
||||||
#log_filter_regex = true
|
#log_filter_regex = true
|
||||||
|
|
||||||
|
@ -718,7 +720,7 @@
|
||||||
# This takes priority over "turn_secret" first, and falls back to
|
# This takes priority over "turn_secret" first, and falls back to
|
||||||
# "turn_secret" if invalid or failed to open.
|
# "turn_secret" if invalid or failed to open.
|
||||||
#
|
#
|
||||||
# example: "/etc/conduwuit/.turn_secret"
|
# example: "/etc/continuwuity/.turn_secret"
|
||||||
#
|
#
|
||||||
#turn_secret_file =
|
#turn_secret_file =
|
||||||
|
|
||||||
|
@ -726,12 +728,12 @@
|
||||||
#
|
#
|
||||||
#turn_ttl = 86400
|
#turn_ttl = 86400
|
||||||
|
|
||||||
# List/vector of room IDs or room aliases that conduwuit will make newly
|
# List/vector of room IDs or room aliases that continuwuity will make
|
||||||
# registered users join. The rooms specified must be rooms that you have
|
# newly registered users join. The rooms specified must be rooms that you
|
||||||
# joined at least once on the server, and must be public.
|
# have joined at least once on the server, and must be public.
|
||||||
#
|
#
|
||||||
# example: ["#conduwuit:puppygock.gay",
|
# example: ["#continuwuity:continuwuity.org",
|
||||||
# "!eoIzvAvVwY23LPDay8:puppygock.gay"]
|
# "!main-1:continuwuity.org"]
|
||||||
#
|
#
|
||||||
#auto_join_rooms = []
|
#auto_join_rooms = []
|
||||||
|
|
||||||
|
@ -754,10 +756,10 @@
|
||||||
#
|
#
|
||||||
#auto_deactivate_banned_room_attempts = false
|
#auto_deactivate_banned_room_attempts = false
|
||||||
|
|
||||||
# RocksDB log level. This is not the same as conduwuit's log level. This
|
# RocksDB log level. This is not the same as continuwuity's log level.
|
||||||
# is the log level for the RocksDB engine/library which show up in your
|
# This is the log level for the RocksDB engine/library which show up in
|
||||||
# database folder/path as `LOG` files. conduwuit will log RocksDB errors
|
# your database folder/path as `LOG` files. continuwuity will log RocksDB
|
||||||
# as normal through tracing or panics if severe for safety.
|
# errors as normal through tracing or panics if severe for safety.
|
||||||
#
|
#
|
||||||
#rocksdb_log_level = "error"
|
#rocksdb_log_level = "error"
|
||||||
|
|
||||||
|
@ -777,7 +779,7 @@
|
||||||
# Set this to true to use RocksDB config options that are tailored to HDDs
|
# Set this to true to use RocksDB config options that are tailored to HDDs
|
||||||
# (slower device storage).
|
# (slower device storage).
|
||||||
#
|
#
|
||||||
# It is worth noting that by default, conduwuit will use RocksDB with
|
# It is worth noting that by default, continuwuity will use RocksDB with
|
||||||
# Direct IO enabled. *Generally* speaking this improves performance as it
|
# Direct IO enabled. *Generally* speaking this improves performance as it
|
||||||
# bypasses buffered I/O (system page cache). However there is a potential
|
# bypasses buffered I/O (system page cache). However there is a potential
|
||||||
# chance that Direct IO may cause issues with database operations if your
|
# chance that Direct IO may cause issues with database operations if your
|
||||||
|
@ -785,7 +787,7 @@
|
||||||
# possibly ZFS filesystem. RocksDB generally deals/corrects these issues
|
# possibly ZFS filesystem. RocksDB generally deals/corrects these issues
|
||||||
# but it cannot account for all setups. If you experience any weird
|
# but it cannot account for all setups. If you experience any weird
|
||||||
# RocksDB issues, try enabling this option as it turns off Direct IO and
|
# RocksDB issues, try enabling this option as it turns off Direct IO and
|
||||||
# feel free to report in the conduwuit Matrix room if this option fixes
|
# feel free to report in the continuwuity Matrix room if this option fixes
|
||||||
# your DB issues.
|
# your DB issues.
|
||||||
#
|
#
|
||||||
# For more information, see:
|
# For more information, see:
|
||||||
|
@ -840,7 +842,7 @@
|
||||||
# as they all differ. See their `kDefaultCompressionLevel`.
|
# as they all differ. See their `kDefaultCompressionLevel`.
|
||||||
#
|
#
|
||||||
# Note when using the default value we may override it with a setting
|
# Note when using the default value we may override it with a setting
|
||||||
# tailored specifically conduwuit.
|
# tailored specifically for continuwuity.
|
||||||
#
|
#
|
||||||
#rocksdb_compression_level = 32767
|
#rocksdb_compression_level = 32767
|
||||||
|
|
||||||
|
@ -856,7 +858,7 @@
|
||||||
# algorithm.
|
# algorithm.
|
||||||
#
|
#
|
||||||
# Note when using the default value we may override it with a setting
|
# Note when using the default value we may override it with a setting
|
||||||
# tailored specifically conduwuit.
|
# tailored specifically for continuwuity.
|
||||||
#
|
#
|
||||||
#rocksdb_bottommost_compression_level = 32767
|
#rocksdb_bottommost_compression_level = 32767
|
||||||
|
|
||||||
|
@ -896,13 +898,13 @@
|
||||||
# 0 = AbsoluteConsistency
|
# 0 = AbsoluteConsistency
|
||||||
# 1 = TolerateCorruptedTailRecords (default)
|
# 1 = TolerateCorruptedTailRecords (default)
|
||||||
# 2 = PointInTime (use me if trying to recover)
|
# 2 = PointInTime (use me if trying to recover)
|
||||||
# 3 = SkipAnyCorruptedRecord (you now voided your Conduwuit warranty)
|
# 3 = SkipAnyCorruptedRecord (you now voided your Continuwuity warranty)
|
||||||
#
|
#
|
||||||
# For more information on these modes, see:
|
# For more information on these modes, see:
|
||||||
# https://github.com/facebook/rocksdb/wiki/WAL-Recovery-Modes
|
# https://github.com/facebook/rocksdb/wiki/WAL-Recovery-Modes
|
||||||
#
|
#
|
||||||
# For more details on recovering a corrupt database, see:
|
# For more details on recovering a corrupt database, see:
|
||||||
# https://conduwuit.puppyirl.gay/troubleshooting.html#database-corruption
|
# https://continuwuity.org/troubleshooting.html#database-corruption
|
||||||
#
|
#
|
||||||
#rocksdb_recovery_mode = 1
|
#rocksdb_recovery_mode = 1
|
||||||
|
|
||||||
|
@ -942,7 +944,7 @@
|
||||||
# - Disabling repair mode and restarting the server is recommended after
|
# - Disabling repair mode and restarting the server is recommended after
|
||||||
# running the repair.
|
# running the repair.
|
||||||
#
|
#
|
||||||
# See https://conduwuit.puppyirl.gay/troubleshooting.html#database-corruption for more details on recovering a corrupt database.
|
# See https://continuwuity.org/troubleshooting.html#database-corruption for more details on recovering a corrupt database.
|
||||||
#
|
#
|
||||||
#rocksdb_repair = false
|
#rocksdb_repair = false
|
||||||
|
|
||||||
|
@ -967,9 +969,9 @@
|
||||||
#rocksdb_compaction_ioprio_idle = true
|
#rocksdb_compaction_ioprio_idle = true
|
||||||
|
|
||||||
# Enables RocksDB compaction. You should never ever have to set this
|
# Enables RocksDB compaction. You should never ever have to set this
|
||||||
# option to false. If you for some reason find yourself needing to use this
|
# option to false. If you for some reason find yourself needing to use
|
||||||
# option as part of troubleshooting or a bug, please reach out to us in
|
# this option as part of troubleshooting or a bug, please reach out to us
|
||||||
# the conduwuit Matrix room with information and details.
|
# in the continuwuity Matrix room with information and details.
|
||||||
#
|
#
|
||||||
# Disabling compaction will lead to a significantly bloated and
|
# Disabling compaction will lead to a significantly bloated and
|
||||||
# explosively large database, gradually poor performance, unnecessarily
|
# explosively large database, gradually poor performance, unnecessarily
|
||||||
|
@ -995,7 +997,7 @@
|
||||||
# purposes such as recovering/recreating your admin room, or inviting
|
# purposes such as recovering/recreating your admin room, or inviting
|
||||||
# yourself back.
|
# yourself back.
|
||||||
#
|
#
|
||||||
# See https://conduwuit.puppyirl.gay/troubleshooting.html#lost-access-to-admin-room for other ways to get back into your admin room.
|
# See https://continuwuity.org/troubleshooting.html#lost-access-to-admin-room for other ways to get back into your admin room.
|
||||||
#
|
#
|
||||||
# Once this password is unset, all sessions will be logged out for
|
# Once this password is unset, all sessions will be logged out for
|
||||||
# security purposes.
|
# security purposes.
|
||||||
|
@ -1010,8 +1012,8 @@
|
||||||
|
|
||||||
# Allow local (your server only) presence updates/requests.
|
# Allow local (your server only) presence updates/requests.
|
||||||
#
|
#
|
||||||
# Note that presence on conduwuit is very fast unlike Synapse's. If using
|
# Note that presence on continuwuity is very fast unlike Synapse's. If
|
||||||
# outgoing presence, this MUST be enabled.
|
# using outgoing presence, this MUST be enabled.
|
||||||
#
|
#
|
||||||
#allow_local_presence = true
|
#allow_local_presence = true
|
||||||
|
|
||||||
|
@ -1019,7 +1021,7 @@
|
||||||
#
|
#
|
||||||
# This option receives presence updates from other servers, but does not
|
# This option receives presence updates from other servers, but does not
|
||||||
# send any unless `allow_outgoing_presence` is true. Note that presence on
|
# send any unless `allow_outgoing_presence` is true. Note that presence on
|
||||||
# conduwuit is very fast unlike Synapse's.
|
# continuwuity is very fast unlike Synapse's.
|
||||||
#
|
#
|
||||||
#allow_incoming_presence = true
|
#allow_incoming_presence = true
|
||||||
|
|
||||||
|
@ -1027,8 +1029,8 @@
|
||||||
#
|
#
|
||||||
# This option sends presence updates to other servers, but does not
|
# This option sends presence updates to other servers, but does not
|
||||||
# receive any unless `allow_incoming_presence` is true. Note that presence
|
# receive any unless `allow_incoming_presence` is true. Note that presence
|
||||||
# on conduwuit is very fast unlike Synapse's. If using outgoing presence,
|
# on continuwuity is very fast unlike Synapse's. If using outgoing
|
||||||
# you MUST enable `allow_local_presence` as well.
|
# presence, you MUST enable `allow_local_presence` as well.
|
||||||
#
|
#
|
||||||
#allow_outgoing_presence = true
|
#allow_outgoing_presence = true
|
||||||
|
|
||||||
|
@ -1081,8 +1083,8 @@
|
||||||
#
|
#
|
||||||
#typing_client_timeout_max_s = 45
|
#typing_client_timeout_max_s = 45
|
||||||
|
|
||||||
# Set this to true for conduwuit to compress HTTP response bodies using
|
# Set this to true for continuwuity to compress HTTP response bodies using
|
||||||
# zstd. This option does nothing if conduwuit was not built with
|
# zstd. This option does nothing if continuwuity was not built with
|
||||||
# `zstd_compression` feature. Please be aware that enabling HTTP
|
# `zstd_compression` feature. Please be aware that enabling HTTP
|
||||||
# compression may weaken TLS. Most users should not need to enable this.
|
# compression may weaken TLS. Most users should not need to enable this.
|
||||||
# See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH
|
# See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH
|
||||||
|
@ -1090,8 +1092,8 @@
|
||||||
#
|
#
|
||||||
#zstd_compression = false
|
#zstd_compression = false
|
||||||
|
|
||||||
# Set this to true for conduwuit to compress HTTP response bodies using
|
# Set this to true for continuwuity to compress HTTP response bodies using
|
||||||
# gzip. This option does nothing if conduwuit was not built with
|
# gzip. This option does nothing if continuwuity was not built with
|
||||||
# `gzip_compression` feature. Please be aware that enabling HTTP
|
# `gzip_compression` feature. Please be aware that enabling HTTP
|
||||||
# compression may weaken TLS. Most users should not need to enable this.
|
# compression may weaken TLS. Most users should not need to enable this.
|
||||||
# See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH before
|
# See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH before
|
||||||
|
@ -1102,8 +1104,8 @@
|
||||||
#
|
#
|
||||||
#gzip_compression = false
|
#gzip_compression = false
|
||||||
|
|
||||||
# Set this to true for conduwuit to compress HTTP response bodies using
|
# Set this to true for continuwuity to compress HTTP response bodies using
|
||||||
# brotli. This option does nothing if conduwuit was not built with
|
# brotli. This option does nothing if continuwuity was not built with
|
||||||
# `brotli_compression` feature. Please be aware that enabling HTTP
|
# `brotli_compression` feature. Please be aware that enabling HTTP
|
||||||
# compression may weaken TLS. Most users should not need to enable this.
|
# compression may weaken TLS. Most users should not need to enable this.
|
||||||
# See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH
|
# See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH
|
||||||
|
@ -1165,7 +1167,7 @@
|
||||||
# Otherwise setting this to false reduces filesystem clutter and overhead
|
# Otherwise setting this to false reduces filesystem clutter and overhead
|
||||||
# for managing these symlinks in the directory. This is now disabled by
|
# for managing these symlinks in the directory. This is now disabled by
|
||||||
# default. You may still return to upstream Conduit but you have to run
|
# default. You may still return to upstream Conduit but you have to run
|
||||||
# conduwuit at least once with this set to true and allow the
|
# continuwuity at least once with this set to true and allow the
|
||||||
# media_startup_check to take place before shutting down to return to
|
# media_startup_check to take place before shutting down to return to
|
||||||
# Conduit.
|
# Conduit.
|
||||||
#
|
#
|
||||||
|
@ -1182,23 +1184,13 @@
|
||||||
#
|
#
|
||||||
#prune_missing_media = false
|
#prune_missing_media = false
|
||||||
|
|
||||||
# Vector list of regex patterns of server names that conduwuit will refuse
|
|
||||||
# to download remote media from.
|
|
||||||
#
|
|
||||||
# example: ["badserver\.tld$", "badphrase", "19dollarfortnitecards"]
|
|
||||||
#
|
|
||||||
#prevent_media_downloads_from = []
|
|
||||||
|
|
||||||
# List of forbidden server names via regex patterns that we will block
|
# List of forbidden server names via regex patterns that we will block
|
||||||
# incoming AND outgoing federation with, and block client room joins /
|
# incoming AND outgoing federation with, and block client room joins /
|
||||||
# remote user invites.
|
# remote user invites.
|
||||||
#
|
#
|
||||||
# Additionally, it will hide messages from these servers for all users
|
|
||||||
# on this server.
|
|
||||||
#
|
|
||||||
# Note that your messages can still make it to forbidden servers through
|
# Note that your messages can still make it to forbidden servers through
|
||||||
# backfilling. Events we receive from forbidden servers via backfill will
|
# backfilling. Events we receive from forbidden servers via backfill
|
||||||
# be stored in the database, but will not be sent to the client.
|
# from servers we *do* federate with will be stored in the database.
|
||||||
#
|
#
|
||||||
# This check is applied on the room ID, room alias, sender server name,
|
# This check is applied on the room ID, room alias, sender server name,
|
||||||
# sender user's server name, inbound federation X-Matrix origin, and
|
# sender user's server name, inbound federation X-Matrix origin, and
|
||||||
|
@ -1207,7 +1199,7 @@
|
||||||
# You can set this to ["*"] to block all servers by default, and then
|
# You can set this to ["*"] to block all servers by default, and then
|
||||||
# use `allowed_remote_server_names` to allow only specific servers.
|
# use `allowed_remote_server_names` to allow only specific servers.
|
||||||
#
|
#
|
||||||
# example: ["badserver\.tld$", "badphrase", "19dollarfortnitecards"]
|
# example: ["badserver\\.tld$", "badphrase", "19dollarfortnitecards"]
|
||||||
#
|
#
|
||||||
#forbidden_remote_server_names = []
|
#forbidden_remote_server_names = []
|
||||||
|
|
||||||
|
@ -1216,10 +1208,17 @@
|
||||||
#
|
#
|
||||||
# This option has no effect if `forbidden_remote_server_names` is empty.
|
# This option has no effect if `forbidden_remote_server_names` is empty.
|
||||||
#
|
#
|
||||||
# example: ["goodserver\.tld$", "goodphrase"]
|
# example: ["goodserver\\.tld$", "goodphrase"]
|
||||||
#
|
#
|
||||||
#allowed_remote_server_names = []
|
#allowed_remote_server_names = []
|
||||||
|
|
||||||
|
# Vector list of regex patterns of server names that continuwuity will
|
||||||
|
# refuse to download remote media from.
|
||||||
|
#
|
||||||
|
# example: ["badserver\.tld$", "badphrase", "19dollarfortnitecards"]
|
||||||
|
#
|
||||||
|
#prevent_media_downloads_from = []
|
||||||
|
|
||||||
# List of forbidden server names via regex patterns that we will block all
|
# List of forbidden server names via regex patterns that we will block all
|
||||||
# outgoing federated room directory requests for. Useful for preventing
|
# outgoing federated room directory requests for. Useful for preventing
|
||||||
# our users from wandering into bad servers or spaces.
|
# our users from wandering into bad servers or spaces.
|
||||||
|
@ -1228,8 +1227,31 @@
|
||||||
#
|
#
|
||||||
#forbidden_remote_room_directory_server_names = []
|
#forbidden_remote_room_directory_server_names = []
|
||||||
|
|
||||||
|
# Vector list of regex patterns of server names that continuwuity will not
|
||||||
|
# send messages to the client from.
|
||||||
|
#
|
||||||
|
# Note that there is no way for clients to receive messages once a server
|
||||||
|
# has become unignored without doing a full sync. This is a protocol
|
||||||
|
# limitation with the current sync protocols. This means this is somewhat
|
||||||
|
# of a nuclear option.
|
||||||
|
#
|
||||||
|
# example: ["reallybadserver\.tld$", "reallybadphrase",
|
||||||
|
# "69dollarfortnitecards"]
|
||||||
|
#
|
||||||
|
#ignore_messages_from_server_names = []
|
||||||
|
|
||||||
|
# Send messages from users that the user has ignored to the client.
|
||||||
|
#
|
||||||
|
# There is no way for clients to receive messages sent while a user was
|
||||||
|
# ignored without doing a full sync. This is a protocol limitation with
|
||||||
|
# the current sync protocols. Disabling this option will move
|
||||||
|
# responsibility of ignoring messages to the client, which can avoid this
|
||||||
|
# limitation.
|
||||||
|
#
|
||||||
|
#send_messages_from_ignored_users_to_client = false
|
||||||
|
|
||||||
# Vector list of IPv4 and IPv6 CIDR ranges / subnets *in quotes* that you
|
# Vector list of IPv4 and IPv6 CIDR ranges / subnets *in quotes* that you
|
||||||
# do not want conduwuit to send outbound requests to. Defaults to
|
# do not want continuwuity to send outbound requests to. Defaults to
|
||||||
# RFC1918, unroutable, loopback, multicast, and testnet addresses for
|
# RFC1918, unroutable, loopback, multicast, and testnet addresses for
|
||||||
# security.
|
# security.
|
||||||
#
|
#
|
||||||
|
@ -1379,26 +1401,26 @@
|
||||||
|
|
||||||
# Allow admins to enter commands in rooms other than "#admins" (admin
|
# Allow admins to enter commands in rooms other than "#admins" (admin
|
||||||
# room) by prefixing your message with "\!admin" or "\\!admin" followed up
|
# room) by prefixing your message with "\!admin" or "\\!admin" followed up
|
||||||
# a normal conduwuit admin command. The reply will be publicly visible to
|
# a normal continuwuity admin command. The reply will be publicly visible
|
||||||
# the room, originating from the sender.
|
# to the room, originating from the sender.
|
||||||
#
|
#
|
||||||
# example: \\!admin debug ping puppygock.gay
|
# example: \\!admin debug ping puppygock.gay
|
||||||
#
|
#
|
||||||
#admin_escape_commands = true
|
#admin_escape_commands = true
|
||||||
|
|
||||||
# Automatically activate the conduwuit admin room console / CLI on
|
# Automatically activate the continuwuity admin room console / CLI on
|
||||||
# startup. This option can also be enabled with `--console` conduwuit
|
# startup. This option can also be enabled with `--console` continuwuity
|
||||||
# argument.
|
# argument.
|
||||||
#
|
#
|
||||||
#admin_console_automatic = false
|
#admin_console_automatic = false
|
||||||
|
|
||||||
# List of admin commands to execute on startup.
|
# List of admin commands to execute on startup.
|
||||||
#
|
#
|
||||||
# This option can also be configured with the `--execute` conduwuit
|
# This option can also be configured with the `--execute` continuwuity
|
||||||
# argument and can take standard shell commands and environment variables
|
# argument and can take standard shell commands and environment variables
|
||||||
#
|
#
|
||||||
# For example: `./conduwuit --execute "server admin-notice conduwuit has
|
# For example: `./continuwuity --execute "server admin-notice continuwuity
|
||||||
# started up at $(date)"`
|
# has started up at $(date)"`
|
||||||
#
|
#
|
||||||
# example: admin_execute = ["debug ping puppygock.gay", "debug echo hi"]`
|
# example: admin_execute = ["debug ping puppygock.gay", "debug echo hi"]`
|
||||||
#
|
#
|
||||||
|
@ -1406,7 +1428,7 @@
|
||||||
|
|
||||||
# Ignore errors in startup commands.
|
# Ignore errors in startup commands.
|
||||||
#
|
#
|
||||||
# If false, conduwuit will error and fail to start if an admin execute
|
# If false, continuwuity will error and fail to start if an admin execute
|
||||||
# command (`--execute` / `admin_execute`) fails.
|
# command (`--execute` / `admin_execute`) fails.
|
||||||
#
|
#
|
||||||
#admin_execute_errors_ignore = false
|
#admin_execute_errors_ignore = false
|
||||||
|
@ -1427,15 +1449,14 @@
|
||||||
# The default room tag to apply on the admin room.
|
# The default room tag to apply on the admin room.
|
||||||
#
|
#
|
||||||
# On some clients like Element, the room tag "m.server_notice" is a
|
# On some clients like Element, the room tag "m.server_notice" is a
|
||||||
# special pinned room at the very bottom of your room list. The conduwuit
|
# special pinned room at the very bottom of your room list. The
|
||||||
# admin room can be pinned here so you always have an easy-to-access
|
# continuwuity admin room can be pinned here so you always have an
|
||||||
# shortcut dedicated to your admin room.
|
# easy-to-access shortcut dedicated to your admin room.
|
||||||
#
|
#
|
||||||
#admin_room_tag = "m.server_notice"
|
#admin_room_tag = "m.server_notice"
|
||||||
|
|
||||||
# Sentry.io crash/panic reporting, performance monitoring/metrics, etc.
|
# Sentry.io crash/panic reporting, performance monitoring/metrics, etc.
|
||||||
# This is NOT enabled by default. conduwuit's default Sentry reporting
|
# This is NOT enabled by default.
|
||||||
# endpoint domain is `o4506996327251968.ingest.us.sentry.io`.
|
|
||||||
#
|
#
|
||||||
#sentry = false
|
#sentry = false
|
||||||
|
|
||||||
|
@ -1443,7 +1464,7 @@
|
||||||
#
|
#
|
||||||
#sentry_endpoint = ""
|
#sentry_endpoint = ""
|
||||||
|
|
||||||
# Report your conduwuit server_name in Sentry.io crash reports and
|
# Report your continuwuity server_name in Sentry.io crash reports and
|
||||||
# metrics.
|
# metrics.
|
||||||
#
|
#
|
||||||
#sentry_send_server_name = false
|
#sentry_send_server_name = false
|
||||||
|
@ -1480,7 +1501,7 @@
|
||||||
# Enable the tokio-console. This option is only relevant to developers.
|
# Enable the tokio-console. This option is only relevant to developers.
|
||||||
#
|
#
|
||||||
# For more information, see:
|
# For more information, see:
|
||||||
# https://conduwuit.puppyirl.gay/development.html#debugging-with-tokio-console
|
# https://continuwuity.org/development.html#debugging-with-tokio-console
|
||||||
#
|
#
|
||||||
#tokio_console = false
|
#tokio_console = false
|
||||||
|
|
||||||
|
@ -1620,19 +1641,29 @@
|
||||||
#
|
#
|
||||||
#server =
|
#server =
|
||||||
|
|
||||||
# This item is undocumented. Please contribute documentation for it.
|
# URL to a support page for the server, which will be served as part of
|
||||||
|
# the MSC1929 server support endpoint at /.well-known/matrix/support.
|
||||||
|
# Will be included alongside any contact information
|
||||||
#
|
#
|
||||||
#support_page =
|
#support_page =
|
||||||
|
|
||||||
# This item is undocumented. Please contribute documentation for it.
|
# Role string for server support contacts, to be served as part of the
|
||||||
|
# MSC1929 server support endpoint at /.well-known/matrix/support.
|
||||||
#
|
#
|
||||||
#support_role =
|
#support_role = "m.role.admin"
|
||||||
|
|
||||||
# This item is undocumented. Please contribute documentation for it.
|
# Email address for server support contacts, to be served as part of the
|
||||||
|
# MSC1929 server support endpoint.
|
||||||
|
# This will be used along with support_mxid if specified.
|
||||||
#
|
#
|
||||||
#support_email =
|
#support_email =
|
||||||
|
|
||||||
# This item is undocumented. Please contribute documentation for it.
|
# Matrix ID for server support contacts, to be served as part of the
|
||||||
|
# MSC1929 server support endpoint.
|
||||||
|
# This will be used along with support_email if specified.
|
||||||
|
#
|
||||||
|
# If no email or mxid is specified, all of the server's admins will be
|
||||||
|
# listed.
|
||||||
#
|
#
|
||||||
#support_mxid =
|
#support_mxid =
|
||||||
|
|
||||||
|
|
4
debian/README.md
vendored
4
debian/README.md
vendored
|
@ -1,4 +1,4 @@
|
||||||
# conduwuit for Debian
|
# Continuwuity for Debian
|
||||||
|
|
||||||
Information about downloading and deploying the Debian package. This may also be
|
Information about downloading and deploying the Debian package. This may also be
|
||||||
referenced for other `apt`-based distros such as Ubuntu.
|
referenced for other `apt`-based distros such as Ubuntu.
|
||||||
|
@ -22,7 +22,7 @@ options in `/etc/conduwuit/conduwuit.toml`.
|
||||||
|
|
||||||
### Running
|
### Running
|
||||||
|
|
||||||
The package uses the [`conduwuit.service`](../configuration/examples.md#example-systemd-unit-file) systemd unit file to start and stop conduwuit. The binary is installed at `/usr/sbin/conduwuit`.
|
The package uses the [`conduwuit.service`](../configuration/examples.md#example-systemd-unit-file) systemd unit file to start and stop Continuwuity. The binary is installed at `/usr/sbin/conduwuit`.
|
||||||
|
|
||||||
This package assumes by default that conduwuit will be placed behind a reverse proxy. The default config options apply (listening on `localhost` and TCP port `6167`). Matrix federation requires a valid domain name and TLS, so you will need to set up TLS certificates and renewal for it to work properly if you intend to federate.
|
This package assumes by default that conduwuit will be placed behind a reverse proxy. The default config options apply (listening on `localhost` and TCP port `6167`). Matrix federation requires a valid domain name and TLS, so you will need to set up TLS certificates and renewal for it to work properly if you intend to federate.
|
||||||
|
|
||||||
|
|
7
debian/conduwuit.service
vendored
7
debian/conduwuit.service
vendored
|
@ -1,9 +1,10 @@
|
||||||
[Unit]
|
[Unit]
|
||||||
Description=conduwuit Matrix homeserver
|
|
||||||
|
Description=Continuwuity - Matrix homeserver
|
||||||
Wants=network-online.target
|
Wants=network-online.target
|
||||||
After=network-online.target
|
After=network-online.target
|
||||||
|
Documentation=https://continuwuity.org/
|
||||||
Alias=matrix-conduwuit.service
|
Alias=matrix-conduwuit.service
|
||||||
Documentation=https://conduwuit.puppyirl.gay/
|
|
||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
DynamicUser=yes
|
DynamicUser=yes
|
||||||
|
@ -11,7 +12,7 @@ User=conduwuit
|
||||||
Group=conduwuit
|
Group=conduwuit
|
||||||
Type=notify
|
Type=notify
|
||||||
|
|
||||||
Environment="CONDUWUIT_CONFIG=/etc/conduwuit/conduwuit.toml"
|
Environment="CONTINUWUITY_CONFIG=/etc/conduwuit/conduwuit.toml"
|
||||||
|
|
||||||
ExecStart=/usr/sbin/conduwuit
|
ExecStart=/usr/sbin/conduwuit
|
||||||
|
|
||||||
|
|
|
@ -1,15 +1,16 @@
|
||||||
ARG RUST_VERSION=1
|
ARG RUST_VERSION=1
|
||||||
|
ARG DEBIAN_VERSION=bookworm
|
||||||
|
|
||||||
FROM --platform=$BUILDPLATFORM docker.io/tonistiigi/xx AS xx
|
FROM --platform=$BUILDPLATFORM docker.io/tonistiigi/xx AS xx
|
||||||
FROM --platform=$BUILDPLATFORM rust:${RUST_VERSION}-slim-bookworm AS base
|
FROM --platform=$BUILDPLATFORM rust:${RUST_VERSION}-slim-${DEBIAN_VERSION} AS base
|
||||||
FROM --platform=$BUILDPLATFORM rust:${RUST_VERSION}-slim-bookworm AS toolchain
|
FROM --platform=$BUILDPLATFORM rust:${RUST_VERSION}-slim-${DEBIAN_VERSION} AS toolchain
|
||||||
|
|
||||||
# Prevent deletion of apt cache
|
# Prevent deletion of apt cache
|
||||||
RUN rm -f /etc/apt/apt.conf.d/docker-clean
|
RUN rm -f /etc/apt/apt.conf.d/docker-clean
|
||||||
|
|
||||||
# Match Rustc version as close as possible
|
# Match Rustc version as close as possible
|
||||||
# rustc -vV
|
# rustc -vV
|
||||||
ARG LLVM_VERSION=19
|
ARG LLVM_VERSION=20
|
||||||
# ENV RUSTUP_TOOLCHAIN=${RUST_VERSION}
|
# ENV RUSTUP_TOOLCHAIN=${RUST_VERSION}
|
||||||
|
|
||||||
# Install repo tools
|
# Install repo tools
|
||||||
|
@ -19,12 +20,21 @@ ARG LLVM_VERSION=19
|
||||||
RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
|
RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
|
||||||
--mount=type=cache,target=/var/lib/apt,sharing=locked \
|
--mount=type=cache,target=/var/lib/apt,sharing=locked \
|
||||||
apt-get update && apt-get install -y \
|
apt-get update && apt-get install -y \
|
||||||
clang-${LLVM_VERSION} lld-${LLVM_VERSION} pkg-config make jq \
|
pkg-config make jq \
|
||||||
curl git \
|
curl git software-properties-common \
|
||||||
file
|
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
|
# Create symlinks for LLVM tools
|
||||||
RUN <<EOF
|
RUN <<EOF
|
||||||
|
set -o xtrace
|
||||||
# clang
|
# clang
|
||||||
ln -s /usr/bin/clang-${LLVM_VERSION} /usr/bin/clang
|
ln -s /usr/bin/clang-${LLVM_VERSION} /usr/bin/clang
|
||||||
ln -s "/usr/bin/clang++-${LLVM_VERSION}" "/usr/bin/clang++"
|
ln -s "/usr/bin/clang++-${LLVM_VERSION}" "/usr/bin/clang++"
|
||||||
|
@ -38,7 +48,7 @@ EOF
|
||||||
|
|
||||||
# Developer tool versions
|
# Developer tool versions
|
||||||
# renovate: datasource=github-releases depName=cargo-bins/cargo-binstall
|
# renovate: datasource=github-releases depName=cargo-bins/cargo-binstall
|
||||||
ENV BINSTALL_VERSION=1.12.3
|
ENV BINSTALL_VERSION=1.13.0
|
||||||
# renovate: datasource=github-releases depName=psastras/sbom-rs
|
# renovate: datasource=github-releases depName=psastras/sbom-rs
|
||||||
ENV CARGO_SBOM_VERSION=0.9.1
|
ENV CARGO_SBOM_VERSION=0.9.1
|
||||||
# renovate: datasource=crate depName=lddtree
|
# renovate: datasource=crate depName=lddtree
|
||||||
|
@ -46,6 +56,7 @@ ENV LDDTREE_VERSION=0.3.7
|
||||||
|
|
||||||
# Install unpackaged tools
|
# Install unpackaged tools
|
||||||
RUN <<EOF
|
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
|
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 cargo-sbom --version $CARGO_SBOM_VERSION
|
||||||
cargo binstall --no-confirm lddtree --version $LDDTREE_VERSION
|
cargo binstall --no-confirm lddtree --version $LDDTREE_VERSION
|
||||||
|
@ -75,6 +86,7 @@ RUN echo "CARGO_INCREMENTAL=0" >> /etc/environment
|
||||||
|
|
||||||
# Configure pkg-config
|
# Configure pkg-config
|
||||||
RUN <<EOF
|
RUN <<EOF
|
||||||
|
set -o xtrace
|
||||||
echo "PKG_CONFIG_LIBDIR=/usr/lib/$(xx-info)/pkgconfig" >> /etc/environment
|
echo "PKG_CONFIG_LIBDIR=/usr/lib/$(xx-info)/pkgconfig" >> /etc/environment
|
||||||
echo "PKG_CONFIG=/usr/bin/$(xx-info)-pkg-config" >> /etc/environment
|
echo "PKG_CONFIG=/usr/bin/$(xx-info)-pkg-config" >> /etc/environment
|
||||||
echo "PKG_CONFIG_ALLOW_CROSS=true" >> /etc/environment
|
echo "PKG_CONFIG_ALLOW_CROSS=true" >> /etc/environment
|
||||||
|
@ -82,12 +94,14 @@ EOF
|
||||||
|
|
||||||
# Configure cc to use clang version
|
# Configure cc to use clang version
|
||||||
RUN <<EOF
|
RUN <<EOF
|
||||||
|
set -o xtrace
|
||||||
echo "CC=clang" >> /etc/environment
|
echo "CC=clang" >> /etc/environment
|
||||||
echo "CXX=clang++" >> /etc/environment
|
echo "CXX=clang++" >> /etc/environment
|
||||||
EOF
|
EOF
|
||||||
|
|
||||||
# Cross-language LTO
|
# Cross-language LTO
|
||||||
RUN <<EOF
|
RUN <<EOF
|
||||||
|
set -o xtrace
|
||||||
echo "CFLAGS=-flto" >> /etc/environment
|
echo "CFLAGS=-flto" >> /etc/environment
|
||||||
echo "CXXFLAGS=-flto" >> /etc/environment
|
echo "CXXFLAGS=-flto" >> /etc/environment
|
||||||
# Linker is set to target-compatible clang by xx
|
# Linker is set to target-compatible clang by xx
|
||||||
|
@ -98,6 +112,7 @@ EOF
|
||||||
ARG TARGET_CPU=
|
ARG TARGET_CPU=
|
||||||
RUN <<EOF
|
RUN <<EOF
|
||||||
set -o allexport
|
set -o allexport
|
||||||
|
set -o xtrace
|
||||||
. /etc/environment
|
. /etc/environment
|
||||||
if [ -n "${TARGET_CPU}" ]; then
|
if [ -n "${TARGET_CPU}" ]; then
|
||||||
echo "CFLAGS='${CFLAGS} -march=${TARGET_CPU}'" >> /etc/environment
|
echo "CFLAGS='${CFLAGS} -march=${TARGET_CPU}'" >> /etc/environment
|
||||||
|
@ -111,37 +126,44 @@ RUN mkdir /out
|
||||||
|
|
||||||
FROM toolchain AS builder
|
FROM toolchain AS builder
|
||||||
|
|
||||||
# Conduwuit version info
|
|
||||||
ARG COMMIT_SHA=
|
|
||||||
ARG CONDUWUIT_VERSION_EXTRA=
|
|
||||||
ENV CONDUWUIT_VERSION_EXTRA=$CONDUWUIT_VERSION_EXTRA
|
|
||||||
RUN <<EOF
|
|
||||||
if [ -z "${CONDUWUIT_VERSION_EXTRA}" ]; then
|
|
||||||
echo "CONDUWUIT_VERSION_EXTRA='$(set -e; git rev-parse --short ${COMMIT_SHA:-HEAD} || echo unknown revision)'" >> /etc/environment
|
|
||||||
fi
|
|
||||||
EOF
|
|
||||||
|
|
||||||
ARG TARGETPLATFORM
|
|
||||||
|
|
||||||
# Verify environment configuration
|
|
||||||
RUN cat /etc/environment
|
|
||||||
RUN xx-cargo --print-target-triple
|
|
||||||
|
|
||||||
# Get source
|
# Get source
|
||||||
COPY . .
|
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
|
# Build the binary
|
||||||
RUN --mount=type=cache,target=/usr/local/cargo/registry \
|
RUN --mount=type=cache,target=/usr/local/cargo/registry \
|
||||||
--mount=type=cache,target=/usr/local/cargo/git/db \
|
--mount=type=cache,target=/usr/local/cargo/git/db \
|
||||||
--mount=type=cache,target=/app/target \
|
--mount=type=cache,target=/app/target,id=cargo-target-${TARGET_CPU}-${TARGETPLATFORM}-${RUST_PROFILE} \
|
||||||
bash <<'EOF'
|
bash <<'EOF'
|
||||||
set -o allexport
|
set -o allexport
|
||||||
|
set -o xtrace
|
||||||
. /etc/environment
|
. /etc/environment
|
||||||
TARGET_DIR=($(cargo metadata --no-deps --format-version 1 | \
|
TARGET_DIR=($(cargo metadata --no-deps --format-version 1 | \
|
||||||
jq -r ".target_directory"))
|
jq -r ".target_directory"))
|
||||||
mkdir /out/sbin
|
mkdir /out/sbin
|
||||||
PACKAGE=conduwuit
|
PACKAGE=conduwuit
|
||||||
xx-cargo build --locked --release \
|
xx-cargo build --locked --profile ${RUST_PROFILE} \
|
||||||
-p $PACKAGE;
|
-p $PACKAGE;
|
||||||
BINARIES=($(cargo metadata --no-deps --format-version 1 | \
|
BINARIES=($(cargo metadata --no-deps --format-version 1 | \
|
||||||
jq -r ".packages[] | select(.name == \"$PACKAGE\") | .targets[] | select( .kind | map(. == \"bin\") | any ) | .name"))
|
jq -r ".packages[] | select(.name == \"$PACKAGE\") | .targets[] | select( .kind | map(. == \"bin\") | any ) | .name"))
|
||||||
|
@ -156,6 +178,7 @@ EOF
|
||||||
RUN --mount=type=cache,target=/usr/local/cargo/registry \
|
RUN --mount=type=cache,target=/usr/local/cargo/registry \
|
||||||
--mount=type=cache,target=/usr/local/cargo/git/db \
|
--mount=type=cache,target=/usr/local/cargo/git/db \
|
||||||
bash <<'EOF'
|
bash <<'EOF'
|
||||||
|
set -o xtrace
|
||||||
mkdir /out/sbom
|
mkdir /out/sbom
|
||||||
typeset -A PACKAGES
|
typeset -A PACKAGES
|
||||||
for BINARY in /out/sbin/*; do
|
for BINARY in /out/sbin/*; do
|
||||||
|
@ -174,6 +197,7 @@ EOF
|
||||||
|
|
||||||
# Extract dynamically linked dependencies
|
# Extract dynamically linked dependencies
|
||||||
RUN <<EOF
|
RUN <<EOF
|
||||||
|
set -o xtrace
|
||||||
mkdir /out/libs
|
mkdir /out/libs
|
||||||
mkdir /out/libs-root
|
mkdir /out/libs-root
|
||||||
for BINARY in /out/sbin/*; do
|
for BINARY in /out/sbin/*; do
|
||||||
|
|
|
@ -19,4 +19,5 @@
|
||||||
- [Contributing](contributing.md)
|
- [Contributing](contributing.md)
|
||||||
- [Testing](development/testing.md)
|
- [Testing](development/testing.md)
|
||||||
- [Hot Reloading ("Live" Development)](development/hot_reload.md)
|
- [Hot Reloading ("Live" Development)](development/hot_reload.md)
|
||||||
- [conduwuit Community Code of Conduct](conduwuit_coc.md)
|
- [Community (and Guidelines)](community.md)
|
||||||
|
- [Security](security.md)
|
||||||
|
|
|
@ -3,8 +3,8 @@
|
||||||
## Getting help
|
## Getting help
|
||||||
|
|
||||||
If you run into any problems while setting up an Appservice: ask us in
|
If you run into any problems while setting up an Appservice: ask us in
|
||||||
[#conduwuit:puppygock.gay](https://matrix.to/#/#conduwuit:puppygock.gay) or
|
[#continuwuity:continuwuity.org](https://matrix.to/#/#continuwuity:continuwuity.org) or
|
||||||
[open an issue on GitHub](https://github.com/girlbossceo/conduwuit/issues/new).
|
[open an issue on Forgejo](https://forgejo.ellis.link/continuwuation/continuwuity/issues/new).
|
||||||
|
|
||||||
## Set up the appservice - general instructions
|
## Set up the appservice - general instructions
|
||||||
|
|
||||||
|
@ -14,7 +14,7 @@ later starting it.
|
||||||
|
|
||||||
At some point the appservice guide should ask you to add a registration yaml
|
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
|
file to the homeserver. In Synapse you would do this by adding the path to the
|
||||||
homeserver.yaml, but in conduwuit you can do this from within Matrix:
|
homeserver.yaml, but in Continuwuity you can do this from within Matrix:
|
||||||
|
|
||||||
First, go into the `#admins` room of your homeserver. The first person that
|
First, go into the `#admins` room of your homeserver. The first person that
|
||||||
registered on the homeserver automatically joins it. Then send a message into
|
registered on the homeserver automatically joins it. Then send a message into
|
||||||
|
@ -37,9 +37,9 @@ You can confirm it worked by sending a message like this:
|
||||||
|
|
||||||
The server bot should answer with `Appservices (1): your-bridge`
|
The server bot should answer with `Appservices (1): your-bridge`
|
||||||
|
|
||||||
Then you are done. conduwuit will send messages to the appservices and the
|
Then you are done. Continuwuity will send messages to the appservices and the
|
||||||
appservice can send requests to the homeserver. You don't need to restart
|
appservice can send requests to the homeserver. You don't need to restart
|
||||||
conduwuit, but if it doesn't work, restarting while the appservice is running
|
Continuwuity, but if it doesn't work, restarting while the appservice is running
|
||||||
could help.
|
could help.
|
||||||
|
|
||||||
## Appservice-specific instructions
|
## Appservice-specific instructions
|
||||||
|
|
139
docs/community.md
Normal file
139
docs/community.md
Normal file
|
@ -0,0 +1,139 @@
|
||||||
|
# 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) and its rooms, including:
|
||||||
|
|
||||||
|
### [#continuwuity:continuwuity.org](https://matrix.to/#/#continuwuity:continuwuity.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)
|
||||||
|
|
||||||
|
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)
|
||||||
|
|
||||||
|
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,93 +0,0 @@
|
||||||
# conduwuit Community Code of Conduct
|
|
||||||
|
|
||||||
Welcome to the conduwuit community! We’re excited to have you here. conduwuit is
|
|
||||||
a hard-fork of the Conduit homeserver, aimed at making Matrix more accessible
|
|
||||||
and inclusive for everyone.
|
|
||||||
|
|
||||||
This space is dedicated to fostering a positive, supportive, and inclusive
|
|
||||||
environment for everyone. This Code of Conduct applies to all conduwuit spaces,
|
|
||||||
including any further community rooms that reference this CoC. Here are our
|
|
||||||
guidelines to help maintain the welcoming atmosphere that sets conduwuit apart.
|
|
||||||
|
|
||||||
For the general foundational rules, please refer to the [Contributor's
|
|
||||||
Covenant](https://github.com/girlbossceo/conduwuit/blob/main/CODE_OF_CONDUCT.md).
|
|
||||||
Below are additional guidelines specific to the conduwuit community.
|
|
||||||
|
|
||||||
## Our Values and Guidelines
|
|
||||||
|
|
||||||
1. **Respect and Inclusivity**: We are committed to maintaining a community
|
|
||||||
where everyone feels safe and respected. Discrimination, harassment, or hate
|
|
||||||
speech of any kind will not be tolerated. Recognise that each community member
|
|
||||||
experiences the world differently based on their past experiences, background,
|
|
||||||
and identity. Share your own experiences and be open to learning about others'
|
|
||||||
diverse perspectives.
|
|
||||||
|
|
||||||
2. **Positivity and Constructiveness**: Engage in constructive discussions and
|
|
||||||
support each other. If you feel angry, negative, or aggressive, take a break
|
|
||||||
until you can participate in a positive and constructive manner. Process intense
|
|
||||||
feelings with a friend or in a private setting before engaging in community
|
|
||||||
conversations to help maintain a supportive and focused environment.
|
|
||||||
|
|
||||||
3. **Clarity and Understanding**: Our community includes neurodivergent
|
|
||||||
individuals and those who may not appreciate sarcasm or subtlety. Communicate
|
|
||||||
clearly and kindly, avoiding sarcasm and ensuring your messages are easily
|
|
||||||
understood by all. Additionally, avoid putting the burden of education on
|
|
||||||
marginalized groups by doing your own research before asking for explanations.
|
|
||||||
|
|
||||||
4. **Be Open to Inclusivity**: Actively engage in conversations about making our
|
|
||||||
community more inclusive. Report discriminatory behavior to the moderators
|
|
||||||
and be open to constructive feedback that aims to improve our community.
|
|
||||||
Understand that discussing discrimination and negative experiences can be
|
|
||||||
emotionally taxing, so focus on the message rather than critiquing the tone
|
|
||||||
used.
|
|
||||||
|
|
||||||
5. **Commit to Inclusivity**: Building an inclusive community requires time,
|
|
||||||
energy, and resources. Recognise that addressing discrimination and bias is
|
|
||||||
an ongoing process that necessitates commitment and action from all community
|
|
||||||
members.
|
|
||||||
|
|
||||||
## Matrix Community
|
|
||||||
|
|
||||||
This Code of Conduct applies to the entire [conduwuit Matrix
|
|
||||||
Space](https://matrix.to/#/#conduwuit-space:puppygock.gay) and its rooms,
|
|
||||||
including:
|
|
||||||
|
|
||||||
### [#conduwuit:puppygock.gay](https://matrix.to/#/#conduwuit:puppygock.gay)
|
|
||||||
|
|
||||||
This room is for support and discussions about conduwuit. Ask questions, share
|
|
||||||
insights, and help each other out.
|
|
||||||
|
|
||||||
### [#conduwuit-offtopic:girlboss.ceo](https://matrix.to/#/#conduwuit-offtopic:girlboss.ceo)
|
|
||||||
|
|
||||||
For off-topic community conversations about any subject. While this room allows
|
|
||||||
for a wide range of topics, the same CoC applies. Keep discussions respectful
|
|
||||||
and inclusive, and avoid divisive subjects like country/world politics. General
|
|
||||||
topics, such as world events, are welcome as long as they follow the CoC.
|
|
||||||
|
|
||||||
### [#conduwuit-dev:puppygock.gay](https://matrix.to/#/#conduwuit-dev:puppygock.gay)
|
|
||||||
|
|
||||||
This room is dedicated to discussing active development of conduwuit. Posting
|
|
||||||
requires an elevated power level, which can be requested in one of the other
|
|
||||||
rooms. Use this space to collaborate and innovate.
|
|
||||||
|
|
||||||
## Enforcement
|
|
||||||
|
|
||||||
We have a zero-tolerance policy for violations of this Code of Conduct. If
|
|
||||||
someone’s behavior makes you uncomfortable, please report it to the moderators.
|
|
||||||
Actions we may take include:
|
|
||||||
|
|
||||||
1. **Warning**: A warning given directly in the room or via a private message
|
|
||||||
from the moderators, identifying the violation and requesting corrective
|
|
||||||
action.
|
|
||||||
2. **Temporary Mute**: Temporary restriction from participating in discussions
|
|
||||||
for a specified period to allow for reflection and cooling off.
|
|
||||||
3. **Kick or Ban**: Egregious behavior may result in an immediate kick or ban to
|
|
||||||
protect other community members. Bans are considered permanent and will only
|
|
||||||
be reversed in exceptional circumstances after proven good behavior.
|
|
||||||
|
|
||||||
Please highlight issues directly in rooms when possible, but if you don't feel
|
|
||||||
comfortable doing that, then please send a DM to one of the moderators directly.
|
|
||||||
|
|
||||||
Together, let’s build a community where everyone feels valued and respected.
|
|
||||||
|
|
||||||
— The conduwuit Moderation Team
|
|
|
@ -1,10 +1,10 @@
|
||||||
# Configuration
|
# Configuration
|
||||||
|
|
||||||
This chapter describes various ways to configure conduwuit.
|
This chapter describes various ways to configure Continuwuity.
|
||||||
|
|
||||||
## Basics
|
## Basics
|
||||||
|
|
||||||
conduwuit uses a config file for the majority of the settings, but also supports
|
Continuwuity uses a config file for the majority of the settings, but also supports
|
||||||
setting individual config options via commandline.
|
setting individual config options via commandline.
|
||||||
|
|
||||||
Please refer to the [example config
|
Please refer to the [example config
|
||||||
|
@ -12,13 +12,13 @@ file](./configuration/examples.md#example-configuration) for all of those
|
||||||
settings.
|
settings.
|
||||||
|
|
||||||
The config file to use can be specified on the commandline when running
|
The config file to use can be specified on the commandline when running
|
||||||
conduwuit by specifying the `-c`, `--config` flag. Alternatively, you can use
|
Continuwuity by specifying the `-c`, `--config` flag. Alternatively, you can use
|
||||||
the environment variable `CONDUWUIT_CONFIG` to specify the config file to used.
|
the environment variable `CONDUWUIT_CONFIG` to specify the config file to used.
|
||||||
Conduit's environment variables are supported for backwards compatibility.
|
Conduit's environment variables are supported for backwards compatibility.
|
||||||
|
|
||||||
## Option commandline flag
|
## Option commandline flag
|
||||||
|
|
||||||
conduwuit supports setting individual config options in TOML format from the
|
Continuwuity supports setting individual config options in TOML format from the
|
||||||
`-O` / `--option` flag. For example, you can set your server name via `-O
|
`-O` / `--option` flag. For example, you can set your server name via `-O
|
||||||
server_name=\"example.com\"`.
|
server_name=\"example.com\"`.
|
||||||
|
|
||||||
|
@ -33,7 +33,7 @@ string. This does not apply to options that take booleans or numbers:
|
||||||
|
|
||||||
## Execute commandline flag
|
## Execute commandline flag
|
||||||
|
|
||||||
conduwuit supports running admin commands on startup using the commandline
|
Continuwuity supports running admin commands on startup using the commandline
|
||||||
argument `--execute`. The most notable use for this is to create an admin user
|
argument `--execute`. The most notable use for this is to create an admin user
|
||||||
on first startup.
|
on first startup.
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
# Deploying
|
# Deploying
|
||||||
|
|
||||||
This chapter describes various ways to deploy conduwuit.
|
This chapter describes various ways to deploy Continuwuity.
|
||||||
|
|
|
@ -1,15 +1,5 @@
|
||||||
# conduwuit for Arch Linux
|
# Continuwuity for Arch Linux
|
||||||
|
|
||||||
Currently conduwuit is only on the Arch User Repository (AUR).
|
Continuwuity is available on the `archlinuxcn` repository and AUR, with the same package name `continuwuity`, which includes latest taggged version. The development version is available on AUR as `continuwuity-git`
|
||||||
|
|
||||||
The conduwuit AUR packages are community maintained and are not maintained by
|
Simply install the `continuwuity` package. Configure the service in `/etc/conduwuit/conduwuit.toml`, then enable/start the continuwuity.service.
|
||||||
conduwuit development team, but the AUR package maintainers are in the Matrix
|
|
||||||
room. Please attempt to verify your AUR package's PKGBUILD file looks fine
|
|
||||||
before asking for support.
|
|
||||||
|
|
||||||
- [conduwuit](https://aur.archlinux.org/packages/conduwuit) - latest tagged
|
|
||||||
conduwuit
|
|
||||||
- [conduwuit-git](https://aur.archlinux.org/packages/conduwuit-git) - latest git
|
|
||||||
conduwuit from `main` branch
|
|
||||||
- [conduwuit-bin](https://aur.archlinux.org/packages/conduwuit-bin) - latest
|
|
||||||
tagged conduwuit static binary
|
|
||||||
|
|
|
@ -1,48 +1,49 @@
|
||||||
# conduwuit - Behind Traefik Reverse Proxy
|
# Continuwuity - Behind Traefik Reverse Proxy
|
||||||
|
|
||||||
services:
|
services:
|
||||||
homeserver:
|
homeserver:
|
||||||
### If you already built the conduduwit image with 'docker build' or want to use the Docker Hub image,
|
### If you already built the conduduwit image with 'docker build' or want to use the Docker Hub image,
|
||||||
### then you are ready to go.
|
### then you are ready to go.
|
||||||
image: girlbossceo/conduwuit:latest
|
image: forgejo.ellis.link/continuwuation/continuwuity:latest
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
volumes:
|
volumes:
|
||||||
- db:/var/lib/conduwuit
|
- db:/var/lib/continuwuity
|
||||||
#- ./conduwuit.toml:/etc/conduwuit.toml
|
- /etc/resolv.conf:/etc/resolv.conf:ro # Use the host's DNS resolver rather than Docker's.
|
||||||
|
#- ./continuwuity.toml:/etc/continuwuity.toml
|
||||||
networks:
|
networks:
|
||||||
- proxy
|
- proxy
|
||||||
environment:
|
environment:
|
||||||
CONDUWUIT_SERVER_NAME: your.server.name.example # EDIT THIS
|
CONTINUWUITY_SERVER_NAME: your.server.name.example # EDIT THIS
|
||||||
CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit
|
CONTINUWUITY_DATABASE_PATH: /var/lib/continuwuity
|
||||||
CONDUWUIT_PORT: 6167 # should match the loadbalancer traefik label
|
CONTINUWUITY_PORT: 6167 # should match the loadbalancer traefik label
|
||||||
CONDUWUIT_MAX_REQUEST_SIZE: 20000000 # in bytes, ~20 MB
|
CONTINUWUITY_MAX_REQUEST_SIZE: 20000000 # in bytes, ~20 MB
|
||||||
CONDUWUIT_ALLOW_REGISTRATION: 'true'
|
CONTINUWUITY_ALLOW_REGISTRATION: 'true'
|
||||||
CONDUWUIT_REGISTRATION_TOKEN: 'YOUR_TOKEN' # A registration token is required when registration is allowed.
|
CONTINUWUITY_REGISTRATION_TOKEN: 'YOUR_TOKEN' # A registration token is required when registration is allowed.
|
||||||
#CONDUWUIT_YES_I_AM_VERY_VERY_SURE_I_WANT_AN_OPEN_REGISTRATION_SERVER_PRONE_TO_ABUSE: 'true'
|
#CONTINUWUITY_YES_I_AM_VERY_VERY_SURE_I_WANT_AN_OPEN_REGISTRATION_SERVER_PRONE_TO_ABUSE: 'true'
|
||||||
CONDUWUIT_ALLOW_FEDERATION: 'true'
|
CONTINUWUITY_ALLOW_FEDERATION: 'true'
|
||||||
CONDUWUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
|
CONTINUWUITY_ALLOW_CHECK_FOR_UPDATES: 'true'
|
||||||
CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
|
CONTINUWUITY_TRUSTED_SERVERS: '["matrix.org"]'
|
||||||
#CONDUWUIT_LOG: warn,state_res=warn
|
#CONTINUWUITY_LOG: warn,state_res=warn
|
||||||
CONDUWUIT_ADDRESS: 0.0.0.0
|
CONTINUWUITY_ADDRESS: 0.0.0.0
|
||||||
#CONDUWUIT_CONFIG: '/etc/conduwuit.toml' # Uncomment if you mapped config toml above
|
#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 CONDUWUIT_WELL_KNOWN
|
# 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 conduwuit.toml file, and in a seperate
|
# 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
|
# see the override file for more information about delegation
|
||||||
CONDUWUIT_WELL_KNOWN: |
|
CONTINUWUITY_WELL_KNOWN: |
|
||||||
{
|
{
|
||||||
client=https://your.server.name.example,
|
client=https://your.server.name.example,
|
||||||
server=your.server.name.example:443
|
server=your.server.name.example:443
|
||||||
}
|
}
|
||||||
#cpuset: "0-4" # Uncomment to limit to specific CPU cores
|
#cpuset: "0-4" # Uncomment to limit to specific CPU cores
|
||||||
ulimits: # conduwuit uses quite a few file descriptors, and on some systems it defaults to 1024, so you can tell docker to increase it
|
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:
|
nofile:
|
||||||
soft: 1048567
|
soft: 1048567
|
||||||
hard: 1048567
|
hard: 1048567
|
||||||
|
|
||||||
### Uncomment if you want to use your own Element-Web App.
|
### 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
|
### Note: You need to provide a config.json for Element and you also need a second
|
||||||
### Domain or Subdomain for the communication between Element and conduwuit
|
### Domain or Subdomain for the communication between Element and Continuwuity
|
||||||
### Config-Docs: https://github.com/vector-im/element-web/blob/develop/docs/config.md
|
### Config-Docs: https://github.com/vector-im/element-web/blob/develop/docs/config.md
|
||||||
# element-web:
|
# element-web:
|
||||||
# image: vectorim/element-web:latest
|
# image: vectorim/element-web:latest
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# conduwuit - Traefik Reverse Proxy Labels
|
# Continuwuity - Traefik Reverse Proxy Labels
|
||||||
|
|
||||||
services:
|
services:
|
||||||
homeserver:
|
homeserver:
|
||||||
|
@ -6,17 +6,17 @@ services:
|
||||||
- "traefik.enable=true"
|
- "traefik.enable=true"
|
||||||
- "traefik.docker.network=proxy" # Change this to the name of your Traefik docker proxy network
|
- "traefik.docker.network=proxy" # Change this to the name of your Traefik docker proxy network
|
||||||
|
|
||||||
- "traefik.http.routers.to-conduwuit.rule=Host(`<SUBDOMAIN>.<DOMAIN>`)" # Change to the address on which conduwuit is hosted
|
- "traefik.http.routers.to-continuwuity.rule=Host(`<SUBDOMAIN>.<DOMAIN>`)" # Change to the address on which Continuwuity is hosted
|
||||||
- "traefik.http.routers.to-conduwuit.tls=true"
|
- "traefik.http.routers.to-continuwuity.tls=true"
|
||||||
- "traefik.http.routers.to-conduwuit.tls.certresolver=letsencrypt"
|
- "traefik.http.routers.to-continuwuity.tls.certresolver=letsencrypt"
|
||||||
- "traefik.http.routers.to-conduwuit.middlewares=cors-headers@docker"
|
- "traefik.http.routers.to-continuwuity.middlewares=cors-headers@docker"
|
||||||
- "traefik.http.services.to_conduwuit.loadbalancer.server.port=6167"
|
- "traefik.http.services.to_continuwuity.loadbalancer.server.port=6167"
|
||||||
|
|
||||||
- "traefik.http.middlewares.cors-headers.headers.accessControlAllowOriginList=*"
|
- "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.accessControlAllowHeaders=Origin, X-Requested-With, Content-Type, Accept, Authorization"
|
||||||
- "traefik.http.middlewares.cors-headers.headers.accessControlAllowMethods=GET, POST, PUT, DELETE, OPTIONS"
|
- "traefik.http.middlewares.cors-headers.headers.accessControlAllowMethods=GET, POST, PUT, DELETE, OPTIONS"
|
||||||
|
|
||||||
# If you want to have your account on <DOMAIN>, but host conduwuit on a subdomain,
|
# 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
|
# 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.rule=Host(`<DOMAIN>`) && PathPrefix(`/.well-known/matrix`)"
|
||||||
#- "traefik.http.routers.to-matrix-wellknown.tls=true"
|
#- "traefik.http.routers.to-matrix-wellknown.tls=true"
|
||||||
|
@ -34,4 +34,3 @@ services:
|
||||||
# - "traefik.http.routers.to-element-web.tls.certresolver=letsencrypt"
|
# - "traefik.http.routers.to-element-web.tls.certresolver=letsencrypt"
|
||||||
|
|
||||||
# vim: ts=2:sw=2:expandtab
|
# vim: ts=2:sw=2:expandtab
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
services:
|
services:
|
||||||
caddy:
|
caddy:
|
||||||
# This compose file uses caddy-docker-proxy as the reverse proxy for conduwuit!
|
# This compose file uses caddy-docker-proxy as the reverse proxy for Continuwuity!
|
||||||
# For more info, visit https://github.com/lucaslorentz/caddy-docker-proxy
|
# For more info, visit https://github.com/lucaslorentz/caddy-docker-proxy
|
||||||
image: lucaslorentz/caddy-docker-proxy:ci-alpine
|
image: lucaslorentz/caddy-docker-proxy:ci-alpine
|
||||||
ports:
|
ports:
|
||||||
|
@ -20,27 +20,28 @@ services:
|
||||||
caddy.1_respond: /.well-known/matrix/client {"m.server":{"base_url":"https://matrix.example.com"},"m.homeserver":{"base_url":"https://matrix.example.com"},"org.matrix.msc3575.proxy":{"url":"https://matrix.example.com"}}
|
caddy.1_respond: /.well-known/matrix/client {"m.server":{"base_url":"https://matrix.example.com"},"m.homeserver":{"base_url":"https://matrix.example.com"},"org.matrix.msc3575.proxy":{"url":"https://matrix.example.com"}}
|
||||||
|
|
||||||
homeserver:
|
homeserver:
|
||||||
### If you already built the conduwuit image with 'docker build' or want to use a registry image,
|
### If you already built the Continuwuity image with 'docker build' or want to use a registry image,
|
||||||
### then you are ready to go.
|
### then you are ready to go.
|
||||||
image: girlbossceo/conduwuit:latest
|
image: forgejo.ellis.link/continuwuation/continuwuity:latest
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
volumes:
|
volumes:
|
||||||
- db:/var/lib/conduwuit
|
- db:/var/lib/continuwuity
|
||||||
#- ./conduwuit.toml:/etc/conduwuit.toml
|
- /etc/resolv.conf:/etc/resolv.conf:ro # Use the host's DNS resolver rather than Docker's.
|
||||||
|
#- ./continuwuity.toml:/etc/continuwuity.toml
|
||||||
environment:
|
environment:
|
||||||
CONDUWUIT_SERVER_NAME: example.com # EDIT THIS
|
CONTINUWUITY_SERVER_NAME: example.com # EDIT THIS
|
||||||
CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit
|
CONTINUWUITY_DATABASE_PATH: /var/lib/continuwuity
|
||||||
CONDUWUIT_PORT: 6167
|
CONTINUWUITY_PORT: 6167
|
||||||
CONDUWUIT_MAX_REQUEST_SIZE: 20000000 # in bytes, ~20 MB
|
CONTINUWUITY_MAX_REQUEST_SIZE: 20000000 # in bytes, ~20 MB
|
||||||
CONDUWUIT_ALLOW_REGISTRATION: 'true'
|
CONTINUWUITY_ALLOW_REGISTRATION: 'true'
|
||||||
CONDUWUIT_REGISTRATION_TOKEN: 'YOUR_TOKEN' # A registration token is required when registration is allowed.
|
CONTINUWUITY_REGISTRATION_TOKEN: 'YOUR_TOKEN' # A registration token is required when registration is allowed.
|
||||||
#CONDUWUIT_YES_I_AM_VERY_VERY_SURE_I_WANT_AN_OPEN_REGISTRATION_SERVER_PRONE_TO_ABUSE: 'true'
|
#CONTINUWUITY_YES_I_AM_VERY_VERY_SURE_I_WANT_AN_OPEN_REGISTRATION_SERVER_PRONE_TO_ABUSE: 'true'
|
||||||
CONDUWUIT_ALLOW_FEDERATION: 'true'
|
CONTINUWUITY_ALLOW_FEDERATION: 'true'
|
||||||
CONDUWUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
|
CONTINUWUITY_ALLOW_CHECK_FOR_UPDATES: 'true'
|
||||||
CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
|
CONTINUWUITY_TRUSTED_SERVERS: '["matrix.org"]'
|
||||||
#CONDUWUIT_LOG: warn,state_res=warn
|
#CONTINUWUITY_LOG: warn,state_res=warn
|
||||||
CONDUWUIT_ADDRESS: 0.0.0.0
|
CONTINUWUITY_ADDRESS: 0.0.0.0
|
||||||
#CONDUWUIT_CONFIG: '/etc/conduwuit.toml' # Uncomment if you mapped config toml above
|
#CONTINUWUITY_CONFIG: '/etc/continuwuity.toml' # Uncomment if you mapped config toml above
|
||||||
networks:
|
networks:
|
||||||
- caddy
|
- caddy
|
||||||
labels:
|
labels:
|
||||||
|
|
|
@ -1,56 +1,57 @@
|
||||||
# conduwuit - Behind Traefik Reverse Proxy
|
# Continuwuity - Behind Traefik Reverse Proxy
|
||||||
|
|
||||||
services:
|
services:
|
||||||
homeserver:
|
homeserver:
|
||||||
### If you already built the conduwuit image with 'docker build' or want to use the Docker Hub image,
|
### If you already built the Continuwuity image with 'docker build' or want to use the Docker Hub image,
|
||||||
### then you are ready to go.
|
### then you are ready to go.
|
||||||
image: girlbossceo/conduwuit:latest
|
image: forgejo.ellis.link/continuwuation/continuwuity:latest
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
volumes:
|
volumes:
|
||||||
- db:/var/lib/conduwuit
|
- db:/var/lib/continuwuity
|
||||||
#- ./conduwuit.toml:/etc/conduwuit.toml
|
- /etc/resolv.conf:/etc/resolv.conf:ro # Use the host's DNS resolver rather than Docker's.
|
||||||
|
#- ./continuwuity.toml:/etc/continuwuity.toml
|
||||||
networks:
|
networks:
|
||||||
- proxy
|
- proxy
|
||||||
environment:
|
environment:
|
||||||
CONDUWUIT_SERVER_NAME: your.server.name.example # EDIT THIS
|
CONTINUWUITY_SERVER_NAME: your.server.name.example # EDIT THIS
|
||||||
CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
|
CONTINUWUITY_TRUSTED_SERVERS: '["matrix.org"]'
|
||||||
CONDUWUIT_ALLOW_REGISTRATION: 'false' # After setting a secure registration token, you can enable this
|
CONTINUWUITY_ALLOW_REGISTRATION: 'false' # After setting a secure registration token, you can enable this
|
||||||
CONDUWUIT_REGISTRATION_TOKEN: "" # This is a token you can use to register on the server
|
CONTINUWUITY_REGISTRATION_TOKEN: "" # This is a token you can use to register on the server
|
||||||
#CONDUWUIT_REGISTRATION_TOKEN_FILE: "" # Alternatively you can configure a path to a token file to read
|
#CONTINUWUITY_REGISTRATION_TOKEN_FILE: "" # Alternatively you can configure a path to a token file to read
|
||||||
CONDUWUIT_ADDRESS: 0.0.0.0
|
CONTINUWUITY_ADDRESS: 0.0.0.0
|
||||||
CONDUWUIT_PORT: 6167 # you need to match this with the traefik load balancer label if you're want to change it
|
CONTINUWUITY_PORT: 6167 # you need to match this with the traefik load balancer label if you're want to change it
|
||||||
CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit
|
CONTINUWUITY_DATABASE_PATH: /var/lib/continuwuity
|
||||||
#CONDUWUIT_CONFIG: '/etc/conduit.toml' # Uncomment if you mapped config toml above
|
#CONTINUWUITY_CONFIG: '/etc/continuwuity.toml' # Uncomment if you mapped config toml above
|
||||||
### Uncomment and change values as desired, note that conduwuit has plenty of config options, so you should check out the example example config too
|
### 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
|
# Available levels are: error, warn, info, debug, trace - more info at: https://docs.rs/env_logger/*/env_logger/#enabling-logging
|
||||||
# CONDUWUIT_LOG: info # default is: "warn,state_res=warn"
|
# CONTINUWUITY_LOG: info # default is: "warn,state_res=warn"
|
||||||
# CONDUWUIT_ALLOW_ENCRYPTION: 'true'
|
# CONTINUWUITY_ALLOW_ENCRYPTION: 'true'
|
||||||
# CONDUWUIT_ALLOW_FEDERATION: 'true'
|
# CONTINUWUITY_ALLOW_FEDERATION: 'true'
|
||||||
# CONDUWUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
|
# CONTINUWUITY_ALLOW_CHECK_FOR_UPDATES: 'true'
|
||||||
# CONDUWUIT_ALLOW_INCOMING_PRESENCE: true
|
# CONTINUWUITY_ALLOW_INCOMING_PRESENCE: true
|
||||||
# CONDUWUIT_ALLOW_OUTGOING_PRESENCE: true
|
# CONTINUWUITY_ALLOW_OUTGOING_PRESENCE: true
|
||||||
# CONDUWUIT_ALLOW_LOCAL_PRESENCE: true
|
# CONTINUWUITY_ALLOW_LOCAL_PRESENCE: true
|
||||||
# CONDUWUIT_WORKERS: 10
|
# CONTINUWUITY_WORKERS: 10
|
||||||
# CONDUWUIT_MAX_REQUEST_SIZE: 20000000 # in bytes, ~20 MB
|
# CONTINUWUITY_MAX_REQUEST_SIZE: 20000000 # in bytes, ~20 MB
|
||||||
# CONDUWUIT_NEW_USER_DISPLAYNAME_SUFFIX = "🏳<200d>⚧"
|
# 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 CONDUWUIT_WELL_KNOWN
|
# 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 conduwuit.toml file, and in a seperate
|
# 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
|
# reverse proxy, but since you do not have a reverse proxy and following this guide, this example is included
|
||||||
CONDUWUIT_WELL_KNOWN: |
|
CONTINUWUITY_WELL_KNOWN: |
|
||||||
{
|
{
|
||||||
client=https://your.server.name.example,
|
client=https://your.server.name.example,
|
||||||
server=your.server.name.example:443
|
server=your.server.name.example:443
|
||||||
}
|
}
|
||||||
#cpuset: "0-4" # Uncomment to limit to specific CPU cores
|
#cpuset: "0-4" # Uncomment to limit to specific CPU cores
|
||||||
ulimits: # conduwuit uses quite a few file descriptors, and on some systems it defaults to 1024, so you can tell docker to increase it
|
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:
|
nofile:
|
||||||
soft: 1048567
|
soft: 1048567
|
||||||
hard: 1048567
|
hard: 1048567
|
||||||
|
|
||||||
### Uncomment if you want to use your own Element-Web App.
|
### 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
|
### Note: You need to provide a config.json for Element and you also need a second
|
||||||
### Domain or Subdomain for the communication between Element and conduwuit
|
### Domain or Subdomain for the communication between Element and Continuwuity
|
||||||
### Config-Docs: https://github.com/vector-im/element-web/blob/develop/docs/config.md
|
### Config-Docs: https://github.com/vector-im/element-web/blob/develop/docs/config.md
|
||||||
# element-web:
|
# element-web:
|
||||||
# image: vectorim/element-web:latest
|
# image: vectorim/element-web:latest
|
||||||
|
|
|
@ -1,34 +1,34 @@
|
||||||
# conduwuit
|
# Continuwuity
|
||||||
|
|
||||||
services:
|
services:
|
||||||
homeserver:
|
homeserver:
|
||||||
### If you already built the conduwuit image with 'docker build' or want to use a registry image,
|
### If you already built the Continuwuity image with 'docker build' or want to use a registry image,
|
||||||
### then you are ready to go.
|
### then you are ready to go.
|
||||||
image: girlbossceo/conduwuit:latest
|
image: forgejo.ellis.link/continuwuation/continuwuity:latest
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
ports:
|
ports:
|
||||||
- 8448:6167
|
- 8448:6167
|
||||||
volumes:
|
volumes:
|
||||||
- db:/var/lib/conduwuit
|
- db:/var/lib/continuwuity
|
||||||
#- ./conduwuit.toml:/etc/conduwuit.toml
|
#- ./continuwuity.toml:/etc/continuwuity.toml
|
||||||
environment:
|
environment:
|
||||||
CONDUWUIT_SERVER_NAME: your.server.name # EDIT THIS
|
CONTINUWUITY_SERVER_NAME: your.server.name # EDIT THIS
|
||||||
CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit
|
CONTINUWUITY_DATABASE_PATH: /var/lib/continuwuity
|
||||||
CONDUWUIT_PORT: 6167
|
CONTINUWUITY_PORT: 6167
|
||||||
CONDUWUIT_MAX_REQUEST_SIZE: 20000000 # in bytes, ~20 MB
|
CONTINUWUITY_MAX_REQUEST_SIZE: 20000000 # in bytes, ~20 MB
|
||||||
CONDUWUIT_ALLOW_REGISTRATION: 'true'
|
CONTINUWUITY_ALLOW_REGISTRATION: 'true'
|
||||||
CONDUWUIT_REGISTRATION_TOKEN: 'YOUR_TOKEN' # A registration token is required when registration is allowed.
|
CONTINUWUITY_REGISTRATION_TOKEN: 'YOUR_TOKEN' # A registration token is required when registration is allowed.
|
||||||
#CONDUWUIT_YES_I_AM_VERY_VERY_SURE_I_WANT_AN_OPEN_REGISTRATION_SERVER_PRONE_TO_ABUSE: 'true'
|
#CONTINUWUITY_YES_I_AM_VERY_VERY_SURE_I_WANT_AN_OPEN_REGISTRATION_SERVER_PRONE_TO_ABUSE: 'true'
|
||||||
CONDUWUIT_ALLOW_FEDERATION: 'true'
|
CONTINUWUITY_ALLOW_FEDERATION: 'true'
|
||||||
CONDUWUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
|
CONTINUWUITY_ALLOW_CHECK_FOR_UPDATES: 'true'
|
||||||
CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]'
|
CONTINUWUITY_TRUSTED_SERVERS: '["matrix.org"]'
|
||||||
#CONDUWUIT_LOG: warn,state_res=warn
|
#CONTINUWUITY_LOG: warn,state_res=warn
|
||||||
CONDUWUIT_ADDRESS: 0.0.0.0
|
CONTINUWUITY_ADDRESS: 0.0.0.0
|
||||||
#CONDUWUIT_CONFIG: '/etc/conduwuit.toml' # Uncomment if you mapped config toml above
|
#CONTINUWUITY_CONFIG: '/etc/continuwuity.toml' # Uncomment if you mapped config toml above
|
||||||
#
|
#
|
||||||
### Uncomment if you want to use your own Element-Web App.
|
### 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
|
### Note: You need to provide a config.json for Element and you also need a second
|
||||||
### Domain or Subdomain for the communication between Element and conduwuit
|
### Domain or Subdomain for the communication between Element and Continuwuity
|
||||||
### Config-Docs: https://github.com/vector-im/element-web/blob/develop/docs/config.md
|
### Config-Docs: https://github.com/vector-im/element-web/blob/develop/docs/config.md
|
||||||
# element-web:
|
# element-web:
|
||||||
# image: vectorim/element-web:latest
|
# image: vectorim/element-web:latest
|
||||||
|
|
|
@ -1,31 +1,20 @@
|
||||||
# conduwuit for Docker
|
# Continuwuity for Docker
|
||||||
|
|
||||||
## Docker
|
## Docker
|
||||||
|
|
||||||
To run conduwuit with Docker you can either build the image yourself or pull it
|
To run Continuwuity with Docker you can either build the image yourself or pull it
|
||||||
from a registry.
|
from a registry.
|
||||||
|
|
||||||
### Use a registry
|
### Use a registry
|
||||||
|
|
||||||
OCI images for conduwuit are available in the registries listed below.
|
OCI images for Continuwuity are available in the registries listed below.
|
||||||
|
|
||||||
| Registry | Image | Size | Notes |
|
| Registry | Image | Notes |
|
||||||
| --------------- | --------------------------------------------------------------- | ----------------------------- | ---------------------- |
|
| --------------- | --------------------------------------------------------------- | -----------------------|
|
||||||
| GitHub Registry | [ghcr.io/girlbossceo/conduwuit:latest][gh] | ![Image Size][shield-latest] | Stable latest tagged image. |
|
| Forgejo Registry| [forgejo.ellis.link/continuwuation/continuwuity:latest][fj] | Latest tagged image. |
|
||||||
| GitLab Registry | [registry.gitlab.com/conduwuit/conduwuit:latest][gl] | ![Image Size][shield-latest] | Stable latest tagged image. |
|
| Forgejo Registry| [forgejo.ellis.link/continuwuation/continuwuity:main][fj] | Main branch image. |
|
||||||
| Docker Hub | [docker.io/girlbossceo/conduwuit:latest][dh] | ![Image Size][shield-latest] | Stable latest tagged image. |
|
|
||||||
| GitHub Registry | [ghcr.io/girlbossceo/conduwuit:main][gh] | ![Image Size][shield-main] | Stable main branch. |
|
|
||||||
| GitLab Registry | [registry.gitlab.com/conduwuit/conduwuit:main][gl] | ![Image Size][shield-main] | Stable main branch. |
|
|
||||||
| Docker Hub | [docker.io/girlbossceo/conduwuit:main][dh] | ![Image Size][shield-main] | Stable main branch. |
|
|
||||||
|
|
||||||
[dh]: https://hub.docker.com/r/girlbossceo/conduwuit
|
[fj]: https://forgejo.ellis.link/continuwuation/-/packages/container/continuwuity
|
||||||
[gh]: https://github.com/girlbossceo/conduwuit/pkgs/container/conduwuit
|
|
||||||
[gl]: https://gitlab.com/conduwuit/conduwuit/container_registry/6369729
|
|
||||||
[shield-latest]: https://img.shields.io/docker/image-size/girlbossceo/conduwuit/latest
|
|
||||||
[shield-main]: https://img.shields.io/docker/image-size/girlbossceo/conduwuit/main
|
|
||||||
|
|
||||||
OCI image `.tar.gz` files are also hosted directly at when uploaded by CI with a
|
|
||||||
commit hash/revision or a tagged release: <https://pup.systems/~strawberry/conduwuit/>
|
|
||||||
|
|
||||||
Use
|
Use
|
||||||
|
|
||||||
|
@ -41,22 +30,22 @@ When you have the image you can simply run it with
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker run -d -p 8448:6167 \
|
docker run -d -p 8448:6167 \
|
||||||
-v db:/var/lib/conduwuit/ \
|
-v db:/var/lib/continuwuity/ \
|
||||||
-e CONDUWUIT_SERVER_NAME="your.server.name" \
|
-e CONTINUWUITY_SERVER_NAME="your.server.name" \
|
||||||
-e CONDUWUIT_ALLOW_REGISTRATION=false \
|
-e CONTINUWUITY_ALLOW_REGISTRATION=false \
|
||||||
--name conduwuit $LINK
|
--name continuwuity $LINK
|
||||||
```
|
```
|
||||||
|
|
||||||
or you can use [docker compose](#docker-compose).
|
or you can use [docker compose](#docker-compose).
|
||||||
|
|
||||||
The `-d` flag lets the container run in detached mode. You may supply an
|
The `-d` flag lets the container run in detached mode. You may supply an
|
||||||
optional `conduwuit.toml` config file, the example config can be found
|
optional `continuwuity.toml` config file, the example config can be found
|
||||||
[here](../configuration/examples.md). You can pass in different env vars to
|
[here](../configuration/examples.md). You can pass in different env vars to
|
||||||
change config values on the fly. You can even configure conduwuit completely by
|
change config values on the fly. You can even configure Continuwuity completely by
|
||||||
using env vars. For an overview of possible values, please take a look at the
|
using env vars. For an overview of possible values, please take a look at the
|
||||||
[`docker-compose.yml`](docker-compose.yml) file.
|
[`docker-compose.yml`](docker-compose.yml) file.
|
||||||
|
|
||||||
If you just want to test conduwuit for a short time, you can use the `--rm`
|
If you just want to test Continuwuity for a short time, you can use the `--rm`
|
||||||
flag, which will clean up everything related to your container after you stop
|
flag, which will clean up everything related to your container after you stop
|
||||||
it.
|
it.
|
||||||
|
|
||||||
|
@ -91,32 +80,32 @@ docker network create caddy
|
||||||
After that, you can rename it so it matches `docker-compose.yml` and spin up the
|
After that, you can rename it so it matches `docker-compose.yml` and spin up the
|
||||||
containers!
|
containers!
|
||||||
|
|
||||||
Additional info about deploying conduwuit can be found [here](generic.md).
|
Additional info about deploying Continuwuity can be found [here](generic.md).
|
||||||
|
|
||||||
### Build
|
### Build
|
||||||
|
|
||||||
Official conduwuit images are built using Nix's
|
Official Continuwuity images are built using **Docker Buildx** and the Dockerfile found at [`docker/Dockerfile`][dockerfile-path]. This approach uses common Docker tooling and enables multi-platform builds efficiently.
|
||||||
[`buildLayeredImage`][nix-buildlayeredimage]. This ensures all OCI images are
|
|
||||||
repeatable and reproducible by anyone, keeps the images lightweight, and can be
|
|
||||||
built offline.
|
|
||||||
|
|
||||||
This also ensures portability of our images because `buildLayeredImage` builds
|
The resulting images are broadly compatible with Docker and other container runtimes like Podman or containerd.
|
||||||
OCI images, not Docker images, and works with other container software.
|
|
||||||
|
|
||||||
The OCI images are OS-less with only a very minimal environment of the `tini`
|
The images *do not contain a shell*. They contain only the Continuwuity binary, required libraries, TLS certificates and metadata. Please refer to the [`docker/Dockerfile`][dockerfile-path] for the specific details of the image composition.
|
||||||
init system, CA certificates, and the conduwuit binary. This does mean there is
|
|
||||||
not a shell, but in theory you can get a shell by adding the necessary layers
|
|
||||||
to the layered image. However it's very unlikely you will need a shell for any
|
|
||||||
real troubleshooting.
|
|
||||||
|
|
||||||
The flake file for the OCI image definition is at [`nix/pkgs/oci-image/default.nix`][oci-image-def].
|
To build an image locally using Docker Buildx, you can typically run a command like:
|
||||||
|
|
||||||
To build an OCI image using Nix, the following outputs can be built:
|
```bash
|
||||||
- `nix build -L .#oci-image` (default features, x86_64 glibc)
|
# Build for the current platform and load into the local Docker daemon
|
||||||
- `nix build -L .#oci-image-x86_64-linux-musl` (default features, x86_64 musl)
|
docker buildx build --load --tag continuwuity:latest -f docker/Dockerfile .
|
||||||
- `nix build -L .#oci-image-aarch64-linux-musl` (default features, aarch64 musl)
|
|
||||||
- `nix build -L .#oci-image-x86_64-linux-musl-all-features` (all features, x86_64 musl)
|
# Example: Build for specific platforms and push to a registry.
|
||||||
- `nix build -L .#oci-image-aarch64-linux-musl-all-features` (all features, aarch64 musl)
|
# docker buildx build --platform linux/amd64,linux/arm64 --tag registry.io/org/continuwuity:latest -f docker/Dockerfile . --push
|
||||||
|
|
||||||
|
# Example: Build binary optimized for the current CPU
|
||||||
|
# docker buildx build --load --tag continuwuity:latest --build-arg TARGET_CPU=native -f docker/Dockerfile .
|
||||||
|
```
|
||||||
|
|
||||||
|
Refer to the Docker Buildx documentation for more advanced build options.
|
||||||
|
|
||||||
|
[dockerfile-path]: ../../docker/Dockerfile
|
||||||
|
|
||||||
### Run
|
### Run
|
||||||
|
|
||||||
|
@ -138,10 +127,10 @@ web. With the two provided files,
|
||||||
[`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml) (or
|
[`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml) (or
|
||||||
[`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)) and
|
[`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)) and
|
||||||
[`docker-compose.override.yml`](docker-compose.override.yml), it is equally easy
|
[`docker-compose.override.yml`](docker-compose.override.yml), it is equally easy
|
||||||
to deploy and use conduwuit, with a little caveat. If you already took a look at
|
to deploy and use Continuwuity, with a little caveat. If you already took a look at
|
||||||
the files, then you should have seen the `well-known` service, and that is the
|
the files, then you should have seen the `well-known` service, and that is the
|
||||||
little caveat. Traefik is simply a proxy and loadbalancer and is not able to
|
little caveat. Traefik is simply a proxy and loadbalancer and is not able to
|
||||||
serve any kind of content, but for conduwuit to federate, we need to either
|
serve any kind of content, but for Continuwuity to federate, we need to either
|
||||||
expose ports `443` and `8448` or serve two endpoints `.well-known/matrix/client`
|
expose ports `443` and `8448` or serve two endpoints `.well-known/matrix/client`
|
||||||
and `.well-known/matrix/server`.
|
and `.well-known/matrix/server`.
|
||||||
|
|
||||||
|
@ -153,4 +142,3 @@ those two files.
|
||||||
See the [TURN](../turn.md) page.
|
See the [TURN](../turn.md) page.
|
||||||
|
|
||||||
[nix-buildlayeredimage]: https://ryantm.github.io/nixpkgs/builders/images/dockertools/#ssec-pkgs-dockerTools-buildLayeredImage
|
[nix-buildlayeredimage]: https://ryantm.github.io/nixpkgs/builders/images/dockertools/#ssec-pkgs-dockerTools-buildLayeredImage
|
||||||
[oci-image-def]: https://github.com/girlbossceo/conduwuit/blob/main/nix/pkgs/oci-image/default.nix
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
# conduwuit for FreeBSD
|
# Continuwuity for FreeBSD
|
||||||
|
|
||||||
conduwuit at the moment does not provide FreeBSD builds or have FreeBSD packaging, however conduwuit does build and work on FreeBSD using the system-provided RocksDB.
|
Continuwuity at the moment does not provide FreeBSD builds or have FreeBSD packaging, however Continuwuity does build and work on FreeBSD using the system-provided RocksDB.
|
||||||
|
|
||||||
Contributions for getting conduwuit packaged are welcome.
|
Contributions for getting Continuwuity packaged are welcome.
|
||||||
|
|
|
@ -2,11 +2,11 @@
|
||||||
|
|
||||||
> ### Getting help
|
> ### Getting help
|
||||||
>
|
>
|
||||||
> If you run into any problems while setting up conduwuit, ask us in
|
> If you run into any problems while setting up Continuwuity, ask us in
|
||||||
> `#conduwuit:puppygock.gay` or [open an issue on
|
> `#continuwuity:continuwuity.org` or [open an issue on
|
||||||
> GitHub](https://github.com/girlbossceo/conduwuit/issues/new).
|
> Forgejo](https://forgejo.ellis.link/continuwuation/continuwuity/issues/new).
|
||||||
|
|
||||||
## Installing conduwuit
|
## Installing Continuwuity
|
||||||
|
|
||||||
### Static prebuilt binary
|
### Static prebuilt binary
|
||||||
|
|
||||||
|
@ -14,12 +14,10 @@ You may simply download the binary that fits your machine architecture (x86_64
|
||||||
or aarch64). Run `uname -m` to see what you need.
|
or aarch64). Run `uname -m` to see what you need.
|
||||||
|
|
||||||
Prebuilt fully static musl binaries can be downloaded from the latest tagged
|
Prebuilt fully static musl binaries can be downloaded from the latest tagged
|
||||||
release [here](https://github.com/girlbossceo/conduwuit/releases/latest) or
|
release [here](https://forgejo.ellis.link/continuwuation/continuwuity/releases/latest) or
|
||||||
`main` CI branch workflow artifact output. These also include Debian/Ubuntu
|
`main` CI branch workflow artifact output. These also include Debian/Ubuntu
|
||||||
packages.
|
packages.
|
||||||
|
|
||||||
Binaries are also available on my website directly at: <https://pup.systems/~strawberry/conduwuit/>
|
|
||||||
|
|
||||||
These can be curl'd directly from. `ci-bins` are CI workflow binaries by commit
|
These can be curl'd directly from. `ci-bins` are CI workflow binaries by commit
|
||||||
hash/revision, and `releases` are tagged releases. Sort by descending last
|
hash/revision, and `releases` are tagged releases. Sort by descending last
|
||||||
modified for the latest.
|
modified for the latest.
|
||||||
|
@ -37,7 +35,7 @@ for performance.
|
||||||
### Compiling
|
### Compiling
|
||||||
|
|
||||||
Alternatively, you may compile the binary yourself. We recommend using
|
Alternatively, you may compile the binary yourself. We recommend using
|
||||||
Nix (or [Lix](https://lix.systems)) to build conduwuit as this has the most
|
Nix (or [Lix](https://lix.systems)) to build Continuwuity as this has the most
|
||||||
guaranteed reproducibiltiy and easiest to get a build environment and output
|
guaranteed reproducibiltiy and easiest to get a build environment and output
|
||||||
going. This also allows easy cross-compilation.
|
going. This also allows easy cross-compilation.
|
||||||
|
|
||||||
|
@ -51,35 +49,35 @@ If wanting to build using standard Rust toolchains, make sure you install:
|
||||||
- `liburing-dev` on the compiling machine, and `liburing` on the target host
|
- `liburing-dev` on the compiling machine, and `liburing` on the target host
|
||||||
- LLVM and libclang for RocksDB
|
- LLVM and libclang for RocksDB
|
||||||
|
|
||||||
You can build conduwuit using `cargo build --release --all-features`
|
You can build Continuwuity using `cargo build --release --all-features`
|
||||||
|
|
||||||
## Adding a conduwuit user
|
## Adding a Continuwuity user
|
||||||
|
|
||||||
While conduwuit can run as any user it is better to use dedicated users for
|
While Continuwuity can run as any user it is better to use dedicated users for
|
||||||
different services. This also allows you to make sure that the file permissions
|
different services. This also allows you to make sure that the file permissions
|
||||||
are correctly set up.
|
are correctly set up.
|
||||||
|
|
||||||
In Debian, you can use this command to create a conduwuit user:
|
In Debian, you can use this command to create a Continuwuity user:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo adduser --system conduwuit --group --disabled-login --no-create-home
|
sudo adduser --system continuwuity --group --disabled-login --no-create-home
|
||||||
```
|
```
|
||||||
|
|
||||||
For distros without `adduser` (or where it's a symlink to `useradd`):
|
For distros without `adduser` (or where it's a symlink to `useradd`):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo useradd -r --shell /usr/bin/nologin --no-create-home conduwuit
|
sudo useradd -r --shell /usr/bin/nologin --no-create-home continuwuity
|
||||||
```
|
```
|
||||||
|
|
||||||
## Forwarding ports in the firewall or the router
|
## Forwarding ports in the firewall or the router
|
||||||
|
|
||||||
Matrix's default federation port is port 8448, and clients must be using port 443.
|
Matrix's default federation port is port 8448, and clients must be using port 443.
|
||||||
If you would like to use only port 443, or a different port, you will need to setup
|
If you would like to use only port 443, or a different port, you will need to setup
|
||||||
delegation. conduwuit has config options for doing delegation, or you can configure
|
delegation. Continuwuity has config options for doing delegation, or you can configure
|
||||||
your reverse proxy to manually serve the necessary JSON files to do delegation
|
your reverse proxy to manually serve the necessary JSON files to do delegation
|
||||||
(see the `[global.well_known]` config section).
|
(see the `[global.well_known]` config section).
|
||||||
|
|
||||||
If conduwuit runs behind a router or in a container and has a different public
|
If Continuwuity runs behind a router or in a container and has a different public
|
||||||
IP address than the host system these public ports need to be forwarded directly
|
IP address than the host system these public ports need to be forwarded directly
|
||||||
or indirectly to the port mentioned in the config.
|
or indirectly to the port mentioned in the config.
|
||||||
|
|
||||||
|
@ -94,9 +92,9 @@ on the network level, consider something like NextDNS or Pi-Hole.
|
||||||
|
|
||||||
## Setting up a systemd service
|
## Setting up a systemd service
|
||||||
|
|
||||||
Two example systemd units for conduwuit can be found
|
Two example systemd units for Continuwuity can be found
|
||||||
[on the configuration page](../configuration/examples.md#debian-systemd-unit-file).
|
[on the configuration page](../configuration/examples.md#debian-systemd-unit-file).
|
||||||
You may need to change the `ExecStart=` path to where you placed the conduwuit
|
You may need to change the `ExecStart=` path to where you placed the Continuwuity
|
||||||
binary if it is not `/usr/bin/conduwuit`.
|
binary if it is not `/usr/bin/conduwuit`.
|
||||||
|
|
||||||
On systems where rsyslog is used alongside journald (i.e. Red Hat-based distros
|
On systems where rsyslog is used alongside journald (i.e. Red Hat-based distros
|
||||||
|
@ -114,10 +112,10 @@ and entering the following:
|
||||||
ReadWritePaths=/path/to/custom/database/path
|
ReadWritePaths=/path/to/custom/database/path
|
||||||
```
|
```
|
||||||
|
|
||||||
## Creating the conduwuit configuration file
|
## Creating the Continuwuity configuration file
|
||||||
|
|
||||||
Now we need to create the conduwuit's config file in
|
Now we need to create the Continuwuity's config file in
|
||||||
`/etc/conduwuit/conduwuit.toml`. The example config can be found at
|
`/etc/continuwuity/continuwuity.toml`. The example config can be found at
|
||||||
[conduwuit-example.toml](../configuration/examples.md).
|
[conduwuit-example.toml](../configuration/examples.md).
|
||||||
|
|
||||||
**Please take a moment to read the config. You need to change at least the
|
**Please take a moment to read the config. You need to change at least the
|
||||||
|
@ -127,7 +125,7 @@ RocksDB is the only supported database backend.
|
||||||
|
|
||||||
## Setting the correct file permissions
|
## Setting the correct file permissions
|
||||||
|
|
||||||
If you are using a dedicated user for conduwuit, you will need to allow it to
|
If you are using a dedicated user for Continuwuity, you will need to allow it to
|
||||||
read the config. To do that you can run this:
|
read the config. To do that you can run this:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
@ -139,7 +137,7 @@ If you use the default database path you also need to run this:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo mkdir -p /var/lib/conduwuit/
|
sudo mkdir -p /var/lib/conduwuit/
|
||||||
sudo chown -R conduwuit:conduwuit /var/lib/conduwuit/
|
sudo chown -R continuwuity:continuwuity /var/lib/conduwuit/
|
||||||
sudo chmod 700 /var/lib/conduwuit/
|
sudo chmod 700 /var/lib/conduwuit/
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -174,13 +172,13 @@ As we would prefer our users to use Caddy, we will not provide configuration fil
|
||||||
|
|
||||||
You will need to reverse proxy everything under following routes:
|
You will need to reverse proxy everything under following routes:
|
||||||
- `/_matrix/` - core Matrix C-S and S-S APIs
|
- `/_matrix/` - core Matrix C-S and S-S APIs
|
||||||
- `/_conduwuit/` - ad-hoc conduwuit routes such as `/local_user_count` and
|
- `/_conduwuit/` - ad-hoc Continuwuity routes such as `/local_user_count` and
|
||||||
`/server_version`
|
`/server_version`
|
||||||
|
|
||||||
You can optionally reverse proxy the following individual routes:
|
You can optionally reverse proxy the following individual routes:
|
||||||
- `/.well-known/matrix/client` and `/.well-known/matrix/server` if using
|
- `/.well-known/matrix/client` and `/.well-known/matrix/server` if using
|
||||||
conduwuit to perform delegation (see the `[global.well_known]` config section)
|
Continuwuity to perform delegation (see the `[global.well_known]` config section)
|
||||||
- `/.well-known/matrix/support` if using conduwuit to send the homeserver admin
|
- `/.well-known/matrix/support` if using Continuwuity to send the homeserver admin
|
||||||
contact and support page (formerly known as MSC1929)
|
contact and support page (formerly known as MSC1929)
|
||||||
- `/` if you would like to see `hewwo from conduwuit woof!` at the root
|
- `/` if you would like to see `hewwo from conduwuit woof!` at the root
|
||||||
|
|
||||||
|
@ -200,7 +198,7 @@ header, making federation non-functional. If a workaround is found, feel free to
|
||||||
|
|
||||||
If using Apache, you need to use `nocanon` in your `ProxyPass` directive to prevent httpd from messing with the `X-Matrix` header (note that Apache isn't very good as a general reverse proxy and we discourage the usage of it if you can).
|
If using Apache, you need to use `nocanon` in your `ProxyPass` directive to prevent httpd from messing with the `X-Matrix` header (note that Apache isn't very good as a general reverse proxy and we discourage the usage of it if you can).
|
||||||
|
|
||||||
If using Nginx, you need to give conduwuit the request URI using `$request_uri`, or like so:
|
If using Nginx, you need to give Continuwuity the request URI using `$request_uri`, or like so:
|
||||||
- `proxy_pass http://127.0.0.1:6167$request_uri;`
|
- `proxy_pass http://127.0.0.1:6167$request_uri;`
|
||||||
- `proxy_pass http://127.0.0.1:6167;`
|
- `proxy_pass http://127.0.0.1:6167;`
|
||||||
|
|
||||||
|
@ -209,7 +207,7 @@ Nginx users need to increase `client_max_body_size` (default is 1M) to match
|
||||||
|
|
||||||
## You're done
|
## You're done
|
||||||
|
|
||||||
Now you can start conduwuit with:
|
Now you can start Continuwuity with:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo systemctl start conduwuit
|
sudo systemctl start conduwuit
|
||||||
|
|
|
@ -1,8 +1,9 @@
|
||||||
# conduwuit for Kubernetes
|
# Continuwuity for Kubernetes
|
||||||
|
|
||||||
conduwuit doesn't support horizontal scalability or distributed loading
|
Continuwuity doesn't support horizontal scalability or distributed loading
|
||||||
natively, however a community maintained Helm Chart is available here to run
|
natively, however a community maintained Helm Chart is available here to run
|
||||||
conduwuit on Kubernetes: <https://gitlab.cronce.io/charts/conduwuit>
|
conduwuit on Kubernetes: <https://gitlab.cronce.io/charts/conduwuit>
|
||||||
|
|
||||||
Should changes need to be made, please reach out to the maintainer in our
|
This should be compatible with continuwuity, but you will need to change the image reference.
|
||||||
Matrix room as this is not maintained/controlled by the conduwuit maintainers.
|
|
||||||
|
Should changes need to be made, please reach out to the maintainer as this is not maintained/controlled by the Continuwuity maintainers.
|
||||||
|
|
|
@ -1,66 +1,33 @@
|
||||||
# conduwuit for NixOS
|
# Continuwuity for NixOS
|
||||||
|
|
||||||
conduwuit can be acquired by Nix (or [Lix][lix]) from various places:
|
Continuwuity can be acquired by Nix (or [Lix][lix]) from various places:
|
||||||
|
|
||||||
* The `flake.nix` at the root of the repo
|
* The `flake.nix` at the root of the repo
|
||||||
* The `default.nix` at the root of the repo
|
* The `default.nix` at the root of the repo
|
||||||
* From conduwuit's binary cache
|
* From Continuwuity's binary cache
|
||||||
|
|
||||||
A community maintained NixOS package is available at [`conduwuit`](https://search.nixos.org/packages?channel=unstable&show=conduwuit&from=0&size=50&sort=relevance&type=packages&query=conduwuit)
|
|
||||||
|
|
||||||
### Binary cache
|
|
||||||
|
|
||||||
A binary cache for conduwuit that the CI/CD publishes to is available at the
|
|
||||||
following places (both are the same just different names):
|
|
||||||
|
|
||||||
```
|
|
||||||
https://attic.kennel.juneis.dog/conduit
|
|
||||||
conduit:eEKoUwlQGDdYmAI/Q/0slVlegqh/QmAvQd7HBSm21Wk=
|
|
||||||
|
|
||||||
https://attic.kennel.juneis.dog/conduwuit
|
|
||||||
conduwuit:BbycGUgTISsltcmH0qNjFR9dbrQNYgdIAcmViSGoVTE=
|
|
||||||
```
|
|
||||||
|
|
||||||
The binary caches were recreated some months ago due to attic issues. The old public
|
|
||||||
keys were:
|
|
||||||
|
|
||||||
```
|
|
||||||
conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg=
|
|
||||||
conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw=
|
|
||||||
```
|
|
||||||
|
|
||||||
If needed, we have a binary cache on Cachix but it is only limited to 5GB:
|
|
||||||
|
|
||||||
```
|
|
||||||
https://conduwuit.cachix.org
|
|
||||||
conduwuit.cachix.org-1:MFRm6jcnfTf0jSAbmvLfhO3KBMt4px+1xaereWXp8Xg=
|
|
||||||
```
|
|
||||||
|
|
||||||
If specifying a Git remote URL in your flake, you can use any remotes that
|
|
||||||
are specified on the README (the mirrors), such as the GitHub: `github:girlbossceo/conduwuit`
|
|
||||||
|
|
||||||
### NixOS module
|
### NixOS module
|
||||||
|
|
||||||
The `flake.nix` and `default.nix` do not currently provide a NixOS module (contributions
|
The `flake.nix` and `default.nix` do not currently provide a NixOS module (contributions
|
||||||
welcome!), so [`services.matrix-conduit`][module] from Nixpkgs can be used to configure
|
welcome!), so [`services.matrix-conduit`][module] from Nixpkgs can be used to configure
|
||||||
conduwuit.
|
Continuwuity.
|
||||||
|
|
||||||
### Conduit NixOS Config Module and SQLite
|
### Conduit NixOS Config Module and SQLite
|
||||||
|
|
||||||
Beware! The [`services.matrix-conduit`][module] module defaults to SQLite as a database backend.
|
Beware! The [`services.matrix-conduit`][module] module defaults to SQLite as a database backend.
|
||||||
Conduwuit dropped SQLite support in favor of exclusively supporting the much faster RocksDB.
|
Continuwuity dropped SQLite support in favor of exclusively supporting the much faster RocksDB.
|
||||||
Make sure that you are using the RocksDB backend before migrating!
|
Make sure that you are using the RocksDB backend before migrating!
|
||||||
|
|
||||||
There is a [tool to migrate a Conduit SQLite database to
|
There is a [tool to migrate a Conduit SQLite database to
|
||||||
RocksDB](https://github.com/ShadowJonathan/conduit_toolbox/).
|
RocksDB](https://github.com/ShadowJonathan/conduit_toolbox/).
|
||||||
|
|
||||||
If you want to run the latest code, you should get conduwuit from the `flake.nix`
|
If you want to run the latest code, you should get Continuwuity from the `flake.nix`
|
||||||
or `default.nix` and set [`services.matrix-conduit.package`][package]
|
or `default.nix` and set [`services.matrix-conduit.package`][package]
|
||||||
appropriately to use conduwuit instead of Conduit.
|
appropriately to use Continuwuity instead of Conduit.
|
||||||
|
|
||||||
### UNIX sockets
|
### UNIX sockets
|
||||||
|
|
||||||
Due to the lack of a conduwuit NixOS module, when using the `services.matrix-conduit` module
|
Due to the lack of a Continuwuity NixOS module, when using the `services.matrix-conduit` module
|
||||||
a workaround like the one below is necessary to use UNIX sockets. This is because the UNIX
|
a workaround like the one below is necessary to use UNIX sockets. This is because the UNIX
|
||||||
socket option does not exist in Conduit, and the module forcibly sets the `address` and
|
socket option does not exist in Conduit, and the module forcibly sets the `address` and
|
||||||
`port` config options.
|
`port` config options.
|
||||||
|
@ -84,13 +51,13 @@ disallows the namespace from accessing or creating UNIX sockets and has to be en
|
||||||
systemd.services.conduit.serviceConfig.RestrictAddressFamilies = [ "AF_UNIX" ];
|
systemd.services.conduit.serviceConfig.RestrictAddressFamilies = [ "AF_UNIX" ];
|
||||||
```
|
```
|
||||||
|
|
||||||
Even though those workarounds are feasible a conduwuit NixOS configuration module, developed and
|
Even though those workarounds are feasible a Continuwuity NixOS configuration module, developed and
|
||||||
published by the community, would be appreciated.
|
published by the community, would be appreciated.
|
||||||
|
|
||||||
### jemalloc and hardened profile
|
### jemalloc and hardened profile
|
||||||
|
|
||||||
conduwuit uses jemalloc by default. This may interfere with the [`hardened.nix` profile][hardened.nix]
|
Continuwuity uses jemalloc by default. This may interfere with the [`hardened.nix` profile][hardened.nix]
|
||||||
due to them using `scudo` by default. You must either disable/hide `scudo` from conduwuit, or
|
due to them using `scudo` by default. You must either disable/hide `scudo` from Continuwuity, or
|
||||||
disable jemalloc like so:
|
disable jemalloc like so:
|
||||||
|
|
||||||
```nix
|
```nix
|
||||||
|
|
|
@ -4,9 +4,9 @@ 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
|
it, you can safely ignore this page. If you plan on contributing, see the
|
||||||
[contributor's guide](./contributing.md).
|
[contributor's guide](./contributing.md).
|
||||||
|
|
||||||
## conduwuit project layout
|
## Continuwuity project layout
|
||||||
|
|
||||||
conduwuit uses a collection of sub-crates, packages, or workspace members
|
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
|
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
|
members are under `src/`. The workspace definition is at the top level / root
|
||||||
`Cargo.toml`.
|
`Cargo.toml`.
|
||||||
|
@ -14,11 +14,11 @@ members are under `src/`. The workspace definition is at the top level / root
|
||||||
The crate names are generally self-explanatory:
|
The crate names are generally self-explanatory:
|
||||||
- `admin` is the admin room
|
- `admin` is the admin room
|
||||||
- `api` is the HTTP API, Matrix C-S and S-S endpoints, etc
|
- `api` is the HTTP API, Matrix C-S and S-S endpoints, etc
|
||||||
- `core` is core conduwuit functionality like config loading, error definitions,
|
- `core` is core Continuwuity functionality like config loading, error definitions,
|
||||||
global utilities, logging infrastructure, etc
|
global utilities, logging infrastructure, etc
|
||||||
- `database` is RocksDB methods, helpers, RocksDB config, and general database definitions,
|
- `database` is RocksDB methods, helpers, RocksDB config, and general database definitions,
|
||||||
utilities, or functions
|
utilities, or functions
|
||||||
- `macros` are conduwuit Rust [macros][macros] like general helper macros, logging
|
- `macros` are Continuwuity Rust [macros][macros] like general helper macros, logging
|
||||||
and error handling macros, and [syn][syn] and [procedural macros][proc-macro]
|
and error handling macros, and [syn][syn] and [procedural macros][proc-macro]
|
||||||
used for admin room commands and others
|
used for admin room commands and others
|
||||||
- `main` is the "primary" sub-crate. This is where the `main()` function lives,
|
- `main` is the "primary" sub-crate. This is where the `main()` function lives,
|
||||||
|
@ -35,7 +35,7 @@ if you truly find yourself needing to, we recommend reaching out to us in
|
||||||
the Matrix room for discussions about it beforehand.
|
the Matrix room for discussions about it beforehand.
|
||||||
|
|
||||||
The primary inspiration for this design was apart of hot reloadable development,
|
The primary inspiration for this design was apart of hot reloadable development,
|
||||||
to support "conduwuit as a library" where specific parts can simply be swapped out.
|
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
|
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
|
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.
|
for handling inbound web requests; but it was never completed or worked.
|
||||||
|
@ -68,36 +68,27 @@ do this if Rust supported workspace-level features to begin with.
|
||||||
|
|
||||||
## List of forked dependencies
|
## List of forked dependencies
|
||||||
|
|
||||||
During conduwuit development, we have had to fork
|
During Continuwuity (and prior projects) development, we have had to fork some dependencies to support our use-cases.
|
||||||
some dependencies to support our use-cases in some areas. This ranges from
|
These forks exist for various reasons including features that upstream projects won't accept,
|
||||||
things said upstream project won't accept for any reason, faster-paced
|
faster-paced development, Continuwuity-specific usecases, or lack of time to upstream changes.
|
||||||
development (unresponsive or slow upstream), conduwuit-specific usecases, or
|
|
||||||
lack of time to upstream some things.
|
|
||||||
|
|
||||||
- [ruma/ruma][1]: <https://github.com/girlbossceo/ruwuma> - various performance
|
All forked dependencies are maintained under the [continuwuation organization on Forgejo](https://forgejo.ellis.link/continuwuation):
|
||||||
improvements, more features, faster-paced development, better client/server interop
|
|
||||||
hacks upstream won't accept, etc
|
- [ruwuma][continuwuation-ruwuma] - Fork of [ruma/ruma][ruma] with various performance improvements, more features and better client/server interop
|
||||||
- [facebook/rocksdb][2]: <https://github.com/girlbossceo/rocksdb> - liburing
|
- [rocksdb][continuwuation-rocksdb] - Fork of [facebook/rocksdb][rocksdb] via [`@zaidoon1`][8] with liburing build fixes and GCC debug build fixes
|
||||||
build fixes and GCC debug build fix
|
- [jemallocator][continuwuation-jemallocator] - Fork of [tikv/jemallocator][jemallocator] fixing musl builds, suspicious code,
|
||||||
- [tikv/jemallocator][3]: <https://github.com/girlbossceo/jemallocator> - musl
|
and adding support for redzones in Valgrind
|
||||||
builds seem to be broken on upstream, fixes some broken/suspicious code in
|
- [rustyline-async][continuwuation-rustyline-async] - Fork of [zyansheep/rustyline-async][rustyline-async] with tab completion callback
|
||||||
places, additional safety measures, and support redzones for Valgrind
|
and `CTRL+\` signal quit event for Continuwuity console CLI
|
||||||
- [zyansheep/rustyline-async][4]:
|
- [rust-rocksdb][continuwuation-rust-rocksdb] - Fork of [rust-rocksdb/rust-rocksdb][rust-rocksdb] fixing musl build issues,
|
||||||
<https://github.com/girlbossceo/rustyline-async> - tab completion callback and
|
removing unnecessary `gtest` include, and using our RocksDB and jemallocator forks
|
||||||
`CTRL+\` signal quit event for conduwuit console CLI
|
- [tracing][continuwuation-tracing] - Fork of [tokio-rs/tracing][tracing] implementing `Clone` for `EnvFilter` to
|
||||||
- [rust-rocksdb/rust-rocksdb][5]:
|
support dynamically changing tracing environments
|
||||||
<https://github.com/girlbossceo/rust-rocksdb-zaidoon1> - [`@zaidoon1`][8]'s fork
|
|
||||||
has quicker updates, more up to date dependencies, etc. Our fork fixes musl build
|
|
||||||
issues, removes unnecessary `gtest` include, and uses our RocksDB and jemallocator
|
|
||||||
forks.
|
|
||||||
- [tokio-rs/tracing][6]: <https://github.com/girlbossceo/tracing> - Implements
|
|
||||||
`Clone` for `EnvFilter` to support dynamically changing tracing envfilter's
|
|
||||||
alongside other logging/metrics things
|
|
||||||
|
|
||||||
## Debugging with `tokio-console`
|
## Debugging with `tokio-console`
|
||||||
|
|
||||||
[`tokio-console`][7] can be a useful tool for debugging and profiling. To make a
|
[`tokio-console`][7] can be a useful tool for debugging and profiling. To make a
|
||||||
`tokio-console`-enabled build of conduwuit, enable the `tokio_console` feature,
|
`tokio-console`-enabled build of Continuwuity, enable the `tokio_console` feature,
|
||||||
disable the default `release_max_log_level` feature, and set the `--cfg
|
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
|
tokio_unstable` flag to enable experimental tokio APIs. A build might look like
|
||||||
this:
|
this:
|
||||||
|
@ -109,16 +100,34 @@ RUSTFLAGS="--cfg tokio_unstable" cargo +nightly build \
|
||||||
--features=systemd,element_hacks,gzip_compression,brotli_compression,zstd_compression,tokio_console
|
--features=systemd,element_hacks,gzip_compression,brotli_compression,zstd_compression,tokio_console
|
||||||
```
|
```
|
||||||
|
|
||||||
You will also need to enable the `tokio_console` config option in conduwuit when
|
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
|
starting it. This was due to tokio-console causing gradual memory leak/usage
|
||||||
if left enabled.
|
if left enabled.
|
||||||
|
|
||||||
[1]: https://github.com/ruma/ruma/
|
## Building Docker Images
|
||||||
[2]: https://github.com/facebook/rocksdb/
|
|
||||||
[3]: https://github.com/tikv/jemallocator/
|
To build a Docker image for Continuwuity, use the standard Docker build command:
|
||||||
[4]: https://github.com/zyansheep/rustyline-async/
|
|
||||||
[5]: https://github.com/rust-rocksdb/rust-rocksdb/
|
```bash
|
||||||
[6]: https://github.com/tokio-rs/tracing/
|
docker build -f docker/Dockerfile .
|
||||||
|
```
|
||||||
|
|
||||||
|
The image can be cross-compiled for different architectures.
|
||||||
|
|
||||||
|
[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/
|
[7]: https://docs.rs/tokio-console/latest/tokio_console/
|
||||||
[8]: https://github.com/zaidoon1/
|
[8]: https://github.com/zaidoon1/
|
||||||
[9]: https://github.com/rust-lang/cargo/issues/12162
|
[9]: https://github.com/rust-lang/cargo/issues/12162
|
||||||
|
|
|
@ -5,7 +5,7 @@ guaranteed to work at this time.
|
||||||
|
|
||||||
### Summary
|
### Summary
|
||||||
|
|
||||||
When developing in debug-builds with the nightly toolchain, conduwuit is modular
|
When developing in debug-builds with the nightly toolchain, Continuwuity is modular
|
||||||
using dynamic libraries and various parts of the application are hot-reloadable
|
using dynamic libraries and various parts of the application are hot-reloadable
|
||||||
while the server is running: http api handlers, admin commands, services,
|
while the server is running: http api handlers, admin commands, services,
|
||||||
database, etc. These are all split up into individual workspace crates as seen
|
database, etc. These are all split up into individual workspace crates as seen
|
||||||
|
@ -42,7 +42,7 @@ 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).
|
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
|
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`
|
happen to have linker issues it's recommended to try using `mold` or `gold`
|
||||||
linkers, and please let us know in the [conduwuit Matrix room][7] the linker
|
linkers, and please let us know in the [Continuwuity Matrix room][7] the linker
|
||||||
error and what linker solved this issue so we can figure out a solution. Ideally
|
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
|
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
|
(`build.rs`) may be suitable to making this easier to use if the capabilities
|
||||||
|
@ -52,13 +52,13 @@ allow us.
|
||||||
|
|
||||||
As of 19 May 2024, the instructions for using this are:
|
As of 19 May 2024, the instructions for using this are:
|
||||||
|
|
||||||
0. Have patience. Don't hesitate to join the [conduwuit Matrix room][7] to
|
0. Have patience. Don't hesitate to join the [Continuwuity Matrix room][7] to
|
||||||
receive help using this. As indicated by the various rustflags used and some
|
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
|
of the interesting issues linked at the bottom, this is definitely not something
|
||||||
the Rust ecosystem or toolchain is used to doing.
|
the Rust ecosystem or toolchain is used to doing.
|
||||||
|
|
||||||
1. Install the nightly toolchain using rustup. You may need to use `rustup
|
1. Install the nightly toolchain using rustup. You may need to use `rustup
|
||||||
override set nightly` in your local conduwuit directory, or use `cargo
|
override set nightly` in your local Continuwuity directory, or use `cargo
|
||||||
+nightly` for all actions.
|
+nightly` for all actions.
|
||||||
|
|
||||||
2. Uncomment `cargo-features` at the top level / root Cargo.toml
|
2. Uncomment `cargo-features` at the top level / root Cargo.toml
|
||||||
|
@ -85,14 +85,14 @@ LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$HOME/.rustup/toolchains/nightly-x86_64-unknown
|
||||||
Cargo should only rebuild what was changed / what's necessary, so it should
|
Cargo should only rebuild what was changed / what's necessary, so it should
|
||||||
not be rebuilding all the crates.
|
not be rebuilding all the crates.
|
||||||
|
|
||||||
9. In your conduwuit server terminal, hit/send `CTRL+C` signal. This will tell
|
9. In your Continuwuity server terminal, hit/send `CTRL+C` signal. This will tell
|
||||||
conduwuit to find which libraries need to be reloaded, and reloads them as
|
Continuwuity to find which libraries need to be reloaded, and reloads them as
|
||||||
necessary.
|
necessary.
|
||||||
|
|
||||||
10. If there were no errors, it will tell you it successfully reloaded `#`
|
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.
|
modules, and your changes should now be visible. Repeat 7 - 9 as needed.
|
||||||
|
|
||||||
To shutdown conduwuit in this setup, hit/send `CTRL+\`. Normal builds still
|
To shutdown Continuwuity in this setup, hit/send `CTRL+\`. Normal builds still
|
||||||
shutdown with `CTRL+C` as usual.
|
shutdown with `CTRL+C` as usual.
|
||||||
|
|
||||||
Steps 1 - 5 are the initial first-time steps for using this. To remove the hot
|
Steps 1 - 5 are the initial first-time steps for using this. To remove the hot
|
||||||
|
@ -101,7 +101,7 @@ reload setup, revert/comment all the Cargo.toml changes.
|
||||||
As mentioned in the requirements section, if you happen to have some linker
|
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
|
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
|
`rustflags` definitions in the top level Cargo.toml, and please let us know in
|
||||||
the [conduwuit Matrix room][7] the problem. mold can be installed typically
|
the [Continuwuity Matrix room][7] the problem. mold can be installed typically
|
||||||
through your distro, and gold is provided by the binutils package.
|
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
|
It's possible a helper script can be made to do all of this, or most preferably
|
||||||
|
@ -136,7 +136,7 @@ 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
|
**no crate is allowed to call a function or use a variable from a crate below
|
||||||
it.**
|
it.**
|
||||||
|
|
||||||

|
Volk](assets/libraries.png)
|
||||||
|
|
||||||
When a symbol is referenced between crates they become bound: **crates cannot be
|
When a symbol is referenced between crates they become bound: **crates cannot be
|
||||||
|
@ -147,7 +147,7 @@ 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
|
and the first crate, freeing the executable from all modules as no global
|
||||||
binding ever occurs between them.
|
binding ever occurs between them.
|
||||||
|
|
||||||

|
Volk](assets/reload_order.png)
|
||||||
|
|
||||||
Proper resource management is essential for reliable reloading to occur. This is
|
Proper resource management is essential for reliable reloading to occur. This is
|
||||||
|
@ -190,11 +190,11 @@ The initial implementation PR is available [here][1].
|
||||||
- [Workspace-level metadata
|
- [Workspace-level metadata
|
||||||
(cargo-deb)](https://github.com/kornelski/cargo-deb/issues/68)
|
(cargo-deb)](https://github.com/kornelski/cargo-deb/issues/68)
|
||||||
|
|
||||||
[1]: https://github.com/girlbossceo/conduwuit/pull/387
|
[1]: https://forgejo.ellis.link/continuwuation/continuwuity/pulls/387
|
||||||
[2]: https://wiki.musl-libc.org/functional-differences-from-glibc.html#Unloading-libraries
|
[2]: https://wiki.musl-libc.org/functional-differences-from-glibc.html#Unloading-libraries
|
||||||
[3]: https://github.com/rust-lang/rust/issues/28794
|
[3]: https://github.com/rust-lang/rust/issues/28794
|
||||||
[4]: https://github.com/rust-lang/rust/issues/28794#issuecomment-368693049
|
[4]: https://github.com/rust-lang/rust/issues/28794#issuecomment-368693049
|
||||||
[5]: https://github.com/rust-lang/cargo/issues/12746
|
[5]: https://github.com/rust-lang/cargo/issues/12746
|
||||||
[6]: https://crates.io/crates/hot-lib-reloader/
|
[6]: https://crates.io/crates/hot-lib-reloader/
|
||||||
[7]: https://matrix.to/#/#conduwuit:puppygock.gay
|
[7]: https://matrix.to/#/#continuwuity:continuwuity.org
|
||||||
[8]: https://crates.io/crates/libloading
|
[8]: https://crates.io/crates/libloading
|
||||||
|
|
|
@ -24,8 +24,9 @@ and run the script.
|
||||||
If you're on macOS and need to build an image, run `nix build .#linux-complement`.
|
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
|
We have a Complement fork as some tests have needed to be fixed. This can be found
|
||||||
at: <https://github.com/girlbossceo/complement>
|
at: <https://forgejo.ellis.link/continuwuation/complement>
|
||||||
|
|
||||||
[ci-workflows]: https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml?query=event%3Apush+is%3Asuccess+actor%3Agirlbossceo
|
[ci-workflows]:
|
||||||
|
https://forgejo.ellis.link/continuwuation/continuwuity/actions/?workflow=ci.yml&actor=0&status=1
|
||||||
[complement]: https://github.com/matrix-org/complement
|
[complement]: https://github.com/matrix-org/complement
|
||||||
[direnv]: https://direnv.net/docs/hook.html
|
[direnv]: https://direnv.net/docs/hook.html
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# conduwuit
|
# Continuwuity
|
||||||
|
|
||||||
{{#include ../README.md:catchphrase}}
|
{{#include ../README.md:catchphrase}}
|
||||||
|
|
||||||
|
@ -8,7 +8,7 @@
|
||||||
|
|
||||||
- [Deployment options](deploying.md)
|
- [Deployment options](deploying.md)
|
||||||
|
|
||||||
If you want to connect an appservice to conduwuit, take a look at the
|
If you want to connect an appservice to Continuwuity, take a look at the
|
||||||
[appservices documentation](appservices.md).
|
[appservices documentation](appservices.md).
|
||||||
|
|
||||||
#### How can I contribute?
|
#### How can I contribute?
|
||||||
|
|
|
@ -1,14 +1,14 @@
|
||||||
# Maintaining your conduwuit setup
|
# Maintaining your Continuwuity setup
|
||||||
|
|
||||||
## Moderation
|
## Moderation
|
||||||
|
|
||||||
conduwuit has moderation through admin room commands. "binary commands" (medium
|
Continuwuity has moderation through admin room commands. "binary commands" (medium
|
||||||
priority) and an admin API (low priority) is planned. Some moderation-related
|
priority) and an admin API (low priority) is planned. Some moderation-related
|
||||||
config options are available in the example config such as "global ACLs" and
|
config options are available in the example config such as "global ACLs" and
|
||||||
blocking media requests to certain servers. See the example config for the
|
blocking media requests to certain servers. See the example config for the
|
||||||
moderation config options under the "Moderation / Privacy / Security" section.
|
moderation config options under the "Moderation / Privacy / Security" section.
|
||||||
|
|
||||||
conduwuit has moderation admin commands for:
|
Continuwuity has moderation admin commands for:
|
||||||
|
|
||||||
- managing room aliases (`!admin rooms alias`)
|
- managing room aliases (`!admin rooms alias`)
|
||||||
- managing room directory (`!admin rooms directory`)
|
- managing room directory (`!admin rooms directory`)
|
||||||
|
@ -36,7 +36,7 @@ each object being newline delimited. An example of doing this is:
|
||||||
## Database (RocksDB)
|
## Database (RocksDB)
|
||||||
|
|
||||||
Generally there is very little you need to do. [Compaction][rocksdb-compaction]
|
Generally there is very little you need to do. [Compaction][rocksdb-compaction]
|
||||||
is ran automatically based on various defined thresholds tuned for conduwuit to
|
is ran automatically based on various defined thresholds tuned for Continuwuity to
|
||||||
be high performance with the least I/O amplifcation or overhead. Manually
|
be high performance with the least I/O amplifcation or overhead. Manually
|
||||||
running compaction is not recommended, or compaction via a timer, due to
|
running compaction is not recommended, or compaction via a timer, due to
|
||||||
creating unnecessary I/O amplification. RocksDB is built with io_uring support
|
creating unnecessary I/O amplification. RocksDB is built with io_uring support
|
||||||
|
@ -50,7 +50,7 @@ Some RocksDB settings can be adjusted such as the compression method chosen. See
|
||||||
the RocksDB section in the [example config](configuration/examples.md).
|
the RocksDB section in the [example config](configuration/examples.md).
|
||||||
|
|
||||||
btrfs users have reported that database compression does not need to be disabled
|
btrfs users have reported that database compression does not need to be disabled
|
||||||
on conduwuit as the filesystem already does not attempt to compress. This can be
|
on Continuwuity as the filesystem already does not attempt to compress. This can be
|
||||||
validated by using `filefrag -v` on a `.SST` file in your database, and ensure
|
validated by using `filefrag -v` on a `.SST` file in your database, and ensure
|
||||||
the `physical_offset` matches (no filesystem compression). It is very important
|
the `physical_offset` matches (no filesystem compression). It is very important
|
||||||
to ensure no additional filesystem compression takes place as this can render
|
to ensure no additional filesystem compression takes place as this can render
|
||||||
|
@ -70,8 +70,8 @@ they're server logs or database logs, however they are critical RocksDB files
|
||||||
related to WAL tracking.
|
related to WAL tracking.
|
||||||
|
|
||||||
The only safe files that can be deleted are the `LOG` files (all caps). These
|
The only safe files that can be deleted are the `LOG` files (all caps). These
|
||||||
are the real RocksDB telemetry/log files, however conduwuit has already
|
are the real RocksDB telemetry/log files, however Continuwuity has already
|
||||||
configured to only store up to 3 RocksDB `LOG` files due to generall being
|
configured to only store up to 3 RocksDB `LOG` files due to generally being
|
||||||
useless for average users unless troubleshooting something low-level. If you
|
useless for average users unless troubleshooting something low-level. If you
|
||||||
would like to store nearly none at all, see the `rocksdb_max_log_files`
|
would like to store nearly none at all, see the `rocksdb_max_log_files`
|
||||||
config option.
|
config option.
|
||||||
|
@ -88,7 +88,7 @@ still be joined together.
|
||||||
|
|
||||||
To restore a backup from an online RocksDB backup:
|
To restore a backup from an online RocksDB backup:
|
||||||
|
|
||||||
- shutdown conduwuit
|
- shutdown Continuwuity
|
||||||
- create a new directory for merging together the data
|
- create a new directory for merging together the data
|
||||||
- in the online backup created, copy all `.sst` files in
|
- in the online backup created, copy all `.sst` files in
|
||||||
`$DATABASE_BACKUP_PATH/shared_checksum` to your new directory
|
`$DATABASE_BACKUP_PATH/shared_checksum` to your new directory
|
||||||
|
@ -99,9 +99,9 @@ To restore a backup from an online RocksDB backup:
|
||||||
if you have multiple) to your new directory
|
if you have multiple) to your new directory
|
||||||
- set your `database_path` config option to your new directory, or replace your
|
- set your `database_path` config option to your new directory, or replace your
|
||||||
old one with the new one you crafted
|
old one with the new one you crafted
|
||||||
- start up conduwuit again and it should open as normal
|
- start up Continuwuity again and it should open as normal
|
||||||
|
|
||||||
If you'd like to do an offline backup, shutdown conduwuit and copy your
|
If you'd like to do an offline backup, shutdown Continuwuity and copy your
|
||||||
`database_path` directory elsewhere. This can be restored with no modifications
|
`database_path` directory elsewhere. This can be restored with no modifications
|
||||||
needed.
|
needed.
|
||||||
|
|
||||||
|
@ -110,7 +110,7 @@ directory.
|
||||||
|
|
||||||
## Media
|
## Media
|
||||||
|
|
||||||
Media still needs various work, however conduwuit implements media deletion via:
|
Media still needs various work, however Continuwuity implements media deletion via:
|
||||||
|
|
||||||
- MXC URI or Event ID (unencrypted and attempts to find the MXC URI in the
|
- MXC URI or Event ID (unencrypted and attempts to find the MXC URI in the
|
||||||
event)
|
event)
|
||||||
|
@ -118,17 +118,17 @@ event)
|
||||||
- Delete remote media in the past `N` seconds/minutes via filesystem metadata on
|
- Delete remote media in the past `N` seconds/minutes via filesystem metadata on
|
||||||
the file created time (`btime`) or file modified time (`mtime`)
|
the file created time (`btime`) or file modified time (`mtime`)
|
||||||
|
|
||||||
See the `!admin media` command for further information. All media in conduwuit
|
See the `!admin media` command for further information. All media in Continuwuity
|
||||||
is stored at `$DATABASE_DIR/media`. This will be configurable soon.
|
is stored at `$DATABASE_DIR/media`. This will be configurable soon.
|
||||||
|
|
||||||
If you are finding yourself needing extensive granular control over media, we
|
If you are finding yourself needing extensive granular control over media, we
|
||||||
recommend looking into [Matrix Media
|
recommend looking into [Matrix Media
|
||||||
Repo](https://github.com/t2bot/matrix-media-repo). conduwuit intends to
|
Repo](https://github.com/t2bot/matrix-media-repo). Continuwuity intends to
|
||||||
implement various utilities for media, but MMR is dedicated to extensive media
|
implement various utilities for media, but MMR is dedicated to extensive media
|
||||||
management.
|
management.
|
||||||
|
|
||||||
Built-in S3 support is also planned, but for now using a "S3 filesystem" on
|
Built-in S3 support is also planned, but for now using a "S3 filesystem" on
|
||||||
`media/` works. conduwuit also sends a `Cache-Control` header of 1 year and
|
`media/` works. Continuwuity also sends a `Cache-Control` header of 1 year and
|
||||||
immutable for all media requests (download and thumbnail) to reduce unnecessary
|
immutable for all media requests (download and thumbnail) to reduce unnecessary
|
||||||
media requests from browsers, reduce bandwidth usage, and reduce load.
|
media requests from browsers, reduce bandwidth usage, and reduce load.
|
||||||
|
|
||||||
|
|
1
docs/security.md
Normal file
1
docs/security.md
Normal file
|
@ -0,0 +1 @@
|
||||||
|
{{#include ../SECURITY.md}}
|
4
docs/static/announcements.json
vendored
4
docs/static/announcements.json
vendored
|
@ -4,6 +4,10 @@
|
||||||
{
|
{
|
||||||
"id": 1,
|
"id": 1,
|
||||||
"message": "Welcome to Continuwuity! Important announcements about the project will appear here."
|
"message": "Welcome to Continuwuity! Important announcements about the project will appear here."
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": 2,
|
||||||
|
"message": "🎉 Continuwuity v0.5.0-rc.6 is now available! This release includes improved knock-restricted room handling, automatic support contact configuration, and a new HTML landing page. Check [the release notes for full details](https://forgejo.ellis.link/continuwuation/continuwuity/releases/tag/v0.5.0-rc.6) and upgrade instructions."
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
8
docs/static/announcements.schema.json
vendored
8
docs/static/announcements.schema.json
vendored
|
@ -3,7 +3,7 @@
|
||||||
"$id": "https://continwuity.org/schema/announcements.schema.json",
|
"$id": "https://continwuity.org/schema/announcements.schema.json",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"updates": {
|
"announcements": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
|
@ -16,6 +16,10 @@
|
||||||
},
|
},
|
||||||
"date": {
|
"date": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
|
},
|
||||||
|
"mention_room": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Whether to mention the room (@room) when posting this announcement"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
|
@ -26,6 +30,6 @@
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
"updates"
|
"announcements"
|
||||||
]
|
]
|
||||||
}
|
}
|
24
docs/static/support
vendored
Normal file
24
docs/static/support
vendored
Normal file
|
@ -0,0 +1,24 @@
|
||||||
|
{
|
||||||
|
"contacts": [
|
||||||
|
{
|
||||||
|
"email_address": "security@continuwuity.org",
|
||||||
|
"role": "m.role.security"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"matrix_id": "@tom:continuwuity.org",
|
||||||
|
"email_address": "tom@tcpip.uk",
|
||||||
|
"role": "m.role.admin"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"matrix_id": "@jade:continuwuity.org",
|
||||||
|
"email_address": "jade@continuwuity.org",
|
||||||
|
"role": "m.role.admin"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"matrix_id": "@nex:continuwuity.org",
|
||||||
|
"email_address": "nex@continuwuity.org",
|
||||||
|
"role": "m.role.admin"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"support_page": "https://continuwuity.org/introduction#contact"
|
||||||
|
}
|
|
@ -1,47 +1,48 @@
|
||||||
# Troubleshooting conduwuit
|
# Troubleshooting Continuwuity
|
||||||
|
|
||||||
> ## Docker users ⚠️
|
> **Docker users ⚠️**
|
||||||
>
|
>
|
||||||
> Docker is extremely UX unfriendly. Because of this, a ton of issues or support
|
> Docker can be difficult to use and debug. It's common for Docker
|
||||||
> is actually Docker support, not conduwuit support. We also cannot document the
|
> misconfigurations to cause issues, particularly with networking and permissions.
|
||||||
> ever-growing list of Docker issues here.
|
> Please check that your issues are not due to problems with your Docker setup.
|
||||||
>
|
|
||||||
> If you intend on asking for support and you are using Docker, **PLEASE**
|
|
||||||
> triple validate your issues are **NOT** because you have a misconfiguration in
|
|
||||||
> your Docker setup.
|
|
||||||
>
|
|
||||||
> If there are things like Compose file issues or Dockerhub image issues, those
|
|
||||||
> can still be mentioned as long as they're something we can fix.
|
|
||||||
|
|
||||||
## conduwuit and Matrix issues
|
## Continuwuity and Matrix issues
|
||||||
|
|
||||||
#### Lost access to admin room
|
### Lost access to admin room
|
||||||
|
|
||||||
You can reinvite yourself to the admin room through the following methods:
|
You can reinvite yourself to the admin room through the following methods:
|
||||||
- Use the `--execute "users make_user_admin <username>"` conduwuit binary
|
|
||||||
|
- Use the `--execute "users make_user_admin <username>"` Continuwuity binary
|
||||||
argument once to invite yourslf to the admin room on startup
|
argument once to invite yourslf to the admin room on startup
|
||||||
- Use the conduwuit console/CLI to run the `users make_user_admin` command
|
- Use the Continuwuity console/CLI to run the `users make_user_admin` command
|
||||||
- Or specify the `emergency_password` config option to allow you to temporarily
|
- Or specify the `emergency_password` config option to allow you to temporarily
|
||||||
log into the server account (`@conduit`) from a web client
|
log into the server account (`@conduit`) from a web client
|
||||||
|
|
||||||
## General potential issues
|
## General potential issues
|
||||||
|
|
||||||
#### Potential DNS issues when using Docker
|
### Potential DNS issues when using Docker
|
||||||
|
|
||||||
Docker has issues with its default DNS setup that may cause DNS to not be
|
Docker's DNS setup for containers in a non-default network intercepts queries to
|
||||||
properly functional when running conduwuit, resulting in federation issues. The
|
enable resolving of container hostnames to IP addresses. However, due to
|
||||||
symptoms of this have shown in excessively long room joins (30+ minutes) from
|
performance issues with Docker's built-in resolver, this can cause DNS queries
|
||||||
very long DNS timeouts, log entries of "mismatching responding nameservers",
|
to take a long time to resolve, resulting in federation issues.
|
||||||
|
|
||||||
|
This is particularly common with Docker Compose, as custom networks are easily
|
||||||
|
created and configured.
|
||||||
|
|
||||||
|
Symptoms of this include excessively long room joins (30+ minutes) from very
|
||||||
|
long DNS timeouts, log entries of "mismatching responding nameservers",
|
||||||
and/or partial or non-functional inbound/outbound federation.
|
and/or partial or non-functional inbound/outbound federation.
|
||||||
|
|
||||||
This is **not** a conduwuit issue, and is purely a Docker issue. It is not
|
This is not a bug in continuwuity. Docker's default DNS resolver is not suitable
|
||||||
sustainable for heavy DNS activity which is normal for Matrix federation. The
|
for heavy DNS activity, which is normal for federated protocols like Matrix.
|
||||||
workarounds for this are:
|
|
||||||
- Use DNS over TCP via the config option `query_over_tcp_only = true`
|
|
||||||
- Don't use Docker's default DNS setup and instead allow the container to use
|
|
||||||
and communicate with your host's DNS servers (host's `/etc/resolv.conf`)
|
|
||||||
|
|
||||||
#### DNS No connections available error message
|
Workarounds:
|
||||||
|
|
||||||
|
- Use DNS over TCP via the config option `query_over_tcp_only = true`
|
||||||
|
- Bypass Docker's default DNS setup and instead allow the container to use and communicate with your host's DNS servers. Typically, this can be done by mounting the host's `/etc/resolv.conf`.
|
||||||
|
|
||||||
|
### DNS No connections available error message
|
||||||
|
|
||||||
If you receive spurious amounts of error logs saying "DNS No connections
|
If you receive spurious amounts of error logs saying "DNS No connections
|
||||||
available", this is due to your DNS server (servers from `/etc/resolv.conf`)
|
available", this is due to your DNS server (servers from `/etc/resolv.conf`)
|
||||||
|
@ -64,7 +65,7 @@ very computationally expensive, and is extremely susceptible to denial of
|
||||||
service, especially on Matrix. Many servers also strangely have broken DNSSEC
|
service, especially on Matrix. Many servers also strangely have broken DNSSEC
|
||||||
setups and will result in non-functional federation.
|
setups and will result in non-functional federation.
|
||||||
|
|
||||||
conduwuit cannot provide a "works-for-everyone" Unbound DNS setup guide, but
|
Continuwuity cannot provide a "works-for-everyone" Unbound DNS setup guide, but
|
||||||
the [official Unbound tuning guide][unbound-tuning] and the [Unbound Arch Linux wiki page][unbound-arch]
|
the [official Unbound tuning guide][unbound-tuning] and the [Unbound Arch Linux wiki page][unbound-arch]
|
||||||
may be of interest. Disabling DNSSEC on Unbound is commenting out trust-anchors
|
may be of interest. Disabling DNSSEC on Unbound is commenting out trust-anchors
|
||||||
config options and removing the `validator` module.
|
config options and removing the `validator` module.
|
||||||
|
@ -75,9 +76,9 @@ high load, and we have identified its DNS caching to not be very effective.
|
||||||
dnsmasq can possibly work, but it does **not** support TCP fallback which can be
|
dnsmasq can possibly work, but it does **not** support TCP fallback which can be
|
||||||
problematic when receiving large DNS responses such as from large SRV records.
|
problematic when receiving large DNS responses such as from large SRV records.
|
||||||
If you still want to use dnsmasq, make sure you **disable** `dns_tcp_fallback`
|
If you still want to use dnsmasq, make sure you **disable** `dns_tcp_fallback`
|
||||||
in conduwuit config.
|
in Continuwuity config.
|
||||||
|
|
||||||
Raising `dns_cache_entries` in conduwuit config from the default can also assist
|
Raising `dns_cache_entries` in Continuwuity config from the default can also assist
|
||||||
in DNS caching, but a full-fledged external caching resolver is better and more
|
in DNS caching, but a full-fledged external caching resolver is better and more
|
||||||
reliable.
|
reliable.
|
||||||
|
|
||||||
|
@ -91,13 +92,13 @@ reliability at a slight performance cost due to TCP overhead.
|
||||||
|
|
||||||
## RocksDB / database issues
|
## RocksDB / database issues
|
||||||
|
|
||||||
#### Database corruption
|
### Database corruption
|
||||||
|
|
||||||
If your database is corrupted *and* is failing to start (e.g. checksum
|
If your database is corrupted *and* is failing to start (e.g. checksum
|
||||||
mismatch), it may be recoverable but careful steps must be taken, and there is
|
mismatch), it may be recoverable but careful steps must be taken, and there is
|
||||||
no guarantee it may be recoverable.
|
no guarantee it may be recoverable.
|
||||||
|
|
||||||
The first thing that can be done is launching conduwuit with the
|
The first thing that can be done is launching Continuwuity with the
|
||||||
`rocksdb_repair` config option set to true. This will tell RocksDB to attempt to
|
`rocksdb_repair` config option set to true. This will tell RocksDB to attempt to
|
||||||
repair itself at launch. If this does not work, disable the option and continue
|
repair itself at launch. If this does not work, disable the option and continue
|
||||||
reading.
|
reading.
|
||||||
|
@ -109,7 +110,7 @@ RocksDB has the following recovery modes:
|
||||||
- `PointInTime`
|
- `PointInTime`
|
||||||
- `SkipAnyCorruptedRecord`
|
- `SkipAnyCorruptedRecord`
|
||||||
|
|
||||||
By default, conduwuit uses `TolerateCorruptedTailRecords` as generally these may
|
By default, Continuwuity uses `TolerateCorruptedTailRecords` as generally these may
|
||||||
be due to bad federation and we can re-fetch the correct data over federation.
|
be due to bad federation and we can re-fetch the correct data over federation.
|
||||||
The RocksDB default is `PointInTime` which will attempt to restore a "snapshot"
|
The RocksDB default is `PointInTime` which will attempt to restore a "snapshot"
|
||||||
of the data when it was last known to be good. This data can be either a few
|
of the data when it was last known to be good. This data can be either a few
|
||||||
|
@ -126,12 +127,12 @@ if `PointInTime` does not work as a last ditch effort.
|
||||||
|
|
||||||
With this in mind:
|
With this in mind:
|
||||||
|
|
||||||
- First start conduwuit with the `PointInTime` recovery method. See the [example
|
- First start Continuwuity with the `PointInTime` recovery method. See the [example
|
||||||
config](configuration/examples.md) for how to do this using
|
config](configuration/examples.md) for how to do this using
|
||||||
`rocksdb_recovery_mode`
|
`rocksdb_recovery_mode`
|
||||||
- If your database successfully opens, clients are recommended to clear their
|
- If your database successfully opens, clients are recommended to clear their
|
||||||
client cache to account for the rollback
|
client cache to account for the rollback
|
||||||
- Leave your conduwuit running in `PointInTime` for at least 30-60 minutes so as
|
- Leave your Continuwuity running in `PointInTime` for at least 30-60 minutes so as
|
||||||
much possible corruption is restored
|
much possible corruption is restored
|
||||||
- If all goes will, you should be able to restore back to using
|
- If all goes will, you should be able to restore back to using
|
||||||
`TolerateCorruptedTailRecords` and you have successfully recovered your database
|
`TolerateCorruptedTailRecords` and you have successfully recovered your database
|
||||||
|
@ -142,16 +143,16 @@ Note that users should not really be debugging things. If you find yourself
|
||||||
debugging and find the issue, please let us know and/or how we can fix it.
|
debugging and find the issue, please let us know and/or how we can fix it.
|
||||||
Various debug commands can be found in `!admin debug`.
|
Various debug commands can be found in `!admin debug`.
|
||||||
|
|
||||||
#### Debug/Trace log level
|
### Debug/Trace log level
|
||||||
|
|
||||||
conduwuit builds without debug or trace log levels at compile time by default
|
Continuwuity builds without debug or trace log levels at compile time by default
|
||||||
for substantial performance gains in CPU usage and improved compile times. If
|
for substantial performance gains in CPU usage and improved compile times. If
|
||||||
you need to access debug/trace log levels, you will need to build without the
|
you need to access debug/trace log levels, you will need to build without the
|
||||||
`release_max_log_level` feature or use our provided static debug binaries.
|
`release_max_log_level` feature or use our provided static debug binaries.
|
||||||
|
|
||||||
#### Changing log level dynamically
|
### Changing log level dynamically
|
||||||
|
|
||||||
conduwuit supports changing the tracing log environment filter on-the-fly using
|
Continuwuity supports changing the tracing log environment filter on-the-fly using
|
||||||
the admin command `!admin debug change-log-level <log env filter>`. This accepts
|
the admin command `!admin debug change-log-level <log env filter>`. This accepts
|
||||||
a string **without quotes** the same format as the `log` config option.
|
a string **without quotes** the same format as the `log` config option.
|
||||||
|
|
||||||
|
@ -166,9 +167,9 @@ load, simply pass the `--reset` flag.
|
||||||
|
|
||||||
`!admin debug change-log-level --reset`
|
`!admin debug change-log-level --reset`
|
||||||
|
|
||||||
#### Pinging servers
|
### Pinging servers
|
||||||
|
|
||||||
conduwuit can ping other servers using `!admin debug ping <server>`. This takes
|
Continuwuity can ping other servers using `!admin debug ping <server>`. This takes
|
||||||
a server name and goes through the server discovery process and queries
|
a server name and goes through the server discovery process and queries
|
||||||
`/_matrix/federation/v1/version`. Errors are outputted.
|
`/_matrix/federation/v1/version`. Errors are outputted.
|
||||||
|
|
||||||
|
@ -177,15 +178,15 @@ server performance on either side as that endpoint is completely unauthenticated
|
||||||
and simply fetches a string on a static JSON endpoint. It is very low cost both
|
and simply fetches a string on a static JSON endpoint. It is very low cost both
|
||||||
bandwidth and computationally.
|
bandwidth and computationally.
|
||||||
|
|
||||||
#### Allocator memory stats
|
### Allocator memory stats
|
||||||
|
|
||||||
When using jemalloc with jemallocator's `stats` feature (`--enable-stats`), you
|
When using jemalloc with jemallocator's `stats` feature (`--enable-stats`), you
|
||||||
can see conduwuit's high-level allocator stats by using
|
can see Continuwuity's high-level allocator stats by using
|
||||||
`!admin server memory-usage` at the bottom.
|
`!admin server memory-usage` at the bottom.
|
||||||
|
|
||||||
If you are a developer, you can also view the raw jemalloc statistics with
|
If you are a developer, you can also view the raw jemalloc statistics with
|
||||||
`!admin debug memory-stats`. Please note that this output is extremely large
|
`!admin debug memory-stats`. Please note that this output is extremely large
|
||||||
which may only be visible in the conduwuit console CLI due to PDU size limits,
|
which may only be visible in the Continuwuity console CLI due to PDU size limits,
|
||||||
and is not easy for non-developers to understand.
|
and is not easy for non-developers to understand.
|
||||||
|
|
||||||
[unbound-tuning]: https://unbound.docs.nlnetlabs.nl/en/latest/topics/core/performance.html
|
[unbound-tuning]: https://unbound.docs.nlnetlabs.nl/en/latest/topics/core/performance.html
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Setting up TURN/STURN
|
# Setting up TURN/STURN
|
||||||
|
|
||||||
In order to make or receive calls, a TURN server is required. conduwuit suggests
|
In order to make or receive calls, a TURN server is required. Continuwuity suggests
|
||||||
using [Coturn](https://github.com/coturn/coturn) for this purpose, which is also
|
using [Coturn](https://github.com/coturn/coturn) for this purpose, which is also
|
||||||
available as a Docker image.
|
available as a Docker image.
|
||||||
|
|
||||||
|
@ -17,9 +17,9 @@ realm=<your server domain>
|
||||||
A common way to generate a suitable alphanumeric secret key is by using `pwgen
|
A common way to generate a suitable alphanumeric secret key is by using `pwgen
|
||||||
-s 64 1`.
|
-s 64 1`.
|
||||||
|
|
||||||
These same values need to be set in conduwuit. See the [example
|
These same values need to be set in Continuwuity. See the [example
|
||||||
config](configuration/examples.md) in the TURN section for configuring these and
|
config](configuration/examples.md) in the TURN section for configuring these and
|
||||||
restart conduwuit after.
|
restart Continuwuity after.
|
||||||
|
|
||||||
`turn_secret` or a path to `turn_secret_file` must have a value of your
|
`turn_secret` or a path to `turn_secret_file` must have a value of your
|
||||||
coturn `static-auth-secret`, or use `turn_username` and `turn_password`
|
coturn `static-auth-secret`, or use `turn_username` and `turn_password`
|
||||||
|
@ -34,7 +34,7 @@ If you are using TURN over TLS, you can replace `turn:` with `turns:` in the
|
||||||
TURN over TLS. This is highly recommended.
|
TURN over TLS. This is highly recommended.
|
||||||
|
|
||||||
If you need unauthenticated access to the TURN URIs, or some clients may be
|
If you need unauthenticated access to the TURN URIs, or some clients may be
|
||||||
having trouble, you can enable `turn_guest_access` in conduwuit which disables
|
having trouble, you can enable `turn_guest_access` in Continuwuity which disables
|
||||||
authentication for the TURN URI endpoint `/_matrix/client/v3/voip/turnServer`
|
authentication for the TURN URI endpoint `/_matrix/client/v3/voip/turnServer`
|
||||||
|
|
||||||
### Run
|
### Run
|
||||||
|
|
|
@ -75,9 +75,9 @@ dockerTools.buildImage {
|
||||||
else [];
|
else [];
|
||||||
|
|
||||||
Env = [
|
Env = [
|
||||||
"CONDUWUIT_TLS__KEY=${./private_key.key}"
|
"CONTINUWUITY_TLS__KEY=${./private_key.key}"
|
||||||
"CONDUWUIT_TLS__CERTS=${./certificate.crt}"
|
"CONTINUWUITY_TLS__CERTS=${./certificate.crt}"
|
||||||
"CONDUWUIT_CONFIG=${./config.toml}"
|
"CONTINUWUITY_CONFIG=${./config.toml}"
|
||||||
"RUST_BACKTRACE=full"
|
"RUST_BACKTRACE=full"
|
||||||
];
|
];
|
||||||
|
|
||||||
|
|
|
@ -130,7 +130,8 @@ buildDepsOnlyEnv =
|
||||||
});
|
});
|
||||||
|
|
||||||
buildPackageEnv = {
|
buildPackageEnv = {
|
||||||
CONDUWUIT_VERSION_EXTRA = inputs.self.shortRev or inputs.self.dirtyShortRev or "";
|
GIT_COMMIT_HASH = inputs.self.rev or inputs.self.dirtyRev or "";
|
||||||
|
GIT_COMMIT_HASH_SHORT = inputs.self.shortRev or inputs.self.dirtyShortRev or "";
|
||||||
} // buildDepsOnlyEnv // {
|
} // buildDepsOnlyEnv // {
|
||||||
# Only needed in static stdenv because these are transitive dependencies of rocksdb
|
# Only needed in static stdenv because these are transitive dependencies of rocksdb
|
||||||
CARGO_BUILD_RUSTFLAGS = buildDepsOnlyEnv.CARGO_BUILD_RUSTFLAGS
|
CARGO_BUILD_RUSTFLAGS = buildDepsOnlyEnv.CARGO_BUILD_RUSTFLAGS
|
||||||
|
|
|
@ -33,13 +33,13 @@ dockerTools.buildLayeredImage {
|
||||||
<jason@zemos.net>";
|
<jason@zemos.net>";
|
||||||
"org.opencontainers.image.created" ="@${toString inputs.self.lastModified}";
|
"org.opencontainers.image.created" ="@${toString inputs.self.lastModified}";
|
||||||
"org.opencontainers.image.description" = "a very cool Matrix chat homeserver written in Rust";
|
"org.opencontainers.image.description" = "a very cool Matrix chat homeserver written in Rust";
|
||||||
"org.opencontainers.image.documentation" = "https://conduwuit.puppyirl.gay/";
|
"org.opencontainers.image.documentation" = "https://continuwuity.org/";
|
||||||
"org.opencontainers.image.licenses" = "Apache-2.0";
|
"org.opencontainers.image.licenses" = "Apache-2.0";
|
||||||
"org.opencontainers.image.revision" = inputs.self.rev or inputs.self.dirtyRev or "";
|
"org.opencontainers.image.revision" = inputs.self.rev or inputs.self.dirtyRev or "";
|
||||||
"org.opencontainers.image.source" = "https://github.com/girlbossceo/conduwuit";
|
"org.opencontainers.image.source" = "https://forgejo.ellis.link/continuwuation/continuwuity";
|
||||||
"org.opencontainers.image.title" = main.pname;
|
"org.opencontainers.image.title" = main.pname;
|
||||||
"org.opencontainers.image.url" = "https://conduwuit.puppyirl.gay/";
|
"org.opencontainers.image.url" = "https://continuwuity.org/";
|
||||||
"org.opencontainers.image.vendor" = "girlbossceo";
|
"org.opencontainers.image.vendor" = "continuwuation";
|
||||||
"org.opencontainers.image.version" = main.version;
|
"org.opencontainers.image.version" = main.version;
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
|
@ -9,7 +9,7 @@
|
||||||
# If you're having trouble making the relevant changes, bug a maintainer.
|
# If you're having trouble making the relevant changes, bug a maintainer.
|
||||||
|
|
||||||
[toolchain]
|
[toolchain]
|
||||||
channel = "1.86.0"
|
channel = "1.87.0"
|
||||||
profile = "minimal"
|
profile = "minimal"
|
||||||
components = [
|
components = [
|
||||||
# For rust-analyzer
|
# For rust-analyzer
|
||||||
|
@ -19,11 +19,3 @@ components = [
|
||||||
"rustfmt",
|
"rustfmt",
|
||||||
"clippy",
|
"clippy",
|
||||||
]
|
]
|
||||||
targets = [
|
|
||||||
#"x86_64-apple-darwin",
|
|
||||||
"x86_64-unknown-linux-gnu",
|
|
||||||
"x86_64-unknown-linux-musl",
|
|
||||||
"aarch64-unknown-linux-musl",
|
|
||||||
"aarch64-unknown-linux-gnu",
|
|
||||||
#"aarch64-apple-darwin",
|
|
||||||
]
|
|
||||||
|
|
|
@ -9,7 +9,7 @@ use crate::{
|
||||||
};
|
};
|
||||||
|
|
||||||
#[derive(Debug, Parser)]
|
#[derive(Debug, Parser)]
|
||||||
#[command(name = "conduwuit", version = conduwuit::version())]
|
#[command(name = conduwuit_core::name(), version = conduwuit_core::version())]
|
||||||
pub(super) enum AdminCommand {
|
pub(super) enum AdminCommand {
|
||||||
#[command(subcommand)]
|
#[command(subcommand)]
|
||||||
/// - Commands for managing appservices
|
/// - Commands for managing appservices
|
||||||
|
|
|
@ -239,10 +239,11 @@ pub(super) async fn get_remote_pdu(
|
||||||
})
|
})
|
||||||
.await
|
.await
|
||||||
{
|
{
|
||||||
| Err(e) =>
|
| Err(e) => {
|
||||||
return Err!(
|
return Err!(
|
||||||
"Remote server did not have PDU or failed sending request to remote server: {e}"
|
"Remote server did not have PDU or failed sending request to remote server: {e}"
|
||||||
),
|
);
|
||||||
|
},
|
||||||
| Ok(response) => {
|
| Ok(response) => {
|
||||||
let json: CanonicalJsonObject =
|
let json: CanonicalJsonObject =
|
||||||
serde_json::from_str(response.pdu.get()).map_err(|e| {
|
serde_json::from_str(response.pdu.get()).map_err(|e| {
|
||||||
|
@ -384,8 +385,9 @@ pub(super) async fn change_log_level(&self, filter: Option<String>, reset: bool)
|
||||||
.reload
|
.reload
|
||||||
.reload(&old_filter_layer, Some(handles))
|
.reload(&old_filter_layer, Some(handles))
|
||||||
{
|
{
|
||||||
| Err(e) =>
|
| Err(e) => {
|
||||||
return Err!("Failed to modify and reload the global tracing log level: {e}"),
|
return Err!("Failed to modify and reload the global tracing log level: {e}");
|
||||||
|
},
|
||||||
| Ok(()) => {
|
| Ok(()) => {
|
||||||
let value = &self.services.server.config.log;
|
let value = &self.services.server.config.log;
|
||||||
let out = format!("Successfully changed log level back to config value {value}");
|
let out = format!("Successfully changed log level back to config value {value}");
|
||||||
|
@ -408,8 +410,9 @@ pub(super) async fn change_log_level(&self, filter: Option<String>, reset: bool)
|
||||||
.reload(&new_filter_layer, Some(handles))
|
.reload(&new_filter_layer, Some(handles))
|
||||||
{
|
{
|
||||||
| Ok(()) => return self.write_str("Successfully changed log level").await,
|
| Ok(()) => return self.write_str("Successfully changed log level").await,
|
||||||
| Err(e) =>
|
| Err(e) => {
|
||||||
return Err!("Failed to modify and reload the global tracing log level: {e}"),
|
return Err!("Failed to modify and reload the global tracing log level: {e}");
|
||||||
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -529,6 +532,7 @@ pub(super) async fn force_set_room_state_from_server(
|
||||||
&self,
|
&self,
|
||||||
room_id: OwnedRoomId,
|
room_id: OwnedRoomId,
|
||||||
server_name: OwnedServerName,
|
server_name: OwnedServerName,
|
||||||
|
at_event: Option<OwnedEventId>,
|
||||||
) -> Result {
|
) -> Result {
|
||||||
if !self
|
if !self
|
||||||
.services
|
.services
|
||||||
|
@ -540,13 +544,18 @@ pub(super) async fn force_set_room_state_from_server(
|
||||||
return Err!("We are not participating in the room / we don't know about the room ID.");
|
return Err!("We are not participating in the room / we don't know about the room ID.");
|
||||||
}
|
}
|
||||||
|
|
||||||
let first_pdu = self
|
let at_event_id = match at_event {
|
||||||
|
| Some(event_id) => event_id,
|
||||||
|
| None => self
|
||||||
.services
|
.services
|
||||||
.rooms
|
.rooms
|
||||||
.timeline
|
.timeline
|
||||||
.latest_pdu_in_room(&room_id)
|
.latest_pdu_in_room(&room_id)
|
||||||
.await
|
.await
|
||||||
.map_err(|_| err!(Database("Failed to find the latest PDU in database")))?;
|
.map_err(|_| err!(Database("Failed to find the latest PDU in database")))?
|
||||||
|
.event_id
|
||||||
|
.clone(),
|
||||||
|
};
|
||||||
|
|
||||||
let room_version = self.services.rooms.state.get_room_version(&room_id).await?;
|
let room_version = self.services.rooms.state.get_room_version(&room_id).await?;
|
||||||
|
|
||||||
|
@ -557,7 +566,7 @@ pub(super) async fn force_set_room_state_from_server(
|
||||||
.sending
|
.sending
|
||||||
.send_federation_request(&server_name, get_room_state::v1::Request {
|
.send_federation_request(&server_name, get_room_state::v1::Request {
|
||||||
room_id: room_id.clone(),
|
room_id: room_id.clone(),
|
||||||
event_id: first_pdu.event_id.clone(),
|
event_id: at_event_id,
|
||||||
})
|
})
|
||||||
.await?;
|
.await?;
|
||||||
|
|
||||||
|
|
|
@ -125,13 +125,13 @@ pub(super) enum DebugCommand {
|
||||||
reset: bool,
|
reset: bool,
|
||||||
},
|
},
|
||||||
|
|
||||||
/// - Verify json signatures
|
/// - Sign JSON blob
|
||||||
///
|
///
|
||||||
/// This command needs a JSON blob provided in a Markdown code block below
|
/// This command needs a JSON blob provided in a Markdown code block below
|
||||||
/// the command.
|
/// the command.
|
||||||
SignJson,
|
SignJson,
|
||||||
|
|
||||||
/// - Verify json signatures
|
/// - Verify JSON signatures
|
||||||
///
|
///
|
||||||
/// This command needs a JSON blob provided in a Markdown code block below
|
/// This command needs a JSON blob provided in a Markdown code block below
|
||||||
/// the command.
|
/// the command.
|
||||||
|
@ -177,6 +177,9 @@ pub(super) enum DebugCommand {
|
||||||
room_id: OwnedRoomId,
|
room_id: OwnedRoomId,
|
||||||
/// The server we will use to query the room state for
|
/// The server we will use to query the room state for
|
||||||
server_name: OwnedServerName,
|
server_name: OwnedServerName,
|
||||||
|
/// The event ID of the latest known PDU in the room. Will be found
|
||||||
|
/// automatically if not provided.
|
||||||
|
event_id: Option<OwnedEventId>,
|
||||||
},
|
},
|
||||||
|
|
||||||
/// - Runs a server name through conduwuit's true destination resolution
|
/// - Runs a server name through conduwuit's true destination resolution
|
||||||
|
|
|
@ -94,7 +94,7 @@ async fn process_command(services: Arc<Services>, input: &CommandInput) -> Proce
|
||||||
#[allow(clippy::result_large_err)]
|
#[allow(clippy::result_large_err)]
|
||||||
fn handle_panic(error: &Error, command: &CommandInput) -> ProcessorResult {
|
fn handle_panic(error: &Error, command: &CommandInput) -> ProcessorResult {
|
||||||
let link =
|
let link =
|
||||||
"Please submit a [bug report](https://github.com/girlbossceo/conduwuit/issues/new). 🥺";
|
"Please submit a [bug report](https://forgejo.ellis.link/continuwuation/continuwuity/issues/new). 🥺";
|
||||||
let msg = format!("Panic occurred while processing command:\n```\n{error:#?}\n```\n{link}");
|
let msg = format!("Panic occurred while processing command:\n```\n{error:#?}\n```\n{link}");
|
||||||
let content = RoomMessageEventContent::notice_markdown(msg);
|
let content = RoomMessageEventContent::notice_markdown(msg);
|
||||||
error!("Panic while processing command: {error:?}");
|
error!("Panic while processing command: {error:?}");
|
||||||
|
|
|
@ -36,7 +36,7 @@ pub(super) enum ServerCommand {
|
||||||
/// - Print database memory usage statistics
|
/// - Print database memory usage statistics
|
||||||
MemoryUsage,
|
MemoryUsage,
|
||||||
|
|
||||||
/// - Clears all of Conduwuit's caches
|
/// - Clears all of Continuwuity's caches
|
||||||
ClearCaches,
|
ClearCaches,
|
||||||
|
|
||||||
/// - Performs an online backup of the database (only available for RocksDB
|
/// - Performs an online backup of the database (only available for RocksDB
|
||||||
|
|
|
@ -15,7 +15,7 @@ use crate::Ruma;
|
||||||
|
|
||||||
/// # `GET /_matrix/client/v3/capabilities`
|
/// # `GET /_matrix/client/v3/capabilities`
|
||||||
///
|
///
|
||||||
/// Get information on the supported feature set and other relevent capabilities
|
/// Get information on the supported feature set and other relevant capabilities
|
||||||
/// of this server.
|
/// of this server.
|
||||||
pub(crate) async fn get_capabilities_route(
|
pub(crate) async fn get_capabilities_route(
|
||||||
State(services): State<crate::State>,
|
State(services): State<crate::State>,
|
||||||
|
|
|
@ -1855,7 +1855,10 @@ pub async fn leave_room(
|
||||||
|
|
||||||
// Ask a remote server if we don't have this room and are not knocking on it
|
// Ask a remote server if we don't have this room and are not knocking on it
|
||||||
if dont_have_room.and(not_knocked).await {
|
if dont_have_room.and(not_knocked).await {
|
||||||
if let Err(e) = remote_leave_room(services, user_id, room_id).boxed().await {
|
if let Err(e) = remote_leave_room(services, user_id, room_id, reason.clone())
|
||||||
|
.boxed()
|
||||||
|
.await
|
||||||
|
{
|
||||||
warn!(%user_id, "Failed to leave room {room_id} remotely: {e}");
|
warn!(%user_id, "Failed to leave room {room_id} remotely: {e}");
|
||||||
// Don't tell the client about this error
|
// Don't tell the client about this error
|
||||||
}
|
}
|
||||||
|
@ -1940,6 +1943,7 @@ async fn remote_leave_room(
|
||||||
services: &Services,
|
services: &Services,
|
||||||
user_id: &UserId,
|
user_id: &UserId,
|
||||||
room_id: &RoomId,
|
room_id: &RoomId,
|
||||||
|
reason: Option<String>,
|
||||||
) -> Result<()> {
|
) -> Result<()> {
|
||||||
let mut make_leave_response_and_server =
|
let mut make_leave_response_and_server =
|
||||||
Err!(BadServerResponse("No remote server available to assist in leaving {room_id}."));
|
Err!(BadServerResponse("No remote server available to assist in leaving {room_id}."));
|
||||||
|
@ -2056,6 +2060,12 @@ async fn remote_leave_room(
|
||||||
.expect("Timestamp is valid js_int value"),
|
.expect("Timestamp is valid js_int value"),
|
||||||
),
|
),
|
||||||
);
|
);
|
||||||
|
// Inject the reason key into the event content dict if it exists
|
||||||
|
if let Some(reason) = reason {
|
||||||
|
if let Some(CanonicalJsonValue::Object(content)) = leave_event_stub.get_mut("content") {
|
||||||
|
content.insert("reason".to_owned(), CanonicalJsonValue::String(reason));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// room v3 and above removed the "event_id" field from remote PDU format
|
// room v3 and above removed the "event_id" field from remote PDU format
|
||||||
match room_version_id {
|
match room_version_id {
|
||||||
|
@ -2152,6 +2162,109 @@ async fn knock_room_by_id_helper(
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// For knock_restricted rooms, check if the user meets the restricted conditions
|
||||||
|
// If they do, attempt to join instead of knock
|
||||||
|
// This is not mentioned in the spec, but should be allowable (we're allowed to
|
||||||
|
// auto-join invites to knocked rooms)
|
||||||
|
let join_rule = services.rooms.state_accessor.get_join_rules(room_id).await;
|
||||||
|
if let JoinRule::KnockRestricted(restricted) = &join_rule {
|
||||||
|
let restriction_rooms: Vec<_> = restricted
|
||||||
|
.allow
|
||||||
|
.iter()
|
||||||
|
.filter_map(|a| match a {
|
||||||
|
| AllowRule::RoomMembership(r) => Some(&r.room_id),
|
||||||
|
| _ => None,
|
||||||
|
})
|
||||||
|
.collect();
|
||||||
|
|
||||||
|
// Check if the user is in any of the allowed rooms
|
||||||
|
let mut user_meets_restrictions = false;
|
||||||
|
for restriction_room_id in &restriction_rooms {
|
||||||
|
if services
|
||||||
|
.rooms
|
||||||
|
.state_cache
|
||||||
|
.is_joined(sender_user, restriction_room_id)
|
||||||
|
.await
|
||||||
|
{
|
||||||
|
user_meets_restrictions = true;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// If the user meets the restrictions, try joining instead
|
||||||
|
if user_meets_restrictions {
|
||||||
|
debug_info!(
|
||||||
|
"{sender_user} meets the restricted criteria in knock_restricted room \
|
||||||
|
{room_id}, attempting to join instead of knock"
|
||||||
|
);
|
||||||
|
// For this case, we need to drop the state lock and get a new one in
|
||||||
|
// join_room_by_id_helper We need to release the lock here and let
|
||||||
|
// join_room_by_id_helper acquire it again
|
||||||
|
drop(state_lock);
|
||||||
|
match join_room_by_id_helper(
|
||||||
|
services,
|
||||||
|
sender_user,
|
||||||
|
room_id,
|
||||||
|
reason.clone(),
|
||||||
|
servers,
|
||||||
|
None,
|
||||||
|
&None,
|
||||||
|
)
|
||||||
|
.await
|
||||||
|
{
|
||||||
|
| Ok(_) => return Ok(knock_room::v3::Response::new(room_id.to_owned())),
|
||||||
|
| Err(e) => {
|
||||||
|
debug_warn!(
|
||||||
|
"Failed to convert knock to join for {sender_user} in {room_id}: {e:?}"
|
||||||
|
);
|
||||||
|
// Get a new state lock for the remaining knock logic
|
||||||
|
let new_state_lock = services.rooms.state.mutex.lock(room_id).await;
|
||||||
|
|
||||||
|
let server_in_room = services
|
||||||
|
.rooms
|
||||||
|
.state_cache
|
||||||
|
.server_in_room(services.globals.server_name(), room_id)
|
||||||
|
.await;
|
||||||
|
|
||||||
|
let local_knock = server_in_room
|
||||||
|
|| servers.is_empty()
|
||||||
|
|| (servers.len() == 1 && services.globals.server_is_ours(&servers[0]));
|
||||||
|
|
||||||
|
if local_knock {
|
||||||
|
knock_room_helper_local(
|
||||||
|
services,
|
||||||
|
sender_user,
|
||||||
|
room_id,
|
||||||
|
reason,
|
||||||
|
servers,
|
||||||
|
new_state_lock,
|
||||||
|
)
|
||||||
|
.boxed()
|
||||||
|
.await?;
|
||||||
|
} else {
|
||||||
|
knock_room_helper_remote(
|
||||||
|
services,
|
||||||
|
sender_user,
|
||||||
|
room_id,
|
||||||
|
reason,
|
||||||
|
servers,
|
||||||
|
new_state_lock,
|
||||||
|
)
|
||||||
|
.boxed()
|
||||||
|
.await?;
|
||||||
|
}
|
||||||
|
|
||||||
|
return Ok(knock_room::v3::Response::new(room_id.to_owned()));
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else if !matches!(join_rule, JoinRule::Knock | JoinRule::KnockRestricted(_)) {
|
||||||
|
debug_warn!(
|
||||||
|
"{sender_user} attempted to knock on room {room_id} but its join rule is \
|
||||||
|
{join_rule:?}, not knock or knock_restricted"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
let server_in_room = services
|
let server_in_room = services
|
||||||
.rooms
|
.rooms
|
||||||
.state_cache
|
.state_cache
|
||||||
|
@ -2199,6 +2312,12 @@ async fn knock_room_helper_local(
|
||||||
return Err!(Request(Forbidden("This room does not support knocking.")));
|
return Err!(Request(Forbidden("This room does not support knocking.")));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Verify that this room has a valid knock or knock_restricted join rule
|
||||||
|
let join_rule = services.rooms.state_accessor.get_join_rules(room_id).await;
|
||||||
|
if !matches!(join_rule, JoinRule::Knock | JoinRule::KnockRestricted(_)) {
|
||||||
|
return Err!(Request(Forbidden("This room's join rule does not allow knocking.")));
|
||||||
|
}
|
||||||
|
|
||||||
let content = RoomMemberEventContent {
|
let content = RoomMemberEventContent {
|
||||||
displayname: services.users.displayname(sender_user).await.ok(),
|
displayname: services.users.displayname(sender_user).await.ok(),
|
||||||
avatar_url: services.users.avatar_url(sender_user).await.ok(),
|
avatar_url: services.users.avatar_url(sender_user).await.ok(),
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
use core::panic;
|
||||||
|
|
||||||
use axum::extract::State;
|
use axum::extract::State;
|
||||||
use conduwuit::{
|
use conduwuit::{
|
||||||
Err, Result, at,
|
Err, Result, at,
|
||||||
|
@ -132,8 +134,6 @@ pub(crate) async fn get_message_events_route(
|
||||||
.take(limit)
|
.take(limit)
|
||||||
.collect()
|
.collect()
|
||||||
.await;
|
.await;
|
||||||
// let appservice_id = body.appservice_info.map(|appservice|
|
|
||||||
// appservice.registration.id);
|
|
||||||
|
|
||||||
let lazy_loading_context = lazy_loading::Context {
|
let lazy_loading_context = lazy_loading::Context {
|
||||||
user_id: sender_user,
|
user_id: sender_user,
|
||||||
|
@ -143,7 +143,10 @@ pub(crate) async fn get_message_events_route(
|
||||||
if let Some(registration) = body.appservice_info.as_ref() {
|
if let Some(registration) = body.appservice_info.as_ref() {
|
||||||
<&DeviceId>::from(registration.registration.id.as_str())
|
<&DeviceId>::from(registration.registration.id.as_str())
|
||||||
} else {
|
} else {
|
||||||
<&DeviceId>::from("")
|
panic!(
|
||||||
|
"No device_id provided and no appservice registration found, this \
|
||||||
|
should be unreachable"
|
||||||
|
);
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
room_id,
|
room_id,
|
||||||
|
@ -275,10 +278,12 @@ pub(crate) async fn is_ignored_pdu(
|
||||||
|
|
||||||
let ignored_server = services
|
let ignored_server = services
|
||||||
.moderation
|
.moderation
|
||||||
.is_remote_server_forbidden(pdu.sender().server_name());
|
.is_remote_server_ignored(pdu.sender().server_name());
|
||||||
|
|
||||||
if ignored_type
|
if ignored_type
|
||||||
&& (ignored_server || services.users.user_is_ignored(&pdu.sender, user_id).await)
|
&& (ignored_server
|
||||||
|
|| (!services.config.send_messages_from_ignored_users_to_client
|
||||||
|
&& services.users.user_is_ignored(&pdu.sender, user_id).await))
|
||||||
{
|
{
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
|
@ -617,21 +617,28 @@ fn custom_room_id_check(services: &Services, custom_room_id: &str) -> Result<Own
|
||||||
} else if custom_room_id.starts_with('!') {
|
} else if custom_room_id.starts_with('!') {
|
||||||
return Err(Error::BadRequest(
|
return Err(Error::BadRequest(
|
||||||
ErrorKind::InvalidParam,
|
ErrorKind::InvalidParam,
|
||||||
"Room ID is prefixed with !, but is not fully qualified. You likely did not want this."));
|
"Room ID is prefixed with !, but is not fully qualified. You likely did not want \
|
||||||
|
this.",
|
||||||
|
));
|
||||||
} else {
|
} else {
|
||||||
room_id = format!("!{custom_room_id}:{server_name}");
|
room_id = format!("!{custom_room_id}:{server_name}");
|
||||||
}
|
}
|
||||||
OwnedRoomId::parse(room_id)
|
OwnedRoomId::parse(room_id)
|
||||||
.map_err(Into::into)
|
.map_err(Into::into)
|
||||||
.and_then(
|
.and_then(|full_room_id| {
|
||||||
|full_room_id| {
|
if full_room_id
|
||||||
if full_room_id.server_name().expect("failed to extract server name from room ID") != server_name {
|
.server_name()
|
||||||
Err(Error::BadRequest(ErrorKind::InvalidParam, "Custom room ID must be on this server."))
|
.expect("failed to extract server name from room ID")
|
||||||
|
!= server_name
|
||||||
|
{
|
||||||
|
Err(Error::BadRequest(
|
||||||
|
ErrorKind::InvalidParam,
|
||||||
|
"Custom room ID must be on this server.",
|
||||||
|
))
|
||||||
} else {
|
} else {
|
||||||
Ok(full_room_id)
|
Ok(full_room_id)
|
||||||
}
|
}
|
||||||
}
|
})
|
||||||
)
|
|
||||||
.inspect(|full_room_id| {
|
.inspect(|full_room_id| {
|
||||||
debug_info!(?full_room_id, "Full custom room ID");
|
debug_info!(?full_room_id, "Full custom room ID");
|
||||||
})
|
})
|
||||||
|
|
|
@ -121,7 +121,9 @@ where
|
||||||
.map(|(key, val)| (key, val.collect()))
|
.map(|(key, val)| (key, val.collect()))
|
||||||
.collect();
|
.collect();
|
||||||
|
|
||||||
if !populate {
|
if populate {
|
||||||
|
rooms.push(summary_to_chunk(summary.clone()));
|
||||||
|
} else {
|
||||||
children = children
|
children = children
|
||||||
.iter()
|
.iter()
|
||||||
.rev()
|
.rev()
|
||||||
|
@ -144,10 +146,8 @@ where
|
||||||
.collect();
|
.collect();
|
||||||
}
|
}
|
||||||
|
|
||||||
if populate {
|
if !populate && queue.is_empty() && children.is_empty() {
|
||||||
rooms.push(summary_to_chunk(summary.clone()));
|
break;
|
||||||
} else if queue.is_empty() && children.is_empty() {
|
|
||||||
return Err!(Request(InvalidParam("Room IDs in token were not found.")));
|
|
||||||
}
|
}
|
||||||
|
|
||||||
parents.insert(current_room.clone());
|
parents.insert(current_room.clone());
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
use axum::{Json, extract::State, response::IntoResponse};
|
use axum::{Json, extract::State, response::IntoResponse};
|
||||||
use conduwuit::{Error, Result};
|
use conduwuit::{Error, Result};
|
||||||
|
use futures::StreamExt;
|
||||||
use ruma::api::client::{
|
use ruma::api::client::{
|
||||||
discovery::{
|
discovery::{
|
||||||
discover_homeserver::{self, HomeserverInfo, SlidingSyncProxyInfo},
|
discover_homeserver::{self, HomeserverInfo, SlidingSyncProxyInfo},
|
||||||
|
@ -17,7 +18,7 @@ pub(crate) async fn well_known_client(
|
||||||
State(services): State<crate::State>,
|
State(services): State<crate::State>,
|
||||||
_body: Ruma<discover_homeserver::Request>,
|
_body: Ruma<discover_homeserver::Request>,
|
||||||
) -> Result<discover_homeserver::Response> {
|
) -> Result<discover_homeserver::Response> {
|
||||||
let client_url = match services.server.config.well_known.client.as_ref() {
|
let client_url = match services.config.well_known.client.as_ref() {
|
||||||
| Some(url) => url.to_string(),
|
| Some(url) => url.to_string(),
|
||||||
| None => return Err(Error::BadRequest(ErrorKind::NotFound, "Not found.")),
|
| None => return Err(Error::BadRequest(ErrorKind::NotFound, "Not found.")),
|
||||||
};
|
};
|
||||||
|
@ -33,44 +34,63 @@ pub(crate) async fn well_known_client(
|
||||||
/// # `GET /.well-known/matrix/support`
|
/// # `GET /.well-known/matrix/support`
|
||||||
///
|
///
|
||||||
/// Server support contact and support page of a homeserver's domain.
|
/// Server support contact and support page of a homeserver's domain.
|
||||||
|
/// Implements MSC1929 for server discovery.
|
||||||
|
/// If no configuration is set, uses admin users as contacts.
|
||||||
pub(crate) async fn well_known_support(
|
pub(crate) async fn well_known_support(
|
||||||
State(services): State<crate::State>,
|
State(services): State<crate::State>,
|
||||||
_body: Ruma<discover_support::Request>,
|
_body: Ruma<discover_support::Request>,
|
||||||
) -> Result<discover_support::Response> {
|
) -> Result<discover_support::Response> {
|
||||||
let support_page = services
|
let support_page = services
|
||||||
.server
|
|
||||||
.config
|
.config
|
||||||
.well_known
|
.well_known
|
||||||
.support_page
|
.support_page
|
||||||
.as_ref()
|
.as_ref()
|
||||||
.map(ToString::to_string);
|
.map(ToString::to_string);
|
||||||
|
|
||||||
let role = services.server.config.well_known.support_role.clone();
|
let email_address = services.config.well_known.support_email.clone();
|
||||||
|
let matrix_id = services.config.well_known.support_mxid.clone();
|
||||||
|
|
||||||
// support page or role must be either defined for this to be valid
|
// TODO: support defining multiple contacts in the config
|
||||||
if support_page.is_none() && role.is_none() {
|
|
||||||
return Err(Error::BadRequest(ErrorKind::NotFound, "Not found."));
|
|
||||||
}
|
|
||||||
|
|
||||||
let email_address = services.server.config.well_known.support_email.clone();
|
|
||||||
let matrix_id = services.server.config.well_known.support_mxid.clone();
|
|
||||||
|
|
||||||
// if a role is specified, an email address or matrix id is required
|
|
||||||
if role.is_some() && (email_address.is_none() && matrix_id.is_none()) {
|
|
||||||
return Err(Error::BadRequest(ErrorKind::NotFound, "Not found."));
|
|
||||||
}
|
|
||||||
|
|
||||||
// TOOD: support defining multiple contacts in the config
|
|
||||||
let mut contacts: Vec<Contact> = vec![];
|
let mut contacts: Vec<Contact> = vec![];
|
||||||
|
|
||||||
if let Some(role) = role {
|
let role_value = services
|
||||||
let contact = Contact { role, email_address, matrix_id };
|
.config
|
||||||
|
.well_known
|
||||||
|
.support_role
|
||||||
|
.clone()
|
||||||
|
.unwrap_or_else(|| "m.role.admin".to_owned().into());
|
||||||
|
|
||||||
contacts.push(contact);
|
// Add configured contact if at least one contact method is specified
|
||||||
|
if email_address.is_some() || matrix_id.is_some() {
|
||||||
|
contacts.push(Contact {
|
||||||
|
role: role_value.clone(),
|
||||||
|
email_address: email_address.clone(),
|
||||||
|
matrix_id: matrix_id.clone(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Try to add admin users as contacts if no contacts are configured
|
||||||
|
if contacts.is_empty() {
|
||||||
|
if let Ok(admin_room) = services.admin.get_admin_room().await {
|
||||||
|
let admin_users = services.rooms.state_cache.room_members(&admin_room);
|
||||||
|
let mut stream = admin_users;
|
||||||
|
|
||||||
|
while let Some(user_id) = stream.next().await {
|
||||||
|
// Skip server user
|
||||||
|
if *user_id == services.globals.server_user {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
contacts.push(Contact {
|
||||||
|
role: role_value.clone(),
|
||||||
|
email_address: None,
|
||||||
|
matrix_id: Some(user_id.to_owned()),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// support page or role+contacts must be either defined for this to be valid
|
|
||||||
if contacts.is_empty() && support_page.is_none() {
|
if contacts.is_empty() && support_page.is_none() {
|
||||||
|
// No admin room, no configured contacts, and no support page
|
||||||
return Err(Error::BadRequest(ErrorKind::NotFound, "Not found."));
|
return Err(Error::BadRequest(ErrorKind::NotFound, "Not found."));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -84,9 +104,9 @@ pub(crate) async fn well_known_support(
|
||||||
pub(crate) async fn syncv3_client_server_json(
|
pub(crate) async fn syncv3_client_server_json(
|
||||||
State(services): State<crate::State>,
|
State(services): State<crate::State>,
|
||||||
) -> Result<impl IntoResponse> {
|
) -> Result<impl IntoResponse> {
|
||||||
let server_url = match services.server.config.well_known.client.as_ref() {
|
let server_url = match services.config.well_known.client.as_ref() {
|
||||||
| Some(url) => url.to_string(),
|
| Some(url) => url.to_string(),
|
||||||
| None => match services.server.config.well_known.server.as_ref() {
|
| None => match services.config.well_known.server.as_ref() {
|
||||||
| Some(url) => url.to_string(),
|
| Some(url) => url.to_string(),
|
||||||
| None => return Err(Error::BadRequest(ErrorKind::NotFound, "Not found.")),
|
| None => return Err(Error::BadRequest(ErrorKind::NotFound, "Not found.")),
|
||||||
},
|
},
|
||||||
|
|
|
@ -3,7 +3,6 @@ mod auth;
|
||||||
mod handler;
|
mod handler;
|
||||||
mod request;
|
mod request;
|
||||||
mod response;
|
mod response;
|
||||||
pub mod state;
|
|
||||||
|
|
||||||
use std::str::FromStr;
|
use std::str::FromStr;
|
||||||
|
|
||||||
|
@ -13,10 +12,11 @@ use axum::{
|
||||||
routing::{any, get, post},
|
routing::{any, get, post},
|
||||||
};
|
};
|
||||||
use conduwuit::{Server, err};
|
use conduwuit::{Server, err};
|
||||||
|
pub(super) use conduwuit_service::state::State;
|
||||||
use http::{Uri, uri};
|
use http::{Uri, uri};
|
||||||
|
|
||||||
use self::handler::RouterExt;
|
use self::handler::RouterExt;
|
||||||
pub(super) use self::{args::Args as Ruma, response::RumaResponse, state::State};
|
pub(super) use self::{args::Args as Ruma, response::RumaResponse};
|
||||||
use crate::{client, server};
|
use crate::{client, server};
|
||||||
|
|
||||||
pub fn build(router: Router<State>, server: &Server) -> Router<State> {
|
pub fn build(router: Router<State>, server: &Server) -> Router<State> {
|
||||||
|
|
34
src/build_metadata/Cargo.toml
Normal file
34
src/build_metadata/Cargo.toml
Normal file
|
@ -0,0 +1,34 @@
|
||||||
|
[package]
|
||||||
|
name = "conduwuit_build_metadata"
|
||||||
|
categories.workspace = true
|
||||||
|
description.workspace = true
|
||||||
|
edition.workspace = true
|
||||||
|
keywords.workspace = true
|
||||||
|
license.workspace = true
|
||||||
|
readme.workspace = true
|
||||||
|
repository.workspace = true
|
||||||
|
version.workspace = true
|
||||||
|
|
||||||
|
|
||||||
|
build = "build.rs"
|
||||||
|
# [[bin]]
|
||||||
|
# path = "main.rs"
|
||||||
|
# name = "conduwuit_build_metadata"
|
||||||
|
|
||||||
|
[lib]
|
||||||
|
path = "mod.rs"
|
||||||
|
crate-type = [
|
||||||
|
"rlib",
|
||||||
|
# "dylib",
|
||||||
|
]
|
||||||
|
|
||||||
|
[features]
|
||||||
|
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
|
||||||
|
[build-dependencies]
|
||||||
|
built = { version = "0.8", features = [] }
|
||||||
|
|
||||||
|
[lints]
|
||||||
|
workspace = true
|
93
src/build_metadata/build.rs
Normal file
93
src/build_metadata/build.rs
Normal file
|
@ -0,0 +1,93 @@
|
||||||
|
use std::process::Command;
|
||||||
|
|
||||||
|
fn run_git_command(args: &[&str]) -> Option<String> {
|
||||||
|
Command::new("git")
|
||||||
|
.args(args)
|
||||||
|
.output()
|
||||||
|
.ok()
|
||||||
|
.filter(|output| output.status.success())
|
||||||
|
.and_then(|output| String::from_utf8(output.stdout).ok())
|
||||||
|
.map(|s| s.trim().to_owned())
|
||||||
|
.filter(|s| !s.is_empty())
|
||||||
|
}
|
||||||
|
fn get_env(env_var: &str) -> Option<String> {
|
||||||
|
match std::env::var(env_var) {
|
||||||
|
| Ok(val) if !val.is_empty() => Some(val),
|
||||||
|
| _ => None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
fn main() {
|
||||||
|
// built gets the default crate from the workspace. Not sure if this is intended
|
||||||
|
// behavior, but it's what we want.
|
||||||
|
built::write_built_file().expect("Failed to acquire build-time information");
|
||||||
|
|
||||||
|
// --- Git Information ---
|
||||||
|
let mut commit_hash = None;
|
||||||
|
let mut commit_hash_short = None;
|
||||||
|
let mut remote_url_web = None;
|
||||||
|
|
||||||
|
// Get full commit hash
|
||||||
|
if let Some(hash) =
|
||||||
|
get_env("GIT_COMMIT_HASH").or_else(|| run_git_command(&["rev-parse", "HEAD"]))
|
||||||
|
{
|
||||||
|
println!("cargo:rustc-env=GIT_COMMIT_HASH={hash}");
|
||||||
|
commit_hash = Some(hash);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get short commit hash
|
||||||
|
if let Some(short_hash) = get_env("GIT_COMMIT_HASH_SHORT")
|
||||||
|
.or_else(|| run_git_command(&["rev-parse", "--short", "HEAD"]))
|
||||||
|
{
|
||||||
|
println!("cargo:rustc-env=GIT_COMMIT_HASH_SHORT={short_hash}");
|
||||||
|
commit_hash_short = Some(short_hash);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get remote URL and convert to web URL
|
||||||
|
if let Some(remote_url_raw) = get_env("GIT_REMOTE_URL")
|
||||||
|
.or_else(|| run_git_command(&["config", "--get", "remote.origin.url"]))
|
||||||
|
{
|
||||||
|
println!("cargo:rustc-env=GIT_REMOTE_URL={remote_url_raw}");
|
||||||
|
let web_url = if remote_url_raw.starts_with("https://") {
|
||||||
|
remote_url_raw.trim_end_matches(".git").to_owned()
|
||||||
|
} else if remote_url_raw.starts_with("git@") {
|
||||||
|
remote_url_raw
|
||||||
|
.trim_end_matches(".git")
|
||||||
|
.replacen(':', "/", 1)
|
||||||
|
.replacen("git@", "https://", 1)
|
||||||
|
} else if remote_url_raw.starts_with("ssh://") {
|
||||||
|
remote_url_raw
|
||||||
|
.trim_end_matches(".git")
|
||||||
|
.replacen("git@", "", 1)
|
||||||
|
.replacen("ssh:", "https:", 1)
|
||||||
|
} else {
|
||||||
|
// Assume it's already a web URL or unknown format
|
||||||
|
remote_url_raw
|
||||||
|
};
|
||||||
|
println!("cargo:rustc-env=GIT_REMOTE_WEB_URL={web_url}");
|
||||||
|
remote_url_web = Some(web_url);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Construct remote commit URL
|
||||||
|
if let Some(remote_commit_url) = get_env("GIT_REMOTE_COMMIT_URL") {
|
||||||
|
println!("cargo:rustc-env=GIT_REMOTE_COMMIT_URL={remote_commit_url}");
|
||||||
|
} else if let (Some(base_url), Some(hash)) =
|
||||||
|
(&remote_url_web, commit_hash.as_ref().or(commit_hash_short.as_ref()))
|
||||||
|
{
|
||||||
|
let commit_page = format!("{base_url}/commit/{hash}");
|
||||||
|
println!("cargo:rustc-env=GIT_REMOTE_COMMIT_URL={commit_page}");
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- Rerun Triggers ---
|
||||||
|
// TODO: The git rerun triggers seem to always run
|
||||||
|
// // Rerun if the git HEAD changes
|
||||||
|
// println!("cargo:rerun-if-changed=.git/HEAD");
|
||||||
|
// // Rerun if the ref pointed to by HEAD changes (e.g., new commit on branch)
|
||||||
|
// if let Some(ref_path) = run_git_command(&["symbolic-ref", "--quiet", "HEAD"])
|
||||||
|
// { println!("cargo:rerun-if-changed=.git/{ref_path}");
|
||||||
|
// }
|
||||||
|
|
||||||
|
println!("cargo:rerun-if-env-changed=GIT_COMMIT_HASH");
|
||||||
|
println!("cargo:rerun-if-env-changed=GIT_COMMIT_HASH_SHORT");
|
||||||
|
println!("cargo:rerun-if-env-changed=GIT_REMOTE_URL");
|
||||||
|
println!("cargo:rerun-if-env-changed=GIT_REMOTE_COMMIT_URL");
|
||||||
|
}
|
29
src/build_metadata/mod.rs
Normal file
29
src/build_metadata/mod.rs
Normal file
|
@ -0,0 +1,29 @@
|
||||||
|
pub mod built {
|
||||||
|
include!(concat!(env!("OUT_DIR"), "/built.rs"));
|
||||||
|
}
|
||||||
|
|
||||||
|
pub static GIT_COMMIT_HASH: Option<&str> = option_env!("GIT_COMMIT_HASH");
|
||||||
|
|
||||||
|
pub static GIT_COMMIT_HASH_SHORT: Option<&str> = option_env!("GIT_COMMIT_HASH_SHORT");
|
||||||
|
|
||||||
|
// this would be a lot better if Option::or was const.
|
||||||
|
pub static VERSION_EXTRA: Option<&str> =
|
||||||
|
if let v @ Some(_) = option_env!("CONTINUWUITY_VERSION_EXTRA") {
|
||||||
|
v
|
||||||
|
} else if let v @ Some(_) = option_env!("CONDUWUIT_VERSION_EXTRA") {
|
||||||
|
v
|
||||||
|
} else {
|
||||||
|
option_env!("CONDUIT_VERSION_EXTRA")
|
||||||
|
};
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn version_tag() -> Option<&'static str> {
|
||||||
|
VERSION_EXTRA
|
||||||
|
.filter(|s| !s.is_empty())
|
||||||
|
.or(GIT_COMMIT_HASH_SHORT)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub static GIT_REMOTE_WEB_URL: Option<&str> = option_env!("GIT_REMOTE_WEB_URL");
|
||||||
|
pub static GIT_REMOTE_COMMIT_URL: Option<&str> = option_env!("GIT_REMOTE_COMMIT_URL");
|
||||||
|
|
||||||
|
// TODO: Mark dirty builds within the version string
|
|
@ -67,6 +67,7 @@ checked_ops.workspace = true
|
||||||
chrono.workspace = true
|
chrono.workspace = true
|
||||||
clap.workspace = true
|
clap.workspace = true
|
||||||
conduwuit-macros.workspace = true
|
conduwuit-macros.workspace = true
|
||||||
|
conduwuit-build-metadata.workspace = true
|
||||||
const-str.workspace = true
|
const-str.workspace = true
|
||||||
core_affinity.workspace = true
|
core_affinity.workspace = true
|
||||||
ctor.workspace = true
|
ctor.workspace = true
|
||||||
|
|
|
@ -274,6 +274,10 @@ pub fn set_dirty_decay<I: Into<Option<usize>>>(arena: I, decay_ms: isize) -> Res
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn background_thread_enable(enable: bool) -> Result<bool> {
|
||||||
|
set::<u8>(&mallctl!("background_thread"), enable.into()).map(is_nonzero!())
|
||||||
|
}
|
||||||
|
|
||||||
#[inline]
|
#[inline]
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn is_affine_arena() -> bool { is_percpu_arena() || is_phycpu_arena() }
|
pub fn is_affine_arena() -> bool { is_percpu_arena() || is_phycpu_arena() }
|
||||||
|
|
|
@ -118,7 +118,7 @@ pub fn check(config: &Config) -> Result {
|
||||||
if cfg!(not(debug_assertions)) && config.server_name == "your.server.name" {
|
if cfg!(not(debug_assertions)) && config.server_name == "your.server.name" {
|
||||||
return Err!(Config(
|
return Err!(Config(
|
||||||
"server_name",
|
"server_name",
|
||||||
"You must specify a valid server name for production usage of conduwuit."
|
"You must specify a valid server name for production usage of continuwuity."
|
||||||
));
|
));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -219,6 +219,15 @@ pub fn check(config: &Config) -> Result {
|
||||||
));
|
));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Check if support contact information is configured
|
||||||
|
if config.well_known.support_email.is_none() && config.well_known.support_mxid.is_none() {
|
||||||
|
warn!(
|
||||||
|
"No support contact information (support_email or support_mxid) is configured in \
|
||||||
|
the well_known section. Users in the admin room will be automatically listed as \
|
||||||
|
support contacts in the /.well-known/matrix/support endpoint."
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
if config
|
if config
|
||||||
.url_preview_domain_contains_allowlist
|
.url_preview_domain_contains_allowlist
|
||||||
.contains(&"*".to_owned())
|
.contains(&"*".to_owned())
|
||||||
|
@ -290,7 +299,7 @@ fn warn_deprecated(config: &Config) {
|
||||||
|
|
||||||
if was_deprecated {
|
if was_deprecated {
|
||||||
warn!(
|
warn!(
|
||||||
"Read conduwuit config documentation at https://conduwuit.puppyirl.gay/configuration.html and check your \
|
"Read continuwuity config documentation at https://continuwuity.org/configuration.html and check your \
|
||||||
configuration if any new configuration parameters should be adjusted"
|
configuration if any new configuration parameters should be adjusted"
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
|
@ -27,7 +27,7 @@ use self::proxy::ProxyConfig;
|
||||||
pub use self::{check::check, manager::Manager};
|
pub use self::{check::check, manager::Manager};
|
||||||
use crate::{Result, err, error::Error, utils::sys};
|
use crate::{Result, err, error::Error, utils::sys};
|
||||||
|
|
||||||
/// All the config options for conduwuit.
|
/// All the config options for continuwuity.
|
||||||
#[allow(clippy::struct_excessive_bools)]
|
#[allow(clippy::struct_excessive_bools)]
|
||||||
#[allow(rustdoc::broken_intra_doc_links, rustdoc::bare_urls)]
|
#[allow(rustdoc::broken_intra_doc_links, rustdoc::bare_urls)]
|
||||||
#[derive(Clone, Debug, Deserialize)]
|
#[derive(Clone, Debug, Deserialize)]
|
||||||
|
@ -35,7 +35,7 @@ use crate::{Result, err, error::Error, utils::sys};
|
||||||
filename = "conduwuit-example.toml",
|
filename = "conduwuit-example.toml",
|
||||||
section = "global",
|
section = "global",
|
||||||
undocumented = "# This item is undocumented. Please contribute documentation for it.",
|
undocumented = "# This item is undocumented. Please contribute documentation for it.",
|
||||||
header = r#"### conduwuit Configuration
|
header = r#"### continuwuity Configuration
|
||||||
###
|
###
|
||||||
### THIS FILE IS GENERATED. CHANGES/CONTRIBUTIONS IN THE REPO WILL BE
|
### THIS FILE IS GENERATED. CHANGES/CONTRIBUTIONS IN THE REPO WILL BE
|
||||||
### OVERWRITTEN!
|
### OVERWRITTEN!
|
||||||
|
@ -50,7 +50,7 @@ use crate::{Result, err, error::Error, utils::sys};
|
||||||
### that say "YOU NEED TO EDIT THIS".
|
### that say "YOU NEED TO EDIT THIS".
|
||||||
###
|
###
|
||||||
### For more information, see:
|
### For more information, see:
|
||||||
### https://conduwuit.puppyirl.gay/configuration.html
|
### https://continuwuity.org/configuration.html
|
||||||
"#,
|
"#,
|
||||||
ignore = "catchall well_known tls blurhashing allow_invalid_tls_certificates_yes_i_know_what_the_fuck_i_am_doing_with_this_and_i_know_this_is_insecure"
|
ignore = "catchall well_known tls blurhashing allow_invalid_tls_certificates_yes_i_know_what_the_fuck_i_am_doing_with_this_and_i_know_this_is_insecure"
|
||||||
)]
|
)]
|
||||||
|
@ -59,7 +59,7 @@ pub struct Config {
|
||||||
/// suffix for user and room IDs/aliases.
|
/// suffix for user and room IDs/aliases.
|
||||||
///
|
///
|
||||||
/// See the docs for reverse proxying and delegation:
|
/// See the docs for reverse proxying and delegation:
|
||||||
/// https://conduwuit.puppyirl.gay/deploying/generic.html#setting-up-the-reverse-proxy
|
/// https://continuwuity.org/deploying/generic.html#setting-up-the-reverse-proxy
|
||||||
///
|
///
|
||||||
/// Also see the `[global.well_known]` config section at the very bottom.
|
/// Also see the `[global.well_known]` config section at the very bottom.
|
||||||
///
|
///
|
||||||
|
@ -70,10 +70,10 @@ pub struct Config {
|
||||||
/// YOU NEED TO EDIT THIS. THIS CANNOT BE CHANGED AFTER WITHOUT A DATABASE
|
/// YOU NEED TO EDIT THIS. THIS CANNOT BE CHANGED AFTER WITHOUT A DATABASE
|
||||||
/// WIPE.
|
/// WIPE.
|
||||||
///
|
///
|
||||||
/// example: "conduwuit.woof"
|
/// example: "continuwuity.org"
|
||||||
pub server_name: OwnedServerName,
|
pub server_name: OwnedServerName,
|
||||||
|
|
||||||
/// The default address (IPv4 or IPv6) conduwuit will listen on.
|
/// The default address (IPv4 or IPv6) continuwuity will listen on.
|
||||||
///
|
///
|
||||||
/// If you are using Docker or a container NAT networking setup, this must
|
/// If you are using Docker or a container NAT networking setup, this must
|
||||||
/// be "0.0.0.0".
|
/// be "0.0.0.0".
|
||||||
|
@ -85,10 +85,10 @@ pub struct Config {
|
||||||
#[serde(default = "default_address")]
|
#[serde(default = "default_address")]
|
||||||
address: ListeningAddr,
|
address: ListeningAddr,
|
||||||
|
|
||||||
/// The port(s) conduwuit will listen on.
|
/// The port(s) continuwuity will listen on.
|
||||||
///
|
///
|
||||||
/// For reverse proxying, see:
|
/// For reverse proxying, see:
|
||||||
/// https://conduwuit.puppyirl.gay/deploying/generic.html#setting-up-the-reverse-proxy
|
/// https://continuwuity.org/deploying/generic.html#setting-up-the-reverse-proxy
|
||||||
///
|
///
|
||||||
/// If you are using Docker, don't change this, you'll need to map an
|
/// If you are using Docker, don't change this, you'll need to map an
|
||||||
/// external port to this.
|
/// external port to this.
|
||||||
|
@ -103,16 +103,17 @@ pub struct Config {
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
pub tls: TlsConfig,
|
pub tls: TlsConfig,
|
||||||
|
|
||||||
/// The UNIX socket conduwuit will listen on.
|
/// The UNIX socket continuwuity will listen on.
|
||||||
///
|
///
|
||||||
/// conduwuit cannot listen on both an IP address and a UNIX socket. If
|
/// continuwuity cannot listen on both an IP address and a UNIX socket. If
|
||||||
/// listening on a UNIX socket, you MUST remove/comment the `address` key.
|
/// listening on a UNIX socket, you MUST remove/comment the `address` key.
|
||||||
///
|
///
|
||||||
/// Remember to make sure that your reverse proxy has access to this socket
|
/// Remember to make sure that your reverse proxy has access to this socket
|
||||||
/// file, either by adding your reverse proxy to the 'conduwuit' group or
|
/// file, either by adding your reverse proxy to the appropriate user group
|
||||||
/// granting world R/W permissions with `unix_socket_perms` (666 minimum).
|
/// or granting world R/W permissions with `unix_socket_perms` (666
|
||||||
|
/// minimum).
|
||||||
///
|
///
|
||||||
/// example: "/run/conduwuit/conduwuit.sock"
|
/// example: "/run/continuwuity/continuwuity.sock"
|
||||||
pub unix_socket_path: Option<PathBuf>,
|
pub unix_socket_path: Option<PathBuf>,
|
||||||
|
|
||||||
/// The default permissions (in octal) to create the UNIX socket with.
|
/// The default permissions (in octal) to create the UNIX socket with.
|
||||||
|
@ -121,22 +122,22 @@ pub struct Config {
|
||||||
#[serde(default = "default_unix_socket_perms")]
|
#[serde(default = "default_unix_socket_perms")]
|
||||||
pub unix_socket_perms: u32,
|
pub unix_socket_perms: u32,
|
||||||
|
|
||||||
/// This is the only directory where conduwuit will save its data, including
|
/// This is the only directory where continuwuity will save its data,
|
||||||
/// media. Note: this was previously "/var/lib/matrix-conduit".
|
/// including media. Note: this was previously "/var/lib/matrix-conduit".
|
||||||
///
|
///
|
||||||
/// YOU NEED TO EDIT THIS.
|
/// YOU NEED TO EDIT THIS.
|
||||||
///
|
///
|
||||||
/// example: "/var/lib/conduwuit"
|
/// example: "/var/lib/continuwuity"
|
||||||
pub database_path: PathBuf,
|
pub database_path: PathBuf,
|
||||||
|
|
||||||
/// conduwuit supports online database backups using RocksDB's Backup engine
|
/// continuwuity supports online database backups using RocksDB's Backup
|
||||||
/// API. To use this, set a database backup path that conduwuit can write
|
/// engine API. To use this, set a database backup path that continuwuity
|
||||||
/// to.
|
/// can write to.
|
||||||
///
|
///
|
||||||
/// For more information, see:
|
/// For more information, see:
|
||||||
/// https://conduwuit.puppyirl.gay/maintenance.html#backups
|
/// https://continuwuity.org/maintenance.html#backups
|
||||||
///
|
///
|
||||||
/// example: "/opt/conduwuit-db-backups"
|
/// example: "/opt/continuwuity-db-backups"
|
||||||
pub database_backup_path: Option<PathBuf>,
|
pub database_backup_path: Option<PathBuf>,
|
||||||
|
|
||||||
/// The amount of online RocksDB database backups to keep/retain, if using
|
/// The amount of online RocksDB database backups to keep/retain, if using
|
||||||
|
@ -160,14 +161,16 @@ pub struct Config {
|
||||||
#[serde(default = "default_new_user_displayname_suffix")]
|
#[serde(default = "default_new_user_displayname_suffix")]
|
||||||
pub new_user_displayname_suffix: String,
|
pub new_user_displayname_suffix: String,
|
||||||
|
|
||||||
/// If enabled, conduwuit will send a simple GET request periodically to
|
/// If enabled, continuwuity will send a simple GET request periodically to
|
||||||
/// `https://continuwuity.org/.well-known/continuwuity/announcements` for any new
|
/// `https://continuwuity.org/.well-known/continuwuity/announcements` for any new
|
||||||
/// announcements or major updates. This is not an update check endpoint.
|
/// announcements or major updates. This is not an update check endpoint.
|
||||||
|
///
|
||||||
|
/// default: true
|
||||||
#[serde(alias = "allow_check_for_updates", default = "true_fn")]
|
#[serde(alias = "allow_check_for_updates", default = "true_fn")]
|
||||||
pub allow_announcements_check: bool,
|
pub allow_announcements_check: bool,
|
||||||
|
|
||||||
/// Set this to any float value to multiply conduwuit's in-memory LRU caches
|
/// Set this to any float value to multiply continuwuity's in-memory LRU
|
||||||
/// with such as "auth_chain_cache_capacity".
|
/// caches with such as "auth_chain_cache_capacity".
|
||||||
///
|
///
|
||||||
/// May be useful if you have significant memory to spare to increase
|
/// May be useful if you have significant memory to spare to increase
|
||||||
/// performance.
|
/// performance.
|
||||||
|
@ -184,7 +187,7 @@ pub struct Config {
|
||||||
)]
|
)]
|
||||||
pub cache_capacity_modifier: f64,
|
pub cache_capacity_modifier: f64,
|
||||||
|
|
||||||
/// Set this to any float value in megabytes for conduwuit to tell the
|
/// Set this to any float value in megabytes for continuwuity to tell the
|
||||||
/// database engine that this much memory is available for database read
|
/// database engine that this much memory is available for database read
|
||||||
/// caches.
|
/// caches.
|
||||||
///
|
///
|
||||||
|
@ -200,7 +203,7 @@ pub struct Config {
|
||||||
#[serde(default = "default_db_cache_capacity_mb")]
|
#[serde(default = "default_db_cache_capacity_mb")]
|
||||||
pub db_cache_capacity_mb: f64,
|
pub db_cache_capacity_mb: f64,
|
||||||
|
|
||||||
/// Set this to any float value in megabytes for conduwuit to tell the
|
/// Set this to any float value in megabytes for continuwuity to tell the
|
||||||
/// database engine that this much memory is available for database write
|
/// database engine that this much memory is available for database write
|
||||||
/// caches.
|
/// caches.
|
||||||
///
|
///
|
||||||
|
@ -317,9 +320,9 @@ pub struct Config {
|
||||||
/// Enable using *only* TCP for querying your specified nameservers instead
|
/// Enable using *only* TCP for querying your specified nameservers instead
|
||||||
/// of UDP.
|
/// of UDP.
|
||||||
///
|
///
|
||||||
/// If you are running conduwuit in a container environment, this config
|
/// If you are running continuwuity in a container environment, this config
|
||||||
/// option may need to be enabled. For more details, see:
|
/// option may need to be enabled. For more details, see:
|
||||||
/// https://conduwuit.puppyirl.gay/troubleshooting.html#potential-dns-issues-when-using-docker
|
/// https://continuwuity.org/troubleshooting.html#potential-dns-issues-when-using-docker
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
pub query_over_tcp_only: bool,
|
pub query_over_tcp_only: bool,
|
||||||
|
|
||||||
|
@ -532,9 +535,9 @@ pub struct Config {
|
||||||
/// tokens. Multiple tokens can be added if you separate them with
|
/// tokens. Multiple tokens can be added if you separate them with
|
||||||
/// whitespace
|
/// whitespace
|
||||||
///
|
///
|
||||||
/// conduwuit must be able to access the file, and it must not be empty
|
/// continuwuity must be able to access the file, and it must not be empty
|
||||||
///
|
///
|
||||||
/// example: "/etc/conduwuit/.reg_token"
|
/// example: "/etc/continuwuity/.reg_token"
|
||||||
pub registration_token_file: Option<PathBuf>,
|
pub registration_token_file: Option<PathBuf>,
|
||||||
|
|
||||||
/// Controls whether encrypted rooms and events are allowed.
|
/// Controls whether encrypted rooms and events are allowed.
|
||||||
|
@ -625,16 +628,16 @@ pub struct Config {
|
||||||
pub allow_room_creation: bool,
|
pub allow_room_creation: bool,
|
||||||
|
|
||||||
/// Set to false to disable users from joining or creating room versions
|
/// Set to false to disable users from joining or creating room versions
|
||||||
/// that aren't officially supported by conduwuit.
|
/// that aren't officially supported by continuwuity.
|
||||||
///
|
///
|
||||||
/// conduwuit officially supports room versions 6 - 11.
|
/// continuwuity officially supports room versions 6 - 11.
|
||||||
///
|
///
|
||||||
/// conduwuit has slightly experimental (though works fine in practice)
|
/// continuwuity has slightly experimental (though works fine in practice)
|
||||||
/// support for versions 3 - 5.
|
/// support for versions 3 - 5.
|
||||||
#[serde(default = "true_fn")]
|
#[serde(default = "true_fn")]
|
||||||
pub allow_unstable_room_versions: bool,
|
pub allow_unstable_room_versions: bool,
|
||||||
|
|
||||||
/// Default room version conduwuit will create rooms with.
|
/// Default room version continuwuity will create rooms with.
|
||||||
///
|
///
|
||||||
/// Per spec, room version 11 is the default.
|
/// Per spec, room version 11 is the default.
|
||||||
///
|
///
|
||||||
|
@ -708,7 +711,7 @@ pub struct Config {
|
||||||
/// Servers listed here will be used to gather public keys of other servers
|
/// Servers listed here will be used to gather public keys of other servers
|
||||||
/// (notary trusted key servers).
|
/// (notary trusted key servers).
|
||||||
///
|
///
|
||||||
/// Currently, conduwuit doesn't support inbound batched key requests, so
|
/// Currently, continuwuity doesn't support inbound batched key requests, so
|
||||||
/// this list should only contain other Synapse servers.
|
/// this list should only contain other Synapse servers.
|
||||||
///
|
///
|
||||||
/// example: ["matrix.org", "tchncs.de"]
|
/// example: ["matrix.org", "tchncs.de"]
|
||||||
|
@ -753,7 +756,7 @@ pub struct Config {
|
||||||
#[serde(default = "default_trusted_server_batch_size")]
|
#[serde(default = "default_trusted_server_batch_size")]
|
||||||
pub trusted_server_batch_size: usize,
|
pub trusted_server_batch_size: usize,
|
||||||
|
|
||||||
/// Max log level for conduwuit. Allows debug, info, warn, or error.
|
/// Max log level for continuwuity. Allows debug, info, warn, or error.
|
||||||
///
|
///
|
||||||
/// See also:
|
/// See also:
|
||||||
/// https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives
|
/// https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives
|
||||||
|
@ -778,8 +781,9 @@ pub struct Config {
|
||||||
#[serde(default = "default_log_span_events")]
|
#[serde(default = "default_log_span_events")]
|
||||||
pub log_span_events: String,
|
pub log_span_events: String,
|
||||||
|
|
||||||
/// Configures whether CONDUWUIT_LOG EnvFilter matches values using regular
|
/// Configures whether CONTINUWUITY_LOG EnvFilter matches values using
|
||||||
/// expressions. See the tracing_subscriber documentation on Directives.
|
/// regular expressions. See the tracing_subscriber documentation on
|
||||||
|
/// Directives.
|
||||||
///
|
///
|
||||||
/// default: true
|
/// default: true
|
||||||
#[serde(default = "true_fn")]
|
#[serde(default = "true_fn")]
|
||||||
|
@ -861,7 +865,7 @@ pub struct Config {
|
||||||
/// This takes priority over "turn_secret" first, and falls back to
|
/// This takes priority over "turn_secret" first, and falls back to
|
||||||
/// "turn_secret" if invalid or failed to open.
|
/// "turn_secret" if invalid or failed to open.
|
||||||
///
|
///
|
||||||
/// example: "/etc/conduwuit/.turn_secret"
|
/// example: "/etc/continuwuity/.turn_secret"
|
||||||
pub turn_secret_file: Option<PathBuf>,
|
pub turn_secret_file: Option<PathBuf>,
|
||||||
|
|
||||||
/// TURN TTL, in seconds.
|
/// TURN TTL, in seconds.
|
||||||
|
@ -870,12 +874,12 @@ pub struct Config {
|
||||||
#[serde(default = "default_turn_ttl")]
|
#[serde(default = "default_turn_ttl")]
|
||||||
pub turn_ttl: u64,
|
pub turn_ttl: u64,
|
||||||
|
|
||||||
/// List/vector of room IDs or room aliases that conduwuit will make newly
|
/// List/vector of room IDs or room aliases that continuwuity will make
|
||||||
/// registered users join. The rooms specified must be rooms that you have
|
/// newly registered users join. The rooms specified must be rooms that you
|
||||||
/// joined at least once on the server, and must be public.
|
/// have joined at least once on the server, and must be public.
|
||||||
///
|
///
|
||||||
/// example: ["#conduwuit:puppygock.gay",
|
/// example: ["#continuwuity:continuwuity.org",
|
||||||
/// "!eoIzvAvVwY23LPDay8:puppygock.gay"]
|
/// "!main-1:continuwuity.org"]
|
||||||
///
|
///
|
||||||
/// default: []
|
/// default: []
|
||||||
#[serde(default = "Vec::new")]
|
#[serde(default = "Vec::new")]
|
||||||
|
@ -900,10 +904,10 @@ pub struct Config {
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
pub auto_deactivate_banned_room_attempts: bool,
|
pub auto_deactivate_banned_room_attempts: bool,
|
||||||
|
|
||||||
/// RocksDB log level. This is not the same as conduwuit's log level. This
|
/// RocksDB log level. This is not the same as continuwuity's log level.
|
||||||
/// is the log level for the RocksDB engine/library which show up in your
|
/// This is the log level for the RocksDB engine/library which show up in
|
||||||
/// database folder/path as `LOG` files. conduwuit will log RocksDB errors
|
/// your database folder/path as `LOG` files. continuwuity will log RocksDB
|
||||||
/// as normal through tracing or panics if severe for safety.
|
/// errors as normal through tracing or panics if severe for safety.
|
||||||
///
|
///
|
||||||
/// default: "error"
|
/// default: "error"
|
||||||
#[serde(default = "default_rocksdb_log_level")]
|
#[serde(default = "default_rocksdb_log_level")]
|
||||||
|
@ -928,7 +932,7 @@ pub struct Config {
|
||||||
/// Set this to true to use RocksDB config options that are tailored to HDDs
|
/// Set this to true to use RocksDB config options that are tailored to HDDs
|
||||||
/// (slower device storage).
|
/// (slower device storage).
|
||||||
///
|
///
|
||||||
/// It is worth noting that by default, conduwuit will use RocksDB with
|
/// It is worth noting that by default, continuwuity will use RocksDB with
|
||||||
/// Direct IO enabled. *Generally* speaking this improves performance as it
|
/// Direct IO enabled. *Generally* speaking this improves performance as it
|
||||||
/// bypasses buffered I/O (system page cache). However there is a potential
|
/// bypasses buffered I/O (system page cache). However there is a potential
|
||||||
/// chance that Direct IO may cause issues with database operations if your
|
/// chance that Direct IO may cause issues with database operations if your
|
||||||
|
@ -936,7 +940,7 @@ pub struct Config {
|
||||||
/// possibly ZFS filesystem. RocksDB generally deals/corrects these issues
|
/// possibly ZFS filesystem. RocksDB generally deals/corrects these issues
|
||||||
/// but it cannot account for all setups. If you experience any weird
|
/// but it cannot account for all setups. If you experience any weird
|
||||||
/// RocksDB issues, try enabling this option as it turns off Direct IO and
|
/// RocksDB issues, try enabling this option as it turns off Direct IO and
|
||||||
/// feel free to report in the conduwuit Matrix room if this option fixes
|
/// feel free to report in the continuwuity Matrix room if this option fixes
|
||||||
/// your DB issues.
|
/// your DB issues.
|
||||||
///
|
///
|
||||||
/// For more information, see:
|
/// For more information, see:
|
||||||
|
@ -997,7 +1001,7 @@ pub struct Config {
|
||||||
/// as they all differ. See their `kDefaultCompressionLevel`.
|
/// as they all differ. See their `kDefaultCompressionLevel`.
|
||||||
///
|
///
|
||||||
/// Note when using the default value we may override it with a setting
|
/// Note when using the default value we may override it with a setting
|
||||||
/// tailored specifically conduwuit.
|
/// tailored specifically for continuwuity.
|
||||||
///
|
///
|
||||||
/// default: 32767
|
/// default: 32767
|
||||||
#[serde(default = "default_rocksdb_compression_level")]
|
#[serde(default = "default_rocksdb_compression_level")]
|
||||||
|
@ -1015,7 +1019,7 @@ pub struct Config {
|
||||||
/// algorithm.
|
/// algorithm.
|
||||||
///
|
///
|
||||||
/// Note when using the default value we may override it with a setting
|
/// Note when using the default value we may override it with a setting
|
||||||
/// tailored specifically conduwuit.
|
/// tailored specifically for continuwuity.
|
||||||
///
|
///
|
||||||
/// default: 32767
|
/// default: 32767
|
||||||
#[serde(default = "default_rocksdb_bottommost_compression_level")]
|
#[serde(default = "default_rocksdb_bottommost_compression_level")]
|
||||||
|
@ -1057,13 +1061,13 @@ pub struct Config {
|
||||||
/// 0 = AbsoluteConsistency
|
/// 0 = AbsoluteConsistency
|
||||||
/// 1 = TolerateCorruptedTailRecords (default)
|
/// 1 = TolerateCorruptedTailRecords (default)
|
||||||
/// 2 = PointInTime (use me if trying to recover)
|
/// 2 = PointInTime (use me if trying to recover)
|
||||||
/// 3 = SkipAnyCorruptedRecord (you now voided your Conduwuit warranty)
|
/// 3 = SkipAnyCorruptedRecord (you now voided your Continuwuity warranty)
|
||||||
///
|
///
|
||||||
/// For more information on these modes, see:
|
/// For more information on these modes, see:
|
||||||
/// https://github.com/facebook/rocksdb/wiki/WAL-Recovery-Modes
|
/// https://github.com/facebook/rocksdb/wiki/WAL-Recovery-Modes
|
||||||
///
|
///
|
||||||
/// For more details on recovering a corrupt database, see:
|
/// For more details on recovering a corrupt database, see:
|
||||||
/// https://conduwuit.puppyirl.gay/troubleshooting.html#database-corruption
|
/// https://continuwuity.org/troubleshooting.html#database-corruption
|
||||||
///
|
///
|
||||||
/// default: 1
|
/// default: 1
|
||||||
#[serde(default = "default_rocksdb_recovery_mode")]
|
#[serde(default = "default_rocksdb_recovery_mode")]
|
||||||
|
@ -1107,7 +1111,7 @@ pub struct Config {
|
||||||
/// - Disabling repair mode and restarting the server is recommended after
|
/// - Disabling repair mode and restarting the server is recommended after
|
||||||
/// running the repair.
|
/// running the repair.
|
||||||
///
|
///
|
||||||
/// See https://conduwuit.puppyirl.gay/troubleshooting.html#database-corruption for more details on recovering a corrupt database.
|
/// See https://continuwuity.org/troubleshooting.html#database-corruption for more details on recovering a corrupt database.
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
pub rocksdb_repair: bool,
|
pub rocksdb_repair: bool,
|
||||||
|
|
||||||
|
@ -1130,9 +1134,9 @@ pub struct Config {
|
||||||
pub rocksdb_compaction_ioprio_idle: bool,
|
pub rocksdb_compaction_ioprio_idle: bool,
|
||||||
|
|
||||||
/// Enables RocksDB compaction. You should never ever have to set this
|
/// Enables RocksDB compaction. You should never ever have to set this
|
||||||
/// option to false. If you for some reason find yourself needing to use this
|
/// option to false. If you for some reason find yourself needing to use
|
||||||
/// option as part of troubleshooting or a bug, please reach out to us in
|
/// this option as part of troubleshooting or a bug, please reach out to us
|
||||||
/// the conduwuit Matrix room with information and details.
|
/// in the continuwuity Matrix room with information and details.
|
||||||
///
|
///
|
||||||
/// Disabling compaction will lead to a significantly bloated and
|
/// Disabling compaction will lead to a significantly bloated and
|
||||||
/// explosively large database, gradually poor performance, unnecessarily
|
/// explosively large database, gradually poor performance, unnecessarily
|
||||||
|
@ -1160,7 +1164,7 @@ pub struct Config {
|
||||||
/// purposes such as recovering/recreating your admin room, or inviting
|
/// purposes such as recovering/recreating your admin room, or inviting
|
||||||
/// yourself back.
|
/// yourself back.
|
||||||
///
|
///
|
||||||
/// See https://conduwuit.puppyirl.gay/troubleshooting.html#lost-access-to-admin-room for other ways to get back into your admin room.
|
/// See https://continuwuity.org/troubleshooting.html#lost-access-to-admin-room for other ways to get back into your admin room.
|
||||||
///
|
///
|
||||||
/// Once this password is unset, all sessions will be logged out for
|
/// Once this password is unset, all sessions will be logged out for
|
||||||
/// security purposes.
|
/// security purposes.
|
||||||
|
@ -1176,8 +1180,8 @@ pub struct Config {
|
||||||
|
|
||||||
/// Allow local (your server only) presence updates/requests.
|
/// Allow local (your server only) presence updates/requests.
|
||||||
///
|
///
|
||||||
/// Note that presence on conduwuit is very fast unlike Synapse's. If using
|
/// Note that presence on continuwuity is very fast unlike Synapse's. If
|
||||||
/// outgoing presence, this MUST be enabled.
|
/// using outgoing presence, this MUST be enabled.
|
||||||
#[serde(default = "true_fn")]
|
#[serde(default = "true_fn")]
|
||||||
pub allow_local_presence: bool,
|
pub allow_local_presence: bool,
|
||||||
|
|
||||||
|
@ -1185,7 +1189,7 @@ pub struct Config {
|
||||||
///
|
///
|
||||||
/// This option receives presence updates from other servers, but does not
|
/// This option receives presence updates from other servers, but does not
|
||||||
/// send any unless `allow_outgoing_presence` is true. Note that presence on
|
/// send any unless `allow_outgoing_presence` is true. Note that presence on
|
||||||
/// conduwuit is very fast unlike Synapse's.
|
/// continuwuity is very fast unlike Synapse's.
|
||||||
#[serde(default = "true_fn")]
|
#[serde(default = "true_fn")]
|
||||||
pub allow_incoming_presence: bool,
|
pub allow_incoming_presence: bool,
|
||||||
|
|
||||||
|
@ -1193,8 +1197,8 @@ pub struct Config {
|
||||||
///
|
///
|
||||||
/// This option sends presence updates to other servers, but does not
|
/// This option sends presence updates to other servers, but does not
|
||||||
/// receive any unless `allow_incoming_presence` is true. Note that presence
|
/// receive any unless `allow_incoming_presence` is true. Note that presence
|
||||||
/// on conduwuit is very fast unlike Synapse's. If using outgoing presence,
|
/// on continuwuity is very fast unlike Synapse's. If using outgoing
|
||||||
/// you MUST enable `allow_local_presence` as well.
|
/// presence, you MUST enable `allow_local_presence` as well.
|
||||||
#[serde(default = "true_fn")]
|
#[serde(default = "true_fn")]
|
||||||
pub allow_outgoing_presence: bool,
|
pub allow_outgoing_presence: bool,
|
||||||
|
|
||||||
|
@ -1257,8 +1261,8 @@ pub struct Config {
|
||||||
#[serde(default = "default_typing_client_timeout_max_s")]
|
#[serde(default = "default_typing_client_timeout_max_s")]
|
||||||
pub typing_client_timeout_max_s: u64,
|
pub typing_client_timeout_max_s: u64,
|
||||||
|
|
||||||
/// Set this to true for conduwuit to compress HTTP response bodies using
|
/// Set this to true for continuwuity to compress HTTP response bodies using
|
||||||
/// zstd. This option does nothing if conduwuit was not built with
|
/// zstd. This option does nothing if continuwuity was not built with
|
||||||
/// `zstd_compression` feature. Please be aware that enabling HTTP
|
/// `zstd_compression` feature. Please be aware that enabling HTTP
|
||||||
/// compression may weaken TLS. Most users should not need to enable this.
|
/// compression may weaken TLS. Most users should not need to enable this.
|
||||||
/// See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH
|
/// See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH
|
||||||
|
@ -1266,8 +1270,8 @@ pub struct Config {
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
pub zstd_compression: bool,
|
pub zstd_compression: bool,
|
||||||
|
|
||||||
/// Set this to true for conduwuit to compress HTTP response bodies using
|
/// Set this to true for continuwuity to compress HTTP response bodies using
|
||||||
/// gzip. This option does nothing if conduwuit was not built with
|
/// gzip. This option does nothing if continuwuity was not built with
|
||||||
/// `gzip_compression` feature. Please be aware that enabling HTTP
|
/// `gzip_compression` feature. Please be aware that enabling HTTP
|
||||||
/// compression may weaken TLS. Most users should not need to enable this.
|
/// compression may weaken TLS. Most users should not need to enable this.
|
||||||
/// See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH before
|
/// See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH before
|
||||||
|
@ -1278,8 +1282,8 @@ pub struct Config {
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
pub gzip_compression: bool,
|
pub gzip_compression: bool,
|
||||||
|
|
||||||
/// Set this to true for conduwuit to compress HTTP response bodies using
|
/// Set this to true for continuwuity to compress HTTP response bodies using
|
||||||
/// brotli. This option does nothing if conduwuit was not built with
|
/// brotli. This option does nothing if continuwuity was not built with
|
||||||
/// `brotli_compression` feature. Please be aware that enabling HTTP
|
/// `brotli_compression` feature. Please be aware that enabling HTTP
|
||||||
/// compression may weaken TLS. Most users should not need to enable this.
|
/// compression may weaken TLS. Most users should not need to enable this.
|
||||||
/// See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH
|
/// See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH
|
||||||
|
@ -1340,7 +1344,7 @@ pub struct Config {
|
||||||
/// Otherwise setting this to false reduces filesystem clutter and overhead
|
/// Otherwise setting this to false reduces filesystem clutter and overhead
|
||||||
/// for managing these symlinks in the directory. This is now disabled by
|
/// for managing these symlinks in the directory. This is now disabled by
|
||||||
/// default. You may still return to upstream Conduit but you have to run
|
/// default. You may still return to upstream Conduit but you have to run
|
||||||
/// conduwuit at least once with this set to true and allow the
|
/// continuwuity at least once with this set to true and allow the
|
||||||
/// media_startup_check to take place before shutting down to return to
|
/// media_startup_check to take place before shutting down to return to
|
||||||
/// Conduit.
|
/// Conduit.
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
|
@ -1357,25 +1361,13 @@ pub struct Config {
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
pub prune_missing_media: bool,
|
pub prune_missing_media: bool,
|
||||||
|
|
||||||
/// Vector list of regex patterns of server names that conduwuit will refuse
|
|
||||||
/// to download remote media from.
|
|
||||||
///
|
|
||||||
/// example: ["badserver\.tld$", "badphrase", "19dollarfortnitecards"]
|
|
||||||
///
|
|
||||||
/// default: []
|
|
||||||
#[serde(default, with = "serde_regex")]
|
|
||||||
pub prevent_media_downloads_from: RegexSet,
|
|
||||||
|
|
||||||
/// List of forbidden server names via regex patterns that we will block
|
/// List of forbidden server names via regex patterns that we will block
|
||||||
/// incoming AND outgoing federation with, and block client room joins /
|
/// incoming AND outgoing federation with, and block client room joins /
|
||||||
/// remote user invites.
|
/// remote user invites.
|
||||||
///
|
///
|
||||||
/// Additionally, it will hide messages from these servers for all users
|
|
||||||
/// on this server.
|
|
||||||
///
|
|
||||||
/// Note that your messages can still make it to forbidden servers through
|
/// Note that your messages can still make it to forbidden servers through
|
||||||
/// backfilling. Events we receive from forbidden servers via backfill will
|
/// backfilling. Events we receive from forbidden servers via backfill
|
||||||
/// be stored in the database, but will not be sent to the client.
|
/// from servers we *do* federate with will be stored in the database.
|
||||||
///
|
///
|
||||||
/// This check is applied on the room ID, room alias, sender server name,
|
/// This check is applied on the room ID, room alias, sender server name,
|
||||||
/// sender user's server name, inbound federation X-Matrix origin, and
|
/// sender user's server name, inbound federation X-Matrix origin, and
|
||||||
|
@ -1384,7 +1376,7 @@ pub struct Config {
|
||||||
/// You can set this to ["*"] to block all servers by default, and then
|
/// You can set this to ["*"] to block all servers by default, and then
|
||||||
/// use `allowed_remote_server_names` to allow only specific servers.
|
/// use `allowed_remote_server_names` to allow only specific servers.
|
||||||
///
|
///
|
||||||
/// example: ["badserver\.tld$", "badphrase", "19dollarfortnitecards"]
|
/// example: ["badserver\\.tld$", "badphrase", "19dollarfortnitecards"]
|
||||||
///
|
///
|
||||||
/// default: []
|
/// default: []
|
||||||
#[serde(default, with = "serde_regex")]
|
#[serde(default, with = "serde_regex")]
|
||||||
|
@ -1395,12 +1387,21 @@ pub struct Config {
|
||||||
///
|
///
|
||||||
/// This option has no effect if `forbidden_remote_server_names` is empty.
|
/// This option has no effect if `forbidden_remote_server_names` is empty.
|
||||||
///
|
///
|
||||||
/// example: ["goodserver\.tld$", "goodphrase"]
|
/// example: ["goodserver\\.tld$", "goodphrase"]
|
||||||
///
|
///
|
||||||
/// default: []
|
/// default: []
|
||||||
#[serde(default, with = "serde_regex")]
|
#[serde(default, with = "serde_regex")]
|
||||||
pub allowed_remote_server_names: RegexSet,
|
pub allowed_remote_server_names: RegexSet,
|
||||||
|
|
||||||
|
/// Vector list of regex patterns of server names that continuwuity will
|
||||||
|
/// refuse to download remote media from.
|
||||||
|
///
|
||||||
|
/// example: ["badserver\.tld$", "badphrase", "19dollarfortnitecards"]
|
||||||
|
///
|
||||||
|
/// default: []
|
||||||
|
#[serde(default, with = "serde_regex")]
|
||||||
|
pub prevent_media_downloads_from: RegexSet,
|
||||||
|
|
||||||
/// List of forbidden server names via regex patterns that we will block all
|
/// List of forbidden server names via regex patterns that we will block all
|
||||||
/// outgoing federated room directory requests for. Useful for preventing
|
/// outgoing federated room directory requests for. Useful for preventing
|
||||||
/// our users from wandering into bad servers or spaces.
|
/// our users from wandering into bad servers or spaces.
|
||||||
|
@ -1411,8 +1412,33 @@ pub struct Config {
|
||||||
#[serde(default, with = "serde_regex")]
|
#[serde(default, with = "serde_regex")]
|
||||||
pub forbidden_remote_room_directory_server_names: RegexSet,
|
pub forbidden_remote_room_directory_server_names: RegexSet,
|
||||||
|
|
||||||
|
/// Vector list of regex patterns of server names that continuwuity will not
|
||||||
|
/// send messages to the client from.
|
||||||
|
///
|
||||||
|
/// Note that there is no way for clients to receive messages once a server
|
||||||
|
/// has become unignored without doing a full sync. This is a protocol
|
||||||
|
/// limitation with the current sync protocols. This means this is somewhat
|
||||||
|
/// of a nuclear option.
|
||||||
|
///
|
||||||
|
/// example: ["reallybadserver\.tld$", "reallybadphrase",
|
||||||
|
/// "69dollarfortnitecards"]
|
||||||
|
///
|
||||||
|
/// default: []
|
||||||
|
#[serde(default, with = "serde_regex")]
|
||||||
|
pub ignore_messages_from_server_names: RegexSet,
|
||||||
|
|
||||||
|
/// Send messages from users that the user has ignored to the client.
|
||||||
|
///
|
||||||
|
/// There is no way for clients to receive messages sent while a user was
|
||||||
|
/// ignored without doing a full sync. This is a protocol limitation with
|
||||||
|
/// the current sync protocols. Disabling this option will move
|
||||||
|
/// responsibility of ignoring messages to the client, which can avoid this
|
||||||
|
/// limitation.
|
||||||
|
#[serde(default)]
|
||||||
|
pub send_messages_from_ignored_users_to_client: bool,
|
||||||
|
|
||||||
/// Vector list of IPv4 and IPv6 CIDR ranges / subnets *in quotes* that you
|
/// Vector list of IPv4 and IPv6 CIDR ranges / subnets *in quotes* that you
|
||||||
/// do not want conduwuit to send outbound requests to. Defaults to
|
/// do not want continuwuity to send outbound requests to. Defaults to
|
||||||
/// RFC1918, unroutable, loopback, multicast, and testnet addresses for
|
/// RFC1918, unroutable, loopback, multicast, and testnet addresses for
|
||||||
/// security.
|
/// security.
|
||||||
///
|
///
|
||||||
|
@ -1580,26 +1606,26 @@ pub struct Config {
|
||||||
|
|
||||||
/// Allow admins to enter commands in rooms other than "#admins" (admin
|
/// Allow admins to enter commands in rooms other than "#admins" (admin
|
||||||
/// room) by prefixing your message with "\!admin" or "\\!admin" followed up
|
/// room) by prefixing your message with "\!admin" or "\\!admin" followed up
|
||||||
/// a normal conduwuit admin command. The reply will be publicly visible to
|
/// a normal continuwuity admin command. The reply will be publicly visible
|
||||||
/// the room, originating from the sender.
|
/// to the room, originating from the sender.
|
||||||
///
|
///
|
||||||
/// example: \\!admin debug ping puppygock.gay
|
/// example: \\!admin debug ping puppygock.gay
|
||||||
#[serde(default = "true_fn")]
|
#[serde(default = "true_fn")]
|
||||||
pub admin_escape_commands: bool,
|
pub admin_escape_commands: bool,
|
||||||
|
|
||||||
/// Automatically activate the conduwuit admin room console / CLI on
|
/// Automatically activate the continuwuity admin room console / CLI on
|
||||||
/// startup. This option can also be enabled with `--console` conduwuit
|
/// startup. This option can also be enabled with `--console` continuwuity
|
||||||
/// argument.
|
/// argument.
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
pub admin_console_automatic: bool,
|
pub admin_console_automatic: bool,
|
||||||
|
|
||||||
/// List of admin commands to execute on startup.
|
/// List of admin commands to execute on startup.
|
||||||
///
|
///
|
||||||
/// This option can also be configured with the `--execute` conduwuit
|
/// This option can also be configured with the `--execute` continuwuity
|
||||||
/// argument and can take standard shell commands and environment variables
|
/// argument and can take standard shell commands and environment variables
|
||||||
///
|
///
|
||||||
/// For example: `./conduwuit --execute "server admin-notice conduwuit has
|
/// For example: `./continuwuity --execute "server admin-notice continuwuity
|
||||||
/// started up at $(date)"`
|
/// has started up at $(date)"`
|
||||||
///
|
///
|
||||||
/// example: admin_execute = ["debug ping puppygock.gay", "debug echo hi"]`
|
/// example: admin_execute = ["debug ping puppygock.gay", "debug echo hi"]`
|
||||||
///
|
///
|
||||||
|
@ -1609,7 +1635,7 @@ pub struct Config {
|
||||||
|
|
||||||
/// Ignore errors in startup commands.
|
/// Ignore errors in startup commands.
|
||||||
///
|
///
|
||||||
/// If false, conduwuit will error and fail to start if an admin execute
|
/// If false, continuwuity will error and fail to start if an admin execute
|
||||||
/// command (`--execute` / `admin_execute`) fails.
|
/// command (`--execute` / `admin_execute`) fails.
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
pub admin_execute_errors_ignore: bool,
|
pub admin_execute_errors_ignore: bool,
|
||||||
|
@ -1634,17 +1660,16 @@ pub struct Config {
|
||||||
/// The default room tag to apply on the admin room.
|
/// The default room tag to apply on the admin room.
|
||||||
///
|
///
|
||||||
/// On some clients like Element, the room tag "m.server_notice" is a
|
/// On some clients like Element, the room tag "m.server_notice" is a
|
||||||
/// special pinned room at the very bottom of your room list. The conduwuit
|
/// special pinned room at the very bottom of your room list. The
|
||||||
/// admin room can be pinned here so you always have an easy-to-access
|
/// continuwuity admin room can be pinned here so you always have an
|
||||||
/// shortcut dedicated to your admin room.
|
/// easy-to-access shortcut dedicated to your admin room.
|
||||||
///
|
///
|
||||||
/// default: "m.server_notice"
|
/// default: "m.server_notice"
|
||||||
#[serde(default = "default_admin_room_tag")]
|
#[serde(default = "default_admin_room_tag")]
|
||||||
pub admin_room_tag: String,
|
pub admin_room_tag: String,
|
||||||
|
|
||||||
/// Sentry.io crash/panic reporting, performance monitoring/metrics, etc.
|
/// Sentry.io crash/panic reporting, performance monitoring/metrics, etc.
|
||||||
/// This is NOT enabled by default. conduwuit's default Sentry reporting
|
/// This is NOT enabled by default.
|
||||||
/// endpoint domain is `o4506996327251968.ingest.us.sentry.io`.
|
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
pub sentry: bool,
|
pub sentry: bool,
|
||||||
|
|
||||||
|
@ -1655,7 +1680,7 @@ pub struct Config {
|
||||||
#[serde(default = "default_sentry_endpoint")]
|
#[serde(default = "default_sentry_endpoint")]
|
||||||
pub sentry_endpoint: Option<Url>,
|
pub sentry_endpoint: Option<Url>,
|
||||||
|
|
||||||
/// Report your conduwuit server_name in Sentry.io crash reports and
|
/// Report your continuwuity server_name in Sentry.io crash reports and
|
||||||
/// metrics.
|
/// metrics.
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
pub sentry_send_server_name: bool,
|
pub sentry_send_server_name: bool,
|
||||||
|
@ -1696,7 +1721,7 @@ pub struct Config {
|
||||||
/// Enable the tokio-console. This option is only relevant to developers.
|
/// Enable the tokio-console. This option is only relevant to developers.
|
||||||
///
|
///
|
||||||
/// For more information, see:
|
/// For more information, see:
|
||||||
/// https://conduwuit.puppyirl.gay/development.html#debugging-with-tokio-console
|
/// https://continuwuity.org/development.html#debugging-with-tokio-console
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
pub tokio_console: bool,
|
pub tokio_console: bool,
|
||||||
|
|
||||||
|
@ -1872,12 +1897,28 @@ pub struct WellKnownConfig {
|
||||||
/// example: "matrix.example.com:443"
|
/// example: "matrix.example.com:443"
|
||||||
pub server: Option<OwnedServerName>,
|
pub server: Option<OwnedServerName>,
|
||||||
|
|
||||||
|
/// URL to a support page for the server, which will be served as part of
|
||||||
|
/// the MSC1929 server support endpoint at /.well-known/matrix/support.
|
||||||
|
/// Will be included alongside any contact information
|
||||||
pub support_page: Option<Url>,
|
pub support_page: Option<Url>,
|
||||||
|
|
||||||
|
/// Role string for server support contacts, to be served as part of the
|
||||||
|
/// MSC1929 server support endpoint at /.well-known/matrix/support.
|
||||||
|
///
|
||||||
|
/// default: "m.role.admin"
|
||||||
pub support_role: Option<ContactRole>,
|
pub support_role: Option<ContactRole>,
|
||||||
|
|
||||||
|
/// Email address for server support contacts, to be served as part of the
|
||||||
|
/// MSC1929 server support endpoint.
|
||||||
|
/// This will be used along with support_mxid if specified.
|
||||||
pub support_email: Option<String>,
|
pub support_email: Option<String>,
|
||||||
|
|
||||||
|
/// Matrix ID for server support contacts, to be served as part of the
|
||||||
|
/// MSC1929 server support endpoint.
|
||||||
|
/// This will be used along with support_email if specified.
|
||||||
|
///
|
||||||
|
/// If no email or mxid is specified, all of the server's admins will be
|
||||||
|
/// listed.
|
||||||
pub support_mxid: Option<OwnedUserId>,
|
pub support_mxid: Option<OwnedUserId>,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -1938,7 +1979,11 @@ impl Config {
|
||||||
where
|
where
|
||||||
I: Iterator<Item = &'a Path>,
|
I: Iterator<Item = &'a Path>,
|
||||||
{
|
{
|
||||||
let envs = [Env::var("CONDUIT_CONFIG"), Env::var("CONDUWUIT_CONFIG")];
|
let envs = [
|
||||||
|
Env::var("CONDUIT_CONFIG"),
|
||||||
|
Env::var("CONDUWUIT_CONFIG"),
|
||||||
|
Env::var("CONTINUWUITY_CONFIG"),
|
||||||
|
];
|
||||||
|
|
||||||
let config = envs
|
let config = envs
|
||||||
.into_iter()
|
.into_iter()
|
||||||
|
@ -1947,7 +1992,8 @@ impl Config {
|
||||||
.chain(paths.map(Toml::file))
|
.chain(paths.map(Toml::file))
|
||||||
.fold(Figment::new(), |config, file| config.merge(file.nested()))
|
.fold(Figment::new(), |config, file| config.merge(file.nested()))
|
||||||
.merge(Env::prefixed("CONDUIT_").global().split("__"))
|
.merge(Env::prefixed("CONDUIT_").global().split("__"))
|
||||||
.merge(Env::prefixed("CONDUWUIT_").global().split("__"));
|
.merge(Env::prefixed("CONDUWUIT_").global().split("__"))
|
||||||
|
.merge(Env::prefixed("CONTINUWUITY_").global().split("__"));
|
||||||
|
|
||||||
Ok(config)
|
Ok(config)
|
||||||
}
|
}
|
||||||
|
|
|
@ -36,7 +36,7 @@ const MAIN_MANIFEST: &'static str = ();
|
||||||
/// For *enabled* features see the info::rustc module instead.
|
/// For *enabled* features see the info::rustc module instead.
|
||||||
static FEATURES: OnceLock<Vec<String>> = OnceLock::new();
|
static FEATURES: OnceLock<Vec<String>> = OnceLock::new();
|
||||||
|
|
||||||
/// Processed list of dependencies. This is generated from the datas captured in
|
/// Processed list of dependencies. This is generated from the data captured in
|
||||||
/// the MANIFEST.
|
/// the MANIFEST.
|
||||||
static DEPENDENCIES: OnceLock<DepsSet> = OnceLock::new();
|
static DEPENDENCIES: OnceLock<DepsSet> = OnceLock::new();
|
||||||
|
|
||||||
|
|
|
@ -26,13 +26,6 @@ pub fn user_agent() -> &'static str { USER_AGENT.get_or_init(init_user_agent) }
|
||||||
fn init_user_agent() -> String { format!("{}/{}", name(), version()) }
|
fn init_user_agent() -> String { format!("{}/{}", name(), version()) }
|
||||||
|
|
||||||
fn init_version() -> String {
|
fn init_version() -> String {
|
||||||
option_env!("CONDUWUIT_VERSION_EXTRA")
|
conduwuit_build_metadata::version_tag()
|
||||||
.or(option_env!("CONDUIT_VERSION_EXTRA"))
|
.map_or(SEMANTIC.to_owned(), |extra| format!("{SEMANTIC} ({extra})"))
|
||||||
.map_or(SEMANTIC.to_owned(), |extra| {
|
|
||||||
if extra.is_empty() {
|
|
||||||
SEMANTIC.to_owned()
|
|
||||||
} else {
|
|
||||||
format!("{SEMANTIC} ({extra})")
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -16,9 +16,9 @@ use crate::{Result, error};
|
||||||
/// pulling in a version of tracing that's incompatible with the rest of our
|
/// pulling in a version of tracing that's incompatible with the rest of our
|
||||||
/// deps.
|
/// deps.
|
||||||
///
|
///
|
||||||
/// To work around this, we define an trait without the S paramter that forwards
|
/// To work around this, we define an trait without the S parameter that
|
||||||
/// to the reload::Handle::reload method, and then store the handle as a trait
|
/// forwards to the reload::Handle::reload method, and then store the handle as
|
||||||
/// object.
|
/// a trait object.
|
||||||
///
|
///
|
||||||
/// [1]: <https://github.com/tokio-rs/tracing/pull/1035/commits/8a87ea52425098d3ef8f56d92358c2f6c144a28f>
|
/// [1]: <https://github.com/tokio-rs/tracing/pull/1035/commits/8a87ea52425098d3ef8f56d92358c2f6c144a28f>
|
||||||
pub trait ReloadHandle<L> {
|
pub trait ReloadHandle<L> {
|
||||||
|
|
|
@ -1,18 +1,10 @@
|
||||||
use std::{
|
|
||||||
borrow::Borrow,
|
|
||||||
fmt::{Debug, Display},
|
|
||||||
hash::Hash,
|
|
||||||
};
|
|
||||||
|
|
||||||
use ruma::{EventId, MilliSecondsSinceUnixEpoch, RoomId, UserId, events::TimelineEventType};
|
use ruma::{EventId, MilliSecondsSinceUnixEpoch, RoomId, UserId, events::TimelineEventType};
|
||||||
use serde_json::value::RawValue as RawJsonValue;
|
use serde_json::value::RawValue as RawJsonValue;
|
||||||
|
|
||||||
/// Abstraction of a PDU so users can have their own PDU types.
|
/// Abstraction of a PDU so users can have their own PDU types.
|
||||||
pub trait Event {
|
pub trait Event {
|
||||||
type Id: Clone + Debug + Display + Eq + Ord + Hash + Send + Borrow<EventId>;
|
|
||||||
|
|
||||||
/// The `EventId` of this event.
|
/// The `EventId` of this event.
|
||||||
fn event_id(&self) -> &Self::Id;
|
fn event_id(&self) -> &EventId;
|
||||||
|
|
||||||
/// The `RoomId` of this event.
|
/// The `RoomId` of this event.
|
||||||
fn room_id(&self) -> &RoomId;
|
fn room_id(&self) -> &RoomId;
|
||||||
|
@ -34,20 +26,18 @@ pub trait Event {
|
||||||
|
|
||||||
/// The events before this event.
|
/// The events before this event.
|
||||||
// Requires GATs to avoid boxing (and TAIT for making it convenient).
|
// Requires GATs to avoid boxing (and TAIT for making it convenient).
|
||||||
fn prev_events(&self) -> impl DoubleEndedIterator<Item = &Self::Id> + Send + '_;
|
fn prev_events(&self) -> impl DoubleEndedIterator<Item = &EventId> + Send + '_;
|
||||||
|
|
||||||
/// All the authenticating events for this event.
|
/// All the authenticating events for this event.
|
||||||
// Requires GATs to avoid boxing (and TAIT for making it convenient).
|
// Requires GATs to avoid boxing (and TAIT for making it convenient).
|
||||||
fn auth_events(&self) -> impl DoubleEndedIterator<Item = &Self::Id> + Send + '_;
|
fn auth_events(&self) -> impl DoubleEndedIterator<Item = &EventId> + Send + '_;
|
||||||
|
|
||||||
/// If this event is a redaction event this is the event it redacts.
|
/// If this event is a redaction event this is the event it redacts.
|
||||||
fn redacts(&self) -> Option<&Self::Id>;
|
fn redacts(&self) -> Option<&EventId>;
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<T: Event> Event for &T {
|
impl<T: Event> Event for &T {
|
||||||
type Id = T::Id;
|
fn event_id(&self) -> &EventId { (*self).event_id() }
|
||||||
|
|
||||||
fn event_id(&self) -> &Self::Id { (*self).event_id() }
|
|
||||||
|
|
||||||
fn room_id(&self) -> &RoomId { (*self).room_id() }
|
fn room_id(&self) -> &RoomId { (*self).room_id() }
|
||||||
|
|
||||||
|
@ -61,13 +51,13 @@ impl<T: Event> Event for &T {
|
||||||
|
|
||||||
fn state_key(&self) -> Option<&str> { (*self).state_key() }
|
fn state_key(&self) -> Option<&str> { (*self).state_key() }
|
||||||
|
|
||||||
fn prev_events(&self) -> impl DoubleEndedIterator<Item = &Self::Id> + Send + '_ {
|
fn prev_events(&self) -> impl DoubleEndedIterator<Item = &EventId> + Send + '_ {
|
||||||
(*self).prev_events()
|
(*self).prev_events()
|
||||||
}
|
}
|
||||||
|
|
||||||
fn auth_events(&self) -> impl DoubleEndedIterator<Item = &Self::Id> + Send + '_ {
|
fn auth_events(&self) -> impl DoubleEndedIterator<Item = &EventId> + Send + '_ {
|
||||||
(*self).auth_events()
|
(*self).auth_events()
|
||||||
}
|
}
|
||||||
|
|
||||||
fn redacts(&self) -> Option<&Self::Id> { (*self).redacts() }
|
fn redacts(&self) -> Option<&EventId> { (*self).redacts() }
|
||||||
}
|
}
|
||||||
|
|
|
@ -79,9 +79,7 @@ impl Pdu {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Event for Pdu {
|
impl Event for Pdu {
|
||||||
type Id = OwnedEventId;
|
fn event_id(&self) -> &EventId { &self.event_id }
|
||||||
|
|
||||||
fn event_id(&self) -> &Self::Id { &self.event_id }
|
|
||||||
|
|
||||||
fn room_id(&self) -> &RoomId { &self.room_id }
|
fn room_id(&self) -> &RoomId { &self.room_id }
|
||||||
|
|
||||||
|
@ -97,15 +95,15 @@ impl Event for Pdu {
|
||||||
|
|
||||||
fn state_key(&self) -> Option<&str> { self.state_key.as_deref() }
|
fn state_key(&self) -> Option<&str> { self.state_key.as_deref() }
|
||||||
|
|
||||||
fn prev_events(&self) -> impl DoubleEndedIterator<Item = &Self::Id> + Send + '_ {
|
fn prev_events(&self) -> impl DoubleEndedIterator<Item = &EventId> + Send + '_ {
|
||||||
self.prev_events.iter()
|
self.prev_events.iter().map(AsRef::as_ref)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn auth_events(&self) -> impl DoubleEndedIterator<Item = &Self::Id> + Send + '_ {
|
fn auth_events(&self) -> impl DoubleEndedIterator<Item = &EventId> + Send + '_ {
|
||||||
self.auth_events.iter()
|
self.auth_events.iter().map(AsRef::as_ref)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn redacts(&self) -> Option<&Self::Id> { self.redacts.as_ref() }
|
fn redacts(&self) -> Option<&EventId> { self.redacts.as_deref() }
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Prevent derived equality which wouldn't limit itself to event_id
|
/// Prevent derived equality which wouldn't limit itself to event_id
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
use ruma::{
|
use ruma::{
|
||||||
events::{
|
events::{
|
||||||
AnyEphemeralRoomEvent, AnyMessageLikeEvent, AnyStateEvent, AnyStrippedStateEvent,
|
AnyMessageLikeEvent, AnyStateEvent, AnyStrippedStateEvent, AnySyncStateEvent,
|
||||||
AnySyncStateEvent, AnySyncTimelineEvent, AnyTimelineEvent, StateEvent,
|
AnySyncTimelineEvent, AnyTimelineEvent, StateEvent, room::member::RoomMemberEventContent,
|
||||||
room::member::RoomMemberEventContent, space::child::HierarchySpaceChildEvent,
|
space::child::HierarchySpaceChildEvent,
|
||||||
},
|
},
|
||||||
serde::Raw,
|
serde::Raw,
|
||||||
};
|
};
|
||||||
|
@ -10,41 +10,6 @@ use serde_json::{json, value::Value as JsonValue};
|
||||||
|
|
||||||
use crate::implement;
|
use crate::implement;
|
||||||
|
|
||||||
/// This only works for events that are also AnyRoomEvents.
|
|
||||||
#[must_use]
|
|
||||||
#[implement(super::Pdu)]
|
|
||||||
pub fn into_any_event(self) -> Raw<AnyEphemeralRoomEvent> {
|
|
||||||
serde_json::from_value(self.into_any_event_value()).expect("Raw::from_value always works")
|
|
||||||
}
|
|
||||||
|
|
||||||
/// This only works for events that are also AnyRoomEvents.
|
|
||||||
#[implement(super::Pdu)]
|
|
||||||
#[must_use]
|
|
||||||
#[inline]
|
|
||||||
pub fn into_any_event_value(self) -> JsonValue {
|
|
||||||
let (redacts, content) = self.copy_redacts();
|
|
||||||
let mut json = json!({
|
|
||||||
"content": content,
|
|
||||||
"type": self.kind,
|
|
||||||
"event_id": self.event_id,
|
|
||||||
"sender": self.sender,
|
|
||||||
"origin_server_ts": self.origin_server_ts,
|
|
||||||
"room_id": self.room_id,
|
|
||||||
});
|
|
||||||
|
|
||||||
if let Some(unsigned) = &self.unsigned {
|
|
||||||
json["unsigned"] = json!(unsigned);
|
|
||||||
}
|
|
||||||
if let Some(state_key) = &self.state_key {
|
|
||||||
json["state_key"] = json!(state_key);
|
|
||||||
}
|
|
||||||
if let Some(redacts) = &redacts {
|
|
||||||
json["redacts"] = json!(redacts);
|
|
||||||
}
|
|
||||||
|
|
||||||
json
|
|
||||||
}
|
|
||||||
|
|
||||||
#[implement(super::Pdu)]
|
#[implement(super::Pdu)]
|
||||||
#[must_use]
|
#[must_use]
|
||||||
#[inline]
|
#[inline]
|
||||||
|
@ -53,7 +18,8 @@ pub fn into_room_event(self) -> Raw<AnyTimelineEvent> { self.to_room_event() }
|
||||||
#[implement(super::Pdu)]
|
#[implement(super::Pdu)]
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn to_room_event(&self) -> Raw<AnyTimelineEvent> {
|
pub fn to_room_event(&self) -> Raw<AnyTimelineEvent> {
|
||||||
serde_json::from_value(self.to_room_event_value()).expect("Raw::from_value always works")
|
let value = self.to_room_event_value();
|
||||||
|
serde_json::from_value(value).expect("Failed to serialize Event value")
|
||||||
}
|
}
|
||||||
|
|
||||||
#[implement(super::Pdu)]
|
#[implement(super::Pdu)]
|
||||||
|
@ -91,8 +57,8 @@ pub fn into_message_like_event(self) -> Raw<AnyMessageLikeEvent> { self.to_messa
|
||||||
#[implement(super::Pdu)]
|
#[implement(super::Pdu)]
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn to_message_like_event(&self) -> Raw<AnyMessageLikeEvent> {
|
pub fn to_message_like_event(&self) -> Raw<AnyMessageLikeEvent> {
|
||||||
serde_json::from_value(self.to_message_like_event_value())
|
let value = self.to_message_like_event_value();
|
||||||
.expect("Raw::from_value always works")
|
serde_json::from_value(value).expect("Failed to serialize Event value")
|
||||||
}
|
}
|
||||||
|
|
||||||
#[implement(super::Pdu)]
|
#[implement(super::Pdu)]
|
||||||
|
@ -130,7 +96,8 @@ pub fn into_sync_room_event(self) -> Raw<AnySyncTimelineEvent> { self.to_sync_ro
|
||||||
#[implement(super::Pdu)]
|
#[implement(super::Pdu)]
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn to_sync_room_event(&self) -> Raw<AnySyncTimelineEvent> {
|
pub fn to_sync_room_event(&self) -> Raw<AnySyncTimelineEvent> {
|
||||||
serde_json::from_value(self.to_sync_room_event_value()).expect("Raw::from_value always works")
|
let value = self.to_sync_room_event_value();
|
||||||
|
serde_json::from_value(value).expect("Failed to serialize Event value")
|
||||||
}
|
}
|
||||||
|
|
||||||
#[implement(super::Pdu)]
|
#[implement(super::Pdu)]
|
||||||
|
@ -162,7 +129,8 @@ pub fn to_sync_room_event_value(&self) -> JsonValue {
|
||||||
#[implement(super::Pdu)]
|
#[implement(super::Pdu)]
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn into_state_event(self) -> Raw<AnyStateEvent> {
|
pub fn into_state_event(self) -> Raw<AnyStateEvent> {
|
||||||
serde_json::from_value(self.into_state_event_value()).expect("Raw::from_value always works")
|
let value = self.into_state_event_value();
|
||||||
|
serde_json::from_value(value).expect("Failed to serialize Event value")
|
||||||
}
|
}
|
||||||
|
|
||||||
#[implement(super::Pdu)]
|
#[implement(super::Pdu)]
|
||||||
|
@ -189,8 +157,8 @@ pub fn into_state_event_value(self) -> JsonValue {
|
||||||
#[implement(super::Pdu)]
|
#[implement(super::Pdu)]
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn into_sync_state_event(self) -> Raw<AnySyncStateEvent> {
|
pub fn into_sync_state_event(self) -> Raw<AnySyncStateEvent> {
|
||||||
serde_json::from_value(self.into_sync_state_event_value())
|
let value = self.into_sync_state_event_value();
|
||||||
.expect("Raw::from_value always works")
|
serde_json::from_value(value).expect("Failed to serialize Event value")
|
||||||
}
|
}
|
||||||
|
|
||||||
#[implement(super::Pdu)]
|
#[implement(super::Pdu)]
|
||||||
|
@ -223,8 +191,8 @@ pub fn into_stripped_state_event(self) -> Raw<AnyStrippedStateEvent> {
|
||||||
#[implement(super::Pdu)]
|
#[implement(super::Pdu)]
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn to_stripped_state_event(&self) -> Raw<AnyStrippedStateEvent> {
|
pub fn to_stripped_state_event(&self) -> Raw<AnyStrippedStateEvent> {
|
||||||
serde_json::from_value(self.to_stripped_state_event_value())
|
let value = self.to_stripped_state_event_value();
|
||||||
.expect("Raw::from_value always works")
|
serde_json::from_value(value).expect("Failed to serialize Event value")
|
||||||
}
|
}
|
||||||
|
|
||||||
#[implement(super::Pdu)]
|
#[implement(super::Pdu)]
|
||||||
|
@ -242,8 +210,8 @@ pub fn to_stripped_state_event_value(&self) -> JsonValue {
|
||||||
#[implement(super::Pdu)]
|
#[implement(super::Pdu)]
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn into_stripped_spacechild_state_event(self) -> Raw<HierarchySpaceChildEvent> {
|
pub fn into_stripped_spacechild_state_event(self) -> Raw<HierarchySpaceChildEvent> {
|
||||||
serde_json::from_value(self.into_stripped_spacechild_state_event_value())
|
let value = self.into_stripped_spacechild_state_event_value();
|
||||||
.expect("Raw::from_value always works")
|
serde_json::from_value(value).expect("Failed to serialize Event value")
|
||||||
}
|
}
|
||||||
|
|
||||||
#[implement(super::Pdu)]
|
#[implement(super::Pdu)]
|
||||||
|
@ -262,7 +230,8 @@ pub fn into_stripped_spacechild_state_event_value(self) -> JsonValue {
|
||||||
#[implement(super::Pdu)]
|
#[implement(super::Pdu)]
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn into_member_event(self) -> Raw<StateEvent<RoomMemberEventContent>> {
|
pub fn into_member_event(self) -> Raw<StateEvent<RoomMemberEventContent>> {
|
||||||
serde_json::from_value(self.into_member_event_value()).expect("Raw::from_value always works")
|
let value = self.into_member_event_value();
|
||||||
|
serde_json::from_value(value).expect("Failed to serialize Event value")
|
||||||
}
|
}
|
||||||
|
|
||||||
#[implement(super::Pdu)]
|
#[implement(super::Pdu)]
|
||||||
|
|
|
@ -52,7 +52,6 @@ fn lexico_topo_sort(c: &mut test::Bencher) {
|
||||||
#[cfg(conduwuit_bench)]
|
#[cfg(conduwuit_bench)]
|
||||||
#[cfg_attr(conduwuit_bench, bench)]
|
#[cfg_attr(conduwuit_bench, bench)]
|
||||||
fn resolution_shallow_auth_chain(c: &mut test::Bencher) {
|
fn resolution_shallow_auth_chain(c: &mut test::Bencher) {
|
||||||
let parallel_fetches = 32;
|
|
||||||
let mut store = TestStore(hashmap! {});
|
let mut store = TestStore(hashmap! {});
|
||||||
|
|
||||||
// build up the DAG
|
// build up the DAG
|
||||||
|
@ -78,7 +77,6 @@ fn resolution_shallow_auth_chain(c: &mut test::Bencher) {
|
||||||
&auth_chain_sets,
|
&auth_chain_sets,
|
||||||
&fetch,
|
&fetch,
|
||||||
&exists,
|
&exists,
|
||||||
parallel_fetches,
|
|
||||||
)
|
)
|
||||||
.await
|
.await
|
||||||
{
|
{
|
||||||
|
@ -91,7 +89,6 @@ fn resolution_shallow_auth_chain(c: &mut test::Bencher) {
|
||||||
#[cfg(conduwuit_bench)]
|
#[cfg(conduwuit_bench)]
|
||||||
#[cfg_attr(conduwuit_bench, bench)]
|
#[cfg_attr(conduwuit_bench, bench)]
|
||||||
fn resolve_deeper_event_set(c: &mut test::Bencher) {
|
fn resolve_deeper_event_set(c: &mut test::Bencher) {
|
||||||
let parallel_fetches = 32;
|
|
||||||
let mut inner = INITIAL_EVENTS();
|
let mut inner = INITIAL_EVENTS();
|
||||||
let ban = BAN_STATE_SET();
|
let ban = BAN_STATE_SET();
|
||||||
|
|
||||||
|
@ -153,7 +150,6 @@ fn resolve_deeper_event_set(c: &mut test::Bencher) {
|
||||||
&auth_chain_sets,
|
&auth_chain_sets,
|
||||||
&fetch,
|
&fetch,
|
||||||
&exists,
|
&exists,
|
||||||
parallel_fetches,
|
|
||||||
)
|
)
|
||||||
.await
|
.await
|
||||||
{
|
{
|
||||||
|
@ -190,7 +186,11 @@ impl<E: Event + Clone> TestStore<E> {
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns a Vec of the related auth events to the given `event`.
|
/// Returns a Vec of the related auth events to the given `event`.
|
||||||
fn auth_event_ids(&self, room_id: &RoomId, event_ids: Vec<E::Id>) -> Result<HashSet<E::Id>> {
|
fn auth_event_ids(
|
||||||
|
&self,
|
||||||
|
room_id: &RoomId,
|
||||||
|
event_ids: Vec<OwnedEventId>,
|
||||||
|
) -> Result<HashSet<OwnedEventId>> {
|
||||||
let mut result = HashSet::new();
|
let mut result = HashSet::new();
|
||||||
let mut stack = event_ids;
|
let mut stack = event_ids;
|
||||||
|
|
||||||
|
@ -216,8 +216,8 @@ impl<E: Event + Clone> TestStore<E> {
|
||||||
fn auth_chain_diff(
|
fn auth_chain_diff(
|
||||||
&self,
|
&self,
|
||||||
room_id: &RoomId,
|
room_id: &RoomId,
|
||||||
event_ids: Vec<Vec<E::Id>>,
|
event_ids: Vec<Vec<OwnedEventId>>,
|
||||||
) -> Result<Vec<E::Id>> {
|
) -> Result<Vec<OwnedEventId>> {
|
||||||
let mut auth_chain_sets = vec![];
|
let mut auth_chain_sets = vec![];
|
||||||
for ids in event_ids {
|
for ids in event_ids {
|
||||||
// TODO state store `auth_event_ids` returns self in the event ids list
|
// TODO state store `auth_event_ids` returns self in the event ids list
|
||||||
|
@ -238,7 +238,7 @@ impl<E: Event + Clone> TestStore<E> {
|
||||||
Ok(auth_chain_sets
|
Ok(auth_chain_sets
|
||||||
.into_iter()
|
.into_iter()
|
||||||
.flatten()
|
.flatten()
|
||||||
.filter(|id| !common.contains(id.borrow()))
|
.filter(|id| !common.contains(id))
|
||||||
.collect())
|
.collect())
|
||||||
} else {
|
} else {
|
||||||
Ok(vec![])
|
Ok(vec![])
|
||||||
|
@ -565,7 +565,7 @@ impl EventTypeExt for &TimelineEventType {
|
||||||
|
|
||||||
mod event {
|
mod event {
|
||||||
use ruma::{
|
use ruma::{
|
||||||
MilliSecondsSinceUnixEpoch, OwnedEventId, RoomId, UserId,
|
EventId, MilliSecondsSinceUnixEpoch, OwnedEventId, RoomId, UserId,
|
||||||
events::{TimelineEventType, pdu::Pdu},
|
events::{TimelineEventType, pdu::Pdu},
|
||||||
};
|
};
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
|
@ -574,9 +574,7 @@ mod event {
|
||||||
use super::Event;
|
use super::Event;
|
||||||
|
|
||||||
impl Event for PduEvent {
|
impl Event for PduEvent {
|
||||||
type Id = OwnedEventId;
|
fn event_id(&self) -> &EventId { &self.event_id }
|
||||||
|
|
||||||
fn event_id(&self) -> &Self::Id { &self.event_id }
|
|
||||||
|
|
||||||
fn room_id(&self) -> &RoomId {
|
fn room_id(&self) -> &RoomId {
|
||||||
match &self.rest {
|
match &self.rest {
|
||||||
|
@ -632,28 +630,30 @@ mod event {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn prev_events(&self) -> Box<dyn DoubleEndedIterator<Item = &Self::Id> + Send + '_> {
|
fn prev_events(&self) -> Box<dyn DoubleEndedIterator<Item = &EventId> + Send + '_> {
|
||||||
match &self.rest {
|
match &self.rest {
|
||||||
| Pdu::RoomV1Pdu(ev) => Box::new(ev.prev_events.iter().map(|(id, _)| id)),
|
| Pdu::RoomV1Pdu(ev) =>
|
||||||
| Pdu::RoomV3Pdu(ev) => Box::new(ev.prev_events.iter()),
|
Box::new(ev.prev_events.iter().map(|(id, _)| id.as_ref())),
|
||||||
|
| Pdu::RoomV3Pdu(ev) => Box::new(ev.prev_events.iter().map(AsRef::as_ref)),
|
||||||
#[cfg(not(feature = "unstable-exhaustive-types"))]
|
#[cfg(not(feature = "unstable-exhaustive-types"))]
|
||||||
| _ => unreachable!("new PDU version"),
|
| _ => unreachable!("new PDU version"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn auth_events(&self) -> Box<dyn DoubleEndedIterator<Item = &Self::Id> + Send + '_> {
|
fn auth_events(&self) -> Box<dyn DoubleEndedIterator<Item = &EventId> + Send + '_> {
|
||||||
match &self.rest {
|
match &self.rest {
|
||||||
| Pdu::RoomV1Pdu(ev) => Box::new(ev.auth_events.iter().map(|(id, _)| id)),
|
| Pdu::RoomV1Pdu(ev) =>
|
||||||
| Pdu::RoomV3Pdu(ev) => Box::new(ev.auth_events.iter()),
|
Box::new(ev.auth_events.iter().map(|(id, _)| id.as_ref())),
|
||||||
|
| Pdu::RoomV3Pdu(ev) => Box::new(ev.auth_events.iter().map(AsRef::as_ref)),
|
||||||
#[cfg(not(feature = "unstable-exhaustive-types"))]
|
#[cfg(not(feature = "unstable-exhaustive-types"))]
|
||||||
| _ => unreachable!("new PDU version"),
|
| _ => unreachable!("new PDU version"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn redacts(&self) -> Option<&Self::Id> {
|
fn redacts(&self) -> Option<&EventId> {
|
||||||
match &self.rest {
|
match &self.rest {
|
||||||
| Pdu::RoomV1Pdu(ev) => ev.redacts.as_ref(),
|
| Pdu::RoomV1Pdu(ev) => ev.redacts.as_deref(),
|
||||||
| Pdu::RoomV3Pdu(ev) => ev.redacts.as_ref(),
|
| Pdu::RoomV3Pdu(ev) => ev.redacts.as_deref(),
|
||||||
#[cfg(not(feature = "unstable-exhaustive-types"))]
|
#[cfg(not(feature = "unstable-exhaustive-types"))]
|
||||||
| _ => unreachable!("new PDU version"),
|
| _ => unreachable!("new PDU version"),
|
||||||
}
|
}
|
||||||
|
|
|
@ -38,7 +38,7 @@ struct GetMembership {
|
||||||
membership: MembershipState,
|
membership: MembershipState,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Deserialize)]
|
#[derive(Deserialize, Debug)]
|
||||||
struct RoomMemberContentFields {
|
struct RoomMemberContentFields {
|
||||||
membership: Option<Raw<MembershipState>>,
|
membership: Option<Raw<MembershipState>>,
|
||||||
join_authorised_via_users_server: Option<Raw<OwnedUserId>>,
|
join_authorised_via_users_server: Option<Raw<OwnedUserId>>,
|
||||||
|
@ -133,7 +133,7 @@ pub fn auth_types_for_event(
|
||||||
level = "debug",
|
level = "debug",
|
||||||
skip_all,
|
skip_all,
|
||||||
fields(
|
fields(
|
||||||
event_id = incoming_event.event_id().borrow().as_str()
|
event_id = incoming_event.event_id().as_str(),
|
||||||
)
|
)
|
||||||
)]
|
)]
|
||||||
pub async fn auth_check<F, Fut, Fetched, Incoming>(
|
pub async fn auth_check<F, Fut, Fetched, Incoming>(
|
||||||
|
@ -149,9 +149,9 @@ where
|
||||||
Incoming: Event + Send + Sync,
|
Incoming: Event + Send + Sync,
|
||||||
{
|
{
|
||||||
debug!(
|
debug!(
|
||||||
"auth_check beginning for {} ({})",
|
event_id = format!("{}", incoming_event.event_id()),
|
||||||
incoming_event.event_id(),
|
event_type = format!("{}", incoming_event.event_type()),
|
||||||
incoming_event.event_type()
|
"auth_check beginning"
|
||||||
);
|
);
|
||||||
|
|
||||||
// [synapse] check that all the events are in the same room as `incoming_event`
|
// [synapse] check that all the events are in the same room as `incoming_event`
|
||||||
|
@ -259,7 +259,7 @@ where
|
||||||
// 3. If event does not have m.room.create in auth_events reject
|
// 3. If event does not have m.room.create in auth_events reject
|
||||||
if !incoming_event
|
if !incoming_event
|
||||||
.auth_events()
|
.auth_events()
|
||||||
.any(|id| id.borrow() == room_create_event.event_id().borrow())
|
.any(|id| id == room_create_event.event_id())
|
||||||
{
|
{
|
||||||
warn!("no m.room.create event in auth events");
|
warn!("no m.room.create event in auth events");
|
||||||
return Ok(false);
|
return Ok(false);
|
||||||
|
@ -383,10 +383,15 @@ where
|
||||||
|
|
||||||
let sender_membership_event_content: RoomMemberContentFields =
|
let sender_membership_event_content: RoomMemberContentFields =
|
||||||
from_json_str(sender_member_event.content().get())?;
|
from_json_str(sender_member_event.content().get())?;
|
||||||
let membership_state = sender_membership_event_content
|
let Some(membership_state) = sender_membership_event_content.membership else {
|
||||||
.membership
|
warn!(
|
||||||
.expect("we should test before that this field exists")
|
sender_membership_event_content = format!("{sender_membership_event_content:?}"),
|
||||||
.deserialize()?;
|
event_id = format!("{}", incoming_event.event_id()),
|
||||||
|
"Sender membership event content missing membership field"
|
||||||
|
);
|
||||||
|
return Err(Error::InvalidPdu("Missing membership field".to_owned()));
|
||||||
|
};
|
||||||
|
let membership_state = membership_state.deserialize()?;
|
||||||
|
|
||||||
if !matches!(membership_state, MembershipState::Join) {
|
if !matches!(membership_state, MembershipState::Join) {
|
||||||
warn!("sender's membership is not join");
|
warn!("sender's membership is not join");
|
||||||
|
@ -633,7 +638,7 @@ fn valid_membership_change(
|
||||||
warn!(?target_user_membership_event_id, "Banned user can't join");
|
warn!(?target_user_membership_event_id, "Banned user can't join");
|
||||||
false
|
false
|
||||||
} else if (join_rules == JoinRule::Invite
|
} else if (join_rules == JoinRule::Invite
|
||||||
|| room_version.allow_knocking && join_rules == JoinRule::Knock)
|
|| room_version.allow_knocking && (join_rules == JoinRule::Knock || matches!(join_rules, JoinRule::KnockRestricted(_))))
|
||||||
// If the join_rule is invite then allow if membership state is invite or join
|
// If the join_rule is invite then allow if membership state is invite or join
|
||||||
&& (target_user_current_membership == MembershipState::Join
|
&& (target_user_current_membership == MembershipState::Join
|
||||||
|| target_user_current_membership == MembershipState::Invite)
|
|| target_user_current_membership == MembershipState::Invite)
|
||||||
|
@ -1016,11 +1021,11 @@ fn check_redaction(
|
||||||
|
|
||||||
// If the domain of the event_id of the event being redacted is the same as the
|
// If the domain of the event_id of the event being redacted is the same as the
|
||||||
// domain of the event_id of the m.room.redaction, allow
|
// domain of the event_id of the m.room.redaction, allow
|
||||||
if redaction_event.event_id().borrow().server_name()
|
if redaction_event.event_id().server_name()
|
||||||
== redaction_event
|
== redaction_event
|
||||||
.redacts()
|
.redacts()
|
||||||
.as_ref()
|
.as_ref()
|
||||||
.and_then(|&id| id.borrow().server_name())
|
.and_then(|&id| id.server_name())
|
||||||
{
|
{
|
||||||
debug!("redaction event allowed via room version 1 rules");
|
debug!("redaction event allowed via room version 1 rules");
|
||||||
return Ok(true);
|
return Ok(true);
|
||||||
|
|
|
@ -20,7 +20,7 @@ use std::{
|
||||||
|
|
||||||
use futures::{Future, FutureExt, Stream, StreamExt, TryFutureExt, TryStreamExt, future};
|
use futures::{Future, FutureExt, Stream, StreamExt, TryFutureExt, TryStreamExt, future};
|
||||||
use ruma::{
|
use ruma::{
|
||||||
EventId, Int, MilliSecondsSinceUnixEpoch, RoomVersionId,
|
EventId, Int, MilliSecondsSinceUnixEpoch, OwnedEventId, RoomVersionId,
|
||||||
events::{
|
events::{
|
||||||
StateEventType, TimelineEventType,
|
StateEventType, TimelineEventType,
|
||||||
room::member::{MembershipState, RoomMemberEventContent},
|
room::member::{MembershipState, RoomMemberEventContent},
|
||||||
|
@ -39,9 +39,7 @@ use crate::{
|
||||||
debug, debug_error,
|
debug, debug_error,
|
||||||
matrix::{event::Event, pdu::StateKey},
|
matrix::{event::Event, pdu::StateKey},
|
||||||
trace,
|
trace,
|
||||||
utils::stream::{
|
utils::stream::{BroadbandExt, IterStream, ReadyExt, TryBroadbandExt, WidebandExt},
|
||||||
BroadbandExt, IterStream, ReadyExt, TryBroadbandExt, TryReadyExt, WidebandExt,
|
|
||||||
},
|
|
||||||
warn,
|
warn,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
@ -69,9 +67,6 @@ type Result<T, E = Error> = crate::Result<T, E>;
|
||||||
/// * `event_fetch` - Any event not found in the `event_map` will defer to this
|
/// * `event_fetch` - Any event not found in the `event_map` will defer to this
|
||||||
/// closure to find the event.
|
/// closure to find the event.
|
||||||
///
|
///
|
||||||
/// * `parallel_fetches` - The number of asynchronous fetch requests in-flight
|
|
||||||
/// for any given operation.
|
|
||||||
///
|
|
||||||
/// ## Invariants
|
/// ## Invariants
|
||||||
///
|
///
|
||||||
/// The caller of `resolve` must ensure that all the events are from the same
|
/// The caller of `resolve` must ensure that all the events are from the same
|
||||||
|
@ -82,21 +77,19 @@ type Result<T, E = Error> = crate::Result<T, E>;
|
||||||
pub async fn resolve<'a, E, Sets, SetIter, Hasher, Fetch, FetchFut, Exists, ExistsFut>(
|
pub async fn resolve<'a, E, Sets, SetIter, Hasher, Fetch, FetchFut, Exists, ExistsFut>(
|
||||||
room_version: &RoomVersionId,
|
room_version: &RoomVersionId,
|
||||||
state_sets: Sets,
|
state_sets: Sets,
|
||||||
auth_chain_sets: &'a [HashSet<E::Id, Hasher>],
|
auth_chain_sets: &'a [HashSet<OwnedEventId, Hasher>],
|
||||||
event_fetch: &Fetch,
|
event_fetch: &Fetch,
|
||||||
event_exists: &Exists,
|
event_exists: &Exists,
|
||||||
parallel_fetches: usize,
|
) -> Result<StateMap<OwnedEventId>>
|
||||||
) -> Result<StateMap<E::Id>>
|
|
||||||
where
|
where
|
||||||
Fetch: Fn(E::Id) -> FetchFut + Sync,
|
Fetch: Fn(OwnedEventId) -> FetchFut + Sync,
|
||||||
FetchFut: Future<Output = Option<E>> + Send,
|
FetchFut: Future<Output = Option<E>> + Send,
|
||||||
Exists: Fn(E::Id) -> ExistsFut + Sync,
|
Exists: Fn(OwnedEventId) -> ExistsFut + Sync,
|
||||||
ExistsFut: Future<Output = bool> + Send,
|
ExistsFut: Future<Output = bool> + Send,
|
||||||
Sets: IntoIterator<IntoIter = SetIter> + Send,
|
Sets: IntoIterator<IntoIter = SetIter> + Send,
|
||||||
SetIter: Iterator<Item = &'a StateMap<E::Id>> + Clone + Send,
|
SetIter: Iterator<Item = &'a StateMap<OwnedEventId>> + Clone + Send,
|
||||||
Hasher: BuildHasher + Send + Sync,
|
Hasher: BuildHasher + Send + Sync,
|
||||||
E: Event + Clone + Send + Sync,
|
E: Event + Clone + Send + Sync,
|
||||||
E::Id: Borrow<EventId> + Send + Sync,
|
|
||||||
for<'b> &'b E: Send,
|
for<'b> &'b E: Send,
|
||||||
{
|
{
|
||||||
debug!("State resolution starting");
|
debug!("State resolution starting");
|
||||||
|
@ -147,13 +140,8 @@ where
|
||||||
|
|
||||||
// Sort the control events based on power_level/clock/event_id and
|
// Sort the control events based on power_level/clock/event_id and
|
||||||
// outgoing/incoming edges
|
// outgoing/incoming edges
|
||||||
let sorted_control_levels = reverse_topological_power_sort(
|
let sorted_control_levels =
|
||||||
control_events,
|
reverse_topological_power_sort(control_events, &all_conflicted, &event_fetch).await?;
|
||||||
&all_conflicted,
|
|
||||||
&event_fetch,
|
|
||||||
parallel_fetches,
|
|
||||||
)
|
|
||||||
.await?;
|
|
||||||
|
|
||||||
debug!(count = sorted_control_levels.len(), "power events");
|
debug!(count = sorted_control_levels.len(), "power events");
|
||||||
trace!(list = ?sorted_control_levels, "sorted power events");
|
trace!(list = ?sorted_control_levels, "sorted power events");
|
||||||
|
@ -162,7 +150,7 @@ where
|
||||||
// Sequentially auth check each control event.
|
// Sequentially auth check each control event.
|
||||||
let resolved_control = iterative_auth_check(
|
let resolved_control = iterative_auth_check(
|
||||||
&room_version,
|
&room_version,
|
||||||
sorted_control_levels.iter().stream(),
|
sorted_control_levels.iter().stream().map(AsRef::as_ref),
|
||||||
clean.clone(),
|
clean.clone(),
|
||||||
&event_fetch,
|
&event_fetch,
|
||||||
)
|
)
|
||||||
|
@ -179,7 +167,7 @@ where
|
||||||
// that failed auth
|
// that failed auth
|
||||||
let events_to_resolve: Vec<_> = all_conflicted
|
let events_to_resolve: Vec<_> = all_conflicted
|
||||||
.iter()
|
.iter()
|
||||||
.filter(|&id| !deduped_power_ev.contains(id.borrow()))
|
.filter(|&id| !deduped_power_ev.contains(id))
|
||||||
.cloned()
|
.cloned()
|
||||||
.collect();
|
.collect();
|
||||||
|
|
||||||
|
@ -199,7 +187,7 @@ where
|
||||||
|
|
||||||
let mut resolved_state = iterative_auth_check(
|
let mut resolved_state = iterative_auth_check(
|
||||||
&room_version,
|
&room_version,
|
||||||
sorted_left_events.iter().stream(),
|
sorted_left_events.iter().stream().map(AsRef::as_ref),
|
||||||
resolved_control, // The control events are added to the final resolved state
|
resolved_control, // The control events are added to the final resolved state
|
||||||
&event_fetch,
|
&event_fetch,
|
||||||
)
|
)
|
||||||
|
@ -292,16 +280,14 @@ where
|
||||||
/// earlier (further back in time) origin server timestamp.
|
/// earlier (further back in time) origin server timestamp.
|
||||||
#[tracing::instrument(level = "debug", skip_all)]
|
#[tracing::instrument(level = "debug", skip_all)]
|
||||||
async fn reverse_topological_power_sort<E, F, Fut>(
|
async fn reverse_topological_power_sort<E, F, Fut>(
|
||||||
events_to_sort: Vec<E::Id>,
|
events_to_sort: Vec<OwnedEventId>,
|
||||||
auth_diff: &HashSet<E::Id>,
|
auth_diff: &HashSet<OwnedEventId>,
|
||||||
fetch_event: &F,
|
fetch_event: &F,
|
||||||
parallel_fetches: usize,
|
) -> Result<Vec<OwnedEventId>>
|
||||||
) -> Result<Vec<E::Id>>
|
|
||||||
where
|
where
|
||||||
F: Fn(E::Id) -> Fut + Sync,
|
F: Fn(OwnedEventId) -> Fut + Sync,
|
||||||
Fut: Future<Output = Option<E>> + Send,
|
Fut: Future<Output = Option<E>> + Send,
|
||||||
E: Event + Send + Sync,
|
E: Event + Send + Sync,
|
||||||
E::Id: Borrow<EventId> + Send + Sync,
|
|
||||||
{
|
{
|
||||||
debug!("reverse topological sort of power events");
|
debug!("reverse topological sort of power events");
|
||||||
|
|
||||||
|
@ -311,35 +297,36 @@ where
|
||||||
}
|
}
|
||||||
|
|
||||||
// This is used in the `key_fn` passed to the lexico_topo_sort fn
|
// This is used in the `key_fn` passed to the lexico_topo_sort fn
|
||||||
let event_to_pl = graph
|
let event_to_pl: HashMap<_, _> = graph
|
||||||
.keys()
|
.keys()
|
||||||
|
.cloned()
|
||||||
.stream()
|
.stream()
|
||||||
.map(|event_id| {
|
.broad_filter_map(async |event_id| {
|
||||||
get_power_level_for_sender(event_id.clone(), fetch_event)
|
let pl = get_power_level_for_sender(&event_id, fetch_event)
|
||||||
.map(move |res| res.map(|pl| (event_id, pl)))
|
.await
|
||||||
|
.ok()?;
|
||||||
|
Some((event_id, pl))
|
||||||
})
|
})
|
||||||
.buffer_unordered(parallel_fetches)
|
.inspect(|(event_id, pl)| {
|
||||||
.ready_try_fold(HashMap::new(), |mut event_to_pl, (event_id, pl)| {
|
|
||||||
debug!(
|
debug!(
|
||||||
event_id = event_id.borrow().as_str(),
|
event_id = event_id.as_str(),
|
||||||
power_level = i64::from(pl),
|
power_level = i64::from(*pl),
|
||||||
"found the power level of an event's sender",
|
"found the power level of an event's sender",
|
||||||
);
|
);
|
||||||
|
|
||||||
event_to_pl.insert(event_id.clone(), pl);
|
|
||||||
Ok(event_to_pl)
|
|
||||||
})
|
})
|
||||||
|
.collect()
|
||||||
.boxed()
|
.boxed()
|
||||||
.await?;
|
.await;
|
||||||
|
|
||||||
let event_to_pl = &event_to_pl;
|
let fetcher = async |event_id: OwnedEventId| {
|
||||||
let fetcher = |event_id: E::Id| async move {
|
|
||||||
let pl = *event_to_pl
|
let pl = *event_to_pl
|
||||||
.get(event_id.borrow())
|
.get(&event_id)
|
||||||
.ok_or_else(|| Error::NotFound(String::new()))?;
|
.ok_or_else(|| Error::NotFound(String::new()))?;
|
||||||
|
|
||||||
let ev = fetch_event(event_id)
|
let ev = fetch_event(event_id)
|
||||||
.await
|
.await
|
||||||
.ok_or_else(|| Error::NotFound(String::new()))?;
|
.ok_or_else(|| Error::NotFound(String::new()))?;
|
||||||
|
|
||||||
Ok((pl, ev.origin_server_ts()))
|
Ok((pl, ev.origin_server_ts()))
|
||||||
};
|
};
|
||||||
|
|
||||||
|
@ -476,18 +463,17 @@ where
|
||||||
/// the eventId at the eventId's generation (we walk backwards to `EventId`s
|
/// the eventId at the eventId's generation (we walk backwards to `EventId`s
|
||||||
/// most recent previous power level event).
|
/// most recent previous power level event).
|
||||||
async fn get_power_level_for_sender<E, F, Fut>(
|
async fn get_power_level_for_sender<E, F, Fut>(
|
||||||
event_id: E::Id,
|
event_id: &EventId,
|
||||||
fetch_event: &F,
|
fetch_event: &F,
|
||||||
) -> serde_json::Result<Int>
|
) -> serde_json::Result<Int>
|
||||||
where
|
where
|
||||||
F: Fn(E::Id) -> Fut + Sync,
|
F: Fn(OwnedEventId) -> Fut + Sync,
|
||||||
Fut: Future<Output = Option<E>> + Send,
|
Fut: Future<Output = Option<E>> + Send,
|
||||||
E: Event + Send,
|
E: Event + Send,
|
||||||
E::Id: Borrow<EventId> + Send,
|
|
||||||
{
|
{
|
||||||
debug!("fetch event ({event_id}) senders power level");
|
debug!("fetch event ({event_id}) senders power level");
|
||||||
|
|
||||||
let event = fetch_event(event_id).await;
|
let event = fetch_event(event_id.to_owned()).await;
|
||||||
|
|
||||||
let auth_events = event.as_ref().map(Event::auth_events);
|
let auth_events = event.as_ref().map(Event::auth_events);
|
||||||
|
|
||||||
|
@ -495,7 +481,7 @@ where
|
||||||
.into_iter()
|
.into_iter()
|
||||||
.flatten()
|
.flatten()
|
||||||
.stream()
|
.stream()
|
||||||
.broadn_filter_map(5, |aid| fetch_event(aid.clone()))
|
.broadn_filter_map(5, |aid| fetch_event(aid.to_owned()))
|
||||||
.ready_find(|aev| is_type_and_key(aev, &TimelineEventType::RoomPowerLevels, ""))
|
.ready_find(|aev| is_type_and_key(aev, &TimelineEventType::RoomPowerLevels, ""))
|
||||||
.await;
|
.await;
|
||||||
|
|
||||||
|
@ -528,14 +514,13 @@ where
|
||||||
async fn iterative_auth_check<'a, E, F, Fut, S>(
|
async fn iterative_auth_check<'a, E, F, Fut, S>(
|
||||||
room_version: &RoomVersion,
|
room_version: &RoomVersion,
|
||||||
events_to_check: S,
|
events_to_check: S,
|
||||||
unconflicted_state: StateMap<E::Id>,
|
unconflicted_state: StateMap<OwnedEventId>,
|
||||||
fetch_event: &F,
|
fetch_event: &F,
|
||||||
) -> Result<StateMap<E::Id>>
|
) -> Result<StateMap<OwnedEventId>>
|
||||||
where
|
where
|
||||||
F: Fn(E::Id) -> Fut + Sync,
|
F: Fn(OwnedEventId) -> Fut + Sync,
|
||||||
Fut: Future<Output = Option<E>> + Send,
|
Fut: Future<Output = Option<E>> + Send,
|
||||||
E::Id: Borrow<EventId> + Clone + Eq + Ord + Send + Sync + 'a,
|
S: Stream<Item = &'a EventId> + Send + 'a,
|
||||||
S: Stream<Item = &'a E::Id> + Send + 'a,
|
|
||||||
E: Event + Clone + Send + Sync,
|
E: Event + Clone + Send + Sync,
|
||||||
{
|
{
|
||||||
debug!("starting iterative auth check");
|
debug!("starting iterative auth check");
|
||||||
|
@ -543,7 +528,7 @@ where
|
||||||
let events_to_check: Vec<_> = events_to_check
|
let events_to_check: Vec<_> = events_to_check
|
||||||
.map(Result::Ok)
|
.map(Result::Ok)
|
||||||
.broad_and_then(async |event_id| {
|
.broad_and_then(async |event_id| {
|
||||||
fetch_event(event_id.clone())
|
fetch_event(event_id.to_owned())
|
||||||
.await
|
.await
|
||||||
.ok_or_else(|| Error::NotFound(format!("Failed to find {event_id}")))
|
.ok_or_else(|| Error::NotFound(format!("Failed to find {event_id}")))
|
||||||
})
|
})
|
||||||
|
@ -551,16 +536,16 @@ where
|
||||||
.boxed()
|
.boxed()
|
||||||
.await?;
|
.await?;
|
||||||
|
|
||||||
let auth_event_ids: HashSet<E::Id> = events_to_check
|
let auth_event_ids: HashSet<OwnedEventId> = events_to_check
|
||||||
.iter()
|
.iter()
|
||||||
.flat_map(|event: &E| event.auth_events().map(Clone::clone))
|
.flat_map(|event: &E| event.auth_events().map(ToOwned::to_owned))
|
||||||
.collect();
|
.collect();
|
||||||
|
|
||||||
let auth_events: HashMap<E::Id, E> = auth_event_ids
|
let auth_events: HashMap<OwnedEventId, E> = auth_event_ids
|
||||||
.into_iter()
|
.into_iter()
|
||||||
.stream()
|
.stream()
|
||||||
.broad_filter_map(fetch_event)
|
.broad_filter_map(fetch_event)
|
||||||
.map(|auth_event| (auth_event.event_id().clone(), auth_event))
|
.map(|auth_event| (auth_event.event_id().to_owned(), auth_event))
|
||||||
.collect()
|
.collect()
|
||||||
.boxed()
|
.boxed()
|
||||||
.await;
|
.await;
|
||||||
|
@ -581,7 +566,7 @@ where
|
||||||
|
|
||||||
let mut auth_state = StateMap::new();
|
let mut auth_state = StateMap::new();
|
||||||
for aid in event.auth_events() {
|
for aid in event.auth_events() {
|
||||||
if let Some(ev) = auth_events.get(aid.borrow()) {
|
if let Some(ev) = auth_events.get(aid) {
|
||||||
//TODO: synapse checks "rejected_reason" which is most likely related to
|
//TODO: synapse checks "rejected_reason" which is most likely related to
|
||||||
// soft-failing
|
// soft-failing
|
||||||
auth_state.insert(
|
auth_state.insert(
|
||||||
|
@ -592,7 +577,7 @@ where
|
||||||
ev.clone(),
|
ev.clone(),
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
warn!(event_id = aid.borrow().as_str(), "missing auth event");
|
warn!(event_id = aid.as_str(), "missing auth event");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -601,7 +586,7 @@ where
|
||||||
.stream()
|
.stream()
|
||||||
.ready_filter_map(|key| Some((key, resolved_state.get(key)?)))
|
.ready_filter_map(|key| Some((key, resolved_state.get(key)?)))
|
||||||
.filter_map(|(key, ev_id)| async move {
|
.filter_map(|(key, ev_id)| async move {
|
||||||
if let Some(event) = auth_events.get(ev_id.borrow()) {
|
if let Some(event) = auth_events.get(ev_id) {
|
||||||
Some((key, event.clone()))
|
Some((key, event.clone()))
|
||||||
} else {
|
} else {
|
||||||
Some((key, fetch_event(ev_id.clone()).await?))
|
Some((key, fetch_event(ev_id.clone()).await?))
|
||||||
|
@ -633,7 +618,7 @@ where
|
||||||
// add event to resolved state map
|
// add event to resolved state map
|
||||||
resolved_state.insert(
|
resolved_state.insert(
|
||||||
event.event_type().with_state_key(state_key),
|
event.event_type().with_state_key(state_key),
|
||||||
event.event_id().clone(),
|
event.event_id().to_owned(),
|
||||||
);
|
);
|
||||||
},
|
},
|
||||||
| Ok(false) => {
|
| Ok(false) => {
|
||||||
|
@ -660,15 +645,14 @@ where
|
||||||
/// level as a parent) will be marked as depth 1. depth 1 is "older" than depth
|
/// level as a parent) will be marked as depth 1. depth 1 is "older" than depth
|
||||||
/// 0.
|
/// 0.
|
||||||
async fn mainline_sort<E, F, Fut>(
|
async fn mainline_sort<E, F, Fut>(
|
||||||
to_sort: &[E::Id],
|
to_sort: &[OwnedEventId],
|
||||||
resolved_power_level: Option<E::Id>,
|
resolved_power_level: Option<OwnedEventId>,
|
||||||
fetch_event: &F,
|
fetch_event: &F,
|
||||||
) -> Result<Vec<E::Id>>
|
) -> Result<Vec<OwnedEventId>>
|
||||||
where
|
where
|
||||||
F: Fn(E::Id) -> Fut + Sync,
|
F: Fn(OwnedEventId) -> Fut + Sync,
|
||||||
Fut: Future<Output = Option<E>> + Send,
|
Fut: Future<Output = Option<E>> + Send,
|
||||||
E: Event + Clone + Send + Sync,
|
E: Event + Clone + Send + Sync,
|
||||||
E::Id: Borrow<EventId> + Clone + Send + Sync,
|
|
||||||
{
|
{
|
||||||
debug!("mainline sort of events");
|
debug!("mainline sort of events");
|
||||||
|
|
||||||
|
@ -688,7 +672,7 @@ where
|
||||||
|
|
||||||
pl = None;
|
pl = None;
|
||||||
for aid in event.auth_events() {
|
for aid in event.auth_events() {
|
||||||
let ev = fetch_event(aid.clone())
|
let ev = fetch_event(aid.to_owned())
|
||||||
.await
|
.await
|
||||||
.ok_or_else(|| Error::NotFound(format!("Failed to find {aid}")))?;
|
.ok_or_else(|| Error::NotFound(format!("Failed to find {aid}")))?;
|
||||||
|
|
||||||
|
@ -734,26 +718,25 @@ where
|
||||||
/// that has an associated mainline depth.
|
/// that has an associated mainline depth.
|
||||||
async fn get_mainline_depth<E, F, Fut>(
|
async fn get_mainline_depth<E, F, Fut>(
|
||||||
mut event: Option<E>,
|
mut event: Option<E>,
|
||||||
mainline_map: &HashMap<E::Id, usize>,
|
mainline_map: &HashMap<OwnedEventId, usize>,
|
||||||
fetch_event: &F,
|
fetch_event: &F,
|
||||||
) -> Result<usize>
|
) -> Result<usize>
|
||||||
where
|
where
|
||||||
F: Fn(E::Id) -> Fut + Sync,
|
F: Fn(OwnedEventId) -> Fut + Sync,
|
||||||
Fut: Future<Output = Option<E>> + Send,
|
Fut: Future<Output = Option<E>> + Send,
|
||||||
E: Event + Send + Sync,
|
E: Event + Send + Sync,
|
||||||
E::Id: Borrow<EventId> + Send + Sync,
|
|
||||||
{
|
{
|
||||||
while let Some(sort_ev) = event {
|
while let Some(sort_ev) = event {
|
||||||
debug!(event_id = sort_ev.event_id().borrow().as_str(), "mainline");
|
debug!(event_id = sort_ev.event_id().as_str(), "mainline");
|
||||||
|
|
||||||
let id = sort_ev.event_id();
|
let id = sort_ev.event_id();
|
||||||
if let Some(depth) = mainline_map.get(id.borrow()) {
|
if let Some(depth) = mainline_map.get(id) {
|
||||||
return Ok(*depth);
|
return Ok(*depth);
|
||||||
}
|
}
|
||||||
|
|
||||||
event = None;
|
event = None;
|
||||||
for aid in sort_ev.auth_events() {
|
for aid in sort_ev.auth_events() {
|
||||||
let aev = fetch_event(aid.clone())
|
let aev = fetch_event(aid.to_owned())
|
||||||
.await
|
.await
|
||||||
.ok_or_else(|| Error::NotFound(format!("Failed to find {aid}")))?;
|
.ok_or_else(|| Error::NotFound(format!("Failed to find {aid}")))?;
|
||||||
|
|
||||||
|
@ -768,15 +751,14 @@ where
|
||||||
}
|
}
|
||||||
|
|
||||||
async fn add_event_and_auth_chain_to_graph<E, F, Fut>(
|
async fn add_event_and_auth_chain_to_graph<E, F, Fut>(
|
||||||
graph: &mut HashMap<E::Id, HashSet<E::Id>>,
|
graph: &mut HashMap<OwnedEventId, HashSet<OwnedEventId>>,
|
||||||
event_id: E::Id,
|
event_id: OwnedEventId,
|
||||||
auth_diff: &HashSet<E::Id>,
|
auth_diff: &HashSet<OwnedEventId>,
|
||||||
fetch_event: &F,
|
fetch_event: &F,
|
||||||
) where
|
) where
|
||||||
F: Fn(E::Id) -> Fut + Sync,
|
F: Fn(OwnedEventId) -> Fut + Sync,
|
||||||
Fut: Future<Output = Option<E>> + Send,
|
Fut: Future<Output = Option<E>> + Send,
|
||||||
E: Event + Send + Sync,
|
E: Event + Send + Sync,
|
||||||
E::Id: Borrow<EventId> + Clone + Send + Sync,
|
|
||||||
{
|
{
|
||||||
let mut state = vec![event_id];
|
let mut state = vec![event_id];
|
||||||
while let Some(eid) = state.pop() {
|
while let Some(eid) = state.pop() {
|
||||||
|
@ -786,26 +768,27 @@ async fn add_event_and_auth_chain_to_graph<E, F, Fut>(
|
||||||
|
|
||||||
// Prefer the store to event as the store filters dedups the events
|
// Prefer the store to event as the store filters dedups the events
|
||||||
for aid in auth_events {
|
for aid in auth_events {
|
||||||
if auth_diff.contains(aid.borrow()) {
|
if auth_diff.contains(aid) {
|
||||||
if !graph.contains_key(aid.borrow()) {
|
if !graph.contains_key(aid) {
|
||||||
state.push(aid.to_owned());
|
state.push(aid.to_owned());
|
||||||
}
|
}
|
||||||
|
|
||||||
// We just inserted this at the start of the while loop
|
graph
|
||||||
graph.get_mut(eid.borrow()).unwrap().insert(aid.to_owned());
|
.get_mut(&eid)
|
||||||
|
.expect("We just inserted this at the start of the while loop")
|
||||||
|
.insert(aid.to_owned());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async fn is_power_event_id<E, F, Fut>(event_id: &E::Id, fetch: &F) -> bool
|
async fn is_power_event_id<E, F, Fut>(event_id: &EventId, fetch: &F) -> bool
|
||||||
where
|
where
|
||||||
F: Fn(E::Id) -> Fut + Sync,
|
F: Fn(OwnedEventId) -> Fut + Sync,
|
||||||
Fut: Future<Output = Option<E>> + Send,
|
Fut: Future<Output = Option<E>> + Send,
|
||||||
E: Event + Send,
|
E: Event + Send,
|
||||||
E::Id: Borrow<EventId> + Send + Sync,
|
|
||||||
{
|
{
|
||||||
match fetch(event_id.clone()).await.as_ref() {
|
match fetch(event_id.to_owned()).await.as_ref() {
|
||||||
| Some(state) => is_power_event(state),
|
| Some(state) => is_power_event(state),
|
||||||
| _ => false,
|
| _ => false,
|
||||||
}
|
}
|
||||||
|
@ -909,13 +892,13 @@ mod tests {
|
||||||
|
|
||||||
let fetcher = |id| ready(events.get(&id).cloned());
|
let fetcher = |id| ready(events.get(&id).cloned());
|
||||||
let sorted_power_events =
|
let sorted_power_events =
|
||||||
super::reverse_topological_power_sort(power_events, &auth_chain, &fetcher, 1)
|
super::reverse_topological_power_sort(power_events, &auth_chain, &fetcher)
|
||||||
.await
|
.await
|
||||||
.unwrap();
|
.unwrap();
|
||||||
|
|
||||||
let resolved_power = super::iterative_auth_check(
|
let resolved_power = super::iterative_auth_check(
|
||||||
&RoomVersion::V6,
|
&RoomVersion::V6,
|
||||||
sorted_power_events.iter().stream(),
|
sorted_power_events.iter().map(AsRef::as_ref).stream(),
|
||||||
HashMap::new(), // unconflicted events
|
HashMap::new(), // unconflicted events
|
||||||
&fetcher,
|
&fetcher,
|
||||||
)
|
)
|
||||||
|
@ -1300,7 +1283,7 @@ mod tests {
|
||||||
let ev_map = store.0.clone();
|
let ev_map = store.0.clone();
|
||||||
let fetcher = |id| ready(ev_map.get(&id).cloned());
|
let fetcher = |id| ready(ev_map.get(&id).cloned());
|
||||||
|
|
||||||
let exists = |id: <PduEvent as Event>::Id| ready(ev_map.get(&*id).is_some());
|
let exists = |id: OwnedEventId| ready(ev_map.get(&*id).is_some());
|
||||||
|
|
||||||
let state_sets = [state_at_bob, state_at_charlie];
|
let state_sets = [state_at_bob, state_at_charlie];
|
||||||
let auth_chain: Vec<_> = state_sets
|
let auth_chain: Vec<_> = state_sets
|
||||||
|
@ -1312,14 +1295,8 @@ mod tests {
|
||||||
})
|
})
|
||||||
.collect();
|
.collect();
|
||||||
|
|
||||||
let resolved = match super::resolve(
|
let resolved =
|
||||||
&RoomVersionId::V2,
|
match super::resolve(&RoomVersionId::V2, &state_sets, &auth_chain, &fetcher, &exists)
|
||||||
&state_sets,
|
|
||||||
&auth_chain,
|
|
||||||
&fetcher,
|
|
||||||
&exists,
|
|
||||||
1,
|
|
||||||
)
|
|
||||||
.await
|
.await
|
||||||
{
|
{
|
||||||
| Ok(state) => state,
|
| Ok(state) => state,
|
||||||
|
@ -1429,16 +1406,10 @@ mod tests {
|
||||||
})
|
})
|
||||||
.collect();
|
.collect();
|
||||||
|
|
||||||
let fetcher = |id: <PduEvent as Event>::Id| ready(ev_map.get(&id).cloned());
|
let fetcher = |id: OwnedEventId| ready(ev_map.get(&id).cloned());
|
||||||
let exists = |id: <PduEvent as Event>::Id| ready(ev_map.get(&id).is_some());
|
let exists = |id: OwnedEventId| ready(ev_map.get(&id).is_some());
|
||||||
let resolved = match super::resolve(
|
let resolved =
|
||||||
&RoomVersionId::V6,
|
match super::resolve(&RoomVersionId::V6, &state_sets, &auth_chain, &fetcher, &exists)
|
||||||
&state_sets,
|
|
||||||
&auth_chain,
|
|
||||||
&fetcher,
|
|
||||||
&exists,
|
|
||||||
1,
|
|
||||||
)
|
|
||||||
.await
|
.await
|
||||||
{
|
{
|
||||||
| Ok(state) => state,
|
| Ok(state) => state,
|
||||||
|
|
|
@ -133,16 +133,10 @@ pub(crate) async fn do_check(
|
||||||
.collect();
|
.collect();
|
||||||
|
|
||||||
let event_map = &event_map;
|
let event_map = &event_map;
|
||||||
let fetch = |id: <PduEvent as Event>::Id| ready(event_map.get(&id).cloned());
|
let fetch = |id: OwnedEventId| ready(event_map.get(&id).cloned());
|
||||||
let exists = |id: <PduEvent as Event>::Id| ready(event_map.get(&id).is_some());
|
let exists = |id: OwnedEventId| ready(event_map.get(&id).is_some());
|
||||||
let resolved = super::resolve(
|
let resolved =
|
||||||
&RoomVersionId::V6,
|
super::resolve(&RoomVersionId::V6, state_sets, &auth_chain_sets, &fetch, &exists)
|
||||||
state_sets,
|
|
||||||
&auth_chain_sets,
|
|
||||||
&fetch,
|
|
||||||
&exists,
|
|
||||||
1,
|
|
||||||
)
|
|
||||||
.await;
|
.await;
|
||||||
|
|
||||||
match resolved {
|
match resolved {
|
||||||
|
@ -247,8 +241,8 @@ impl<E: Event + Clone> TestStore<E> {
|
||||||
pub(crate) fn auth_event_ids(
|
pub(crate) fn auth_event_ids(
|
||||||
&self,
|
&self,
|
||||||
room_id: &RoomId,
|
room_id: &RoomId,
|
||||||
event_ids: Vec<E::Id>,
|
event_ids: Vec<OwnedEventId>,
|
||||||
) -> Result<HashSet<E::Id>> {
|
) -> Result<HashSet<OwnedEventId>> {
|
||||||
let mut result = HashSet::new();
|
let mut result = HashSet::new();
|
||||||
let mut stack = event_ids;
|
let mut stack = event_ids;
|
||||||
|
|
||||||
|
@ -584,7 +578,7 @@ pub(crate) fn INITIAL_EDGES() -> Vec<OwnedEventId> {
|
||||||
|
|
||||||
pub(crate) mod event {
|
pub(crate) mod event {
|
||||||
use ruma::{
|
use ruma::{
|
||||||
MilliSecondsSinceUnixEpoch, OwnedEventId, RoomId, UserId,
|
EventId, MilliSecondsSinceUnixEpoch, OwnedEventId, RoomId, UserId,
|
||||||
events::{TimelineEventType, pdu::Pdu},
|
events::{TimelineEventType, pdu::Pdu},
|
||||||
};
|
};
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
|
@ -593,9 +587,7 @@ pub(crate) mod event {
|
||||||
use crate::Event;
|
use crate::Event;
|
||||||
|
|
||||||
impl Event for PduEvent {
|
impl Event for PduEvent {
|
||||||
type Id = OwnedEventId;
|
fn event_id(&self) -> &EventId { &self.event_id }
|
||||||
|
|
||||||
fn event_id(&self) -> &Self::Id { &self.event_id }
|
|
||||||
|
|
||||||
fn room_id(&self) -> &RoomId {
|
fn room_id(&self) -> &RoomId {
|
||||||
match &self.rest {
|
match &self.rest {
|
||||||
|
@ -652,29 +644,31 @@ pub(crate) mod event {
|
||||||
}
|
}
|
||||||
|
|
||||||
#[allow(refining_impl_trait)]
|
#[allow(refining_impl_trait)]
|
||||||
fn prev_events(&self) -> Box<dyn DoubleEndedIterator<Item = &Self::Id> + Send + '_> {
|
fn prev_events(&self) -> Box<dyn DoubleEndedIterator<Item = &EventId> + Send + '_> {
|
||||||
match &self.rest {
|
match &self.rest {
|
||||||
| Pdu::RoomV1Pdu(ev) => Box::new(ev.prev_events.iter().map(|(id, _)| id)),
|
| Pdu::RoomV1Pdu(ev) =>
|
||||||
| Pdu::RoomV3Pdu(ev) => Box::new(ev.prev_events.iter()),
|
Box::new(ev.prev_events.iter().map(|(id, _)| id.as_ref())),
|
||||||
|
| Pdu::RoomV3Pdu(ev) => Box::new(ev.prev_events.iter().map(AsRef::as_ref)),
|
||||||
#[allow(unreachable_patterns)]
|
#[allow(unreachable_patterns)]
|
||||||
| _ => unreachable!("new PDU version"),
|
| _ => unreachable!("new PDU version"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[allow(refining_impl_trait)]
|
#[allow(refining_impl_trait)]
|
||||||
fn auth_events(&self) -> Box<dyn DoubleEndedIterator<Item = &Self::Id> + Send + '_> {
|
fn auth_events(&self) -> Box<dyn DoubleEndedIterator<Item = &EventId> + Send + '_> {
|
||||||
match &self.rest {
|
match &self.rest {
|
||||||
| Pdu::RoomV1Pdu(ev) => Box::new(ev.auth_events.iter().map(|(id, _)| id)),
|
| Pdu::RoomV1Pdu(ev) =>
|
||||||
| Pdu::RoomV3Pdu(ev) => Box::new(ev.auth_events.iter()),
|
Box::new(ev.auth_events.iter().map(|(id, _)| id.as_ref())),
|
||||||
|
| Pdu::RoomV3Pdu(ev) => Box::new(ev.auth_events.iter().map(AsRef::as_ref)),
|
||||||
#[allow(unreachable_patterns)]
|
#[allow(unreachable_patterns)]
|
||||||
| _ => unreachable!("new PDU version"),
|
| _ => unreachable!("new PDU version"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn redacts(&self) -> Option<&Self::Id> {
|
fn redacts(&self) -> Option<&EventId> {
|
||||||
match &self.rest {
|
match &self.rest {
|
||||||
| Pdu::RoomV1Pdu(ev) => ev.redacts.as_ref(),
|
| Pdu::RoomV1Pdu(ev) => ev.redacts.as_deref(),
|
||||||
| Pdu::RoomV3Pdu(ev) => ev.redacts.as_ref(),
|
| Pdu::RoomV3Pdu(ev) => ev.redacts.as_deref(),
|
||||||
#[allow(unreachable_patterns)]
|
#[allow(unreachable_patterns)]
|
||||||
| _ => unreachable!("new PDU version"),
|
| _ => unreachable!("new PDU version"),
|
||||||
}
|
}
|
||||||
|
|
|
@ -21,7 +21,10 @@ pub use ::toml;
|
||||||
pub use ::tracing;
|
pub use ::tracing;
|
||||||
pub use config::Config;
|
pub use config::Config;
|
||||||
pub use error::Error;
|
pub use error::Error;
|
||||||
pub use info::{rustc_flags_capture, version, version::version};
|
pub use info::{
|
||||||
|
rustc_flags_capture, version,
|
||||||
|
version::{name, version},
|
||||||
|
};
|
||||||
pub use matrix::{Event, EventTypeExt, PduCount, PduEvent, PduId, RoomVersion, pdu, state_res};
|
pub use matrix::{Event, EventTypeExt, PduCount, PduEvent, PduId, RoomVersion, pdu, state_res};
|
||||||
pub use server::Server;
|
pub use server::Server;
|
||||||
pub use utils::{ctor, dtor, implement, result, result::Result};
|
pub use utils::{ctor, dtor, implement, result, result::Result};
|
||||||
|
|
|
@ -1,12 +1,12 @@
|
||||||
type Delim<'a> = (&'a str, &'a str);
|
type Delim<'a> = (&'a str, &'a str);
|
||||||
|
|
||||||
/// Slice a string between a pair of delimeters.
|
/// Slice a string between a pair of delimiters.
|
||||||
pub trait Between<'a> {
|
pub trait Between<'a> {
|
||||||
/// Extract a string between the delimeters. If the delimeters were not
|
/// Extract a string between the delimiters. If the delimiters were not
|
||||||
/// found None is returned, otherwise the first extraction is returned.
|
/// found None is returned, otherwise the first extraction is returned.
|
||||||
fn between(&self, delim: Delim<'_>) -> Option<&'a str>;
|
fn between(&self, delim: Delim<'_>) -> Option<&'a str>;
|
||||||
|
|
||||||
/// Extract a string between the delimeters. If the delimeters were not
|
/// Extract a string between the delimiters. If the delimiters were not
|
||||||
/// found the original string is returned; take note of this behavior,
|
/// found the original string is returned; take note of this behavior,
|
||||||
/// if an empty slice is desired for this case use the fallible version and
|
/// if an empty slice is desired for this case use the fallible version and
|
||||||
/// unwrap to EMPTY.
|
/// unwrap to EMPTY.
|
||||||
|
|
|
@ -193,7 +193,7 @@ fn get_cache(ctx: &Context, desc: &Descriptor) -> Option<Cache> {
|
||||||
return None;
|
return None;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Some cache capacities are overriden by server config in a strange but
|
// Some cache capacities are overridden by server config in a strange but
|
||||||
// legacy-compat way
|
// legacy-compat way
|
||||||
let config = &ctx.server.config;
|
let config = &ctx.server.config;
|
||||||
let cap = match desc.name {
|
let cap = match desc.name {
|
||||||
|
|
|
@ -36,6 +36,7 @@ assets = [
|
||||||
|
|
||||||
[features]
|
[features]
|
||||||
default = [
|
default = [
|
||||||
|
"blurhashing",
|
||||||
"brotli_compression",
|
"brotli_compression",
|
||||||
"element_hacks",
|
"element_hacks",
|
||||||
"gzip_compression",
|
"gzip_compression",
|
||||||
|
|
|
@ -15,7 +15,7 @@ use conduwuit_core::{
|
||||||
#[clap(
|
#[clap(
|
||||||
about,
|
about,
|
||||||
long_about = None,
|
long_about = None,
|
||||||
name = "conduwuit",
|
name = conduwuit_core::name(),
|
||||||
version = conduwuit_core::version(),
|
version = conduwuit_core::version(),
|
||||||
)]
|
)]
|
||||||
pub(crate) struct Args {
|
pub(crate) struct Args {
|
||||||
|
@ -74,17 +74,30 @@ pub(crate) struct Args {
|
||||||
/// with the exception of the last bucket, try increasing this value to e.g.
|
/// with the exception of the last bucket, try increasing this value to e.g.
|
||||||
/// 50 or 100. Inversely, decrease to 10 etc if the histogram lacks
|
/// 50 or 100. Inversely, decrease to 10 etc if the histogram lacks
|
||||||
/// resolution.
|
/// resolution.
|
||||||
#[arg(long, hide(true), env = "CONDUWUIT_RUNTIME_HISTOGRAM_INTERVAL", default_value = "25")]
|
#[arg(
|
||||||
|
long,
|
||||||
|
hide(true),
|
||||||
|
env = "CONTINUWUITY_RUNTIME_HISTOGRAM_INTERVAL",
|
||||||
|
env = "CONDUWUIT_RUNTIME_HISTOGRAM_INTERVAL",
|
||||||
|
default_value = "25"
|
||||||
|
)]
|
||||||
pub(crate) worker_histogram_interval: u64,
|
pub(crate) worker_histogram_interval: u64,
|
||||||
|
|
||||||
/// Set the histogram bucket count (tokio_unstable). Default is 20.
|
/// Set the histogram bucket count (tokio_unstable). Default is 20.
|
||||||
#[arg(long, hide(true), env = "CONDUWUIT_RUNTIME_HISTOGRAM_BUCKETS", default_value = "20")]
|
#[arg(
|
||||||
|
long,
|
||||||
|
hide(true),
|
||||||
|
env = "CONTINUWUITY_RUNTIME_HISTOGRAM_BUCKETS",
|
||||||
|
env = "CONDUWUIT_RUNTIME_HISTOGRAM_BUCKETS",
|
||||||
|
default_value = "20"
|
||||||
|
)]
|
||||||
pub(crate) worker_histogram_buckets: usize,
|
pub(crate) worker_histogram_buckets: usize,
|
||||||
|
|
||||||
/// Toggles worker affinity feature.
|
/// Toggles worker affinity feature.
|
||||||
#[arg(
|
#[arg(
|
||||||
long,
|
long,
|
||||||
hide(true),
|
hide(true),
|
||||||
|
env = "CONTINUWUITY_RUNTIME_WORKER_AFFINITY",
|
||||||
env = "CONDUWUIT_RUNTIME_WORKER_AFFINITY",
|
env = "CONDUWUIT_RUNTIME_WORKER_AFFINITY",
|
||||||
action = ArgAction::Set,
|
action = ArgAction::Set,
|
||||||
num_args = 0..=1,
|
num_args = 0..=1,
|
||||||
|
@ -99,6 +112,7 @@ pub(crate) struct Args {
|
||||||
#[arg(
|
#[arg(
|
||||||
long,
|
long,
|
||||||
hide(true),
|
hide(true),
|
||||||
|
env = "CONTINUWUITY_RUNTIME_GC_ON_PARK",
|
||||||
env = "CONDUWUIT_RUNTIME_GC_ON_PARK",
|
env = "CONDUWUIT_RUNTIME_GC_ON_PARK",
|
||||||
action = ArgAction::Set,
|
action = ArgAction::Set,
|
||||||
num_args = 0..=1,
|
num_args = 0..=1,
|
||||||
|
|
|
@ -77,7 +77,7 @@ pub(crate) fn init(
|
||||||
);
|
);
|
||||||
let tracer = opentelemetry_jaeger::new_agent_pipeline()
|
let tracer = opentelemetry_jaeger::new_agent_pipeline()
|
||||||
.with_auto_split_batch(true)
|
.with_auto_split_batch(true)
|
||||||
.with_service_name("conduwuit")
|
.with_service_name(conduwuit_core::name())
|
||||||
.install_batch(opentelemetry_sdk::runtime::Tokio)
|
.install_batch(opentelemetry_sdk::runtime::Tokio)
|
||||||
.expect("jaeger agent pipeline");
|
.expect("jaeger agent pipeline");
|
||||||
let telemetry = tracing_opentelemetry::layer().with_tracer(tracer);
|
let telemetry = tracing_opentelemetry::layer().with_tracer(tracer);
|
||||||
|
|
|
@ -73,7 +73,7 @@ async fn async_main(server: &Arc<Server>) -> Result<(), Error> {
|
||||||
.lock()
|
.lock()
|
||||||
.await
|
.await
|
||||||
.take()
|
.take()
|
||||||
.expect("services initialied"),
|
.expect("services initialized"),
|
||||||
)
|
)
|
||||||
.await
|
.await
|
||||||
{
|
{
|
||||||
|
|
|
@ -13,8 +13,8 @@ pub(super) fn restart() -> ! {
|
||||||
//
|
//
|
||||||
// We can (and do) prevent that panic by checking the result of current_exe()
|
// We can (and do) prevent that panic by checking the result of current_exe()
|
||||||
// prior to committing to restart, returning an error to the user without any
|
// prior to committing to restart, returning an error to the user without any
|
||||||
// unexpected shutdown. In a nutshell that is the execuse for this unsafety.
|
// unexpected shutdown. In a nutshell that is the excuse for this unsafety.
|
||||||
// Nevertheless, we still want a way to override the restart preventation (i.e.
|
// Nevertheless, we still want a way to override the restart presentation (i.e.
|
||||||
// admin server restart --force).
|
// admin server restart --force).
|
||||||
let exe = unsafe { utils::sys::current_exe().expect("program path must be available") };
|
let exe = unsafe { utils::sys::current_exe().expect("program path must be available") };
|
||||||
let envs = env::vars();
|
let envs = env::vars();
|
||||||
|
|
|
@ -98,12 +98,7 @@ pub(super) fn shutdown(server: &Arc<Server>, runtime: tokio::runtime::Runtime) {
|
||||||
Level::INFO
|
Level::INFO
|
||||||
};
|
};
|
||||||
|
|
||||||
debug!(
|
wait_shutdown(server, runtime);
|
||||||
timeout = ?SHUTDOWN_TIMEOUT,
|
|
||||||
"Waiting for runtime..."
|
|
||||||
);
|
|
||||||
|
|
||||||
runtime.shutdown_timeout(SHUTDOWN_TIMEOUT);
|
|
||||||
let runtime_metrics = server.server.metrics.runtime_interval().unwrap_or_default();
|
let runtime_metrics = server.server.metrics.runtime_interval().unwrap_or_default();
|
||||||
|
|
||||||
event!(LEVEL, ?runtime_metrics, "Final runtime metrics");
|
event!(LEVEL, ?runtime_metrics, "Final runtime metrics");
|
||||||
|
@ -111,13 +106,23 @@ pub(super) fn shutdown(server: &Arc<Server>, runtime: tokio::runtime::Runtime) {
|
||||||
|
|
||||||
#[cfg(not(tokio_unstable))]
|
#[cfg(not(tokio_unstable))]
|
||||||
#[tracing::instrument(name = "stop", level = "info", skip_all)]
|
#[tracing::instrument(name = "stop", level = "info", skip_all)]
|
||||||
pub(super) fn shutdown(_server: &Arc<Server>, runtime: tokio::runtime::Runtime) {
|
pub(super) fn shutdown(server: &Arc<Server>, runtime: tokio::runtime::Runtime) {
|
||||||
|
wait_shutdown(server, runtime);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn wait_shutdown(_server: &Arc<Server>, runtime: tokio::runtime::Runtime) {
|
||||||
debug!(
|
debug!(
|
||||||
timeout = ?SHUTDOWN_TIMEOUT,
|
timeout = ?SHUTDOWN_TIMEOUT,
|
||||||
"Waiting for runtime..."
|
"Waiting for runtime..."
|
||||||
);
|
);
|
||||||
|
|
||||||
runtime.shutdown_timeout(SHUTDOWN_TIMEOUT);
|
runtime.shutdown_timeout(SHUTDOWN_TIMEOUT);
|
||||||
|
|
||||||
|
// Join any jemalloc threads so they don't appear in use at exit.
|
||||||
|
#[cfg(all(not(target_env = "msvc"), feature = "jemalloc"))]
|
||||||
|
conduwuit_core::alloc::je::background_thread_enable(false)
|
||||||
|
.log_debug_err()
|
||||||
|
.ok();
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(
|
#[tracing::instrument(
|
||||||
|
|
|
@ -103,6 +103,7 @@ conduwuit-admin.workspace = true
|
||||||
conduwuit-api.workspace = true
|
conduwuit-api.workspace = true
|
||||||
conduwuit-core.workspace = true
|
conduwuit-core.workspace = true
|
||||||
conduwuit-service.workspace = true
|
conduwuit-service.workspace = true
|
||||||
|
conduwuit-web.workspace = true
|
||||||
const-str.workspace = true
|
const-str.workspace = true
|
||||||
futures.workspace = true
|
futures.workspace = true
|
||||||
http.workspace = true
|
http.workspace = true
|
||||||
|
|
|
@ -6,8 +6,7 @@ use axum::{
|
||||||
};
|
};
|
||||||
use axum_client_ip::SecureClientIpSource;
|
use axum_client_ip::SecureClientIpSource;
|
||||||
use conduwuit::{Result, Server, debug, error};
|
use conduwuit::{Result, Server, debug, error};
|
||||||
use conduwuit_api::router::state::Guard;
|
use conduwuit_service::{Services, state::Guard};
|
||||||
use conduwuit_service::Services;
|
|
||||||
use http::{
|
use http::{
|
||||||
HeaderValue, Method, StatusCode,
|
HeaderValue, Method, StatusCode,
|
||||||
header::{self, HeaderName},
|
header::{self, HeaderName},
|
||||||
|
|
|
@ -1,9 +1,8 @@
|
||||||
use std::sync::Arc;
|
use std::sync::Arc;
|
||||||
|
|
||||||
use axum::{Router, response::IntoResponse, routing::get};
|
use axum::{Router, response::IntoResponse};
|
||||||
use conduwuit::Error;
|
use conduwuit::Error;
|
||||||
use conduwuit_api::router::{state, state::Guard};
|
use conduwuit_service::{Services, state, state::Guard};
|
||||||
use conduwuit_service::Services;
|
|
||||||
use http::{StatusCode, Uri};
|
use http::{StatusCode, Uri};
|
||||||
use ruma::api::client::error::ErrorKind;
|
use ruma::api::client::error::ErrorKind;
|
||||||
|
|
||||||
|
@ -11,7 +10,7 @@ pub(crate) fn build(services: &Arc<Services>) -> (Router, Guard) {
|
||||||
let router = Router::<state::State>::new();
|
let router = Router::<state::State>::new();
|
||||||
let (state, guard) = state::create(services.clone());
|
let (state, guard) = state::create(services.clone());
|
||||||
let router = conduwuit_api::router::build(router, &services.server)
|
let router = conduwuit_api::router::build(router, &services.server)
|
||||||
.route("/", get(it_works))
|
.merge(conduwuit_web::build())
|
||||||
.fallback(not_found)
|
.fallback(not_found)
|
||||||
.with_state(state);
|
.with_state(state);
|
||||||
|
|
||||||
|
@ -21,5 +20,3 @@ pub(crate) fn build(services: &Arc<Services>) -> (Router, Guard) {
|
||||||
async fn not_found(_uri: Uri) -> impl IntoResponse {
|
async fn not_found(_uri: Uri) -> impl IntoResponse {
|
||||||
Error::Request(ErrorKind::Unrecognized, "Not Found".into(), StatusCode::NOT_FOUND)
|
Error::Request(ErrorKind::Unrecognized, "Not Found".into(), StatusCode::NOT_FOUND)
|
||||||
}
|
}
|
||||||
|
|
||||||
async fn it_works() -> &'static str { "hewwo from conduwuit woof!" }
|
|
||||||
|
|
|
@ -165,7 +165,7 @@ pub async fn create_admin_room(services: &Services) -> Result {
|
||||||
.timeline
|
.timeline
|
||||||
.build_and_append_pdu(
|
.build_and_append_pdu(
|
||||||
PduBuilder::state(String::new(), &RoomTopicEventContent {
|
PduBuilder::state(String::new(), &RoomTopicEventContent {
|
||||||
topic: format!("Manage {} | Run commands prefixed with `!admin` | Run `!admin -h` for help | Documentation: https://conduwuit.puppyirl.gay/", services.config.server_name),
|
topic: format!("Manage {} | Run commands prefixed with `!admin` | Run `!admin -h` for help | Documentation: https://continuwuity.org/", services.config.server_name),
|
||||||
}),
|
}),
|
||||||
server_user,
|
server_user,
|
||||||
&room_id,
|
&room_id,
|
||||||
|
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Reference in a new issue