Docker installation

Ctfreak provides automatically updated Docker images within the JYP Software Docker Hub organization.

System requirements

Docker Engine
Docker Compose
AMD64 architecture
An internet connection

Installing

To install Ctfreak as a service, we will rely on docker-compose command.

Create a docker-compose.yml file with the following content (adapt timezone, port mapping or replace ./ctfreak-data with another folder according to your needs):

version: "3.5"
services:
  ctfreak:
    image: jypsoftware/ctfreak
    container_name: ctfreak
    environment:
      - TZ=Europe/Paris # Set timezone used to schedule your tasks
    ports:
      - "6700:6700"
    volumes:
      - ./ctfreak-data:/data # Where to store all ctfreak data (logs, embedded database, config)
    restart: "unless-stopped"

Then while in the same folder as the docker-compose.yml run:

$ docker-compose up -d

Navigate to http://localhost:6700.

To complete this installation, we encourage you to configure a reverse proxy.

Uninstall

Execute:

$ docker-compose stop
$ docker-compose rm

Upgrading

Execute:

$ docker-compose pull
$ docker-compose up -d

Backup and restore

Configuration file, embedded database, log files are all saved into Ctfreak volume ./ctfreak-data.