Requirements

You can find on this page the requirements to install / create your own instance of The Dojo.

Requirements changes

There is actually no change from the original requirements to install The Dojo.

Gitlab

The Dojo uses Gitlab to manage the projects. Gitlab must have the following characteristics:

  • Version 17.4 or higher with API version 4.
  • A Gitlab account
    • No project limit - All Dojo projects (assignments and exercises) are created under this account.
  • Runners: At least one runner (on x64 architecture) is required to run the pipelines. It must have the following characteristics:
    • Executor: Docker
      • Image: ubuntu:latest
      • Privileged: Yes
    • Tags:
      • dojo_assignment
      • dojo_exercise
  • The following group tree must be created from The Dojo gitlab account:
    • Dojo: Runners must be registered in this group (or be global runners)
      • Assignment
        • Deleted
      • Exercise
        • Deleted
      • Template
        • Deleted

The Dojo Backend

The Dojo backend is Docker-based. Here are the minimum requirements of the server (may vary depending on the number of users and the load):

  • CPU: 2 cores
  • Architecture: x64
  • RAM: 4 GB
  • Disk: 32 GB
  • OS: Ubuntu 22.04 LTS (tested on this platform but other Linux distributions should work)
    • Docker: 26.1 or higher
    • Docker Compose: 2.27 or higher
    • Git: 2.34 or higher

The Dojo Pipelines

A Docker Hub account is required to generate and store The Dojo pipelines images. It can be a free account as we don't use private repositories.

Two public repositories must be created:

  • dojo_assignment_checker
  • dojo_exercise_checker

The computer that generates the images can be x64 or amd64 (the resulting images are built for x64) and must have the following tools installed:

  • Docker: 26.1 or higher
  • Git: 2.34 or higher
  • jq
  • sed