summaryrefslogtreecommitdiff
path: root/DEPLOY.md
diff options
context:
space:
mode:
Diffstat (limited to 'DEPLOY.md')
-rw-r--r--DEPLOY.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/DEPLOY.md b/DEPLOY.md
index 99ba641..ddf0aac 100644
--- a/DEPLOY.md
+++ b/DEPLOY.md
@@ -58,6 +58,12 @@ In Debian you can use this command to create a Conduit user:
sudo adduser --system conduit --no-create-home
```
+## Forwarding ports in the firewall or the router
+
+Conduit uses the ports 443 and 8448 both of which need to be open in the firewall.
+
+If Conduit runs behind a router or in a container and has a different public IP address than the host system these public ports need to be forwarded directly or indirectly to the port mentioned in the config.
+
## Setting up a systemd service
Now we'll set up a systemd service for Conduit, so it's easy to start/stop Conduit and set it to autostart when your
@@ -89,7 +95,8 @@ $ sudo systemctl daemon-reload
## Creating the Conduit configuration file
Now we need to create the Conduit's config file in `/etc/matrix-conduit/conduit.toml`. Paste this in **and take a moment
-to read it. You need to change at least the server name.**
+to read it. You need to change at least the server name.**
+You can also choose to use a different database backend, but right now only `rocksdb` and `sqlite` are recommended.
```toml
[global]
@@ -262,7 +269,8 @@ $ curl https://your.server.name/_matrix/client/versions
$ curl https://your.server.name:8448/_matrix/client/versions
```
-- To check if your server can talk with other homeservers, you can use the [Matrix Federation Tester](https://federationtester.matrix.org/)
+- To check if your server can talk with other homeservers, you can use the [Matrix Federation Tester](https://federationtester.matrix.org/).
+ If you can register but cannot join federated rooms check your config again and also check if the port 8448 is open and forwarded correctly.
# What's next?