Getting started

On this page you will find the first steps to run HUMAN Protocol with CVAT locally. These steps are needed only for first-time setup.

Everything you need to spin up services is located in scripts/cvat folder, so let’s make it our working directory:

cd ./scripts/cvat

---

Preparing .env files

Before you build or run any services, you need to prepare .env files and fill them with valid values. Review files in env-files folder. There are sample .env files that contain minimal set of environment variables to run services (to get the full list for some service - check its compose definition), but you have to put the actual values instead of replace_me entries. For other variables you can set your overrides if needed.

In case you don't know how to generate some values - you can check FAQ.

Once you finish - run next command:

make copy-env-files && git checkout ./env-files > /dev/null

and it will copy .env files with provided values to necessary locations.

---

Creating infra and building images

In order to make sure that all necessary infra is set up and services can be started, build the compose setup:

docker-compose -f docker-compose.local.yml \
    --env-file .env.compose.local \
    up --no-start

The step above ensures that human-cvat-bridge network (that is needed to have stable communication between HUMAN Protocol and CVAT) is created.

First-time run can take some time to build docker images for all services, don't expect it to be quick.

---

Creating network mappings

In order to easily access some links from the applications in your browser, you should create network mappings in your /etc/hosts file:

• 127.0.0.1 minio

• 127.0.0.1 cvat-lb

After you save the changes - flush the DNS cache if needed (How to clear the DNS cache on my PC?)