From a063a6d08863dc09259d7bb668d9de83e8549d41 Mon Sep 17 00:00:00 2001 From: strawberry <strawberry@puppygock.gay> Date: Mon, 13 May 2024 22:50:40 -0400 Subject: [PATCH] debian: make the docs actually coherent and understandable, and update it the language here is very poor and i'm not sure why it was written like this. Signed-off-by: strawberry <strawberry@puppygock.gay> --- debian/README.md | 37 +++++++++++++------------------------ 1 file changed, 13 insertions(+), 24 deletions(-) diff --git a/debian/README.md b/debian/README.md index a3f5d57cd..3fe622122 100644 --- a/debian/README.md +++ b/debian/README.md @@ -1,33 +1,22 @@ # conduwuit for Debian -Installation ------------- +Information about downloading and deploying the Debian package. This may also be referenced for other `apt`-based distros such as Ubuntu. -Information about downloading, building and deploying the Debian package, see -the "Installing conduwuit" section in the Deploying docs. -All following sections until "Setting up the Reverse Proxy" be ignored because -this is handled automatically by the packaging. +### Installation -Configuration -------------- +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. -When installed, Debconf generates the configuration of the homeserver -(host)name, the address and port it listens on. This configuration ends up in -`/etc/conduwuit/conduwuit.toml`. +### Configuration -You can tweak more detailed settings by uncommenting and setting the variables -in `/etc/conduwuit/conduwuit.toml`. This involves settings such as the maximum -file size for download/upload, enabling federation, etc. +When installed, the example config is placed at `/etc/conduwuit/conduwuit.toml` as the default config. At the minimum, you will need to change your `server_name` here. -Running -------- +You can tweak more detailed settings by uncommenting and setting the config options +in `/etc/conduwuit/conduwuit.toml`. -The package uses the [`conduwuit.service`](../configuration.md#example-systemd-unit-file) systemd unit file to start and -stop conduwuit. It loads the configuration file mentioned above to set up the -environment before running the server. +### Running -This package assumes by default that conduwuit will be placed behind a reverse -proxy. This default deployment entails just listening -on `127.0.0.1` and the free port `6167` and is reachable via a client using the URL -<http://localhost:6167>. Matrix federation requires TLS, so you will need to set up -some certificates and renewal, for it to work properly. +The package uses the [`conduwuit.service`](../configuration.md#example-systemd-unit-file) systemd unit file to start and stop conduwuit. 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. -- GitLab