From c35fd32d1a3c9bdf91e2091b05741978606a3900 Mon Sep 17 00:00:00 2001 From: Filip Wandzio Date: Thu, 25 Sep 2025 23:21:00 +0200 Subject: Add makefile and enable support for building on arch based distributions Organize script into modular functions Add manpages Signed-off-by: Filip Wandzio --- whiterabbit.1 | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 whiterabbit.1 (limited to 'whiterabbit.1') diff --git a/whiterabbit.1 b/whiterabbit.1 new file mode 100644 index 0000000..e02030f --- /dev/null +++ b/whiterabbit.1 @@ -0,0 +1,51 @@ +.\" Manpage for whiterabbit +.TH WHITERABBIT 1 "2025-09-25" "1.0.0" "whiterabbit manual" +.SH NAME +whiterabbit \- auto-configure Matrix homeservers (Dendrite or Synapse) +.SH SYNOPSIS +.B whiterabbit +[\fIturn\fR|\fIdendrite\fR|\fIsynapse\fR|\fIlist\fR|\fIremove \fR] +.SH DESCRIPTION +whiterabbit sets up Matrix homeservers with a global Coturn server and Nginx/Let's Encrypt support. + +Main commands: +.TP +.B turn +Install or configure the global Coturn server. +.TP +.B dendrite +Add a new Matrix Dendrite server. +.TP +.B synapse +Add a new Matrix Synapse server. +.TP +.B list +List all configured Matrix servers. +.TP +.B remove +Remove a Matrix server by domain. + +.SH EXAMPLES +.TP +whiterabbit turn +Set up the global Coturn server. +.TP +whiterabbit dendrite +Add a Dendrite server with TLS and Nginx. +.TP +whiterabbit synapse +Add a Synapse server with TLS and Nginx. +.TP +whiterabbit list +Show all servers. +.TP +whiterabbit remove matrix.example.com +Remove a server. + +.SH NOTES +All Matrix servers share the same Coturn instance. +TLS certificates are issued automatically via Let's Encrypt. +Requires docker, docker-compose, nginx, certbot, and coturn. + +.SH AUTHOR +Filip Wandzio -- cgit v1.2.3