| admins |
The list of players that are server admins |
list(string) |
n/a |
yes |
| allow_nether |
Should players be allowed to access the nether? |
bool |
n/a |
yes |
| announce_player_achievements |
Should achievements be announced to players? |
bool |
n/a |
yes |
| difficulty |
The difficulty the server is set to |
string |
n/a |
yes |
| docker_host |
The host where docker resides |
string |
n/a |
yes |
| enable_autopause |
Enabling auto pause will pause the JVM process 1 hour after the last client has disconnected. |
bool |
n/a |
yes |
| enable_rolling_logs |
By default the vanilla log file will grow without limit. The logger can be reconfigured to use a rolling log files. Set to false to disable rolling logs. |
bool |
true |
no |
| force_gamemode |
Force players to join in the default game mode. False = Players will join in the game mode they left in, True = Players will always join in the default game mode. |
bool |
n/a |
yes |
| game_mode |
Changes the game mode between survival, creative, adventure and spectator |
string |
n/a |
yes |
| generate_structures |
Should structures (such as villages) be generated? |
bool |
n/a |
yes |
| java_version |
The version of java to use in the container. As defined here https://github.com/itzg/docker-minecraft-server/blob/master/README.md#running-minecraft-server-on-different-java-version |
string |
"latest" |
no |
| level_seed |
Sets the servers seed |
string |
n/a |
yes |
| level_type |
By default, a standard world is generated with hills, valleys, water, etc. A different level type can be configured by setting LEVEL_TYPE to an expected type |
string |
n/a |
yes |
| max_build_height |
The maximum height in which building is allowed. Terrain may still naturally generate above a low height limit |
number |
256 |
no |
| max_player_count |
The maximum amount of players allowed onto the server |
number |
n/a |
yes |
| max_world_size |
Sets the maximum possible size in blocks, expressed as a radius, that the world border can obtain |
number |
29999984 |
no |
| memory_limit |
The amount of memory the containers JVM can access. Supported format/units as [g|G|m|M|k|K] |
string |
"1G" |
no |
| message_of_the_day |
Message that appears to the player before login in the server list |
string |
n/a |
yes |
| minecraft_container_name |
The name of the Minecraft server container to be created |
string |
n/a |
yes |
| minecraft_image_name |
The name of the Minecraft server docker image that should be pulled |
string |
n/a |
yes |
| minecraft_network_name |
The name of the docker network that the Minecraft server container will be connected to |
string |
n/a |
yes |
| minecraft_version |
The version of minecraft to be run e.g. 1.16.5 |
string |
n/a |
yes |
| minecraft_volume_name |
The name of the docker volume to be used by the Minecraft server container |
string |
n/a |
yes |
| other_environment_variables |
Use this list to include any other env vars that aren't included by default. Other env vars can be found here https://github.com/itzg/docker-minecraft-server |
list(string) |
[] |
no |
| player_whitelist |
The list of players tht are allowed to play on the server |
list(string) |
n/a |
yes |
| pvp |
By default, servers are created with player-vs-player (PVP) mode enabled. You can disable this with the PVP environment variable set to false |
bool |
false |
no |
| rcon_interface_bind |
The network interface that port 25575 will bind to |
string |
"0.0.0.0" |
no |
| rcon_port |
The host port number the internal port 25575 will map to |
number |
25575 |
no |
| restart_policy |
The restart policy for the container. Must be one of 'no', 'on-failure', 'always', 'unless-stopped'. Defaults to no. |
string |
n/a |
yes |
| server_interface_bind |
The network interface that port 25565 will bind to |
string |
"0.0.0.0" |
no |
| server_port |
The host port number the internal port 25565 will map to |
number |
25565 |
no |
| server_type |
The server type to use |
string |
n/a |
yes |
| spawn_animals |
Should animals be able to spawn? |
bool |
n/a |
yes |
| spawn_monsters |
Should monsters be able to spawn? |
bool |
n/a |
yes |
| spawn_npcs |
Should NPCs be able to spawn? |
bool |
n/a |
yes |
| use_aikars_flags |
Use the optimal JVM flags defined by Aikar, https://aikar.co/2018/07/02/tuning-the-jvm-g1gc-garbage-collector-flags-for-minecraft/ |
bool |
n/a |
yes |
| view_distance |
Sets the amount of world data the server sends the client, measured in chunks in each direction of the player (radius, not diameter). It determines the server-side viewing distance. |
number |
10 |
no |
