Update README.md

This commit is contained in:
Liam A Edwards
2023-10-08 18:54:25 +01:00
committed by GitHub
parent 3523e19090
commit b763ef3498

View File

@@ -16,8 +16,6 @@
---
### 📖 Overview
This project is for those who prefer containerized solutions, making server deployment and management a breeze. It's based on the [official documentation](https://docs.spacestation14.com/en/general-development/setup/server-hosting-tutorial.html) but wrapped up in a Docker container for convenience.
@@ -36,6 +34,8 @@ This project is for those who prefer containerized solutions, making server depl
3. **Run the Server**
Using Docker directly:
```bash
docker run -d \
-p 1212:1212/tcp \
@@ -46,5 +46,30 @@ This project is for those who prefer containerized solutions, making server depl
ghcr.io/liamaedwards/ss14-docker-linux-server:main
```
---
Or using Docker Compose:
First, create a `docker-compose.yml` file:
```yaml
version: '3'
services:
ss14-server:
image: ghcr.io/liamaedwards/ss14-docker-linux-server:main
ports:
- "1212:1212/tcp"
- "1212:1212/udp"
- "5000:5000/tcp"
- "5000:5000/udp"
volumes:
- /path/on/host:/ss14
restart: always
```
Then, run with:
```bash
docker-compose up -d
```
---