OctoPrint Ngrok Tunnel

This plugin creates a secure tunnel to access OctoPrint remotely. It provides a more secure alternative to using port forwarding to expose your OctoPrint instance to the internet, while giving full and secure access to the OctoPrint web interface and the OctoPrint API. The plugin uses secure tunnels provided by ngrok. These tunnels are encrypted via SSL and Basic Authentication to prevent snooping.

Each time OctoPrint is (re-)started, the tunnel is created at a new, randomly created subdomain of ngrok.io. If you sign up for a paid account at ngrok.com, you can configure the tunnel to use a fixed subdomain.

You can always find the address of the currently active ngrok tunnel by logging in to the ngrok dashboard.

Setup

Install the plugin via the bundled Plugin Manager or manually using this URL:

https://github.com/fieldOfView/OctoPrint-ngrok/archive/master.zip

Sign up for a free or paid ngrok account.

Configuration

The Ngrok Tunnel plugin can be configured via the OctoPrint settings panel.

The ngrok auth token is used to authenticate you on the ngrok service and can be found by logging in to the ngrok dashboard. Though not strictly required for an ngrok tunnel, the plugin requires you to set up Basic Authentication on the tunnel in addition to the access control already set up on your OctoPrint instance. Any username and password combination can be chosen, but it is recommended to use a different username and password than your OctoPrint credentials. If you wish, you can use the same username and password you use for logging in to OctoPrint and have the login to the tunnel automatically log you in to OctoPrint too.

Events

This plugin fires events associated to the status of the tunnel:

• PLUGIN_NGROK_CLOSED
• PLUGIN_NGROK_CONNECTED

PLUGIN_NGROK_CONNECTED

The tunnel URL is specified as payload of the PLUGIN_NGROK_CONNECTED event inside a dictionary, under the key: 'tunnel'.

Consuming events

Third party plugings can subscribe to such events and perform actions when such events are triggered.

For example OctoPrint-IFTTT can be configured as following:

Funding

The development of this plugin can be sponsored via Github Sponsors or Paypal