VNOX-Server/docs/03-server/README.md
loki5512344 c18ccadf99
chore(server): checkpoint deployed services and unfinished forums
User requested a checkpoint and stopped all agents. Deployed artifacts remain the last verified releases; unfinished settings/categories/forums are preserved as WIP. See TODO/roadmap for verification and remaining release/updater work.
2026-11-01 15:31:20 +01:00

40 lines
1.3 KiB
Markdown

# Server / Gateway
A VNOX node contains two components:
```
gateway — TCP, handles auth / chat / channels / permissions
voice-node — UDP, handles voice relay
```
Both are written in Rust. Run `vnox-serverd` for working voice: it connects the
gateway to voice-node through an in-process authenticated credential bridge.
Standalone gateway and voice-node binaries exist, but separate-process signaling
is not implemented; standalone voice-node fails closed without credentials.
The optional central account service is `vnox-hub`. It provides browser sign-in,
profile/handle selection and own-avatar APIs; it does not relay community messages
or voice. See [Hub setup](../../hub/README.md) and [account API](../../hub/AUTH.md).
---
## 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