OctoPrint

New update : Octoprint 1.5.x support

This is a Dockerfile to set up OctoPrint. It supports the following architectures automatically:

x86
arm32v6 ¹
arm32v7
arm64

Just run:

docker run sckyzo/octoprint

Now have a beer 🍻, and enjoy 😍

Tested devices

Device	Working?
Raspberry Pi 2b	✅
Raspberry Pi 3b+	✅
Raspberry Pi Zero W	✅

Please let me know if you test any others, would love to increase the compatibility list!

Usage

$ docker run \
  --device=/dev/video0 \
  -p 80:80 \
  -v /mnt/data:/data \
  sckyzo/octoprint

How to update Octoprint ?

💥 Never use octoprint's built-in update system to update Octoprint. You can however update plugins. To update Octoprint in docker mode you will need to download the new image that I will make available

With docker-compose :

docker-compose pull
docker-compose up -d

Environment Variables

Variable	Description	Default Value
CAMERA_DEV	The camera device node	`/dev/vchiq`
MJPEG_STREAMER_AUTOSTART	Start the camera automatically	`true`
MJPEG_STREAMER_INPUT	Flags to pass to mjpg_streamer	`-x 1280 -y 720 -fps 15`

CuraEngine integration

Cura engine integration was very outdated (using version 15.04.6) and was removed.

It will return once OctoPrint supports python3 (needed for the newest versions of cura engine).

Webcam integration

Raspberry Pi camera module (default)

The camera module must be activated (sudo raspi-config -> interfacing -> Camera -> set it to YES)
Memory split must be at least 128mb, 256mb recommended. (sudo raspi-config -> Advanced Options -> Memory Split -> set it to 128 or 256)
You must allow access to device: /dev/vchiq
Change MJPEG_STREAMER_INPUT to use input_raspicam.so (ex: input_raspicam.so -x 1280 -y 720 -fps 15)

For more details on the parameters of mjpeg_stream, please refer to the official documentation. For more details on the parameters of your Raspberry Pi Camera Module, please refer to the official documentation

It does support upto 1080p 30fps, but the bandwidth produced would be more than the usb bus (and therefore ethernet port / wifi dongle) can provide. 720p 15fps is a good compromise.

^{* Raspberry PI camera support is only available in arm/v6 and arm/v7 builds at the moment.}

USB Webcam

Bind the camera to the docker using --device=/dev/video0:/dev/videoX
Optionally, change MJPEG_STREAMER_INPUT to your preferred settings (ex: input_uvc.so -y -n -x 1920 -y 1080 -fps 25)

Octoprint configuration

Use the following settings in octoprint:

webcam:
  stream: /webcam/?action=stream
  snapshot: http://127.0.0.1:8080/?action=snapshot
  ffmpeg: /usr/bin/ffmpeg

Toggle the camera on/off

This image uses supervisord in order to launch 3 processes: haproxy, octoprint and mjpeg-streamer.

This means you can disable/enable the camera at will from within octoprint by editing your config.yaml:

system:
  actions:
  - action: streamon
    command: supervisorctl start mjpeg-streamer
    confirm: false
    name: Start webcam
  - action: streamoff
    command: supervisorctl stop mjpeg-streamer
    confirm: false
    name: Stop webcam

Credits

Original credits go to a2z Team. I initially ported this to the raspberry pi 2 and later moved to a multiarch image.

This repo is based on nunofgs work.

License

MIT

Todo

List of news features

Integrate Cura Engine in last version with python 3 support
Add plugins support with Docker env
Run container without root process

SckyzO/docker-octoprint