From 297bb9cdf50792610e47d4d989d25e55a82c2d83 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Fri, 1 May 2020 20:00:32 +0000 Subject: [PATCH] Bot Updating Documentation --- images/docker-minetest.md | 53 +++++++++++++++++++++++++-------------- 1 file changed, 34 insertions(+), 19 deletions(-) diff --git a/images/docker-minetest.md b/images/docker-minetest.md index 3efa2a3bc3..a7493f269c 100644 --- a/images/docker-minetest.md +++ b/images/docker-minetest.md @@ -1,8 +1,17 @@ -# linuxserver/minetest +# [linuxserver/minetest](https://github.com/linuxserver/docker-minetest) -[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-minetest.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-minetest) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-minetest.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-minetest/releases) [![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-minetest/packages) [![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-minetest/container_registry) [![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/minetest) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/minetest.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/minetest) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/minetest.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/minetest) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/minetest.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/minetest) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-minetest/job/master/badge/icon?style=flat-square)](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) +[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-minetest.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-minetest) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-minetest.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-minetest/releases) +[![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-minetest/packages) +[![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-minetest/container_registry) +[![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/minetest) +[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/minetest.svg?style=flat-square&color=E68523)](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?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/minetest) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/minetest.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/minetest) +[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-minetest/job/master/badge/icon?style=flat-square)](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](http://www.minetest.net/) (server) is a near-infinite-world block sandbox game and a game engine, inspired by InfiniMiner, Minecraft, and the like. ## Supported Architectures @@ -13,18 +22,19 @@ Simply pulling `linuxserver/minetest` should retrieve the correct image for your The architectures supported by this image are: | Architecture | Tag | -| :---: | :--- | +| :----: | --- | | x86-64 | amd64-latest | | arm64 | arm64v8-latest | | armhf | arm32v7-latest | + ## Usage Here are some example snippets to help you get started creating a container from this image. ### docker -```text +``` docker create \ --name=minetest \ -e PUID=1000 \ @@ -37,6 +47,7 @@ docker create \ linuxserver/minetest ``` + ### docker-compose Compatible with docker-compose v2 schemas. @@ -62,38 +73,42 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `:` 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. +Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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. -### Ports \(`-p`\) +### Ports (`-p`) | Parameter | Function | -| :---: | :--- | +| :----: | --- | | `30000/udp` | Port Minetest listens on. | -### Environment Variables \(`-e`\) + +### Environment Variables (`-e`) | Env | Function | -| :---: | :--- | +| :----: | --- | | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | | `TZ=Europe/London` | Specify a timezone to use EG Europe/London. | | `CLI_ARGS="--gameid minetest"` | Optionally specify any [CLI variables](https://wiki.minetest.net/Command_line) you want to launch the app with | -### Volume Mappings \(`-v`\) +### Volume Mappings (`-v`) | Volume | Function | -| :---: | :--- | +| :----: | --- | | `/config/.minetest` | Where minetest stores config files and maps etc. | + + + ## User / Group Identifiers -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`. +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`. Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic. In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: -```text +``` $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` @@ -104,13 +119,14 @@ You can find the world maps, mods folder and config files in /config/.minetest. 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](https://hub.docker.com/r/linuxserver/minetest/tags) +https://hub.docker.com/r/linuxserver/minetest/tags + ## Docker Mods +[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27minetest%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=minetest "view available mods for this container.") -[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27minetest%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=minetest) +We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above. -We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image \(if any\) can be accessed via the dynamic badge above. ## Support Info @@ -133,7 +149,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to * **04.03.19:** - Rebase to alpine 3.9 to compile 5.0.0 minetest with new build args. * **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. -* **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. * **30.11.17:** - Use cpu core counting routine to speed up build time. * **26.05.17:** - Rebase to alpine 3.6. @@ -144,4 +160,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to * **15.02.16:** - Make minetest app a service. * **01.02.16:** - Add lua-socket dependency. * **06.11.15:** - Initial Release. -