diff options
| author | Filip Wandzio <contact@philw.dev> | 2025-10-28 11:28:42 +0100 |
|---|---|---|
| committer | Filip Wandzio <contact@philw.dev> | 2025-10-28 11:28:42 +0100 |
| commit | fd49f329f86b8231a9dff70d8d126297e91ad3c0 (patch) | |
| tree | 7d0224ac528b0b7d9f516bb7d15aa3d625de8051 | |
| parent | 752782fb34329e7a688fd7192851c6370f423ca3 (diff) | |
| download | whiterabbit-fd49f329f86b8231a9dff70d8d126297e91ad3c0.tar.gz whiterabbit-fd49f329f86b8231a9dff70d8d126297e91ad3c0.zip | |
| -rw-r--r-- | README.md | 47 |
1 files changed, 46 insertions, 1 deletions
| @@ -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 | ||
| 9 | All Matrix homeservers share the same Coturn instance. | ||
| 10 | TLS certificates are issued automatically via Let's Encrypt. | ||
| 11 | Requires docker, docker-compose, nginx, certbot, and coturn. | ||
| 12 | |||
| 13 | ## Usage | ||
| 14 | |||
| 15 | Install or configure the global Coturn server. | ||
| 16 | |||
| 17 | ```bash | ||
| 18 | wh turn <domain> <ip> <device> <secret> | ||
| 19 | |||
| 20 | ``` | ||
| 21 | |||
| 22 | Add a new Matrix Dendrite server with automatic TLS and Nginx reverse proxy. | ||
| 23 | ```bash | ||
| 24 | wh dendrite <domain> <email> <server_ip> | ||
| 25 | |||
| 26 | ``` | ||
| 27 | |||
| 28 | Add a new Matrix Synapse server with automatic TLS and Nginx reverse proxy. | ||
| 29 | ```bash | ||
| 30 | wh synapse <domain> <email> <server_ip> | ||
| 31 | |||
| 32 | ``` | ||
| 33 | |||
| 34 | Add a Tuwunel homeserver with automatic TLS and Nginx reverse proxy. | ||
| 35 | ```bash | ||
| 36 | wh tuwunel <domain> <email> <server_ip> | ||
| 37 | |||
| 38 | ``` | ||
| 39 | |||
| 40 | List all configured Matrix servers and their container status. | ||
| 41 | ```bash | ||
| 42 | wh list | ||
| 43 | |||
| 44 | ``` | ||
| 45 | |||
| 46 | Remove one or more Matrix servers by domain name. | ||
| 47 | ```bash | ||
| 48 | wh remove <domain_name> | ||
| 49 | |||
| 50 | ``` | ||
