Quickstart

A short guide on setting up a simple CTFd with Chall-Manager setup locally with Docker.

less than a minute

Goal

In this tutorial, you will deploy a test environment containing Chall-Manager, CTFd, and the CTFd-chall-manager plugin.

Local Docker

Prerequisites

This tutorial requires the installation of Docker and Docker Compose.

Create CTF Platform

Step 1 - Start the Services

Note

The docker-compose.yml file should not be used in production as is because the architecture is not secure by default and prod-ready (certificates, HA, passwords, etc.). This installation will serve as an example in this tutorial and will give you a working base to get started with the plugin without a heavy production installation. For a “prod-ready” installation, refer to the following tools: ctfer or fullchain.

cd hack
docker compose -f docker-compose-minimal.yml up -d

Step 2 - Check All Services

Perform the CTFd configuration, then go to the plugin UI.

Admin Panel > Plugins > Chall-Manager

The Status should be reachable. If not, check your installation and the containers running on your machine; there might be a conflict.

CTFd can successfully reach Chall-Manager.

Destroy CTF Platform

When you are done, remove the CTF platform:

cd hack
docker compose -f docker-compose-minimal.yml down -v