Plugin Configuration

This guide covers how to enable, configure, and use FiestaBoard plugins.

Enabling Plugins via the Web UI

The web UI is the recommended way to manage plugins:

1. Open http://localhost:4420
2. Go to the Integrations page
3. Toggle plugins on or off
4. Click on a plugin to open its settings (API keys, locations, preferences, etc.)
5. Settings are saved automatically and persist across restarts

tip

The Integrations page shows setup instructions for each plugin that needs an API key. You don't need to look anything up separately.

Using Plugin Data in Pages

Once a plugin is enabled, its data becomes available as template variables in the page editor.

Inserting Variables

1. Create or edit a page in the Pages section
2. Click the Variables button in the editor toolbar
3. Browse variables grouped by plugin
4. Click a variable to insert it at the cursor position

Variable Format

Variables use the format {{plugin_name.variable_name}}:

Temperature: {{weather.temperature}}
Conditions:  {{weather.condition}}

When the page is displayed on your board, these are replaced with live data (e.g., 72*F and SUNNY).

Full-Screen Variables

Some plugins provide variables that fill the entire board:

{{visual_clock.display}}    → Fills all rows with a large clock
{{sun_art.display}}         → Fills all rows with sun art

Multi-Line Variables

Some plugins provide array variables that expand into multiple lines:

{{stocks.prices}}    → Multiple rows of stock data
{{muni.formatted}}   → Multiple rows of transit arrivals

Alternative: Environment Variables

Most plugins also support configuration via environment variables in your .env file. This is useful for:

• Automated deployments where you want all config in one place
• Docker setups where .env is managed by your orchestration tool

info

Web UI settings take priority over environment variables. If a setting is configured in both places, the web UI value is used.

See the Environment Variables Reference for the full list of plugin-related variables.

Alternative: Plugin API

You can also manage plugins programmatically:

# Enable a plugin
curl -X POST http://localhost:4420/api/plugins/weather/enable

# Disable a plugin
curl -X POST http://localhost:4420/api/plugins/weather/disable

# Get plugin details and configuration
curl http://localhost:4420/api/plugins/weather

# Update plugin configuration
curl -X PUT http://localhost:4420/api/plugins/weather/config \
  -H "Content-Type: application/json" \
  -d '{"location": "San Francisco, CA"}'

# Get all available variables from a plugin
curl http://localhost:4420/api/plugins/weather/variables

# List all plugins and their status
curl http://localhost:4420/api/plugins

External Plugin API

You can install and remove external plugins through the API:

# List curated registry plugins
curl http://localhost:4420/api/plugins/registry

# Install a plugin from the registry
curl -X POST http://localhost:4420/api/plugins/registry/{plugin_id}/install

# Install a plugin from any public git repository
curl -X POST http://localhost:4420/api/plugins/install \
  -H "Content-Type: application/json" \
  -d '{"repository": "https://github.com/someone/my-plugin"}'

# Uninstall an external plugin (built-in plugins cannot be uninstalled)
curl -X DELETE http://localhost:4420/api/plugins/{plugin_id}/uninstall

Next Steps

• Plugins Overview - See all available plugins and what they need
• Page Editor - Use plugin data in your pages
• Plugin Development Guide - Create custom plugins