Laptop Setup

QuizInch runs as a web server. Installation is similar for Windows, MacOS (Apple silicon or Intel), or Linux.

Before installation

Download and install Docker Desktop. See docs.docker.com for instructions.

Install QuizInch

A basic installation requires the addition of just one file on the server.

1. Create a directory quizinch for the quiz server. On MacOS you might mkdir ~/quizinch && cd ~/quizinch, and on Windows md C:\%HOMEPATH%\QuizInch && cd C:\%HOMEPATH%\QuizInch.

2. Add docker-compose.yml to the server directory. This Docker Compose file specifies the QuizInch and MariaDB software to be downloaded from Docker Hub, the settings to run them on the host system, and essential application parameters. ⇒ Docker Setup

3. Run docker compose up -d. When issued the first time, this fetches QuizInch and MariaDB software from Docker Hub, and starts QuizInch. Then QuizInch sets up the quiz database, and creates the directory to hold media files (quizinch/media). QuizInch will be restarted automatically whenever the host system is rebooted. ⇒ Commands

4. If needed, you can customize the quiz system: ⇒ Customisation

5. Connect to your server at http://localhost/ using a web browser and view the home page for the quiz system.