aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README19
-rw-r--r--README.md13
2 files changed, 13 insertions, 19 deletions
diff --git a/README b/README
deleted file mode 100644
index 7a2e496..0000000
--- a/README
+++ /dev/null
@@ -1,19 +0,0 @@
1whiterabbit
2Auto-configure Matrix homeservers (Dendrite or Synapse)
3with a global Coturn server, Nginx, and Let's Encrypt.
4
5Commands:
6
7turn Install or configure the global Coturn server
8dendrite Add a new Matrix server (Dendrite)
9synapse Add a new Matrix server (Synapse)
10list Show all configured Matrix servers
11remove Remove a Matrix server by domain
12
13Examples:
14
15./whiterabbit.sh turn
16./whiterabbit.sh dendrite
17./whiterabbit.sh synapse
18./whiterabbit.sh list
19./whiterabbit.sh remove matrix.example.com
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..48bb23c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
1# whiterabbit
2
3**Auto-configure Matrix homeservers** (Dendrite or Synapse)
4
5with a global Coturn server, Nginx, and Let's Encrypt.
6
7## Commands
8
9| Command | Description |
10|------------|-------------|
11| `turn` | Install or configure the global Coturn server |
12| `dendrite` | Add a new Matrix server (Dendrite) |
13| `synapse` | Add a new Matrix server (Synapse) |