{"repo":"deco-cx/warp","free":true,"listed":false,"github":"https://github.com/deco-cx/warp","clone":"git clone https://github.com/deco-cx/warp.git","description":"A simple tool that allows your locally running HTTP(s) servers to have a public URL, serving as an easy-to-self-host alternative to services like `ngrok`","language":"HTML","stars":32,"topics":[],"license":"Apache-2.0","category":"self-hosted-apps","readme_excerpt":"Warp Warp is a simple tool that allows your locally running HTTP(s) servers to have a public URL, serving as an easy-to-self-host alternative to services like ngrok . Warp is implemented in Deno with the goal of providing flexibility and minimal dependencies. The project has two main components: - Server : Deployable on a server, it connects to the outside world and is accessible from any domain. - Client : Runs locally to connect a given HTTP endpoint running on a local or non-public network. Server The Warp server opens a single HTTP port to which the Warp client connects and upgrades to a WebSocket connection. Each request to this HTTP port is forwarded (based on the client's HOST header) to the corresponding connected Warp client connection, which then serves the request. Usage To start the Warp server, import the serve function from the Warp package and call it with the appropriate configuration. Example Parameters - port : The port number where the Warp server will listen for connections. - apiKeys : An array of API keys used for client authentication. Client The Warp client connects to the Warp server. Upon connection, the client shares the given API key and the domain it wants to receive requests for. Usage To connect a client to the Warp server, import the connect function from the Warp package and call it with the appropriate configuration. Example Parameters - domain : The domain name that will be used to access your localhost service. - localAddr : The local addre","default_branch":null,"files":null,"tree":[],"storefront":"/r/deco-cx","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/deco-cx/warp/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}