Added more documenation on depencies and usage to README.
This commit is contained in:
parent
3c7d4c0676
commit
b2b20dd6c2
22
README
22
README
|
@ -1,8 +1,12 @@
|
|||
localtunnel -- instant public tunnel for local web servers
|
||||
|
||||
Dependencies: Ruby (with libopenssl) and Rubygems
|
||||
Dependencies: Ruby (with libopenssl) and Rubygems. A public key.
|
||||
Type "sudo apt-get install ruby ruby1.8-dev rubygems1.8 libopenssl-ruby"
|
||||
to satisfy dependencies.
|
||||
Run "ssh-keygen" if you have never made a public key.
|
||||
|
||||
Install: sudo gem install localtunnel
|
||||
Install: sudo gem install localtunnel
|
||||
or "git clone http://github.com/progrium/localtunnel.git" for source.
|
||||
|
||||
Usage: localtunnel [options] <localport>
|
||||
-k, --key FILE upload a public key for authentication
|
||||
|
@ -10,7 +14,8 @@ Usage: localtunnel [options] <localport>
|
|||
localtunnel is a client to a free and open source reverse tunneling service
|
||||
made specifically for web traffic. It's intended to be used to temporarily
|
||||
expose local web servers to the greater Internet for debugging, unit tests,
|
||||
demos, etc.
|
||||
demos, etc.
|
||||
|
||||
|
||||
This is how you make your local port 8080 public:
|
||||
|
||||
|
@ -22,12 +27,15 @@ a remote host that has GatewayPorts enabled, but without all the configuration
|
|||
or the need of a host. The localtunnel command works with a server component
|
||||
that is running on localtunnel.com, which is provided as a free service.
|
||||
|
||||
If you haven't run the command before, you'll need to upload a public key to
|
||||
authenticate. You do this like so:
|
||||
If have never run localtunnel before, you'll need to upload a public key to
|
||||
authenticate. You do this once:
|
||||
|
||||
$ localtunnel -k ~/.ssh/id_rsa.pub 8080
|
||||
|
||||
After that, you shouldn't have to use -k again.
|
||||
|
||||
The tunnel remains open for as long as the command is running. The tunnel is
|
||||
closed if the command exits.
|
||||
localtunnel can be started before or after the local web server. It tunnels
|
||||
through to the url given in that status message "publicly accessible from..."
|
||||
for as long as the command is running. The tunnel is
|
||||
closed if the command exits.
|
||||
|
||||
|
|
Loading…
Reference in New Issue