Skip to content

Commit 2797120

Browse files
itzgitzg
committed
Avoid confusion about server properties supportability
1 parent 816ab73 commit 2797120

File tree

3 files changed

+23
-203
lines changed

3 files changed

+23
-203
lines changed

‎build/ubuntu/install-packages.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ apt-get update
3535
apt-get install -y git-lfs
3636

3737
# Clean up APT when done
38-
apt-get clean
38+
rm -rf /var/lib/apt/lists/*
3939

4040
# Download and install patched knockd
4141
curl -fsSL -o /tmp/knock.tar.gz https://github.com/Metalcape/knock/releases/download/0.8.1/knock-0.8.1-$TARGET.tar.gz

‎docs/configuration/server-properties.md‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
In order to unify management of the Minecraft server container, all of the [`server.properties`](https://minecraft.wiki/w/Server.properties) entries can be managed by the environment variables described in the sections below. Some of the mappings provide additional functionality above and beyond the properties file.
1+
To unify management of the Minecraft server container, all known [`server.properties`](https://minecraft.wiki/w/Server.properties) entries can be managed by the environment variables described in the sections below. Some mappings provide additional functionality above and beyond the properties file and will be described in the sections below.
2+
3+
!!! warning "Version compatibility"
4+
5+
Not all server properties are supported by all versions of Minecraft. Since this image supports a wide range of versions, please consult the [server properties documentation](https://minecraft.wiki/w/Server.properties) for the version you are using.
26

37
If you prefer to manually manage the `server.properties` file, set `OVERRIDE_SERVER_PROPERTIES` to "false". Similarly, you can entirely skip the startup script's creation of `server.properties` by setting `SKIP_SERVER_PROPERTIES` to "true".
48

@@ -432,6 +436,7 @@ When using `docker run` from a bash shell, the entries must be quoted with the `
432436
| ACCEPTS_TRANSFERS | [accepts-transfers](https://minecraft.wiki/w/Server.properties#accepts-transfers) |
433437
| ALLOW_FLIGHT | [allow-flight](https://minecraft.wiki/w/Server.properties#allow-flight) |
434438
| ALLOW_NETHER | [allow-nether](https://minecraft.wiki/w/Server.properties#allow-nether) |
439+
| ANNOUNCE_PLAYER_ACHIEVEMENTS | |
435440
| BROADCAST_CONSOLE_TO_OPS | [broadcast-console-to-ops](https://minecraft.wiki/w/Server.properties#broadcast-console-to-ops) |
436441
| BROADCAST_RCON_TO_OPS | [broadcast-rcon-to-ops](https://minecraft.wiki/w/Server.properties#broadcast-rcon-to-ops) |
437442
| BUG_REPORT_LINK | [bug-report-link](https://minecraft.wiki/w/Server.properties#bug-report-link) |
@@ -442,6 +447,7 @@ When using `docker run` from a bash shell, the entries must be quoted with the `
442447
| FORCE_GAMEMODE | [force-gamemode](https://minecraft.wiki/w/Server.properties#force-gamemode) |
443448
| FUNCTION_PERMISSION_LEVEL | [function-permission-level](https://minecraft.wiki/w/Server.properties#function-permission-level) |
444449
| GENERATE_STRUCTURES | [generate-structures](https://minecraft.wiki/w/Server.properties#generate-structures) |
450+
| GENERATOR_SETTINGS | [generator-settings](https://minecraft.wiki/w/Server.properties#generator-settings) |
445451
| HARDCORE | [hardcore](https://minecraft.wiki/w/Server.properties#hardcore) |
446452
| HIDE_ONLINE_PLAYERS | [hide-online-players](https://minecraft.wiki/w/Server.properties#hide-online-players) |
447453
| LOG_IPS | [log-ips](https://minecraft.wiki/w/Server.properties#log-ips) |
@@ -453,6 +459,12 @@ When using `docker run` from a bash shell, the entries must be quoted with the `
453459
| MANAGEMENT_SERVER_TLS_ENABLED | [management-server-tls-enabled](https://minecraft.wiki/w/Server.properties#management-server-tls-enabled) |
454460
| MANAGEMENT_SERVER_TLS_KEYSTORE | [management-server-tls-keystore](https://minecraft.wiki/w/Server.properties#management-server-tls-keystore) |
455461
| MANAGEMENT_SERVER_TLS_KEYSTORE_PASSWORD | [management-server-tls-keystore-password](https://minecraft.wiki/w/Server.properties#management-server-tls-keystore-password) |
462+
| MAX_BUILD_HEIGHT | [max-build-height](https://minecraft.wiki/w/Server.properties#max-build-height) |
463+
| MAX_COMMAND_CHAIN_LENGTH | [max-command-chain-length](https://minecraft.wiki/w/Server.properties#max-command-chain-length) |
464+
| MAX_ENTITY_CRAMMING | [max-entity-cramming](https://minecraft.wiki/w/Server.properties#max-entity-cramming) |
465+
| MAX_ENTITY_COLLISION_RADIUS | [max-entity-collision-radius](https://minecraft.wiki/w/Server.properties#max-entity-collision-radius) |
466+
| MAX_FUNCTION_CHAIN_DEPTH | [max-function-chain-depth](https://minecraft.wiki/w/Server.properties#max-function-chain-depth) |
467+
| MAX_NEIGHBORS | [max-neighbors](https://minecraft.wiki/w/Server.properties#max-neighbors) |
456468
| MAX_CHAINED_NEIGHBOR_UPDATES | [max-chained-neighbor-updates](https://minecraft.wiki/w/Server.properties#max-chained-neighbor-updates) |
457469
| MAX_PLAYERS | [max-players](https://minecraft.wiki/w/Server.properties#max-players) |
458470
| MAX_TICK_TIME | [max-tick-time](https://minecraft.wiki/w/Server.properties#max-tick-time) |
@@ -470,7 +482,10 @@ When using `docker run` from a bash shell, the entries must be quoted with the `
470482
| RESOURCE_PACK_PROMPT | [resource-pack-prompt](https://minecraft.wiki/w/Server.properties#resource-pack-prompt) |
471483
| SERVER_NAME | [server-name](https://minecraft.wiki/w/Server.properties#server-name) |
472484
| SIMULATION_DISTANCE | [simulation-distance](https://minecraft.wiki/w/Server.properties#simulation-distance) |
485+
| SNOOPER_ENABLED | |
486+
| SPAWN_ANIMALS | [spawn-animals](https://minecraft.wiki/w/Server.properties#spawn-animals) |
473487
| SPAWN_MONSTERS | [spawn-monsters](https://minecraft.wiki/w/Server.properties#spawn-monsters) |
488+
| SPAWN_NPCS | [spawn-npcs](https://minecraft.wiki/w/Server.properties#spawn-npcs) |
474489
| SPAWN_PROTECTION | [spawn-protection](https://minecraft.wiki/w/Server.properties#spawn-protection) |
475490
| STATUS_HEARTBEAT_INTERVAL | [status-heartbeat-interval](https://minecraft.wiki/w/Server.properties#status-heartbeat-interval) |
476491
| SYNC_CHUNK_WRITES | [sync-chunk-writes](https://minecraft.wiki/w/Server.properties#sync-chunk-writes) |

‎docs/variables.md‎

Lines changed: 6 additions & 201 deletions
Original file line numberDiff line numberDiff line change
@@ -216,102 +216,6 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
216216
<td><code>FALSE</code></td>
217217
<td>⬜️</td>
218218
</tr>
219-
<tr>
220-
<td><code>MAX_PLAYERS</code></td>
221-
<td>The maximum number of players that can join the server.</td>
222-
<td><code>20</code></td>
223-
<td>⬜️</td>
224-
</tr>
225-
<tr>
226-
<td><code>MAX_WORLD_SIZE</code></td>
227-
<td>The maximum possible size in blocks, expressed as a radius.</td>
228-
<td><code></code></td>
229-
<td>⬜️</td>
230-
</tr>
231-
<tr>
232-
<td><code>ALLOW_NETHER</code></td>
233-
<td>Allows players to travel to the Nether</td>
234-
<td><code>true</code></td>
235-
<td>⬜️</td>
236-
</tr>
237-
<tr>
238-
<td><code>ANNOUNCE_PLAYER_ACHIEVEMENTS</code></td>
239-
<td>Allows server to announce when a player gets an achievement.</td>
240-
<td><code>true</code></td>
241-
<td>⬜️</td>
242-
</tr>
243-
<tr>
244-
<td><code>ENABLE_COMMAND_BLOCK</code></td>
245-
<td>Enables the command blocks.</td>
246-
<td><code></code></td>
247-
<td>⬜️</td>
248-
</tr>
249-
<tr>
250-
<td><code>FORCE_GAMEMODE</code></td>
251-
<td>Force players to join in the default game mode.</td>
252-
<td><code>false</code></td>
253-
<td>⬜️</td>
254-
</tr>
255-
<tr>
256-
<td><code>GENERATE_STRUCTURES</code></td>
257-
<td>Defines whether structures (such as villages) will be generated.</td>
258-
<td><code>true</code></td>
259-
<td>⬜️</td>
260-
</tr>
261-
<tr>
262-
<td><code>HARDCORE</code></td>
263-
<td>If set to <code>true</code>, players will be set to spectator mode if they die.</td>
264-
<td><code>false</code></td>
265-
<td>⬜️</td>
266-
</tr>
267-
<tr>
268-
<td><code>SNOOPER_ENABLED</code></td>
269-
<td>If set to false, the server will not send data to snoop.minecraft.net server.</td>
270-
<td><code>true</code></td>
271-
<td>⬜️</td>
272-
</tr>
273-
<tr>
274-
<td><code>MAX_BUILD_HEIGHT</code></td>
275-
<td>The maximum height in which building is allowed. Terrain may still naturally generate above a low height limit.</td>
276-
<td><code>256</code></td>
277-
<td>⬜️</td>
278-
</tr>
279-
<tr>
280-
<td><code>SPAWN_ANIMALS</code></td>
281-
<td>Determines if animals will be able to spawn.</td>
282-
<td><code>true</code></td>
283-
<td>⬜️</td>
284-
</tr>
285-
<tr>
286-
<td><code>SPAWN_MONSTERS</code></td>
287-
<td>Determines if monsters will be spawned.</td>
288-
<td><code>true</code></td>
289-
<td>⬜️</td>
290-
</tr>
291-
<tr>
292-
<td><code>SPAWN_NPCS</code></td>
293-
<td>Determines if villagers will be spawned.</td>
294-
<td><code>true</code></td>
295-
<td>⬜️</td>
296-
</tr>
297-
<tr>
298-
<td><code>SPAWN_PROTECTION</code></td>
299-
<td>Sets the area that non-ops can not edit (0 to disable)</td>
300-
<td><code></code></td>
301-
<td>⬜️</td>
302-
</tr>
303-
<tr>
304-
<td><code>VIEW_DISTANCE</code></td>
305-
<td>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.</td>
306-
<td><code></code></td>
307-
<td>⬜️</td>
308-
</tr>
309-
<tr>
310-
<td><code>SEED</code></td>
311-
<td>Sets the seed to create the Minecraft world. If you use a negative number, make sure that it is in quotes.</td>
312-
<td><code></code></td>
313-
<td>⬜️</td>
314-
</tr>
315219
<tr>
316220
<td><code>MODE</code></td>
317221
<td>Minecraft servers are configured to run in Survival mode by default. You can change the mode using MODE where you can either provide the <a href="http://minecraft.wiki/Game_mode#Game_modes">standard numerical values</a> or the shortcut values:<br />
@@ -324,118 +228,15 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
324228
<td><code></code></td>
325229
<td>⬜️</td>
326230
</tr>
327-
<tr>
328-
<td><code>PVP</code></td>
329-
<td>By default, servers are created with player-vs-player (PVP) mode enabled.</td>
330-
<td><code>true</code></td>
331-
<td>⬜️</td>
332-
</tr>
333-
<tr>
334-
<td><code>LEVEL_TYPE</code></td>
335-
<td>By default, a standard world is generated with hills, valleys, water, etc. A different level type can be configured by setting LEVEL_TYPE to <a href="https://minecraft.wiki/w/Server.properties#level-type">an expected type listed here</a>.
336-
</td>
337-
<td><code>minecraft:default</code></td>
338-
<td>⬜️</td>
339-
</tr>
340-
<tr>
341-
<td><code>GENERATOR_SETTINGS</code></td>
342-
<td>For some of the level types, <code>GENERATOR_SETTINGS</code> can be used to further customize the world generation <a href="https://minecraft.wiki/w/Server.properties#generator-settings">as described here</a>.</td>
343-
<td><code></code></td>
344-
<td>⬜️</td>
345-
</tr>
346231
<tr>
347232
<td><code>LEVEL</code></td>
348-
<td>You can either switch between world saves or run multiple containers with different saves by using the LEVEL option</td>
233+
<td>Maps to [the `level-name` server property](https://minecraft.wiki/w/Server.properties#level-name). You can either switch between world saves or run multiple containers with different saves by using the LEVEL option</td>
349234
<td><code>world</code></td>
350235
<td>⬜️</td>
351236
</tr>
352-
<tr>
353-
<td><code>ONLINE_MODE</code></td>
354-
<td>By default, server checks connecting players against Minecraft's account database. If you want to create an offline server or your server is not connected to the internet, you can disable the server to try connecting to minecraft.net to authenticate players</td>
355-
<td><code>true</code></td>
356-
<td>⬜️</td>
357-
</tr>
358-
<tr>
359-
<td><code>ALLOW_FLIGHT</code></td>
360-
<td>Allows users to use flight on your server while in Survival mode, if they have a mod that provides flight installed.</td>
361-
<td><code>FALSE</code></td>
362-
<td>⬜️</td>
363-
</tr>
364-
<tr>
365-
<td><code>SERVER_NAME</code></td>
366-
<td>The server name</td>
367-
<td><code></code></td>
368-
<td>⬜️</td>
369-
</tr>
370237
<tr>
371238
<td><code>SERVER_PORT</code></td>
372-
<td>Only change this value if you know what you're doing. It is only needed when using host networking and it is rare that host networking should be used.</td>
373-
<td><code></code></td>
374-
<td>⬜️</td>
375-
</tr>
376-
<tr>
377-
<td><code>PLAYER_IDLE_TIMEOUT</code></td>
378-
<td>player-idle-timeout</td>
379-
<td><code></code></td>
380-
<td>⬜️</td>
381-
</tr>
382-
<tr>
383-
<td><code>ENABLE_JMX</code></td>
384-
<td>enable-jmx-monitoring</td>
385-
<td><code></code></td>
386-
<td>⬜️</td>
387-
</tr>
388-
<tr>
389-
<td><code>SYNC_CHUNK_WRITES</code></td>
390-
<td>sync-chunk-writes</td>
391-
<td><code></code></td>
392-
<td>⬜️</td>
393-
</tr>
394-
<tr>
395-
<td><code>ENABLE_STATUS</code></td>
396-
<td>enable-status</td>
397-
<td><code></code></td>
398-
<td>⬜️</td>
399-
</tr>
400-
<tr>
401-
<td><code>ENTITY_BROADCAST_RANGE_PERCENTAGE</code></td>
402-
<td>entity-broadcast-range-percentage</td>
403-
<td><code></code></td>
404-
<td>⬜️</td>
405-
</tr>
406-
<tr>
407-
<td><code>FUNCTION_PERMISSION_LEVEL</code></td>
408-
<td>function-permission-level</td>
409-
<td><code></code></td>
410-
<td>⬜️</td>
411-
</tr>
412-
<tr>
413-
<td><code>NETWORK_COMPRESSION_THRESHOLD</code></td>
414-
<td>network-compression-threshold</td>
415-
<td><code></code></td>
416-
<td>⬜️</td>
417-
</tr>
418-
<tr>
419-
<td><code>OP_PERMISSION_LEVEL</code></td>
420-
<td>op-permission-level</td>
421-
<td><code></code></td>
422-
<td>⬜️</td>
423-
</tr>
424-
<tr>
425-
<td><code>PREVENT_PROXY_CONNECTIONS</code></td>
426-
<td>prevent-proxy-connections</td>
427-
<td><code></code></td>
428-
<td>⬜️</td>
429-
</tr>
430-
<tr>
431-
<td><code>USE_NATIVE_TRANSPORT</code></td>
432-
<td>use-native-transport</td>
433-
<td><code></code></td>
434-
<td>⬜️</td>
435-
</tr>
436-
<tr>
437-
<td><code>SIMULATION_DISTANCE</code></td>
438-
<td>simulation-distance</td>
239+
<td>Maps to [the `server-port` server property](https://minecraft.wiki/w/Server.properties#server-port). Only change this value if you know what you're doing. It is only needed when using host networking and it is rare that host networking should be used.</td>
439240
<td><code></code></td>
440241
<td>⬜️</td>
441242
</tr>
@@ -496,6 +297,10 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
496297
</tbody>
497298
</table>
498299

300+
### Server properties
301+
302+
This image maps known server properties as described in [this section](configuration/server-properties.md).
303+
499304
### Custom resource pack
500305

501306
<table>

0 commit comments

Comments
 (0)