Jade Ellis
67e5e11a97
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Successful in 1m24s
Checks / Prek / Check changed files (pull_request) Successful in 8s
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m26s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m53s
Checks / Changelog / Check changelog is added (pull_request_target) Failing after 16s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 8m43s
Also adds an alias for the old binary name to the dockerfile Supersedes !1485 Closes #1536 Closes #2277
45 lines
2.5 KiB
Markdown
45 lines
2.5 KiB
Markdown
# Continuwuity for Debian
|
|
|
|
This document provides information about downloading and deploying the Debian package. You can also use this guide for other deb-based distributions such as Ubuntu.
|
|
|
|
## Installation
|
|
|
|
To add the Continuwuation apt repository:
|
|
```bash
|
|
# Component `"stable"` contains all tagged releases. Use `"stable unstable"` to additionally include all pre-releases (alpha, beta, rc,...)
|
|
# Replace with `"dev"` for bleeding-edge builds at your own risk, these contain
|
|
# automatic nightly builds and might or might not work.
|
|
export COMPONENT="stable"
|
|
# Import the Continuwuation signing key
|
|
sudo curl https://forgejo.ellis.link/api/packages/continuwuation/debian/repository.key -o /etc/apt/keyrings/forgejo-continuwuation.asc
|
|
# Add a new apt source list pointing to the repository
|
|
echo "deb [signed-by=/etc/apt/keyrings/forgejo-continuwuation.asc] https://forgejo.ellis.link/api/packages/continuwuation/debian $(lsb_release -sc) $COMPONENT" | sudo tee /etc/apt/sources.list.d/continuwuation.list
|
|
# Update remote package lists
|
|
sudo apt update
|
|
```
|
|
|
|
To install continuwuity:
|
|
```bash
|
|
sudo apt install continuwuity
|
|
```
|
|
The `continuwuity` package conflicts with the old `conduwuit` package and will remove it automatically when installed.
|
|
|
|
See the [generic deployment guide](/deploying/generic.mdx) for additional information about using the Debian package.
|
|
|
|
## Configuration
|
|
|
|
After installation, Continuwuity places the example configuration at `/etc/continuwuity/continuwuity.toml` as the default configuration file. The configuration file indicates which settings you must change before starting the service.
|
|
|
|
You can customize additional settings by uncommenting and modifying the configuration options in `/etc/continuwuity/continuwuity.toml`.
|
|
|
|
## Running
|
|
|
|
The package uses the `continuwuity.service` systemd unit file to start and stop Continuwuity. The binary installs at `/usr/bin/continuwuity`.
|
|
|
|
By default, this package assumes that Continuwuity runs behind a reverse proxy. The default configuration options apply (listening on `localhost` and TCP port `6167`). Matrix federation requires a valid domain name and TLS. To federate properly, you must set up TLS certificates and certificate renewal.
|
|
|
|
For information about setting up a reverse proxy and TLS, consult online documentation and guides. The [generic deployment guide](/deploying/generic.md#setting-up-the-reverse-proxy) documents Caddy, which is the most user-friendly option for reverse proxy configuration.
|
|
|
|
## What's next?
|
|
|
|
Navigate to [Post-installation](/deploying#post-installation) for next steps.
|