Ngrok Webhookify Plugin
This plugin lets you open ngrok tunnels on your computer with webhooks.
Installation
Install the plugin globally by running
npm i -g whfp-ngrok --unsafe-perm
You can try installing without --unsafe-perm
, but it is usually required for global installations, since the ngrok module downloads a binary.
Configuration
The plugin needs a pre-defined list of tunnel configurations, which are passed to the ngrok connect function as-is. Valid configuration keys are documented here. Global configuration keys, which are valid for all connections (but can be overridden), can also be specified.
Example:
"global": ... "tunnels": "tunnel1": ... "ssh": ... "minecraft": ...
Controlling tunnels
Tunnels can be opened or closed by sending an object like this:
If the tunnel is open or closed already, the request is simply ignored.
Getting tunnel addresses
If you perform a GET request on the endpoint you get an object which contains the status of all configured tunnels: