Skip to content

Latest commit

 

History

History
177 lines (132 loc) · 5.64 KB

File metadata and controls

177 lines (132 loc) · 5.64 KB

ThemisDB Deployment Documentation

Date: April 5, 2026
Version: v1.8.1-rc1
Category: 🚀 Deployment
Status: Production-Ready


📑 Table of Contents

📋 Overview

ThemisDB uses an Offline-First vcpkg build strategy for reproducible deployments across all platforms.

Core Documents

  1. Deployment Strategy - Overall build & deployment strategy
  2. vcpkg Offline StrategyNEW - Offline-first build system
  3. Docker Build - Container-based deployment
  4. ARM/Raspberry Pi Build - ARM64/ARMv7 builds

🚀 Quick Start

Option 1: Docker (Recommended)

# Pull latest multi-arch image (amd64/arm64)
docker pull themisdb/themisdb:latest

# Run with data volume
docker run -d \
  -p 8080:8080 \
  -p 18765:18765 \
  -v themis_data:/data \
  themisdb/themisdb:latest

Option 2: From Source (Offline-First)

# 1. vcpkg cache setup (one-time)
./scripts/setup-vcpkg-offline.sh

# 2. Build
cmake -B build -DCMAKE_TOOLCHAIN_FILE=vcpkg/scripts/buildsystems/vcpkg.cmake
cmake --build build -j$(nproc)

# 3. Install
sudo cmake --install build

See: vcpkg Offline Strategy for details


🌍 Supported Platforms

Platform Architecture Status Docker vcpkg Offline Guide
Windows 10/11 x64 ✅ Production Build Guide
Linux (Ubuntu) x64 ✅ Production Deployment Strategy
Linux (Ubuntu) ARM64 ✅ Production ARM Build
Raspberry Pi 4/5 ARM64 ✅ Supported ARM Build
QNAP NAS x64 ✅ Supported QNAP Deployment
macOS ARM64 (M1/M2) 🚧 Planned TBD

📦 Build Variants

ThemisDB offers different build configurations for various use cases:

Minimal Build (~150 MB)

cmake -B build \
  -DTHEMIS_ENABLE_LLM=OFF \
  -DTHEMIS_BUILD_RPC_FRAMEWORK=OFF \
  -DCMAKE_BUILD_TYPE=Release

LLM Build (~250 MB)

cmake -B build \
  -DTHEMIS_ENABLE_LLM=ON \
  -DTHEMIS_CORE_SHARED=OFF \
  -DCMAKE_BUILD_TYPE=Release

Full Build (~350 MB)

cmake -B build \
  -DTHEMIS_ENABLE_LLM=ON \
  -DTHEMIS_BUILD_RPC_FRAMEWORK=ON \
  -DTHEMIS_ENABLE_GPU=ON \
  -DCMAKE_BUILD_TYPE=Release

See: Deployment Strategy for all options


🐳 Docker Deployment

# Pull latest image
docker pull themisdb/themisdb:latest

# Run with data volume
docker run -d \
  -p 8765:8765 \
  -v /data/themis:/var/lib/themis \
  themisdb/themisdb:latest

Community releases are published to Docker Hub (themisdb/themisdb) via .github/workflows/04-release_publish-community.yml.

Multi-Arch Build

# Build for multiple architectures
docker buildx build --platform linux/amd64,linux/arm64 \
  -t themisdb/themisdb:latest \
  --push .

Native Binary Deployment

# Download release
wget https://github.com/makr-code/ThemisDB/releases/latest/download/themis-linux-x86_64.tar.gz

# Extract and run
tar -xzf themis-linux-x86_64.tar.gz
./themis_server --config config.yaml

Documentation in This Directory

File Description
deployment_strategy.md Deployment strategy
deployment_arm_build.md ARM build guide
deployment_arm_benchmarks.md ARM performance
deployment_arm_packages.md ARM packages
deployment_docker_multiarch.md Multi-arch Docker
deployment_cicd_multiarch.md CI/CD pipelines
deployment_qnap.md QNAP NAS deployment
deployment_raspberry_tuning.md Raspberry Pi tuning
docker_build.md Docker build guide
docker_status.md Docker status
QNAP_CPU_COMPATIBILITY.md QNAP CPU support

Related Documentation


Note: Most detailed deployment documentation is currently available in German. English translations are in progress.
For the most up-to-date information, please refer to the German deployment documentation.

Version: 1.8.1-rc1 | License: MIT | Support: GitHub Issues