Installation

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

Docker Compose (Recommended)

MiniAPM consists of two services—a collector and a dashboard—that share the same database:

docker-compose.yml

services:
  miniapm:
    image: ghcr.io/miniapm/miniapm
    command: miniapm
    ports:
      - "3000:3000"
    volumes:
      - miniapm_data:/data
    environment:
      - SQLITE_PATH=/data/miniapm.db
      - RUST_LOG=mini_apm=info
    restart: unless-stopped

  miniapm-admin:
    image: ghcr.io/miniapm/miniapm
    command: miniapm-admin
    ports:
      - "3001:3001"
    volumes:
      - miniapm_data:/data
    environment:
      - SQLITE_PATH=/data/miniapm.db
      - RUST_LOG=mini_apm_admin=info
      - ENABLE_USER_ACCOUNTS=true
      - SESSION_SECRET=change-me-to-random-string
    depends_on:
      - miniapm
    restart: unless-stopped

volumes:
  miniapm_data:

Run with:

docker compose up -d

• Collector API: http://localhost:3000
• Dashboard: http://localhost:3001

Docker (Collector Only)

If you only need the collector (no web dashboard):

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

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

macOS (Apple Silicon)

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

macOS (Intel)

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

Building from Source

Requirements:

• Rust 1.75 or later

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

# Run the collector
cargo run -p mini-apm

# Run the dashboard (in another terminal)
cargo run -p mini-apm-admin

Verifying Installation

After starting MiniAPM, verify the collector is running:

curl http://localhost:3000/health

# Should return:
# {"status":"ok","uptime_seconds":5,"db_ok":true}

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

First API Key

On first run, the collector generates an API key automatically and logs it:

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

Save this key—you’ll need it to configure your applications.

Binaries

MiniAPM ships three binaries:

# Collector server (default port 3000)
miniapm

# Collector on a custom port
miniapm -p 8080

# Admin dashboard (default port 3001)
miniapm-admin

# CLI tools
miniapm-cli create-key my-app    # Create a new API key
miniapm-cli list-keys            # List all API keys
miniapm-cli reset-password admin newpass  # Reset user password
miniapm-cli list-users           # List all users