Skip to main content
Version: 4.3

Production Deployment

Best practices for deploying FiestaBoard in a production environment.

Docker Compose for Production​

Use the production-optimized Docker Compose file:

docker-compose -f docker-compose.prod.yml up -d --build

Or use pre-built images from Docker Hub:

docker-compose -f docker-compose.hub.yml up -d

Environment Variables​

# In .env
REFRESH_INTERVAL_SECONDS=300   # Refresh every 5 minutes (default)
SILENCE_SCHEDULE_START_TIME=22:00       # Set quiet hours
SILENCE_SCHEDULE_END_TIME=07:00

Data Backup​

FiestaBoard stores all persistent state in two directories on the host:

DirectoryContents
data/Config, pages, schedules, carousels, settings, logs, and migration backups
external_plugins/Marketplace plugins installed via the Integrations page

Both directories are automatically bind-mounted by Docker Compose. Back up both to fully preserve your setup:

# One-shot backup (run from the directory containing your docker-compose file)
tar -czf fiestaboard-backup-$(date +%Y%m%d).tar.gz data/ external_plugins/

# Automated daily backup via cron (runs at 2 AM)
0 2 * * * tar -czf /backups/fiestaboard-$(date +\%Y\%m\%d).tar.gz /path/to/FiestaBoard/data/ /path/to/FiestaBoard/external_plugins/

Restore from backup:

# Stop the container before restoring
docker-compose down

# Extract the backup (overwrites existing data/ and external_plugins/)
tar -xzf fiestaboard-backup-20240101.tar.gz

# Start again — all pages, settings, and plugins are restored
docker-compose up -d
What each file contains
  • data/config.json — Board API key and connection settings
  • data/settings.json — Display preferences, active page, schedule
  • data/pages.json — All board pages
  • data/schedules.json / data/carousels.json — Automation rules
  • data/*.backup — Automatic pre-migration snapshots (safe to delete after confirming an upgrade works)

Updating​

# Pull latest changes
git pull

# Rebuild and restart
docker-compose -f docker-compose.prod.yml down
docker-compose -f docker-compose.prod.yml up -d --build
Zero-Downtime Updates

Pull the latest code and rebuild the images first, then bring down the old containers and start the new ones. The downtime is minimal, just a few seconds while containers swap.

Monitoring​

Health Checks​

FiestaBoard provides a health endpoint:

curl http://localhost:4420/api/health

You can use this with monitoring tools like Uptime Kuma or Healthchecks.io.

Logs​

# View all logs
docker-compose logs -f

# View FiestaBoard container logs only
docker-compose logs -f fiestaboard

Security Considerations​

  • Never commit .env files to version control
  • Restrict API access - The API has no authentication by default
  • Use a reverse proxy - For external access, put FiestaBoard behind Nginx or Traefik with HTTPS
  • Keep Docker updated - Regularly update Docker and Docker Compose

Running Behind a Reverse Proxy​

If you want to access FiestaBoard from outside your local network, use a reverse proxy with HTTPS:

server {
    listen 443 ssl;
    server_name fiestaboard.yourdomain.com;

    ssl_certificate /path/to/cert.pem;
    ssl_certificate_key /path/to/key.pem;

    location / {
        proxy_pass http://localhost:4420;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

Next Steps​