Skip to content

README.md

Latest commit

 

History

History
154 lines (107 loc) · 4.21 KB

README.md

File metadata and controls

154 lines (107 loc) · 4.21 KB

Metabase

OCI Artifact - Deploy directly from GitHub Container Registry

Metabase is an open-source business intelligence tool that lets you create charts and dashboards using data from various databases without writing SQL.

What is an OCI Artifact?

This is a Docker Compose OCI artifact, not a traditional Docker image. It contains a complete docker-compose.yml configuration that you can deploy directly using Docker 25.0+.

Quick Start

Using bc CLI (Recommended)

# 1. Create environment file
cat > .env.metabase << 'EOF'
COMPOSE_PROJECT_NAME=metabase
SERVICE_DOMAIN=metabase.example.com
DB_PASS=Swordfish
EOF

# 2. Deploy
bc metabase up

# 3. Check status
bc metabase ps

Note: Install the bc CLI with: curl -fsSL https://raw.githubusercontent.com/beevelop/beecompose/main/scripts/install.sh | sudo bash

Manual Deployment

# 1. Create environment file
cat > .env.metabase << 'EOF'
COMPOSE_PROJECT_NAME=metabase
SERVICE_DOMAIN=metabase.example.com
DB_PASS=Swordfish
EOF

# 2. Deploy from GHCR
docker compose -f oci://ghcr.io/beevelop/metabase:latest --env-file .env.metabase up -d --pull always

# 3. Check status
docker compose -f oci://ghcr.io/beevelop/metabase:latest --env-file .env.metabase ps

Prerequisites

  • Docker 25.0+ (required for OCI artifact support)
  • Docker Compose v2.24+
  • Traefik reverse proxy (see traefik)

Dependencies

This service includes all required backing stores:

Dependency Container Purpose
PostgreSQL metabase-postgres Metabase metadata storage

See Service Dependency Graph for details.

Architecture

Container Image Purpose
metabase metabase/metabase Metabase BI application
metabase-postgres postgres:17-alpine PostgreSQL database for Metabase metadata

Environment Variables

Required

Variable Description Example
SERVICE_DOMAIN Domain for Metabase access metabase.example.com
DB_PASS PostgreSQL password Swordfish

Optional

Variable Description Default
COMPOSE_PROJECT_NAME Docker Compose project name metabase
DB_USER PostgreSQL username metabase
DB_NAME PostgreSQL database name metabase
METABASE_VERSION Metabase image tag latest
POSTGRES_TAG PostgreSQL image tag 15-alpine

Volumes

Volume Purpose
metabase_postgres_data PostgreSQL database files (stores Metabase configuration)

Post-Deployment

  1. Access Metabase: Navigate to https://metabase.example.com
  2. Setup Wizard: Complete the initial setup wizard
  3. Admin Account: Create your first admin user
  4. Add Database: Connect to your data sources (MySQL, PostgreSQL, etc.)
  5. Create Questions: Start building queries and visualizations
  6. Build Dashboards: Combine questions into dashboards

Common Operations

Using bc CLI

bc metabase logs -f     # View logs
bc metabase restart     # Restart
bc metabase down        # Stop
bc metabase update      # Pull and recreate

Using docker compose directly

# Define alias for convenience
alias dc="docker compose -f oci://ghcr.io/beevelop/metabase:latest --env-file .env.metabase"

# View logs
dc logs -f

# Restart
dc restart

# Stop
dc down

# Update
dc pull && dc up -d

Troubleshooting

Metabase slow to start

Metabase has a start_period of 60 seconds. Initial startup includes database migrations which can take time.

Cannot connect to data sources

Ensure the target database is accessible from the Metabase container. You may need to add the database to the same Docker network.

Memory issues

Metabase runs on the JVM. If you experience out-of-memory issues, consider limiting queries or increasing container resources.

Container not healthy

Check logs with dc logs metabase and ensure all required environment variables are set.

Links