Skip to content

Commit

Permalink
doc: add IP filtering to documentation and update install section
Browse files Browse the repository at this point in the history
Added IP filtering documentation to the README and added an updated
install method via wget
  • Loading branch information
kofoworola committed May 3, 2021
1 parent 65a60d5 commit e1ee065
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,22 @@ Tunnelify is a deployable proxy server and tunnel written in go


## Installing
For now, you can only install tunnelify using `go get`. To install, run:

### Direct download
You can install tunnelify by manually downloading the executable for your operating system via the releases page with:
```sh
$ wget https://github.com/kofoworola/tunnelify/releases/download/v0.1.0/tunnelify_0.1.0_mac_x86_64.tar.gz
```

Then extract it to your preferred location with:
```sh
$ tar -xf https://github.com/kofoworola/tunnelify/releases/download/v0.1.0/tunnelify_0.1.0_mac_x86_64.tar.gz
```


### Using go get
You can use go get to compile and install tunnelify directly to your `$GOPATH/bin`

```sh
$ go get github.com/kofoworola/tunnelify
```
Expand Down Expand Up @@ -33,4 +48,5 @@ change to upper case.
| `server.timeout` | duration| Amount of time the proxy will attempt to establish an outbound connection for | 30s |
| `hideIP` | boolean | Hide the IP of the source of the request | false |
| `logging` | []string | An array of file or URL paths to write logging to (logs are written to `stderr` regardless | [] |
| `allowedIP` | []string| An array of IPs that should be allowed to access the server. Nil or empty means no IP filtering will be in place | [] |

1 change: 1 addition & 0 deletions tunnelify.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ func (s *Server) Start() error {

// check if allowed
if !s.config.ShouldAllowIP(c.RemoteAddr().String()) {
c.Close()
continue
}
// read first line of the connection and use an appropriate handler
Expand Down

0 comments on commit e1ee065

Please sign in to comment.