Connecting OctoPrint with Printoid

Printoid is really easy to use and to configure for the first time. The connection to OctoPrint requests you to provide a few parameters.

But, of course, Printoid can’t do all the magik.

You need to ensure first that your OctoPrint server is properly installed, configured, and reachable from a web browser first. Then start Printoid on your phone and let yourself be guided!

How does the app work →

CREATE YOUR FIRST OCTOPRINT PROFILE

From the onboarding screen, click on the “next” button on the bottom right of the screen.

Profile name
For a better display in the app

You can provide the name you want for this OctoPrint profile.

It will be used for informative display only, so it can be the 3D printer name or model, or whatever you want.

You can also attach a picture to this profile.

Local IP or hostname (LAN)
To reach your OctoPrint server from your local network, when you’re at home

This is the IP (or hostname) of your OctoPrint server on your local network.

This field is not mandatory if you only want to provide the public IP (or hostname)

Do not add “http://” or “https://”. Only the IP or hostname, for example something like 192.168.1.10 or myprinterhostname.ddns.net

You can use the “magnifying glass” icon to search for OctoPrint servers on your server automatically (using the UPnP service). In this case, please ensure that your device is connected to the same network as your OctoPrint server.

Some tips for you:

If you have installed the OctoPi image then you can let the Local port (optional) field empty (the default value 80 will be used since both OctoPrint and mjpeg-streamer instances will be accessible on the default HTTP port 80 thanks to the haproxy reverse proxy that is pre-configured in OctoPi)
If you have installed OctoPrint manually and not configured a reverse proxy, then you should put 5000 in the Local port field.
If you have configured OctoPrint to be reachable on another port than 5000, then put this value in the Local port field.

OctoPrint API key
The first level of security to manage which third party app can connect to your OctoPrint server

This is the private application key provided by your OctoPrint server. This field is mandatory.

You can find this value in your OctoPrint web interface > Settings > Application Key (please ensure that you are properly logged-in in your OctoPrint web interface)

Generate a new application key dedicated to your Printoid application.

Once generated, you can scan the QR code with Printoid.

OctoPrint credentials (optional)
The second layer of security, so the third party app can have all the access to your OctoPrint server

Provide the credentials of the user you’ve created on your OctoPrint server, so the application can have the full access to all your server features.

This step is optional, but please note that, if you don’t provide this information:

The Terminal feature in Printoid won’t work
The OctoPrint plugins support in Printoid won’t work well

Distant access (over the internet)
To reach your OctoPrint server from everywhere, when you’re not at home

This step is optional, but gives you multiple options to give Printoid an access to your OctoPrint server even when you’re not at home.

You can configure this option later if you want.

Option 1: OctoEverywhere
Secure connection to your OctoPrint server over the Internet with very few steps!

OctoEverywhere is a third party service, not developed by the developer of Printoid.

https://octoeverywhere.com/

The service is a “supporter level” paid service. You can paid the amount of your choice to unlock the features you really need.

A 14-days trial of the service is offered if you create your account from Printoid!

Let yourself guided by the OctoEverywhere flow.

Option 2: Public IP or hostname (WAN)
Secure connection to your OctoPrint server over the Internet for the experts

This is the public IP (or hostname) of your router over the Internet. You can find this value here if your browser is connected to the network of your rooter.

You can also let Printoid retrieving your public IP. To do that, please be sure that your device is currently connected to the same network as your OctoPrint server.

This field is not mandatory if you only want to provide the local IP (or hostname)

Do not add “http://” or “https://”. Only the IP or hostname. For example, something like 82.65.165.258 or mypublichostname.ddns.net

You can use the “magnifying glass” icon to feed this field automatically. In this case, please ensure that your device is connected to the same network as your OctoPrint server.

Please read this tutorial if you want to know how to make OctoPrint reachable over the Internet.

Security (optional)
The third level of security to connect your OctoPrint server

If your OctoPrint server is protected by a basic per-user authentication, you can enable “Use per-user credentials”.

If you have checked this last box, then please provide the correct Username and Password.

Please double check the provided values in order to prevent connection issues.

If you should use SSL to connect to your OctoPrint server, then you can enable “Use HTTPS protocol instead of HTTP”.

Please ONLY activate this step if your have configured your OctoPrint server to be connected over HTTPS (experts only – DO NOT activate this option otherwise the app will not be able to connect to your OctoPrint server at all)

SSH parameters (for custom commands)

Printoid PRO and PREMIUM allow you to send your own SSH commands to your Raspberry Pi directly from the app.

So you need to provide some informations about the SSH parameters.

The login value is the username of your session on your Raspberry Pi. Most of time (with Raspbian or OctoPi), the login is pi

The password value is the password associated to your session on your Raspberry Pi. If you have not changed the default Raspbian (or OctoPi) password, the value is raspberry

The port for the distant SSH sessions is optional. The port 22 will be used by default if you are connected to your local network.

The port value is mandatory for distant SSH commands (over the Internet). Please see this tutorial.