readme: improved the readme
This commit is contained in:
parent
289ca52d3c
commit
a7de35364b
1 changed files with 5 additions and 8 deletions
13
README.md
13
README.md
|
@ -1,18 +1,15 @@
|
||||||
# minecraft-docker
|
# minecraft-docker
|
||||||
A docker container for running minecraft server!
|
A docker container for running a minecraft server!
|
||||||
|
|
||||||
# Installation Instructions
|
|
||||||
These are the instructions to set this up.
|
|
||||||
|
|
||||||
## Network setup
|
## Network setup
|
||||||
To setup the network you just need to use this command to create a network.
|
To setup the network you just need to use this command to create a network.
|
||||||
```
|
```
|
||||||
docker network create -d bridge minecraft-stack
|
docker network create -d bridge minecraft-stack
|
||||||
```
|
```
|
||||||
(You can use this for multiple server, for like setting up a proxy like bungee or velocity)
|
(You can use this for multiple servers, like setting up a proxy like bungee or velocity.)
|
||||||
|
|
||||||
## Configuring
|
## 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)
|
By default, the compose file won't work. To make it work, you need to add your name for your server, like -smp, and you will also 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"
|
version: "3.8"
|
||||||
|
|
||||||
|
@ -39,13 +36,13 @@ services:
|
||||||
Happy configuring!
|
Happy configuring!
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
You need to build the image now to do that use this command:
|
You need to build the image now. To do that, use this command:
|
||||||
```
|
```
|
||||||
docker-compose build
|
docker-compose build
|
||||||
```
|
```
|
||||||
|
|
||||||
## Spinning them up!
|
## Spinning them up!
|
||||||
To first test it run the container without -d but when all works just use the -d (Example):
|
To first test it, run the container without -d, but when all else fails, just use -d (example):
|
||||||
|
|
||||||
### Without -d for testing
|
### Without -d for testing
|
||||||
```
|
```
|
||||||
|
|
Loading…
Add table
Reference in a new issue