Update readme

This commit is contained in:
jacob.eva 2023-11-13 12:30:02 +00:00
parent 9b5c92fa01
commit 44c4c9f53c
No known key found for this signature in database
GPG Key ID: 0B92E083BBCCAA1E

View File

@ -7,14 +7,31 @@ No scouring over documentation for hours or headache required ;)
However, celibacy is required, since this script is written for use on __Arch However, celibacy is required, since this script is written for use on __Arch
Linux* only__. Linux* only__.
## Prerequisites ## Features
* Modern TLS configuration by default
* Uses MariaDB as the SQL database
* Adds an admin account
## Modules configured
* HTTP uploads (XEP-0363)
* HTTP upload quotas (by total size)
* STUN/TURN server
## Installation
### Prerequisites
Make sure you have the following packages installed: Make sure you have the following packages installed:
``` ```
Nginx Nginx
Mariadb MariaDB
``` ```
## Running ### Installs
This script installs the following packages:
* ejabberd - XMPP server
* certbot - managing certificates
### Running
The script should be run as root. The script should be run as root.
```doas/sudo bash xmpp-wizard.sh``` ```doas/sudo bash xmpp-wizard.sh```