> 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-guide-1.md).

# Setup Guide

I've tried to make this setup process as simple as possible, while it was already easy it is even easier with this guide.

## Installation

Install the plugin via OctoPrint's bundled [plugin manager](https://docs.octoprint.org/en/master/bundledplugins/pluginmanager.html) or manually using this URL:

```
https://github.com/cp2004/OctoPrint-WS281x_LED_Status/releases/latest/download/release.zip
```

Once you have installed and enabled the plugin, OctoPrint will prompt you to restart the server.

{% hint style="info" %}
Once the server is back up, you may have to refresh the page for in order for the wizard dialog to show up.
{% endhint %}

{% hint style="warning" %}
Using the OctoPrint Docker container? There's some [additional steps you have to follow ](/ws281x-led-status/guides/setup-in-docker.md)for this to work.
{% endhint %}

### Check you have the right hardware:

{% content-ref url="/pages/eRomwEqITIYNz2J22L8N" %}
[Supported Hardware](/ws281x-led-status/guides/setup-guide-1/supported-hardware.md)
{% endcontent-ref %}

### Next up: Wiring your LEDs

{% content-ref url="/pages/8R5XPHRNylt2459F4iIN" %}
[Wiring your LEDs](/ws281x-led-status/guides/setup-guide-1/wiring-your-leds.md)
{% endcontent-ref %}