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.5 release audit - Cloudflare country analytics consistency, Revision History modal styling and release gates.
• 0.25.4 release audit - historical retained configuration restore, CAS/audit behavior and release gates.
• 0.25.3 release audit - historical request-method policy, location ACL/country controls, hashed request IDs and configuration-history scope.
• 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.
• 0.29.1 implementation note - internal error fallbacks, multipart byte ranges and PHP PATH_INFO.
• 0.29.0 implementation note - canonical host/custom-location redirects, health Host defaults, forced cache and gzip Stored Logs.
• 0.28.2 implementation note - external certificate ACL/path hardening and least-privilege Certificate API grants.
• 0.28.1 implementation note - external certificate paths, Certbot symlink reloads, backup semantics and certificate-source UX.
• 0.28.0 implementation note - manual/hot-reloaded GeoIP, listener status UX, cache Via/narrow invalidation and header-rule layout.
• 0.27.3 implementation note - HTTP/3 HEAD cache parity, COLD/rate-limit memory reduction, backup scope and package-path update.
• 0.27.2 implementation note - managed Certbot relocation/renewal repair.
• 0.27.1 implementation note - first-admin command, managed/fallback certificate runtime and account-scoped route-list sorting.
• 0.27.0 implementation note - compression defaults/scoped policy, persistent Docker publications and visible cache occupancy meter fill.
• 0.26.7 implementation note - HOT/COLD occupancy meters, backend rotation continuity and container Certbot packaging.
• 0.26.6 implementation note - composed ACL allow semantics, certificate-form reset, backend table preferences and NPM migration helper documentation.
• 0.26.5 implementation note - interface-scaled form/select alignment and corrected Streams listener navigation.
• 0.26.4 implementation note - 404 drafts, consistent modal controls, compact Overview settings and idle age-based backend rotation.
• 0.26.3 implementation note - global interface scaling, chart themes, square draft dock and Settings navigation polish.
• 0.26.2 implementation note - unified Logs navigation, field-query search, dynamic JSON columns and RAW parsing.
• 0.26.1 implementation note - historical vhost-aware protocol logging and Stored Logs UX milestone.
• 0.31.3 mobile session / invalid-Origin recovery - deterministic BFCache and visibility session coordination, 403 diagnostics, recovery and remaining acceptance.
• 0.31.1 mobile panel bootstrap - panel script readiness, versioned assets, failure recovery and acceptance tests.
• 0.31.0 security audit - current API/panel/BAN/PURGE attack-surface review, hardening and remaining runtime verification.
• 0.31.0 implementation report - consolidated changes, exact file inventory, validation results and outstanding Rust runtime acceptance.
• 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.
• PHP_FPM_ISOLATION - separate PHP-FPM pools to prevent cross-vhost INI settings leakage.
• 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, FILE_LOGS and ERROR_LOGGING - independent in-memory live request viewing, bounded on-disk log exploration, protocol-error persistence and optional error-file logging.

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.
• MEMORY_STRESS - sustained-memory audit, offline load simulations, real RustProxy staging stress and RSS measurement procedure.

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. The current release implementation note is IMPLEMENTATION_0.31.3.md; IMPLEMENTATION_0.31.1.md is retained as the prior mobile milestone; IMPLEMENTATION_0.31.0.md is retained as the previous milestone; V0.29.1_IMPLEMENTATION.md is retained as historical context, and V0.29.0_IMPLEMENTATION.md is retained as the prior redirect/health/cache/log milestone; V0.28.2_IMPLEMENTATION.md is retained as the prior certificate-hardening milestone; V0.28.1_IMPLEMENTATION.md is retained as the prior external-path milestone; V0.28.0_IMPLEMENTATION.md is retained as the prior GeoIP/listener/cache milestone, and V0.27.3_IMPLEMENTATION.md is retained as the prior HTTP/3/cache-maintenance milestone, V0.27.2_IMPLEMENTATION.md is retained as the prior managed-ACME repair, V0.27.1_IMPLEMENTATION.md as the prior managed-runtime/list-sorting milestone, and older version notes remain historical evidence. The latest retained audit is V0.25.5_AUDIT.md; older audit files remain available for traceability.

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 the current release scope 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.