luzifer/expose
1
0
Fork 0
mirror of https://github.com/Luzifer/expose.git synced 2024-09-19 15:42:57 +00:00
Code Issues Releases Wiki Activity
1d35b0988e
expose/README.md
Knut Ahlers 1d35b0988e
Initial version 
Signed-off-by: Knut Ahlers <knut@ahlers.me>
2017-04-14 02:45:38 +02:00

1.4 KiB
Raw Blame History

Luzifer / expose

expose is a small CLI utility to control a running ngrok 2 daemon.

Use cases

  • Quickly open a local port to demonstrate something to someone 
    # expose create 4000
Created tunnel to address "localhost:4000" with URL https://8d35e4bf.eu.ngrok.io
  • Close that port again 
    # go run *.go delete 4000
Successfully closed tunnel "expose_4000" to address "localhost:4000".
  • Quickly share a folder with files through HTTP 
    # go run *.go serve
Created HTTP server for this directory with URL https://81e668af.eu.ngrok.io
Press Ctrl+C to stop server and tunnel
  • List the active tunnels in a nice table 
    # go run *.go list
     NAME     | TYPE  |    ADDRESS     |          PUBLIC URL
+-------------+-------+----------------+------------------------------+
  expose_3000 | https | localhost:3000 | https://9c8d36d6.eu.ngrok.io

How to set up

  • Download the latest release of ngrok 2
  • Configure ngrok (see the official documentation for that!)
    • For this to work you only need an authtoken set in ~/.ngrok2/ngrok.yml
  • Set it up to start automatically (see docs/ngrok.service for a systemd service file)
  • Download the latest release of this tool