Files
AWG2_harness/docs/README.md
T

2.5 KiB

Документация AWG2 Harness

Рекомендуемый порядок чтения:

  1. ../README.md — общий runtime-план: SSH, официальная Amnezia, установка пакета, preflight, проверка перезагрузкой и CLI.
  2. UPSTREAM_COMPATIBILITY.md — канонический контракт совместимости с AmneziaWG.
  3. INSTALLATION.md — сжатый порядок установки на production.
  4. CONFIGURATION.md — параметры /etc/awg2-harness/config.toml.
  5. ACCEPTANCE_CHECKLIST.md — чек-лист приёмки перед статусом production-ready.
  6. VALIDATION_0.3.1.md — фактически выполненные Debian 13 build/package/runtime-проверки версии 0.3.1 и их ограничения.
  7. ANTI_TORRENT.md — ограничение числа соединений через nftables.
  8. IMPLEMENTATION_SPEC.md — архитектура и reconciliation состояния.

Отдельно:

Практический порядок для оператора: сначала выполнить корневой README, затем свериться с чек-листом приёмки. Остальные документы нужны для понимания замысла и отладки.

Язык документации

Проза — на русском. Английский остаётся там, где он технически обязателен: команды, вывод утилит, ключи конфигурации, имена файлов, модулей, таблиц nftables и handles tc. Термины, у которых нет устоявшегося русского эквивалента в этом контексте (drift, reconcile, peer, namespace, handshake), не переводятся.

IMPLEMENTATION_SPEC.md описывает фактическое состояние кода. Расхождение между ним и traffic_core/src считается дефектом документа, а не допустимым упрощением.