Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 1.93 KB

README.md

File metadata and controls

72 lines (51 loc) · 1.93 KB
Raw

Mole

Mole creates publicly accessible HTTP/HTTPS/TCP/UDP tunnels for local development. Tunnels are implemented using ssh remote port forwarding. Subdomains are assigned using an auto-incrementing id for every forwarding request.

Installation

Install the mole server. You will need go and openssh installed before preceeding.

go get -u github.com/michalnicp/mole

Generate the ssh host key file.

ssh-keygen -t rsa -b 2048 -f /etc/mole/ssh_host_key

Start mole.

$ mole
mole version 0.0.0

Configuration

Mole is configured using environment variables

Variable Default Description
SERVER_NAME The fully qualified domain name (hostname).
HTTP_ADDR :8080 The http server address to listen on.
SSH_ADDR :2022 The ssh server address to listen on.
SSH_HOST_KEY_PATH ssh_host_key The path to the ssh server host key file.
SSH_AUTHORIZED_KEYS authorized_keys The path to the authorized keys file.

Quickstart

This quickstart assumes that the mole server is running and available at example.com. You can use any ssh client that supports remote forwarding. For example, using openssh

$ ssh example.com -p 2022 -R 8000:localhost:8000
mole version 0.0.0
forwarding http://1.example.com->localhost:8000

Test using ncat. The following will start ncat listening on port 8000

$ printf 'HTTP/1.1 200 OK\r\n' | ncat -l 8000

Then, in another terminal, make an http request using curl

$ curl 1.example.com

You should see the following output from ncat

$ printf 'HTTP/1.1 200 OK\r\n' | ncat -l 8000
GET / HTTP/1.1
Host: 1.example.com
User-Agent: curl/7.68.0
Accept: */*