43 lines
3.4 KiB
Markdown
43 lines
3.4 KiB
Markdown
# RustProxy documentation
|
|
|
|
Practical guides for **RustProxy 0.34.9**. 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](INSTALL.md) — packages, build, first administrator, optional JSON/systemd permissions and updates.
|
|
- [Container deployment](CONTAINER.md) — image, persistent state, ports and isolation.
|
|
- [Settings and configuration](CONFIGURATION.md) — active SQLite/file storage source and which changes need restart.
|
|
- [Troubleshooting](TROUBLESHOOTING.md) — symptom-based checks and release validation.
|
|
|
|
## Publishing services
|
|
|
|
- [Vhosts and backends](VHOSTS.md) — domains, listener bindings, request Content-Type filtering, 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, built-in error pages 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.
|
|
- [Experimental TLS post-quantum key exchange](TLS_POST_QUANTUM.md) — opt-in X25519MLKEM768, compatibility, rollback and validation.
|
|
- [TCP/UDP Streams](STREAMS.md) — non-HTTP forwarding and its security boundaries.
|
|
|
|
## Integrations and operations
|
|
|
|
- [Certificates and automatic renewal](ACME_PROVIDERS.md) — PEM, HTTP-01, DNS-01, Certbot and external certificates.
|
|
- [Docker discovery](DOCKER_DISCOVERY.md) — optional Linux agent DEB/RPM or manual installation, TLS/token CLI, networking, generated Vhosts and their per-service live HTTP logs.
|
|
- [Other integrations](INTEGRATIONS.md) — Tinyauth, NPM migration, OPNsense and monitoring tools.
|
|
- [Dashboard](DASHBOARD.md) — metrics panels, HIT/MISS/BYPASS/OTHER request mix, presets, configuration history and applying stylesheet updates.
|
|
- [Monitoring](MONITORING.md) — Prometheus, full JSON and compact `summary` API, 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.
|
|
|
|
## Release information
|
|
|
|
[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.
|
|
|
|
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.
|