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. You can install it yourself, or alternatively simply buy one of the available

Installing OctoPi using the Raspberry Pi Imager

🤚 Before you begin

Read and follow these instructions precisely. Most importantly, leave the system username as “pi”, do not change it to anything else or OctoPrint won’t work!

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

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

3. Open advanced options by clicking on the button with the gear, or by using the keyboard shortcut ctrl+shift+x and then:

   • Configure your wifi options: Set your SSID, password and WiFi country:

   • Change the system password in “Set username and password” by entering a new password to use for the system user “pi”. 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. Leave the username as “pi”, do not change it to anything else!

   • Optionally: Change the configured timezone in “Set locale settings”

   • Optionally: Change the hostname in “Set hostname”

4. 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!

5. 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.

Alternative Initial Setup

If you decide against using the Raspberry Pi Imager, here are some alternative steps to get started:

1. Flash the image to your SD card through whatever alternative means you’ve chosen.

2. With the SD card still attached to your computer, set up the Wifi connection using the octopi-wpa-supplicant.txt file on the root of the installed card when using it like a thumb drive. Important: Do not use WordPad (Windows) or TextEdit (MacOS X) for this, those editors are known to mangle the file, making configuration fail. Use something like Notepad++, Atom or VSCode instead or at the very least heed the warnings in the file. If your computer doesn’t see the card right away after flashing, try ejecting and inserting it again. 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!

   Please also refer take a look at the full WiFi setup guide in the FAQ that also includes troubleshooting tips.

3. Plug everything into your Raspberry Pi and boot it up

4. Log into your Pi via SSH (it is located at octopi.local if your computer supports bonjour or the IP address assigned by your router), default username is pi, default password is raspberry. Run sudo raspi-config. Once that is open:

   1. Change the password via “Change User Password”
   2. Optionally: Change the configured timezone via “Localization Options” > “Timezone”.
   3. Optionally: Change the hostname via “Network Options” > “Hostname”. Your OctoPi instance will then no longer be reachable under octopi.local but rather the hostname you chose postfixed with .local, so keep that in mind.

   You can navigate in the menus using the arrow keys and Enter. To switch to selecting the buttons at the bottom use Tab.

   You do not need to expand the filesystem, current versions of OctoPi do this automatically.

   You also do not need to manually enable the RaspiCam if you have one, that is already taken care of on the image as well.

5. Access OctoPrint through http://octopi.local (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 Release Candidate

The current OctoPi Release Candidate 1.0.0rc3 can be found here:

OctoPi Nightlies

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

Further resources

• For customizing OctoPi, take a look at CustoPiZer.
• Scripts to build the image yourself can be found in OctoPi’s Github repository.

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.

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 & octoprint_install

octoprint_deploy is a guided script for creating multiple OctoPrint instances. This enables control of multiple printers on a single piece of hardware. It is compatible with OctoPi and also functions as a general Linux installer for OctoPrint, video streamers, haproxy, etc.

The related octoprint_install serves as a single instance Linux installer.

Both are 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.

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.