Setup in Docker

Using OctoPrint in a docker container? You need to do some slightly different config.

This step is not required if you are not using a docker container. The standard setup guide can be found here

You will still need to follow the full setup guide, this is additional.

The plugin needs access to the underlying hardware to drive the LEDs. To do this it will need to run privileged with docker.

This guide assumes you are using the official OctoPrint container and it's docker-compose.yml file.

Add the following mappings to docker-compose.yml under the volumes: section of the OctoPrint service

volumes:
 - octoprint:/octoprint

To enable access to the hardware to drive the LEDs, the container must be run privileged:

privileged: true

The final file should look something like this Gist:

The OS configuration test dialog will not pick up changes to enable SPI or set the correct core frequency without also adding these mappings to the container. You still need to configure SPI manually, as set out in the SPI Setup section