continuwuity/pkg/debian/README.md
Ginger 58bbc0e676
Some checks are pending
Release Docker Image / merge (push) Blocked by required conditions
Release Docker Image / define-variables (push) Successful in 20s
Documentation / Build and Deploy Documentation (push) Successful in 50s
Checks / Prek / Pre-commit & Formatting (push) Successful in 1m6s
Checks / Prek / Clippy and Cargo Tests (push) Successful in 7m3s
Release Docker Image / build-image (linux/amd64, release, linux-amd64, base) (push) Successful in 16m36s
Release Docker Image / build-image (linux/arm64, release, linux-arm64, base) (push) Successful in 18m46s
fix: Move packaging files from dist/ to pkg/
2025-09-06 14:03:57 +00:00

23 lines
1.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 `apt`-based distributions such as Ubuntu.
### Installation
See the [generic deployment guide](../deploying/generic.md) for additional information about using the Debian package.
No `apt` repository is currently available. This feature is in development.
### Configuration
After installation, Continuwuity places the example configuration at `/etc/conduwuit/conduwuit.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/conduwuit/conduwuit.toml`.
### Running
The package uses the [`conduwuit.service`](../configuration/examples.md#example-systemd-unit-file) systemd unit file to start and stop Continuwuity. The binary installs at `/usr/sbin/conduwuit`.
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.