Getting started

Installation

Install ShrouDB Moat (all engines in one binary) or individual engines.

Homebrew

The quickest way to get Moat on macOS or Linux.

terminal

$ brew install shroudb/tap/shroudb-moat

# or install individual engines
$ brew install shroudb/tap/shroudb-sigil
$ brew install shroudb/tap/shroudb-cipher
$ brew install shroudb/tap/shroudb-keep

Docker

Official images are published on Docker Hub and ghcr.io.

terminal

$ docker run --rm -it \
    -p 8200:8200 -p 8201:8201 \
    -v $(pwd)/moat.toml:/etc/shroudb/moat.toml \
    -e SHROUDB_MASTER_KEY \
    ghcr.io/shroudb/moat:latest

docker-compose.yml

services:
  moat:
    image: ghcr.io/shroudb/moat:latest
    ports:
      - "8200:8200"
      - "8201:8201"
    volumes:
      - ./moat.toml:/etc/shroudb/moat.toml
      - moat-data:/var/lib/shroudb
    environment:
      SHROUDB_MASTER_KEY: ${SHROUDB_MASTER_KEY}

volumes:
  moat-data:

Binary download

Pre-built binaries are published on each GitHub release.

terminal

$ curl -fsSL \
    https://github.com/shroudb/moat/releases/latest/download/shroudb-moat-$(uname -s)-$(uname -m).tar.gz \
    | tar xz
$ sudo mv shroudb-moat /usr/local/bin/
$ shroudb-moat --version

Cargo (from source)

Requires Rust 1.75 or later.

terminal

$ cargo install shroudb-moat

# or individual engines
$ cargo install shroudb-sigil
$ cargo install shroudb-cipher

Verify

terminal

$ shroudb-moat --version
shroudb-moat 1.0.0

What's next

Follow the Quickstart to have Moat running with two engines in under five minutes.
Read the Architecture overview to see how engines, storage, and protocols fit together.