Skip to content

Latest commit

 

History

History
82 lines (59 loc) · 2.54 KB

README.md

File metadata and controls

82 lines (59 loc) · 2.54 KB
Raw

Gotunnel - server your local server/directory over the internet

Gotunnel makes your localhost server or directory accessible on the net. It supports HTTP/S and WebSocket.

Assuming your server is running on port 3000, on your laptop. Run ./gotunnel -p "3000" (from the checkedout repository, see installation) and that would make it accessible on a subdomain at localtunnel.net.

$ ./gotunnel -p 3000
Setting Gotunnel server localtunnel.net:34000 with local server on 3000

Connect to vxyz.localtunnel.net

If you would like to serve a directory on the internet (think python -m SimpleHTTPServer 8000 over the internet), then run:

$ ./gotunnel -fs -p <some port> -d <path to dir>

The server is running on ec2 small instance, so although free, might not be able to handle much load. You can deploy the server on your own machine (ec2 instance etc), and connect the client to it. More below.

Installation

If you are on Mac OS X, just checkout the repository. The client binary that comes with the repo, should work.

git clone https://github.com/ciju/gotunnel

If you are on some other OS, or the above didn't work. First install Go. Then clone the repo, and build the client. Ex:

git clone https://github.com/ciju/gotunnel
go get
make

Client Options

$ ./gotunnel
Usage: ./gotunnel [OPTIONS]

Options:
  -d="": The directory to serve. To be used with -fs.
  -fs=false: Server files in the current directory. Use -p to specify the port.
  -p="": port
  -r="localtunnel.net:34000": the remote gotunnel server host/ip:port
  -sc=false: Skip version check
  -sub="": request subdomain to serve on

Running your own server

Install golang, and compile the server with command.

go get
go build server.go

Run the server with custom options. Usage: ./server [OPTIONS]

Options:
  -a="localtunnel.net": the address to be used by the users
  -p="32000": Access the tunnel sites on this port.
  -x="0.0.0.0:34000": Port for clients to connect to

Limitations

  • If making connections to ports like 34000 are not allowed by your n/w then the client might not work.

  • Connection pooling might not be possible. Working at the TCP level, we loose the ability of knowing when an HTTP/S or websocket request has finished, except when TCP connection ends.

TODO

  • statistics
  • better error handling
  • make it faster

LICENSE

MIT

Sponsored by ActiveSphere