feat: add docker-compose example and update GHCR deployment links

2026-08-28 03:27:10 +00:00 · 2026-05-04 05:12:22 +02:00
parent 583e15745f
commit 6093da4dc6
3 changed files with 39 additions and 5 deletions
@@ -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.

 ---