Skip to content

Using Docker Compose

About this guide

This guide will explain how to deploy TAO Community Edition using Docker Compose.

We will assume you already have Docker Compose installed. If you need to install it, please follow instructions from its documentation.

Requirements

  • At least 4 CPU cores1
  • At least 8GB RAM
  • At least 20GB free disk space2

Installation

You can install TAO Community Edition with Docker Compose with one of the following methods:

Get Compose file

Docker Compose need a template file, usually called docker-compose.yml. This file is available for TAO Community Edition as two formats:

Download docker-compose.yml file 

curl -LO \
  https://github.com/tao-ce/tao-ce/releases/latest/download/docker-compose.yml

Clone tao-ce/tao-ce repository 

git clone https://github.com/tao-ce/tao-ce
cd tao-ce

Deploy TAO Community Edition

Run the following command 

docker compose up -d

In the next minutes, Docker Compose will:

  • download and start dependencies containers
  • download and unpack tao-ce container image
  • start tao container

Check installation

Under construction

TAO Community Edition is still in active development, and there is no evident method now to confirm readiness status.

However, you can connect to container console and browse logs.

Uninstallation

Be careful

This operation will remove all data (including users, tests and results).

If you are sure to remove TAO Community Edition, you may run the following command:

docker compose down -v

-v flag will ensure all data from volumes are removed. If this flag is skipped, TAO Community Edition may fail to re-install, as some volumes contains semaphores which could prevent complete installation to run.

Reinstallation

Be careful

This operation will remove all data (including users, tests and results).

If you are sure to reinstall TAO Community Edition, you may run the following command:

docker compose down -v
docker compose up -d

What's next?

  • As TAO Community Edition has been successfully installed on your system, you can now proceed with Preparation steps.
  • You can also explore Configuration guide and check additional settings.

  1. aarch64/arm64 or x86_64/amd64 architectures are supported ↩

  2. Additionally, ensure to always have at least 10% of free disk on your system. ↩