ngrokker's Introduction

ngrokker

ngrokker wraps the ngrok shell command, allowing you to programmatically create an introspective tunnel. For more information about ngrok, see https://ngrok.com.

Created for the send2phone utility.

This package is in alpha state. Contributions are welcome and encouraged!

Prerequisites

You must have ngrok installed and available on your $PATH. See https://ngrok.com/download.

Installing

This package is go getable.

go get github.com/mfresonke/ngrokker

Example Usage

Code

package main

import (
	"fmt"
	"io/ioutil"
	"net/http"

	"github.com/mfresonke/ngrokker"
)

func main() {
	// setup an introspective tunnel to port 8080
	tunnel := ngrokker.NewHTTPTunnel(true, false)
	endpoints, _ := tunnel.Open(8080)
	// don't forget to close the tunnel!
	defer tunnel.Close()

	// set up a http server to respond to requests on port 8080
	http.HandleFunc("/hello-world", func(w http.ResponseWriter, r *http.Request) {
		fmt.Fprintf(w, "Thanks, @inconshreveable!")
	})
	go func() {
		http.ListenAndServe(":8080", nil)
	}()

	// find the secure endpoint out of the two ngrok creates by default
	var secureEndpoint ngrokker.Endpoint
	for i, endpoint := range endpoints {
		fmt.Println("Endpoint", i+1, "-", endpoint.URL)
		if endpoint.Secure {
			secureEndpoint = endpoint
		}
	}

	// Make a zero-configuration https request to your own machine!
	// Notice the lack of ":8080"!
	reqURL := secureEndpoint.URL + "/hello-world"
	fmt.Println("Making request from outside world to", reqURL)
	resp, _ := http.Get(reqURL)
	defer resp.Body.Close()
	bodyBytes, _ := ioutil.ReadAll(resp.Body)
	fmt.Println(string(bodyBytes))
}

Output

Endpoint 1 - https://9545bfed.ngrok.io
Endpoint 2 - http://9545bfed.ngrok.io
Making request from outside world to https://9545bfed.ngrok.io/hello-world
Thanks, @inconshreveable!

Issues

See https://github.com/mfresonke/ngrokker/issues

Contributing

Please fork the repo, make your changes, and create a PR. Make sure you gofmt, golint, and go vet your code!

Notice

All users of ngrok MUST accept the ngrok terms of service before opening a tunnel.

ngrokker's People

Contributors

Watchers

ngrokker's Issues

ngrokker does not enable paid account behavior

With a paid ngrokker account, you can do some more things, such as open multiple instances of ngrok at the same time. Due to the fact that myself (and probably >90% of users) do not have a paid ngrok account, this was of low priority.

ngrokker uses a package variable to detect concurrent usage

This is not ideal. Ideally, we either get error feedback from ngrok itself (relatively simple, but not foolproof), or better, we search for the ngrok process and react accordingly. (doable, but is platform specific and more complex). Anyone willing to tackle this issue is welcome to do so.

ngrokker does not check ngrok version

in its current state, ngrokker does not check for the ngrok version before attempting to open the tunnel. While this should be fine for 2.X.X releases, is a definite problem if someone still has a 1.X.X release installed.

ngrokker does not properly detect an ngrok process started outside of package

if you start ngrok outside of the package (e.g. through your shell), the package does not detect this correctly, and may return an incorrect slice of Endpoints and a nil error.

While you may see some attempts in the code to do this, unfortunately it does not work. It used to work when the process was ran in a different way (using cmd.CombinedOutput IIRC), but it stopped working and I don't have the time to track down why. If anyone wants to give this a shot, by all means!

Recommend Projects

mfresonke / ngrokker Goto Github PK