v0.34.0_fina;

docs/README.md

@@ -1,76 +1,41 @@
-# RustProxy documentation index
+# RustProxy documentation
 
-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.
+Practical guides for **RustProxy 0.34.0**. This index and the listed pages are also available in the authenticated panel at **`/docs → Reader`**. The adjacent **API** tab provides the embedded OpenAPI reference. Paths below are links to actual files in the source archive.
 
-## Project and release
+## Getting started
 
-- [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.
+- [Installation and updates](INSTALL.md) — packages, build, first administrator, systemd and updates.
+- [Container deployment](CONTAINER.md) — image, persistent state, ports and isolation.
+- [Settings and configuration](CONFIGURATION.md) — what to configure and which changes need restart.
+- [Troubleshooting](TROUBLESHOOTING.md) — symptom-based checks and release validation.
 
-## Functional documentation
+## Publishing services
 
-- [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.
+- [Vhosts and backends](VHOSTS.md) — domains, listener bindings, balancing, health and redirects.
+- [Custom locations](CUSTOM_LOCATIONS.md) — path routing, rewrites, local responses and error fallbacks.
+- [Access and authentication](ACCESS.md) — ACL, country/DDNS, Basic Auth, Tinyauth and rate limits.
+- [Static Web Server](WEB_SERVER.md) — document roots, downloads, rules and file delivery.
+- [PHP-FPM](PHP_FPM.md) — PHP service profiles, security and application examples.
+- [Cache](CACHE.md) — HOT/COLD storage, privacy, TTL and invalidation.
+- [Response delivery](RESPONSE_DELIVERY.md) — compression, static transformations and response headers.
+- [HTTP transport](TRANSPORT.md) — HTTPS/H2/H3, WebSockets, origin protocols and timeouts.
+- [TCP/UDP Streams](STREAMS.md) — non-HTTP forwarding and its security boundaries.
 
-## Administration and operations
+## Integrations 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.
+- [Certificates and automatic renewal](ACME_PROVIDERS.md) — PEM, HTTP-01, DNS-01, Certbot and external certificates.
+- [Docker discovery](DOCKER_DISCOVERY.md) — agent installation, networking and generated Vhosts.
+- [Other integrations](INTEGRATIONS.md) — Tinyauth, NPM migration, OPNsense and monitoring tools.
+- [Dashboard](DASHBOARD.md) — metrics panels, presets and configuration history.
+- [Monitoring](MONITORING.md) — Prometheus, traffic, backend and cache observations.
+- [Logs](LOGS.md) — live logs, stored logs, error logs and searches.
+- [Backups and recovery](BACKUP.md) — encrypted backups, restore and Secret Store.
+- [Migration](MIGRATION.md) — managed upgrades and Nginx Proxy Manager import.
+- [Security](SECURITY.md) — important trust boundaries and limitations.
+- [Administration API](API.md) and [API access](API_ACCESS.md) — endpoints, sessions and restricted certificate credentials.
 
-## Development and testing
+## Release information
 
-- [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.
+[Changelog](../CHANGELOG.md) tracks user/operator-visible technical changes; [Roadmap](../ROADMAP.md) separates current verification work from future ideas. Historical low-level investigations, audits and benchmarks are not part of the live Reader. Keep them separately if you need an audit trail.
 
-## 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) - security audit material.
-- [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 and unresolved work in `ROADMAP.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.
+When changing functionality, update the appropriate guide, this index, the registered Reader documents and any OpenAPI/schema references together. Describe actual code behavior, not unimplemented plans.