Files
Baradb/docs/en/docker.md
T
dimgigov b6cdf8c88e Add Docker deployment support with compose, entrypoint and docs
- Add Dockerfile (pre-built binary) and Dockerfile.source
- Add docker-compose.yml, docker-compose.prod.yml, docker-compose.override.yml
- Add docker-entrypoint.sh with non-root user support
- Add .dockerignore and helper scripts (scripts/docker-build.sh, scripts/docker-run.sh)
- Add docs/en/docker.md with full Docker guide
- Update docs/en/deployment.md and README.md
- Fix src/barabadb/core/config.nim to read BARADB_ADDRESS, BARADB_PORT, BARADB_DATA_DIR from env
- Fix src/barabadb/core/httpserver.nim missing wire import
2026-05-06 23:58:43 +03:00

5.2 KiB
Raw Blame History

Docker Deployment Guide

Това ръководство описва как да използвате BaraDB с Docker и Docker Compose.

Бърз старт

# Клониране на репото
git clone https://github.com/katehonz/barabaDB.git
cd barabaDB

# Build на образа
docker build -t baradb:latest .

# Стартиране с Docker Compose
docker compose up -d

# Проверка на статуса
docker compose ps
docker compose logs -f

Файлове

Файл Описание
Dockerfile Мулти-stage production build
docker-compose.yml Development конфигурация
docker-compose.prod.yml Production конфигурация
docker-compose.override.yml Development override (автоматично се зарежда)
docker-entrypoint.sh Entrypoint скрипт за инициализация
.dockerignore Файлове, които да не се копират в образа
scripts/docker-build.sh Helper скрипт за build
scripts/docker-run.sh Helper скрипт за ръчно стартиране

Създаване на образ

# Стандартен build
docker build -t baradb:latest .

# Със скрипта
./scripts/docker-build.sh

# С конкретна версия
IMAGE_NAME=baradb VERSION=0.1.0 ./scripts/docker-build.sh

Стартиране

Development (docker compose)

# Стартиране на заден план
docker compose up -d

# Спиране
docker compose down

# Спиране и изтриване на volumes (ВНИМАНИЕ — изтрива данните!)
docker compose down -v

# Преглед на логове
docker compose logs -f

Production (docker compose)

# Стартиране с production конфигурация
docker compose -f docker-compose.prod.yml up -d

# Проверка на healthcheck
docker compose -f docker-compose.prod.yml ps

Ръчно (docker run)

# Със скрипта
./scripts/docker-run.sh

# Ръчно
docker run -d \
  --name baradb \
  -p 9472:9472 \
  -p 9470:9470 \
  -p 9471:9471 \
  -v baradb_data:/data \
  -e BARADB_LOG_LEVEL=info \
  baradb:latest

Портове

Порт Описание
9472 Binary wire protocol
9912 HTTP/REST API (TCP port + 440)
9913 WebSocket (TCP port + 441)

Environment Variables

Променлива Стойност по подразбиране Описание
BARADB_ADDRESS 0.0.0.0 Адрес за слушане
BARADB_PORT 9472 Binary protocol порт
BARADB_HTTP_PORT 9470 HTTP порт
BARADB_WS_PORT 9471 WebSocket порт
BARADB_DATA_DIR /data Директория за данни
BARADB_LOG_LEVEL info Ниво на логове

Забележка: В момента приложението използва built-in стойности. Пълна поддръжка на env променливи се разработва.

Volumes

Път в контейнера Описание
/data Основна директория за базата данни
/data/server/wal Write-ahead log
/data/server/sstables SSTable файлове

Production Checklist

  • Създайте TLS сертификати в ./certs/
  • Задайте силен BARADB_JWT_SECRET
  • Настройте firewall правила
  • Конфигурирайте регулярни backups
  • Проверете resource limits
  • Настройте мониторинг (healthcheck, logs)

TLS в Docker

  1. Създайте сертификати:
mkdir -p certs
openssl req -x509 -nodes -days 365 -newkey rsa:2048 \
  -keyout certs/server.key -out certs/server.crt
  1. Активирайте в docker-compose.prod.yml:
environment:
  - BARADB_TLS_ENABLED=true
  - BARADB_CERT_FILE=/certs/server.crt
  - BARADB_KEY_FILE=/certs/server.key
volumes:
  - ./certs:/certs:ro

Backup в Docker

# Ръчен backup
docker exec baradb /app/backup backup --data-dir=/data

# Списък на backups
docker exec baradb /app/backup list

# Възстановяване
docker exec baradb /app/backup restore --input=backup_xxx.tar.gz

Troubleshooting

Контейнерът не стартира

# Проверка на логове
docker compose logs -f baradb

# Проверка на статус
docker compose ps

Няма връзка с базата

# Проверка дали портовете са експознати
docker port baradb

# Проверка отвътре
docker exec baradb wget -qO- http://localhost:9470/health

Permission denied на /data

Entrypoint скриптът автоматично създава директориите и задава правилните permissions. Ако имате проблем:

docker exec baradb ls -la /data
docker exec baradb chown -R baradb:baradb /data