Baradb/docs/en/installation.md

BaraDB - Installation Guide

Requirements

• Nim Compiler >= 2.2.0
• OpenSSL development headers (for TLS support)
• Operating System: Linux, macOS, Windows

Supported Platforms

OS	Architecture	Status
Linux	x86_64	✅ Fully supported
Linux	ARM64	✅ Fully supported
macOS	x86_64	✅ Fully supported
macOS	ARM64 (Apple Silicon)	✅ Fully supported
Windows	x86_64	✅ Supported
FreeBSD	x86_64	🟡 Community tested

Installing Nim

Linux

# Official installer
curl https://nim-lang.org/choosenim/init.sh -sSf | sh

# Ubuntu/Debian
sudo apt-get update
sudo apt-get install nim

# Fedora
sudo dnf install nim

# Arch Linux
sudo pacman -S nim

macOS

# Homebrew
brew install nim

# MacPorts
sudo port install nim

Windows

# Using choosenim
curl.exe -A "MSYS2_$(uname -m)" -L https://nim-lang.org/choosenim/init.ps1 | powershell -

# Using winget
winget install nim

# Using scoop
scoop install nim

Verify Installation

nim --version
# Expected: Nim Compiler Version 2.2.0 or later

Installing OpenSSL

Linux

# Ubuntu/Debian
sudo apt-get install libssl-dev

# Fedora
sudo dnf install openssl-devel

# Arch Linux
sudo pacman -S openssl

macOS

OpenSSL is included with the system. If needed:

brew install openssl

Windows

OpenSSL is bundled with the Nim Windows distribution. For manual builds, download from slproweb.com.

Building BaraDB

Clone the Repository

git clone https://github.com/katehonz/barabaDB.git
cd barabaDB

Install Dependencies

nimble install -d -y

Build Options

Debug Build

nim c -d:ssl -o:build/baradadb src/baradadb.nim

Release Build (Recommended)

nim c -d:ssl -d:release --opt:speed -o:build/baradadb src/baradadb.nim

Using Nimble Tasks

# Debug build
nimble build_debug

# Release build
nimble build_release

Strip Binary (Minimal Size)

nim c -d:ssl -d:release --opt:size -o:build/baradadb src/baradadb.nim
strip build/baradadb

Verify Build

./build/baradadb --version
# Expected: BaraDB v0.1.0 — Multimodal Database Engine

Running Tests

All Tests

nim c -d:ssl -r tests/test_all.nim

Specific Test Suites

# Storage tests
nim c -d:ssl -r tests/test_storage.nim

# Query engine tests
nim c -d:ssl -r tests/test_query.nim

# Protocol tests
nim c -d:ssl -r tests/test_protocol.nim

Benchmarks

nim c -d:ssl -d:release -r benchmarks/bench_all.nim

Installation Options

System-Wide Installation

# Build release binary
nimble build_release

# Install to /usr/local/bin
sudo cp build/baradadb /usr/local/bin/
sudo chmod +x /usr/local/bin/baradadb

# Create data directory
sudo mkdir -p /var/lib/baradb
sudo chmod 755 /var/lib/baradb

Pre-built Binary

Download the latest release for your platform:

# Linux x86_64
wget https://github.com/katehonz/barabaDB/releases/latest/download/baradadb-linux-amd64
chmod +x baradadb-linux-amd64
mv baradadb-linux-amd64 /usr/local/bin/baradadb

# Linux ARM64
wget https://github.com/katehonz/barabaDB/releases/latest/download/baradadb-linux-arm64
chmod +x baradadb-linux-arm64
mv baradadb-linux-arm64 /usr/local/bin/baradadb

# macOS
wget https://github.com/katehonz/barabaDB/releases/latest/download/baradadb-darwin-amd64
chmod +x baradadb-darwin-amd64
mv baradadb-darwin-amd64 /usr/local/bin/baradadb

Docker

# Pull official image
docker pull barabadb/barabadb:latest

# Run
docker run -d \
  -p 9472:9472 \
  -p 9470:9470 \
  -p 9471:9471 \
  -v baradb_data:/data \
  barabadb/barabadb

Docker Compose

docker-compose up -d

Embedded Usage (Nim Projects)

Add to your .nimble file:

requires "barabadb >= 0.1.0"

Use in your code:

import barabadb/storage/lsm

var db = newLSMTree("./data")
db.put("key", cast[seq[byte]]("value"))
let (found, val) = db.get("key")
db.close()

First Run

# Start server
./build/baradadb

# Expected output:
# BaraDB v0.1.0 — Multimodal Database Engine
# BaraDB TCP listening on 127.0.0.1:9472

# Test with HTTP API
curl http://localhost:9470/health

# Interactive shell
./build/baradadb --shell

Troubleshooting Installation

"cannot open file: hunos"

nimble install -d -y

"BaraDB requires SSL support"

Always compile with -d:ssl:

nim c -d:ssl -o:build/baradadb src/baradadb.nim

Slow compilation

Use parallel compilation:

nim c -d:ssl -d:release --parallelBuild:4 -o:build/baradadb src/baradadb.nim

Large binary size

Use size optimization:

nim c -d:ssl -d:release --opt:size --passL:-s -o:build/baradadb src/baradadb.nim

Next Steps

• Quick Start Guide
• Configuration Reference
• Architecture Overview
• BaraQL Query Language