81 lines
6.5 KiB
Markdown
81 lines
6.5 KiB
Markdown
# 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](../README.md) - product overview, installation entry points and current release notes.
|
|
- [ROADMAP](../ROADMAP.md) - planned and completed release scope.
|
|
- [CHANGELOG](../CHANGELOG.md) - user/operator-visible changes by release.
|
|
- [TODO](TODO.md) - open work only; completed work is not retained as TODO.
|
|
- [0.25.5 release audit](V0.25.5_AUDIT.md) - Cloudflare country analytics consistency, Revision History modal styling and release gates.
|
|
- [0.25.4 release audit](V0.25.4_AUDIT.md) - historical retained configuration restore, CAS/audit behavior and release gates.
|
|
- [0.25.3 release audit](V0.25.3_AUDIT.md) - historical request-method policy, location ACL/country controls, hashed request IDs and configuration-history scope.
|
|
- [0.25.2 release audit](V0.25.2_AUDIT.md) - historical live backup, internal symlink and resumed-origin recovery scope.
|
|
- [0.25.1 release audit](V0.25.1_AUDIT.md) - historical Traffic/module-split release scope and compiler-regression guards.
|
|
- [0.25.0 specification audit](V0.25.0_AUDIT.md) - Web Server foundation point-by-point implementation status.
|
|
- [0.25.0 pre-production security audit](V0.25.0_SECURITY_PREPROD_AUDIT.md) - threat-oriented source/configuration review, fixes made in-session and mandatory runtime security gates.
|
|
- [0.26.4 implementation note](V0.26.4_IMPLEMENTATION.md) - 404 drafts, consistent modal controls, compact Overview settings and idle age-based backend rotation.
|
|
- [0.26.3 implementation note](V0.26.3_IMPLEMENTATION.md) - global interface scaling, chart themes, square draft dock and Settings navigation polish.
|
|
- [0.26.2 implementation note](V0.26.2_IMPLEMENTATION.md) - unified Logs navigation, field-query search, dynamic JSON columns and RAW parsing.
|
|
- [0.26.1 implementation note](V0.26.1_IMPLEMENTATION.md) - historical vhost-aware protocol logging and Stored Logs UX milestone.
|
|
- [TEST_REPORT](TEST_REPORT.md) - verification commands, results and environment limitations.
|
|
|
|
## Functional documentation
|
|
|
|
- [WEB_SERVER](WEB_SERVER.md) - reusable Web Services, static-file behavior, ranges/validators and document-root security.
|
|
- [PHP_FPM](PHP_FPM.md) - implemented FastCGI/PHP-FPM integration, security model and runtime requirements.
|
|
- [VHOSTS](VHOSTS.md) - vhosts and backend/source behavior.
|
|
- [CUSTOM_LOCATIONS](CUSTOM_LOCATIONS.md) - location matching, rewrites and local responses.
|
|
- [VHOST_ACCESS](VHOST_ACCESS.md) - access rules applied to vhosts and locations.
|
|
- [CACHE](CACHE.md) - cache behavior and policy.
|
|
- [TRANSFORM](TRANSFORM.md) - response transformation.
|
|
- [STREAMS](STREAMS.md) - stream proxying.
|
|
- [REDIRECTS](REDIRECTS.md) - redirect hosts and rules.
|
|
- [NOT_FOUND_HOSTS](NOT_FOUND_HOSTS.md) - local 404 host handling.
|
|
- [DOCKER_DISCOVERY](DOCKER_DISCOVERY.md) - Docker discovery and generated vhosts.
|
|
- [ACME_PROVIDERS](ACME_PROVIDERS.md) and [RENEWAL](RENEWAL.md) - certificate automation.
|
|
- [LIVE_LOGS](LIVE_LOGS.md), [FILE_LOGS](FILE_LOGS.md) and [ERROR_LOGGING](ERROR_LOGGING.md) - independent in-memory live request viewing, bounded on-disk log exploration, protocol-error persistence and optional error-file logging.
|
|
|
|
## Administration and operations
|
|
|
|
- [INSTALL](INSTALL.md) - installation and managed updates.
|
|
- [SETTINGS](SETTINGS.md) - listeners, administration and response defaults.
|
|
- [API](API.md) - administration API overview.
|
|
- [API_ACCESS](API_ACCESS.md) - API authentication, CSRF and `/docs` security model.
|
|
- [SECRET_STORE_BACKUP](SECRET_STORE_BACKUP.md) - encrypted secret storage and backup/restore.
|
|
- [PROMETHEUS](PROMETHEUS.md) - monitoring endpoint and metrics.
|
|
- [CONTAINER](CONTAINER.md) - container deployment.
|
|
- [NPM_MIGRATION](NPM_MIGRATION.md) and [MIGRATION](MIGRATION.md) - migration tooling and historical migration notes.
|
|
|
|
## Development and testing
|
|
|
|
- [MOCK_SERVER](MOCK_SERVER.md) - local Python mock origin used by development/integration checks.
|
|
- [MOCK_AUTH](MOCK_AUTH.md) - local fake Tinyauth peer for development only.
|
|
|
|
## Technical documentation
|
|
|
|
- [ARCHITECTURE](ARCHITECTURE.md) - process and request architecture.
|
|
- [SECURITY](SECURITY.md) - current security model and limitations.
|
|
- [HTTP3](HTTP3.md) - HTTP/3 transport behavior.
|
|
- [TRANSPORT](TRANSPORT.md) - transport background/contract notes.
|
|
- [CACHE_DIAGNOSTICS](CACHE_DIAGNOSTICS.md) - cache diagnostics and interpretation.
|
|
- [REFERENCES](REFERENCES.md) - 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 [V0.26.4_IMPLEMENTATION.md](V0.26.4_IMPLEMENTATION.md); [V0.26.3_IMPLEMENTATION.md](V0.26.3_IMPLEMENTATION.md) is retained as the prior appearance/UI milestone, [V0.26.2_IMPLEMENTATION.md](V0.26.2_IMPLEMENTATION.md) as the prior Logs/UI milestone and [V0.26.1_IMPLEMENTATION.md](V0.26.1_IMPLEMENTATION.md) as the prior protocol-attribution milestone. The latest retained audit is [V0.25.5_AUDIT.md](V0.25.5_AUDIT.md); older audit files remain historical evidence.
|
|
|
|
Older context documents such as [INTEGRATIONS_040](INTEGRATIONS_040.md), [MANAGEMENT](MANAGEMENT.md), [SECURITY_AUDIT](SECURITY_AUDIT.md), [ACME_RFC2136](ACME_RFC2136.md) 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](CHANGELOG_TECHNICAL_ARCHIVE.md) 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](ROADMAP_HISTORY.md); 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.
|