continuwuity/debian/README.md
Jade Ellis beee996f72
Some checks failed
Release Docker Image / define-variables (pull_request) Successful in 1s
Documentation / Build and Deploy Documentation (pull_request) Successful in 35s
Release Docker Image / build-image (linux/arm64, linux-arm64) (pull_request) Successful in 17m16s
Release Docker Image / build-image (linux/amd64, linux-amd64) (pull_request) Failing after 1h32m49s
Release Docker Image / merge (pull_request) Has been cancelled
Release Docker Image / define-variables (push) Successful in 12s
Documentation / Build and Deploy Documentation (push) Successful in 58s
Release Docker Image / build-image (linux/arm64, linux-arm64) (push) Successful in 19m7s
Release Docker Image / build-image (linux/amd64, linux-amd64) (push) Successful in 1h37m14s
Release Docker Image / merge (push) Successful in 21s
docs: Rename conduwuit to continuwuity in more places
2025-05-10 20:37:08 +01:00

29 lines
1.5 KiB
Markdown

# Continuwuity for Debian
Information about downloading and deploying the Debian package. This may also be
referenced for other `apt`-based distros such as Ubuntu.
### Installation
It is recommended to see the [generic deployment guide](../deploying/generic.md)
for further information if needed as usage of the Debian package is generally
related.
No `apt` repository is currently offered yet, it is in the works/development.
### Configuration
When installed, the example config is placed at `/etc/conduwuit/conduwuit.toml`
as the default config. The config mentions things required to be changed before
starting.
You can tweak more detailed settings by uncommenting and setting the config
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 is installed at `/usr/sbin/conduwuit`.
This package assumes by default that conduwuit will be placed behind a reverse proxy. The default config options apply (listening on `localhost` and TCP port `6167`). Matrix federation requires a valid domain name and TLS, so you will need to set up TLS certificates and renewal for it to work properly if you intend to federate.
Consult various online documentation and guides on setting up a reverse proxy and TLS. Caddy is documented at the [generic deployment guide](../deploying/generic.md#setting-up-the-reverse-proxy) as it's the easiest and most user friendly.