diff options
| author | Filip Wandzio <contact@philw.dev> | 2025-10-01 22:21:25 +0200 |
|---|---|---|
| committer | Filip Wandzio <contact@philw.dev> | 2025-10-01 22:21:25 +0200 |
| commit | 37e65300245be45d4000797b3ada53c68022fc26 (patch) | |
| tree | ae304da2869d2069b3359def36e36d29877fc7c8 /wh.1 | |
| parent | 34fbb07af8de311a4d316325bcf574341f6be5dd (diff) | |
| download | whiterabbit-37e65300245be45d4000797b3ada53c68022fc26.tar.gz whiterabbit-37e65300245be45d4000797b3ada53c68022fc26.zip | |
Implement use flags for subcommants
Optimize synapse pipeline
Diffstat (limited to '')
| -rw-r--r-- | wh.1 (renamed from whiterabbit.1) | 30 |
1 files changed, 23 insertions, 7 deletions
| @@ -4,25 +4,26 @@ | |||
| 4 | whiterabbit \- auto-configure Matrix homeservers (Dendrite or Synapse) | 4 | whiterabbit \- auto-configure Matrix homeservers (Dendrite or Synapse) |
| 5 | .SH SYNOPSIS | 5 | .SH SYNOPSIS |
| 6 | .B whiterabbit | 6 | .B whiterabbit |
| 7 | [\fIturn\fR|\fIdendrite\fR|\fIsynapse\fR|\fIlist\fR|\fIremove <domain>\fR] | 7 | [\fIturn\fR|\fIdendrite\fR|\fIsynapse\fR|\fIlist\fR|\fIremove <domain>\fR| |
| 8 | \fI-t\fR|\fI-d\fR|\fI-s\fR|\fI-l\fR|\fI-r <domain>\fR] | ||
| 8 | .SH DESCRIPTION | 9 | .SH DESCRIPTION |
| 9 | whiterabbit sets up Matrix homeservers with a global Coturn server and Nginx/Let's Encrypt support. | 10 | whiterabbit sets up Matrix homeservers with a global Coturn server and Nginx/Let's Encrypt support. |
| 10 | 11 | ||
| 11 | Main commands: | 12 | Main commands and their short flag equivalents: |
| 12 | .TP | 13 | .TP |
| 13 | .B turn | 14 | .B turn, -t |
| 14 | Install or configure the global Coturn server. | 15 | Install or configure the global Coturn server. |
| 15 | .TP | 16 | .TP |
| 16 | .B dendrite | 17 | .B dendrite, -d |
| 17 | Add a new Matrix Dendrite server. | 18 | Add a new Matrix Dendrite server. |
| 18 | .TP | 19 | .TP |
| 19 | .B synapse | 20 | .B synapse, -s |
| 20 | Add a new Matrix Synapse server. | 21 | Add a new Matrix Synapse server. |
| 21 | .TP | 22 | .TP |
| 22 | .B list | 23 | .B list, -l |
| 23 | List all configured Matrix servers. | 24 | List all configured Matrix servers. |
| 24 | .TP | 25 | .TP |
| 25 | .B remove <domain> | 26 | .B remove <domain>, -r <domain> |
| 26 | Remove a Matrix server by domain. | 27 | Remove a Matrix server by domain. |
| 27 | 28 | ||
| 28 | .SH EXAMPLES | 29 | .SH EXAMPLES |
| @@ -30,17 +31,32 @@ Remove a Matrix server by domain. | |||
| 30 | whiterabbit turn | 31 | whiterabbit turn |
| 31 | Set up the global Coturn server. | 32 | Set up the global Coturn server. |
| 32 | .TP | 33 | .TP |
| 34 | whiterabbit -t | ||
| 35 | Same as above using flag. | ||
| 36 | .TP | ||
| 33 | whiterabbit dendrite | 37 | whiterabbit dendrite |
| 34 | Add a Dendrite server with TLS and Nginx. | 38 | Add a Dendrite server with TLS and Nginx. |
| 35 | .TP | 39 | .TP |
| 40 | whiterabbit -d | ||
| 41 | Same as above using flag. | ||
| 42 | .TP | ||
| 36 | whiterabbit synapse | 43 | whiterabbit synapse |
| 37 | Add a Synapse server with TLS and Nginx. | 44 | Add a Synapse server with TLS and Nginx. |
| 38 | .TP | 45 | .TP |
| 46 | whiterabbit -s | ||
| 47 | Same as above using flag. | ||
| 48 | .TP | ||
| 39 | whiterabbit list | 49 | whiterabbit list |
| 40 | Show all servers. | 50 | Show all servers. |
| 41 | .TP | 51 | .TP |
| 52 | whiterabbit -l | ||
| 53 | Same as above using flag. | ||
| 54 | .TP | ||
| 42 | whiterabbit remove matrix.example.com | 55 | whiterabbit remove matrix.example.com |
| 43 | Remove a server. | 56 | Remove a server. |
| 57 | .TP | ||
| 58 | whiterabbit -r matrix.example.com | ||
| 59 | Same as above using flag. | ||
| 44 | 60 | ||
| 45 | .SH NOTES | 61 | .SH NOTES |
| 46 | All Matrix servers share the same Coturn instance. | 62 | All Matrix servers share the same Coturn instance. |