> For the complete documentation index, see [llms.txt](https://cp2004.gitbook.io/ws281x-led-status/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cp2004.gitbook.io/ws281x-led-status/guides/setup-in-docker.md).

# Setup in Docker

{% hint style="warning" %}
This step is **not required** if you are not using a docker container. The standard setup guide can be found [here](/ws281x-led-status/guides/setup-guide-1.md)

You will still need to follow the full setup guide, this is **additional.**
{% endhint %}

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

{% hint style="info" %}
This guide assumes you are using the official [OctoPrint container](https://github.com/OctoPrint/octoprint-docker) and it's `docker-compose.yml` file.
{% endhint %}

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

```yaml
volumes:
 - octoprint:/octoprint
```

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

```yaml
privileged: true
```

The final file should look something like this Gist:

{% embed url="<https://gist.github.com/cp2004/5e32b021fca66e7167039a1737fd7f21>" %}

{% hint style="warning" %}
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](/ws281x-led-status/guides/setup-guide-1/spi-setup.md)
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://cp2004.gitbook.io/ws281x-led-status/guides/setup-in-docker.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.