The single navigation point. Documents are grouped by audience: what a user and an operator need first, then internal and historical material.
New here? Start with Getting started, then Configuration. If something doesn't work — Troubleshooting.
Русская версия → ../ru/index.md
| Document | What it covers |
|---|---|
| GETTING-STARTED.md | Installation and first run, step by step from scratch |
| TROUBLESHOOTING.md | Connection diagnostics and error reference |
| Document | What it covers |
|---|---|
| CONFIG.md | Configuration (flat-INI): every server and client parameter |
| CLIENT-CONFIG-MATRIX.md | All 73 client keys by platform: 0.7.14 → 0.7.15 |
| PANEL.md | Web panel: installation and usage |
| OPERATIONS.md | Operations: compatibility, upgrades and rollback, backup, firewall |
| Document | What it covers |
|---|---|
| KEENETIC-DEPLOY.md | Step-by-step client deployment on Keenetic |
| KEENETIC-PORT.md | Porting the client to Keenetic (dual-arch: mipsel + aarch64) |
| Document | What it covers |
|---|---|
| AUDIT.md | Security model and current status |
| THREAT-MODEL.md | Threat model |
| DPI-AUDIT.md | DPI detectability audit: tells and their mitigation |
| Document | What it covers |
|---|---|
| README.md | Project overview: what it is, why, wire modes, crypto stack |
| COMPARISON.md | Comparison with WireGuard / OpenVPN / V2Ray |
| BENCHMARK.md | Load testing and per-mode measurements |
| ROAMING.md | Client roaming (seamless network change) |
Internal documents: plans and status, not end-user guides.
| Document | What it covers |
|---|---|
| ROADMAP.md | Roadmap |
| REFACTOR-PLAN.md | Refactoring plan: eliminating code duplication |
| TRANSPORT-CORE.md | A shared transport core in Rust for every client: proposal, measurements, plan |
| DESIGN-remaining.md | REALITY development stages: status and remainder |
| RELEASE-FIXES.md | Plan to finish off toward a stable release |
Point-in-time reports of past reviews, kept for the record — for the current security posture read AUDIT.md, not these.
| Document | Date |
|---|---|
| AUDIT-2026-06-10.md | 2026-06-10 — security and reliability audit |
| AUDIT-2026-06-11.md | 2026-06-11 — external audit review and fixes |
| AUDIT-2026-06-11-external2.md | 2026-06-11 — review of the second external audit |
| AUDIT-2026-06-12.md | 2026-06-12 — audit and fixes (release 0.7.1) |
| Client | Document |
|---|---|
| Windows | qeli-win/README.md |
| macOS | qeli-mac/README.md |
| iOS |
qeli-ios/README.md · MDM: qeli-ios/MDM/README.md — feature-complete but never run on a device, and nothing ships from it |
| Routers (OpenWrt) | qeli-openwrt/README.md · Keenetic: KEENETIC-DEPLOY.md |
| Android | qeli-android/README.md (in Russian) |
| Linux CLI | GETTING-STARTED §8.2 |
- ../../CHANGELOG.md — all changes by version.
- ../../release/RELEASE_NOTES_0.7.16.md — bilingual
0.7.16release-note draft, upgrade impact and remaining pre-release checks. - ../../SECURITY.md — security policy and reporting.
- ../../CONTRIBUTING.md — how to contribute.
- ../../release/docker/README.md — running the server in Docker.