ROUTED(1)

NAME
routed - TLS termination and reverse reverse proxying daemon.

SYNOPSIS
routed

ENVIRONMENT
BOLTDB_PATH
    Specifies the path to the boltdb database routed stores all of its relevant data in.
WEB_ADDR
    Specifies the host+port that routed will listen on for unsecured HTTP traffic. This will only forward traffic to HTTPS.
SSL_ADDR
    Specifies the host+port that routed will listen on for secure (TLS) traffic. This should have port 443 if you want Let's Encrypt to work (you probably want Let's Encrypt to work).
QUIC_ADDR
    Specifies the host+port that routed will listen on for secure (TLS) QUIC traffic. For more information see https://datatracker.ietf.org/wg/quic/about/. This should also be port 443, but is not essential for Let's Encrypt to work.
BACKEND_TCP_ADDR
    Specifies the host+port that routed will listen on for secure (TLS) TCP connections from backends. Any client that is successfully able to authenticate with routed on this port will relay HTTP traffic from to and from end users.
BACKEND_KCP_ADDR
    Specifies the host+port that routed will listen on for secure (TLS) KCP (reliable-UDP) connections from backends. Any client that is successfully able to authenticate with routed on this port will relay HTTP traffic from to and from end users. For more information about KCP, see https://github.com/xtaci/kcp-go
GRPC_ADDR
    Specifies the host+post that routed will listen on for secure (TLS) TCP gRPC connections from clients wishing to control routed configuration. Authentication is enforced and requires the use of an API token generated by the API call route.Tokens.Put.
DOMAIN_SUFFIX
    Specifies the domain suffix that routed will use when automatically generating a domain name for a newly created route. Please set this to something that has a wildcard DNS record pointing to your instances of routed.
ACME_EMAIL
    Specifies the email address that routed will use when creating a new account with Let's Encrypt. This assumes you have read (and agree to) the Let's Encrypt terms of service found here: https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf.
SSL_CERT_KEY
    Specifies the encryption key that routed will use when encrypting and decrypting SSL certificates when loading them from and saving them to the database. This can be created with route-cli(1).

IMPLEMENTATION NOTES
In order for routed to route traffic, a route must be set up using route-cli(1). Please see its manpage for more information on how to do this. routed exposes debugging and introspection information on a randomly generated port every time it starts up. The message will look something like: 2017/12/13 02:06:56 manhole: Now listening on http://127.0.0.1:39245 Expose this using route-httpagent(1) or similar tools. routed can be managed using terraform. See terraform-provider-route(1) for more information.

EXAMPLES
routed

DIAGNOSTICS

SEE ALSO

•   https://datatracker.ietf.org/wg/quic/about/

•   https://github.com/xtaci/kcp-go

•   https://grpc.io/

•   https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf