route/doc/man/route-httpagent.1

132 lines
2.7 KiB
Groff
Raw Normal View History

.Dd December 14, 2017
.Dt ROUTE-HTTPAGENT 1 URM
.Sh NAME
.Nm route-httpagent
.Nd agent to communicate between
.Xr routed 1
and a HTTP backend of your choice.
.Sh SYNOPSIS
.Nm
.Op Fl backend Ar BACKEND
.Op Fl domain Ar DOMAIN
.Op Fl method Ar METHOD
.Op Fl server Ar SERVER
.Op Fl token Ar TOKEN
.Sh DESCRIPTION
.Nm
communicates with
.Xr routed 1
to relay traffic from it and the TCP/HTTP backend of your choice.
.Bl -tag -width "routed" -offset -indent -compact
.It Fl backend Ar BACKEND
Specifies the backend TCP/HTTP server
.Nm
should relay traffic to/from. This is specified in URI (RFC 3986) format. If this is not specified, the default value will be http://127.0.0.1:9090.
.It Fl domain Ar DOMAIN
Specifies the domain
.Nm
should use when authenticating with
.Xr routed 1 .
This must be set or
.Nm
will fail to launch.
.It Fl method Ar METHOD
Specifies the connection method that
.Nm
should use to relay traffic with
.Xr routed 1 .
This MUST be set to either "tcp" or "kcp". If this is not set, the default is "tcp".
.It Fl server Ar SERVER
Specifies the TCP/UDP host+port that
.Xr routed 1
is configured to accept agent connections from. See the manpage for
.Xr routed 1
for more information on how to configure this. This must be set by the user.
.It Fl token Ar TOKEN
Specifies the authentication token used to authenticate with
.Xr routed 1
when setting up an agent connection. This must be set by the user.
.Sh ENVIRONMENT
All of the above command line flags can be set as environment variables. Ex: -method becomes METHOD
For convenience,
.Nm
will load key->value pairs from .env in its current working directory when it starts up. A reference for the environment variables
.Nm
reads follows:
.Bl -tag -width "routed" -offset indent -compact
.It Ev BACKEND
Supplies the value for -backend
.It Ev DOMAIN
Supplies the value for -domain
.It Ev METHOD
Supplies the value for -method
.It Ev SERVER
supplies the value for -server
.It Ev TOKEN
supplies the value for -token
.El
.Sh IMPLEMENTATION NOTES
In order for
.Nm
to route traffic, a route must be set up using
.Xr route-cli 1 .
Please see its manpage for more information on how to do this.
This relies on an instance of
.Xr routed 1
to be running and reachable via either TCP or UDP.
.Sh EXAMPLES
route-httpagent -backend http://127.0.0.1:9090 -domain wusg-strugzi-wu.routed.xeserv.us -method tcp -server connect.routed.xeserv.us -token <secret_omitted>
route-httpagent -domain wusg-strugzi-wu.routed.xeserv.us -method tcp -server connect.routed.xeserv.us -token <secret_omitted>
.Sh DIAGNOSTICS
.Ex -std routed
.Sh SEE ALSO
.Bl -bullet
.It
.Xr route-cli 1
.It
.Xr routed 1
.It
https://tools.ietf.org/html/rfc3986
.El