Skip to content

Overviewer Support #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
Prev Previous commit
Next Next commit
Update README.md
Zeromusta authored Jan 9, 2017
commit be930fd636e6f3f5d346385d5620537fa340acf7
33 changes: 21 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -21,32 +21,41 @@ All credit to [nimmis](https://github.com/nimmis). This image build upon their w
**This is important and you only need to do it once.**

1) You need your own Google Maps API key. Click this link: https://developers.google.com/maps/documentation/javascript/get-api-key and follow the instructions.

2) [Install docker](https://docs.docker.com/engine/installation/)

3) Clone this repo and then run:

docker build -t docker_spigot_overviewer .

4) Subsitute these values into the command below.

2) Subsitute these values into the command below.
- Add your key to:
- `GOOGLE_MAPS_KEY=<--replace with your google maps key-->`, for example, `GOOGLE_MAPS_KEY=abcdefg-H1J2Lm4PQ-dscasdwqeqweb321321Jn`.
- Specify how much memory the minecraft server can utilise
- `MC_MAXMEM=<--megabytes-->m`, for example, `MC_MAXMEM=1500m`
- Add your key to:

- `GOOGLE_MAPS_KEY=<--replace with your google maps key-->`, for example, `GOOGLE_MAPS_KEY=abcdefg-H1J2Lm4PQ-dscasdwqeqweb321321Jn`.

- Specify how much memory the minecraft server can utilise

- `MC_MAXMEM=<--megabytes-->m`, for example, `MC_MAXMEM=1500m`

or
- `MC_MAXMEM=<--gigabytes-->g`, for example, `MC_MAXMEM=4g`

- `MC_MAXMEM=<--gigabytes-->g`, for example, `MC_MAXMEM=4g`

When ready, run:

docker run -d -p 25565:25565 -p 80:80 -e EULA=true -e MC_MAXMEM=<--replace with megabytes-->m -e GOOGLE_MAPS_KEY=<--replace with your google maps key--> --name mcserver docker_spigot_overviewer

Further information about the docker run command:

|Argument|Description|
|---|---|
|-p 25565:25565|Required. Opens the port minecraft uses for gameplay|
|-p 80:80|Required. Opens the http port so you can access Overviewer|
|-e GOOGLE_MAPS_KEY=<--replace with your google maps key-->|Required. You must add your own API key (which you can obtain from the link above) other overviewer **will not work**.
|-e EULA=true|Required. By adding arguemnt this you're accepting the [Minecraft EULA](https://account.mojang.com/documents/minecraft_eula).|
|-e MC_MAXMEM=<--megabytes-->m|Sets the maximum memory to use <size>m for Mb or <size>g for Gb, if this parameter is not set 1 Gb is chosen.
|--name mcserver|Names this docker container 'mcserver' so it's easier to address later.|
|`-p 25565:25565`|Required. Opens the port minecraft uses for gameplay|
|`-p 80:80`|Required. Opens the http port so you can access Overviewer|
|`-e GOOGLE_MAPS_KEY=<--replace with your google maps key-->`|Required. You must add your own API key (which you can obtain from the link above) other overviewer **will not work**.
|`-e EULA=true`|Required. By adding arguemnt this you're accepting the [Minecraft EULA](https://account.mojang.com/documents/minecraft_eula).|
|`-e MC_MAXMEM=<--megabytes-->m`|Sets the maximum memory to use <size>m for Mb or <size>g for Gb, if this parameter is not set 1 Gb is chosen.
|`--name mcserver`|Names this docker container 'mcserver' so it's easier to address later.|

### First time run