RustProxy/docs

RustProxy documentation index

This is the canonical index for the current project documentation. The authenticated administration documentation page at /docs embeds these Markdown files in its Reader tab and keeps OpenAPI/Swagger in a separate API tab.

Project and release

• Project README - product overview, installation entry points and current release notes.
• ROADMAP - planned and completed release scope.
• CHANGELOG - user/operator-visible changes by release.
• TODO - open work only; completed work is not retained as TODO.
• 0.25.3 release audit - request-method policy, location ACL/country controls, hashed request IDs and configuration-history scope plus release gates.
• 0.25.2 release audit - historical live backup, internal symlink and resumed-origin recovery scope.
• 0.25.1 release audit - historical Traffic/module-split release scope and compiler-regression guards.
• 0.25.0 specification audit - Web Server foundation point-by-point implementation status.
• 0.25.0 pre-production security audit - threat-oriented source/configuration review, fixes made in-session and mandatory runtime security gates.
• TEST_REPORT - verification commands, results and environment limitations.

Functional documentation

• WEB_SERVER - reusable Web Services, static-file behavior, ranges/validators and document-root security.
• PHP_FPM - implemented FastCGI/PHP-FPM integration, security model and runtime requirements.
• VHOSTS - vhosts and backend/source behavior.
• CUSTOM_LOCATIONS - location matching, rewrites and local responses.
• VHOST_ACCESS - access rules applied to vhosts and locations.
• CACHE - cache behavior and policy.
• TRANSFORM - response transformation.
• STREAMS - stream proxying.
• REDIRECTS - redirect hosts and rules.
• NOT_FOUND_HOSTS - local 404 host handling.
• DOCKER_DISCOVERY - Docker discovery and generated vhosts.
• ACME_PROVIDERS and RENEWAL - certificate automation.
• LIVE_LOGS and ERROR_LOGGING - request/error observability, User-Agent/optional-country capture and bounded per-vhost Traffic analytics.

Administration and operations

• INSTALL - installation and managed updates.
• SETTINGS - listeners, administration and response defaults.
• API - administration API overview.
• API_ACCESS - API authentication, CSRF and /docs security model.
• SECRET_STORE_BACKUP - encrypted secret storage and backup/restore.
• PROMETHEUS - monitoring endpoint and metrics.
• CONTAINER - container deployment.
• NPM_MIGRATION and MIGRATION - migration tooling and historical migration notes.

Development and testing

• MOCK_SERVER - local Python mock origin used by development/integration checks.
• MOCK_AUTH - local fake Tinyauth peer for development only.

Technical documentation

• ARCHITECTURE - process and request architecture.
• SECURITY - current security model and limitations.
• HTTP3 - HTTP/3 transport behavior.
• TRANSPORT - transport background/contract notes.
• CACHE_DIAGNOSTICS - cache diagnostics and interpretation.
• REFERENCES - implementation references.

Historical or version-labelled context

Version-labelled V*.md files are retained as historical implementation/audit records. Their version number describes the audited milestone; they are not current-release documentation. The current audit is V0.25.3_AUDIT.md; V0.25.2_AUDIT.md records the prior backup/session hardening milestone and V0.25.1_AUDIT.md records the prior Traffic/module-split milestone and V0.25.0_AUDIT.md remains the Web Server foundation audit.

Older context documents such as INTEGRATIONS_040, MANAGEMENT, SECURITY_AUDIT, ACME_RFC2136 and older version audits remain available for traceability but should not override the current functional/technical documents above.

The pre-cleanup developer-level changelog is retained as CHANGELOG_TECHNICAL_ARCHIVE when low-level historical detail is needed. The root CHANGELOG.md remains the operator-facing release record. Completed roadmap history is retained separately as ROADMAP_HISTORY; the root ROADMAP.md contains only the active 0.25 milestone, release gate and future direction.

Maintenance rules

• Put user/operator-visible release changes in CHANGELOG.md.
• Put future release scope in ROADMAP.md and unresolved work in docs/TODO.md.
• Keep detailed implementation evidence in technical documents or version audits, not in CHANGELOG.
• When functionality changes, update the functional document, this index, Reader coverage and cross-links in the same change.
• Remove obsolete or duplicated documents when they no longer provide historical or technical value; retain useful audits with an explicit historical label.