Crystal wrapper for ngrok. This library does not require ngrok be installed as it includes a downloaded which will go and fetch the version of ngrok for your system and save it locally. If you do have ngrok installed it will use the installed version.
Add this to your application's shard.yml
:
dependencies:
ngrok:
github: watzon/ngrok.cr
Ngrok.auth("your token")
Ngrok.start(addr: "127.0.0.1:3001",
subdomain: nil,
hostname: nil,
timeout: 10.seconds,
inspect: false,
region: "us",
config: nil,
use_local_executable: true,
ngrok_bin: "./bin") do |ngrok|
# `ngrok.url` contains the http url for this session
puts ngrok.url
# `ngrok.url_https` contains the https url for this session
puts ngrok.url_https
end
See the examples
directory for a couple usage examples.
- Fork it ( https://github.com/watzon/ngrok.cr/fork )
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request
- watzon Chris Watson - creator, maintainer