◆ Altar
Docs
Installation Sacred
Tools
Sender Viewer Extractor
Dev / Sysadmin
Deploy Manage Users Backup/Transfer
GitHub
◆ Altar
GitHub

AltarDocker

Deploy your experiment data infrastructure locally with Docker Compose. MongoDB stores metadata and results, MinIO handles large raw data, and Omniboard provides a web interface to visualize experiments.

Quick start Install Source

Features

MongoDB

Store experiment metadata, configs, results, and metrics using Sacred's standard schema.

MinIO

S3-compatible object storage for large files like videos, images, and raw data.

Omniboard

Web dashboard to visualize Sacred experiments, view metrics, and download artifacts.

Quick start

1

Prepare the environment variables

cp .env.example .env
# Edit .env to customize ports, passwords, and data paths

Copy the example environment file and customize it with your preferred settings. Update MongoDB database name, MinIO credentials, host ports, and volume paths.

2

Start all services

docker compose up -d

Launch MongoDB, MinIO, and Omniboard in detached mode. All services will start with the configuration from your .env file.

3

Access the services

Open the URLs below to access each service. Default credentials are in the .env file.

Default URLs

MongoDB mongodb://localhost:27017
Omniboard http://localhost:9030
AltarExtractor http://localhost:8050
MinIO Console http://localhost:9001
MinIO S3 API http://localhost:9000

Related tools

AltarExtractor

Browse and filter Sacred experiments with a modern web UI.

Learn more →

AltarSender

Send experiments to Sacred and artifacts to MinIO.

Learn more →

AltarViewer

Desktop app to connect to your databases and open the interface to browse and visualize experiments.

Learn more →

Full Documentation

AltarDocker

Docker Compose stack for running Sacred experiment tracking infrastructure locally.

What’s Included

Service Description Port
MongoDB Stores experiment metadata 27017
MinIO S3-compatible object storage 9000, 9001

Default configuration:

  • MongoDB: localhost:27017, database: sacred
  • MinIO: S3 API localhost:9000, Console localhost:9001
    • Credentials: minio_admin / changeme123

Installation

Choose your guide based on your needs:

  • QUICKSTART-GUI.md — Easy install with Docker Desktop (no command line)
  • DEPLOY.md — Complete deployment guide with customization options
  • MANAGE_USERS.md — MongoDB and MinIO user management

Access the Services

  • MongoDB: mongodb://localhost:27017
  • MinIO Console: http://localhost:9001
  • Use with:
    • AltarSender — Upload experiments
    • AltarViewer — View experiments with Omniboard
    • AltarExtractor — Analyze and export data

For developers:

Adding MongoDB Authentication

By default, MongoDB runs without authentication. To add authentication:

  1. Add to your .env file:
    MONGO_ROOT_USER=admin
    MONGO_ROOT_PASSWORD=your_secure_password
    
  2. Update the mongo service in docker-compose.yml to use these variables:
    mongo:
      image: mongo:6
      container_name: mongo_altar
      restart: unless-stopped
      environment:
        MONGO_INITDB_ROOT_USERNAME: ${MONGO_ROOT_USER}
        MONGO_INITDB_ROOT_PASSWORD: ${MONGO_ROOT_PASSWORD}
        MONGO_INITDB_DATABASE: ${MONGO_DB}
      ports:
        - "${MONGO_PORT}:27017"
      volumes:
        - ${MONGO_DATA_PATH}:/data/db
    
  3. Recreate the container:
    docker compose down
    docker compose up -d
    

Note: After enabling authentication, you’ll need to update connection strings in AltarSender, AltarViewer, and AltarExtractor to include the username and password.

Requirements

  • Docker >= 24
  • Docker Compose v2
  • At least 2 GB free disk space

Related

  • AltarExtractor docs — Browse and filter Sacred experiments
  • AltarSender docs — GUI to send experiments to Sacred and MinIO
  • AltarViewer docs — Launch Omniboard configured for your database

License

GNU General Public License v3.0

← Back to Altar
Source · License (GPL‑3.0)