From 3b97a0684f82d09c00eb7f17ebbc468acdf6d8ac Mon Sep 17 00:00:00 2001 From: sparklyballs Date: Thu, 5 Nov 2015 09:57:51 +0000 Subject: [PATCH] first draft README --- READMETEMPLATE.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/READMETEMPLATE.md b/READMETEMPLATE.md index fb19a71..5797e51 100644 --- a/READMETEMPLATE.md +++ b/READMETEMPLATE.md @@ -1,26 +1,26 @@ ![http://linuxserver.io](http://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png) -The [LinuxServer.io](https://www.linuxserver.io/) team brings you another quality container release featuring auto-update on startup, easy user mapping and community support. Be sure to checkout our [forums](https://forum.linuxserver.io/index.php) or for real-time support our [IRC](https://www.linuxserver.io/index.php/irc/) on freenode at `#linuxserver.io`. +The [LinuxServer.io](https://www.linuxserver.io/) team brings you another quality container release featuring dependency update on startup, easy user mapping and community support. Be sure to checkout our [forums](https://forum.linuxserver.io/index.php) or for real-time support our [IRC](https://www.linuxserver.io/index.php/irc/) on freenode at `#linuxserver.io`. -# linuxserver/ +# linuxserver/minetest - +Minetest is a near-infinite-world block sandbox game and a game engine, inspired by InfiniMiner, Minecraft, and the like. [Minetest](http://www.minetest.net/) ## Usage ``` -docker create --name= -v /etc/localtime:/etc/localtime:ro -v :/config -e PGID= -e PUID= -p 1234:1234 linuxserver/ +docker create --name=minetest -v :/config/.minetest -e PGID= -e PUID= -e TZ= -p 30000:30000 linuxserver/minetest ``` **Parameters** -* `-p 4242` - the port(s) -* `-v /etc/localtime` for timesync - *optional* -* `-v /config` - +* `-p 30000` - the port(s) +* `-v /config/.minetest` - where minetest stores config files and maps etc. * `-e PGID` for GroupID - see below for explanation * `-e PUID` for UserID - see below for explanation +* `-e TZ` for Timezone setting, eg Europe/London -It is based on phusion-baseimage with ssh removed, for shell access whilst the container is running do `docker exec -it /bin/bash`. +It is based on phusion-baseimage with ssh removed, for shell access whilst the container is running do `docker exec -it minetest /bin/bash`. ### User / Group Identifiers @@ -30,17 +30,17 @@ Part of what makes our containers work so well is by allowing you to specify you ## Setting up the application - DELETE ME +You can find the world maps, mods folder and config files in /config/.minetest. ## Updates -* Upgrade to the latest version simply `docker restart `. -* To monitor the logs of the container in realtime `docker logs -f `. +* Update dependencies to the latest version simply `docker restart minetest`. +* To monitor the logs of the container in realtime `docker logs -f minetest`. ## Versions -+ **dd.MM.yyyy:** This is the standard Version type now. ++ **05.11.2015:** Initial Release.