Viewing docs for ngrok v0.0.24
published on Friday, Sep 29, 2023 by Piers Karsenbarg
published on Friday, Sep 29, 2023 by Piers Karsenbarg
ngrok: Installation & Configuration
I want to use the Pulumi ngrok package (ngrok) in my project.
## Provider details
- Package: ngrok
- Version: v0.0.24
- Publisher: Piers Karsenbarg
- Source: pulumi
- Repository: https://github.com/pierskarsenbarg/pulumi-ngrok
## Documentation
The Pulumi Cloud Registry API serves canonical, up-to-date docs for this package — including private packages and every published version. Send the "Accept: text/markdown" header for clean readable content, or "application/json" for structured data.
Start at the navigation tree, which cross-links to the readme, installation guide, and per-resource docs URL template:
- https://api.pulumi.com/api/registry/packages/pulumi/piers_karsenbarg/ngrok/versions/latest/nav
Returns a summary by default. The full tree can be hundreds of kB for large providers, so prefer targeted search: append "?q=<query>&depth=full" to filter by resource/function title or token (for example "?q=bucket&depth=full"). Only request the full nav without a query if you actually need to enumerate every resource.
Other endpoints:
- Overview and getting started: https://api.pulumi.com/api/registry/packages/pulumi/piers_karsenbarg/ngrok/versions/latest/readme
- Installation and configuration: https://api.pulumi.com/api/registry/packages/pulumi/piers_karsenbarg/ngrok/versions/latest/installation
- Per-resource/function docs: https://api.pulumi.com/api/registry/packages/pulumi/piers_karsenbarg/ngrok/versions/latest/docs/{token}?lang={lang}
Replace {token} with the percent-encoded token from the nav response (for example aws:s3/bucket:Bucket).
Replace {lang} with typescript, python, go, csharp, java, or yaml.
Fetch the installation endpoint above for the correct setup steps — install instructions vary between native providers, bridged Terraform providers, and component packages.
Help me get started using this provider. Show me a complete Pulumi program that provisions a common resource, including all necessary configuration and imports.
Viewing docs for ngrok v0.0.24
published on Friday, Sep 29, 2023 by Piers Karsenbarg
published on Friday, Sep 29, 2023 by Piers Karsenbarg
Installation
The Pulumi ngrok provider is available as a package from the following repositories:
- JavaScript/TypeScript:
@pierskarsenbarg/ngrok - Python:
pierskarsenbarg-pulumi-ngrok - Go:
github.com/pierskarsenbarg/pulumi-ngrok/sdk/go/ngrok - .NET:
PiersKarsenbarg.Ngrok
Setup
To provision resources with the Pulumi ngrok provider, you need to provide the apiKey.
Optionally you can specify the API URL to talk with ngrok. The default is https://api.ngrok.com.
Configuration Options
Use pulumi config set ngrok:<option> --secret.
| Option | Required/Optional | Description |
|---|---|---|
apiKey | Required | This is the ngrok API key (environment: NGROK_API_KEY). |
apiBaseUrl | Optional | The API URL used to talk with ngrok. The default is https://api.ngrok.com. (environment: NGROK_API_BASE_URL). |
You should use the
--secret flag to encrypt the config values using your secret provider. For more information on this, view the Pulumi Configuration Secrets section in the Pulumi docs.
Viewing docs for ngrok v0.0.24
published on Friday, Sep 29, 2023 by Piers Karsenbarg
published on Friday, Sep 29, 2023 by Piers Karsenbarg
