diff --git a/README.md b/README.md index b61bf20..3d9f1e5 100644 --- a/README.md +++ b/README.md @@ -23,3 +23,23 @@ python web.py You would need to edit web.py to adjust the address/port the server listens on, and may want to edit the web_config.cfg file. Note that most of the options in web_config.cfg are unused after forking from the fc00.org code, so this is mostly just a workaround until we have time to clean up this code. Run `web/updateGraph.py` periodically to rerender nodes graph. You may want to customize reverse-proxy IP retrieval logic in web.py. + +## Web server with Docker +### 1. Copy files from contrib/Docker/ to your folder of choice. + +### 2. Build image +Example folder is /docker/yggdrasil/map +```bash +sudo docker build -t Arceliar/yggdrasil-map /docker/yggdrasil/map/ +``` + +### 3. Create container +Run with using Docker host network +```bash +sudo docker run --name yggdrasil-map -d --net host --restart always Arceliar/yggdrasil-map +``` + +You can also use other Docker networks +```bash +sudo docker run --name yggdrasil-map -d --net local --ip 10.254.1.3 --ip6 fd80:deaf:1::3 --mac-address 02:42:01:00:00:03 -e HOST=fd80:deaf:1::3 -e PORT=80 --restart always Arceliar/yggdrasil-map +```