wormhole

wormhole lets you expose your locally running web server via a public URL. Written in Rust. Built completely with async-io on top of tokio.

1. Install Wormhole
2. Usage Instructions
3. Host it yourself

Install

Brew (macOS)

brew install agrinman/tap/wormhole

Cargo

cargo install wormhole-tunnel

Or Download a release for your target OS here: wormhole/releases

Usage

Quick Start

⇢ wormhole start -p 8000

The above command opens a wormhole and starts tunneling traffic to localhost:8000.

More Options:

⇢ wormhole start -h
wormhole-start 0.1.4
Start the wormhole

USAGE:
    wormhole start [OPTIONS] --port <port>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -k, --key <key>                 Sets an API authentication key to use for this wormhole
    -p, --port <port>               Sets the port to forward incoming tunnel traffic to on localhost
    -s, --subdomain <sub-domain>    Specify a sub-domain for this wormhole

Host it yourself

1. Compile the server for the musl target. See the musl_build.sh for a way to do this trivially with Docker!
2. See Dockerfile for a simple alpine based image that runs that server binary.
3. Deploy the image where ever you want.

Testing Locally

# Run the Server: xpects TCP traffic on 8080 and control websockets on 5000
ALLOWED_HOSTS="localhost" ALLOW_UNKNOWN_CLIENTS=1 cargo run --bin wormhole_server

# Run a local wormhole talking to your local wormhole_server
WORMHOLE_HOST="localhost" WORMHOLE_PORT=5000 TLS_OFF=1 cargo run --bin wormhole -- start -p 8000

# Test it out!
# Remember 8080 is our local wormhole_server TCP server
curl -H '<subdomain>.localhost' "http://localhost:8080/some_path?with=somequery"

Server Env Vars

• ALLOWED_HOSTS: which hostname suffixes do we allow forwarding on

• SECRET_KEY: an authentication key for restricting access to your wormhole server

• ALLOW_UNKNOWN_CLIENTS: a boolean flag, if set, enables unknown (no authentication) clients to use your wormhole. Note that unknown clients are not allowed to chose a subdomain via -s.

Caveats

This implementation does not support multiple running servers (i.e. centralized coordination). Therefore, if you deploy multiple instances of the server, it will only work if the client connects to the same instance as the remote TCP stream.