Giter VIP home page Giter VIP logo

proxy's Introduction

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"
);

proxy's People

Contributors

tlaanemaa avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.