VideoGrace Server — ReadMe

# VideoGrace Server

VideoGrace Server provides the web client, signaling, WebRTC media, diagnostic telemetry and the CAN service bus.

The primary modern path is HTTPS/WSS plus WebRTC. WSM is kept as a fallback and compatibility path.

## First start

- Admin panel URL: `https://localhost/` on the server or `https://server.example.com/` from the network.
- Default management port: `443/tcp`.
- The first registered user becomes the owner and then manages users and grants from the admin panel.
- Windows: data and logs are stored under `C:\ProgramData\IVS\VideoGrace\Server` by default; binaries are installed to `C:\Program Files\VideoGraceServer`.
- Linux: installation and data are stored under `/opt/VideoGrace/Server` by default.
- Main databases: `main.db`, `history.db`, `storage.db`, `api.db` in the configured `db` directory.

## Network and certificates

Required ports

- `443/tcp` — HTTPS, Admin API, WebSocket control, web client, PWA/service worker.
- `5060/udp` — legacy RTP/translator compatibility.
- `43000-43999/udp` — WebRTC ICE/DTLS/SRTP unless changed in configuration.

TLS

- Browsers require a trusted HTTPS certificate for the server domain.
- Self-signed/PKI mode is available at `/pki/`, but browsers and mobile OSes must trust the root certificate.
- HTTPS is required for Web Push and PWA installation.

## Media transport

- WebRTC-first: browsers connect to an RTC endpoint selected by the server and receive media over WebRTC.
- WSM fallback: used only when WebRTC is unavailable or fallback is explicitly selected.
- Codecs: Opus audio; browser video path uses H.264/VP8 depending on client and RTC endpoint capabilities.
- Diagnostics: admin UI exposes WebRTC counters, stalled/ok media status, remote audio/video health and client probes.

## CAN, services and storage

- CAN is the internal service bus for jobs, diagnostic events and recorder/rtc-edge/AI integrations.
- Recorder/Consolidator can still run as legacy processes, while new scenarios are built around CAN services.
- Object storage stores attachments and blobs using the filesystem backend and `storage.db`; large objects should be streamed.
- Web Push is configured through VAPID in server Push settings; FCM and Apple Web Push browser endpoints are supported.

## Operations

- Use the admin dashboard to monitor uptime, WebRTC, storage, CAN and update availability.
- Windows logs: `C:\ProgramData\IVS\VideoGrace\Server\logs`; Linux log file: `/var/log/vgserver/VGServer.log`.
- Windows settings: `HKLM\Software\IVS\VideoGrace-Server`; Linux config file: `/opt/VideoGrace/Server/vgserver.conf`.
- Restart the service after changing network ports or TLS certificates.
- Back up the configured `db` directory and the object storage directory.

## Support

Admin documentation: https://videograce.ru/doc/admin/

Downloads and updates: https://videograce.ru/download

E-mail: contact@videograce.ru

Website: https://videograce.ru/