Docs: added some proper documentation
This commit is contained in:
parent
5a1da6cc64
commit
289ca52d3c
2 changed files with 69 additions and 7 deletions
61
README.md
61
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
|
|
@ -1,20 +1,21 @@
|
||||||
version: "3.8"
|
version: "3.8"
|
||||||
|
|
||||||
networks:
|
networks:
|
||||||
bridge-network:
|
customnetwork:
|
||||||
external:
|
external: true
|
||||||
name: bridge-network
|
name: minecraft-stack
|
||||||
|
|
||||||
services:
|
services:
|
||||||
minecraft:
|
minecraft-(CHANGETHIS):
|
||||||
restart: always
|
restart: always
|
||||||
image: minecraft
|
image: minecraft-(CHANGETHIS)
|
||||||
build: ./minecraft-docker
|
build: ./minecraft-docker
|
||||||
command: ["java", "-Xmx2048M", "-jar", "server.jar", "true"]
|
command: ["java", "-Xmx2048M", "-jar", "server.jar", "true"]
|
||||||
networks:
|
networks:
|
||||||
- bridge-network
|
customnetwork:
|
||||||
|
ipv4_address: 192.168.16.(CHANGETHIS)
|
||||||
volumes:
|
volumes:
|
||||||
- "./data:/root/minecraft"
|
- "./data:/root/minecraft"
|
||||||
ports:
|
ports:
|
||||||
- "25565:25565"
|
- "25565:25565"
|
||||||
- "25575:25575"
|
- "8001:8001" # RCON (REMOTE CONSOLE)
|
||||||
|
|
Loading…
Add table
Reference in a new issue