Tutorials

Each page here is a walkthrough. Follow it from the top and you get a working setup. The other pages of this site are references: they describe every field and every behavior, but they do not build anything.

• Installing on a Linux Server: install.sh and the systemd service.
• Installing with Docker: one container with two volumes.
• Getting Started: the first admin account, the first port and the first proxy.
• High Availability: three nodes with a shared state in etcd or Consul, behind a load balancer.
• Proxies from Docker: proxies built from the labels of your containers.
• HTTPS with a Wildcard Certificate: a DNS-01 wildcard certificate, the HTTPS redirect and HSTS.
• Protecting an Application: access list, authentication, rate limit and audit log.
• Caching and Compression: responses from memory and smaller bodies.
• TCP and UDP Proxies: a database, a DNS server and mutual TLS.
• r3v3rs3 on Kubernetes: the ingress controller, Ingress resources and the R3v3rs3Proxy custom resource.
• Load Balancing and Health Checks: weights, health checks, retries, sticky sessions, WebSocket and gRPC.
• Driving r3v3rs3 from a Script: the admin API, a deploy job and an account for it.
• Proxies from Consul and etcd: the catalog, the key-value store and etcd keys.
• Accounts for a Team: roles, proxy lists, TOTP and the audit log.
• Single Sign-On with Forward Auth: oauth2-proxy in front, the user in the upstream request.
• Migrating from nginx or Traefik: the equivalents of each directive and the cutover order.