aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFilip Wandzio <contact@philw.dev>2025-10-03 00:47:40 +0200
committerFilip Wandzio <contact@philw.dev>2025-10-03 00:47:40 +0200
commit752782fb34329e7a688fd7192851c6370f423ca3 (patch)
tree7b1432e9ae556dfffc8270f744ae01598266cb6c
parent7fb099832c72d59e613faf4f9623f1cb4af19f56 (diff)
downloadwhiterabbit-752782fb34329e7a688fd7192851c6370f423ca3.tar.gz
whiterabbit-752782fb34329e7a688fd7192851c6370f423ca3.zip
Test if markdown works this time
-rw-r--r--README.174
-rw-r--r--README.md5
2 files changed, 5 insertions, 74 deletions
diff --git a/README.1 b/README.1
deleted file mode 100644
index 53ffeb6..0000000
--- a/README.1
+++ /dev/null
@@ -1,74 +0,0 @@
1.\" Manpage for whiterabbit
2.TH WHITERABBIT 1 "2025-10-02" "1.1.0" "whiterabbit manual"
3.SH NAME
4whiterabbit \- auto-configure Matrix homeservers (Dendrite, Synapse, or Tuwunel)
5.SH SYNOPSIS
6.B whiterabbit
7[\fIturn <domain> <ip> <device> <secret>\fR|
8 \fIdendrite <domain> <email> <server_ip>\fR|
9 \fIsynapse <domain> <email> <server_ip>\fR|
10 \fItuwunel <domain> <email> <server_ip>\fR|
11 \fIlist\fR|
12 \fIremove <domain>...\fR]
13.SH DESCRIPTION
14whiterabbit sets up Matrix homeservers (Dendrite, Synapse, or Tuwunel) with a global Coturn server and Nginx/Let's Encrypt proxying.
15
16Main subcommands:
17.TP
18.B turn <domain> <ip> <device> <secret>
19Install or configure the global Coturn server.
20.TP
21.B dendrite <domain> <email> <server_ip>
22Add a new Matrix Dendrite server with automatic TLS and Nginx reverse proxy.
23.TP
24.B synapse <domain> <email> <server_ip>
25Add a new Matrix Synapse server with automatic TLS and Nginx reverse proxy.
26.TP
27.B tuwunel <domain> <email> <server_ip>
28Add a Tuwunel homeserver with automatic TLS and Nginx reverse proxy.
29.TP
30.B list
31List all configured Matrix servers and their container status.
32.TP
33.B remove <domain> [domain2 ...]
34Remove one or more Matrix servers by domain name.
35
36.SH EXAMPLES
37.TP
38whiterabbit turn turn.example.com 192.168.1.10 eth0 myturnsecret
39Set up the global Coturn server bound to eth0 on IP 192.168.1.10.
40.TP
41whiterabbit dendrite matrix.example.com admin@example.com 192.168.1.20
42Add a Dendrite server.
43.TP
44whiterabbit synapse matrix.example.com admin@example.com 192.168.1.21
45Add a Synapse server.
46.TP
47whiterabbit tuwunel tuw.example.com admin@example.com 192.168.1.22
48Add a Tuwunel server.
49.TP
50whiterabbit list
51Show all installed servers and their status.
52.TP
53whiterabbit remove matrix.example.com another.example.org
54Remove one or more servers.
55
56.SH NOTES
57All Matrix homeservers share the same Coturn instance.
58TLS certificates are issued automatically via Let's Encrypt.
59Requires docker, docker-compose, nginx, certbot, and coturn.
60
61.SH COMMAND DISPATCH
62The script internally dispatches commands as follows:
63.nf
64CMD="${1:-}"
65case "$CMD" in
66 turn) shift; install_turn "$@" ;;
67 dendrite) shift; install_dendrite "$@" ;;
68 # synapse) shift; install_synapse "$@" ;;
69 tuwunel) shift; install_tuwunel "$@" ;;
70 list) list_servers ;;
71 remove) shift; remove_server "$@" ;;
72 *) usage ;;
73esac
74.fi
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..451e7d6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
1# whiterabbit(1) – Manual
2
3**Date:** 2025-10-02
4**Version:** 1.1.0
5**Name:** whiterabbit – auto-configure Matrix homeservers (Dendrite, Synapse, or Tuwunel)