diff --git a/.github/workflows/generate-toc.yml b/.github/workflows/generate-toc.yml deleted file mode 100644 index 59b96f8e..00000000 --- a/.github/workflows/generate-toc.yml +++ /dev/null @@ -1,21 +0,0 @@ -name: Generate README table of contents -on: - push: - branches: - - master - paths: - - README.md -jobs: - generate: - if: github.repository == 'itzg/docker-minecraft-server' - runs-on: ubuntu-latest - timeout-minutes: 5 - steps: - - uses: actions/checkout@v3 - - run: | - curl https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc -o gh-md-toc - chmod a+x gh-md-toc - ./gh-md-toc --insert --no-backup README.md - - uses: stefanzweifel/git-auto-commit-action@v4.14.1 - with: - commit_message: "docs: Auto update markdown TOC" \ No newline at end of file diff --git a/README.md b/README.md index bc88a72b..a1df38b7 100644 --- a/README.md +++ b/README.md @@ -21,142 +21,6 @@ where, in this case, the standard server port 25565, will be exposed on your hos By default, the container will download the latest version of the "vanilla" [Minecraft: Java Edition server](https://www.minecraft.net/en-us/download/server) provided by Mojang. The [`VERSION`](#versions) and the [`TYPE`](#server-types) can be configured to create many variations of desired Minecraft server. -**TABLE OF CONTENTS** - - - * [Mitigated Log4jShell Vulnerability](#mitigated-log4jshell-vulnerability) - * [Looking for a Bedrock Dedicated Server](#looking-for-a-bedrock-dedicated-server) - * [Interacting with the server](#interacting-with-the-server) - * [Data Directory](#data-directory) - * [Attaching data directory to host filesystem](#attaching-data-directory-to-host-filesystem) - * [Converting anonymous /data volume to named volume](#converting-anonymous-data-volume-to-named-volume) - * [Versions](#versions) - * [Running Minecraft server on different Java version](#running-minecraft-server-on-different-java-version) - * [Deprecated Image Tags](#deprecated-image-tags) - * [Related Projects](#related-projects) - * [itzg/minecraft-bedrock-server](#itzgminecraft-bedrock-server) - * [mc-router](#mc-router) - * [itzg/bungeecord](#itzgbungeecord) - * [itzg/mc-backup](#itzgmc-backup) - * [rcon-cli](#rcon-cli) - * [mc-monitor](#mc-monitor) - * [mc-image-helper](#mc-image-helper) - * [Healthcheck](#healthcheck) - * [Deployment Templates and Examples](#deployment-templates-and-examples) - * [Helm Charts](#helm-charts) - * [Examples](#examples) - * [Amazon Web Services (AWS) Deployment](#amazon-web-services-aws-deployment) - * [Using Docker Compose](#using-docker-compose) - * [Troubleshooting](#troubleshooting) - * [Server types](#server-types) - * [Running a Forge Server](#running-a-forge-server) - * [Running a Fabric Server](#running-a-fabric-server) - * [Running a Bukkit/Spigot server](#running-a-bukkitspigot-server) - * [Running a Paper server](#running-a-paper-server) - * [Running an Airplane server](#running-an-airplane-server) - * [Running a Pufferfish server](#running-a-pufferfish-server) - * [Running a Purpur server](#running-a-purpur-server) - * [Running a Magma server](#running-a-magma-server) - * [Running a Mohist server](#running-a-mohist-server) - * [Running a Catserver type server](#running-a-catserver-type-server) - * [Running a Loliserver type server](#running-a-loliserver-type-server) - * [Running a Canyon server](#running-a-canyon-server) - * [Running a SpongeVanilla server](#running-a-spongevanilla-server) - * [Running a Limbo server](#running-a-limbo-server) - * [Running a Crucible server](#running-a-crucible-server) - * [Running a server with a Feed the Beast modpack](#running-a-server-with-a-feed-the-beast-modpack) - * [Environment Variables:](#environment-variables) - * [Upgrading](#upgrading) - * [Example](#example) - * [Running a server with a CurseForge modpack](#running-a-server-with-a-curseforge-modpack) - * [Modpack data directory](#modpack-data-directory) - * [Buggy start scripts](#buggy-start-scripts) - * [Fixing "unable to launch forgemodloader"](#fixing-unable-to-launch-forgemodloader) - * [Running a server with a packwiz modpack](#running-a-server-with-a-packwiz-modpack) - * [Working with mods and plugins](#working-with-mods-and-plugins) - * [Optional plugins, mods, and config attach points](#optional-plugins-mods-and-config-attach-points) - * [Auto-downloading SpigotMC/Bukkit/PaperMC plugins](#auto-downloading-spigotmcbukkitpapermc-plugins) - * [Downloadable mod/plugin pack for Forge, Fabric, and Bukkit-like Servers](#downloadable-modplugin-pack-for-forge-fabric-and-bukkit-like-servers) - * [ForgeAPI usage to use non-version specific projects](#forgeapi-usage-to-use-non-version-specific-projects) - * [Generic pack files](#generic-pack-files) - * [Mod/Plugin URL Listing File](#modplugin-url-listing-file) - * [Remove old mods/plugins](#remove-old-modsplugins) - * [Working with world data](#working-with-world-data) - * [Downloadable world](#downloadable-world) - * [Cloning world from a container path](#cloning-world-from-a-container-path) - * [Overwrite world on start](#overwrite-world-on-start) - * [Datapacks](#datapacks) - * [VanillaTweaks](#vanillatweaks) - * [Server configuration](#server-configuration) - * [Message of the Day](#message-of-the-day) - * [Difficulty](#difficulty) - * [Whitelist Players](#whitelist-players) - * [Op/Administrator Players](#opadministrator-players) - * [Server icon](#server-icon) - * [Rcon](#rcon) - * [Query](#query) - * [Max players](#max-players) - * [Max world size](#max-world-size) - * [Allow Nether](#allow-nether) - * [Announce Player Achievements](#announce-player-achievements) - * [Enable Command Block](#enable-command-block) - * [Force Gamemode](#force-gamemode) - * [Generate Structures](#generate-structures) - * [Hardcore](#hardcore) - * [Snooper](#snooper) - * [Max Build Height](#max-build-height) - * [Max Tick Time](#max-tick-time) - * [Spawn Animals](#spawn-animals) - * [Spawn Monsters](#spawn-monsters) - * [Spawn NPCs](#spawn-npcs) - * [Set spawn protection](#set-spawn-protection) - * [View Distance](#view-distance) - * [Level Seed](#level-seed) - * [Game Mode](#game-mode) - * [PVP Mode](#pvp-mode) - * [Level Type and Generator Settings](#level-type-and-generator-settings) - * [Custom Server Resource Pack](#custom-server-resource-pack) - * [Level / World Save Name](#level--world-save-name) - * [Online mode](#online-mode) - * [Allow flight](#allow-flight) - * [Server name](#server-name) - * [Server port](#server-port) - * [Other server property mappings](#other-server-property-mappings) - * [Miscellaneous Options](#miscellaneous-options) - * [Replacing variables inside configs](#replacing-variables-inside-configs) - * [Patching existing files](#patching-existing-files) - * [Running with a custom server JAR](#running-with-a-custom-server-jar) - * [Force re-download of the server file](#force-re-download-of-the-server-file) - * [Running as alternate user/group ID](#running-as-alternate-usergroup-id) - * [Memory Limit](#memory-limit) - * [JVM Options](#jvm-options) - * [Interactive and Color Console](#interactive-and-color-console) - * [Server Shutdown Options](#server-shutdown-options) - * [OpenJ9 Specific Options](#openj9-specific-options) - * [Enabling rolling logs](#enabling-rolling-logs) - * [Timezone Configuration](#timezone-configuration) - * [Enable Remote JMX for Profiling](#enable-remote-jmx-for-profiling) - * [Enable Aikar's Flags](#enable-aikars-flags) - * [HTTP Proxy](#http-proxy) - * [Using "noconsole" option](#using-noconsole-option) - * [Explicitly disable GUI](#explicitly-disable-gui) - * [Stop Duration](#stop-duration) - * [Setup only](#setup-only) - * [Enable Flare Flags](#enable-flare-flags) - * [Enable timestamps in init logs](#enable-timestamps-in-init-logs) - * [Use RCON commands](#use-rcon-commands) - * [Autopause](#autopause) - * [Description](#description) - * [Enabling Autopause](#enabling-autopause) - * [Autostop](#autostop) - * [Running on RaspberryPi](#running-on-raspberrypi) - * [Contributing](#contributing) - - - - - - ## Mitigated Log4jShell Vulnerability **Please ensure you have pulled the latest image** since [all official mitigations](https://www.minecraft.net/en-us/article/important-message--security-vulnerability-java-edition) are automatically applied by the container startup process.