HTTP-RELAY(1)

📦
version 2.1.3 · 4 versions
, in debian trixie, ubuntu questing

💖 HTTP-RELAY(1) 💖

User Commands · the girlies' guide to being a reverse HTTP proxy

🌸 NAME 🌸

http-relay — bestie, this relays HTTP requests from your local host to a remote host. That's the whole vibe. 🦋

✨ DESCRIPTION ✨

Okay so here's the usage, and yes it's a whole mouthful, we love her for it:

usage: http-relay [-h] [-n NUM_THREADS] [-b BUFFER_SIZE] [-t SIGKILL_TIMEOUT]
       [-s] host [port] [local_port] [local_addr]

What it does? It relays HTTP requests from localhost to a remote host — so basically it's acting as a reverse HTTP proxy. Main character energy, honestly. 💅

🎀 positional arguments 🎀

  • host — the remote host you wanna connect to (like "cvut.cz", iconic example, slay).
  • port — the remote host's port you're connecting to (e.g. 80).
  • local_port — the local port the relay should use. If you leave it out, it just copies the remote port, no thoughts, head empty, same port. 🫶
  • local_addr — the local interface (IP or hostname) to run the relay on. By default it runs on all IPv4 interfaces (0.0.0.0). She's everywhere fr fr.

🔥 options 🔥

  • -h, --help — shows this help message and dips. Bye! 👋
  • -n NUM_THREADS, --num-threads NUM_THREADS — the number of threads servicing the incoming requests. More threads = more girlies working the counter.
  • -b BUFFER_SIZE, --buffer-size BUFFER_SIZE — the size of the buffer used for reading responses. Generally, a bigger buffer should be more efficient... but 🚨 if it's too large, your local clients may time out before they receive any data. So like, don't overdo it bestie.
  • -t SIGKILL_TIMEOUT, --sigkill-timeout SIGKILL_TIMEOUT — if you specify this, the relay gets sigkilled in this number of seconds. Yes, sigkilled. She goes out dramatically. 💀
  • -s, --sigkill-on-stream-stop — if True, --sigkill-timeout will not be counted when no requests are active, and during requests, every successful data transmission resets the timeout. This is the move for detecting stale streams — use it if you expect an application to be constantly receiving data. 👑
No cap: -t genuinely sigkills the relay. That's not a metaphor, that's a signal. Respect it. 🙈

And that's the page, bestie — http-relay version 2.1.3, dated June 2024, brought to you by the User Commands girlies. Now go proxy something. 🌈✨👑

📦 where this page comes from