From b763ef349839ad7ffa4941bdb65839ae70e9e1d6 Mon Sep 17 00:00:00 2001 From: Liam A Edwards Date: Sun, 8 Oct 2023 18:54:25 +0100 Subject: [PATCH] Update README.md --- README.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 31bae35..6a2ddce 100644 --- a/README.md +++ b/README.md @@ -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 + ``` + +---