cookbook 'ngrok', '= 1.0.10'
ngrok (9) Versions 1.0.10 Follow1
Installs/Configures ngrok
cookbook 'ngrok', '= 1.0.10', :supermarket
knife supermarket install ngrok
knife supermarket download ngrok
Description
[][https://community.opscode.com/cookbooks/ngrok]
[][http://travis-ci.org/onbeep-cookbooks/ngrok]
Installs & configures the ngrok client program. Ngrok can be used for establishing
network tunnels from the outside world to the inside world.
Requirements
Chef 11+ is required. For the latest list of supported platforms please see metadata.rb
.
Attributes
Attribute | Default | Required? | Description |
---|---|---|---|
auth_token |
'' |
Required | Authentication Token for ngrok.com |
tunnels |
{} |
Required | Dictionary of tunnel configurations. |
config_file |
/etc/ngrok.conf |
Default | Config file for ngrok client. |
download_site |
https://dl.ngrok.com |
Default | Site from which to download ngrok. |
zip_file |
ngrok.zip |
Default | Ngrok archive to download. |
http_proxy |
nil |
Optional | For running ngrok client behind a HTTP proxy. |
inspect_addr |
nil |
Optional | Change web inspection interface. |
server_addr |
nil |
Optional | Custom ngrok server (other than ngrok.com) |
trust_host_root_certs |
nil |
Optional | Trust custom server TLS connections |
For more information on these configuration Attributes, see https://ngrok.com/usage
Usage
- Create an ngrok account: http://ngrok.com
- Copy your ngrok auth_token to the
['ngrok']['auth_token']
Attribute. - Add an Attribute for the tunnels you'd like to establish. e.g.
{'webserver' => {'proto' => {'http+https' => '80'}}}
- Add the ngrok Cookbook in your Run List.
Author
Greg Albrecht gba@onbeep.com
Copyright
Copyright 2014 OnBeep, Inc.
License
Apache License, Version 2.0
See LICENSE
Dependent cookbooks
ark = 0.9.0 |
supervisor >= 0.0.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Foodcritic Metric
1.0.10 failed this metric
FC017: LWRP does not notify when updated: /tmp/cook/7f67e0bed8a4b2e6a07f90da/ngrok/providers/tunnel.rb:19
FC017: LWRP does not notify when updated: /tmp/cook/7f67e0bed8a4b2e6a07f90da/ngrok/providers/tunnel.rb:24
1.0.10 failed this metric
FC017: LWRP does not notify when updated: /tmp/cook/7f67e0bed8a4b2e6a07f90da/ngrok/providers/tunnel.rb:24