Scripts to build OctoPi, a Raspberry PI distro for controlling 3D printers over the web
Shell JavaScript HTML Ruby
Latest commit e12ae01 Dec 1, 2016 @guysoft committed on GitHub Merge pull request #279 from guillaumemolter/patch-1
Adding note for MacOS users using Textedit



A Raspberry Pi distribution for 3d printers. It includes the OctoPrint host software for 3d printers out of the box and mjpg-streamer with RaspiCam support for live viewing of prints and timelapse video creation. OctoPi also includes OctoPiPanel, which is an LCD display app that works with OctoPrint, and scripts to configure supported display.s This repository contains the source script to generate the distribution out of an existing Raspbian distro image.

Where to get it?

Download the latest stable build via this button:

Official mirror is here

Nightly builds are available here

How to use it?

  1. Unzip the image and install it to an sd card like any other Raspberry Pi image
  2. Configure your WiFi by editing octopi-network.txt on the root of the flashed card when using it like a thumb drive
  3. Boot the Pi from the card
  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", change the password using the passwd command and expand the filesystem of the SD card through the corresponding option when running sudo raspi-config.

OctoPrint is located at http://octopi.local and also at https://octopi.local. Since the SSL certificate is self signed (and generated upon first boot), you will get a certificate warning at the latter location, please ignore it.

If a USB webcam or the Raspberry Pi camera is detected, MJPG-streamer will be started automatically as webcam server. OctoPrint on OctoPi ships with correctly configured stream and snapshot URLs pointing at it. If necessary, you can reach it under http://octopi.local/webcam/?action=stream and SSL respectively, or directly on its configured port 8080: http://octopi.local:8080/?action=stream.

CuraEngine is installed and OctoPrint ships pre-configured with the correct path to utilize it for on-board-slicing. Just import a Cura Slicing Profile in OctoPrint's settings and start slicing directly on your Pi.


  • OctoPrint host software for 3d printers out of the box
  • Raspbian tweaked for maximum preformance for printing out of the box
  • mjpg-streamer with RaspiCam support for live viewing of prints and timelapse video creation.
  • CuraEngine pre-installed for slicing directly on the Raspberry Pi
  • OctoPiPanel, which is an LCD display app that works with OctoPrint
  • Configuration scripts for various LCD displays



  1. qemu-arm-static
  2. Downloaded Raspbian image.
  3. root privileges for chroot
  4. Bash
  5. git
  6. realpath
  7. sudo (the script itself calls it, running as root without sudo won't work)

Build OctoPi From within OctoPi / Raspbian / Debian / Ubuntu

OctoPi can be built from Debian, Ubuntu, Raspbian, or even OctoPi. Build requires about 2.5 GB of free space available. You can build it by issuing the following commands:

sudo apt-get install gawk util-linux realpath qemu-user-static git

git clone
cd OctoPi/src/image
curl -J -O -L
cd ..
sudo modprobe loop
sudo bash -x ./build

Building OctoPi Variants

OctoPi supports building variants, which are builds with changes from the main release build. An example and other variants are available in the folder src/variants/example.

To build a variant use:

sudo bash -x ./build [Variant]

Building Using Vagrant

There is a vagrant machine configuration to let build OctoPi in case your build environment behaves differently. Unless you do extra configuration, vagrant must run as root to have nfs folder sync working.

To use it:

sudo apt-get install vagrant nfs-kernel-server
sudo vagrant plugin install vagrant-nfs_guest
sudo modprobe nfs
cd OctoPi/src/vagrant
sudo vagrant up

After provisioning the machine, its also possible to run a nightly build which updates from devel using:

cd OctoPi/src/vagrant

To build a variant on the machine simply run:

cd FullPageOS/src/vagrant [Variant]


  1. If needed, override existing config settings by creating a new file src/config.local. You can override all settings found in src/config. If you need to override the path to the Raspbian image to use for building OctoPi, override the path to be used in ZIP_IMG. By default the most recent file matching * found in src/image will be used.
  2. Run src/build as root.
  3. The final image will be created at the src/workspace

Code contribution would be appreciated!