Getting Started

Installation

Deploy Vouchstone to your infrastructure using Docker, Kubernetes, or cloud-native deployments.

System Requirements

Control Plane (SaaS)

The Control Plane is hosted by Vouchstone - no installation required.

Data Plane Requirements

Kubernetes 1.24+ or Docker 20.10+
4 CPU cores minimum (8+ recommended)
16 GB RAM minimum (32+ recommended)
100 GB SSD storage
PostgreSQL 16+
Redis 7+

Docker Installation

# Clone the repository (self-hosted customers get access as part of onboarding)
git clone https://github.com/GGChamp85/Vouchstone.git
cd Vouchstone

# Copy environment template
cp .env.example .env

# Edit configuration
nano .env

# Start all services
docker-compose up -d

# Check status
./scripts/health-check.sh

Kubernetes (Helm)

The Data Plane's Helm chart (data-plane/helm-charts/vouchstone-runtime) is a chart directory in the repo, not published to a hosted Helm repository -- install directly from a local checkout:

git clone https://github.com/GGChamp85/Vouchstone.git
cd Vouchstone/data-plane/helm-charts/vouchstone-runtime

helm install vouchstone-runtime . \
  --namespace vouchstone \
  --create-namespace \
  --set vouchstone.controlPlane.url=https://your-control-plane-host.example.com \
  --set vouchstone.controlPlane.apiKey=YOUR_API_KEY \
  --set vouchstone.tenantId=YOUR_TENANT_ID

replicaCount stays at 1 by default -- Episodic/Meta-Memory and the execution store are still per-pod state, so a second replica can silently diverge. See the chart's values.yaml comments before scaling out.

Cloud Deployments

Terraform under deployments/ provisions the infrastructure each cloud needs (VPC, managed Postgres/Redis, and either ECS Fargate, GKE, or AKS for the containers) -- one apply per cloud, from that cloud's own directory.

AWS

VPC, RDS, ElastiCache, ECS Fargate

cd deployments/aws/terraform
terraform init && terraform apply

GCP

VPC, Cloud SQL, Memorystore, GKE

cd deployments/gcp/terraform
terraform init && terraform apply

Azure

VNet, PostgreSQL, Redis Cache, AKS

cd deployments/azure/terraform
terraform init && terraform apply

Each cloud also ships a standalone modules/sidecar Terraform module for the Tier 2 pattern -- the Data Plane runtime provisioned entirely inside a customer's cloud account (their own VPC/subnets, their own KMS/Key Vault-backed encryption key, linked back to the Control Plane over mTLS). It is not applied by the root deployment above; see each module's own README (e.g. deployments/aws/terraform/modules/sidecar/README.md) for its standalone usage.

Continue to Quick Start