add example docker-compose and fix port documentation
Build Container Image / build_amd64 (push) Successful in 1m19s Details
Build Container Image / publish_amd64 (push) Successful in 42s Details

This commit is contained in:
Daniel Wolf 2023-06-19 14:07:16 -04:00
parent 8d5a8a16b3
commit da1bafd725
Signed by: nephatrine
GPG Key ID: 59D70EC2E4AAB4D0
3 changed files with 27 additions and 6 deletions

View File

@ -15,4 +15,4 @@ USER ${USER}
WORKDIR ${HOMEDIR}
CMD ["/usr/local/bin/starbound.sh"]
EXPOSE 21025/tcp 21026/udp 21027/udp
EXPOSE 21025/tcp 21025/udp 21026/tcp

View File

@ -6,11 +6,21 @@
This docker image contains a Starbound server to self-host your own game.
You can spin up a quick temporary test container like this:
This is an example docker-compose file:
~~~
docker run --rm -p 21025:21025 -it nephatrine/starbound-scmd:latest /bin/bash
~~~
```yaml
services:
starbound:
image: nephatrine/starbound-scmd:latest
container_name: starbound
ports:
- "21025:21025/tcp"
- "21025:21025/udp"
- "21026:21026/tcp"
volumes:
- /mnt/starbound-scmd:/opt/starbound-dedicated
```
The installation uses **SteamCMD** and so will need your Steam credentials and
SteamGuard 2FA. Due to this, it cannot be automated. On startup, if not
@ -48,4 +58,5 @@ the container. You can map these to host ports using the ``-p HOST:CONTAINER``
or ``-p HOST:CONTAINER/PROTOCOL`` syntax.
- ``21025/tcp``: Game Server.
- ``21026/udp``: RCon Port.
- ``21025/udp``: Query Server.
- ``21026/tcp``: RCon Server.

10
docker-compose.yml Normal file
View File

@ -0,0 +1,10 @@
services:
starbound:
build: .
container_name: starbound
ports:
- "21025:21025/tcp"
- "21025:21025/udp"
- "21026:21026/tcp"
volumes:
- /mnt/starbound-dedicated:/opt/starbound-dedicated