mirror of
https://gitlab.com/famedly/conduit.git
synced 2024-12-28 05:23:48 +03:00
433dad6ac2
It is common to have a markdown file per deployment subdirectory. Still install it as `README.Debian` to `/usr/share/doc/matrix-conduit` as per Debian policy. Also update the link in the main `README.md` file.
29 lines
1.1 KiB
Markdown
29 lines
1.1 KiB
Markdown
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 will be 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 `6167` and is reachable via a client using the URL
|
|
<http://localhost:6167>.
|
|
|
|
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.
|