Download & Setup OctoPrint

OctoPi

Guy Sheffer maintains “OctoPi”, a Raspbian (and thus Debian) based SD card image for the Raspberry Pi that already includes OctoPrint plus everything you need to run it:

  • OctoPrint plus its dependencies
  • MJPG-Streamer for live viewing of prints and timelapse video creation, compatible with various USB webcams and the Raspberry Pi camera

Recommended hardware: Raspberry Pi 3B, 3B+, 4B or Zero 2. Expect print artifacts and long loading times with other options, especially when adding a webcam or installing third party plugins. Setups not using recommended hardware are not officially supported.

Please note that the Raspberry Pi Zero and Zero W are not recommended explicitly since severe performance issues were observed, caused by the WiFi interface when bandwidth is utilized (e.g. the webcam is streamed), negatively impacting printing quality. See also here. The Zero 2 however is recommended.

Installing OctoPi

OctoPi is available through the Raspberry Pi Imager, which you can use to download and setup OctoPi.

Step 1

Download & install Raspberry Pi Imager

If you haven’t already, download and install Raspberry Pi Imager on your computer

Step 2

Select your device

Chose your Raspberry Pi Model.

Step 3

Locate the OctoPi Image

Find the OctoPi image under “Choose OS”, by selecting “Other Specific Purpose OS” > “3D printing” > “OctoPi” and then the “stable” version.

Raspberry Pi Imager OS selection screen, showing “OctoPi stable” as option

Step 4

Storage selection

Select your SD card from the storage list.

Step 5

Customize the image

The following steps allow you to customize various aspects of the image:

  • Enter the hostname of your choice. If unsure, set it to octopi.

    Raspberry Pi Imager Customisation: Hostname

  • Configure your Localisation options. You should at least select the right time zone and country (via “National Capital”).

    Raspberry Pi Imager Customisation: Localisation

  • Enter User details for the system login. If unsure, leave the user as pi, but be sure to set a new password. This is not the password you’ll use for logging into OctoPrint but one that you’ll have to use to log into your Pi via SSH should you ever need to. Make sure to note it down!

    Raspberry Pi Imager Customisation: User

  • Enter Wi-Fi details. Set your SSID and password.

    Raspberry Pi Imager Customisation: Wi-Fi

  • Enable SSH under Remote Access. This is useful for troubleshooting and installing system level requirements/dependencies as necessary.

    Raspberry Pi Imager Customisation: Remote access

Step 6

Flash your SD card

Install the image to your SD card, then plug everything in to your Raspberry Pi and boot it up. Do not format the SD card after installing, even if prompted to do so. This will break the installation and you will have to start over!

Step 7

Boot your Raspberry Pi

Plug the SD card into your Raspberry Pi and power it up. The first boot will take a while, be patient.

Step 8

Access OctoPrint

Once your Pi has booted up, access OctoPrint from your browser via http://octopi.local or the hostname you chose (if your computer supports bonjour) or http://<your pi's ip address>. https is available too, with a self-signed certificate (which means your browser will warn you about it being invalid - it isn’t, it’s just not recognized by your browser).

Please also refer to OctoPi’s README, especially the “How to use it” section.

Image Downloads

Raspberry Pi Imager will download the latest version of OctoPi for you, but if you want to download the images yourself you can do so here.

Stable OctoPi

OctoPi 1.1.0 & OctoPrint 2.0.0

SHA256: 5561a55788ed079439d2a27792602b49a244d609e9e4e6fe801bfe517b38e645
Image compatible with Raspberry Pi 1A, 1A+, 1B, 1B+, 2B, 3A+, 3B, 3B+, 4B 1/2/4/8GB, 5B 4/8GB, Zero, Zero W, Zero 2 and 400. Raspberry Pi 3B, 3B+, 4B or Zero 2 strongly recommended, Raspberry Pi Zero/Zero W not officially supported!

OctoPi Nightlies

You can also get the 32bit nightlies here or the 64bit nightlies here.

Further resources

Octo4a

Filip Grzywok maintains “Octo4a”, an Android app that allows you to use an Android based smart phone as an OctoPrint host. Root is not required!

Check out the Octo4a README for information on how to obtain the app, install and run it.

Video

There’s also a video guide on how to get Octo4a up and running by Thomas Sanladerer.

This video uses YouTube’s privacy-enhanced mode. YouTube may still store and/or gain access to cookies and/or local storage on your device.

OctoPrint for Orange Pi

The people at Obico maintain an image suitable for use with the Orange Pi Zero 2 and the Orange Pi 3. You can find it here. Please report issues to Obico.

Docker

There’s also an official OctoPrint Docker image, octoprint/octoprint. It is maintained by Brian Vanderbush and team on GitHub.

Please refer to its entry on dockerhub for more details on usage and configuration.

octoprint_deploy (Linux)

octoprint_deploy is a guided script for installing OctoPrint and additional tools (video streamer, haproxy) on virtually any Linux system. It guides the user through creation of one or more OctoPrint instances. Creating multiple instances with the script allows control of multiple printers on a single piece of hardware. A variety of utilities improve the multi-instance experience, including automated creation of udev rules, syncing users between instances, and sharing file uploads between instances. It is compatible with OctoPi.

Maintained by Paul Paukstelis.

Windows Installer

OctoPrint-WindowsInstaller is a Windows installation wizard for OctoPrint. It is maintained by jneilliii. Please report issues here.

Installing manually

The generic setup instructions boil down to

  1. Installing Python 3, including pip.
  2. Creating a virtual environment somewhere: python -m venv OctoPrint
  3. Installing OctoPrint into that virtual environment: OctoPrint/bin/pip install OctoPrint
  4. OctoPrint may then be started through ./OctoPrint/bin/octoprint serve or with an absolute path /path/to/OctoPrint/bin/octoprint serve

More specific setup instructions for the most common runtime environments can be found below.

Linux

For installing OctoPrint on Linux, please take a look at the setup instructions for Raspbian on the forum. They should be pretty much identical on other Linux distributions. See octoprint_install & octoprint_deploy (Linux) above for simplified scripted options.

Windows

For installing the OctoPrint server on a Windows system, please take a look at the setup instructions for Windows on the forum.

Mac

For installing the OctoPrint server on a Mac, please take a look at the setup instructions for MacOS on the forum.