25 lines
2.3 KiB
Markdown
25 lines
2.3 KiB
Markdown
# Документация AWG2 Harness
|
|
|
|
Рекомендуемый порядок чтения:
|
|
|
|
1. [`../README.md`](../README.md) — общий runtime-план: SSH, официальная Amnezia, установка пакета, preflight, проверка перезагрузкой и CLI.
|
|
2. [`UPSTREAM_COMPATIBILITY.md`](UPSTREAM_COMPATIBILITY.md) — канонический контракт совместимости с AmneziaWG.
|
|
3. [`INSTALLATION.md`](INSTALLATION.md) — сжатый порядок установки на production.
|
|
4. [`CONFIGURATION.md`](CONFIGURATION.md) — параметры `/etc/awg2-harness/config.toml`.
|
|
5. [`ACCEPTANCE_CHECKLIST.md`](ACCEPTANCE_CHECKLIST.md) — чек-лист приёмки перед статусом production-ready.
|
|
6. [`ANTI_TORRENT.md`](ANTI_TORRENT.md) — ограничение числа соединений через nftables.
|
|
7. [`IMPLEMENTATION_SPEC.md`](IMPLEMENTATION_SPEC.md) — архитектура и reconciliation состояния.
|
|
|
|
Отдельно:
|
|
|
|
- [`../tools/README.md`](../tools/README.md) — сборка и упаковка `.deb`.
|
|
- [`../reboot_module/README.md`](../reboot_module/README.md) — внешний планировщик перезагрузки.
|
|
|
|
Практический порядок для оператора: сначала выполнить корневой README, затем свериться с чек-листом приёмки. Остальные документы нужны для понимания замысла и отладки.
|
|
|
|
## Язык документации
|
|
|
|
Проза — на русском. Английский остаётся там, где он технически обязателен: команды, вывод утилит, ключи конфигурации, имена файлов, модулей, таблиц nftables и handles `tc`. Термины, у которых нет устоявшегося русского эквивалента в этом контексте (`drift`, `reconcile`, `peer`, `namespace`, `handshake`), не переводятся.
|
|
|
|
`IMPLEMENTATION_SPEC.md` описывает фактическое состояние кода. Расхождение между ним и `traffic_core/src` считается дефектом документа, а не допустимым упрощением.
|