.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.2.
.TH AIOCOAP-PROXY "1" "April 2022" "aiocoap-proxy 0.4.3" "User Commands"
.SH NAME
aiocoap-proxy \- A plain CoAP proxy that can work both as forward and as reverse proxy
.SH DESCRIPTION
usage: aiocoap\-proxy [\-h] [\-\-forward] [\-\-reverse] [\-\-bind BIND]
.TP
[\-\-credentials CREDENTIALS]
[\-\-tls\-server\-certificate CRT] [\-\-tls\-server\-key KEY]
[\-\-register [RD\-URI]] [\-\-register\-as EP[.D]]
[\-\-register\-proxy] [\-\-namebased NAME:DEST]
[\-\-subdomainbased NAME:DEST] [\-\-pathbased PATH:DEST]
[\-\-unconditional DEST]
.PP
a plain CoAP proxy that can work both as forward and as reverse proxy
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.SS "mode:"
.IP
Required argument for setting the operation mode
.TP
\fB\-\-forward\fR
Run as forward proxy
.TP
\fB\-\-reverse\fR
Run as reverse proxy
.SS "details:"
.IP
Options that govern how requests go in and out
.TP
\fB\-\-bind\fR BIND
Host and/or port to bind to (see \fB\-\-help\-bind\fR for
details)
.TP
\fB\-\-credentials\fR CREDENTIALS
JSON file pointing to credentials for the server's
identity/ies.
.TP
\fB\-\-tls\-server\-certificate\fR CRT
TLS certificate (chain) to present to connecting
clients (in PEM format)
.TP
\fB\-\-tls\-server\-key\fR KEY
TLS key to load that supports the server certificate
.TP
\fB\-\-register\fR [RD\-URI]
Register with a Resource directory
.TP
\fB\-\-register\-as\fR EP[.D]
Endpoint name (with possibly a domain after a dot) to
register as
.TP
\fB\-\-register\-proxy\fR
Ask the RD to serve as a reverse proxy. Note that this
is only practical for \fB\-\-unconditional\fR or \fB\-\-pathbased\fR
reverse proxies.
.SS "Rules:"
.IP
Sequence of forwarding rules that, if matched by a request, specify a
forwarding destination. Destinations can be prefixed to change their
behavior: With an '@' sign, they are treated as forward proxies. With a
\&'!' sign, the destination is set as Uri\-Host.
.TP
\fB\-\-namebased\fR NAME:DEST
If Uri\-Host matches NAME, route to DEST
.TP
\fB\-\-subdomainbased\fR NAME:DEST
If Uri\-Host is anything.NAME, route to DEST
.TP
\fB\-\-pathbased\fR PATH:DEST
If a requested path starts with PATH, split that part
off and route to DEST
.TP
\fB\-\-unconditional\fR DEST
Route all requests not previously matched to DEST
.SH "SEE ALSO"
The full documentation for
.B aiocoap-proxy
is maintained as a Texinfo manual.  If the
.B info
and
.B aiocoap-proxy
programs are properly installed at your site, the command
.IP
.B info aiocoap-proxy
.PP
should give you access to the complete manual.