Quick Start

Get a local service publicly accessible in a few steps.

1. Install Exposr

bash

pip install exposr

2. Configure the relay server

Set the IP address of your Exposr relay server. This also generates a random agent token and saves it to ~/.exposr/agent_token.txt:

bash

exposr config set-server YOUR_SERVER_IP

Note

You need access to a machine running the Exposr server. See the "Using Your Own Relay Server" guide for setup instructions.

3. Start your local application

Start a local service. For example, a Python HTTP server:

bash

python -m http.server 3000

4. Expose it

bash

exposr tcp 3000 25565

You should see output similar to:

exposr

[TRYING] Connecting to Exposr server
[CONNECTED] Connected to Exposr control server
[TRYING] Registering public port
[CONNECTED] Tunnel active

Public address:
  20.198.81.254:25565

Forwarding to:
  127.0.0.1:3000

5. Access from the internet

Anyone can now access your local service at the public address shown. For a web server:

text

http://SERVER_IP:25565

Traffic arriving at the public port is forwarded through the Exposr tunnel to your local service on port 3000.

Installation Overview

Edit this page on GitHub →