diff --git a/README.md b/README.md index e39ae3f..ab01442 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,31 @@ in the "LAN Games" part of the "Friends" tab, such as: ![](docs/example-client.jpg) +## Deploying with Docker Compose + +The [examples](examples) directory contains [an example Docker compose file](examples/docker-compose.yml) that declares: +- a service running the bedrock server container and exposing UDP port 19132 +- a volume to be attached to the service + +The service configuration includes some examples of configuring the server properties via environment variables: +```yaml +environment: + EULA: "TRUE" + GAMEMODE: survival + DIFFICULTY: normal +``` + +From with in the `examples` directory, you can deploy the composition by using: + +```bash +docker-compose up -d +``` + +You can follow the logs using: +```bash +docker-compose logs -f bds +``` + ## Deploying with Kubernetes The [examples](examples) directory contains [an example Kubernetes manifest file](examples/kubernetes.yml) that declares: diff --git a/examples/docker-compose.yml b/examples/docker-compose.yml new file mode 100644 index 0000000..3ae91e9 --- /dev/null +++ b/examples/docker-compose.yml @@ -0,0 +1,16 @@ +version: '3.4' + +services: + bds: + image: itzg/minecraft-bedrock-server + environment: + EULA: "TRUE" + GAMEMODE: survival + DIFFICULTY: normal + ports: + - 19132:19132/udp + volumes: + - bds:/data + +volumes: + bds: {} \ No newline at end of file