Skip to content
WeftKitBeta

Installation

WeftKit is distributed exclusively as Docker images. There is no host install, no compiler toolchain, and no package manager step — every engine ships as a self-contained OCI image that you pull and run.

Prerequisites

  • Container runtime: Docker 24+, Podman 5+, or any OCI-compatible runtime
  • Host platform: Linux (x86_64, aarch64), macOS (Apple Silicon + Intel), Windows with WSL2
  • Resources: 512 MB RAM and 1 CPU core per engine for development; see Deployment for production sizing

Available Images

Every image is published under the weftkit/ namespace. See the full Download Catalogue for ports, volumes, and one-line docker run snippets.

Database Engines

| Image | Purpose | |-------|---------| | weftkit/relational:0.1.0 | Relational engine (PostgreSQL v3 wire protocol) | | weftkit/document:0.1.0 | Document engine (MongoDB wire protocol) | | weftkit/graph:0.1.0 | Graph engine (Bolt v4+ wire protocol) | | weftkit/inmemory:0.1.0 | In-memory cache (Redis RESP3) | | weftkit/keyvalue:0.1.0 | Key-value store (DynamoDB REST) | | weftkit/vector:0.1.0 | Vector database (Pinecone-compatible gRPC) | | weftkit/markdown:0.1.0 | Markdown store (custom REST) | | weftkit/filestore:0.1.0 | File/object store (S3 REST) |

Platform Services

| Image | Purpose | |-------|---------| | weftkit/discovery:0.1.0 | Service registry with REST + gRPC + dashboard | | weftkit/gateway:0.1.0 | Multi-protocol router (TCP, gRPC, GraphQL) | | weftkit/pool:0.1.0 | Connection pool and load balancer | | weftkit/playground:0.1.0 | Web UI for query editing and exploration |

Pull a Single Image

bash
docker pull weftkit/relational:0.1.0

Run a Single Image

bash
docker run -d \
  --name weftkit-rel \
  -p 20000:20000 \
  -p 9100:9100 \
  -v weftkit-rel-data:/var/lib/weftkit/data \
  weftkit/relational:0.1.0

Common options:

  • -e WEFTKIT_DATA_DIR=/var/lib/weftkit/data — override the data directory inside the container
  • -v <named-volume>:/var/lib/weftkit/data — mount a persistent volume (required for durability)
  • -p <host>:<container> — expose the engine's wire-protocol port (see /downloads)

Pin the Version

All v0.1.0 images are tagged explicitly. We do not publish a floating latest tag — pin the exact version you intend to run:

bash
docker pull weftkit/relational:0.1.0   # pin
docker pull weftkit/relational         # NOT published

Verify the Image

bash
docker image inspect weftkit/relational:0.1.0 \
  --format '{{.Config.Labels}}'

Every image carries org.opencontainers.image.* labels with the version, build date, and component name.

Platform Notes

  • Linux — primary platform, full io_uring support inside privileged containers
  • macOS / Windows (WSL2) — supported via Docker Desktop; io_uring falls back to epoll/kqueue
  • Kubernetes — see Deployment for StatefulSet manifests

Next Steps

  • Quickstart — connect and run your first query
  • Deployment — Compose stacks, Kubernetes, and pool fronting
  • Download Catalogue — the full list of images with ports and defaults
  • License — the terms under which the images are distributed