diff --git a/pkg/debian/README.md b/pkg/debian/README.md index a0e2fd6ba..68a247bc0 100644 --- a/pkg/debian/README.md +++ b/pkg/debian/README.md @@ -2,7 +2,7 @@ # 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 +## Installation To add the Continuwuation apt repository: ```bash @@ -26,16 +26,20 @@ # Update remote package lists See the [generic deployment guide](/deploying/generic.mdx) for additional information about using the Debian package. -### Configuration +## 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 +## Running The package uses the `conduwuit.service` systemd unit file to start and stop Continuwuity. The binary installs at `/usr/bin/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. + +## What's next? + +Navigate to [Post-installation](../deploying.mdx#post-installation) for next steps.