NAME
aiocoap-proxy - forward and reverse proxy server for CoAP
a plain CoAP proxy that can work both as forward and as reverse proxy
usage: aiocoap-proxy [-h] [--version] [--forward] [--reverse] [--bind BIND]
[--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]
NAMED ARGUMENTS
- --version
-
show program's version number and exit
MODE
Required argument for setting the operation mode
- --forward
-
Run as forward proxy
Default: False
- --reverse
-
Run as reverse proxy
Default: False
DETAILS
Options that govern how requests go in and out
- --bind
-
Host and/or port to bind to (see --help-bind for details)
- --credentials
-
JSON file pointing to credentials for the server's identity/ies.
- --tls-server-certificate
-
TLS certificate (chain) to present to connecting clients (in PEM format)
- --tls-server-key
-
TLS key to load that supports the server certificate
- --register
-
Register with a Resource directory
Default: False
- --register-as
-
Endpoint name (with possibly a domain after a dot) to register as
- --register-proxy
-
Ask the RD to serve as a reverse proxy. Note that this is only practical for --unconditional or --pathbased reverse proxies.
Default: False
RULES
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.
- --namebased
-
If Uri-Host matches NAME, route to DEST
- --subdomainbased
-
If Uri-Host is anything.NAME, route to DEST
- --pathbased
-
If a requested path starts with PATH, split that part off and route to DEST
- --unconditional
-
Route all requests not previously matched to DEST
COPYRIGHT
Christian Amsüss and the aiocoap contributors