Getting Started

Install Proxer and expose a local HTTP service in a few minutes.

Prerequisites

Download a standalone Windows executable from GitHub Releases.

proxer.exe --version

brew install tinyrack-net/tap/proxer

npm works on every platform and can be used as a cross-platform fallback.

npm install -g @tinyrack/proxer

docker run --rm tinyrack/proxer --version

If this is your first time using Proxer, follow these steps to start one public server and expose one local service.

Start the public server

Run Proxer on the machine that receives public traffic.
```
proxer server --listen 0.0.0.0:8080 --domain your-server.example.com --token dev-token
```
The server listens for both public requests and tunnel control connections on the same port.
Start a local app

On the client machine, start any HTTP service. This example uses Python’s built-in server:
```
python3 -m http.server 3000 --bind 127.0.0.1
```

Connect the root-domain tunnel

Omit --subdomain to register the root domain route.

proxer http 3000 \
  --server ws://your-server.example.com:8080 \
  --token dev-token

Test the root route

curl -H 'Host: your-server.example.com' http://your-server.example.com:8080/

Use a subdomain route

Start another client with --subdomain when you want a named route.

proxer http 3000 \
  --server ws://your-server.example.com:8080 \
  --subdomain demo \
  --token dev-token

curl -H 'Host: demo.your-server.example.com' http://your-server.example.com:8080/

Now that you have a tunnel running, explore the guides:

How It Works — understand the control connection and request flow
Routing and Trusted Proxies — configure root domains, subdomains, and reverse proxies
Docker — run the public server from an OCI image
proxer server — command reference for the server
proxer http — command reference for tunnel clients