Документация Хражевника
Каталог содержит функциональную документацию Хражевника на русском
языке. Обзор системы и инструкция по первоначальному запуску — в
корневом README.md; вопросы, требующие отдельного рассмотрения,
документированы здесь.
| Файл | Содержание |
|---|---|
| quickstart.md | Быстрый старт: установка контейнера, bootstrap, первый remote, проверка кеша. |
| config.md | Конфигурация: все секции TOML, env KHRZ_*, секреты file://, валидация, прокси upstream (HTTP/HTTPS/SOCKS5). |
| api.md | REST API админки: аутентификация, эндпоинты, коды ошибок. |
| ui.md | Веб-админка: экраны и типовые операции. |
| deploy.md | Развёртывание: quadlet, docker, bootstrap, настройка клиентов, сборка образа. |
| reverse-proxy.md | Реверс-прокси: Caddy/Traefik/nginx, TLS, trusted_proxies. |
| storage-db.md | Хранилище объектов (fs/S3) и каталог (sqlite/postgres/mariadb): выбор и переключение. |
| personal-repos.md | Личные репозитории: upload, подпись, настройка клиентов по экосистемам. |
| ecosystems/ | Клиенты экосистем: apt, rpm-md, pacman, apk, nix. |
Английская документация — в docs/func/EN/.
Внутренняя документация разработки — в docs/:
ARCHITECTURE.md (слои и правила импортов), SPECIFICATION.md (полные
требования и схемы), TESTING.md (стратегия тестирования),
ROADMAP.md (путеводитель планов), HISTORY.md (история этапов).