Add a throw-back README with the information from the previous project

This commit is contained in:
R. Tyler Croy 2013-03-10 17:41:18 -07:00
parent d4302e617b
commit 6b3546ab4a
1 changed files with 54 additions and 19 deletions

View File

@ -1,29 +1,64 @@
# Passageway
# Passageway -- instant public tunnel to your local web server
TODO: Write a gem description
## Install
## Installation
Now you can install Passageway with RubyGems:
Add this line to your application's Gemfile:
% gem install passageway
gem 'passageway'
or to get the source:
And then execute:
$ bundle
Or install it yourself as:
$ gem install passageway
git clone http://github.com/rtyler/passageway.git
## Usage
TODO: Write usage instructions here
passageway [options] <localport>
-k, --key FILE upload a public key for authentication
## Contributing
Passageway 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.
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
This is how you make your local port 8080 public:
$ passageway 8080
Port 8080 is now publicly accessible from http://8bv2.localtunnel.com ...
$ passageway 8080
Port 8080 is now publicly accessible from http://8bv2.localtunnel.com ...
Using Passageway is comparable to using SSH reverse/remote port
forwarding on 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 have never run localtunnel before, you'll need to upload a public
key to authenticate. You do this once:
$ passageway -k ~/.ssh/id_rsa.pub 8080
After that, you shouldn't have to use -k again.
Passageway 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.
Passageway will search for the file `.localtunnel_callback` in the current
working directory. If it exists, it will execute the file with one argument,
the public endpoint, when the tunnel is opened. This is useful for starting
other tools or processes that need the name of the endpoint.
## Contributors
andyl (andy@r210.com)
Charles Merriam (charles.merriam@gmail.com)
Hunter Gillane (hunter.gillane@gmail.com)
Michael Sofaer (msofaer@pivotallabs.com)
Jeff Lindsay (progrium@gmail.com)
## License
MIT