Getting Started

This page shows the quickest way to run Reflog locally.

Run locally via Docker

docker pull ghcr.io/reflog-io/reflog-engine:0.1.19

Run the container (quick start)

mkdir -p data
docker run --rm \
  -p 50051:50051 \
  -v "$PWD/data:/data" \
  ghcr.io/reflog-io/reflog-engine:0.1.19

Run with reflog-docker (docker compose)

The reflog-docker repo provides a local runner that builds an image and starts the engine with sensible defaults:

• Container image (GHCR): https://github.com/reflog-io/reflog-docker/pkgs/container/reflog-engine
• Runner repo: https://github.com/reflog-io/reflog-docker

git clone https://github.com/reflog-io/reflog-docker
cd reflog-docker
docker compose up --build

Optional: custom proto

If you have a custom proto file, mount it and point the engine at it. See Custom Proto for schema structure and relationship options.

docker run --rm \
  -p 50051:50051 \
  -e REFLOG_CUSTOM_PROTO_PATH=/data/custom.proto \
  -v "$PWD/custom.proto:/data/custom.proto:ro" \
  -v "$PWD/data:/data" \
  ghcr.io/reflog-io/reflog-engine:0.1.19