linuxserver/docker-minetest
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

adding dynamic readme

Browse Source
This commit is contained in:
thelamer 2019-02-11 20:37:55 -08:00
parent b436f4c079
commit ac4ca95c60
2 changed files with 184 additions and 161 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

190
README.md
View File

@ -1,104 +1,172 @@
[linuxserverurl]: https://linuxserver.io [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
[forumurl]: https://forum.linuxserver.io
[ircurl]: https://www.linuxserver.io/irc/
[podcasturl]: https://www.linuxserver.io/podcast/
[appurl]: http://www.minetest.net/
[hub]: https://hub.docker.com/r/linuxserver/minetest/
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :-
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: * regular and timely application updates
* [forum.linuxserver.io][forumurl] * easy user mappings (PGID, PUID)
* [IRC][ircurl] on freenode at `#linuxserver.io` * custom base image with s6 overlay
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! * weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
* regular security updates
# linuxserver/minetest Find us at:
[![](https://images.microbadger.com/badges/version/linuxserver/minetest.svg)](https://microbadger.com/images/linuxserver/minetest "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/minetest.svg)](https://microbadger.com/images/linuxserver/minetest "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/minetest.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/minetest.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-minetest)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-minetest/) * [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
* [IRC](https://irc.linuxserver.io) - on freenode at `#linuxserver.io`. Our primary support channel is Discord.
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
* [Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018).
[Minetest][appurl] (server) is a near-infinite-world block sandbox game and a game engine, inspired by InfiniMiner, Minecraft, and the like. # PSA: Changes are happening
From August 2018 onwards, Linuxserver are in the midst of switching to a new CI platform which will enable us to build and release multiple architectures under a single repo. To this end, existing images for `arm64` and `armhf` builds are being deprecated. They are replaced by a manifest file in each container which automatically pulls the correct image for your architecture. You'll also be able to pull based on a specific architecture tag.
TLDR: Multi-arch support is changing from multiple repos to one repo per container image.
# [linuxserver/minetest](https://github.com/linuxserver/docker-minetest)
[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn)
[![](https://images.microbadger.com/badges/version/linuxserver/minetest.svg)](https://microbadger.com/images/linuxserver/minetest "Get your own version badge on microbadger.com")
[![](https://images.microbadger.com/badges/image/linuxserver/minetest.svg)](https://microbadger.com/images/linuxserver/minetest "Get your own version badge on microbadger.com")
![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/minetest.svg)
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/minetest.svg)
[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-minetest/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-minetest/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/minetest/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/minetest/latest/index.html)
[Minetest](http://www.minetest.net/) (server) is a near-infinite-world block sandbox game and a game engine, inspired by InfiniMiner, Minecraft, and the like.
[![minetest](https://raw.githubusercontent.com/linuxserver/beta-templates/master/lsiodev/img/minetest-icon.png)](http://www.minetest.net/)
## Supported Architectures
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list).
Simply pulling `linuxserver/minetest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
| Architecture | Tag |
| :----: | --- |
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v6-latest |
[![minetest](https://raw.githubusercontent.com/linuxserver/beta-templates/master/lsiodev/img/minetest-icon.png)][appurl]
## Usage ## Usage
Here are some example snippets to help you get started creating a container.
### docker
``` ```
docker create \ docker create \
--name=minetest \ --name=minetest \
-e PUID=1001 \
-e PGID=1001 \
-e TZ=Europe/London \
-p 30000:30000/udp \
-v <path to data>:/config/.minetest \ -v <path to data>:/config/.minetest \
-e PGID=<gid> -e PUID=<uid> \ --restart unless-stopped \
-p 30000:30000/udp
linuxserver/minetest linuxserver/minetest
``` ```
## Tags
Client and server must be the same version and to allow this you can choose one of the following tags in the following format
linuxserver/minetest:0.4.16 ### docker-compose
+ **0.4.13** Compatible with docker-compose v2 schemas.
+ **0.4.14**
+ **0.4.15**
+ **0.4.16**
The default aka :latest builds whatever is the latest release at build time, from here. https://github.com/minetest/minetest/releases
```
---
version: "2"
services:
minetest:
image: linuxserver/minetest
container_name: minetest
environment:
- PUID=1001
- PGID=1001
- TZ=Europe/London
volumes:
- <path to data>:/config/.minetest
ports:
- 30000:30000/udp
mem_limit: 4096m
restart: unless-stopped
```
## Parameters ## Parameters
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
| Parameter | Function |
| :----: | --- |
| `-p 30000/udp` | Port Minetest listens on. |
| `-e PUID=1001` | for UserID - see below for explanation |
| `-e PGID=1001` | for GroupID - see below for explanation |
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
| `-v /config/.minetest` | Where minetest stores config files and maps etc. |
## User / Group Identifiers
* `-p 30000/udp` - the port(s) When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
* `-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
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it minetest /bin/bash`. Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
### User / Group Identifiers In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
Sometimes when using data volumes (`-v` flags) permissions issues can arise between the host OS and the container. We avoid this issue by allowing you to specify the user `PUID` and group `PGID`. Ensure the data volume directory on the host is owned by the same user you specify and it will "just work" ™.
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
``` ```
$ id <dockeruser> $ id username
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
``` ```
## Setting up the application
&nbsp;
## Application Setup
You can find the world maps, mods folder and config files in /config/.minetest. You can find the world maps, mods folder and config files in /config/.minetest.
## Info Client and server must be the same version, please browse the tags here to pull the appropriate version for your server:
https://hub.docker.com/r/linuxserver/minetest/tags
## Support Info
* Shell access whilst the container is running: `docker exec -it minetest /bin/bash` * Shell access whilst the container is running: `docker exec -it minetest /bin/bash`
* To monitor the logs of the container in realtime: `docker logs -f minetest` * To monitor the logs of the container in realtime: `docker logs -f minetest`
* container version number * container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' minetest`
`docker inspect -f '{{ index .Config.Labels "build_version" }}' minetest`
* image version number * image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/minetest`
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/minetest` ## Updating Info
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
Below are the instructions for updating containers:
### Via Docker Run/Create
* Update the image: `docker pull linuxserver/minetest`
* Stop the running container: `docker stop minetest`
* Delete the container: `docker rm minetest`
* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
* Start the new container: `docker start minetest`
* You can also remove the old dangling images: `docker image prune`
### Via Docker Compose
* Update the image: `docker-compose pull linuxserver/minetest`
* Let compose update containers as necessary: `docker-compose up -d`
* You can also remove the old dangling images: `docker image prune`
## Versions ## Versions
+ **14.01.19:** Add pipeline logic and multi arch. * **14.01.19:** - Add pipeline logic and multi arch.
+ **08.08.18:** Rebase to alpine 3.8, build from latest release tag instead of master. * **08.08.18:** - Rebase to alpine 3.8, build from latest release tag instead of master.
+ **03.01.18:** Deprecate cpu_core routine lack of scaling. * **03.01.18:** - Deprecate cpu_core routine lack of scaling.
+ **08.12.17:** Rebase to alpine 3.7. * **08.12.17:** - Rebase to alpine 3.7.
+ **30.11.17:** Use cpu core counting routine to speed up build time. * **30.11.17:** - Use cpu core counting routine to speed up build time.
+ **26.05.17:** Rebase to alpine 3.6. * **26.05.17:** - Rebase to alpine 3.6.
+ **14.02.17:** Rebase to alpine 3.5. * **14.02.17:** - Rebase to alpine 3.5.
+ **25.11.16:** Rebase to alpine linux, move to main repo. * **25.11.16:** - Rebase to alpine linux, move to main repo.
+ **27.02.16:** Bump to latest version. * **27.02.16:** - Bump to latest version.
+ **19.02.16:** Change port to UDP, thanks to slashopt for pointing this out. * **19.02.16:** - Change port to UDP, thanks to slashopt for pointing this out.
+ **15.02.16:** Make minetest app a service. * **15.02.16:** - Make minetest app a service.
+ **01.02.16:** Add lua-socket dependency. * **01.02.16:** - Add lua-socket dependency.
+ **06.11.15:** Initial Release. * **06.11.15:** - Initial Release.

153
readme-vars.yml
View File

@ -2,110 +2,65 @@
# project information # project information
project_name: minetest project_name: minetest
full_custom_readme: | project_url: "http://www.minetest.net/"
{% raw -%} project_logo: "https://raw.githubusercontent.com/linuxserver/beta-templates/master/lsiodev/img/minetest-icon.png"
[linuxserverurl]: https://linuxserver.io project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) (server) is a near-infinite-world block sandbox game and a game engine, inspired by InfiniMiner, Minecraft, and the like."
[forumurl]: https://forum.linuxserver.io project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
[ircurl]: https://www.linuxserver.io/irc/ project_blurb_optional_extras_enabled: false
[podcasturl]: https://www.linuxserver.io/podcast/
[appurl]: http://www.minetest.net/
[hub]: https://hub.docker.com/r/linuxserver/minetest/
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] # supported architectures
available_architectures:
- { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
- { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
- { arch: "{{ arch_armhf }}", tag: "arm32v6-latest"}
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: # development version
* [forum.linuxserver.io][forumurl] development_versions: false
* [IRC][ircurl] on freenode at `#linuxserver.io`
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
# linuxserver/minetest # container parameters
[![](https://images.microbadger.com/badges/version/linuxserver/minetest.svg)](https://microbadger.com/images/linuxserver/minetest "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/minetest.svg)](https://microbadger.com/images/linuxserver/minetest "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/minetest.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/minetest.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-minetest)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-minetest/) common_param_env_vars_enabled: true
param_container_name: "{{ project_name }}"
param_usage_include_net: false
param_usage_include_env: true
param_env_vars:
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." }
param_usage_include_vols: true
param_volumes:
- { vol_path: "/config/.minetest", vol_host_path: "<path to data>", desc: "Where minetest stores config files and maps etc." }
param_usage_include_ports: true
param_ports:
- { external_port: "30000", internal_port: "30000/udp", port_desc: "Port Minetest listens on." }
param_device_map: false
cap_add_param: false
[Minetest][appurl] (server) is a near-infinite-world block sandbox game and a game engine, inspired by InfiniMiner, Minecraft, and the like. # optional container parameters
opt_param_usage_include_env: false
[![minetest](https://raw.githubusercontent.com/linuxserver/beta-templates/master/lsiodev/img/minetest-icon.png)][appurl] opt_param_usage_include_vols: false
opt_param_usage_include_ports: false
## Usage opt_param_device_map: false
opt_cap_add_param: false
``` optional_block_1: false
docker create \
--name=minetest \
-v <path to data>:/config/.minetest \
-e PGID=<gid> -e PUID=<uid> \
-p 30000:30000/udp
linuxserver/minetest
```
## Tags
Client and server must be the same version and to allow this you can choose one of the following tags in the following format
linuxserver/minetest:0.4.16
+ **0.4.13**
+ **0.4.14**
+ **0.4.15**
+ **0.4.16**
The default aka :latest builds whatever is the latest release at build time, from here. https://github.com/minetest/minetest/releases
## Parameters
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
* `-p 30000/udp` - 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
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it minetest /bin/bash`.
### User / Group Identifiers
Sometimes when using data volumes (`-v` flags) permissions issues can arise between the host OS and the container. We avoid this issue by allowing you to specify the user `PUID` and group `PGID`. Ensure the data volume directory on the host is owned by the same user you specify and it will "just work" ™.
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
```
$ id <dockeruser>
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
```
## Setting up the application
# application setup block
app_setup_block_enabled: true
app_setup_block: |
You can find the world maps, mods folder and config files in /config/.minetest. You can find the world maps, mods folder and config files in /config/.minetest.
## Info Client and server must be the same version, please browse the tags here to pull the appropriate version for your server:
* Shell access whilst the container is running: `docker exec -it minetest /bin/bash` https://hub.docker.com/r/linuxserver/{{ project_name }}/tags
* To monitor the logs of the container in realtime: `docker logs -f minetest` # changelog
changelogs:
* container version number - { date: "14.01.19:", desc: "Add pipeline logic and multi arch." }
- { date: "08.08.18:", desc: "Rebase to alpine 3.8, build from latest release tag instead of master." }
`docker inspect -f '{{ index .Config.Labels "build_version" }}' minetest` - { date: "03.01.18:", desc: "Deprecate cpu_core routine lack of scaling." }
- { date: "08.12.17:", desc: "Rebase to alpine 3.7." }
* image version number - { date: "30.11.17:", desc: "Use cpu core counting routine to speed up build time." }
- { date: "26.05.17:", desc: "Rebase to alpine 3.6." }
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/minetest` - { date: "14.02.17:", desc: "Rebase to alpine 3.5." }
- { date: "25.11.16:", desc: "Rebase to alpine linux, move to main repo." }
## Versions - { date: "27.02.16:", desc: "Bump to latest version." }
- { date: "19.02.16:", desc: "Change port to UDP, thanks to slashopt for pointing this out." }
+ **14.01.19:** Add pipeline logic and multi arch. - { date: "15.02.16:", desc: "Make minetest app a service." }
+ **08.08.18:** Rebase to alpine 3.8, build from latest release tag instead of master. - { date: "01.02.16:", desc: "Add lua-socket dependency." }
+ **03.01.18:** Deprecate cpu_core routine lack of scaling. - { date: "06.11.15:", desc: "Initial Release." }
+ **08.12.17:** Rebase to alpine 3.7.
+ **30.11.17:** Use cpu core counting routine to speed up build time.
+ **26.05.17:** Rebase to alpine 3.6.
+ **14.02.17:** Rebase to alpine 3.5.
+ **25.11.16:** Rebase to alpine linux, move to main repo.
+ **27.02.16:** Bump to latest version.
+ **19.02.16:** Change port to UDP, thanks to slashopt for pointing this out.
+ **15.02.16:** Make minetest app a service.
+ **01.02.16:** Add lua-socket dependency.
+ **06.11.15:** Initial Release.
{%- endraw %}