Prerequisites

Questbee runs inside Docker — a tool that packages software so it works the same way on any computer, whether that's a laptop or a server. You also need Git to download the Questbee code, and Python 3 to run the questbee CLI tool.

You only need to do this once. Once all three are installed, follow the Getting Started guide to run Questbee.

💻

Minimum requirements: 2 CPU cores · 4 GB RAM · 10 GB free disk space. Any modern Windows, macOS, or Linux machine meets this.

1. Install Docker Desktop

Docker Desktop is a free application that installs Docker on Windows with a graphical interface. It includes everything Questbee needs.

⚠️

Windows 10/11 required. Docker Desktop needs Windows 10 version 1903 or later (64-bit). If you are on Windows 7 or 8, please upgrade first.

  1. Go to the official Docker Desktop download page:
    docs.docker.com/desktop/install/windows-install/ ↗
  2. Click Docker Desktop for Windows to download the installer (Docker Desktop Installer.exe).
  3. Run the installer. When asked, leave the default options selected and click Next through each step.
  4. When the installer asks about WSL 2, click OK — this is the recommended backend and installs automatically.
  5. After installation, click Close and restart. Your computer will restart.
  6. After restarting, Docker Desktop will open automatically. Wait for the whale icon 🐋 in the taskbar to stop animating — that means Docker is ready.
✅

You do not need to create a Docker account or sign in. Click Skip if it asks you to log in.

2. Install Git

Git is a tool for downloading and managing code. You will use it once to download Questbee.

  1. Go to the official Git for Windows download page:
    git-scm.com/download/win ↗
  2. The download starts automatically. Run the installer (Git-x.x.x-64-bit.exe).
  3. Click Next through all steps — the default options are correct for most users.
  4. On the step "Choosing the default editor" you can pick any editor. If unsure, leave the default and continue.
  5. Click Install, then Finish.

3. Install Python 3

The Questbee CLI (questbee.bat) is a Python script. Python 3 must be installed so it can run.

  1. Go to the official Python download page:
    python.org/downloads/windows/ ↗
  2. Click the big Download Python 3.x.x button.
  3. Run the installer. Important: on the first screen, check the box "Add python.exe to PATH" before clicking Install Now.
  4. Click Install Now and wait for it to complete.
  5. Click Close.
⚠️

If you forget to check "Add python.exe to PATH", Command Prompt won't find Python. Re-run the installer, choose Modify, and enable the PATH option.

1. Install Docker Desktop

Docker Desktop is a free application that installs Docker on macOS with a graphical interface.

⚠️

Check your chip. Click the Apple menu () → About This Mac. If it says Apple M1 / M2 / M3 download the Apple Silicon version. If it says Intel, download the Intel chip version.

  1. Go to the official Docker Desktop download page:
    docs.docker.com/desktop/install/mac-install/ ↗
  2. Download the correct version for your chip (Apple Silicon or Intel).
  3. Open the downloaded .dmg file. Drag the Docker icon to your Applications folder.
  4. Open Docker from Applications. macOS will ask if you want to open it — click Open.
  5. Docker will ask for your Mac password to install its components. Enter your password and click Install Helper.
  6. Wait for the whale icon 🐋 in the menu bar to stop animating — Docker is ready when it's still.
✅

You do not need to create a Docker account. Click Skip if prompted to sign in.

2. Install Git

Most Macs already have Git. Open Terminal (search for "Terminal" in Spotlight with ⌘ Space) and run:

git --version

If you see a version number (e.g. git version 2.39.3), Git is already installed — skip to the Verify section below.

If a dialog pops up asking to install Command Line Developer Tools, click Install and wait for it to finish. Git will be included.

If neither happens, install Git via Homebrew. First install Homebrew if you don't have it:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Then install Git:

brew install git

3. Install Python 3

The Questbee CLI (./questbee) is a Python script. macOS ships with Python 3 on recent versions — check first:

python3 --version

If you see a version number (e.g. Python 3.12.3), Python is already installed — you are done.

If the command is not found, install Python 3 via Homebrew:

brew install python3
✅

The ./questbee CLI will also offer to install Python automatically if it is missing when you first run it.

1. Install Docker Engine

On Linux, Docker runs as a background service (no graphical interface needed). The commands below are for Ubuntu / Debian. For other distributions, see the official guide linked at the end.

ℹ️

Open a Terminal and copy-paste these commands one at a time. You may be asked for your password — this is normal for sudo commands.

Step 1 — Remove any old versions:

sudo apt-get remove docker docker-engine docker.io containerd runc

Step 2 — Install using the official convenience script (easiest method):

curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh

Step 3 — Allow your user to run Docker without sudo:

sudo usermod -aG docker $USER
newgrp docker

Step 4 — Install Docker Compose v2 (included with recent Docker installs, but just in case):

sudo apt-get install docker-compose-plugin
🐧

Using a different Linux distribution? See the official guides:
Fedora ↗ · CentOS ↗ · RHEL ↗ · All distributions ↗

2. Install Git

Ubuntu / Debian:

sudo apt-get update && sudo apt-get install -y git

Fedora / RHEL / CentOS:

sudo dnf install -y git

3. Install Python 3

Most Linux distributions include Python 3 by default. Check first:

python3 --version

If not installed, add it:

Ubuntu / Debian:

sudo apt-get install -y python3

Fedora / RHEL / CentOS:

sudo dnf install -y python3
✅

The ./questbee CLI will also offer to install Python automatically if it is missing when you first run it.

Verify the installation

Open a Terminal (on Windows: search for "PowerShell" or "Command Prompt") and run these three commands. You should see version numbers, not errors.

Check Docker
docker --version
Check Git
git --version
Check Python (Mac / Linux)
python3 --version
Check Python (Windows)
python --version

Expected output (your version numbers may differ):

Docker version 27.3.1, build ce12230
git version 2.47.0
Python 3.12.3
⚠️

On Windows: if you just installed Docker Desktop, make sure it is open and the whale icon has stopped animating before running docker --version.

🎉

All three commands returned version numbers? You are ready. Follow the Getting Started guide to run Questbee in under 5 minutes.

Next: Getting Started →
Clone the repo, configure your environment, and run Questbee with one command.
→