conduit/debian
Paul van Tilburg 5bf43a4d7e
Generate conduit.toml instead of debian environment file
Only generate this file once. I am not sure what to do with future
upgrades yet.
2021-04-22 21:52:40 +02:00
..
README.Debian Generate conduit.toml instead of debian environment file 2021-04-22 21:52:40 +02:00
config Split config into a Debian and local part 2020-11-24 14:42:18 +01:00
matrix-conduit.service Generate conduit.toml instead of debian environment file 2021-04-22 21:52:40 +02:00
postinst Generate conduit.toml instead of debian environment file 2021-04-22 21:52:40 +02:00
postrm First version of cargo-deb packaging setup 2020-11-24 14:38:15 +01:00
templates Split config into a Debian and local part 2020-11-24 14:42:18 +01:00

README.Debian

Conduit for Debian
==================

Configuration
-------------

When installed, Debconf generates the configuration of the homeserver
(host)name, the address and port it listens on. This configuration ends up in
/etc/matrix-conduit/conduit.toml.

You can tweak more detailed settings by uncommenting and setting the variables
in /etc/matrix-conduit/conduit.toml. This involves settings such as the maximum
file size for download/upload, enabling federation, etc.

Running
-------

The package uses the matrix-conduit.service systemd unit file to start and
stop Conduit. It loads the configuration file mentioned above to set up the
environment before running the server.

This package assumes by default that Conduit is placed behind a reverse proxy
such as Apache or nginx. This default deployment entails just listening on
127.0.0.1 and the free port 14004 and is reachable via a client using the URL
http://localhost:14004.

At a later stage this packaging may support also setting up TLS and running
stand-alone.  In this case, however, you need to set up some certificates and
renewal, for it to work properly.