Skip to content

Commit

Permalink
more readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zwily committed Mar 1, 2014
1 parent 99c9222 commit d76db89
Showing 1 changed file with 45 additions and 4 deletions.
49 changes: 45 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ proxies data through the remote tunnel.

Trust me, it's magic.

## Building

```bash
$ go get github.com/zwily/turbotunnel
$ go build github.com/zwily/turbotunnel
```

## Sample Config

```yaml
Expand All @@ -25,7 +32,7 @@ tunnels:
## Running

```bash
$ turbotunnel -config /path/to/config.yml
$ ./turbotunnel -config /path/to/config.yml
```

## Using
Expand All @@ -36,10 +43,44 @@ initiate an ssh connection to jump1.example.com forwarding a local port
to 10.0.13.10:80. TurboTunnel will then proxy all data between the
opened connection and the local tunnel.

## Building
## Notifications

If you're using OS X, you can get desktop notifications when a tunnel
is started by installing `terminal-notifier`:

```bash
$ brew install terminal-notifier
```

## Running as a Daemon

I run TurboTunnel via launchd. Sample configuration, placed in
`~/Library/LaunchAgents/com.github.zwily.turbotunnel.plist`:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http:https://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>Label</key>
<string>com.github.zwily.turbotunnel</string>
<key>ProgramArguments</key>
<array>
<string>/usr/local/bin/turbotunnel</string>
<string>-config</string>
<string>/Users/zach/.turbotunnel.yml</string>
</array>
<key>KeepAlive</key>
<true/>
<key>RunAtLoad</key>
<true/>
</dict>
</plist>
```

To start it after putting the file in place:

```bash
$ go get
$ go build
$ launchctl load ~/Library/LaunchAgents/com.github.zwily.turbotunnel.plist
```

0 comments on commit d76db89

Please sign in to comment.