mirror of
https://forgejo.ellis.link/continuwuation/continuwuity.git
synced 2026-11-16 21:47:34 +00:00
Compare commits
283
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
fe8314bb4d | ||
|
|
4922e5da01 | ||
|
|
8c720e5427 | ||
|
|
fb389cb6f9 | ||
|
|
db86d42801 | ||
|
|
223e889459 | ||
|
|
219e8d2e1e | ||
|
|
4d0ccd998f | ||
|
|
42609eab02 | ||
|
|
dad9e1426c | ||
|
|
34c5787af0 | ||
|
|
d2eeae34a9 | ||
|
|
2ee28c1b82 | ||
|
|
c77bbf6d18 | ||
|
|
0727d564a2 | ||
|
|
0e5baa9399 | ||
|
|
d8229a7933 | ||
|
|
ddbdd1ed0c | ||
|
|
f3d8e8d688 | ||
|
|
5a4f3acae4 | ||
|
|
dc03f2136a | ||
|
|
abf8f878bc | ||
|
|
cb27a2082d | ||
|
|
068ba88378 | ||
|
|
60de549cf9 | ||
|
|
363097b31b | ||
|
|
d128207d71 | ||
|
|
c6832372c2 | ||
|
|
14f5f62182 | ||
|
|
5208efcb5e | ||
|
|
224cf04936 | ||
|
|
ae26d5c239 | ||
|
|
30f62eef25 | ||
|
|
b04ffd7e6a | ||
|
|
bc15b7b668 | ||
|
|
3eb2788eb9 | ||
|
|
3b0fc25cd3 | ||
|
|
b580379a2d | ||
|
|
3c19206534 | ||
|
|
7358712fb9 | ||
|
|
18bd828b8b | ||
|
|
4c62b96821 | ||
|
|
a6b8bfe2c9 | ||
|
|
028ffabebf | ||
|
|
b70131c301 | ||
|
|
d4bfb38bd5 | ||
|
|
d4ae9f9ac1 | ||
|
|
1247cf1c80 | ||
|
|
0d9bb6ba7c | ||
|
|
e769ceb147 | ||
|
|
206aaf6893 | ||
|
|
b07093c7ab | ||
|
|
5c3bc643d2 | ||
|
|
c5f28c8276 | ||
|
|
17d575c3e3 | ||
|
|
2604b13ef6 | ||
|
|
c5e976f4bc | ||
|
|
a825b7db8b | ||
|
|
bdb376c8fd | ||
|
|
a96fec4cbc | ||
|
|
ea5d2f4d4c | ||
|
|
f2cf1b2331 | ||
|
|
1c82c57d9f | ||
|
|
c6d220dc60 | ||
|
|
0adfd32b0c | ||
|
|
4cd0e737db | ||
|
|
e8593eeaca | ||
|
|
6fae2475b8 | ||
|
|
0ceabb4b3e | ||
|
|
addd1875d3 | ||
|
|
24b1e2ebe8 | ||
|
|
5297e01357 | ||
|
|
18f5f4fbfa | ||
|
|
98ae1fcaa1 | ||
|
|
ad0181a3d8 | ||
|
|
938b3d2825 | ||
|
|
35d606eeb7 | ||
|
|
9c4f84940e | ||
|
|
2badf2dfe9 | ||
|
|
2b18fa12bf | ||
|
|
747a612fd1 | ||
|
|
be5c94074c | ||
|
|
8fff8f66d3 | ||
|
|
81c62c4a35 | ||
|
|
b848aed1bb | ||
|
|
3295427af6 | ||
|
|
ffef3911e7 | ||
|
|
263ccd6b0b | ||
|
|
0ad4fc1c25 | ||
|
|
a13a50836b | ||
|
|
ef1378509e | ||
|
|
9c27441acf | ||
|
|
c5b70958cf | ||
|
|
3b2afe03ac | ||
|
|
4a20fd62a9 | ||
|
|
783a68cc90 | ||
|
|
2f93711a09 | ||
|
|
d72a27b249 | ||
|
|
b0a5caf576 | ||
|
|
17ddd3966d | ||
|
|
fe02b03d15 | ||
|
|
a973f3e10c | ||
|
|
ab939da036 | ||
|
|
138dd61f82 | ||
|
|
98c694eaa3 | ||
|
|
e6ca06a501 | ||
|
|
4f21fa2bda | ||
|
|
08301fba2a | ||
|
|
a21b0918dc | ||
|
|
a17a805293 | ||
|
|
090203c2ea | ||
|
|
ff63d9f203 | ||
|
|
511e791b9f | ||
|
|
bc70c4eaff | ||
|
|
bbbc9bc7d8 | ||
|
|
7da0ef6e2b | ||
|
|
24e289113b | ||
|
|
805d4d9416 | ||
|
|
fe0ab62124 | ||
|
|
bd005edd59 | ||
|
|
c66fb684f0 | ||
|
|
0773cd1f78 | ||
|
|
929ef60780 | ||
|
|
39bb4fefa1 | ||
|
|
b4a2a457a1 | ||
|
|
dac940784d | ||
|
|
8200487787 | ||
|
|
b5c3da3f52 | ||
|
|
3975d31b91 | ||
|
|
fd4cb4a306 | ||
|
|
c79e9e29a3 | ||
|
|
698edda6bd | ||
|
|
ea3ec965ed | ||
|
|
9d454fd883 | ||
|
|
4996471878 | ||
|
|
5185045cb6 | ||
|
|
e96b6e6665 | ||
|
|
e584e1a572 | ||
|
|
31bce80524 | ||
|
|
f14c401f39 | ||
|
|
ea96858c4a | ||
|
|
75c439a9d0 | ||
|
|
d3b9aee3ab | ||
|
|
3af5302dd8 | ||
|
|
0415a35fa8 | ||
|
|
b76dc816a4 | ||
|
|
536d96abb4 | ||
|
|
2fad908f27 | ||
|
|
b081ac36ff | ||
|
|
c3ba97adb6 | ||
|
|
30508ea353 | ||
|
|
df3466e68d | ||
|
|
5d55b413a2 | ||
|
|
7ce47be4de | ||
|
|
7cedf9f322 | ||
|
|
17f5ce10f4 | ||
|
|
5f13bab52f | ||
|
|
c1e4f926c8 | ||
|
|
63578eba8c | ||
|
|
20fe43d200 | ||
|
|
1ffb1d637e | ||
|
|
0224a558b3 | ||
|
|
ae2e71ff45 | ||
|
|
52435fa02d | ||
|
|
c0d8f5ab8b | ||
|
|
80851bba06 | ||
|
|
4d7341c32d | ||
|
|
18f2118c42 | ||
|
|
240c806d70 | ||
|
|
2fdd59ae54 | ||
|
|
a8a6ab9e3d | ||
|
|
f55a5bd1c3 | ||
|
|
7ab415c4b6 | ||
|
|
c9b0fbaeac | ||
|
|
bc9b97e97f | ||
|
|
0d48c9681d | ||
|
|
38f8011b95 | ||
|
|
e963adf524 | ||
|
|
af84202ba4 | ||
|
|
08b6ab4af7 | ||
|
|
823ee9f6e1 | ||
|
|
3a20ad7ff2 | ||
|
|
4d4693494b | ||
|
|
1e34bd2ed9 | ||
|
|
d83da6ada7 | ||
|
|
9377ff7abd | ||
|
|
2118eb8501 | ||
|
|
ef0483feb9 | ||
|
|
25f59e3e2c | ||
|
|
060eee983d | ||
|
|
7fba194bff | ||
|
|
7bf6f3bd11 | ||
|
|
8b77a559e0 | ||
|
|
c1d75183d1 | ||
|
|
f9a6171cc5 | ||
|
|
5fcc43e803 | ||
|
|
26646f9df6 | ||
|
|
c221d60654 | ||
|
|
70cce17b7f | ||
|
|
2f45a5c794 | ||
|
|
b64f8a76ac | ||
|
|
aab456e0e0 | ||
|
|
b40204a6c7 | ||
|
|
ea16e78092 | ||
|
|
56c2d8d901 | ||
|
|
7d8a5f6bab | ||
|
|
de578c2163 | ||
|
|
c94fa39fd1 | ||
|
|
2773ff3e16 | ||
|
|
6bbea25034 | ||
|
|
39bee607c0 | ||
|
|
935ddf1d0f | ||
|
|
495eeedd24 | ||
|
|
63294f8775 | ||
|
|
7243c92dbc | ||
|
|
43ee11bb00 | ||
|
|
f1d9537b14 | ||
|
|
cb7af18bc2 | ||
|
|
a6fae7498d | ||
|
|
48c36d6f17 | ||
|
|
23d07e3d4f | ||
|
|
1220144495 | ||
|
|
a718aa92eb | ||
|
|
4a97dc8c96 | ||
|
|
8414af2349 | ||
|
|
4daf674337 | ||
|
|
847412367b | ||
|
|
95e99a393d | ||
|
|
a4faa82f38 | ||
|
|
e931fdca15 | ||
|
|
db6e70eae8 | ||
|
|
d97fcc9acd | ||
|
|
c087c3cdb8 | ||
|
|
c186879138 | ||
|
|
92bc1111ee | ||
|
|
0989155929 | ||
|
|
15bb2f7bf5 | ||
|
|
a62f7ecc28 | ||
|
|
30266fe3b5 | ||
|
|
7d1163e35d | ||
|
|
a88da6fd5c | ||
|
|
d413a3ebdc | ||
|
|
4dd538219a | ||
|
|
413ebc0061 | ||
|
|
2eda5de86b | ||
|
|
931686e84e | ||
|
|
eb602e83a1 | ||
|
|
5c4066cbfd | ||
|
|
58d135bc57 | ||
|
|
684820c7c1 | ||
|
|
cbdf978b84 | ||
|
|
38b7987335 | ||
|
|
612a261b61 | ||
|
|
b1e51ab0fb | ||
|
|
8f56f99e2f | ||
|
|
95f65fdba4 | ||
|
|
23a0fc1b0f | ||
|
|
f49bda81d2 | ||
|
|
f35eb7677c | ||
|
|
b2a90f118d | ||
|
|
4b79acba97 | ||
|
|
01a83067c6 | ||
|
|
84cf4196e2 | ||
|
|
83341062af | ||
|
|
1d196f24ec | ||
|
|
4631854325 | ||
|
|
26b8e527aa | ||
|
|
c07922fff2 | ||
|
|
e41435f13c | ||
|
|
8c0fcfd108 | ||
|
|
516f94d83f | ||
|
|
97533eea05 | ||
|
|
062cb5b412 | ||
|
|
17084a363b | ||
|
|
ac96b57506 | ||
|
|
385f6639c4 | ||
|
|
b3a15fc305 | ||
|
|
979c1b2fc7 | ||
|
|
8f2f7f09ed | ||
|
|
b59e697ed6 | ||
|
|
9c0b88f67c | ||
|
|
76e87c93d8 | ||
|
|
aa40142b87 |
No files matched your search
@@ -44,7 +44,7 @@ runs:
|
||||
|
||||
- name: Login to builtin registry
|
||||
if: ${{ env.BUILTIN_REGISTRY_ENABLED == 'true' }}
|
||||
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4
|
||||
uses: docker/login-action@81c6f93d4bc991e510b342a00b419b3bb4efc5c6 # v4
|
||||
with:
|
||||
registry: ${{ env.BUILTIN_REGISTRY }}
|
||||
username: ${{ inputs.registry_user }}
|
||||
|
||||
@@ -79,7 +79,7 @@ runs:
|
||||
|
||||
- name: Login to builtin registry
|
||||
if: ${{ env.BUILTIN_REGISTRY_ENABLED == 'true' }}
|
||||
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4
|
||||
uses: docker/login-action@81c6f93d4bc991e510b342a00b419b3bb4efc5c6 # v4
|
||||
with:
|
||||
registry: ${{ env.BUILTIN_REGISTRY }}
|
||||
username: ${{ inputs.registry_user }}
|
||||
|
||||
@@ -71,7 +71,7 @@ runs:
|
||||
|
||||
- name: Install timelord-cli and git-warp-time
|
||||
if: steps.check-binaries.outputs.need-install == 'true'
|
||||
uses: https://github.com/taiki-e/install-action@94c31af3204a9f15ab40b35ad084410b905bbc73 # v2
|
||||
uses: https://github.com/taiki-e/install-action@682ce6c3c696a4cd5168a05f98e51aa02b877941 # v2
|
||||
with:
|
||||
tool: git-warp-time,timelord-cli@3.0.1
|
||||
|
||||
|
||||
@@ -37,9 +37,9 @@ creds:
|
||||
- registry: forgejo.ellis.link
|
||||
user: "{{env \"BUILTIN_REGISTRY_USER\"}}"
|
||||
pass: "{{env \"BUILTIN_REGISTRY_PASSWORD\"}}"
|
||||
- registry: registry.gitlab.com
|
||||
user: "{{env \"GITLAB_USERNAME\"}}"
|
||||
pass: "{{env \"GITLAB_TOKEN\"}}"
|
||||
# - registry: registry.gitlab.com
|
||||
# user: "{{env \"GITLAB_USERNAME\"}}"
|
||||
# pass: "{{env \"GITLAB_TOKEN\"}}"
|
||||
- registry: git.nexy7574.co.uk
|
||||
user: "{{env \"N7574_GIT_USERNAME\"}}"
|
||||
pass: "{{env \"N7574_GIT_TOKEN\"}}"
|
||||
@@ -58,10 +58,10 @@ defaults:
|
||||
|
||||
# Sync configuration - each registry gets different image sets
|
||||
sync:
|
||||
- source: *source
|
||||
target: registry.gitlab.com/continuwuity/continuwuity
|
||||
type: repository
|
||||
<<: *tags-main
|
||||
#- source: *source
|
||||
# target: registry.gitlab.com/continuwuity/continuwuity
|
||||
# type: repository
|
||||
# <<: *tags-main
|
||||
- source: *source
|
||||
target: ghcr.io/continuwuity/continuwuity
|
||||
type: repository
|
||||
|
||||
@@ -4,6 +4,11 @@ on:
|
||||
pull_request_target:
|
||||
types: [opened, reopened]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
pull-requests: write
|
||||
issues: write
|
||||
|
||||
jobs:
|
||||
auto-label:
|
||||
name: Apply labels based on changed files
|
||||
|
||||
@@ -144,7 +144,7 @@ jobs:
|
||||
COMPONENT="dev-$(echo '${{ forge.ref_name }}' | sed 's/[^a-zA-Z0-9.+]/-/g' | tr '[:upper:]' '[:lower:]' | cut -c1-30)"
|
||||
fi
|
||||
CLEAN_COMPONENT=$(echo $COMPONENT | sed 's/[^a-zA-Z0-9.+]/~/g')
|
||||
VERSION="$BASE_VERSION~git$DATE.$SHA-$CLEAN_COMPONENT"
|
||||
VERSION="$BASE_VERSION-git$DATE.$SHA-$CLEAN_COMPONENT"
|
||||
fi
|
||||
echo "component=$COMPONENT" >> $GITHUB_OUTPUT
|
||||
echo "version=$VERSION" >> $GITHUB_OUTPUT
|
||||
|
||||
@@ -54,6 +54,8 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
needs:
|
||||
- build
|
||||
permissions:
|
||||
contents: write
|
||||
if: startsWith(github.ref, 'refs/tags/')
|
||||
steps:
|
||||
- name: Download binary artifacts
|
||||
|
||||
@@ -4,6 +4,11 @@ on:
|
||||
pull_request_target:
|
||||
types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
pull-requests: write
|
||||
issues: write
|
||||
|
||||
jobs:
|
||||
check-changelog:
|
||||
name: Check changelog is added
|
||||
|
||||
@@ -32,7 +32,7 @@ jobs:
|
||||
|
||||
- name: Setup Node.js
|
||||
if: steps.runner-env.outputs.node_major == '' || steps.runner-env.outputs.node_major < '20'
|
||||
uses: https://github.com/actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7
|
||||
uses: https://github.com/actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7
|
||||
with:
|
||||
node-version: 26
|
||||
|
||||
@@ -56,7 +56,7 @@ jobs:
|
||||
|
||||
- name: Deploy to Cloudflare Pages (Production)
|
||||
if: github.ref == 'refs/heads/main' && vars.CLOUDFLARE_PROJECT_NAME != ''
|
||||
uses: https://github.com/cloudflare/wrangler-action@ebbaa1584979971c8614a24965b4405ff95890e0 # v4
|
||||
uses: https://github.com/cloudflare/wrangler-action@953926a2e2182532811c01a25e53647d93bf07c0 # v4
|
||||
with:
|
||||
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
||||
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
||||
@@ -64,7 +64,7 @@ jobs:
|
||||
|
||||
- name: Deploy to Cloudflare Pages (Preview)
|
||||
if: github.ref != 'refs/heads/main' && vars.CLOUDFLARE_PROJECT_NAME != ''
|
||||
uses: https://github.com/cloudflare/wrangler-action@ebbaa1584979971c8614a24965b4405ff95890e0 # v4
|
||||
uses: https://github.com/cloudflare/wrangler-action@953926a2e2182532811c01a25e53647d93bf07c0 # v4
|
||||
with:
|
||||
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
||||
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
||||
|
||||
@@ -55,7 +55,7 @@ jobs:
|
||||
# repositories: continuwuity
|
||||
|
||||
- name: Install regsync
|
||||
uses: https://github.com/regclient/actions/regsync-installer@bb562fac724b7b37c17f19671df07fe34fabc376 # main
|
||||
uses: https://github.com/regclient/actions/regsync-installer@dd58ad94f76adb73d8ac1bf75ed25f01545d5b32 # main
|
||||
|
||||
- name: Check what images need mirroring
|
||||
run: |
|
||||
|
||||
@@ -7,6 +7,10 @@ on:
|
||||
- main
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
pull-requests: read
|
||||
|
||||
jobs:
|
||||
fast-checks:
|
||||
name: Pre-commit & Formatting
|
||||
|
||||
@@ -31,6 +31,11 @@ jobs:
|
||||
build-release:
|
||||
name: "Build ${{ matrix.slug }} (release)"
|
||||
runs-on: dind
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
attestations: write
|
||||
id-token: write
|
||||
strategy:
|
||||
matrix:
|
||||
include:
|
||||
@@ -79,7 +84,6 @@ jobs:
|
||||
outputs: |
|
||||
${{ env.BUILTIN_REGISTRY_ENABLED == 'true' && format('type=image,"name={0}",push-by-digest=true,name-canonical=true,push=true', env.IMAGE_PATH) || format('type=image,"name={0}",push=false', env.IMAGE_PATH) }}
|
||||
type=local,dest=/tmp/binaries
|
||||
pull: true # Base images were becoming out of date
|
||||
env:
|
||||
SOURCE_DATE_EPOCH: ${{ env.TIMESTAMP }}
|
||||
- name: Upload Docker artifacts
|
||||
@@ -113,6 +117,11 @@ jobs:
|
||||
name: "Build ${{ matrix.slug }} (max-perf)"
|
||||
runs-on: dind
|
||||
needs: build-release
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
attestations: write
|
||||
id-token: write
|
||||
strategy:
|
||||
matrix:
|
||||
include:
|
||||
@@ -163,7 +172,6 @@ jobs:
|
||||
outputs: |
|
||||
${{ env.BUILTIN_REGISTRY_ENABLED == 'true' && format('type=image,"name={0}",push-by-digest=true,name-canonical=true,push=true', env.IMAGE_PATH) || format('type=image,"name={0}",push=false', env.IMAGE_PATH) }}
|
||||
type=local,dest=/tmp/binaries
|
||||
pull: true # Base images were becoming out of date
|
||||
env:
|
||||
SOURCE_DATE_EPOCH: ${{ env.TIMESTAMP }}
|
||||
- name: Upload max-perf Docker artifacts
|
||||
@@ -199,6 +207,8 @@ jobs:
|
||||
needs:
|
||||
- build-release
|
||||
- build-maxperf
|
||||
permissions:
|
||||
contents: write
|
||||
if: startsWith(github.ref, 'refs/tags/')
|
||||
steps:
|
||||
- name: Download binary artifacts
|
||||
|
||||
@@ -43,7 +43,7 @@ jobs:
|
||||
name: Renovate
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ghcr.io/renovatebot/renovate:44.104.2@sha256:d19051d0a908e098c7fbba04a16435ef136208bfa47105d59a9fe47059e2bd25
|
||||
image: ghcr.io/renovatebot/renovate:44.210.1@sha256:45cc73346c44a9afe037f2d19766f2b545b59b2ed31b937b5b09017d2958e45f
|
||||
options: --tmpfs /tmp:exec
|
||||
steps:
|
||||
- name: Checkout
|
||||
|
||||
@@ -7,6 +7,7 @@ f419c64aca300a338096b4e0db4c73ace54f23d0
|
||||
5998a0d883d31b866f7c8c46433a8857eae51a89
|
||||
# trailing whitespace and newlines
|
||||
46c193e74b2ce86c48ce802333a0aabce37fd6e9
|
||||
# rustfmt update that rewrapped tons of comments
|
||||
# rustfmt updates that rewrapped tons of comments
|
||||
9fbabe221051e6956a05d8824142092ede68971e
|
||||
b0c0905472b882ff0cc79232e73d307fd0b5035b
|
||||
9c27441acf2e65f85c106ccff5c6b6c37030ddca
|
||||
@@ -1,3 +1,4 @@
|
||||
open_collective: continuwuity
|
||||
github: [JadedBlueEyes, timedoutuk, gingershaped]
|
||||
custom:
|
||||
- https://timedout.uk/donate.html
|
||||
|
||||
@@ -24,7 +24,7 @@ repos:
|
||||
- id: check-added-large-files
|
||||
|
||||
- repo: https://github.com/crate-ci/typos
|
||||
rev: v1.50.2
|
||||
rev: v1.51.1
|
||||
hooks:
|
||||
- id: typos
|
||||
- id: typos
|
||||
|
||||
@@ -1,19 +1,3 @@
|
||||
# Continuwuity v26.9.3 (2026-11-10)
|
||||
|
||||
No significant changes.
|
||||
|
||||
|
||||
# Continuwuity v26.9.2 (2026-11-10)
|
||||
|
||||
## Bugfixes
|
||||
|
||||
- SEC15, reported by @stratself (SEC15)
|
||||
- SEC31, reported by @tulir (SEC31)
|
||||
- SEC34, reported by @jade (SEC34)
|
||||
- SEC36, reported by @nex (SEC36)
|
||||
- SEC39, reported by @Henry-Hiles (SEC39)
|
||||
|
||||
|
||||
# Continuwuity v26.9.1 (2026-09-28)
|
||||
|
||||
## Features
|
||||
|
||||
Generated
+279
-242
File diff suppressed because it is too large.
Load diff
+67
-44
@@ -12,7 +12,7 @@ license = "Apache-2.0"
|
||||
# See also `rust-toolchain.toml`
|
||||
readme = "README.md"
|
||||
repository = "https://forgejo.ellis.link/continuwuation/continuwuity"
|
||||
version = "26.9.3"
|
||||
version = "26.9.1"
|
||||
|
||||
[workspace.metadata.crane]
|
||||
name = "conduwuit"
|
||||
@@ -104,6 +104,7 @@ version = "0.8.8"
|
||||
default-features = false
|
||||
features = [
|
||||
"form",
|
||||
"query",
|
||||
"http1",
|
||||
"http2",
|
||||
"json",
|
||||
@@ -163,6 +164,7 @@ features = [
|
||||
"hickory-dns",
|
||||
"http2",
|
||||
"stream",
|
||||
"form",
|
||||
]
|
||||
|
||||
[workspace.dependencies.serde]
|
||||
@@ -329,7 +331,7 @@ version = "2.1.1"
|
||||
|
||||
# used for MPSC channels
|
||||
[workspace.dependencies.loole]
|
||||
version = "0.4.0"
|
||||
version = "0.6.0"
|
||||
|
||||
# used for MPMC channels
|
||||
[workspace.dependencies.async-channel]
|
||||
@@ -347,7 +349,7 @@ version = "1.1.1"
|
||||
# Used for matrix spec type definitions and helpers
|
||||
[workspace.dependencies.ruma]
|
||||
git = "https://github.com/ruma/ruma.git"
|
||||
rev = "e7384f01eacd454c593683de50491201e2160fd1"
|
||||
rev = "0ed7fba34213f18a628a56f527c6cc795cd7eef5"
|
||||
features = [
|
||||
"appservice-api-c",
|
||||
"client-api",
|
||||
@@ -378,11 +380,16 @@ features = [
|
||||
"unstable-msc4380",
|
||||
"unstable-msc4143",
|
||||
"unstable-msc4293",
|
||||
"unstable-msc4363",
|
||||
"unstable-msc4406",
|
||||
"unstable-msc4439",
|
||||
"unstable-msc4354",
|
||||
"unstable-msc4480",
|
||||
"unstable-msc4466",
|
||||
"unstable-msc4494",
|
||||
"unstable-msc4484",
|
||||
"unstable-msc4540",
|
||||
"unstable-msc4560",
|
||||
"unstable-extensible-events",
|
||||
]
|
||||
|
||||
@@ -411,27 +418,43 @@ version = "4.0.1"
|
||||
|
||||
# optional opentelemetry, performance measurements, flamegraphs, etc for performance measurements and monitoring
|
||||
[workspace.dependencies.opentelemetry]
|
||||
version = "0.32.0"
|
||||
version = "0.33.0"
|
||||
|
||||
[workspace.dependencies.opentelemetry-instrumentation-tower]
|
||||
version = "0.19.0"
|
||||
default-features = false
|
||||
features = ["axum"]
|
||||
|
||||
[workspace.dependencies.opentelemetry-semantic-conventions]
|
||||
version = "0.33.0"
|
||||
features = ["semconv_experimental"]
|
||||
|
||||
[workspace.dependencies.tracing-flame]
|
||||
version = "0.2.0"
|
||||
|
||||
[workspace.dependencies.tracing-opentelemetry]
|
||||
version = "0.33.0"
|
||||
version = "0.34.0"
|
||||
|
||||
[workspace.dependencies.opentelemetry_sdk]
|
||||
version = "0.32.0"
|
||||
version = "0.33.0"
|
||||
features = ["rt-tokio"]
|
||||
|
||||
[workspace.dependencies.opentelemetry-prometheus]
|
||||
version = "0.33.0"
|
||||
|
||||
[workspace.dependencies.prometheus]
|
||||
version = "0.14.0"
|
||||
default-features = false
|
||||
|
||||
[workspace.dependencies.opentelemetry-otlp]
|
||||
version = "0.32.0"
|
||||
version = "0.33.0"
|
||||
features = ["http", "grpc-tonic", "trace", "logs", "metrics"]
|
||||
|
||||
|
||||
|
||||
# optional sentry metrics for crash/panic reporting
|
||||
[workspace.dependencies.sentry]
|
||||
version = "0.48.0"
|
||||
version = "0.49.0"
|
||||
default-features = false
|
||||
features = [
|
||||
"backtrace",
|
||||
@@ -446,9 +469,9 @@ features = [
|
||||
]
|
||||
|
||||
[workspace.dependencies.sentry-tracing]
|
||||
version = "0.48.0"
|
||||
version = "0.49.0"
|
||||
[workspace.dependencies.sentry-tower]
|
||||
version = "0.48.0"
|
||||
version = "0.49.0"
|
||||
|
||||
# jemalloc usage
|
||||
[workspace.dependencies.tikv-jemalloc-sys]
|
||||
@@ -522,7 +545,7 @@ features = ["hardware-lock-elision", "deadlock_detection"] # TODO: Check if dead
|
||||
|
||||
# Use this when extending with_lock::WithLock to parking_lot
|
||||
[workspace.dependencies.lock_api]
|
||||
version = "0.4.13"
|
||||
version = "0.5.0"
|
||||
|
||||
[workspace.dependencies.bytesize]
|
||||
version = "2.0"
|
||||
@@ -804,37 +827,37 @@ codegen-units = 16
|
||||
#
|
||||
|
||||
[workspace.lints.rust]
|
||||
absolute-paths-not-starting-with-crate = "warn"
|
||||
#box-pointers = "warn"
|
||||
deprecated-in-future = "warn"
|
||||
elided-lifetimes-in-paths = "warn"
|
||||
explicit-outlives-requirements = "warn"
|
||||
ffi-unwind-calls = "warn"
|
||||
keyword-idents = "warn"
|
||||
macro-use-extern-crate = "warn"
|
||||
meta-variable-misuse = "warn"
|
||||
missing-abi = "warn"
|
||||
#missing-copy-implementations = "warn" # TODO
|
||||
#missing-debug-implementations = "warn" # TODO
|
||||
non-ascii-idents = "warn"
|
||||
rust-2021-incompatible-closure-captures = "warn"
|
||||
rust-2021-incompatible-or-patterns = "warn"
|
||||
rust-2021-prefixes-incompatible-syntax = "warn"
|
||||
rust-2021-prelude-collisions = "warn"
|
||||
single-use-lifetimes = "warn"
|
||||
trivial-casts = "warn"
|
||||
trivial-numeric-casts = "warn"
|
||||
unit-bindings = "warn"
|
||||
#unnameable-types = "warn" # TODO
|
||||
unreachable-pub = "warn"
|
||||
unsafe-op-in-unsafe-fn = "warn"
|
||||
unstable-features = "warn"
|
||||
unused-extern-crates = "warn"
|
||||
unused-import-braces = "warn"
|
||||
unused-lifetimes = "warn"
|
||||
unused-macro-rules = "warn"
|
||||
unused-qualifications = "warn"
|
||||
#unused-results = "warn" # TODO
|
||||
absolute_paths_not_starting_with_crate = "warn"
|
||||
#box_pointers = "warn"
|
||||
deprecated_in_future = "warn"
|
||||
elided_lifetimes_in_paths = "warn"
|
||||
explicit_outlives_requirements = "warn"
|
||||
ffi_unwind_calls = "warn"
|
||||
keyword_idents = { level = "warn", priority = -1 }
|
||||
macro_use_extern_crate = "warn"
|
||||
meta_variable_misuse = "warn"
|
||||
missing_abi = "warn"
|
||||
#missing_copy_implementations = "warn" # TODO
|
||||
#missing_debug_implementations = "warn" # TODO
|
||||
non_ascii_idents = "warn"
|
||||
rust_2021_incompatible_closure_captures = "warn"
|
||||
rust_2021_incompatible_or_patterns = "warn"
|
||||
rust_2021_prefixes_incompatible_syntax = "warn"
|
||||
rust_2021_prelude_collisions = "warn"
|
||||
single_use_lifetimes = "warn"
|
||||
trivial_casts = "warn"
|
||||
trivial_numeric_casts = "warn"
|
||||
unit_bindings = "warn"
|
||||
#unnameable_types = "warn" # TODO
|
||||
unreachable_pub = "warn"
|
||||
unsafe_op_in_unsafe_fn = "warn"
|
||||
unstable_features = "warn"
|
||||
unused_extern_crates = "warn"
|
||||
unused_import_braces = "warn"
|
||||
unused_lifetimes = "warn"
|
||||
unused_macro_rules = "warn"
|
||||
unused_qualifications = "warn"
|
||||
#unused_results = "warn" # TODO
|
||||
|
||||
## some sadness
|
||||
mismatched_lifetime_syntaxes = "allow" # TODO!
|
||||
@@ -888,6 +911,7 @@ significant_drop_tightening = { level = "allow", priority = 1 } # TODO
|
||||
pedantic = { level = "warn", priority = -1 }
|
||||
|
||||
## some sadness
|
||||
assert_is_empty = { level = "allow", priority = 1 }
|
||||
too_long_first_doc_paragraph = { level = "allow", priority = 1 }
|
||||
doc_markdown = { level = "allow", priority = 1 }
|
||||
enum_glob_use = { level = "allow", priority = 1 }
|
||||
@@ -930,7 +954,6 @@ float_cmp_const = "warn"
|
||||
fn_to_numeric_cast_any = "warn"
|
||||
format_push_string = "warn"
|
||||
get_unwrap = "warn"
|
||||
impl_trait_in_params = "warn"
|
||||
lossy_float_literal = "warn"
|
||||
mem_forget = "warn"
|
||||
missing_assert_message = "warn"
|
||||
@@ -976,7 +999,7 @@ let_underscore_future = { level = "allow", priority = 1 }
|
||||
literal_string_with_formatting_args = { level = "allow", priority = 1 }
|
||||
|
||||
# This lint is stupid, there's no point defining generics for simple trait params
|
||||
impl-trait-in-params = { level = "allow", priority = 1 }
|
||||
impl_trait_in_params = { level = "allow", priority = 1 }
|
||||
|
||||
needless_raw_string_hashes = "allow"
|
||||
|
||||
|
||||
@@ -1,49 +1,77 @@
|
||||
# continuwuity
|
||||
# Continuwuity
|
||||
|
||||
<!-- ANCHOR: catchphrase -->
|
||||
## A community-driven [Matrix](https://matrix.org/) homeserver
|
||||
|
||||
## A community-driven [Matrix](https://matrix.org/) homeserver in Rust
|
||||
[![Chat on Matrix][matrix-chat-badge]][matrix-chatroom]
|
||||
[![Join the space][matrix-space-badge]][matrix-space]
|
||||
[![Open Collective backers and sponsors][opencollective-contributors-badge]][opencollective]
|
||||
|
||||
[](https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org) [](https://matrix.to/#/#space:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org)
|
||||
|
||||
|
||||
|
||||
<!-- ANCHOR_END: catchphrase -->
|
||||
[matrix-chat-badge]: https://img.shields.io/matrix/continuwuity%3Acontinuwuity.org?server_fqdn=matrix.continuwuity.org&fetchMode=summary&logo=matrix
|
||||
[matrix-chatroom]: https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org
|
||||
[matrix-space-badge]: https://img.shields.io/matrix/space%3Acontinuwuity.org?server_fqdn=matrix.continuwuity.org&fetchMode=summary&logo=matrix&label=space
|
||||
[matrix-space]: https://matrix.to/#/#space:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org
|
||||
[opencollective-contributors-badge]: https://img.shields.io/opencollective/all/continuwuity
|
||||
[opencollective]: https://opencollective.com/continuwuity
|
||||
|
||||
[continuwuity] is a Matrix homeserver written in Rust.
|
||||
It's the official community continuation of the [conduwuit](https://github.com/girlbossceo/conduwuit) homeserver.
|
||||
|
||||
<!-- ANCHOR: body -->
|
||||
[![forgejo.ellis.link][forge-badge]][forge-link]
|
||||
[![Stars][forge-stars-badge]][forge-stars-link]
|
||||
[![Issues][forge-issues-badge]][forge-issues-link]
|
||||
[![Pull Requests][forge-pulls-badge]][forge-pulls-link]
|
||||
|
||||
[](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)
|
||||
[![GitHub][github-badge]][github-link] ![Stars][github-stars-badge] -
|
||||
[![Codeberg][codeberg-badge]][codeberg-link] [![Stars][codeberg-stars-badge]][codeberg-stars-link] -
|
||||
[![GitLab][gitlab-badge]][gitlab-link] [![Stars][gitlab-stars-badge]][gitlab-stars-link]
|
||||
|
||||
[](https://github.com/continuwuity/continuwuity) [](https://github.com/continuwuity/continuwuity/stargazers)
|
||||
<br>
|
||||
<a href="https://opencollective.com/continuwuity" target="_blank">
|
||||
<img src="https://opencollective.com/webpack/donate/button.png?color=blue" width="250"/>
|
||||
</a>
|
||||
|
||||
[](https://gitlab.com/continuwuity/continuwuity) [](https://gitlab.com/continuwuity/continuwuity/-/starrers)
|
||||
[forge-badge]: https://img.shields.io/badge/Ellis%20Git-main+packages-green?style=flat&logo=forgejo&labelColor=fff
|
||||
[forge-link]: https://forgejo.ellis.link/continuwuation/continuwuity
|
||||
[forge-stars-badge]: https://forgejo.ellis.link/continuwuation/continuwuity/badges/stars.svg?style=flat&labelColor=fff&color=8a5cd0
|
||||
[forge-stars-link]: https://forgejo.ellis.link/continuwuation/continuwuity/stars
|
||||
[forge-issues-badge]: https://forgejo.ellis.link/continuwuation/continuwuity/badges/issues/open.svg?style=flat&labelColor=fff&color=8a5cd0
|
||||
[forge-issues-link]: https://forgejo.ellis.link/continuwuation/continuwuity/issues?state=open
|
||||
[forge-pulls-badge]: https://forgejo.ellis.link/continuwuation/continuwuity/badges/pulls/open.svg?style=flat&labelColor=fff&color=8a5cd0
|
||||
[forge-pulls-link]: https://forgejo.ellis.link/continuwuation/continuwuity/pulls?state=open
|
||||
|
||||
[](https://codeberg.org/continuwuity/continuwuity) [](https://codeberg.org/continuwuity/continuwuity/stars)
|
||||
[github-badge]: https://img.shields.io/badge/GitHub-mirror-blue?style=flat&logo=github&labelColor=fff&logoColor=24292f
|
||||
[github-link]: https://github.com/continuwuity/continuwuity
|
||||
[github-stars-badge]: https://img.shields.io/github/stars/continuwuity/continuwuity?style=flat
|
||||
[gitlab-badge]:https://img.shields.io/badge/GitLab-mirror-blue?style=flat&logo=gitlab&labelColor=fff
|
||||
[gitlab-link]: https://gitlab.com/continuwuity/continuwuity
|
||||
[gitlab-stars-badge]: https://img.shields.io/gitlab/stars/continuwuity/continuwuity?style=flat
|
||||
[gitlab-stars-link]: https://gitlab.com/continuwuity/continuwuity/-/starrers
|
||||
[codeberg-badge]:https://img.shields.io/badge/Codeberg-mirror-2185D0?style=flat&logo=codeberg&labelColor=fff
|
||||
[codeberg-link]: https://codeberg.org/continuwuity/continuwuity
|
||||
[codeberg-stars-badge]: https://codeberg.org/continuwuity/continuwuity/badges/stars.svg?style=flat
|
||||
[codeberg-stars-link]: 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.
|
||||
|
||||
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?
|
||||
|
||||
We are a group of Matrix enthusiasts, developers and system administrators who have used conduwuit and believe in its potential. Our team includes both previous
|
||||
contributors to the original project and new developers who want to help maintain and improve this important piece of Matrix infrastructure.
|
||||
|
||||
We operate as an open community project, welcoming contributions from anyone interested in improving continuwuity.
|
||||
|
||||
### What is Matrix?
|
||||
## What is Matrix?
|
||||
|
||||
[Matrix](https://matrix.org) is an open, federated, and extensible network for
|
||||
decentralized communication. Users from any Matrix homeserver can chat with users from all
|
||||
other homeservers over federation. Matrix is designed to be extensible and built on top of.
|
||||
You can even use bridges such as Matrix Appservices to communicate with users outside of Matrix, like a community on Discord.
|
||||
|
||||
### What are the project's goals?
|
||||
## What are the project's goals?
|
||||
|
||||
Continuwuity aims to:
|
||||
|
||||
@@ -55,11 +83,11 @@ Continuwuity aims to:
|
||||
- Create a sustainable development model for long-term maintenance
|
||||
- Keep a lightweight, efficient codebase that can run on modest hardware
|
||||
|
||||
### Can I try it out?
|
||||
## Can I try it out?
|
||||
|
||||
Check out the [documentation](https://continuwuity.org) for installation instructions.
|
||||
Check out our [website](https://continuwuity.org) for installation instructions. Start with the [deployment section](https://continuwuity.org/deploying).
|
||||
|
||||
If you want to try it out as a user, we have some partnered homeservers you can use:
|
||||
If you want to try it out as a user, we have some partnered homeservers you can join:
|
||||
* You can head over to [https://federated.nexus](https://federated.nexus/) in your browser.
|
||||
* Hit the `Apply to Join` button. Once your request has been accepted, you will receive an email with your username and password.
|
||||
* Head over to [https://app.federated.nexus](https://app.federated.nexus/) and you can sign in there, or use any other matrix chat client you wish elsewhere.
|
||||
@@ -67,31 +95,20 @@ If you want to try it out as a user, we have some partnered homeservers you can
|
||||
|
||||
* There's also [https://continuwuity.rocks/](https://continuwuity.rocks/). You can register a new account using Cinny via [this convenient link](https://app.cinny.in/register/continuwuity.rocks), or you can use Element or another matrix client *that supports registration*.
|
||||
|
||||
### What are we working on?
|
||||
## Can I migrate my data from X?
|
||||
|
||||
We're working our way through all of the issues in the [Forgejo project](https://forgejo.ellis.link/continuwuation/continuwuity/issues).
|
||||
|
||||
- [Packaging & availability in more places](https://forgejo.ellis.link/continuwuation/continuwuity/issues/747)
|
||||
- [Appservices bugs & features](https://forgejo.ellis.link/continuwuation/continuwuity/issues?q=&type=all&state=open&labels=178&milestone=0&assignee=0&poster=0)
|
||||
- [Improving compatibility and spec compliance](https://forgejo.ellis.link/continuwuation/continuwuity/issues?labels=119)
|
||||
- Automated testing
|
||||
- [Admin API](https://forgejo.ellis.link/continuwuation/continuwuity/issues/748)
|
||||
- [Policy-list controlled moderation](https://forgejo.ellis.link/continuwuation/continuwuity/issues/750)
|
||||
|
||||
### Can I migrate my data from x?
|
||||
|
||||
- Conduwuit: Yes
|
||||
- Conduit: No, database is now incompatible
|
||||
- Grapevine: No, database is now incompatible
|
||||
- Dendrite: No
|
||||
- Synapse: No
|
||||
- **Conduwuit**: Yes
|
||||
- **Conduit**: No, database is now incompatible
|
||||
- **Grapevine**: No, database is now incompatible
|
||||
- **Dendrite**: No
|
||||
- **Synapse**: No
|
||||
|
||||
We haven't written up a guide on migrating from incompatible homeservers yet. Reach out to us if you need to do this!
|
||||
|
||||
<!-- ANCHOR_END: body -->
|
||||
|
||||
## Contribution
|
||||
|
||||
See our [Contributing page](CONTRIBUTING.md) for more details.
|
||||
|
||||
### Development flow
|
||||
|
||||
- Features / changes must developed in a separate branch
|
||||
@@ -104,7 +121,6 @@ We haven't written up a guide on migrating from incompatible homeservers yet. Re
|
||||
|
||||
The main branch is always green!
|
||||
|
||||
|
||||
### Policy on pulling from other forks
|
||||
|
||||
We welcome contributions from other forks of conduwuit, subject to our review process.
|
||||
@@ -117,13 +133,18 @@ When incorporating code from other forks:
|
||||
- We prioritize stability and compatibility when evaluating external contributions
|
||||
- Features that align with our project goals will be given priority consideration
|
||||
|
||||
<!-- ANCHOR: footer -->
|
||||
## Donate to us!
|
||||
|
||||
#### Contact
|
||||
If you like what we're doing, consider donating to our [**Open Collective**][opencollective]!
|
||||
|
||||
You can also donate individually to each of the maintainers:
|
||||
|
||||
- Nex: https://timedout.uk/donate.html
|
||||
- Jade: https://jade.ellis.link/sponsors
|
||||
- Ginger: https://github.com/sponsors/gingershaped
|
||||
|
||||
## Contact
|
||||
|
||||
Join our [Matrix room](https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org) and [space](https://matrix.to/#/#space:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org) to chat with us about the project!
|
||||
|
||||
<!-- ANCHOR_END: footer -->
|
||||
|
||||
|
||||
[continuwuity]: https://forgejo.ellis.link/continuwuation/continuwuity
|
||||
@@ -0,0 +1,3 @@
|
||||
Implemented unstable support for [MSC4560] (Stripped state requests over federation). Contributed by @ginger.
|
||||
|
||||
[MSC4560]: https://github.com/matrix-org/matrix-spec-proposals/pull/4560
|
||||
@@ -0,0 +1 @@
|
||||
Added support for [MSC4484](https://github.com/matrix-org/matrix-spec-proposals/pull/4484). Clients which use the built-in Matrix server administration APIs will need to ask for the appropriate scope when signing in with OAuth. Contributed by @ginger.
|
||||
@@ -0,0 +1 @@
|
||||
Profile banners are now treated as images when imported from OIDC claims, like avatars already were.
|
||||
@@ -0,0 +1 @@
|
||||
Added support for MSC4363 (OAuth step-up authentication). Contributed by @ginger.
|
||||
@@ -0,0 +1 @@
|
||||
The first-run version of the web UI now includes a link to the registration page. Contributed by @ginger
|
||||
@@ -0,0 +1 @@
|
||||
For deployments using OIDC with `profile_key_import_mode` set to `on_login`, users' avatars will no longer be clobbered if they didn't change their avatar since their last login.
|
||||
@@ -0,0 +1 @@
|
||||
Continuwuity now supports the OAuth 2.0 client credentials grant type, allowing secure automated access to the Matrix homeserver admin API, as well as future administrative functionality. Contributed by @ginger.
|
||||
@@ -0,0 +1 @@
|
||||
Room summary visibility checks are no longer incorrectly applied for remote rooms. Contributed by @ginger.
|
||||
@@ -0,0 +1 @@
|
||||
The userinfo endpoint is now accessible even if federation is disabled, allowing LiveKit to be used on servers with federation disabled without using the server name whitelist.
|
||||
@@ -0,0 +1 @@
|
||||
Fix new devices sometimes never reaching other users' device lists. Contributed by @eleboucher.
|
||||
@@ -0,0 +1 @@
|
||||
Fix gap filling skipping outlier events that are missing their previous events. Contributed by @eleboucher.
|
||||
@@ -0,0 +1 @@
|
||||
Fix state resolution applying events out of order, which could undo room joins. Contributed by @eleboucher.
|
||||
@@ -0,0 +1 @@
|
||||
Fix to-device messages, including room keys, sometimes being lost before delivery. Contributed by @eleboucher.
|
||||
@@ -0,0 +1 @@
|
||||
Add support for using custom DNS servers instead of using /etc/resolv.conf. Contributed by @s1lv3r.
|
||||
@@ -0,0 +1 @@
|
||||
Invitees are now added as room creators when creating a v12+ trusted private chat. Contributed by @ginger.
|
||||
@@ -0,0 +1 @@
|
||||
Continuwuity now supports configuring additional trusted audience values for deployments using OIDC with an IDP that sends them. Contributed by @ginger
|
||||
@@ -0,0 +1 @@
|
||||
Add the Authentication section to document available auth methods for Continuwuity. The "delegated authentication" guide has also been migrated to here. Contributed by @stratself.
|
||||
@@ -0,0 +1 @@
|
||||
Add a guide for push notifications, detailing how it works, push gateway specifics, troubleshooting common issues, and pointing to external guides for UnifiedPush backends. Contributed by @stratself
|
||||
@@ -0,0 +1 @@
|
||||
The deploying page now includes vital general information about installing Continuwuity: release tracks, update steps, and post-installation recommendations. Contributed by @stratself
|
||||
@@ -0,0 +1 @@
|
||||
Fixed push gateway URLs containing the configured notification path outside of their suffix. Contributed by @eleboucher.
|
||||
@@ -0,0 +1 @@
|
||||
Add some missing instructions on configuring Continuwuity on the RPM page. Users are encouraged to use the [generic deploying docs](https://continuwuity.org/deploying/generic) for the bulk of guidance anyhow. Contributed by @stratself
|
||||
@@ -0,0 +1 @@
|
||||
Better, more succinct [introduction page](https://continuwuity.org/introduction.html). Contributed by @stratself
|
||||
@@ -0,0 +1 @@
|
||||
"!admin users list" now hides deactivated users by default, but can display them with the optional "--show-deactivated" flag. "--hide-suspended" and "--hide-locked" have been added as well, which stop suspended and locked users from being displayed respectively. Contributed by @Clubs.
|
||||
@@ -0,0 +1 @@
|
||||
Added support for [MSC4494: Membership-based invite blocking](https://github.com/matrix-org/matrix-spec-proposals/pull/4494)
|
||||
@@ -0,0 +1 @@
|
||||
"!admin users change-email" now verifies a user exists before attempting to change their email. Contributed by @Clubs.
|
||||
@@ -0,0 +1 @@
|
||||
`!admin token issue` can no longer issue registration tokens when `allow_registration` is false. Contributed by @Clubs.
|
||||
@@ -0,0 +1 @@
|
||||
Fixed URL preview image MIME types and rejected failed downloads. Contributed by @eleboucher.
|
||||
@@ -0,0 +1 @@
|
||||
Add a section on [troubleshooting Docker issues](https://continuwuity.org/troubleshooting#docker-issues). Contributed by @stratself.
|
||||
@@ -0,0 +1 @@
|
||||
Appservices now receive typing indicators and read receipts. Contributed by @Jade
|
||||
@@ -0,0 +1 @@
|
||||
Instructions for Authelia added to the [OIDC guide](https://continuwuity.org/authentication/oidc.html). Contributed by @fhoekstra
|
||||
@@ -0,0 +1 @@
|
||||
Correctly set RocksDB column options, including enabling block caches. Contributed by @Jade
|
||||
@@ -0,0 +1 @@
|
||||
Fix some possible deadlocks/freezes and reduce lock contention (improving performance). Contributed by @Jade
|
||||
@@ -0,0 +1 @@
|
||||
Docker compose examples now use bind mounts by default, instead of Docker volumes, as they are easier to work with esp. for backup/restore. Contributed by @stratself.
|
||||
@@ -0,0 +1 @@
|
||||
Once again fixed how room extremities are handled, fixing a problem that made continuwuity gradually make rooms needlessly complex, which also caused more frequent state resets.
|
||||
@@ -0,0 +1 @@
|
||||
The OAuth identity reset page is no longer linked from the account management UI to reduce confusion. Contributed by @ginger.
|
||||
@@ -0,0 +1 @@
|
||||
Fixed a worker panic when knocking on a room over federation. Contributed by @eleboucher.
|
||||
@@ -0,0 +1 @@
|
||||
Perform more validation on events received during atomic gapfill from remote servers, fixing a panic if bad data was persisted by another server and later lazily fetched by us.
|
||||
@@ -0,0 +1 @@
|
||||
Redirect URIs in OAuth clients' metadata are now properly validated to be on a subdomain of the OAuth issuer URL domain. Contributed by @ginger.
|
||||
@@ -0,0 +1 @@
|
||||
Updated internal Sentry integration setup to the new pattern required by the SDK.
|
||||
@@ -0,0 +1 @@
|
||||
Fix v12 rooms created by the same user in the same millisecond ending up as the same room. Contributed by @eleboucher.
|
||||
@@ -0,0 +1 @@
|
||||
Setting a profile key longer than 255 bytes now returns 400 `M_KEY_TOO_LARGE` as required by the spec, instead of 413 `M_TOO_LARGE`.
|
||||
@@ -0,0 +1 @@
|
||||
Setting profile data that would make the profile exceed 64 KiB now returns 400 `M_PROFILE_TOO_LARGE` as required by the spec, instead of a 500 error.
|
||||
@@ -0,0 +1 @@
|
||||
Appservices masquerading as a device that does not exist now receive 400 `M_UNKNOWN_DEVICE` as required by the spec, instead of 403 `M_FORBIDDEN`.
|
||||
@@ -0,0 +1 @@
|
||||
Setting `m.fully_read` via the account data endpoints now returns 405 `M_BAD_JSON` as required by the spec, instead of 400.
|
||||
@@ -0,0 +1 @@
|
||||
The `m.forget_forced_upon_leave` capability now reflects the `forget_forced_upon_leave` config option instead of always being advertised as enabled.
|
||||
@@ -0,0 +1 @@
|
||||
Fixed push notifications for membership events setting `user_is_target` based on the sender rather than the user being notified.
|
||||
@@ -0,0 +1 @@
|
||||
Added opt-in OpenTelemetry metrics, exported over OTLP or scraped by Prometheus from `/_continuwuity/metrics`, and a Grafana dashboard. Contributed by @eleboucher.
|
||||
+355
-17
File diff suppressed because it is too large.
Load diff
+2
-2
@@ -10,7 +10,7 @@ RUN rm -f /etc/apt/apt.conf.d/docker-clean
|
||||
|
||||
# Match Rustc version as close as possible
|
||||
# rustc -vV
|
||||
ARG LLVM_VERSION=22
|
||||
ARG LLVM_VERSION=23
|
||||
# ENV RUSTUP_TOOLCHAIN=${RUST_VERSION}
|
||||
|
||||
# Install repo tools
|
||||
@@ -50,7 +50,7 @@ EOF
|
||||
|
||||
# Developer tool versions
|
||||
# renovate: datasource=github-releases depName=cargo-bins/cargo-binstall
|
||||
ENV BINSTALL_VERSION=1.23.0
|
||||
ENV BINSTALL_VERSION=1.26.1
|
||||
# renovate: datasource=github-releases depName=psastras/sbom-rs
|
||||
ENV CARGO_SBOM_VERSION=0.9.1
|
||||
# renovate: datasource=crate depName=lddtree
|
||||
|
||||
@@ -18,7 +18,7 @@ RUN --mount=type=cache,target=/etc/apk/cache apk add \
|
||||
|
||||
# Developer tool versions
|
||||
# renovate: datasource=github-releases depName=cargo-bins/cargo-binstall
|
||||
ENV BINSTALL_VERSION=1.23.0
|
||||
ENV BINSTALL_VERSION=1.26.1
|
||||
# renovate: datasource=github-releases depName=psastras/sbom-rs
|
||||
ENV CARGO_SBOM_VERSION=0.9.1
|
||||
# renovate: datasource=crate depName=lddtree
|
||||
|
||||
+8
-3
@@ -2,7 +2,12 @@
|
||||
{
|
||||
"type": "file",
|
||||
"name": "introduction",
|
||||
"label": "Continuwuity"
|
||||
"label": "Introduction"
|
||||
},
|
||||
{
|
||||
"type": "dir",
|
||||
"name": "deploying",
|
||||
"label": "Deploying"
|
||||
},
|
||||
{
|
||||
"type": "file",
|
||||
@@ -11,8 +16,8 @@
|
||||
},
|
||||
{
|
||||
"type": "dir",
|
||||
"name": "deploying",
|
||||
"label": "Deploying"
|
||||
"name": "authentication",
|
||||
"label": "Authentication"
|
||||
},
|
||||
{
|
||||
"type": "dir",
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
# Authentication
|
||||
|
||||
This chapter describes various ways to authenticate to Continuwuity.
|
||||
|
||||
## Authentication flows
|
||||
|
||||
Continuwuity implements the following authentication flows:
|
||||
|
||||
- **OAuth login** (also known as **next-gen auth**): clients redirect the user to Continuwuity's own login and registration page to complete the authentication process.
|
||||
- **Legacy login** (also known as the **User Interactive Authentication** framework): clients provide their own UI to log in to or register with the server directly.
|
||||
|
||||
Different sets of clients support different flows, but most clients are moving towards next-gen auth. One can set which login modes are allowed via the `compatibility_mode` variable of the `[global.oauth]` config file section.
|
||||
|
||||
:::important Configure your client well-known for OAuth logins
|
||||
|
||||
To ensure OAuth logins work, Continuwuity must know the base URL its Client-Server API is being served on:
|
||||
|
||||
```toml
|
||||
[global.well_known]
|
||||
client = "https://matrix.example.com"
|
||||
```
|
||||
|
||||
Refer to the [delegation](./guides/delegation) documentation for more details.
|
||||
|
||||
:::
|
||||
|
||||
## Authentication sources
|
||||
|
||||
Continuwuity can read user authentication data from the following sources:
|
||||
|
||||
- **Internal authentication** - this is the default setup, where Continuwuity reads user authentication data from its local database. It allows for registration, email, and password reset self-service. See the [**internal authentication documentation**](./authentication/internal).
|
||||
|
||||
- **Delegated authentication** - in this mode, the server connects to an OpenID Connect identity provider for user authentication. This method allows for integrating with single sign-on services, but enabling it will disable legacy logins. See the [**delegated authentication documentation**](./authentication/oidc).
|
||||
|
||||
Only one authentication source can be used at a time.
|
||||
@@ -0,0 +1,12 @@
|
||||
[
|
||||
{
|
||||
"type": "file",
|
||||
"name": "internal",
|
||||
"label": "Internal authentication"
|
||||
},
|
||||
{
|
||||
"type": "file",
|
||||
"name": "oidc",
|
||||
"label": "Delegated authentication (OIDC)"
|
||||
}
|
||||
]
|
||||
@@ -0,0 +1,46 @@
|
||||
# Internal authentication
|
||||
|
||||
Continuwuity comes with an internal database for user authentication, which it uses by default. This allows for self-servicing of account registration, linking emails, and password resets.
|
||||
|
||||
## Registration
|
||||
|
||||
Registration is disabled by default. To enable it, set `allow_registration = true` in your config file and use at least one of the registration methods below.
|
||||
|
||||
| Method | Description | Additional configuration needed |
|
||||
| ------ | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| 1 | Admin-issued tokens (recommended) | None. Use the [`!admin token issue`](../reference/admin/token#admin-token-issue) command |
|
||||
| 2 | Static registration token | `registration_token` or `registration_token_file` |
|
||||
| 3 | Token + email | Method 1 or 2 + `require_email_for_token_registration = true` in `[global.smtp]`. See [Email configuration](#email-configuration) |
|
||||
| 4 | Email-only registration | `require_email_for_registration = true` in `[global.smtp]` section. See [Email configuration](#email-configuration) |
|
||||
| 5 | reCAPTCHA-only registration | `recaptcha_site_key` and `recaptcha_private_site_key` |
|
||||
| 6 | Email + reCAPTCHA registration | Methods 4 + 5 |
|
||||
|
||||
Admin-issued tokens are the recommended registration method. These tokens are well suited for private or invite-only servers, and they can be scoped with an expiry duration or given a usage limit. See the [`!admin token`](../reference/admin/token) commands for more details.
|
||||
|
||||
Other registration methods are meant for **untrusted, public registration**. Care must be taken when allowing these modes of operation.
|
||||
|
||||
## Email configuration
|
||||
|
||||
Continuwuity can be configured to send emails via an SMTP relay of your choice. These are used for verifying user email addresses and sending password reset links to them.
|
||||
|
||||
A user is associated with only **one** email address at a time.
|
||||
|
||||
All email options are in the `[global.smtp]` block of the [configuration file](../reference/config.mdx), and are toggled on when the block is uncommented. For example:
|
||||
|
||||
```toml
|
||||
[global.smtp]
|
||||
# Example URI for the user john@example.com on the `mail.example.net` mail server
|
||||
connection_uri = "smtps://john%40example.com:password@mail.example.net:465"
|
||||
sender = "John's Continuwuity server <john@example.com>"
|
||||
```
|
||||
|
||||
A user's email address can also be modified by the [`!admin users change-email`](../reference/admin/users#admin-users-change-email) command. To view current user-email associations, use the `!admin users get-email` and `!admin users get-user-by-email` command.
|
||||
|
||||
Use [`!admin debug send-test-email`](../reference/admin/debug#admin-debug-send-test-email) to test that your email setup is working.
|
||||
|
||||
## Password resets
|
||||
|
||||
Password resets in Continuwuity can be made via:
|
||||
|
||||
- Self-service password resets. This requires a user's email to have been set up and verified.
|
||||
- Using the [`!admin users reset-password`](../reference/admin/users#admin-users-reset-password) command.
|
||||
@@ -0,0 +1,159 @@
|
||||
import { Tab, Tabs } from '@rspress/core/theme';
|
||||
|
||||
# Delegated authentication with OIDC
|
||||
|
||||
Continuwuity supports delegating user authentication to an external identity provider that implements the OpenID Connect (OIDC) specification, such as Authentik, Kanidm, or Keycloak.
|
||||
|
||||
:::important Delegated authentication and legacy logins
|
||||
When delegated authentication is configured, Continuwuity will disable its support for legacy logins. **Only clients that support OAuth** will be able to login.
|
||||
:::
|
||||
|
||||
An account on the homeserver can only be associated with one OIDC subject claim - that is, one account on the identity provider - at a time. Linking an account will also prevent the user from deactivating it themselves.
|
||||
|
||||
## Instructions
|
||||
|
||||
A simple OIDC configuration is as easy as creating a new OIDC application in your identity provider's settings and supplying Continuwuity with the client ID and client secret.
|
||||
|
||||
The instructions below make the following assumptions:
|
||||
|
||||
- Continuwuity's base URL: `https://matrix.example.com`. Note that if you employ [well-known delegation](../guides/delegation), this must match the client well-known domain rather than your server name.
|
||||
- OIDC provider's base URL: `https://idm.example.com`
|
||||
|
||||
### Configuring the OIDC provider
|
||||
|
||||
This guide will cover [**Kanidm**][kanidm] and [**Authelia**][authelia], but the basic concepts apply to most identity providers. Contributions for them are welcome.
|
||||
|
||||
<Tabs groupId="idp">
|
||||
<Tab label="KanIDM">
|
||||
|
||||
Create a new application for continuwuity in kanidm. We will use `c10y` as the client ID.
|
||||
|
||||
```sh
|
||||
kanidm system oauth2 create c10y Continuwuity https://matrix.example.com
|
||||
```
|
||||
|
||||
Configure the redirect URL that Continuwuity uses.
|
||||
|
||||
```sh
|
||||
kanidm system oauth2 add-redirect-url c10y https://matrix.example.com/_continuwuity/oidc/complete
|
||||
```
|
||||
|
||||
Allow Continuwuity to request the `openid` scope.
|
||||
|
||||
```sh
|
||||
kanidm system oauth2 update-scope-map c10y idm_all_persons openid
|
||||
```
|
||||
|
||||
Find the client secret that was generated.
|
||||
```sh
|
||||
kanidm system oauth2 show-basic-secret c10y
|
||||
d1qgx352kkuvs1j70b6w293d65x68jve1f7b27fyk90gjhpr
|
||||
```
|
||||
|
||||
Now the discovery URL for KanIDM is: `https://idm.example.com/oauth2/openid/c10y`
|
||||
|
||||
</Tab>
|
||||
<Tab label="Authelia">
|
||||
|
||||
To create a new client in Authelia, it is [recommended][authelia-faq-client-secret] to randomly generate both the client id and client secret. The commands below should get you those:
|
||||
|
||||
<Tabs groupId="authelia-generate-client-details">
|
||||
<Tab label="Bare Binary">
|
||||
```sh
|
||||
# Generate random value for Client ID
|
||||
authelia crypto rand --length 72 --charset rfc3986
|
||||
# Generate Client Secret (labeled Random Password) and its Digest
|
||||
authelia crypto hash generate pbkdf2 --variant sha512 --random --random.length 72 --random.charset rfc3986
|
||||
```
|
||||
</Tab>
|
||||
<Tab label="Docker">
|
||||
```sh
|
||||
# Generate random value for Client ID
|
||||
docker run --rm authelia/authelia:latest authelia crypto rand --length 72 --charset rfc3986
|
||||
# Generate Client Secret (labeled Random Password) and its Digest
|
||||
docker run --rm authelia/authelia:latest authelia crypto hash generate pbkdf2 --variant sha512 --random --random.length 72 --random.charset rfc3986
|
||||
```
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
Authelia only needs to know the digest of the secret, whereas Continuwuity requires the secret itself.
|
||||
|
||||
Go to your Authelia configuration file, find the `identity_provers` block, and add a block for Continuwuity to the `clients` list:
|
||||
|
||||
```yaml
|
||||
identity_providers:
|
||||
oidc:
|
||||
jwks:
|
||||
# This part has the JWKs and is what you configured previously
|
||||
# ...
|
||||
clients:
|
||||
# Add this block below to the clients list
|
||||
- client_name: continuwuity
|
||||
client_id: "client-id-goes-here"
|
||||
# Use the client secret's DIGEST, not the client secret itself
|
||||
client_secret: "client-secret-DIGEST-goes-here"
|
||||
redirect_uris: ["https://matrix.example.com/_continuwuity/oidc/complete"]
|
||||
scopes: [openid]
|
||||
```
|
||||
Then restart Authelia to load the new configuration.
|
||||
|
||||
The discovery URL is simply the root domain of your Authelia, where it can be reached by clients, i.e. `https://idm.example.com`.
|
||||
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
[kanidm]: https://kanidm.com
|
||||
[authelia]: https://www.authelia.com
|
||||
[authelia-faq-client-secret]: https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#how-do-i-generate-a-client-identifier-or-client-secret
|
||||
|
||||
### Configuring Continuwuity
|
||||
|
||||
Configure Continuwuity with the client ID, client secret, and discovery URL provided from the steps above.
|
||||
|
||||
```toml
|
||||
[global.oauth.oidc]
|
||||
|
||||
# `/.well-known/openid-configuration` will be appended automatically
|
||||
discovery_url = "https://your-discovery-url"
|
||||
|
||||
client_id = "your-client-id"
|
||||
client_secret = "your-client-secret"
|
||||
```
|
||||
|
||||
### Testing that it works
|
||||
|
||||
Finally, restart Continuwuity, and log out and back in again. Your client should prompt you to continue in your web browser and open a webpage with the Continuwuity logo that allows you to continue in your identity provider. Once you log in successfully there, you will be prompted to choose a user ID -- to link your existing account, enter its user ID, and then your old password.
|
||||
|
||||
Continuwuity offers several additional configuration options to tweak its integration with your identity provider. Review the `[global.oauth.oidc]` section towards the bottom of the [reference configuration](../reference/config) for a complete list of options and documentation.
|
||||
|
||||
## Advanced options
|
||||
|
||||
### Minting tokens for non-OIDC accounts
|
||||
|
||||
With OIDC delegation enabled, accounts without an OIDC mapping (such as bot accounts) can still be created via the admin commands, but will not be able to log in to the homeserver. To accommodate this, homeserver admins can use the [`!admin users issue-token`](../reference/admin/users#admin-users-issue-token) command to issue tokens for them. This command requires the account to have set a local password, which can be done with [`!admin users reset-password`](../reference/admin/users#admin-users-reset-password).
|
||||
|
||||
### Manually linking users to OIDC claims
|
||||
|
||||
To view associations between local users and their linked subject claim, issue the following command:
|
||||
|
||||
```
|
||||
!admin query raw raw-iter openidsubject_localpart
|
||||
("1d3fc994-3947-406d-b22c-0fc529baf235", "john")
|
||||
("ba543628-e6a5-45d8-9bd2-6cc497400136", "jane")
|
||||
```
|
||||
|
||||
These associations can be changed manually with the [`!admin oidc`](../reference/admin/oidc) commands, which are useful to debug some account linkage issues. For example, to link the user `jane` to a new Subject Identifier claim of `721c36a8-ce04-4474-8e97-b62655b07340`:
|
||||
|
||||
```
|
||||
!admin oidc unlink ba543628-e6a5-45d8-9bd2-6cc497400136
|
||||
Subject `ba543628-e6a5-45d8-9bd2-6cc497400136` unlinked.
|
||||
!admin oidc link jane 721c36a8-ce04-4474-8e97-b62655b07340
|
||||
Subject `721c36a8-ce04-4474-8e97-b62655b07340` linked to account @jane:example.com.
|
||||
!admin query raw raw-iter openidsubject_localpart
|
||||
("1d3fc994-3947-406d-b22c-0fc529baf235", "john")
|
||||
("721c36a8-ce04-4474-8e97-b62655b07340", "jane")
|
||||
```
|
||||
|
||||
### Decommissioning OIDC delegation
|
||||
|
||||
It is possible to revert to using the internal database for authentication. First, comment out the `[global.oauth.oidc]` section in your config file and restart the homeserver. Then, execute the [`!admin users reset-password --convert-to-local-account`](../reference/admin/users#admin-users-reset-password) for each user to assign them a local password and convert their linked accounts into local ones.
|
||||
+2
-21
@@ -303,33 +303,14 @@ For browser-based clients, you can also inspect connections using DevTools' Netw
|
||||
|
||||
### Docker loopback networking issues
|
||||
|
||||
Some distros do not allow Docker containers in bridge networks to connect to their host's public IP by default. This makes `lk-jwt-service` fail connecting to `livekit` or `continuwuity` on the same host, causing refused and timed out connections to appear in the log entries of the JWT service, even when `LIVEKIT_URL` has been configured correctly.
|
||||
|
||||
You can also test that this is the case by cURLing from a sidecar container:
|
||||
Some distros do not allow Docker containers to connect to the host's public IP, and this breaks connections from `lk-jwt-service` towards `livekit` and `continuwuity` if they're on the same host. This can be tested by the following command:
|
||||
|
||||
```bash
|
||||
docker run --rm --net container:lk-jwt-service docker.io/curlimages/curl https://livekit.example.com
|
||||
# --- some errors ---
|
||||
```
|
||||
|
||||
To resolve this, configure an `extra_hosts` file mapping LiveKit's and Continuwuity's domain names to Docker's custom host loopback address, represented here by `host-gateway`:
|
||||
|
||||
```diff
|
||||
# in docker-compose.yaml
|
||||
services:
|
||||
lk-jwt-service:
|
||||
...
|
||||
+ extra_hosts:
|
||||
+ - "livekit.example.com:host-gateway"
|
||||
+ - "matrix.example.com:host-gateway"
|
||||
```
|
||||
|
||||
After implementing the changes and restarting your compose, `lk-jwt-service` should now connect to your other services. The sidecar container test above should now return an `OK` from LiveKit.
|
||||
|
||||
For more information about the `host-gateway` parameter, kindly refer to the `--add-host` documentation for [Docker][docker-add-host] and [Podman][podman-add-host]. Should you have further difficulties, feel free to enquire in the support rooms.
|
||||
|
||||
[docker-add-host]: https://docs.docker.com/reference/cli/docker/container/run/#add-host
|
||||
[podman-add-host]: https://docs.podman.io/en/latest/markdown/podman-run.1.html#add-host-hostname-hostname-ip
|
||||
To resolve this, follow the steps in [Docker loopback networking issues](../troubleshooting.mdx#docker-loopback-networking-issues) of the Troubleshooting page.
|
||||
|
||||
### Incorrect IP address for LiveKit
|
||||
|
||||
|
||||
@@ -37,6 +37,10 @@ CONTINUWUITY_ANTISPAM__DRAUPNIR__BASE_URL="https://draupnir.example.com"
|
||||
# Alternatively, you can pass a (quoted) struct to define an entire section
|
||||
# This maps to the [global.well_known] section
|
||||
CONTINUWUITY_WELL_KNOWN="{ client=https://example.com,server=example.com:443 }"
|
||||
|
||||
# Options that take a list are written as a (quoted) array
|
||||
CONTINUWUITY_TRUSTED_SERVERS='["matrix.org"]'
|
||||
CONTINUWUITY_PORT='[8008, 8448]'
|
||||
```
|
||||
|
||||
### Alternative prefixes
|
||||
|
||||
+106
-1
@@ -1,3 +1,108 @@
|
||||
import { OverviewGroup } from '@rspress/core/theme';
|
||||
|
||||
# Deploying
|
||||
|
||||
This chapter describes various ways to deploy Continuwuity.
|
||||
This chapter describes various ways to deploy Continuwuity. Start reading on this page for useful general information, and then proceed to one of the deployment methods.
|
||||
|
||||
:::tip Getting help
|
||||
If you run into any problems while setting up Continuwuity, ask us in [`#continuwuity:continuwuity.org`][support-room] or [open an issue on Forgejo][forgejo-new-issue].
|
||||
:::
|
||||
|
||||
[support-room]: https://matrix.to/#/%23continuwuity:continuwuity.org
|
||||
[forgejo-new-issue]: https://forgejo.ellis.link/continuwuation/continuwuity/issues/new
|
||||
|
||||
## Release tracks
|
||||
|
||||
Continuwuity offers two release tracks to accommodate different needs: tracking the **main branch** of the [repository], and following the regular **release schedule**.
|
||||
|
||||
### Main branch
|
||||
|
||||
As Continuwuity is rapidly evolving software, we encourage deployments to follow the main branch to receive the latest fixes and features. Commits in main are stable and have been thoroughly tested by the maintainers before merging.
|
||||
|
||||
To be notified of updates to main, it is best to [**track the `/changelog.d` directory**][changelog-d] in the repository, which contains changelog snippets from merged pull requests. These may contain breaking changes. Then, proceed to update or build Continuwuity according to your deployment method.
|
||||
|
||||
[repository]: https://forgejo.ellis.link/continuwuation/continuwuity
|
||||
[changelog-d]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/changelog.d
|
||||
|
||||
### Regular releases
|
||||
|
||||
Regular releases are periodic, versioned cutoffs from the main branch from time to time, and can be found on the [Releases] page. They are suitable in cases where updating more frequently is not viable, such as when using third-party packaging.
|
||||
|
||||
For regular releases, **always read the release notes before upgrading to a new version**, as they may contain breaking changes that affect your deployment.
|
||||
|
||||
[Releases]: https://forgejo.ellis.link/continuwuation/continuwuity/releases
|
||||
|
||||
## Installation
|
||||
|
||||
:::info Mind the name!
|
||||
The binary for Continuwuity is called `conduwuit`, and the configuration file `conduwuit.toml`.
|
||||
:::
|
||||
|
||||
To have Continuwuity working, you will generally need to:
|
||||
|
||||
1. Have a domain name pointing to your server's IP address - we will be using `example.com` in our guides.
|
||||
2. Download or build Continuwuity from your preferred source.
|
||||
3. Configure Continuwuity via the config file or environment variables. See the [Configuration](./configuration.mdx) page for more.
|
||||
4. Employ a reverse proxy in front of Continuwuity - we will mainly provide examples for Caddy in our guides.
|
||||
5. And finally, start the Continuwuity service.
|
||||
|
||||
Navigate to your preferred method of deploying Continuwuity as listed below, and follow the instructions there.
|
||||
|
||||
<OverviewGroup
|
||||
group={{
|
||||
items: [
|
||||
{
|
||||
"link": "deploying/generic",
|
||||
"text": "Generic"
|
||||
},
|
||||
{
|
||||
"link": "deploying/docker",
|
||||
"text": "Docker"
|
||||
},
|
||||
{
|
||||
"link": "deploying/debian",
|
||||
"text": "Debian"
|
||||
},
|
||||
{
|
||||
"link": "deploying/rpm",
|
||||
"text": "RPM"
|
||||
},
|
||||
{
|
||||
"link": "deploying/nixos",
|
||||
"text": "NixOS"
|
||||
},
|
||||
{
|
||||
"link": "deploying/arch-linux",
|
||||
"text": "Arch Linux"
|
||||
},
|
||||
{
|
||||
"link": "deploying/freebsd",
|
||||
"text": "FreeBSD"
|
||||
},
|
||||
{
|
||||
"link": "deploying/kubernetes",
|
||||
"text": "Kubernetes"
|
||||
},
|
||||
{
|
||||
"link": "deploying/nomad",
|
||||
"text": "Nomad"
|
||||
}
|
||||
],
|
||||
}}
|
||||
/>
|
||||
|
||||
## Post-installation
|
||||
|
||||
After Continuwuity is up and running, consider the following:
|
||||
|
||||
- For smooth federation, set up a caching resolver according to the [**DNS tuning guide**](./guides/dns.mdx) (strongly recommended).
|
||||
|
||||
- To set up Audio/Video communication, see the [**Calls**](./calls.mdx) page.
|
||||
|
||||
- See the [**Authentication chapter**](./authentication.mdx) for various ways to access to your homeserver, such as logging in with an external OIDC provider.
|
||||
|
||||
- Consult the [**Maintenance**](./maintenance.mdx) page for guidance on maintaining your homeserver.
|
||||
|
||||
- If you want to set up an appservice, take a look at the [**Appservice Guide**](./appservices.mdx).
|
||||
|
||||
- See the [**Troubleshooting**](./troubleshooting.mdx) page for commonly diagnosed issues.
|
||||
@@ -29,6 +29,11 @@
|
||||
"name": "arch-linux",
|
||||
"label": "Arch Linux"
|
||||
},
|
||||
{
|
||||
"type": "file",
|
||||
"name": "freebsd",
|
||||
"label": "FreeBSD"
|
||||
},
|
||||
{
|
||||
"type": "file",
|
||||
"name": "kubernetes",
|
||||
@@ -38,10 +43,5 @@
|
||||
"type": "file",
|
||||
"name": "nomad",
|
||||
"label": "Nomad"
|
||||
},
|
||||
{
|
||||
"type": "file",
|
||||
"name": "freebsd",
|
||||
"label": "FreeBSD"
|
||||
}
|
||||
]
|
||||
@@ -1,5 +1,11 @@
|
||||
# Continuwuity for Arch Linux
|
||||
|
||||
Continuwuity is available in the `archlinuxcn` repository and AUR with the same package name `continuwuity`, which includes the latest tagged version. The development version is available on AUR as `continuwuity-git`.
|
||||
Continuwuity is available in the [`archlinuxcn`][archlinuxcn] repository and AUR with the same package name, [`continuwuity`][aur-continuwuity].
|
||||
|
||||
Simply install the `continuwuity` package. Configure the service in `/etc/conduwuit/conduwuit.toml`, then enable and start the continuwuity.service.
|
||||
The development version is available on the AUR as [`continuwuity-git`][aur-continuwuity-git].
|
||||
|
||||
[archlinuxcn]: https://www.archlinuxcn.org/
|
||||
[aur-continuwuity]: https://aur.archlinux.org/packages/continuwuity
|
||||
[aur-continuwuity-git]: https://aur.archlinux.org/packages/continuwuity-git
|
||||
|
||||
Simply install the `continuwuity` package. Configure the service in `/etc/conduwuit/conduwuit.toml`, then enable and start the `continuwuity.service`.
|
||||
+68
-26
@@ -1,15 +1,17 @@
|
||||
# Continuwuity for Docker
|
||||
|
||||
This page describes how to deploy Continuwuity via Docker containers. Make sure that you have installed `docker` on your system before continuing.
|
||||
|
||||
## Preparation
|
||||
|
||||
### Choose an image
|
||||
|
||||
The following OCI images are available for Continuwuity:
|
||||
|
||||
| Image | Notes |
|
||||
| Image | Notes |
|
||||
| ------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| [https://forgejo.ellis.link/continuwuation/continuwuity:**latest**][latest] | Latest tagged release. (recommended) |
|
||||
| [https://forgejo.ellis.link/continuwuation/continuwuity:**main**][main] | Latest `main` branch commit. Built with [CI][release-image] |
|
||||
| [https://forgejo.ellis.link/continuwuation/continuwuity:**latest**][latest] | Latest tagged release. |
|
||||
| [https://forgejo.ellis.link/continuwuation/continuwuity:**main**][main] | Latest `main` branch commit. Built with [CI][release-image] |
|
||||
| [https://forgejo.ellis.link/continuwuation/continuwuity:**latest-maxperf**][latest-maxperf] | Latest tagged release, [performance optimised version](./generic.mdx#performance-optimised-builds). |
|
||||
| [https://forgejo.ellis.link/continuwuation/continuwuity:**main-maxperf**][main-maxperf] | Latest `main` branch commit, [performance optimised version](./generic.mdx#performance-optimised-builds). |
|
||||
|
||||
@@ -51,7 +53,7 @@ For more setups with `.well-known` delegation and split-domain deployments, cons
|
||||
Docker Compose is the recommended deployment method for Continuwuity containers. The following environment variables will be set:
|
||||
|
||||
- `CONTINUWUITY_SERVER_NAME` - Your Matrix server's domain name. **This CANNOT be changed later without a data wipe.**
|
||||
- `CONTINUWUITY_DATABASE_PATH` - Where to store your database. This must match the docker volume mount.
|
||||
- `CONTINUWUITY_DATABASE_PATH` - Where to store your database. This must match the docker bind mount.
|
||||
- `CONTINUWUITY_ADDRESS` - Bind address (for Docker, use `0.0.0.0` to listen on all interfaces).
|
||||
|
||||
Alternatively, you can specify a path to mount the configuration file using the `CONTINUWUITY_CONFIG` environment variable.
|
||||
@@ -87,7 +89,9 @@ Consult the [**DNS tuning guide (recommended)**](../guides/dns.mdx) for full sol
|
||||
|
||||
<summary>docker-compose.with-caddy.yml ([view raw](/deploying/docker-compose.with-caddy.yml))</summary>
|
||||
|
||||
Create a Caddyfile with the following content:
|
||||
Create a directory called `caddy-data`, which will store TLS certs obtained by Caddy.
|
||||
|
||||
Then, create a Caddyfile with the following content:
|
||||
|
||||
```
|
||||
https://example.com:443, https://example.com:8448 {
|
||||
@@ -95,7 +99,7 @@ https://example.com:443, https://example.com:8448 {
|
||||
}
|
||||
```
|
||||
|
||||
Then, for the docker-compose:
|
||||
Then, for the docker compose file:
|
||||
|
||||
```yaml file="../public/deploying/docker-compose.with-caddy.yml"
|
||||
|
||||
@@ -108,6 +112,10 @@ Then, for the docker-compose:
|
||||
<details>
|
||||
<summary>docker-compose.with-caddy-labels.yml ([view raw](/deploying/docker-compose.with-caddy-labels.yml))</summary>
|
||||
|
||||
Create a directory called `caddy-data`, which will store TLS certs obtained by Caddy.
|
||||
|
||||
Then, for the docker compose file:
|
||||
|
||||
```yaml file="../public/deploying/docker-compose.with-caddy-labels.yml"
|
||||
|
||||
```
|
||||
@@ -130,6 +138,10 @@ Then, for the docker-compose:
|
||||
<details>
|
||||
<summary>docker-compose.with-traefik.yml ([view raw](/deploying/docker-compose.with-traefik.yml))</summary>
|
||||
|
||||
Create a directory called `traefik-acme-data`, which will store TLS certs obtained by Caddy.
|
||||
|
||||
Then, for the docker compose file:
|
||||
|
||||
```yaml file="../public/deploying/docker-compose.with-traefik.yml"
|
||||
|
||||
```
|
||||
@@ -162,10 +174,15 @@ See the [Other reverse proxies](generic.mdx#setting-up-the-reverse-proxy) sectio
|
||||
|
||||
### Starting Your Server
|
||||
|
||||
1. Choose your compose file from the above, and rename it to `docker-compose.yml`. Replace `example.com` with your homeserver's domain name, and edit other values as you see fit.
|
||||
2. If using the override file, rename it to `docker-compose.override.yml` and
|
||||
edit your values.
|
||||
3. Start the server:
|
||||
1. Create a directory named `continuwuity-data`. This will be where your server's database lives.
|
||||
|
||||
2. Choose your compose file from the above, and rename it to `docker-compose.yml`. Replace `example.com` with your homeserver's domain name, and edit other values as you see fit.
|
||||
|
||||
- Follow all extra instructions as needed.
|
||||
|
||||
- If using the override file, rename it to `docker-compose.override.yml` and edit your values.
|
||||
|
||||
3. Start the server with the following command:
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
@@ -187,9 +204,7 @@ See the [Other reverse proxies](generic.mdx#setting-up-the-reverse-proxy) sectio
|
||||
Pick your own username and password!
|
||||
```
|
||||
|
||||
5. Log in to your server with any Matrix client, and register for an account with the registration token from step 4. You'll automatically be invited to the admin room where you can [manage your server](../reference/admin).
|
||||
|
||||
See the [generic deployment guide](generic.mdx) for more deployment options.
|
||||
5. Log in to your server with any Matrix client, and register for an account with the registration token from the previous step. You'll automatically be invited to the admin room where you can [manage your server](../reference/admin).
|
||||
|
||||
## Testing
|
||||
|
||||
@@ -197,7 +212,9 @@ Test that your setup works by following these [instructions](./generic.mdx#how-d
|
||||
|
||||
Check your container logs using `docker-compose logs --follow` to debug any issues. See the [Troubleshooting](../troubleshooting.mdx) page for common errors and how to fix them.
|
||||
|
||||
## Updating
|
||||
## Maintenance
|
||||
|
||||
### Updating
|
||||
|
||||
To update to a new version of Continuwuity, use the following commands:
|
||||
|
||||
@@ -210,7 +227,17 @@ docker compose pull
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
## Other deployment methods
|
||||
### Backups
|
||||
|
||||
The database in `./continuwuity-data` is present on the host system as a regular directory, and therefore can be backed up using normal mechanisms. See the [Backup](../maintenance.mdx#backups) section of the Maintenance page for more details.
|
||||
|
||||
## What's next?
|
||||
|
||||
Navigate to [Post-installation](../deploying.mdx#post-installation) for next steps.
|
||||
|
||||
---
|
||||
|
||||
## Appendix - Other deployment methods
|
||||
|
||||
### Docker - Quick Run
|
||||
|
||||
@@ -262,12 +289,6 @@ Get a working Continuwuity server with an admin user in four steps:
|
||||
|
||||
Once configured, log in to your server with any Matrix client, and register for an account with the registration token from step 3. If you did not configure step 4., log in via the `http://<your_server_ip>:8008` address. You will be automatically invited to the admin room where you can [manage your server](../reference/admin).
|
||||
|
||||
### (Optional) Building Custom Images
|
||||
|
||||
For information on building your own Continuwuity Docker images, see the
|
||||
[Building Docker Images](../development/index.mdx#building-docker-images)
|
||||
section in the development documentation.
|
||||
|
||||
### Accessing the Server's Console
|
||||
|
||||
Before you can access the server's console and [send admin commands](../reference/admin/index.md) from the CLI, you will need to make the container interactive and allocate a pseudo-tty. Make sure you set `admin_console_automatic` to `true` in [the config](../reference/config.mdx) as well for Continuwuity to activate the CLI on startup.
|
||||
@@ -290,9 +311,30 @@ Note that using `CTRL+c` within `docker attach`'s context will forward the signa
|
||||
|
||||
[docker-attach-reference]: https://docs.docker.com/reference/cli/docker/container/attach/
|
||||
|
||||
## Next steps
|
||||
### Using Docker volumes
|
||||
|
||||
- For smooth federation, set up a caching resolver according to the [**DNS tuning guide**](../guides/dns.mdx) (recommended)
|
||||
- To set up Audio/Video communication, see the [**Calls**](../calls.mdx) page.
|
||||
- Consult the [Maintenance](../maintenance.mdx) page for guidance on maintaining your homeserver.
|
||||
- If you want to set up an appservice, take a look at the [**Appservice Guide**](../appservices.mdx).
|
||||
The example compose files above utilizes [bind mounts][docker-bind-mounts]. If you want to use [Docker volumes][docker-volumes] instead, apply these changes to your compose file:
|
||||
|
||||
```diff
|
||||
services:
|
||||
continuwuity:
|
||||
# ...
|
||||
volumes:
|
||||
- - ./continuwuity-data:/var/lib/continuwuity
|
||||
+ - continuwuity-data:/var/lib/continuwuity
|
||||
|
||||
+volumes:
|
||||
+ continuwuity-data:
|
||||
```
|
||||
|
||||
Consult the [Docker docs][docker-volumes-backup-restore] for details on backing up and restoring Docker volumes
|
||||
|
||||
[docker-bind-mounts]: https://docs.docker.com/engine/storage/bind-mounts/
|
||||
[docker-volumes]: https://docs.docker.com/engine/storage/volumes/
|
||||
[docker-volumes-backup-restore]: https://docs.docker.com/engine/storage/volumes/#back-up-restore-or-migrate-data-volumes
|
||||
|
||||
### Building Custom Images
|
||||
|
||||
For information on building your own Continuwuity Docker images, see the
|
||||
[Building Docker Images](../development/index.mdx#building-docker-images)
|
||||
section in the development documentation.
|
||||
@@ -4,4 +4,6 @@ Continuwuity doesn't provide official FreeBSD packages; however, a community-mai
|
||||
|
||||
Please see the installation instructions in that repository. Direct any questions to its issue tracker or to [@katie:kat5.dev](https://matrix.to/#/@katie:kat5.dev).
|
||||
|
||||
For general BSD support, please join our [Continuwuity BSD](https://matrix.to/#/%23bsd:continuwuity.org) community room.
|
||||
For general BSD support, please join our [Continuwuity support room][support-room].
|
||||
|
||||
[support-room]: https://matrix.to/#/%23continuwuity:continuwuity.org
|
||||
@@ -1,12 +1,6 @@
|
||||
# Generic deployment documentation
|
||||
|
||||
:::tip Getting help
|
||||
If you run into any problems while setting up Continuwuity, ask us in
|
||||
`#continuwuity:continuwuity.org` or [open an issue on
|
||||
Forgejo][forgejo-new-issue].
|
||||
:::
|
||||
|
||||
[forgejo-new-issue]: https://forgejo.ellis.link/continuwuation/continuwuity/issues/new
|
||||
This page provides instructions on deploying Continuwuity on a generic Linux distro via a systemd service file. It also contains common routing instructions for reverse proxies.
|
||||
|
||||
## Installing Continuwuity
|
||||
|
||||
@@ -205,6 +199,11 @@ header, making federation non-functional. If you find a workaround, please share
|
||||
|
||||
Furthermore, Nginx users need to increase the `client_max_body_size` setting (default is 1M) to match the `max_request_size` defined in conduwuit.toml.
|
||||
|
||||
- For HAProxy, ensure that the ACL for the `Host` header matches both the domain and the domain with the port, as federation requests are often sent with the port included. This can be done by using the `host_only` directive:
|
||||
```
|
||||
acl matrix-host hdr(host),host_only -i example.com
|
||||
```
|
||||
|
||||
## Starting Your Server
|
||||
|
||||
Now you can start Continuwuity with:
|
||||
@@ -270,11 +269,9 @@ curl https://example.com/_matrix/client/versions
|
||||
|
||||
## What's next?
|
||||
|
||||
- For smooth federation, set up a caching resolver according to the [**DNS tuning guide**](../guides/dns.mdx) (recommended)
|
||||
- To configure OIDC login with an identity provider, see the [**delegated authentication guide**](../guides/oidc.mdx).
|
||||
- For Audio/Video call functionality see the [**Calls**](../calls.md) page.
|
||||
- Consult the [Maintenance](../maintenance.mdx) page for guidance on maintaining your homeserver.
|
||||
- If you want to set up an appservice, take a look at the [**Appservice Guide**](../appservices.md).
|
||||
Navigate to [Post-installation](../deploying.mdx#post-installation) for next steps.
|
||||
|
||||
---
|
||||
|
||||
## Appendix
|
||||
|
||||
|
||||
@@ -79,7 +79,7 @@ spec:
|
||||
value: "https://matrix.example.com"
|
||||
- name: CONTINUWUITY_ALLOW_REGISTRATION
|
||||
value: "false"
|
||||
- name: RUST_LOG
|
||||
- name: CONTINUWUITY_LOG
|
||||
value: info
|
||||
readinessProbe:
|
||||
httpGet:
|
||||
|
||||
+36
-20
@@ -1,4 +1,4 @@
|
||||
import { Tab, Tabs} from '@rspress/core/theme';
|
||||
import { Tab, Tabs } from '@rspress/core/theme';
|
||||
|
||||
# RPM Installation Guide
|
||||
|
||||
@@ -28,7 +28,7 @@ Available for openSUSE Tumbleweed, Slowroll, and [supported Leap versions](https
|
||||
|
||||
## Installation methods
|
||||
|
||||
### Stable releases (recommended)
|
||||
### Stable releases
|
||||
|
||||
<Tabs groupId="distro">
|
||||
<Tab label="Fedora">
|
||||
@@ -49,6 +49,7 @@ openSUSE packages are available through an openSUSE Build Service project namesp
|
||||
</Tabs>
|
||||
|
||||
### Nightly releases
|
||||
|
||||
Nightly versions are built from the latest commit on the `main` branch every 24 hours.
|
||||
|
||||
<Tabs groupId="distro">
|
||||
@@ -68,14 +69,22 @@ In the meantime, you may follow the [generic deployment instructions](generic).
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
## Service management and removal
|
||||
## Configuration
|
||||
|
||||
**Systemd service commands**
|
||||
Consult the [generic deployment instructions](./generic.mdx) for detailed steps. You will at least need to adjust the config file located at `/etc/conduwuit/conduwuit.toml` to suit your needs, and configure a [reverse proxy](./generic.mdx#setting-up-the-reverse-proxy).
|
||||
|
||||
## Service management
|
||||
|
||||
Now, you can start your Continuwuity service with:
|
||||
|
||||
```bash
|
||||
# Start the service
|
||||
sudo systemctl start conduwuit
|
||||
```
|
||||
|
||||
Other useful commands include:
|
||||
|
||||
```bash
|
||||
# Enable on boot
|
||||
sudo systemctl enable conduwuit
|
||||
|
||||
@@ -84,27 +93,13 @@ sudo systemctl status conduwuit
|
||||
|
||||
# View logs
|
||||
sudo journalctl -u conduwuit -f
|
||||
```
|
||||
|
||||
**Uninstallation**
|
||||
|
||||
```bash
|
||||
# Stop and disable the service
|
||||
# Stopping the service
|
||||
sudo systemctl stop conduwuit
|
||||
sudo systemctl disable conduwuit
|
||||
|
||||
# Remove the package
|
||||
sudo dnf remove continuwuity # replace `dnf` with `zypper` on openSUSE
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**GPG key errors**: Temporarily disable GPG checking
|
||||
|
||||
```bash
|
||||
sudo dnf --nogpgcheck install continuwuity
|
||||
```
|
||||
|
||||
**Repository metadata issues**: Clear and rebuild cache
|
||||
|
||||
```bash
|
||||
@@ -122,7 +117,28 @@ dnf --showduplicates list continuwuity
|
||||
sudo dnf install continuwuity-<version>
|
||||
```
|
||||
|
||||
## Building locally
|
||||
## What's next?
|
||||
|
||||
Navigate to [Post-installation](../deploying.mdx#post-installation) for next steps.
|
||||
|
||||
---
|
||||
|
||||
## Appendix
|
||||
|
||||
### Uninstallation
|
||||
|
||||
To uninstall Continuwuity:
|
||||
|
||||
```bash
|
||||
# Stop and disable the service
|
||||
sudo systemctl stop conduwuit
|
||||
sudo systemctl disable conduwuit
|
||||
|
||||
# Remove the package
|
||||
sudo dnf remove continuwuity # replace `dnf` with `zypper` on openSUSE
|
||||
```
|
||||
|
||||
### Building locally
|
||||
|
||||
<Tabs groupId="distro">
|
||||
<Tab label="Fedora">
|
||||
|
||||
@@ -16,7 +16,12 @@
|
||||
},
|
||||
{
|
||||
"type": "file",
|
||||
"name": "oidc",
|
||||
"label": "Delegated authentication"
|
||||
"name": "metrics",
|
||||
"label": "Metrics"
|
||||
},
|
||||
{
|
||||
"type": "file",
|
||||
"name": "push",
|
||||
"label": "Push notifications"
|
||||
}
|
||||
]
|
||||
@@ -0,0 +1,100 @@
|
||||
# Metrics
|
||||
|
||||
Continuwuity records metrics with OpenTelemetry and can export them in two ways, both disabled by default:
|
||||
|
||||
- **Prometheus scraping** from `/_continuwuity/metrics`
|
||||
- **OTLP push**, alongside traces
|
||||
|
||||
## Prometheus
|
||||
|
||||
```toml
|
||||
[global]
|
||||
allow_prometheus_metrics = true
|
||||
prometheus_metrics_token = "a-long-random-secret"
|
||||
```
|
||||
|
||||
The endpoint is served on the same listener as the rest of the server. Either set `prometheus_metrics_token` or block `/_continuwuity/metrics` at your reverse proxy so it is not publicly readable.
|
||||
|
||||
```yaml
|
||||
scrape_configs:
|
||||
- job_name: continuwuity
|
||||
scheme: https
|
||||
metrics_path: /_continuwuity/metrics
|
||||
authorization:
|
||||
credentials: a-long-random-secret
|
||||
static_configs:
|
||||
- targets: ["matrix.example.com"]
|
||||
```
|
||||
|
||||
## OTLP
|
||||
|
||||
Requires the `otlp_telemetry` feature, enabled in default builds.
|
||||
|
||||
```toml
|
||||
[global]
|
||||
allow_otlp_metrics = true
|
||||
```
|
||||
|
||||
Configure the exporter with standard OpenTelemetry environment variables:
|
||||
|
||||
```sh
|
||||
OTEL_EXPORTER_OTLP_ENDPOINT=http://collector:4318
|
||||
OTEL_EXPORTER_OTLP_METRICS_PROTOCOL=http/protobuf # or "grpc"
|
||||
OTEL_METRIC_EXPORT_INTERVAL=15000
|
||||
```
|
||||
|
||||
`service.instance.id` defaults to the server name, and `OTEL_RESOURCE_ATTRIBUTES` or `OTEL_SERVICE_NAME` override the defaults.
|
||||
|
||||
Prometheus can receive OTLP directly when started with `--web.enable-otlp-receiver`, using `http://prometheus:9090/api/v1/otlp` as the endpoint.
|
||||
|
||||
## Exported metrics
|
||||
|
||||
Names below are as they appear in Prometheus. OTLP uses the dotted OpenTelemetry names, such as `continuwuity.sender.events`. HTTP and process metrics follow the OpenTelemetry semantic conventions.
|
||||
|
||||
| Metric | Type | Labels | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `target_info` | gauge | `service_version`, `service_instance_id` | Running server version and name |
|
||||
| `http_server_request_duration_seconds` | histogram | `http_request_method`, `http_route`, `http_response_status_code`, `network_protocol_name`, `network_protocol_version`, `url_scheme` | Handled HTTP requests, by route template |
|
||||
| `http_server_active_requests` | gauge | `http_request_method`, `url_scheme` | Requests currently being handled |
|
||||
| `http_server_request_body_size_bytes` | histogram | HTTP request duration labels | Request body sizes, when `Content-Length` is supplied |
|
||||
| `http_server_response_body_size_bytes` | histogram | HTTP request duration labels | Response body sizes, when known |
|
||||
| `continuwuity_federation_incoming_transaction_duration_seconds` | histogram | `outcome` | Processing time of incoming transactions |
|
||||
| `continuwuity_federation_incoming_transactions_active` | gauge | | Incoming transactions currently being processed |
|
||||
| `continuwuity_federation_incoming_pdus_total` | counter | `type`, `outcome` | Incoming PDUs by event type and outcome: `accepted`, `forbidden`, `invalid`, `error` or `unparsable` |
|
||||
| `continuwuity_federation_incoming_pdu_duration_seconds` | histogram | `outcome` | Time to handle an incoming PDU |
|
||||
| `continuwuity_federation_incoming_pdu_lag_seconds` | histogram | | Time between an accepted PDU's `origin_server_ts` and its arrival |
|
||||
| `continuwuity_federation_incoming_edus_total` | counter | `type` | Incoming EDUs by type |
|
||||
| `continuwuity_federation_incoming_edu_duration_seconds` | histogram | `type` | Time to handle an incoming EDU |
|
||||
| `continuwuity_federation_outgoing_request_duration_seconds` | histogram | `outcome` | Outgoing federation requests |
|
||||
| `continuwuity_federation_destinations` | gauge | `state` | Remote servers in retry `backoff` or with a `stale` destination cache entry |
|
||||
| `continuwuity_sender_transaction_duration_seconds` | histogram | `destination`, `outcome` | Outgoing federation, appservice and push transactions |
|
||||
| `continuwuity_sender_events_total` | counter | `destination`, `kind`, `outcome` | PDUs and EDUs sent in outgoing transactions |
|
||||
| `continuwuity_sender_events_queued_total` | counter | `destination`, `kind` | PDUs and EDUs queued for sending |
|
||||
| `continuwuity_sender_queue_depth` | gauge | | Messages waiting for the sender workers |
|
||||
| `continuwuity_users` | gauge | `origin` | Known `local` users, including deactivated, and `remote` users |
|
||||
| `continuwuity_invites_total` | counter | `direction`, `destination`, `outcome` | Invites sent by local users or received over federation |
|
||||
| `continuwuity_media_write_size_bytes` | histogram | `origin` | Media files written, from local uploads or cached remote media |
|
||||
| `continuwuity_media_read_size_bytes` | histogram | `origin` | Media files served |
|
||||
| `continuwuity_media_files` | gauge | | Stored media files, including thumbnails |
|
||||
| `continuwuity_antispam_checks_total` | counter | `check`, `outcome` | Antispam service checks; denials include the service being unreachable |
|
||||
| `continuwuity_database_size_bytes` | gauge | | Total size of RocksDB SST files |
|
||||
| `continuwuity_database_memory_bytes` | gauge | `name` | RocksDB memtable, table reader and row cache usage |
|
||||
| `continuwuity_database_block_cache_bytes` | gauge | `column` | RocksDB block cache usage |
|
||||
| `continuwuity_cache_entries` | gauge | `name` | Entries in the auth chain and state info caches |
|
||||
| `continuwuity_jemalloc_memory_bytes` | gauge | `kind` | jemalloc statistics, only with the `jemalloc_stats` feature |
|
||||
| `process_uptime_seconds` | gauge | | Time since the server started |
|
||||
| `process_cpu_time_seconds_total` | counter | `cpu_mode` | CPU time used by the process |
|
||||
| `process_memory_usage_bytes` | gauge | | Resident memory (Linux) |
|
||||
| `process_memory_virtual_bytes` | gauge | | Virtual memory (Linux) |
|
||||
| `process_unix_file_descriptor_count` | gauge | | Open file descriptors (Linux) |
|
||||
| `continuwuity_tokio_workers` | gauge | | Tokio runtime worker threads |
|
||||
| `continuwuity_tokio_alive_tasks` | gauge | | Alive tokio tasks |
|
||||
| `continuwuity_tokio_global_queue_depth` | gauge | | Tasks in the tokio global queue |
|
||||
| `continuwuity_tokio_worker_busy_time_seconds_total` | counter | | Time worker threads spent busy |
|
||||
| `continuwuity_tokio_worker_parks_total` | counter | | Number of times worker threads parked |
|
||||
|
||||
User and media file counts are estimates taken from RocksDB (`rocksdb.estimate-num-keys`), so they may lag slightly or drift after deletions.
|
||||
|
||||
## Grafana dashboard
|
||||
|
||||
Import [grafana-dashboard.json](/guides/grafana-dashboard.json) under **Dashboards → New → Import**, or provision it from a file.
|
||||
@@ -1,56 +0,0 @@
|
||||
# Configuring delegated authentication
|
||||
|
||||
Continuwuity supports delegating user authentication to an external identity provider that implements the OpenID Connect specification, such as Authentik, kanidm, or Keycloak.
|
||||
|
||||
:::warning{title="OIDC versus OAuth, and supported clients"}
|
||||
**OIDC** is not to be confused with **OAuth**. In the context of Matrix, OAuth is the protocol that Matrix clients use to authenticate with the _homeserver_. OIDC is the protocol that the _homeserver_ uses to communicate with the _identity provider_. Continuwuity supports OAuth by default, alongside the legacy **UIAA** authentication framework.
|
||||
|
||||
When OIDC is configured, Continuwuity will disable its support for legacy authentication. **Only clients that support OAuth**, such as the Element family of clients, will be able to log in when OIDC is configured. If your client of choice shows an error when you try to log in after configuring OIDC, it likely does not support OAuth. This is an issue with your client, not Continuwuity, and should be reported to your client's developers.
|
||||
:::
|
||||
|
||||
A simple OIDC configuration is as easy as creating a new OIDC application in your identity provider's settings and supplying Continuwuity with the client ID and client secret. This guide will use kanidm as an example, but the described steps are broadly applicable to other identity providers.
|
||||
|
||||
First, create a new application for Continuwuity in your identity provider.
|
||||
```sh
|
||||
# Here, `c10y` is the client ID that kanidm will use, and `Continuwuity` is the display name.
|
||||
# Other identity providers may generate a client ID for you.
|
||||
# Use the domain that clients can reach Continuwuity at, which may not be the same as your server name
|
||||
# if you have configured well-known delegation.
|
||||
kanidm system oauth2 create c10y Continuwuity https://matrix.yourdomain.com
|
||||
```
|
||||
|
||||
Configure the redirect URL that Continuwuity uses.
|
||||
```sh
|
||||
kanidm system oauth2 add-redirect-url c10y https://matrix.yourdomain.com/_continuwuity/oidc/complete
|
||||
```
|
||||
|
||||
Allow Continuwuity to request the `openid` scope. Other identity providers may not require this step.
|
||||
```sh
|
||||
kanidm system oauth2 update-scope-map c10y idm_all_persons openid
|
||||
```
|
||||
|
||||
Find the client secret that was generated. Other identity providers may show this information in their web UI.
|
||||
```sh
|
||||
kanidm system oauth2 show-basic-secret c10y
|
||||
d1qgx352kkuvs1j70b6w293d65x68jve1f7b27fyk90gjhpr
|
||||
```
|
||||
|
||||
Configure Continuwuity with the client ID, client secret, and discovery URL. kanidm has a different discovery URL for each client, but other identity providers may have a single discovery URL at the root of their domain.
|
||||
|
||||
```toml
|
||||
[global.oauth.oidc]
|
||||
|
||||
# `/.well-known/openid-configuration` will be appended automatically
|
||||
discovery_url = "https://idm.example.com/oauth2/openid/c10y"
|
||||
|
||||
# This may be randomly generated by your identity provider. kanidm requires
|
||||
# you to set it manually when you create the application.
|
||||
client_id = "c10y"
|
||||
|
||||
# From the previous step
|
||||
client_secret = "d1qgx352kkuvs1j70b6w293d65x68jve1f7b27fyk90gjhpr"
|
||||
```
|
||||
|
||||
Finally, restart Continuwuity, and log out and back in again. Your client should prompt you to continue in your web browser and open a webpage with the Continuwuity logo that allows you to continue in your identity provider. Once you log in successfully, you will be prompted to choose a user ID -- to link your existing account, enter its user ID, and then your old password when prompted.
|
||||
|
||||
Continuwuity offers several additional configuration options to tweak its integration with your identity provider. Review the `[global.oauth.oidc]` section towards the bottom of the [reference configuration](../reference/config) for a complete list of options and documentation.
|
||||
@@ -113,7 +113,7 @@ https://matrix.example.com {
|
||||
|
||||
### Tuning your trusted servers
|
||||
|
||||
:::info Vet your trusted servers!
|
||||
:::important Important: Vet your trusted servers!
|
||||
Trusted servers are your first point of contact when obtaining public keys from other servers, and they could theoretically impersonate other servers and cause significant harm to your deployment. Please thoroughly verify your trusted servers' credibility before adding them to your configuration.
|
||||
|
||||
If you need suggestions for trusted servers, ask in the Continuwuity main room.
|
||||
@@ -128,7 +128,7 @@ trusted_servers = ["codestorm.net","starstruck.systems","unredacted.org","matrix
|
||||
|
||||
Avoid prioritising `matrix.org` as your primary trusted server, as it tends to be quite slow.
|
||||
|
||||
Some users have also reported that increasing `trusted_server_batch_size` has helped with faster joins for huge rooms. Start with doubling the default to `2048` until you find a suitable value.
|
||||
Some users have also reported that increasing `trusted_server_batch_size` helps with faster joins for huge rooms. Start with doubling the default to `2048` until you find a suitable value.
|
||||
|
||||
### Enable HTTP/3 on your reverse proxy
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 27 KiB |
@@ -0,0 +1,215 @@
|
||||
import { Tab, Tabs } from '@rspress/core/theme';
|
||||
|
||||
# Push notifications
|
||||
|
||||
Matrix clients receive notifications in the following ways:
|
||||
|
||||
- **In-band notifications**, which are shown when the client actively syncs with the server.
|
||||
- **Push notifications**, which are posted to the client by the server through an external push service. This is typically used to send out-of-band notifications to mobile devices, and it is the focus of this page.
|
||||
|
||||
Generally, your mobile device is preconfigured for push notifications out of the box. The details below are for advanced use cases, such as using an alternative push backend (like UnifiedPush) or hosting your own.
|
||||
|
||||
## Overview
|
||||
|
||||
Continuwuity supports two push methods: the legacy **Matrix Push Gateway** and the new **Web Push** protocol. The former is currently supported by more clients, but the latter enables end-to-end-encrypted push notifications. They work as follows:
|
||||
|
||||
<Tabs groupId="push-ops">
|
||||
<Tab label="Registration">
|
||||
<img src="./push-registration.webp"
|
||||
alt="Diagram showing the push registration flow, described in the text below."
|
||||
style= {{"max-height":300,display:"flex",margin:"1rem auto","border-radius":"5px"}}
|
||||
/>
|
||||
|
||||
1. A client app obtains a _push key_ from the push app that it hooks up to.
|
||||
2. Then, it registers a _pusher_ with Continuwuity, bringing along the _push key_ and the following additional information:
|
||||
- For the Push Gateway method: The _push gateway_ URL, which is [provided by the client](#unifiedpush-and-push-gateways).
|
||||
- For the Web Push method: Some _encryption details_ generated by the client, so the server knows how to encrypt its push payloads.
|
||||
|
||||
</Tab>
|
||||
|
||||
<Tab label="Operation (Push Gateway)">
|
||||
<img src="./push-operation-gateway.webp"
|
||||
alt="Diagram showing the push operation with the Push Gateway method, described in the text below."
|
||||
style={{"max-height":300,display:"flex",margin:"1rem auto","border-radius":"5px"}}
|
||||
/>
|
||||
|
||||
1. Continuwuity pushes messages to the push gateway
|
||||
2. The push gateway converts the messages to a suitable format and forwards them to the push provider server.
|
||||
3. The push provider server passes them along to the push app.
|
||||
4. The push app wakes the client, prompting it to fetch new messages from Continuwuity.
|
||||
5. Finally, the client calculates against a set of _push rules_ to determine whether the fetched message(s) should be notified to users.
|
||||
|
||||
</Tab>
|
||||
|
||||
<Tab label="Operation (Web Push)">
|
||||
<img src="./push-operation-webpush.webp"
|
||||
alt="Diagram showing the push operation with the Web Push method, described in the text below."
|
||||
style={{"max-height":300,display:"flex",margin:"1rem auto","border-radius":"5px"}}
|
||||
/>
|
||||
|
||||
1. Continuwuity pushes encrypted messages to the push provider server.
|
||||
2. The push provider server passes them along to the push app.
|
||||
3. The push app wakes the client, which decrypts the payload, and if needed, fetches new messages from Continuwuity.
|
||||
4. Finally, the client calculates against a set of _push rules_ to determine whether the pushed message(s) should be notified to users.
|
||||
|
||||
Note that this mechanism does not require a push gateway component.
|
||||
|
||||
[MSC4174]: https://github.com/matrix-org/matrix-spec-proposals/pull/4174
|
||||
|
||||
</Tab>
|
||||
|
||||
</Tabs>
|
||||
|
||||
_([excalidraw file of the diagrams](/guides/push-notifications.excalidraw))_
|
||||
|
||||
Therefore, Continuwuity's role within this system is to keep track of client-registered _pushers_ and send relevant payloads to them. To view and manage these pushers, use the [`!admin query pusher`](../reference/admin/query.md#admin-query-pusher) set of commands.
|
||||
|
||||
## UnifiedPush
|
||||
|
||||
[UnifiedPush][unifiedpush] is an open and self-hostable notifications system that is supported by many Matrix clients on Android and Linux. It is compatible with both the Web Push and Push Gateway mechanisms, and therefore requires no additional setup from the homeserver.
|
||||
|
||||
:::info Debugging UnifiedPush
|
||||
To debug and test your UnifiedPush installation, use the [UP-Example] app for Android and the [UnifiedPush Troubleshooter] app for Linux distributions.
|
||||
:::
|
||||
|
||||
[unifiedpush]: https://unifiedpush.org
|
||||
[UP-Example]: https://codeberg.org/UnifiedPush/android-example
|
||||
[UnifiedPush Troubleshooter]: https://flathub.org/en/apps/org.unifiedpush.Troubleshooter
|
||||
|
||||
### UnifiedPush and push gateways
|
||||
|
||||
The push gateway URL is usually pre-configured by the client app. However, some clients (such as Element X) implement UnifiedPush's [Gateway Discovery] mechanism, and attempt to detect a push gateway _on the same domain as the push provider_, before falling back to a hardcoded one.
|
||||
|
||||
Per the [spec][spec-push-gateway-api], these push gateways must be available on the `/_matrix/push/v1/notify` path of said domain. To test that a push gateway is accessible to the homeserver, make a request for it from the homeserver's IP:
|
||||
|
||||
```txt
|
||||
curl https://push.example.com/_matrix/push/v1/notify
|
||||
{"unifiedpush":{"gateway":"matrix"}}
|
||||
```
|
||||
|
||||
[Gateway Discovery]: https://unifiedpush.org/users/gateway/#discovery--hosting
|
||||
|
||||
### ntfy
|
||||
|
||||
[ntfy][ntfy] is a widely supported UnifiedPush implementation, with an easy-to-install push app and plenty of publicly available instances. Its server includes an embedded Matrix push gateway and can be self-hosted.
|
||||
|
||||
Some tutorials on self-hosting ntfy can be found below:
|
||||
|
||||
- [Official ntfy self-hosting tutorial][official-ntfy-selfhosting]
|
||||
- [Element's tutorial on Unified Push and ntfy][element-ntfy]
|
||||
|
||||
:::warning Avoid ntfy.sh
|
||||
Avoid using the `https://ntfy.sh` push server, which is configured as the default in the ntfy app. This server is known to ratelimit requests aggressively.
|
||||
:::
|
||||
|
||||
[ntfy]: https://ntfy.sh
|
||||
[element-ntfy]: https://docs.element.io/latest/element-support/element-androidios-client-settings/using-unified-push-and-ntfy-for-push-notifications/
|
||||
[official-ntfy-selfhosting]: https://docs.ntfy.sh/install/
|
||||
|
||||
### Other UnifiedPush distributors
|
||||
|
||||
To find a list of other UnifiedPush distributors, visit this [page][unifiedpush-distributors].
|
||||
|
||||
[unifiedpush-distributors]: https://unifiedpush.org/users/distributors/
|
||||
|
||||
Community tutorials for selfhosting some of these stacks are listed below. Unless stated otherwise, they are all tested against Element X Android and the push gateway mechanism, but they should work with Web Push as well.
|
||||
|
||||
- [Self-hosting Sunup for Matrix and UnifiedPush][kimiblock-selfhosting-sunup], by Kimiblock.
|
||||
- Push gateway: [common-proxies]
|
||||
- Push server: [autopush-rs]
|
||||
- Push app: [Sunup][sunup]
|
||||
- [Matrix notifications on Android, powered by XMPP][stratself-xmpp], by stratself.
|
||||
- Push gateway: [common-proxies]
|
||||
- Push server: [ejabberd's mod_unified_push]
|
||||
- Push app: [Conversations] (and forks)
|
||||
- [Element X push notifications via Conversations][alfredolin-xmpp], by Alfredo Lin.
|
||||
- Push gateway: [common-proxies]
|
||||
- Push server: [Prosody's mod_unified_push]
|
||||
- Push app: [Conversations]
|
||||
- Nextcloud's NextPush flow, which uses the following stack:
|
||||
- Push server + push gateway: [uppush] (selfhosting tutorial included)
|
||||
- Push app: [NextPush Android]
|
||||
|
||||
[kimiblock-selfhosting-sunup]: https://blog.kimiblock.top/2025/09/11/selfhosting-sunup/
|
||||
[stratself-xmpp]: https://muoi.me/~stratself/articles/matrix-notifs-xmpp
|
||||
[alfredolin-xmpp]: https://alfredolin.eu/blog/2026/07/24/element-x-push-notifications-via-conversations/
|
||||
[common-proxies]: https://codeberg.org/UnifiedPush/common-proxies/
|
||||
[sunup]: https://codeberg.org/Sunup/android
|
||||
[autopush-rs]: https://github.com/mozilla-services/autopush-rs
|
||||
[ejabberd's mod_unified_push]: https://github.com/processone/ejabberd-contrib/tree/master/mod_unified_push
|
||||
[Prosody's mod_unified_push]: https://modules.prosody.im/mod_unified_push
|
||||
[Conversations]: https://conversations.im
|
||||
[uppush]: https://codeberg.org/NextPush/uppush
|
||||
[NextPush Android]: https://codeberg.org/NextPush/nextpush-android
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Issues with push notifications can arise from the components of the system beyond your homeserver (for example, if the connection fails between the gateway and the push server). Make sure you check the logs of these components for debugging as well.
|
||||
|
||||
### Locally hosted push gateways / push providers
|
||||
|
||||
Outbound requests, including push notifications, follows the `ip_range_denylist` config option which refuses loopback and private-range destinations by default. This would break against push components that are self-hosted on a LAN address, and will result in these log entries at push creation time:
|
||||
|
||||
```txt
|
||||
WARN conduwuit_service::pusher: Pusher URL is a forbidden remote address url=https://push.example.com/_matrix/push/v1/notify
|
||||
```
|
||||
|
||||
To fix this, remove your push gateway or push server's address from `ip_range_denylist`, and restart Continuwuity to apply the changes.
|
||||
|
||||
### Push notifications not audible/not displaying
|
||||
|
||||
This is likely an issue with your account's _push rules_, which determines which events are shown to to the user as notifications. Check these push rules in the client's notifications settings and tweak accordingly. Continuwuity also provides an [`!admin users reset-push-rules`](../reference/admin/users#admin-users-reset-push-rules) command, which restores the rules to the default of notifying for every message.
|
||||
|
||||
Another reason may be that push background services are frequently being terminated by your operating system, which is a [well-known problem][dontkillmyapp] with many Android-based systems. To fix this, follow your operating system's instructions to exempt your push app from background restrictions.
|
||||
|
||||
Otherwise, if you find Continuwuity not sending push notifications according to the spec, feel free to discuss in our [support room][support-room] or open an issue.
|
||||
|
||||
[dontkillmyapp]: https://dontkillmyapp.com
|
||||
[support-room]: https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org
|
||||
|
||||
### Various "Could not send request to pusher" log entries
|
||||
|
||||
If you find spurious log entries like this in your Continuwuity deployment:
|
||||
|
||||
```txt
|
||||
WARN push{user_id="@user:example.com" pushkey="very-long-string-of-letters" events=1}:send_push_notice:send_notice:send_request: conduwuit_service::pusher: Could not send request to pusher https//push.example.com: error sending request for url (https://push.example.com/_matrix/push/v1/notify)
|
||||
```
|
||||
|
||||
Then, your server is most likely sending push requests to too many invalid targets. This could be due to one of the following reasons:
|
||||
|
||||
#### Connection issues between the server and the push gateway
|
||||
|
||||
Verify that the connection to the push gateway is working correctly. This includes checking firewall rules, DNS, and that the push gateway is online. The section on [locally-hosted gateways/push providers](#locally-hosted-push-gateways--push-providers) may also apply to you.
|
||||
|
||||
#### Expired push endpoints
|
||||
|
||||
Active Matrix clients periodically renew their pushkeys as the old ones expire, and consequently register them against Continuwuity. As these pushers build up over time, the homeserver will keep sending more requests to an increasing number of "dead" push endpoints. This results in the errors seen above, and can heavily impact performance if not mitigated.
|
||||
|
||||
To work around this issue, the following actions can be taken:
|
||||
|
||||
- Delete all of a user's pushers with the [`!admin query pusher delete-all-user`](../reference/admin/query##admin-query-pusher-delete-all-user) command. This command is not typically disruptive, as active clients will re-register new pushers the next time they log on.
|
||||
- Alternatively, delete one's own pushers from a client that supports doing so. Currently this only includes FluffyChat and Element Classic/SchildiChat Legacy.
|
||||
|
||||
While clients are supposed to automatically delete old pushers under their own control, this behaviour has been inconsistent. A further discussion of this issue can be found in [#2242][issue-2242].
|
||||
|
||||
[issue-2242]: https://forgejo.ellis.link/continuwuation/continuwuity/issues/2242
|
||||
|
||||
## Related Documentation
|
||||
|
||||
Specifications:
|
||||
|
||||
- [Matrix specification for the Push Gateway API][spec-push-gateway-api]
|
||||
- [Matrix Client-Server API for push notifications][spec-c-s-push-notifications]
|
||||
- [UnifiedPush specifications][unifiedpush-spec]
|
||||
- [MSC4174: Web push][MSC4174]
|
||||
- [Web Push RFCs][webpush-rfcs]
|
||||
|
||||
Other:
|
||||
|
||||
- [Matrix Push Rules and Notifications][clokep-push] - blogpost on push rules in Matrix
|
||||
|
||||
[webpush-rfcs]: https://datatracker.ietf.org/wg/webpush/documents/
|
||||
[spec-push-gateway-api]: https://spec.matrix.org/latest/push-gateway-api/
|
||||
[spec-c-s-push-notifications]: https://spec.matrix.org/latest/client-server-api/#push-notifications
|
||||
[unifiedpush-spec]: https://unifiedpush.org/developers/spec/definitions/
|
||||
[clokep-push]: https://patrick.cloke.us/posts/2023/05/08/matrix-push-rules-notifications/
|
||||
@@ -32,33 +32,5 @@ beforeFeatures:
|
||||
link: https://matrix.org/docs/matrix-concepts/elements-of-matrix/
|
||||
buttonText: Read the Guide
|
||||
|
||||
features:
|
||||
- title: 🚀 High Performance
|
||||
details: Built with Rust for exceptional speed and efficiency. Designed to run smoothly even on modest hardware.
|
||||
- title: 🔒 Secure by Default
|
||||
details: Memory-safe Rust implementation with built-in security features to protect your communication.
|
||||
- title: 🌐 Matrix Protocol
|
||||
details: Fully compatible with the Matrix ecosystem. Connect with users across the federated network.
|
||||
- title: 🛠️ Community Maintained
|
||||
details: Actively developed by a dedicated community of Matrix enthusiasts and contributors.
|
||||
- title: 📦 Easy to Deploy
|
||||
details: Multiple deployment options including Docker, NixOS, and traditional package managers.
|
||||
- title: 🔌 Appservice Support
|
||||
details: Bridge to other platforms like Discord, Telegram, and more with Matrix appservices.
|
||||
|
||||
doc: false
|
||||
---
|
||||
|
||||
## What is Continuwuity?
|
||||
|
||||
Continuwuity is a Matrix homeserver.
|
||||
|
||||
Matrix is an open chat network that lets anyone talk to anyone, no matter what server or address they use - sort of like email.
|
||||
|
||||
Continuwuity receives and keeps track of all your messages, and delivers what you send to the right people.
|
||||
|
||||
## Why is Continuwuity different?
|
||||
|
||||
Continuwuity is light and fast, using a fraction of the memory of other major homeservers. It's also simple to set up, and secure by default.
|
||||
|
||||
We are a community run project, filled with diverse and friendly people. Everything is built by people who care about the project volunteering their free time.
|
||||
+86
-70
@@ -1,98 +1,114 @@
|
||||
<div align="center">
|
||||
|
||||
<img src="/assets/logo.svg" width="150"/>
|
||||
|
||||
# Continuwuity
|
||||
|
||||
## A community-driven [Matrix](https://matrix.org/) homeserver in Rust
|
||||
</div>
|
||||
|
||||
[](https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org) [](https://matrix.to/#/#space:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org)
|
||||
## What is Continuwuity?
|
||||
|
||||
[continuwuity] is a Matrix homeserver written in Rust.
|
||||
It's the official community continuation of the [conduwuit](https://github.com/girlbossceo/conduwuit) homeserver.
|
||||
Continuwuity is a Matrix homeserver. [Matrix] is an open chat network that lets anyone talk to anyone, no matter what server or address they use, like email.
|
||||
|
||||
[](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)
|
||||
Continuwuity receives and keeps track of all your messages, and delivers what you send to the right people.
|
||||
|
||||
[](https://github.com/continuwuity/continuwuity) [](https://github.com/continuwuity/continuwuity/stargazers)
|
||||
[Matrix]: https://matrix.org
|
||||
|
||||
[](https://gitlab.com/continuwuity/continuwuity) [](https://gitlab.com/continuwuity/continuwuity/-/starrers)
|
||||
## Why is Continuwuity different?
|
||||
|
||||
[](https://codeberg.org/continuwuity/continuwuity) [](https://codeberg.org/continuwuity/continuwuity/stars)
|
||||
Continuwuity is light and fast, using a fraction of the resources of other major homeservers. It's also simple to set up, and secure by default.
|
||||
|
||||
## Why does this exist?
|
||||
We are a community-run project, made up of friendly and diverse people. Everything is built by people who care about the project volunteering their free time.
|
||||
|
||||
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.
|
||||
## Deploying Continuwuity
|
||||
|
||||
We aim to provide a stable, well-maintained alternative for current conduwuit users and welcome newcomers seeking a lightweight, efficient Matrix homeserver.
|
||||
Head over to the [**Deploying chapter**](./deploying.mdx) to get started.
|
||||
|
||||
## Who are we?
|
||||
## Try it out!
|
||||
|
||||
We are a group of Matrix enthusiasts, developers and system administrators who have used conduwuit and believe in its potential. Our team includes both previous
|
||||
contributors to the original project and new developers who want to help maintain and improve this important piece of Matrix infrastructure.
|
||||
If you want to try it out as a user, we have some [partnered homeservers](./community/ops-guidelines.mdx) you can use:
|
||||
|
||||
We operate as an open community project, welcoming contributions from anyone interested in improving continuwuity.
|
||||
**`federated.nexus`** - A community resource hosting multiple FOSS (especially federated) services.
|
||||
- Go to https://federated.nexus, click on "Apply to Join", and follow the prompts.
|
||||
- Once your request has been accepted, you will receive an email with your username and password, which you can use to sign in from any Matrix client.
|
||||
- Remember to change your password after logging in!
|
||||
|
||||
## What is Matrix?
|
||||
**`continuwuity.rocks`** - the demo server, run by us.
|
||||
- Sign up using any Matrix client, or via this [convenient link][cinny-register] for Cinny.
|
||||
|
||||
[Matrix](https://matrix.org) is an open, federated, and extensible network for
|
||||
decentralized communication. Users from any Matrix homeserver can chat with users from all
|
||||
other homeservers over federation. Matrix is designed to be extensible and built on top of.
|
||||
You can even use bridges such as Matrix Appservices to communicate with users outside of Matrix, like a community on Discord.
|
||||
[cinny-register]: https://app.cinny.in/register/continuwuity.rocks
|
||||
|
||||
## What are the project's goals?
|
||||
## Donate to us {#donate}
|
||||
|
||||
continuwuity aims to:
|
||||
If you like what we're doing, consider donating to our Open Collective via the button below!
|
||||
|
||||
- Maintain a stable, reliable Matrix homeserver implementation in Rust
|
||||
- Improve compatibility and specification compliance with the Matrix protocol
|
||||
- Fix bugs and performance issues from the original conduwuit
|
||||
- Add missing features needed by homeserver administrators
|
||||
- Provide comprehensive documentation and easy deployment options
|
||||
- Create a sustainable development model for long-term maintenance
|
||||
- Keep a lightweight, efficient codebase that can run on modest hardware
|
||||
<div class="no-zoom" align="center">
|
||||
<br/>
|
||||
<a href="https://opencollective.com/continuwuity" target="_blank">
|
||||
<img src="https://opencollective.com/webpack/donate/button@2x.png?color=blue" width="250"/>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
## Can I try it out?
|
||||
You can also donate individually to each of the maintainers
|
||||
|
||||
Check out the [documentation](https://continuwuity.org) for installation instructions.
|
||||
- Nex: https://timedout.uk/donate.html
|
||||
|
||||
If you want to try it out as a user, we have some partnered homeservers you can use:
|
||||
* You can head over to [https://federated.nexus](https://federated.nexus/) in your browser.
|
||||
* Hit the `Apply to Join` button. Once your request has been accepted, you will receive an email with your username and password.
|
||||
* Head over to [https://app.federated.nexus](https://app.federated.nexus/) and you can sign in there, or use any other matrix chat client you wish elsewhere.
|
||||
* Your username for matrix will be in the form of `@username:federated.nexus`, however you can simply use the `username` part to log in. Your password is your password.
|
||||
- Jade: https://jade.ellis.link/sponsors
|
||||
|
||||
* There's also [https://continuwuity.rocks/](https://continuwuity.rocks/). You can register a new account using Cinny via [this convenient link](https://app.cinny.in/register/continuwuity.rocks), or you can use Element or another matrix client *that supports registration*.
|
||||
|
||||
## What are we working on?
|
||||
|
||||
We're working our way through all of the issues in the [Forgejo project](https://forgejo.ellis.link/continuwuation/continuwuity/issues).
|
||||
|
||||
- [Packaging & availability in more places](https://forgejo.ellis.link/continuwuation/continuwuity/issues/747)
|
||||
- [Appservices bugs & features](https://forgejo.ellis.link/continuwuation/continuwuity/issues?q=&type=all&state=open&labels=178&milestone=0&assignee=0&poster=0)
|
||||
- [Improving compatibility and spec compliance](https://forgejo.ellis.link/continuwuation/continuwuity/issues?labels=119)
|
||||
- Automated testing
|
||||
- [Admin API](https://forgejo.ellis.link/continuwuation/continuwuity/issues/748)
|
||||
- [Policy-list controlled moderation](https://forgejo.ellis.link/continuwuation/continuwuity/issues/750)
|
||||
|
||||
## Can I migrate my data from x?
|
||||
|
||||
- **Conduwuit**: Yes
|
||||
- **Conduit**: No, database is now incompatible
|
||||
- **Grapevine**: No, database is now incompatible
|
||||
- **Dendrite**: No
|
||||
- **Synapse**: No
|
||||
|
||||
We haven't written up a guide on migrating from incompatible homeservers yet. Reach out to us if you need to do this!
|
||||
|
||||
## How can I deploy my own?
|
||||
|
||||
- [Deployment options](deploying)
|
||||
|
||||
If you want to connect an appservice to continuwuity, take a look at the
|
||||
[appservices documentation](appservices).
|
||||
|
||||
## How can I contribute?
|
||||
|
||||
See the [contributor's guide](development/contributing)
|
||||
- Ginger: https://github.com/sponsors/gingershaped
|
||||
|
||||
## Contact
|
||||
|
||||
Join our [Matrix room](https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org) and [space](https://matrix.to/#/#space:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org) to chat with us about the project!
|
||||
|
||||
[continuwuity]: https://forgejo.ellis.link/continuwuation/continuwuity
|
||||
<div class="no-zoom" align="center">
|
||||
|
||||
[![Chat on Matrix][matrix-chat-badge]][matrix-chatroom]
|
||||
[![Join the space][matrix-space-badge]][matrix-space]
|
||||
|
||||
</div>
|
||||
|
||||
[matrix-chat-badge]: https://img.shields.io/matrix/continuwuity%3Acontinuwuity.org?server_fqdn=matrix.continuwuity.org&fetchMode=summary&logo=matrix
|
||||
[matrix-chatroom]: https://matrix.to/#/#continuwuity:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org
|
||||
[matrix-space-badge]: https://img.shields.io/matrix/space%3Acontinuwuity.org?server_fqdn=matrix.continuwuity.org&fetchMode=summary&logo=matrix&label=space
|
||||
[matrix-space]: https://matrix.to/#/#space:continuwuity.org?via=continuwuity.org&via=ellis.link&via=explodie.org&via=matrix.org
|
||||
|
||||
|
||||
Our source code and mirrors can be accessed through these buttons:
|
||||
|
||||
<div class="no-zoom" align="center">
|
||||
|
||||
[![forgejo.ellis.link][forge-badge]][forge-link]
|
||||
[![Releases][forge-releases-badge]][forge-releases-link]
|
||||
[![Stars][forge-stars-badge]][forge-stars-link]
|
||||
[![Issues][forge-issues-badge]][forge-issues-link]
|
||||
[![Pull Requests][forge-pulls-badge]][forge-pulls-link]
|
||||
|
||||
[![GitHub][github-badge]][github-link] ![Stars][github-stars-badge] -
|
||||
[![Codeberg][codeberg-badge]][codeberg-link] [![Stars][codeberg-stars-badge]][codeberg-stars-link] -
|
||||
[![GitLab][gitlab-badge]][gitlab-link] [![Stars][gitlab-stars-badge]][gitlab-stars-link]
|
||||
|
||||
</div>
|
||||
|
||||
[forge-badge]: https://img.shields.io/badge/Ellis%20Git-main+packages-green?style=flat&logo=forgejo&labelColor=fff
|
||||
[forge-link]: https://forgejo.ellis.link/continuwuation/continuwuity
|
||||
[forge-releases-badge]: https://forgejo.ellis.link/continuwuation/continuwuity/badges/release.svg?style=flat&label=Latest%20release&labelColor=fff&color=green
|
||||
[forge-releases-link]: https://forgejo.ellis.link/continuwuation/continuwuity
|
||||
[forge-stars-badge]: https://forgejo.ellis.link/continuwuation/continuwuity/badges/stars.svg?style=flat&labelColor=fff&color=8a5cd0
|
||||
[forge-stars-link]: https://forgejo.ellis.link/continuwuation/continuwuity/stars
|
||||
[forge-issues-badge]: https://forgejo.ellis.link/continuwuation/continuwuity/badges/issues/open.svg?style=flat&labelColor=fff&color=8a5cd0
|
||||
[forge-issues-link]: https://forgejo.ellis.link/continuwuation/continuwuity/issues?state=open
|
||||
[forge-pulls-badge]: https://forgejo.ellis.link/continuwuation/continuwuity/badges/pulls/open.svg?style=flat&labelColor=fff&color=8a5cd0
|
||||
[forge-pulls-link]: https://forgejo.ellis.link/continuwuation/continuwuity/pulls?state=open
|
||||
|
||||
[github-badge]: https://img.shields.io/badge/GitHub-mirror-blue?style=flat&logo=github&labelColor=fff&logoColor=24292f
|
||||
[github-link]: https://github.com/continuwuity/continuwuity
|
||||
[github-stars-badge]: https://img.shields.io/github/stars/continuwuity/continuwuity?style=flat&logo=github
|
||||
[gitlab-badge]:https://img.shields.io/badge/GitLab-mirror-blue?style=flat&logo=gitlab&labelColor=fff
|
||||
[gitlab-link]: https://gitlab.com/continuwuity/continuwuity
|
||||
[gitlab-stars-badge]: https://img.shields.io/gitlab/stars/continuwuity/continuwuity?style=flat
|
||||
[gitlab-stars-link]: https://gitlab.com/continuwuity/continuwuity/-/starrers
|
||||
[codeberg-badge]:https://img.shields.io/badge/Codeberg-mirror-2185D0?style=flat&logo=codeberg&labelColor=fff
|
||||
[codeberg-link]: https://codeberg.org/continuwuity/continuwuity
|
||||
[codeberg-stars-badge]: https://codeberg.org/continuwuity/continuwuity/badges/stars.svg?style=flat
|
||||
[codeberg-stars-link]: https://codeberg.org/continuwuity/continuwuity/stars
|
||||
@@ -6,10 +6,10 @@
|
||||
"message": "Welcome to Continuwuity! Important announcements about the project will appear here."
|
||||
},
|
||||
{
|
||||
"id": 20,
|
||||
"id": 21,
|
||||
"mention_room": true,
|
||||
"date": "2026-09-16",
|
||||
"message": "[Continuwuity 26.9.0](https://forgejo.ellis.link/continuwuation/continuwuity/releases/tag/v26.9.0) has just been released - this update features a bunch of bug fixes, and some bandwidth saving improvements for sliding sync.\n\nAny questions? Ask in our [support room](https://matrix.to/#/#continuwuity:continuwuity.org)!"
|
||||
"date": "2026-09-29",
|
||||
"message": "[Continuwuity 26.9.1](https://forgejo.ellis.link/continuwuation/continuwuity/releases/tag/v26.9.1) has just been released - this update features a fix for a **critical** security issue, please read the release notes for more information."
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -6,7 +6,7 @@ services:
|
||||
restart: unless-stopped
|
||||
command: /sbin/conduwuit
|
||||
volumes:
|
||||
- db:/var/lib/continuwuity
|
||||
- ./continuwuity-data:/var/lib/continuwuity
|
||||
- ./continuwuity-resolv.conf:/etc/resolv.conf # use custom resolvers rather than Docker's
|
||||
#- ./continuwuity.toml:/etc/continuwuity.toml
|
||||
networks:
|
||||
|
||||
@@ -12,7 +12,7 @@ services:
|
||||
- proxy
|
||||
volumes:
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
- ./data:/data
|
||||
- ./caddy-data:/data
|
||||
restart: unless-stopped
|
||||
labels:
|
||||
caddy: example.com
|
||||
@@ -23,7 +23,7 @@ services:
|
||||
restart: unless-stopped
|
||||
command: /sbin/conduwuit
|
||||
volumes:
|
||||
- db:/var/lib/continuwuity
|
||||
- ./continuwuity-data:/var/lib/continuwuity
|
||||
- ./continuwuity-resolv.conf:/etc/resolv.conf # use custom resolvers rather than Docker's
|
||||
# - ./continuwuity.toml:/etc/continuwuity.toml
|
||||
environment:
|
||||
@@ -46,8 +46,5 @@ services:
|
||||
caddy: matrix.example.com
|
||||
caddy.reverse_proxy: "{{upstreams 8008}}"
|
||||
|
||||
volumes:
|
||||
db:
|
||||
|
||||
networks:
|
||||
proxy:
|
||||
@@ -9,7 +9,7 @@ services:
|
||||
networks:
|
||||
- caddy
|
||||
volumes:
|
||||
- ./data:/data
|
||||
- ./caddy-data:/data
|
||||
# mount your created Caddyfile into the container
|
||||
- ./Caddyfile:/etc/caddy/Caddyfile
|
||||
restart: unless-stopped
|
||||
@@ -19,7 +19,7 @@ services:
|
||||
restart: unless-stopped
|
||||
command: /sbin/conduwuit
|
||||
volumes:
|
||||
- db:/var/lib/continuwuity
|
||||
- ./continuwuity-data:/var/lib/continuwuity
|
||||
- ./continuwuity-resolv.conf:/etc/resolv.conf # use custom resolvers rather than Docker's
|
||||
# - ./continuwuity.toml:/etc/continuwuity.toml
|
||||
environment:
|
||||
@@ -41,6 +41,3 @@ services:
|
||||
|
||||
networks:
|
||||
proxy:
|
||||
|
||||
volumes:
|
||||
db:
|
||||
@@ -6,7 +6,7 @@ services:
|
||||
restart: unless-stopped
|
||||
command: /sbin/conduwuit
|
||||
volumes:
|
||||
- db:/var/lib/continuwuity
|
||||
- ./continuwuity-data:/var/lib/continuwuity
|
||||
- ./continuwuity-resolv.conf:/etc/resolv.conf # use custom resolvers rather than Docker's
|
||||
#- ./continuwuity.toml:/etc/continuwuity.toml
|
||||
networks:
|
||||
@@ -40,7 +40,7 @@ services:
|
||||
- "443:443"
|
||||
volumes:
|
||||
- "/var/run/docker.sock:/var/run/docker.sock:ro"
|
||||
- "acme:/etc/traefik/acme"
|
||||
- "./traefik-acme-data:/etc/traefik/acme"
|
||||
labels:
|
||||
- "traefik.enable=true"
|
||||
|
||||
@@ -77,9 +77,5 @@ services:
|
||||
TRAEFIK_PROVIDERS_DOCKER_ENDPOINT: "unix:///var/run/docker.sock"
|
||||
TRAEFIK_PROVIDERS_DOCKER_EXPOSEDBYDEFAULT: false
|
||||
|
||||
volumes:
|
||||
db:
|
||||
acme:
|
||||
|
||||
networks:
|
||||
proxy:
|
||||
Loaded 100 of 270 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user