diff options
| author | HimbeerserverDE <himbeerserverde@gmail.com> | 2024-01-24 18:20:31 +0100 |
|---|---|---|
| committer | HimbeerserverDE <himbeerserverde@gmail.com> | 2024-01-24 18:20:31 +0100 |
| commit | a2d3e4be5fd8158fbb07eb4e949589b7faf383b8 (patch) | |
| tree | 7b9269284af3ca8f584b961f5fc604b7113c3ccf | |
| parent | 971e1be9a2b8a1da4464f2ed8d55c88df7d9c7c4 (diff) | |
document github packages docker image
| -rw-r--r-- | doc/docker.md | 23 |
1 files changed, 22 insertions, 1 deletions
diff --git a/doc/docker.md b/doc/docker.md index 9ff9c38..1b8a20c 100644 --- a/doc/docker.md +++ b/doc/docker.md @@ -1,7 +1,28 @@ # Docker +The proxy can be run in Docker if you with to do so. +You may build it yourself or pull the latest image from +[GitHub Packages](https://github.com/HimbeerserverDE/mt-multiserver-proxy/pkgs/container/mt-multiserver-proxy). + This repository contains a `Dockerfile` at its root. -It can be used to build a release or development version into an image. +It can be used to build a release version into an image. +Development versions can be built using the `devel.Dockerfile`. + +## Pre-built image + +You can pull the latest version from [GitHub Packages](https://github.com/HimbeerserverDE/mt-multiserver-proxy/pkgs/container/mt-multiserver-proxy). +Simply follow the instructions at [Run](#run), replacing the image `mt-multiserver-proxy` +with `ghcr.io/himbeerserverde/mt-multiserver-proxy:main`. + +Example (without data volume): + +``` +docker run \ + -it \ + -p 40000:40000/udp \ + --name mt-multiserver-proxy \ + ghcr.io/himbeerserverde/mt-multiserver-proxy:main +``` ## Build |