RustProxy/docs/README.md

RustProxy documentation

Practical guides for RustProxy 0.34.10. 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.

Getting started

• Installation and updates — packages, build, first administrator, optional JSON/systemd permissions and updates.
• Container deployment — image, persistent state, ports and isolation.
• Settings and configuration — active SQLite/file storage source and which changes need restart.
• Troubleshooting — symptom-based checks and release validation.

Publishing services

• Vhosts and backends — domains, listener bindings, request Content-Type filtering, balancing, health and redirects.
• Custom locations — path routing, rewrites, local responses and error fallbacks.
• Access and authentication — ACL, country/DDNS, Basic Auth, Tinyauth and rate limits.
• Static Web Server — document roots, generated filesystem permission commands, downloads, rules, built-in error pages and file delivery.
• PHP-FPM — PHP service profiles, security and application examples.
• Cache — HOT/COLD storage, privacy, TTL and invalidation.
• Response delivery — compression, static transformations and response headers.
• HTTP transport — HTTPS/H2/H3, WebSockets, origin protocols and timeouts.
• Experimental TLS post-quantum key exchange — opt-in X25519MLKEM768, compatibility, rollback and validation.
• TCP/UDP Streams — non-HTTP forwarding and its security boundaries.

Integrations and operations

• Certificates and automatic renewal — PEM, automatic SNI names, path permission commands, HTTP-01, DNS-01, Certbot and external certificates.
• Docker discovery — optional Linux agent DEB/RPM or manual installation, TLS/token CLI, networking, generated Vhosts and their per-service live HTTP logs.
• Other integrations — Tinyauth, NPM migration, OPNsense and monitoring tools.
• Dashboard — metrics panels, HIT/MISS/BYPASS/OTHER request mix, presets, configuration history and applying stylesheet updates.
• Monitoring — Prometheus, full JSON and compact summary API, traffic, backend and cache observations.
• Logs — live logs, stored logs, error logs and searches.
• Backups and recovery — encrypted backups, restore and Secret Store.
• Migration — managed upgrades and Nginx Proxy Manager import.
• Security — important trust boundaries and limitations.
• Administration API and API access — endpoints, sessions and restricted certificate credentials.

Release information

Changelog tracks user/operator-visible technical changes; Roadmap 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.

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.