From e7a79b1e030b5ec7defc3b80835b73abf8d60641 Mon Sep 17 00:00:00 2001 From: Ginger Date: Mon, 8 Sep 2025 13:11:04 -0400 Subject: [PATCH] docs: Update Debian installation guide --- pkg/debian/README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/pkg/debian/README.md b/pkg/debian/README.md index b605b198..dc174e5b 100644 --- a/pkg/debian/README.md +++ b/pkg/debian/README.md @@ -1,12 +1,26 @@ # 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. +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 -See the [generic deployment guide](../deploying/generic.md) for additional information about using the Debian package. +To add the Continuwuation apt repository: +```bash +# 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) stable" | sudo tee -a /etc/apt/sources.list.d/continuwuation.list +# Update remote package lists +sudo apt update +``` -No `apt` repository is currently available. This feature is in development. +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.md) for additional information about using the Debian package. ### Configuration @@ -16,7 +30,7 @@ You can customize additional settings by uncommenting and modifying the configur ### 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`. +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/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.