table of contents
other versions
- bookworm-backports 0.4.12-1
- testing 0.4.11-1
- unstable 0.4.12-2
AIOCOAP-PROXY(1) | User Commands | AIOCOAP-PROXY(1) |
NAME¶
aiocoap-proxy - manual page for aiocoap-proxy 0.4.12
DESCRIPTION¶
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]
a plain CoAP proxy that can work both as forward and as reverse proxy
options:¶
- -h, --help
- show this help message and exit
- --version
- show program's version number and exit
mode:¶
- Required argument for setting the operation mode
details:¶
- Options that govern how requests go in and out
- --bind BIND
- Host and/or port to bind to (see --help-bind for details)
- --credentials CREDENTIALS
- JSON file pointing to credentials for the server's identity/ies.
- --tls-server-certificate CRT
- TLS certificate (chain) to present to connecting clients (in PEM format)
- --tls-server-key KEY
- TLS key to load that supports the server certificate
- --register [RD-URI]
- Register with a Resource directory
- --register-as EP[.D]
- 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.
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 NAME:DEST
- If Uri-Host matches NAME, route to DEST
- --subdomainbased NAME:DEST
- If Uri-Host is anything.NAME, route to DEST
- --pathbased PATH:DEST
- If a requested path starts with PATH, split that part off and route to DEST
- --unconditional 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.
February 2025 | aiocoap-proxy 0.4.12 |