Docs Home
ngrok v0.0.24 published on Friday, Sep 29, 2023 by Piers Karsenbarg
ngrok: Installation & Configuration
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.