AIOCOAP-PROXY(1)

📦
version 0.4.17 · 4 versions
, in ubuntu stonking

✨ AIOCOAP-PROXY(1) ✨

okay bestie, buckle up 💖 this is the manual page for aiocoap-proxy, part of the aiocoap fam.

🌸 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. that's it, that's the whole job 💅

👑 MODE 👑

Required argument for setting the operation mode — like, you have to pick one, it's not optional, no she's not coming to the party without an outfit, periodt.

  • --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. iykyk 🔥

ngl, the prefix thing is the part people trip on — those little '@' and '!' characters lowkey change everything about where your request goes.
  • --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

Christian Amsüss and the aiocoap contributors

and that's the whole thing bestie, you ate 🍓 version 0.4, dated Apr 04, 2026 — go proxy something iconic 👑💅

📦 where this page comes from