CONFIGURABLE-HTTP-PROXY(1)

📦
version 4.5.3+~cs15.2.4 · 4 versions
, in ubuntu noble, ubuntu resolute

💖 NAME 💖

okay so bestie, meet configurable-http-proxy — it's a configurable-on-the-fly HTTP Proxy written in Node.js. yes she's that girl. she rewrites her routing while she's running, no restart, no drama. 👑

this lil page lives in the User Commands section of your manual, so you already know it's giving real-tool energy. ✨

🦋 SYNOPSIS 🦋

configurable-http-proxy [options]

that's it. that's the whole vibe. toss her some options and she goes. 🫶

💅 OPTIONS 💅

she has so many options, and honestly? obsessed. every single one below, no skips, no cuts. 🎀

  • -V, --version — prints out the version number. that's the whole job. she ate. 💅
  • --ip <ip-address> — the public-facing IP of the proxy. who the world sees.
  • --port <n> — the public-facing port of the proxy. defaults to 8000 if you don't say anything. ⭐
  • --ssl-key <keyfile> — SSL key to use, if any. no key? no worries.
  • --ssl-cert <certfile> — SSL certificate to use, if any.
  • --ssl-ca <ca-file> — SSL certificate authority, if any.
  • --ssl-request-cert — asks for SSL certs so clients can authenticate themselves. 💳
  • --ssl-reject-unauthorized — rejects unauthorized SSL connections. heads up: this is only meaningful if --ssl-request-cert is given. no request, nothing to reject, iykyk.
  • --ssl-protocol <ssl-protocol> — pins a specific SSL protocol, like TLSv1_2 or SSLv3.
  • --ssl-ciphers <ciphers> — a :-separated ssl cipher list. the default excludes RC4, because bestie has taste.
  • --ssl-allow-rc4 — allows the RC4 cipher for SSL. it's disabled by default and there's a reason for that. 🔥
  • --ssl-dhparam <dhparam-file> — SSL Diffie-Helman Parameters pem file, if any.
  • --api-ip <ip> — the inward-facing IP for API requests. defaults to "localhost".
  • --api-port <n> — the inward-facing port for API requests. defaults to --port=value+1, which is cute of her.
  • --api-ssl-key <keyfile> — SSL key to use, if any, for API requests.
  • --api-ssl-cert <certfile> — SSL certificate to use, if any, for API requests.
  • --api-ssl-ca <ca-file> — SSL certificate authority, if any, for API requests.
  • --api-ssl-request-cert — requests SSL certs to authenticate clients for API requests.
  • --api-ssl-reject-unauthorized — rejects unauthorized SSL connections. again: only meaningful if --api-ssl-request-cert is given.
  • --client-ssl-key <keyfile> — SSL key to use, if any, for proxy-to-client requests.
  • --client-ssl-cert <certfile> — SSL certificate to use, if any, for proxy-to-client requests.
  • --client-ssl-ca <ca-file> — SSL certificate authority, if any, for proxy-to-client requests.
  • --client-ssl-request-cert — requests SSL certs to authenticate clients for API requests. (yes, it says API requests. that's what it says. we don't question the queen. 🙈)
  • --client-ssl-reject-unauthorized — rejects unauthorized SSL connections, and same rule as always: only meaningful if --client-ssl-request-cert is given.
  • --default-target <host> — the default proxy target, written as proto://host[:port].
  • --error-target <host> — an alternate server for handling proxy errors, written as proto://host[:port].
  • --error-path <path> — an alternate server for handling proxy errors, written as proto://host[:port].
  • --redirect-port <redirect-port> — redirects HTTP requests on this port over to the server on HTTPS. glow up to TLS. ✨
  • --redirect-to <port> — redirects HTTP requests from --redirect-port to this port.
  • --pid-file <pid-file> — writes our PID to a file. she's documenting herself. main character behavior. 📝
  • --no-x-forward — don't add 'X-forward-' headers to proxied requests.
  • --no-prepend-path — avoids prepending target paths to proxied requests.
  • --no-include-prefix — don't include the routing prefix in proxied requests.
  • --auto-rewrite — rewrites the Location header host/port in redirect responses. sneaky, helpful, iconic.
  • --change-origin — changes the origin of the host header to the target URL.
  • --protocol-rewrite <proto> — rewrites the Location header protocol in redirect responses to the specified protocol.
  • --custom-header <header> — a custom header to add to proxied requests. use the same option again for multiple headers, like --custom-header k1:v1 --custom-header k2:v2. default: {}. 🎀
  • --insecure — disables SSL cert verification.
ngl bestie, turning off cert verification is exactly as unserious as it sounds. she's allowed to do it. that doesn't mean it's a good idea. 😭
  • --host-routing — uses host routing, meaning the host becomes the first level of the path.
  • --metrics-ip <ip> — IP for the metrics server. default: "".
  • --metrics-port <n> — port of the metrics server. defaults to no metrics server at all, which is very "I'm booked and busy". ⭐
  • --log-level <loglevel> — log level, one of debug, info, warn, error. default: "info".
  • --timeout <n> — timeout (in millis) when the proxy drops a connection for a request.
  • --proxy-timeout <n> — timeout (in millis) when the proxy receives no response from the target.
  • --storage-backend <storage-class> — defines an external storage class. defaults to in-MemoryStore.
  • -h, --help — displays help for the command. when in doubt, ask her directly. 💜

and that's the whole page, bestie, every single flag, untouched and unskipped. 💖

configurable-http-proxy 4.5.3 🌈 — that's the version, and this whole page is dated March 2023. go forth and proxy. periodt. 💅✨
📦 where this page comes from