78 lines
5.0 KiB
Markdown
78 lines
5.0 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.
|
|
|
|
## 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.
|
|
- [PHP_FPM_ISOLATION](PHP_FPM_ISOLATION.md) - separate PHP-FPM pools to prevent cross-vhost INI settings leakage.
|
|
- [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.
|
|
- [MEMORY_STRESS](MEMORY_STRESS.md) - sustained-memory audit, offline load simulations, real RustProxy staging stress and RSS measurement procedure.
|
|
|
|
## 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.
|
|
|
|
|
|
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 the current release scope and future direction.
|
|
|
|
## Historical or version-labelled context
|
|
|
|
### Retained audits and historical context
|
|
|
|
- [SECURITY_AUDIT](SECURITY_AUDIT.md) and [SECURITY_AUDIT_0.31.0](SECURITY_AUDIT_0.31.0.md) - current security audit material and the 0.31.0 audit.
|
|
- [CHANGELOG_TECHNICAL_ARCHIVE](CHANGELOG_TECHNICAL_ARCHIVE.md) and [ROADMAP_HISTORY](ROADMAP_HISTORY.md) - retained long-form technical history and completed milestones.
|
|
- [ACME_RFC2136](ACME_RFC2136.md) - historical DNS provider details.
|
|
- [INTEGRATIONS_040](INTEGRATIONS_040.md) and [MANAGEMENT](MANAGEMENT.md) - retained design and integration notes.
|
|
- [TEST_REPORT](TEST_REPORT.md) - verification history and release gates.
|
|
|
|
The old per-version implementation notes and audits removed from this trimmed source archive are no longer required to build the application or use the documentation Reader. Only registered documents are embedded at compile time.
|
|
|
|
## 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.
|