RustProxy documentation
Guides for operating RustProxy: installation, publishing services, security, certificates, monitoring and automation. The same pages are available in the administration panel under /docs → Reader, next to the interactive API reference.
- Project website and packages: rustproxy.linuxiarz.pl
- Source code: git.linuxiarz.pl/gru/RustProxy
- License: GNU AGPL v3.0 or later
Overview
- Feature list — everything RustProxy can do, grouped by area.
- Screenshots — a tour of the administration panel.
- Performance — benchmark method, comparison with Nginx and tuning.
Getting started
- Installation and updates — packages, source build, Docker image, first administrator, systemd and updates.
- Configuration — SQLite or JSON configuration source, configuration map and changes that need a restart.
- Troubleshooting — symptom-based checks and a rollout checklist.
Publishing services
- Vhosts and backends — domains, listeners, backends, balancing, health checks and redirects.
- Custom locations — path routing, rewrites, local responses and error fallbacks.
- Web Server — static sites, downloads,
try_files, rewrites,.htaccesssubset and error pages. - PHP-FPM — PHP profiles, pool isolation and application examples.
- HTTP transport and TLS — HTTPS, HTTP/2, HTTP/3, WebSockets, backend protocols and post-quantum key exchange.
- TCP/UDP Streams — non-HTTP forwarding.
Security and access
- Access and authentication — ACLs, countries, rate limits, Basic Auth, Forward Auth and OIDC.
- Certificates — PEM import, ACME HTTP-01/DNS-01, external Certbot files and automatic renewal.
- Security model — trust boundaries and deployment recommendations.
Performance and delivery
- Cache — HOT (memory) and COLD (disk) cache, freshness,
Cache-Statusand invalidation. - Response delivery — compression, transformations and response headers.
Operations
- Dashboard — Overview cards, layouts, presets and configuration history.
- Monitoring — Prometheus exporter, JSON metrics, Grafana and Nagios.
- Logs — live, stored and error logs.
- Backup and recovery — encrypted backups, restore and the Secret Store.
- Migration — upgrades and Nginx Proxy Manager import.
- Docker discovery — Docker agent and generated Vhosts.
- Administration API — authentication, tokens, endpoints, lightweight polling views and configuration sections.
Integrations
| Integration | Purpose | Guide |
|---|---|---|
| Docker agent | Discover containers on Docker hosts and publish them as Vhosts | Docker discovery |
| Tinyauth, Authelia, authentik | Forward Auth for selected Vhosts | Access |
| OIDC (Authelia, authentik, Pocket ID, others) | Central login across unrelated domains | Access |
| ACME / Certbot | Certificates via HTTP-01 or DNS-01 (Cloudflare, OVH, RFC 2136) | Certificates |
| Prometheus and Grafana | Metrics scraping and a ready dashboard | Monitoring |
| Nagios | Service checks for API, backends, latency and queues | Monitoring |
| Nginx Proxy Manager | Import of existing proxy hosts | Migration |
| OPNsense | Certificate deployment from the os-acme-client plugin | integrations/opnsense-acme/README.md |
| MikroTik RouterOS | OCI image build for RouterOS containers | integrations/routeros-oci-build/README.md |
Release notes
See the changelog.