oss/continuwuity
oss/continuwuity
1
0
Fork 0
mirror of https://forgejo.ellis.link/continuwuation/continuwuity.git synced 2025-07-27 10:18:30 +00:00
Code Wiki Activity

docs: Update Docker and generic instructions

Browse source 
Add instructions for proxying .well-known to Continuwuity in with
Traefik. Clarify and expand build instructions in generic deployment,
separating Rust toolchain and Nix approaches.
This commit is contained in:
Jade Ellis 2025-07-14 20:24:29 +01:00
parent 13de0ac822
commit a89ceb93d8
No known key found for this signature in database
GPG key ID: 8705A2A3EBF77BD2
2 changed files with 17 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/deploying/docker.md
View file

@ -137,6 +137,8 @@ and `.well-known/matrix/server`.
With the service `well-known`, we use a single `nginx` container that serves With the service `well-known`, we use a single `nginx` container that serves
those two files. those two files.
Alternatively, you can use Continuwuity's built-in delegation file capability. Set up the delegation files in the configuration file, and then proxy paths under `/.well-known/matrix` to continuwuity. For example, the label ``traefik.http.routers.continuwuity.rule=(Host(`matrix.ellis.link`) || (Host(`ellis.link`) && PathPrefix(`/.well-known/matrix`)))`` does this for the domain `ellis.link`.
## Voice communication ## Voice communication
See the [TURN](../turn.md) page. See the [TURN](../turn.md) page.

25
docs/deploying/generic.md
View file

@ -34,10 +34,21 @@ for performance.
### Compiling ### Compiling
Alternatively, you may compile the binary yourself. We recommend using Alternatively, you may compile the binary yourself.
Nix (or [Lix](https://lix.systems)) to build Continuwuity as this provides the most
guaranteed reproducibility and makes it easiest to set up a build environment and generate ### Building with the Rust toolchain
output. This approach also allows for easy cross-compilation.
If wanting to build using standard Rust toolchains, make sure you install:
- (On linux) `liburing-dev` on the compiling machine, and `liburing` on the target host
- (On linux) `pkg-config` on the compiling machine to allow finding `liburing`
- A C++ compiler and (on linux) `libclang` for RocksDB
You can build Continuwuity using `cargo build --release --all-features`.
### Building with Nix
If you prefer, you can use Nix (or [Lix](https://lix.systems)) to build Continuwuity. This provides improved reproducibility and makes it easy to set up a build environment and generate output. This approach also allows for easy cross-compilation.
You can run the `nix build -L .#static-x86_64-linux-musl-all-features` or You can run the `nix build -L .#static-x86_64-linux-musl-all-features` or
`nix build -L .#static-aarch64-linux-musl-all-features` commands based `nix build -L .#static-aarch64-linux-musl-all-features` commands based
@ -45,12 +56,6 @@ on architecture to cross-compile the necessary static binary located at
`result/bin/conduwuit`. This is reproducible with the static binaries produced `result/bin/conduwuit`. This is reproducible with the static binaries produced
in our CI. in our CI.
If wanting to build using standard Rust toolchains, make sure you install:
- `liburing-dev` on the compiling machine, and `liburing` on the target host
- LLVM and libclang for RocksDB
You can build Continuwuity using `cargo build --release --all-features`
## Adding a Continuwuity user ## Adding a Continuwuity user
While Continuwuity can run as any user, it is better to use dedicated users for While Continuwuity can run as any user, it is better to use dedicated users for