Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Comparing changes

Choose two branches to see what's changed or to start a new pull request. If you need to, you can also compare across forks.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also compare across forks.
base fork: rtyler/passageway
base: d4302e617b
...
head fork: rtyler/passageway
compare: 995c189661
Checking mergeability… Don't worry, you can still create the pull request.
  • 2 commits
  • 2 files changed
  • 0 commit comments
  • 1 contributor
Showing with 53 additions and 18 deletions.
  1. +52 −17 README.md
  2. +1 −1  lib/passageway/version.rb
View
69 README.md
@@ -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:
+ git clone http://github.com/rtyler/passageway.git
- $ bundle
+## Usage
-Or install it yourself as:
+ passageway [options] <localport>
+ -k, --key FILE upload a public key for authentication
- $ gem install passageway
+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.
-## Usage
+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
-TODO: Write usage instructions here
+ 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)
-## Contributing
+## License
-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
+MIT
View
2  lib/passageway/version.rb
@@ -1,3 +1,3 @@
module Passageway
- VERSION = "0.0.1"
+ VERSION = "0.0.2"
end

No commit comments for this range

Something went wrong with that request. Please try again.