Proxy

A customizable HTTP and WebSocket proxy server written in TypeScript.

Running

Run the container

docker run -p 3000:3000 --name proxy ghcr.io/tlaanemaa/proxy:latest

Configuration

You can configure the proxy server through the following environment variables:

• TARGET_HEADER_NAME: The name of the header containing the target host, used for proxying HTTP requests. Defaults to x-target.
• TARGET_QUERY_PARAM: The name of the query parameter containing the target host, used for proxying websockets. Defaults to target.
• PORT: The port the server listens on. Defaults to 3000.

Usage

To use the proxy, simply send requests to it like you would to the target, and pass the target host as either x-target header when sending HTTP requests, or target query param when initiating websocket connections. All headers, method, body, etc. will be copied from the original request.

Example HTTP proxy request, using JS fetch API:

This is assuming that the proxy server is running at http://localhost:3000

fetch("http://localhost:3000/todos/1", {
  method: "GET",
  headers: {
    "x-target": "https://jsonplaceholder.typicode.com",
  },
})
  .then((response) => response.json())
  .then((data) => console.log(data))
  .catch((error) => console.error("Error:", error));

Example websocket connection, using JS

This is assuming that the proxy server is running at http://localhost:3000

const socket = new WebSocket(
  "ws://localhost:3000?target=wss://echo.websocket.org"
);