Installation

Install DB Audit

Choose your deployment method and get DB Audit running in your environment. From cloud-hosted to fully on-premise, we support your security requirements.

Choose Your Deployment Method

System Requirements

Collector Requirements

  • CPU 2 cores minimum, 4+ recommended
  • Memory 2 GB minimum, 4 GB recommended
  • Disk 10 GB for logs and cache
  • Network Outbound HTTPS (443) to api.dbaudit.ai

Supported Platforms

  • Linux (Ubuntu 20.04+, RHEL 8+, Debian 11+)
  • Windows Server 2019+
  • macOS 12+ (Monterey)
  • Docker 20.10+
  • Kubernetes 1.24+

Cloud (SaaS) Setup

Recommended

The fastest way to get started. No infrastructure to manage - just sign up and connect your databases.

  1. 1
    Create an account

    Sign up at app.dbaudit.ai/signup

  2. 2
    Add your database

    Enter connection details and credentials from the dashboard

  3. 3
    Start monitoring

    Activity appears in real-time within seconds

Get Started Free

Docker Installation

Deploy the DB Audit collector as a container for databases behind firewalls or when you need data to stay on-premise.

Quick Start

# Pull the latest collector image
docker pull dbaudit/collector:latest

# Run the collector
docker run -d \
  --name dbaudit-collector \
  --restart unless-stopped \
  -e DBAUDIT_API_KEY=your_api_key_here \
  -e DBAUDIT_ENDPOINT=https://api.dbaudit.ai \
  -v /var/lib/dbaudit:/data \
  dbaudit/collector:latest

Docker Compose

version: '3.8'
services:
  dbaudit-collector:
    image: dbaudit/collector:latest
    container_name: dbaudit-collector
    restart: unless-stopped
    environment:
      - DBAUDIT_API_KEY=your_api_key_here
      - DBAUDIT_ENDPOINT=https://api.dbaudit.ai
      - DBAUDIT_LOG_LEVEL=info
    volumes:
      - dbaudit-data:/data
    networks:
      - dbaudit-network

volumes:
  dbaudit-data:

networks:
  dbaudit-network:

Kubernetes Installation

Production-ready deployment using Helm charts with automatic scaling, health checks, and rolling updates.

# Add the DB Audit Helm repository
helm repo add dbaudit https://charts.dbaudit.ai
helm repo update

# Create namespace
kubectl create namespace dbaudit

# Create secret for API key
kubectl create secret generic dbaudit-credentials \
  --from-literal=api-key=your_api_key_here \
  -n dbaudit

# Install the collector
helm install dbaudit-collector dbaudit/collector \
  --namespace dbaudit \
  --set apiKeySecretName=dbaudit-credentials \
  --set endpoint=https://api.dbaudit.ai
Helm Values

View all configuration options with helm show values dbaudit/collector

Binary Installation

Download and run the collector binary directly on your server without containerization.

Download & Install

# Linux (amd64)
curl -LO https://releases.dbaudit.ai/collector/latest/dbaudit-collector-linux-amd64
chmod +x dbaudit-collector-linux-amd64
sudo mv dbaudit-collector-linux-amd64 /usr/local/bin/dbaudit-collector

# Configure
export DBAUDIT_API_KEY=your_api_key_here
export DBAUDIT_ENDPOINT=https://api.dbaudit.ai

# Run
dbaudit-collector --config /etc/dbaudit/config.yaml

Configuration File

# /etc/dbaudit/config.yaml
api_key: ${DBAUDIT_API_KEY}
endpoint: https://api.dbaudit.ai

collector:
  log_level: info
  buffer_size: 1000
  flush_interval: 10s

databases:
  - name: production-postgres
    type: postgresql
    host: db.example.com
    port: 5432
    ssl: true

  - name: analytics-mysql
    type: mysql
    host: mysql.example.com
    port: 3306

Systemd Service (Linux)

# /etc/systemd/system/dbaudit-collector.service
[Unit]
Description=DB Audit Collector
After=network.target

[Service]
Type=simple
User=dbaudit
ExecStart=/usr/local/bin/dbaudit-collector --config /etc/dbaudit/config.yaml
Restart=always
RestartSec=10
Environment=DBAUDIT_API_KEY=your_api_key_here

[Install]
WantedBy=multi-user.target

Enable and start the service: sudo systemctl enable --now dbaudit-collector

Verify Installation

After installation, verify the collector is running and connected:

Check collector status: docker logs dbaudit-collector
Dashboard status: Collector shows "Online" in the DB Audit dashboard
Test connection: Run a query on your database and see it in the activity feed

Need Help with Installation?

Our team can help you plan and execute your DB Audit deployment, whether cloud or on-premise.