From 289ca52d3c41e90e9dd8386c2ce024dcb73e531f Mon Sep 17 00:00:00 2001 From: Kaley Fischer Date: Sat, 17 Feb 2024 12:28:57 +0100 Subject: [PATCH] Docs: added some proper documentation --- README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++ docker-compose.yml | 15 ++++++------ 2 files changed, 69 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e69de29..5dc57dd 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,61 @@ +# minecraft-docker +A docker container for running minecraft server! + +# Installation Instructions +These are the instructions to set this up. + +## Network setup +To setup the network you just need to use this command to create a network. +``` +docker network create -d bridge minecraft-stack +``` +(You can use this for multiple server, for like setting up a proxy like bungee or velocity) + +## Configuring +By default the compose file won't work to make it work you need to add your name for your server like -smp, also you will need to set an ip for it. (I will give you an example on how to set it up for a proxy) +``` +version: "3.8" + +networks: + customnetwork: + external: true + name: minecraft-stack + +services: + minecraft-proxy: + restart: always + image: minecraft-proxy + build: ./minecraft-docker + command: ["java", "-Xmx2048M", "-jar", "server.jar", "true"] + networks: + customnetwork: + ipv4_address: 192.168.16.2 + volumes: + - "./data:/root/minecraft" + ports: + - "25565:25565" + - "8001:8001" # RCON (REMOTE CONSOLE) +``` +Happy configuring! + +## Building +You need to build the image now to do that use this command: +``` +docker-compose build +``` + +## Spinning them up! +To first test it run the container without -d but when all works just use the -d (Example): + +### Without -d for testing +``` +docker-compose up +``` + +### With -d for daemoninzing +``` +docker-compose up -d +``` + +# Contributors +- DRAGONTOS diff --git a/docker-compose.yml b/docker-compose.yml index 36a6d30..49fe057 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,20 +1,21 @@ version: "3.8" networks: - bridge-network: - external: - name: bridge-network + customnetwork: + external: true + name: minecraft-stack services: - minecraft: + minecraft-(CHANGETHIS): restart: always - image: minecraft + image: minecraft-(CHANGETHIS) build: ./minecraft-docker command: ["java", "-Xmx2048M", "-jar", "server.jar", "true"] networks: - - bridge-network + customnetwork: + ipv4_address: 192.168.16.(CHANGETHIS) volumes: - "./data:/root/minecraft" ports: - "25565:25565" - - "25575:25575" + - "8001:8001" # RCON (REMOTE CONSOLE)