Merge pull request #50 from linuxserver/readme

fix var sample
This commit is contained in:
Adam 2023-03-24 15:48:41 +00:00 committed by GitHub
commit bbfa8cdd3a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 4 deletions

View File

@ -87,7 +87,7 @@ services:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- "CLI_ARGS="--gameid minetest --port 30000"" #optional
- "CLI_ARGS=--gameid minetest --port 30000" #optional
volumes:
- /path/to/data:/config/.minetest
ports:
@ -103,7 +103,7 @@ docker run -d \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-e CLI_ARGS=""--gameid minetest --port 30000"" `#optional` \
-e CLI_ARGS="--gameid minetest --port 30000" `#optional` \
-p 30000:30000/udp \
-v /path/to/data:/config/.minetest \
--restart unless-stopped \
@ -121,7 +121,7 @@ Container images are configured using parameters passed at runtime (such as thos
| `-e PUID=1000` | for UserID - see below for explanation |
| `-e PGID=1000` | for GroupID - see below for explanation |
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
| `-e CLI_ARGS="--gameid minetest --port 30000"` | Optionally specify any [CLI variables](https://wiki.minetest.net/Command_line) you want to launch the app with |
| `-e CLI_ARGS=--gameid minetest --port 30000` | Optionally specify any [CLI variables](https://wiki.minetest.net/Command_line) you want to launch the app with |
| `-v /config/.minetest` | Where minetest stores config files and maps etc. |
## Environment variables from files (Docker secrets)
@ -233,6 +233,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
## Versions
* **17.03.23:** - Fix CLI_ARGS example in readme.
* **23.02.23:** - Rebase to Alpine 3.17, migrate to s6v3.
* **06.08.22:** - Update irrlicht deps.
* **02.05.22:** - Allow specifying the advertised port.

View File

@ -36,7 +36,7 @@ cap_add_param: false
# optional container parameters
opt_param_usage_include_env: true
opt_param_env_vars:
- { env_var: "CLI_ARGS", env_value: "\"--gameid minetest --port 30000\"", desc: "Optionally specify any [CLI variables](https://wiki.minetest.net/Command_line) you want to launch the app with" }
- { env_var: "CLI_ARGS", env_value: "--gameid minetest --port 30000", desc: "Optionally specify any [CLI variables](https://wiki.minetest.net/Command_line) you want to launch the app with" }
# application setup block
@ -53,6 +53,7 @@ app_setup_block: |
https://hub.docker.com/r/linuxserver/{{ project_name }}/tags
# changelog
changelogs:
- { date: "17.03.23:", desc: "Fix CLI_ARGS example in readme."}
- { date: "23.02.23:", desc: "Rebase to Alpine 3.17, migrate to s6v3."}
- { date: "06.08.22:", desc: "Update irrlicht deps."}
- { date: "02.05.22:", desc: "Allow specifying the advertised port."}