mirror of
https://github.com/Shik3i/KoalaSync.git
synced 2026-07-26 12:08:15 +00:00
dependabot[bot]
5c805bcafa
Bumps the npm_and_yarn group with 1 update in the /server directory: [ws](https://github.com/websockets/ws). Updates `ws` from 8.18.3 to 8.20.1 - [Release notes](https://github.com/websockets/ws/releases) - [Commits](https://github.com/websockets/ws/compare/8.18.3...8.20.1) --- updated-dependencies: - dependency-name: ws dependency-version: 8.20.1 dependency-type: indirect dependency-group: npm_and_yarn ... Signed-off-by: dependabot[bot] <support@github.com>
KoalaSync Relay Server
A Node.js relay server for synchronized video playback.
Key Features
- Zero-Persistence: No database. All state is held in RAM.
- Privacy First: No tracking, no persistent logging of user data.
- WebSocket Only: Minimal overhead with efficient transport.
Setup
Environment
Copy .env.example to .env and configure your settings.
PORT=3000
MAX_ROOMS=1000
MAX_PEERS_PER_ROOM=50
MIN_VERSION=1.0.0
Docker (Recommended)
The server is available as a pre-built image on GHCR.
# 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 network compose or Static IP compose in the root directory for ready-to-use Docker Compose files.
Manual Setup
cd server
npm install
npm start
Security
- Rate Limiting: IP-based connection limits and socket-based event limits.
- Token Handshake: Requires a valid token defined in the root
shared/constants.js. - Single Source of Truth: The server imports constants directly from the root
shared/directory. - In-Memory: Rooms are automatically pruned after 2 hours of inactivity.