cvat/server repository overview

⁠Quick reference

• Maintained by: cvat.ai⁠ development team

• Where to get help: Gitter⁠

• Where to file issues: https://github.com/cvat-ai/cvat/issues⁠

• Where to try CVAT online: https://app.cvat.ai⁠

• Where to find user guide: Documentation⁠

⁠What is CVAT?

Computer Vision Annotation Tool (CVAT) is a free, online, interactive video and image annotation tool for computer vision. There is CVAT annotation backend image (cvat/server).

⁠How to use this image

⁠start a cvat_server instance

docker run -p 8080:8080 --name some-cvat-server -e CVAT_POSTGRES_HOST=DB_HOST -e CVAT_REDIS_HOST=REDIS_HOST -d cvat/server
docker exec -it some-cvat-server bash -ic 'python3 ~/manage.py createsuperuser'

⁠... or via docker-compose

You can use docker-compose config file to easily run the latest CVAT release:

git clone https://github.com/cvat-ai/cvat
cd cvat
docker-compose up -d
docker exec -it cvat bash -ic 'python3 ~/manage.py createsuperuser'

⁠Exposed port

8080

⁠Environment Variables

The cvat_server image uses several environment variables. Most likely your need to specify CVAT_POSTGRES_HOST and CVAT_REDIS_HOST at least.

⁠CVAT_POSTGRES_HOST

Specifies the host to use when connecting to the Postgres database, the default is cvat_db.

⁠CVAT_POSTGRES_DBNAME

The name of the database to use. Default is cvat.

⁠CVAT_POSTGRES_USER

The username to use when connecting to the database. Default is root.

⁠CVAT_POSTGRES_PASSWORD

The password to use when connecting to the database. Default is '' (empty).

⁠CVAT_REDIS_HOST

Specifies the host to use when connecting to the Redis. Default is cvat_redis.

⁠CVAT_SERVERLESS

This optional environment variable is used in enable semi-automatic and automatic Annotation. To enable pass 1, the default is 0.

⁠CVAT_NUCLIO_HOST

This optional environment variable is used in conjunction with CVAT_SERVERLESS to set nuclio dashboard hostname. Default is nuclio

⁠CVAT_ANALYTICS

This optional environment variable is used to enable forwarding the UI and server logs to an external Logstash instance. Pass 1 to enable. The default value is 0.

⁠DJANGO_LOG_SERVER_HOST

This optional environment variable is used in conjunction with CVAT_ANALYTICS to set the hostname of the Logstash instance to which the logs will be forwarded. Default is localhost.

⁠DJANGO_LOG_SERVER_PORT

This optional environment variable is used in conjunction with CVAT_ANALYTICS to set the port of the Logstash instance to which the logs will be forwarded. Default is 5000.

⁠DJANGO_LOG_VIEWER_HOST

This optional environment variable is used in conjunction with CVAT_ANALYTICS to set the hostname of Kibana instance. No default value.

⁠DJANGO_LOG_VIEWER_PORT

This optional environment variable is used in conjunction with CVAT_ANALYTICS to set the port of Kibana instance. No default value.

⁠CLAM_AV

This optional environment variable is used to enable scanning of uploaded data with ClamAV⁠ software. Pass yes to enable. The default is no.

⁠http_proxy

⁠https_proxy

⁠no_proxy

⁠socks_proxy

These variables are used to configure proxy settings if needed.

⁠Where CVAT is store data

All uploaded data are stored by /home/django/data path inside the container. You can create a data directory on the host system (outside the container) and mount this to a directory visible from inside the container⁠.

1. Create a data directory on a suitable volume on your host system, e.g. /my/cvat_data_dir.

2. Start your cvat container like this:

$ docker run --name cvat-server -v /my/cvat_data_dir:/home/django/data -d cvat/server

The -v /my/cvat_data_dir:/home/django/data part of the command mounts the /my/cvat_data_dir directory from the underlying host system as /home/django/data inside the container, where CVAT by default will store its data files.

⁠LICENSE

LEGAL NOTICE: By accessing, downloading or using this software and any required dependent software (the “Software Package”), you agree to the terms and conditions of the software license agreements for the Software Package, which may also include notices, disclaimers, or license terms for third party software included with the Software Package. Please refer to the “third-party-programs.txt” or other similarly-named text file for additional details.

View license information⁠ for the software contained in this image.

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses and potential fees for all software contained within. We will have no indemnity or warranty coverage from suppliers.

This software uses libraries from the FFmpeg project.

FFmpeg is an open source framework licensed under LGPL and GPL. See https://www.ffmpeg.org/legal.html⁠. You are solely responsible for determining if your use of FFmpeg requires any additional licenses. CVAT.AI is not responsible for obtaining any such licenses, nor liable for any licensing fees due in connection with your use of FFmpeg.