mirror of https://gitlab.com/famedly/conduit
Merge branch 'sync-up-debian-packaging' into 'next'
Sync up Debian packaging See merge request famedly/conduit!510merge-requests/551/head
commit
9f14ad7125
@ -1,28 +1,36 @@
|
|||||||
Conduit for Debian
|
Conduit for Debian
|
||||||
==================
|
==================
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
Configuration
|
Configuration
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
When installed, Debconf generates the configuration of the homeserver
|
When installed, Debconf generates the configuration of the homeserver
|
||||||
(host)name, the address and port it listens on. This configuration ends up in
|
(host)name, the address and port it listens on. This configuration ends up in
|
||||||
/etc/matrix-conduit/conduit.toml.
|
`/etc/matrix-conduit/conduit.toml`.
|
||||||
|
|
||||||
You can tweak more detailed settings by uncommenting and setting the variables
|
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
|
in `/etc/matrix-conduit/conduit.toml`. This involves settings such as the maximum
|
||||||
file size for download/upload, enabling federation, etc.
|
file size for download/upload, enabling federation, etc.
|
||||||
|
|
||||||
Running
|
Running
|
||||||
-------
|
-------
|
||||||
|
|
||||||
The package uses the matrix-conduit.service systemd unit file to start and
|
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
|
stop Conduit. It loads the configuration file mentioned above to set up the
|
||||||
environment before running the server.
|
environment before running the server.
|
||||||
|
|
||||||
This package assumes by default that Conduit will be placed behind a reverse
|
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
|
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
|
on `127.0.0.1` and the free port `6167` and is reachable via a client using the URL
|
||||||
http://localhost:6167.
|
<http://localhost:6167>.
|
||||||
|
|
||||||
At a later stage this packaging may support also setting up TLS and running
|
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
|
stand-alone. In this case, however, you need to set up some certificates and
|
Loading…
Reference in New Issue