add docs, protocol, plugins, README, CHANGELOG

This commit is contained in:
loki5512344 2026-07-09 12:30:55 +02:00
parent 1d2209bfac
commit f262da222b
Signed by: boba
GPG key ID: 253067914055423B
44 changed files with 9269 additions and 0 deletions

34
docs/03-server/README.md Normal file
View file

@ -0,0 +1,34 @@
# Server / Gateway
A VNOX node consists of two processes:
```
gateway — TCP, handles auth / chat / channels / permissions
voice-node — UDP, handles voice relay
```
Both are written in Rust. They can run on the same machine or separately.
For most self-hosted setups, running both on one machine is fine.
---
## Minimum requirements
| | Minimum | Recommended |
|---|---|---|
| CPU | 1 core | 2+ cores |
| RAM | 256 MB | 512 MB |
| Bandwidth | 1 Mbps up | 10 Mbps up |
| OS | Linux x86_64 | Linux x86_64 |
| Ports | TCP 7600, UDP 7700 | configurable |
Voice bandwidth scales with concurrent speakers:
~64 kbps per active speaker (default 64k bitrate, 20ms frames).
---
## Sections
- [deployment.md](deployment.md) — how to install and run a node
- [configuration.md](configuration.md) — full config.toml reference
- [operations.md](operations.md) — metrics, logs, backup, upgrades