diff options
Diffstat (limited to 'whiterabbit.1')
| -rw-r--r-- | whiterabbit.1 | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/whiterabbit.1 b/whiterabbit.1 new file mode 100644 index 0000000..e02030f --- /dev/null +++ b/whiterabbit.1 | |||
| @@ -0,0 +1,51 @@ | |||
| 1 | .\" Manpage for whiterabbit | ||
| 2 | .TH WHITERABBIT 1 "2025-09-25" "1.0.0" "whiterabbit manual" | ||
| 3 | .SH NAME | ||
| 4 | whiterabbit \- auto-configure Matrix homeservers (Dendrite or Synapse) | ||
| 5 | .SH SYNOPSIS | ||
| 6 | .B whiterabbit | ||
| 7 | [\fIturn\fR|\fIdendrite\fR|\fIsynapse\fR|\fIlist\fR|\fIremove <domain>\fR] | ||
| 8 | .SH DESCRIPTION | ||
| 9 | whiterabbit sets up Matrix homeservers with a global Coturn server and Nginx/Let's Encrypt support. | ||
| 10 | |||
| 11 | Main commands: | ||
| 12 | .TP | ||
| 13 | .B turn | ||
| 14 | Install or configure the global Coturn server. | ||
| 15 | .TP | ||
| 16 | .B dendrite | ||
| 17 | Add a new Matrix Dendrite server. | ||
| 18 | .TP | ||
| 19 | .B synapse | ||
| 20 | Add a new Matrix Synapse server. | ||
| 21 | .TP | ||
| 22 | .B list | ||
| 23 | List all configured Matrix servers. | ||
| 24 | .TP | ||
| 25 | .B remove <domain> | ||
| 26 | Remove a Matrix server by domain. | ||
| 27 | |||
| 28 | .SH EXAMPLES | ||
| 29 | .TP | ||
| 30 | whiterabbit turn | ||
| 31 | Set up the global Coturn server. | ||
| 32 | .TP | ||
| 33 | whiterabbit dendrite | ||
| 34 | Add a Dendrite server with TLS and Nginx. | ||
| 35 | .TP | ||
| 36 | whiterabbit synapse | ||
| 37 | Add a Synapse server with TLS and Nginx. | ||
| 38 | .TP | ||
| 39 | whiterabbit list | ||
| 40 | Show all servers. | ||
| 41 | .TP | ||
| 42 | whiterabbit remove matrix.example.com | ||
| 43 | Remove a server. | ||
| 44 | |||
| 45 | .SH NOTES | ||
| 46 | All Matrix servers share the same Coturn instance. | ||
| 47 | TLS certificates are issued automatically via Let's Encrypt. | ||
| 48 | Requires docker, docker-compose, nginx, certbot, and coturn. | ||
| 49 | |||
| 50 | .SH AUTHOR | ||
| 51 | Filip Wandzio <contact@philw.dev> | ||
