mirror of
https://github.com/Shik3i/KoalaSync.git
synced 2026-07-26 12:08:15 +00:00
4909a86a13
- Add central toast notification system (popup.html, popup.js) - Add browser notifications toggle (opt-in) with event toasts - Fix interpolation memory leak (unload listener) - Add /health endpoint with IP-based rate limiting (server) - Improve tab sorting (current tab first, matches, alphabetical) - Add copy-to-clipboard visual feedback with toast - Show targetTime in last action card for seek/force sync - Add explicit video cleanup when element removed (content.js) - Update ROADMAP.md to remove implemented features
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-compose.example.yml in the root directory for a ready-to-use configuration.
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.