BibaVPN User Manual
Status
BibaVPN is experimental. The on-wire protocol is not frozen. Run matching versions of client, server, and GUI apps from the same release or commit. See CHANGELOG before upgrading.
Manual chapters
| Chapter | Description |
|---|---|
| How it works | Architecture, traffic path, protocols, terminology |
| Download | Releases, Docker images, building from source |
| Server setup | Running bibavpn-server on a VPS or at home |
| Control plane provisioning | How the control plane launches secure Docker instances |
| Client setup | CLI, apps, SOCKS5/HTTP CONNECT, invites |
| Security | Threat model, credentials, TLS, disclosure |
Reference documentation (repository root)
These files stay in the repo root and go deeper than this manual:
- README.md — project overview and quick starts
- PROTOCOL.md — wire formats, session flow, invite format
- AGENTS.md — every CLI flag, crate layout, contributor workflows
- SECURITY.md — reporting vulnerabilities
- DESIGN.md — visual design tokens for apps
Support and source
- Repository: github.com/Eljaja/BibaVPN
- License: MIT
Obey applicable laws and your hosting provider’s terms when operating a tunnel.