Skip to main content

Quick Start Guide

Full Deployment Guide

This is a condensed summary. For detailed step-by-step instructions (including Docker installation), see the Full Deployment Guide. Make sure you meet the System Requirements first.

This guide describes how to deploy TriviaFlow on a production server.

Prerequisites​

  • A dedicated server or VPS (e.g., Debian 13).
  • Docker & Docker Compose installed.
    • apt install docker.io docker-compose-v2
  • A public domain (e.g., quiz.your-domain.com).

1. Installation​

Log in to your server and run the following commands:

# 1. Clone the repository
git clone https://github.com/your-username/triviaflow.git
cd triviaflow

# 2. Configure Environment
# Copy the example file and edit it to match your domain and secrets.
cp .env.example .env
nano .env
Important

You must configure the .env file for the application to work. See the Environment Variables guide for a detailed explanation of all settings.

2. Start the Server​

Start the application stack using Docker Compose.

Standard Start:

docker compose up -d --build

Start with Database Admin (phpMyAdmin): Use this if you configured a DB domain in your Caddyfile.

docker compose --profile admin up -d --build

3. Create Admin User​

To access the Game Master dashboard, you need a superuser account.

  1. Run the creation command: 
    docker compose exec web python manage.py createsuperuser
  2. Follow the prompts to enter a Username, Email (optional), and Password.
  3. This account will have full access to the Admin Panel and Game Master view.

4. Access the Application​

Your application should now be live at your configured domain.

ApplicationURLDescription
Lobbyhttps://quiz.your-domain.com/createCreate a new game session.
Gamemasterhttps://quiz.your-domain.com/gamemasterJoin a running game as host.
Admin Panelhttps://quiz.your-domain.com/adminCreate quizzes and manage settings.

5. Hosting Your First Game​

  1. Create Content: Log in to the Admin Panel and create a Quiz with a few questions.
  2. Open Lobby: Go to the Lobby URL (/create) on a projector or big screen. Select your quiz and click "Start Session".
  3. Join as Game Master:
    • Open /gamemaster on your smartphone.
    • Enter the Room Code displayed on the Lobby screen.
    • Login with your Superuser credentials.
  4. Players Join: Guests scan the QR code on the lobby screen to join.

Next Steps​