cookbook 'ngrokd', '~> 0.1.1'
ngrokd (1) Versions 0.1.1 Follow0
Installs/Configures ngrokd
cookbook 'ngrokd', '~> 0.1.1', :supermarket
knife supermarket install ngrokd
knife supermarket download ngrokd
ngrokd-cookbook
Chef cookbook to install, configure and run ngrokd.
Currently uses citadel to transfer secrets.
At this time only supports Ubuntu 14.04 - let me know if you want another platform - PRs welcome.
Attributes
Attributes and their default values:
node['ngrokd']['domain'] = nil # required. Server's domain. node['ngrokd']['path'] = '/etc/ngrokd' # path to store tls crt/key in node['ngrokd']['tlskey'] = 'tls.key' # name of tls private key on disk node['ngrokd']['tlscrt'] = 'tls.crt' # name of tls certificate on disk node['ngrokd']['log'] = '/var/log/ngrokd.log' # path for ngrok to log to. stdout and none are also valid.
node['ngrokd']['domain'] is the only setting that needs to be modified - if your domain is example.com then in DNS example.com and *.example.com should be A records for the server IP.
Secrets
A SSL certificate and matching private key are required. These are stored in an Amazon S3 bucket and retrieved via Citadel, as such IAM Roles (if running the server in EC2) or AWS credentials are required.
Bucket should also be specified. See Citadel's docs for more information.
Usage
ngrokd::default
Include ngrokd in your node's run_list:
{
"run_list": [
"recipe[ngrokd::default]"
]
}
This will install ngrokd from Ubuntu package. Download and place ssl key/crt into place.
It will create and launch an Upstart script to keep ngrokd running on boot.
Vagrant
A working Vagrantfile is included, check this to see the minimum viable now-AWS attributes required.
Contributing
- Fork the repository on Github
- Create a named feature branch (i.e.
add-new-recipe) - Write your change
- Write tests for your change (if applicable)
- Run the tests, ensuring they all pass
- Submit a Pull Request
License and Authors
Author:: Robert Coleman (github@robert.net.nz)
Dependent cookbooks
| citadel >= 0.0.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Collaborator Number Metric
0.1.1 failed this metric
Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
0.1.1 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
0.1.1 failed this metric
FC064: Ensure issues_url is set in metadata: ngrokd/metadata.rb:1
FC065: Ensure source_url is set in metadata: ngrokd/metadata.rb:1
FC066: Ensure chef_version is set in metadata: ngrokd/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
0.1.1 passed this metric
Testing File Metric
0.1.1 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
0.1.1 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
0.1.1 failed this metric
0.1.1 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
0.1.1 failed this metric
FC064: Ensure issues_url is set in metadata: ngrokd/metadata.rb:1
FC065: Ensure source_url is set in metadata: ngrokd/metadata.rb:1
FC066: Ensure chef_version is set in metadata: ngrokd/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
0.1.1 passed this metric
Testing File Metric
0.1.1 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
0.1.1 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
0.1.1 failed this metric
FC065: Ensure source_url is set in metadata: ngrokd/metadata.rb:1
FC066: Ensure chef_version is set in metadata: ngrokd/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
0.1.1 passed this metric
Testing File Metric
0.1.1 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
0.1.1 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
0.1.1 failed this metric
0.1.1 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
