Installation Guide

Get TheiaCast up and running in just a few minutes

Server Installation

Choose your deployment method for the TheiaCast backend and admin dashboard

Docker (Recommended)

Quick deployment using Docker Compose with pre-built images

Using Docker Compose:

# Clone the repository
git clone https://github.com/jimmyeao/TheiaCast.git
cd TheiaCast

# Configure environment
cp .env.example .env
nano .env  # Update settings

# Start all services
docker-compose -f docker-compose.prod.yml up -d

Access your installation:
Web Interface: http://localhost:5173
API: http://localhost:5001
Default Login: admin / admin123 ⚠️ Change immediately!

Client Installation

Install the client software on your display devices

Windows Client

Download Windows Installer

Requirements: Windows 10 or later, .NET 10 Runtime (auto-installed)

Interactive Installation:

.\TheiaCast-Client-Windows-Setup.exe

Silent Installation:

.TheiaCast-Client-Windows-Setup.exe /VERYSILENT \
    /ServerUrl=http://your-server:5001 \
    /DeviceId=kiosk1 \
    /DeviceToken=your-device-token

✓ Auto-starts via Task Scheduler on user login
✓ Chromium browser bundled with installer
✓ Configuration: C:\Program Files\TheiaCast\KioskClient\appsettings.json

Linux / Raspberry Pi Client

Download Linux Client

Requirements: Linux/Raspberry Pi OS, Node.js 18+ (auto-installed), Systemd, X11

Installation:

# Download latest release
wget https://github.com/jimmyeao/TheiaCast/releases/latest/download/theiacast-client-linux.tar.gz

# Extract
tar xzf theiacast-client-linux.tar.gz
cd theiacast-client

# Run installation script
sudo ./scripts/install.sh

# Verify installation
sudo systemctl status theiacast-client
sudo journalctl -u theiacast-client -f

Configuration:

# Edit configuration
sudo nano /opt/theiacast-client/.env

# Restart service
sudo systemctl restart theiacast-client

✓ Systemd service auto-start
✓ Node.js installed if missing
✓ Configuration: /opt/theiacast-client/.env

Need Help?

Check out our comprehensive documentation and getting started guide

Getting Started Guide View on GitHub