luzifer/expose
1
0
Fork 0
mirror of https://github.com/Luzifer/expose.git synced 2024-11-08 14:20:04 +00:00
Code Issues Releases Wiki Activity
expose is a small CLI utility to control a running ngrok 2 daemon.
18 commits 1 branch 8 tags 253 KiB
Go 99.3%
Makefile 0.7%
Find a file
Knut Ahlers 0b9ff9c731
Add auto-close for serve command 
Signed-off-by: Knut Ahlers <knut@ahlers.me>
2018-10-15 21:24:17 +02:00
cmd Add auto-close for serve command 2018-10-15 21:24:17 +02:00
docs Initial version 2017-04-14 02:45:38 +02:00
ngrok2 Initial version 2017-04-14 02:45:38 +02:00
vendor Switch to dep for vendoring 2018-09-17 21:32:52 +02:00
.gitignore Initial version 2017-04-14 02:45:38 +02:00
.repo-runner.yaml Update reporunner image 2018-10-15 21:14:59 +02:00
CONTRIBUTING.md Initial version 2017-04-14 02:45:38 +02:00
Gopkg.lock Switch to dep for vendoring 2018-09-17 21:32:52 +02:00
Gopkg.toml Switch to dep for vendoring 2018-09-17 21:32:52 +02:00
History.md prepare release v0.4.0 2018-10-15 21:13:54 +02:00
LICENSE Fix license file 2018-09-17 21:33:47 +02:00
main.go Initial version 2017-04-14 02:45:38 +02:00
Makefile Add github release build 2017-04-14 02:47:17 +02:00
README.md Add buttons to README 2018-09-17 21:35:03 +02:00

README.md

Go Report Card

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 
    # expose delete 4000
Successfully closed tunnel "expose_4000" to address "localhost:4000".
  • Quickly share a folder with files through HTTP 
    # expose 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 
    # expose 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