mimise/waterfall repository overview

⁠waterfall

Minecraft Micro Service tries to get a minecraft server as a micro service.

This repository holds the Watrefall proxy.

This image provides support for amd64 and arm/v7 (Raspberry Pi).

To use the proxy inside a container your minecraft also need to be inside a container. See Networking.

⁠Versions

This image is rebuild regularly to ensure always the newest build of Waterfall is available.

⁠Start server

docker run -d --name <container_name> -e mimise/waterfall

Note: Replace the placeholders.

⁠Networking

To connect the minecraft container with Waterfall all container need to join the same network.

... --network="proxy" ...

After you started the minecraft server and Waterfall server within the same network you can add the server to the config.yml.

As a hostname you can use the name from the container, the port is always 25565.

⁠Files

To get a feeling of a micro service the files separated between configs and data.

⁠Data

To bind data to a local folder use.

... -v `pwd`/data:/data ...

Data:

• locations.yml

⁠Config

If you want to change settings you can use the config folder. Just place the file in a config folder and mount it to the container.

... -v `pwd`/config:/config ...

Config:

• config.yml
• waterfall.yml

⁠Other

There are other files from a minecraft server where you not have access to.

• proxy.log.0
• modules.yml

Why I can't access the logs?

As this image tries to create a micro service logs should handled via the container stdout.

⁠Example with docker-compose

See files in example folder. As we use restart: unless-stopped the container restarts automatically when the server crashes or you stop the minecraft server.

⁠TODO

• enable to run commands in waterfall
• auto add server in config when new container in network