Quick Start

Get Marmot running in seconds with Docker Compose.

Prefer Kubernetes or a Single Binary?

Docker Compose is the fastest route, but Helm and the binary are equally supported.

Deployment Options

1. 1

   Install the prerequisites

   Docker and Docker Compose installed.

2. 2

   Create your Docker Compose file

   Create a docker-compose.yaml:

   services:
     marmot:
       image: ghcr.io/marmotdata/marmot:latest
       ports:
         - "8080:8080"
       environment:
         MARMOT_DATABASE_HOST: postgres
         MARMOT_DATABASE_PORT: 5432
         MARMOT_DATABASE_USER: marmot
         MARMOT_DATABASE_PASSWORD: marmot
         MARMOT_DATABASE_NAME: marmot
         MARMOT_DATABASE_SSLMODE: disable
         MARMOT_SERVER_ALLOW_UNENCRYPTED: true
       depends_on:
         postgres:
           condition: service_healthy
   
     postgres:
       image: postgres:16-alpine
       environment:
         POSTGRES_USER: marmot
         POSTGRES_PASSWORD: marmot
         POSTGRES_DB: marmot
       volumes:
         - marmot_data:/var/lib/postgresql/data
       healthcheck:
         test: ["CMD-SHELL", "pg_isready -U marmot"]
         interval: 5s
         timeout: 5s
         retries: 5
   
   volumes:
     marmot_data:

3. 3

   Start Marmot

   docker compose up -d

   Open http://localhost:8080 and log in with admin / admin.

Next Steps

• Add Data with PluginsAutomatically discover assets from PostgreSQL, Kafka, S3 and more
• Configure MarmotSet up authentication, customise settings and more
• Learn the Query LanguageFind any asset with powerful search queries
• Production DeploymentDeploy with Docker Compose, Kubernetes or the CLI

Need Help?

Join the Discord community to get support and connect with other Marmot users.

Join Discord(opens in a new tab)