mirror of
https://github.com/Shik3i/KoalaSync.git
synced 2026-07-26 12:08:15 +00:00
feat: add docker-compose example and update GHCR deployment links
This commit is contained in:
@@ -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.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -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
|
||||
+6
-2
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user