cookbook 'ngrok', '~> 1.0.13'
ngrok (9) Versions 1.0.13 Follow1
Installs/Configures ngrok
cookbook 'ngrok', '~> 1.0.13', :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.
Collaborator Number Metric
1.0.13 failed this metric
Failure: Cookbook has 1 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
1.0.13 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
1.0.13 failed this metric
FC064: Ensure issues_url is set in metadata: ngrok/metadata.rb:1
FC065: Ensure source_url is set in metadata: ngrok/metadata.rb:1
FC066: Ensure chef_version is set in metadata: ngrok/metadata.rb:1
FC067: Ensure at least one platform supported in metadata: ngrok/metadata.rb:1
FC069: Ensure standardized license defined in metadata: ngrok/metadata.rb:1
FC074: LWRP should use DSL to define resource's default action: ngrok/resources/tunnel.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
1.0.13 passed this metric
Testing File Metric
1.0.13 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.0.13 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.0.13 failed this metric
1.0.13 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
1.0.13 failed this metric
FC064: Ensure issues_url is set in metadata: ngrok/metadata.rb:1
FC065: Ensure source_url is set in metadata: ngrok/metadata.rb:1
FC066: Ensure chef_version is set in metadata: ngrok/metadata.rb:1
FC067: Ensure at least one platform supported in metadata: ngrok/metadata.rb:1
FC069: Ensure standardized license defined in metadata: ngrok/metadata.rb:1
FC074: LWRP should use DSL to define resource's default action: ngrok/resources/tunnel.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
1.0.13 passed this metric
Testing File Metric
1.0.13 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.0.13 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.0.13 failed this metric
FC065: Ensure source_url is set in metadata: ngrok/metadata.rb:1
FC066: Ensure chef_version is set in metadata: ngrok/metadata.rb:1
FC067: Ensure at least one platform supported in metadata: ngrok/metadata.rb:1
FC069: Ensure standardized license defined in metadata: ngrok/metadata.rb:1
FC074: LWRP should use DSL to define resource's default action: ngrok/resources/tunnel.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
1.0.13 passed this metric
Testing File Metric
1.0.13 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.0.13 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.0.13 failed this metric
1.0.13 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
