Installation

MiniAPM can be installed in several ways depending on your needs.

Docker (Recommended)

The easiest way to run MiniAPM:

docker run -d -p 3000:3000 -v miniapm_data:/data ghcr.io/miniapm/miniapm

This command:

• Runs MiniAPM on port 3000
• Persists data in a Docker volume named miniapm_data

Docker Compose

For a more permanent setup, use Docker Compose:

docker-compose.yml

services:
  miniapm:
    image: ghcr.io/miniapm/miniapm
    ports:
      - "3000:3000"
    volumes:
      - miniapm_data:/data
    environment:
      - RETENTION_DAYS_REQUESTS=7
      - RETENTION_DAYS_ERRORS=30
      - RETENTION_DAYS_SPANS=7
    restart: unless-stopped

volumes:
  miniapm_data:

Run with:

docker compose up -d

Pre-built Binary

Download the latest release for your platform from GitHub Releases.

Linux (x86_64)

curl -L https://github.com/miniapm/miniapm/releases/latest/download/miniapm-linux-x86_64 -o miniapm
chmod +x miniapm
./miniapm server

macOS (Apple Silicon)

curl -L https://github.com/miniapm/miniapm/releases/latest/download/miniapm-darwin-arm64 -o miniapm
chmod +x miniapm
./miniapm server

macOS (Intel)

curl -L https://github.com/miniapm/miniapm/releases/latest/download/miniapm-darwin-x86_64 -o miniapm
chmod +x miniapm
./miniapm server

Building from Source

Requirements:

• Rust 1.75 or later
• SQLite development libraries

# Clone the repository
git clone https://github.com/miniapm/miniapm.git
cd miniapm

# Build release binary
cargo build --release

# Run the server
./target/release/miniapm server

Verifying Installation

After starting MiniAPM, verify it’s running:

# Health check
curl http://localhost:3000/health

# Should return:
# {"status":"ok"}

Open http://localhost:3000 in your browser to access the dashboard.

First API Key

On first run, MiniAPM generates an API key automatically:

INFO miniapm::server: Single-project mode - API key: proj_abc123...

Save this key—you’ll need it to configure your applications. The key is printed on every server start for convenience.

CLI Commands

MiniAPM provides several CLI commands:

# Start the server (default port 3000)
miniapm server

# Start on a custom port
miniapm server -p 8080

# Run database migrations
miniapm migrate

# Generate a new API key
miniapm create-key my-app

# List all API keys
miniapm list-keys

# Generate test data (for development)
miniapm simulate

# Start MCP server (for AI assistants)
miniapm mcp