From 7fb099832c72d59e613faf4f9623f1cb4af19f56 Mon Sep 17 00:00:00 2001
From: Filip Wandzio <contact@philw.dev>
Date: Fri, 3 Oct 2025 00:38:30 +0200
Subject: Enable groff support

---
 README.1 | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 74 insertions(+)
 create mode 100644 README.1

(limited to 'README.1')

diff --git a/README.1 b/README.1
new file mode 100644
index 0000000..53ffeb6
--- /dev/null
+++ b/README.1
@@ -0,0 +1,74 @@
+.\" Manpage for whiterabbit
+.TH WHITERABBIT 1 "2025-10-02" "1.1.0" "whiterabbit manual"
+.SH NAME
+whiterabbit \- auto-configure Matrix homeservers (Dendrite, Synapse, or Tuwunel)
+.SH SYNOPSIS
+.B whiterabbit
+[\fIturn <domain> <ip> <device> <secret>\fR|
+ \fIdendrite <domain> <email> <server_ip>\fR|
+ \fIsynapse <domain> <email> <server_ip>\fR|
+ \fItuwunel <domain> <email> <server_ip>\fR|
+ \fIlist\fR|
+ \fIremove <domain>...\fR]
+.SH DESCRIPTION
+whiterabbit sets up Matrix homeservers (Dendrite, Synapse, or Tuwunel) with a global Coturn server and Nginx/Let's Encrypt proxying.
+
+Main subcommands:
+.TP
+.B turn <domain> <ip> <device> <secret>
+Install or configure the global Coturn server.
+.TP
+.B dendrite <domain> <email> <server_ip>
+Add a new Matrix Dendrite server with automatic TLS and Nginx reverse proxy.
+.TP
+.B synapse <domain> <email> <server_ip>
+Add a new Matrix Synapse server with automatic TLS and Nginx reverse proxy.
+.TP
+.B tuwunel <domain> <email> <server_ip>
+Add a Tuwunel homeserver with automatic TLS and Nginx reverse proxy.
+.TP
+.B list
+List all configured Matrix servers and their container status.
+.TP
+.B remove <domain> [domain2 ...]
+Remove one or more Matrix servers by domain name.
+
+.SH EXAMPLES
+.TP
+whiterabbit turn turn.example.com 192.168.1.10 eth0 myturnsecret
+Set up the global Coturn server bound to eth0 on IP 192.168.1.10.
+.TP
+whiterabbit dendrite matrix.example.com admin@example.com 192.168.1.20
+Add a Dendrite server.
+.TP
+whiterabbit synapse matrix.example.com admin@example.com 192.168.1.21
+Add a Synapse server.
+.TP
+whiterabbit tuwunel tuw.example.com admin@example.com 192.168.1.22
+Add a Tuwunel server.
+.TP
+whiterabbit list
+Show all installed servers and their status.
+.TP
+whiterabbit remove matrix.example.com another.example.org
+Remove one or more servers.
+
+.SH NOTES
+All Matrix homeservers share the same Coturn instance.
+TLS certificates are issued automatically via Let's Encrypt.
+Requires docker, docker-compose, nginx, certbot, and coturn.
+
+.SH COMMAND DISPATCH
+The script internally dispatches commands as follows:
+.nf
+CMD="${1:-}"
+case "$CMD" in
+    turn) shift; install_turn "$@" ;;
+    dendrite) shift; install_dendrite "$@" ;;
+    # synapse) shift; install_synapse "$@" ;;
+    tuwunel) shift; install_tuwunel "$@" ;;
+    list) list_servers ;;
+    remove) shift; remove_server "$@" ;;
+    *) usage ;;
+esac
+.fi
-- 
cgit v1.2.3