From 923404e42c83e48cbdad9ca9930b282e020218ca Mon Sep 17 00:00:00 2001 From: Thomas Rudin Date: Sun, 1 Dec 2019 17:51:35 +0100 Subject: [PATCH] docs --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1fb4739..386ab75 100644 --- a/README.md +++ b/README.md @@ -17,19 +17,27 @@ Webmail # Installation The webmail component runs as webservice and provides the api for the minetest server -and the website for the webmail componentc +and the website for the webmail component + +## Bare metal Prerequisites: * node and npm (on ubuntu: apt install nodejs npm) To install and run the webmail server: -* Copy the "webmail" folder to your desired location (or keep it where it is) -* Change to the webmail directory: (cd ./webmail) * run "npm install" to install the node dependencies * generate a secret key for yourself, can be anything string-like, i suggest one from https://www.random.org/passwords/?num=5&len=16&format=html&rnd=new * Edit the "start.sh" file and insert the secret key in place of "myserverkey" * run "./start.sh" +## Docker + +```bash +sudo docker run --rm -it -p 8080:8080 -e WEBMAILKEY=myserverkey minetestmail/mail +``` + +# Mod configuration + To set up your minetest installation to communicate with the webmail server, edit your "minetest.conf": ``` @@ -46,11 +54,6 @@ webmail.key = myserverkey webmail.disallow_banned_players = true ``` -# Docker image - -```bash -sudo docker run --rm -it -p 8080:8080 -e WEBMAILKEY=myserverkey minetestmail/mail -``` # Roadmap