Installation Guide

Maree-DB is distributed as a single self-contained binary. No runtime dependencies, no package manager, no root required to run in development mode.

System Requirements

TierCPURAMDiskUse Case
IoT / Edge1 core128 MB256 MBSensors, embedded devices, Raspberry Pi
Development2 cores512 MB2 GBLaptop development, CI runners
Production4+ cores8 GB+SSD recommendedWeb applications, APIs, microservices
Enterprise16+ cores64 GB+NVMe RAIDHigh-throughput OLTP, analytics, clustering

Supported platforms: Linux x86-64, Linux ARM64, macOS Apple Silicon, macOS Intel, Windows (WSL2).

Linux

x86-64
ARM64
IoT / Embedded
Linux x86-64
$ curl -fsSLO https://dist.mareedb.com/maree-db-v1.0.0-linux-x86_64.tar.gz
$ curl -fsSLO https://dist.mareedb.com/maree-db-v1.0.0-linux-x86_64.tar.gz.sig
$ maree-db-cli verify maree-db-1.0.0-linux-x86_64.tar.gz.sig
Ed25519 signature valid. Binary authentic.
$ tar -xzf maree-db-1.0.0-linux-x86_64.tar.gz
$ sudo mv maree-db-server maree-db-cli /usr/local/bin/
$ maree-db-server --version
Maree-DB 1.0.0 (linux-x86_64, BSL 1.1)
Linux ARM64
$ curl -fsSLO https://dist.mareedb.com/maree-db-v1.0.0-linux-aarch64.tar.gz
$ tar -xzf maree-db-1.0.0-linux-aarch64.tar.gz
$ sudo mv maree-db-server maree-db-cli /usr/local/bin/
Maree-DB 1.0.0 (linux-aarch64, BSL 1.1)
ARM64 targets: AWS Graviton, Ampere Altra, Oracle Ampere, Raspberry Pi 4/5, Rockchip RK3588, NVIDIA Jetson.
IoT build
$ curl -fsSLO https://dist.mareedb.com/maree-db-v1.0.0-linux-aarch64-iot.tar.gz
# IoT build: ~3 MB binary, 128 MB RAM minimum, no clustering features
$ maree-db-server --profile iot
Maree-DB IoT 1.0.0. Memory limit: 96 MB. Ports: 3306, 6379.

macOS

Apple Silicon
Intel
Apple Silicon (M1/M2/M3)
$ curl -fsSLO https://dist.mareedb.com/maree-db-v1.0.0-macos-aarch64.tar.gz
$ tar -xzf maree-db-1.0.0-macos-aarch64.tar.gz
$ sudo mv maree-db-server maree-db-cli /usr/local/bin/
$ maree-db-server
Ready for connections on 3306, 5432, 6379, 8080.
macOS Intel
$ curl -fsSLO https://dist.mareedb.com/maree-db-v1.0.0-macos-x86_64.tar.gz
$ tar -xzf maree-db-1.0.0-macos-x86_64.tar.gz
$ sudo mv maree-db-server maree-db-cli /usr/local/bin/

Docker

Docker
# Run with persistent volume
$ docker run -d \
--name mareedb \
-v mareedb-data:/var/lib/mareedb \
-p 3306:3306 -p 5432:5432 -p 6379:6379 -p 8080:8080 \
dist.mareedb.com/docker/mareedb:1.0.0
# With custom config
$ docker run -d \
-v /etc/mareedb/maree-db.toml:/etc/mareedb/maree-db.toml:ro \
-v mareedb-data:/var/lib/mareedb \
-p 3306:3306 -p 5432:5432 -p 6379:6379 \
dist.mareedb.com/docker/mareedb:1.0.0
Image signature: All Docker images are signed with our Ed25519 key. Verify before use: docker trust inspect dist.mareedb.com/docker/mareedb:1.0.0

Kubernetes

kubernetes/mareedb.yaml
apiVersion: apps/v1
kind: StatefulSet
metadata:
name: mareedb
spec:
replicas: 3 # 3-node BFT cluster
selector:
matchLabels:
app: mareedb
template:
spec:
containers:
- name: mareedb
image: dist.mareedb.com/docker/mareedb:1.0.0
ports:
- containerPort: 3306
- containerPort: 5432
- containerPort: 6379
- containerPort: 8080
volumeMounts:
- name: data
mountPath: /var/lib/mareedb
volumeClaimTemplates:
- metadata:
name: data
spec:
resources:
requests:
storage: 100Gi

cPanel

The Maree-DB cPanel plugin installs Maree-DB as a drop-in replacement for MySQL on cPanel/WHM servers. Existing sites continue to work without any changes — the plugin intercepts the MySQL socket and routes traffic transparently.

cPanel/WHM (root)
# curl -fsSLO https://dist.mareedb.com/maree-db-v1.0.0-cpanel-plugin.tar.gz
# /usr/local/cpanel/scripts/install_plugin mareedb-cpanel-plugin.tar.gz
Plugin installed. MySQL socket intercepted. All sites operational.
Important: The cPanel plugin requires WHM root access and Maree-DB Professional or Enterprise licence. Community and SME Free licences do not include the cPanel plugin.

systemd Service (Linux Production)

/etc/systemd/system/mareedb.service
[Unit]
Description=Maree-DB Database Server
After=network.target
[Service]
Type=notify
User=mareedb
Group=mareedb
ExecStart=/usr/local/bin/maree-db-server --config /etc/mareedb/maree-db.toml
Restart=always
RestartSec=5
LimitNOFILE=1048576
OOMScoreAdjust=-900
[Install]
WantedBy=multi-user.target
Enable service
# useradd -r -s /bin/false mareedb
# mkdir -p /var/lib/mareedb /etc/mareedb
# chown mareedb:mareedb /var/lib/mareedb
# systemctl daemon-reload
# systemctl enable --now mareedb
mareedb.service enabled and started.

Verify Installation

After installation, confirm the server is running and passes self-verification:

bash
$ maree-db-cli verify
Running 5,574 self-verification checks...
All checks passed. Maree-DB is healthy.
$ maree-db-cli status
Server : Maree-DB 1.0.0
Uptime : 42 seconds
MySQL : listening on :3306
PG : listening on :5432
Redis : listening on :6379
REST : listening on :8080
TamperLock: active, chain length 0
Status: HEALTHY