One of the fastest ways to get a ngrok server running on any cloud infrastructure is too deploy this BOSH release.
To use this bosh release, first upload it to your bosh:
bosh target BOSH_HOST
git clone https://github.com/cf-platform-eng/ngrokd-boshrelease.git
cd ngrokd-boshrelease
bosh upload release releases/ngrokd/ngrokd-1.yml
Now create a deployment file using the files at the examples directory as a starting point.
ngrok
provides secure tunnels via TLS, so you'll need an SSL certificate matching your server domain in order to deploy this BOSH release
(see "How to run your own ngrokd server").
The SSL certificate (key and certificate) must be provided at the deployment manifest
If you want to use a self-signed cert then you'll need to recompile the ngrok client with your signing CA (see "ngrokd with a self-signed SSL certificate").
Using the previous created deployment manifest, now we can deploy it:
bosh deployment path/to/deployment.yml
bosh -n deploy
In the spirit of free software, everyone is encouraged to help improve this project.
Here are some ways you can contribute:
- by using alpha, beta, and prerelease versions
- by reporting bugs
- by suggesting new features
- by writing or editing documentation
- by writing specifications
- by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
- by refactoring code
- by closing issues
- by reviewing patches
We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. You can indicate support for an existing issue by voting it up. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.
- Fork the project.
- Create a topic branch.
- Implement your feature or bug fix.
- Commit and push your changes.
- Submit a pull request.
If you need to create a new final release, you will need to get read/write API credentials to the @cloudfoundry-community s3 account.
Please email Dr Nic Williams and he will create unique API credentials for you.
Create a config/private.yml
file with the following contents:
---
blobstore:
s3:
access_key_id: ACCESS
secret_access_key: PRIVATE
You can now create final releases for everyone to enjoy!
bosh create release
# test this dev release
git commit -m "updated ngrokd"
bosh create release --final
git commit -m "creating vXYZ release"
git tag vXYZ
git push origin master --tags
See LICENSE for details. Copyright (c) 2014 Pivotal Software, Inc.