Skip to content

configuration.md

Latest commit

 

History

History
51 lines (35 loc) · 1.68 KB

configuration.md

File metadata and controls

51 lines (35 loc) · 1.68 KB

Configuration Guide

Version: v1.4.1+ Status: Production Ready

VideoAnnotator supports a flexible configuration system using YAML files and environment variables.

Configuration File (configs/default.yaml)

The primary configuration file is located at configs/default.yaml. This file defines the default settings for the application, including storage, pipelines, and API behavior.

Storage Configuration

The storage section controls where job artifacts (videos, annotations, reports) are stored.

storage:
  # Root directory for persistent job storage
  # Can be absolute or relative to the workspace root
  root_path: "./storage/jobs"

  # Storage provider type (currently only 'local' is supported)
  provider: "local"

Overriding Configuration

You can override configuration values using environment variables. Environment variables take precedence over the YAML configuration.

YAML Key Environment Variable Description
storage.root_path STORAGE_ROOT Root directory for job storage

Storage Structure

When using the local storage provider, the directory structure is organized by job ID:

storage/jobs/
├── <job_id_1>/
│   ├── video.mp4          # Original video file
│   ├── results.json       # Pipeline results
│   ├── annotations.vtt    # Generated annotations
│   └── processing.log     # Job processing log
├── <job_id_2>/
│   └── ...

Advanced Configuration

For advanced use cases, you can create custom configuration files (e.g., configs/production.yaml) and load them via the CLI/config mechanisms supported by your deployment.