From 6093da4dc6c9c967d2bf602e3b77a1dda8772569 Mon Sep 17 00:00:00 2001
From: MacBook <macbook@shik3i.net>
Date: Mon, 4 May 2026 05:12:22 +0200
Subject: [PATCH] feat: add docker-compose example and update GHCR deployment
 links

---
 README.md                  | 11 ++++++++---
 docker-compose.example.yml | 25 +++++++++++++++++++++++++
 server/README.md           |  8 ++++++--
 3 files changed, 39 insertions(+), 5 deletions(-)
 create mode 100644 docker-compose.example.yml

diff --git a/README.md b/README.md
index 4cf5f1c..2eb529b 100644
--- a/README.md
+++ b/README.md
@@ -56,11 +56,16 @@ node scripts/build-extension.js
 The compiled artifacts will be available in the `dist/` directory.
 
 #### For Self-Hosting (Docker)
-Deploy your own private relay server:
+Deploy your own private relay server using our official image:
 ```bash
-docker-compose up -d --build
+# Pull the latest image
+docker pull ghcr.io/shik3i/koalasync:latest
+
+# Or use our example compose file
+cp docker-compose.example.yml docker-compose.yml
+docker-compose up -d
 ```
-The server will be available at `ws://localhost:3000`.
+The server will be available at `ws://localhost:3000`. See [docker-compose.example.yml](docker-compose.example.yml) for advanced configuration.
 
 ---
 
diff --git a/docker-compose.example.yml b/docker-compose.example.yml
new file mode 100644
index 0000000..72683c7
--- /dev/null
+++ b/docker-compose.example.yml
@@ -0,0 +1,25 @@
+services:
+  koala-sync:
+    image: ghcr.io/shik3i/koalasync:latest
+    container_name: KoalaSync
+    restart: always
+    ports:
+      - "3000:3000"
+    environment:
+      - TZ=Europe/Berlin
+      - PORT=3000
+      - MIN_VERSION=1.0.0
+      - MAX_ROOMS=100
+      - MAX_PEERS_PER_ROOM=50
+    # KoalaSync uses in-memory storage for the relay, 
+    # so no persistent database volume is required.
+    pids_limit: 2048
+    # Example for custom network (e.g., Unraid/Macvlan)
+    # networks:
+    #   custom_network:
+    #     ipv4_address: 192.168.1.XXX
+
+# networks:
+#   custom_network:
+#     external: true
+#     name: br0
diff --git a/server/README.md b/server/README.md
index 5284d1c..f7453bc 100644
--- a/server/README.md
+++ b/server/README.md
@@ -19,11 +19,15 @@ MIN_VERSION=1.0.0
 ```
 
 ### Docker (Recommended)
-The server is designed to run in a Docker container.
+The server is available as a pre-built image on GHCR.
 ```bash
-# Build from the repository root
+# Pull from GHCR
+docker pull ghcr.io/shik3i/koalasync:latest
+
+# Or build from the repository root
 docker build -t koala-sync-server -f server/Dockerfile .
 ```
+See [docker-compose.example.yml](../docker-compose.example.yml) in the root directory for a ready-to-use configuration.
 
 ### Manual Setup
 ```bash