2020-11-13 20:50:58 +01:00
|
|
|
Conduit for Debian
|
|
|
|
|
==================
|
|
|
|
|
|
2023-07-23 12:34:48 +02:00
|
|
|
Installation
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Information about downloading, building and deploying the Debian package, see
|
|
|
|
|
the "Installing Conduit" section in [DEPLOY.md](../DEPLOY.md).
|
|
|
|
|
All following sections until "Setting up the Reverse Proxy" be ignored because
|
|
|
|
|
this is handled automatically by the packaging.
|
|
|
|
|
|
2020-11-13 20:50:58 +01:00
|
|
|
Configuration
|
|
|
|
|
-------------
|
|
|
|
|
|
2021-04-16 22:10:07 +02:00
|
|
|
When installed, Debconf generates the configuration of the homeserver
|
|
|
|
|
(host)name, the address and port it listens on. This configuration ends up in
|
2023-07-23 12:24:37 +02:00
|
|
|
`/etc/matrix-conduit/conduit.toml`.
|
2020-11-13 20:50:58 +01:00
|
|
|
|
|
|
|
|
You can tweak more detailed settings by uncommenting and setting the variables
|
2023-07-23 12:24:37 +02:00
|
|
|
in `/etc/matrix-conduit/conduit.toml`. This involves settings such as the maximum
|
2021-04-16 22:10:07 +02:00
|
|
|
file size for download/upload, enabling federation, etc.
|
2020-11-13 20:50:58 +01:00
|
|
|
|
|
|
|
|
Running
|
|
|
|
|
-------
|
|
|
|
|
|
2023-07-23 12:24:37 +02:00
|
|
|
The package uses the `matrix-conduit.service` systemd unit file to start and
|
2021-04-16 22:10:07 +02:00
|
|
|
stop Conduit. It loads the configuration file mentioned above to set up the
|
2020-11-13 20:50:58 +01:00
|
|
|
environment before running the server.
|
|
|
|
|
|
2021-04-16 22:11:07 +02:00
|
|
|
This package assumes by default that Conduit will be placed behind a reverse
|
|
|
|
|
proxy such as Apache or nginx. This default deployment entails just listening
|
2023-07-23 12:24:37 +02:00
|
|
|
on `127.0.0.1` and the free port `6167` and is reachable via a client using the URL
|
|
|
|
|
<http://localhost:6167>.
|
2020-11-13 20:50:58 +01:00
|
|
|
|
|
|
|
|
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.
|
