diff options
| -rw-r--r-- | README | 19 | ||||
| -rw-r--r-- | README.md | 13 |
2 files changed, 13 insertions, 19 deletions
| @@ -1,19 +0,0 @@ | |||
| 1 | whiterabbit | ||
| 2 | Auto-configure Matrix homeservers (Dendrite or Synapse) | ||
| 3 | with a global Coturn server, Nginx, and Let's Encrypt. | ||
| 4 | |||
| 5 | Commands: | ||
| 6 | |||
| 7 | turn Install or configure the global Coturn server | ||
| 8 | dendrite Add a new Matrix server (Dendrite) | ||
| 9 | synapse Add a new Matrix server (Synapse) | ||
| 10 | list Show all configured Matrix servers | ||
| 11 | remove Remove a Matrix server by domain | ||
| 12 | |||
| 13 | Examples: | ||
| 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 | |||
| 5 | with 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) | | ||
