conduwuit/debian
strawberry a063a6d088 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>
2024-05-15 14:31:35 -04:00
..
README.md debian: make the docs actually coherent and understandable, and update it 2024-05-15 14:31:35 -04:00
conduwuit.service docs: add troubleshooting, maintenance, various improvements and fixes 2024-05-09 12:34:50 -04:00
config rename `release_log_level` dev feature to `dev_release_log_level`, some rebranding 2024-04-26 02:03:40 -04:00
postinst debian: create system account verbosely 2024-05-15 14:31:35 -04:00
postrm rename `release_log_level` dev feature to `dev_release_log_level`, some rebranding 2024-04-26 02:03:40 -04:00
templates rename `release_log_level` dev feature to `dev_release_log_level`, some rebranding 2024-04-26 02:03:40 -04:00

README.md

conduwuit 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 for further information if needed as usage of the Debian package is generally related.

Configuration

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.

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 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 as it's the easiest and most user friendly.