summaryrefslogtreecommitdiff
path: root/debian
diff options
context:
space:
mode:
authorPaul van Tilburg <paul@luon.net>2023-07-23 12:24:37 +0200
committerPaul van Tilburg <paul@luon.net>2023-07-23 12:37:38 +0200
commit433dad6ac2d7cba9146a403cddafdacfef6ceacc (patch)
tree9864c735ccf1c9e67430d7df3e711b3b7e35130e /debian
parent8cf408e96689afc3a03afd1209cdc9cdc68330d3 (diff)
downloadconduit-433dad6ac2d7cba9146a403cddafdacfef6ceacc.zip
Turn README.Debian into a markdown file
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.
Diffstat (limited to 'debian')
-rw-r--r--debian/README.md (renamed from debian/README.Debian)10
1 files changed, 5 insertions, 5 deletions
diff --git a/debian/README.Debian b/debian/README.md
index 5f63b5c..b0f8658 100644
--- a/debian/README.Debian
+++ b/debian/README.md
@@ -6,23 +6,23 @@ 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.
+`/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
+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
+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.
+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