Skip to content

Installation

Quickstart

No git clone, no configuration file.

Terminal
curl -LO https://raw.githubusercontent.com/depictio/depictio/main/docker-compose.yaml # (1)!
docker compose up -d # (2)!
  1. Downloads the single compose file — nothing else needed locally.
  2. Starts all six services in the background: MongoDB, Redis, MinIO, backend API, frontend, and Celery worker.

Open Depictio

Service URL Notes
Depictio localhost:5080 Single-user mode — no login required
API docs localhost:8058/docs Interactive OpenAPI interface
MinIO console localhost:9001 minio / minio123

  • Customise credentials

    Copy .env.example to .env to change the MinIO password or switch to multi-user mode.

    Advanced configuration

  • Multi-user or public mode?

    Set DEPICTIO_AUTH_SINGLE_USER_MODE=false in .env to enable accounts and login.

    Authentication modes

Server Deployment

  • Docker Compose

    The recommended way to run Depictio. MinIO is bundled — one command starts everything.

    Ideal for development, testing, and small-scale deployments.

    Installation guide

  • Kubernetes

    Deploy Depictio on a Kubernetes cluster using the official Helm chart.

    Ideal for production environments and scalable deployments.

    Installation guide

CLI & Configuration

  • Depictio CLI

    Command-line tool for data ingestion, project management, and interacting with the Depictio API.

    CLI guide

  • Configuration

    Configure authentication, S3/MinIO, backups, and advanced features via environment variables.

    Configuration guide

  • Try in GitHub Codespaces

    Launch a temporary cloud workspace with Depictio pre-configured — no local setup required.

    Open in Codespaces