Quick Start

Get FiestaBoard running in minutes with Docker Compose.

Prerequisites

• A split-flap display you already own and have set up
• Your board's API key (Local API or Cloud Read/Write key)
• Docker and Docker Compose installed on your system

That's it. The install wizard handles the rest. Plugins that need external API keys (weather, traffic, etc.) can be configured later through the web UI.

Installation (Recommended)

Run the setup wizard — it will collect your board API key, create the configuration, and start the server:

# Mac/Linux
./scripts/install.sh

# Windows (PowerShell)
.\scripts\install.ps1

The script guides you through everything. When it finishes, FiestaBoard is running.

Access Your Dashboard

Once running, access FiestaBoard at:

Service	URL
Web UI	http://localhost:8080
API	http://localhost:8000
API Docs	http://localhost:8000/docs

Start the Display Service

1. Open http://localhost:8080 in your browser
2. Click the "▶ Start Service" button
3. Your board will start updating!

Stop FiestaBoard

docker-compose down

Getting Your Board API Key

Have your board API key ready before running the wizard.

Local API (Recommended)

1. Open the board's mobile app
2. Go to Settings → Local API
3. Copy your API key and note the board's IP address

Cloud API (Alternative)

1. Go to web.vestaboard.com
2. Navigate to the API section
3. Enable Read/Write API
4. Copy your Read/Write API key

Manual Setup (Development)

If you're setting up a development environment or prefer not to use the wizard, you can configure FiestaBoard manually:

1. Clone the repository

git clone https://github.com/Fiestaboard/FiestaBoard.git
cd FiestaBoard

2. Create your environment file

cp env.example .env

3. Edit .env with your board API key

For Local API (recommended):

BOARD_API_MODE=local
BOARD_LOCAL_API_KEY=your_local_api_key_here
BOARD_HOST=192.168.0.11
TIMEZONE=America/Los_Angeles

For Cloud API:

BOARD_API_MODE=cloud
BOARD_READ_WRITE_KEY=your_board_key_here
TIMEZONE=America/Los_Angeles

4. Start FiestaBoard

docker-compose up -d --build

5. Configure plugins in the web UI — go to the Integrations page at http://localhost:8080 to enable plugins and enter API keys.

See env.example for all available environment variables (useful for development).

Next Steps

• Configure Plugins - Enable and configure data sources via the Integrations page
• Local Development - Set up a development environment for contributing
• Create Custom Plugins - Build your own plugins