README
¶
roxy
Roxy the Frontend Proxy
Our mascot, Roxy Lalonde.
Roxy is an Internet-facing frontend proxy which provides the following features:
- Automatically obtains TLS certificates from Let's Encrypt; no need to manage certificates manually or to install and configure Certbot
- Able to inject and rewrite headers in the incoming request, before your application sees them
- Able to inject and rewrite headers in the outgoing response, allowing you to centrally control your Internet-visible server headers
- Comprehensive request logging in JSON Lines format
- Can serve static files directly, without need for nginx, lighttpd, etc.
See our GitHub Pages site for more documentation.
Documentation
¶
Overview ¶
Command "roxy" is an Internet-facing HTTPS frontend proxy that uses ACME (Let's Encrypt et al.) to obtain TLS certificates.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
atc
Command "atc" is the Roxy Air Traffic Controller, a piece of software which provides load-balanced routing of requests from ATC-aware clients to ATC-aware servers.
|
Command "atc" is the Roxy Air Traffic Controller, a piece of software which provides load-balanced routing of requests from ATC-aware clients to ATC-aware servers. |
|
atcctl
Command "atcctl" is the admin CLI for "atc".
|
Command "atcctl" is the admin CLI for "atc". |
|
colorize-logs
Command "colorize-logs" is a small command line tool that allows pretty-printing log files in JSON Lines format, with basic support for "tail -f" operation.
|
Command "colorize-logs" is a small command line tool that allows pretty-printing log files in JSON Lines format, with basic support for "tail -f" operation. |
|
demo-backend
Command "demo-backend" is a demonstration of a server which uses the Roxy libraries "membership", "announce", and "mainutil", and which serves web content via both HTTP(S) and gRPC.
|
Command "demo-backend" is a demonstration of a server which uses the Roxy libraries "membership", "announce", and "mainutil", and which serves web content via both HTTP(S) and gRPC. |
|
roxyctl
Command "roxyctl" is the admin CLI for "roxy".
|
Command "roxyctl" is the admin CLI for "roxy". |
|
zkcp
Command "zkcp" is a small command line tool for copying files between ZooKeeper and the local filesystem.
|
Command "zkcp" is a small command line tool for copying files between ZooKeeper and the local filesystem. |
|
Package dist contains embedded copies of files distributed with Roxy.
|
Package dist contains embedded copies of files distributed with Roxy. |
|
internal
|
|
|
lib
|
|
|
announcer
Package announcer encapsulates the idea of a server that dynamically advertises its presence to clients through various media.
|
Package announcer encapsulates the idea of a server that dynamically advertises its presence to clients through various media. |
|
atcclient
Package atcclient implements a client for the Roxy Air Traffic Control protocol.
|
Package atcclient implements a client for the Roxy Air Traffic Control protocol. |
|
expbackoff
Package expbackoff provides an implementation of exponential backoff, useful for preventing client retries from overloading a recovering server.
|
Package expbackoff provides an implementation of exponential backoff, useful for preventing client retries from overloading a recovering server. |
|
mainutil
Package mainutil provides miscellaneous tools for implementing the main() function of long-lived HTTP and gRPC servers.
|
Package mainutil provides miscellaneous tools for implementing the main() function of long-lived HTTP and gRPC servers. |
|
membership
Package membership provides Go types for dealing with various data formats used to advertise a server's presence using services like ZooKeeper or Etcd.
|
Package membership provides Go types for dealing with various data formats used to advertise a server's presence using services like ZooKeeper or Etcd. |
|
roxyresolver
Package roxyresolver provides advanced implementations of gRPC-compatible address resolution strategies.
|
Package roxyresolver provides advanced implementations of gRPC-compatible address resolution strategies. |
|
roxyutil
Package roxyutil provides miscellaneous utility functions for use by Roxy and by users of mainutil.
|
Package roxyutil provides miscellaneous utility functions for use by Roxy and by users of mainutil. |
|
syncrand
Package syncrand provides synchronized (thread-safe) wrappers of "math/rand".Source64 and "math/rand".Rand.
|
Package syncrand provides synchronized (thread-safe) wrappers of "math/rand".Source64 and "math/rand".Rand. |
Click to show internal directories.
Click to hide internal directories.