add example docker-compose and fix port documentation
This commit is contained in:
parent
8d5a8a16b3
commit
da1bafd725
|
@ -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
|
||||
|
|
21
README.md
21
README.md
|
@ -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.
|
||||
|
|
|
@ -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
|
Reference in New Issue