50 lines
3.9 KiB
Markdown
50 lines
3.9 KiB
Markdown
# RustProxy 0.34.0
|
|
|
|
RustProxy combines a reverse proxy, static/PHP web server, certificate management and traffic monitoring in one service with a browser administration panel. It supports several domains and backends without requiring a separate proxy configuration language.
|
|
|
|
## Main capabilities
|
|
|
|
| Area | Available features |
|
|
|---|---|
|
|
| Reverse proxy | HTTP/HTTPS origins, HTTP/1.1 and HTTP/2 upstream modes, health checks, load balancing, connection reuse, WebSockets, path-based routing, retries and error fallbacks |
|
|
| Frontends | HTTP, HTTPS, HTTP/2, optional HTTP/3 (QUIC), named listeners, domain and wildcard routing, redirects, TLS certificates |
|
|
| Web Server | Static content, downloads, directory/index policy, rewrite and `try_files`, selected `.htaccess` rules, optional PHP-FPM, application presets |
|
|
| Access | IP/CIDR and DNS/DDNS rules, country restrictions, reusable ACLs, rate limits, method rules, Basic Auth, Tinyauth, security headers |
|
|
| Delivery | Optional shared HOT/RAM and COLD/disk cache, cache invalidation, compression, response transformations, static-file optimizations |
|
|
| Integrations | Docker discovery via separate agents, TCP/UDP Streams, ACME certificate providers, Prometheus, Grafana/Nagios examples and administration API |
|
|
| Operations | Dashboard presets, traffic analytics, live/stored logs, configuration history, encrypted backups and certificate reloads |
|
|
|
|
Features and default settings vary by component; configure only the capabilities you need. The [documentation index](docs/README.md) covers each workflow, including prerequisites, security boundaries, troubleshooting and API access.
|
|
|
|
## Installation
|
|
|
|
Use the maintained packages where available:
|
|
|
|
- Linux DEB/RPM: https://rustproxy.linuxiarz.pl/
|
|
- OPNsense: https://rustproxy-opn.linuxiarz.pl/
|
|
|
|
For Debian 13+ source installation, manual compilation, managed updates or Docker, see [Installation and updates](docs/INSTALL.md).
|
|
|
|
Typical managed Linux defaults: HTTP on `:80`, HTTPS on `:443`, local administration at `http://127.0.0.1:9090`, private data in `/var/lib/rustproxy`. The initial public certificate is self-signed. **There is no default administrator password.** Initialize administration locally and assign trusted certificates before public use.
|
|
|
|
## First configuration
|
|
|
|
1. Install and start the service, then initialize the administrator using the local CLI.
|
|
2. Open the panel and review **Settings → Listeners**, administration access and certificates.
|
|
3. Create a **Vhost** with a domain name and a reachable HTTP backend or **Web Service**.
|
|
4. Confirm frontend TLS, backend health, access permissions and routing.
|
|
5. Enable additional cache, compression, Docker or monitoring functions as needed; inspect **Overview**, **Logs** and **Cache** for results.
|
|
|
|
## Guides
|
|
|
|
- [Installation](docs/INSTALL.md) · [Settings](docs/CONFIGURATION.md) · [Vhosts](docs/VHOSTS.md) · [Web Server](docs/WEB_SERVER.md) · [PHP-FPM](docs/PHP_FPM.md)
|
|
- [Certificates](docs/ACME_PROVIDERS.md) · [Cache](docs/CACHE.md) · [Response delivery](docs/RESPONSE_DELIVERY.md) · [Docker discovery](docs/DOCKER_DISCOVERY.md) · [Monitoring](docs/MONITORING.md)
|
|
- [Security](docs/SECURITY.md) · [API](docs/API.md) · [Troubleshooting](docs/TROUBLESHOOTING.md)
|
|
- [Changelog](CHANGELOG.md) · [Roadmap](ROADMAP.md)
|
|
|
|
The authenticated **`/docs`** page includes the guides and a separate interactive **OpenAPI/Swagger** tab.
|
|
|
|
## Status of this source archive
|
|
|
|
This archive is **source code, not a production-tested executable**. Some 0.34.0 changes, particularly proxy-path and caching optimizations, have not completed compilation, full regression testing or controlled performance measurements in the supplied evidence. Feature descriptions reflect the included code and settings; they do not constitute a runtime acceptance certificate. Validate the exact build and your TLS, routing, access, cache, logging and backup/restore setup before deployment. No measured throughput increase is claimed for 0.34.0.
|