search

fieldOfView / OctoPrint-ngrok

An OctoPrint Plugin that provides remote access using ngrok
GNU Affero General Public License v3.0
15 stars 8 forks source link

Easy access to random tunnels #7

Closed theely closed 4 years ago

theely commented 4 years ago

Thanks a lot for the plug-in, awesome idea! Have you thought about an easy way to retrieve the randomly generated tunnel address on external devices? For example would it be possible to push the tunnel address somewhere? Could be as simple as sending an email.

fieldOfView commented 4 years ago

Thought about it, yes. Decided on how to do it: not yet ;-)

The tunnel address is already available through https://dashboard.ngrok.com/status/tunnels. The easier I make the access to the tunnel address, the less secure everything gets. Also, once I have implemented one way (eg email, as you suggest), people will want their preferred way added (eg push to telegram, some SMS service, etc). That would become a maintenance nightmare, and introduce many opportunities to leak the tunnel address.

If you get a paid ngrok account (I have no affiliation with them, I swear!), you can get a fixed tunnel address.

theely commented 4 years ago

Alternatively you could trigger an event when a new tunnel is established. There are several plugins that allow to perform action on events:

fieldOfView commented 4 years ago

Yes, I could fire a custom event when a tunnel is established. However, out of the plugins you listed, I think only IFTTT supports custom events directly. And it is still a bit akin to installing a fancy lock on your frontdoor and telling all your housemates - whom you know can't keep a secret - how to duplicate the key. But I'll add a custom event in a future version; good suggestion.

fieldOfView commented 4 years ago

The ~master~ devel branch now fires the plugin_ngrok_connected event when the plugin creates a tunnel, and the plugin_ngrok_closed event when a tunnel is closed.

fieldOfView commented 4 years ago

Please help testing the fix by installing the current development version via OctoPrint Settings -> Plugin Manager -> Get more -> ... from URL with the following url: https://github.com/fieldOfView/OctoPrint-ngrok/archive/devel.zip