guard/docs
loki5512344 72c1f45d62
perf: criterion benchmarks for the per-connection hot path
- benches/hot_paths.rs measures RateLimiter::check, Blacklist exact/CIDR/miss
  lookups, SubnetDetector::evaluate over 256 prefixes and HTTP request-head
  validation; `cargo bench --all-features --bench hot_paths`, HTML report in
  target/criterion.
- Dev-machine medians recorded in docs/testing.md (~110 ns rate limit,
  ~70 ns exact ban lookup, ~220 ns CIDR lookup, ~2.6 us detector window,
  ~280 ns HTTP head).
- Makefile `bench` target; the bench is gated on protocol-http.
2026-11-16 12:55:51 +01:00
..
kb feat!: universal redesign — drop Minecraft stack, single-crate architecture 2026-08-24 01:50:22 +02:00
research feat(xdp): IPv6 UDP rate limit, working loader; English comments and docs 2026-11-15 23:50:52 +01:00
api.md feat(manager): SCAN inventory, pagination, request limits, graceful shutdown 2026-11-16 12:36:29 +01:00
configuration.md fix(edge): IPv6 bind, configurable relay idle, per-gateway budget, PROXY identity 2026-11-16 12:36:19 +01:00
deployment.md fix(core): close auth bypass, hangs and memory leaks found by review 2026-11-16 12:06:23 +01:00
disaster_recovery.md feat: sync edge autobans across nodes 2026-10-16 23:09:26 +02:00
minecraft-java.md docs: clarify private network deployment 2026-10-16 23:16:20 +02:00
README.md feat(xdp): IPv6 UDP rate limit, working loader; English comments and docs 2026-11-15 23:50:52 +01:00
runbook.md test: move the last inline test modules to tests/, document new signals 2026-11-16 12:36:29 +01:00
testing.md perf: criterion benchmarks for the per-connection hot path 2026-11-16 12:55:51 +01:00
troubleshooting.md test: move the last inline test modules to tests/, document new signals 2026-11-16 12:36:29 +01:00
vds_compatibility.md feat!: universal redesign — drop Minecraft stack, single-crate architecture 2026-08-24 01:50:22 +02:00

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

Индекс всей документации проекта и правила её ведения. Точка входа — README.md; текущий статус и планы — TODO.md.


1. С чего начать

Документ Когда читать
deployment.md Первый деплой edge-ноды и manager'а
configuration.md Настройка config.toml, секция [xdp], переменные manager'а
runbook.md Ежедневная эксплуатация и типовые операции

2. Эксплуатация (how-to)

Документ О чём
runbook.md Метрики, рестарты, снятие банов, аварийные процедуры
troubleshooting.md Диагностика типовых проблем
disaster_recovery.md Восстановление после отказа Redis/ноды
testing.md Гейты, тесты, XDP-smoke на реальном ядре

3. Справочник (reference)

Документ О чём
configuration.md Все поля конфига и значения по умолчанию
api.md HTTP API manager'а: аутентификация, эндпоинты
vds_compatibility.md Ограничения окружений и ядер

4. Протоколы

Документ О чём
minecraft-java.md Minecraft-edge: Paper, PROXY protocol, закрытый backend

5. Теория и исследования

Раздел О чём
kb/ База знаний: анатомия атак, уровни защиты, практика (двуязычная)
research/ Глубокие разборы: архитектура, eBPF, DDoS, Rust-производительность, конкуренты

kb/ отвечает на вопрос «как это работает и как защищаться», research/ — на вопрос «какое решение выбрать и почему». Статус проекта не живёт ни там, ни там — только в TODO.md.


6. Как вести документацию

  1. Язык. docs/ — русский. Исключение: docs/kb/, где статьи двуязычные (## English / ## Русский). Комментарии в коде — английский (TODO §0.8).
  2. Один документ = одна задача. How-to начинается с цели («что получится в конце»), содержит копируемые команды и заканчивается проверкой результата.
  3. Reference синхронизируется с кодом в том же PR. Меняешь поле конфига, флаг CLI или эндпоинт — правишь configuration.md / api.md там же. Расхождение = баг.
  4. Новый документ кладётся в подходящую категорию (2–4) и сразу добавляется в эту таблицу; если он является точкой входа — ссылка добавляется и в корневой README.
  5. Не размножай папки. Плоская структура docs/*.md — норма; подпапка нужна только для серии документов (kb/, research/).
  6. Имена файлов — kebab-case, .md, без дат в имени; дата и версия — внутри документа.
  7. Никаких битых ссылок. Перед коммитом: grep -o '](\.\?[^)]*)' docs/*.md и проверь, что цели существуют.