aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFilip Wandzio <contact@philw.dev>2025-10-28 11:28:42 +0100
committerFilip Wandzio <contact@philw.dev>2025-10-28 11:28:42 +0100
commitfd49f329f86b8231a9dff70d8d126297e91ad3c0 (patch)
tree7d0224ac528b0b7d9f516bb7d15aa3d625de8051
parent752782fb34329e7a688fd7192851c6370f423ca3 (diff)
downloadwhiterabbit-master.tar.gz
whiterabbit-master.zip
Update readmeHEADmaster
-rw-r--r--README.md47
1 files changed, 46 insertions, 1 deletions
diff --git a/README.md b/README.md
index 451e7d6..c35dc51 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,50 @@
1# whiterabbit(1) – Manual 1# whiterabbit
2 2
3**Date:** 2025-10-02 3**Date:** 2025-10-02
4**Version:** 1.1.0 4**Version:** 1.1.0
5**Name:** whiterabbit – auto-configure Matrix homeservers (Dendrite, Synapse, or Tuwunel) 5**Name:** whiterabbit – auto-configure Matrix homeservers (Dendrite, Synapse, or Tuwunel)
6
7
8## About
9All Matrix homeservers share the same Coturn instance.
10TLS certificates are issued automatically via Let's Encrypt.
11Requires docker, docker-compose, nginx, certbot, and coturn.
12
13## Usage
14
15Install or configure the global Coturn server.
16
17```bash
18 wh turn <domain> <ip> <device> <secret>
19
20```
21
22Add a new Matrix Dendrite server with automatic TLS and Nginx reverse proxy.
23```bash
24 wh dendrite <domain> <email> <server_ip>
25
26```
27
28Add a new Matrix Synapse server with automatic TLS and Nginx reverse proxy.
29```bash
30 wh synapse <domain> <email> <server_ip>
31
32```
33
34Add a Tuwunel homeserver with automatic TLS and Nginx reverse proxy.
35```bash
36 wh tuwunel <domain> <email> <server_ip>
37
38```
39
40List all configured Matrix servers and their container status.
41```bash
42 wh list
43
44```
45
46Remove one or more Matrix servers by domain name.
47```bash
48 wh remove <domain_name>
49
50```