From 63ee39a599a19ed488a8fa41cea254ff1f36c059 Mon Sep 17 00:00:00 2001
From: Matthew Green <greenmatthew07@gmail.com>
Date: Tue, 8 Apr 2025 18:14:12 -0500
Subject: [PATCH] Fixing volume mapping to wrong dir. Also added proper
 README.md with quick start and env var options.

---
 Makefile  |   2 +-
 README.md | 111 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 start.sh  |   2 +-
 3 files changed, 112 insertions(+), 3 deletions(-)

diff --git a/Makefile b/Makefile
index 3dad97d..ef43e74 100644
--- a/Makefile
+++ b/Makefile
@@ -23,7 +23,7 @@ run: build
 	@echo "Running container: $(CONTAINER_NAME)"
 	docker run -d --name $(CONTAINER_NAME) \
 		-p $(PORT):$(PORT)/udp \
-		-v $(PWD)/config:/home/steam/config \
+		-v $(PWD)/config:/home/steam/.config \
 		-e UID=1001 \
 		-e GID=1001 \
 		--restart unless-stopped \
diff --git a/README.md b/README.md
index 7d8db88..036bb84 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,110 @@
-# scp-secret-laboratory-docker
+# SCP: Secret Laboratory Docker Server
+
+A Docker container for easily running an SCP: Secret Laboratory dedicated server.
+
+## Quick Start
+
+<details open>
+<summary><b>Using Docker Compose (Recommended)</b></summary>
+
+1. Create a `docker-compose.yml` file:
+
+```yaml
+services:
+  scp-sl-server:
+    image: greenmatthew/scp-secret-laboratory-server:latest
+    container_name: scp-sl-server
+    ports:
+      - "7777:7777/udp"
+    volumes:
+      - ./config:/home/steam/.config
+    environment:
+      - UID=1000
+      - GID=1000
+    restart: unless-stopped
+```
+
+2. Start the server:
+
+```bash
+docker-compose up -d
+```
+
+3. Check logs:
+
+```bash
+docker-compose logs -f
+```
+</details>
+
+<details>
+<summary><b>Using Docker CLI</b></summary>
+
+1. Pull the image:
+
+```bash
+docker pull greenmatthew/scp-secret-laboratory-server:latest
+```
+
+2. Run the server:
+
+```bash
+docker run -d \
+  --name scp-sl-server \
+  -p 7777:7777/udp \
+  -v ./config:/home/steam/.config \
+  -e UID=1000 \
+  -e GID=1000 \
+  --restart unless-stopped \
+  greenmatthew/scp-secret-laboratory-server:latest
+```
+
+3. Check logs:
+
+```bash
+docker logs -f scp-sl-server
+```
+</details>
+
+## Configuration
+
+Mounting the .config directory allows you to configure any server setting and have it persist between container restarts.
+
+## Environment Variables
+
+- `UID`: User ID to run the server as (default: 1000)
+- `GID`: Group ID to run the server as (default: 1000)
+
+## Port Configuration
+
+The default server port is 7777/UDP. To use a different external port, adjust the port mapping:
+
+<details>
+<summary><b>In Docker Compose</b></summary>
+
+```yaml
+ports:
+  - "8777:7777/udp"  # Maps external port 8777 to internal port 7777
+```
+</details>
+
+<details>
+<summary><b>In Docker CLI</b></summary>
+
+```bash
+-p 8777:7777/udp  # Maps external port 8777 to internal port 7777
+```
+</details>
+
+## Development
+
+A Makefile is included for development:
+
+```bash
+# For available commands
+make help
+```
+
+## License
+
+Released under the MIT License. See [LICENSE](LICENSE) file for details.
\ No newline at end of file
diff --git a/start.sh b/start.sh
index 7bb2bea..84c35d6 100644
--- a/start.sh
+++ b/start.sh
@@ -24,6 +24,6 @@ if [ ! -f "$INTERNAL_DATA_FILE" ]; then
 fi
 
 # Run server
-cd $SERVER_DIR && HOME=$INSTALL_DIR ./LocalAdmin $PORT --config $(CONFIG_DIR)
+cd $SERVER_DIR && HOME=$INSTALL_DIR ./LocalAdmin $PORT
 
 sleep infinity
\ No newline at end of file