raphaeljaeger/blitzquiz repository overview

⁠BlitzQuiz

BlitzQuiz is a self-hosted quiz application that can be deployed easily using Docker. It supports MySQL database connectivity and can be integrated into your existing Docker environment.

⁠Features

• Docker-ready: Easy deployment using Docker Compose.
• MySQL support: Connects to an external MySQL database.
• Configurable: Database connection settings can be configured through environment variables.
• Persistent deployment: Designed for long-running container deployments with automatic restart support.
• Customizable port: Exposes the application on port 8080 by default.

⁠Quick Start

⁠Using Docker Compose

Create a compose.yaml file with the following configuration:

services:
  quizblitz:
    image: raphaeljaeger/blitzquiz:latest
    container_name: blitzquiz
    restart: unless-stopped
    ports:
      - "8080:8080"
    environment:
      DB_HOST: "your-mysql-host"
      DB_PORT: "3306"
      DB_NAME: "quiz"
      DB_USER: "quiz"
      DB_PASSWORD: "your-secure-password"

Replace the database settings with your actual MySQL credentials and connection details.

Start the application:

docker compose up -d

Once the container is running, access BlitzQuiz at:

http://localhost:8080⁠

If Docker is running on a remote server, replace localhost with the server's IP address or hostname.

⁠Configuration

The following environment variables are available:

Note: Ensure that the MySQL server is reachable from the container and that the configured user has the necessary database permissions.

⁠Docker Image

Docker Hub: https://hub.docker.com/r/raphaeljaeger/blitzquiz⁠

Pull the latest image:

docker pull raphaeljaeger/blitzquiz:latest

⁠Updating

To update to the latest image version:

docker compose pull
docker compose up -d