Quick Start

Quick Start

Get your Lights Pi up and running in minutes.

Prerequisites

• Raspberry Pi 3B+ or Pi 4
• MicroSD card (16GB+ Class 10)
• ENTTEC DMX USB Pro (or compatible)
• WiFi network credentials

Step 1: Prepare the SD Card

Flash Raspberry Pi OS Lite to your MicroSD card using the Raspberry Pi Imager. Enable SSH and configure WiFi during the imaging process.

Step 2: Clone and Configure

git clone https://github.com/gfargo/lights-pi.git
cd lights-pi
cp .env.example .env

Edit .env with your Pi's hostname/IP and WiFi credentials:

PI_HOST=lights.local
PI_USER=pi
WIFI1_SSID=YourNetwork
WIFI1_PSK=YourPassword

Step 3: Provision

Run the full setup command to install QLC+, configure the system, and harden security:

./lightsctl.sh setup-full

This runs setup (base install) followed by harden (firewall, watchdog, unattended upgrades).

Step 4: Verify

./lightsctl.sh doctor    # Full health check
./lightsctl.sh health    # Quick status
./lightsctl.sh open-web  # Open QLC+ web UI

Next Steps

• Check the Command-Reference for all available commands
• See Hardware-Setup for DMX fixture configuration
• Visit Troubleshooting if you run into issues