Scroll to navigation

AIOCOAP-PROXY(1) User Commands AIOCOAP-PROXY(1)

NAME

aiocoap-proxy - A plain CoAP proxy that can work both as forward and as reverse proxy

DESCRIPTION

usage: aiocoap-proxy [-h] [--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]

a plain CoAP proxy that can work both as forward and as reverse proxy

options:

show this help message and exit

mode:

Required argument for setting the operation mode
Run as forward proxy
Run as reverse proxy

details:

Options that govern how requests go in and out
Host and/or port to bind to (see --help-bind for details)
JSON file pointing to credentials for the server's identity/ies.
TLS certificate (chain) to present to connecting clients (in PEM format)
TLS key to load that supports the server certificate
Register with a Resource directory
Endpoint name (with possibly a domain after a dot) to register as
Ask the RD to serve as a reverse proxy. Note that this is only practical for --unconditional or --pathbased reverse proxies.

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.
If Uri-Host matches NAME, route to DEST
If Uri-Host is anything.NAME, route to DEST
If a requested path starts with PATH, split that part off and route to DEST
Route all requests not previously matched to DEST

SEE ALSO

The full documentation for aiocoap-proxy is maintained as a Texinfo manual. If the info and aiocoap-proxy programs are properly installed at your site, the command

info aiocoap-proxy

should give you access to the complete manual.

April 2022 aiocoap-proxy 0.4.3