Khrazhevnik Documentation
This directory contains Khrazhevnik functional documentation in English.
The root README.en.md provides a system overview and initial setup
instructions; details requiring separate treatment are documented here.
| File | Contents |
|---|---|
| quickstart.md | Quick start: container installation, bootstrap, the first remote, cache verification. |
| config.md | Configuration: all TOML sections, the KHRZ_* env, file:// secrets, validation. |
| api.md | Admin REST API: authentication, endpoints, error codes. |
| ui.md | Web admin UI: screens and typical operations. |
| deploy.md | Deployment: the quadlet, docker, bootstrap, client setup, image build. |
| reverse-proxy.md | Reverse proxy: Caddy/Traefik/nginx, TLS, trusted_proxies. |
| storage-db.md | Object storage (fs/S3) and the catalog (sqlite/postgres/mariadb): selection and switching. |
| personal-repos.md | Personal repositories: upload, signing, client setup per ecosystem. |
| ecosystems/ | Ecosystem clients: apt, rpm-md, pacman, apk, nix. |
The Russian documentation is in docs/func/ru/.
Internal development documentation is in docs/:
ARCHITECTURE.md (layers and import rules), SPECIFICATION.md (full
requirements and schemas), TESTING.md (testing strategy),
ROADMAP.md (stage history).