From 44c4c9f53cdd549c524bc389e03cd34c38c2047a Mon Sep 17 00:00:00 2001 From: "jacob.eva" Date: Mon, 13 Nov 2023 12:30:02 +0000 Subject: [PATCH] Update readme --- README.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 63e613d..c53c82b 100644 --- a/README.md +++ b/README.md @@ -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 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: ``` 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. ```doas/sudo bash xmpp-wizard.sh```