From ff8b160a2baa5ceff41ffd23b6144190ee729666 Mon Sep 17 00:00:00 2001 From: Geoff Bourne Date: Sat, 21 Aug 2021 13:52:25 -0500 Subject: [PATCH] docs: added troubleshooting section --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 7b31bc58..51ec9bc8 100644 --- a/README.md +++ b/README.md @@ -350,6 +350,14 @@ and in the same directory as that file run Now, go play...or adjust the `environment` section to configure this server instance. +## Troubleshooting + +To troubleshoot the container initialization, such as when server files are pre-downloaded, set the environment variable `DEBUG` to `true`. The container logs will include **much more** output, and it is highly recommended including that output when reporting any [issues](https://github.com/itzg/docker-minecraft-server/issues). + +To troubleshoot just the command-line used to start the Minecraft server, set the environment variable `DEBUG_EXEC` to `true`. + +To troubleshoot any issues with memory allocation reported by the JVM, set the environment variable `DEBUG_MEMORY` to `true`. + ## Server types ### Running a Forge Server