aboutsummaryrefslogtreecommitdiffstats
path: root/whiterabbit.1
diff options
context:
space:
mode:
Diffstat (limited to 'whiterabbit.1')
-rw-r--r--whiterabbit.151
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
4whiterabbit \- 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
9whiterabbit sets up Matrix homeservers with a global Coturn server and Nginx/Let's Encrypt support.
10
11Main commands:
12.TP
13.B turn
14Install or configure the global Coturn server.
15.TP
16.B dendrite
17Add a new Matrix Dendrite server.
18.TP
19.B synapse
20Add a new Matrix Synapse server.
21.TP
22.B list
23List all configured Matrix servers.
24.TP
25.B remove <domain>
26Remove a Matrix server by domain.
27
28.SH EXAMPLES
29.TP
30whiterabbit turn
31Set up the global Coturn server.
32.TP
33whiterabbit dendrite
34Add a Dendrite server with TLS and Nginx.
35.TP
36whiterabbit synapse
37Add a Synapse server with TLS and Nginx.
38.TP
39whiterabbit list
40Show all servers.
41.TP
42whiterabbit remove matrix.example.com
43Remove a server.
44
45.SH NOTES
46All Matrix servers share the same Coturn instance.
47TLS certificates are issued automatically via Let's Encrypt.
48Requires docker, docker-compose, nginx, certbot, and coturn.
49
50.SH AUTHOR
51Filip Wandzio <contact@philw.dev>