Getting Started

Get Krypt running in your environment.

Prerequisites

Docker (recommended) or Rust toolchain
PostgreSQL 15+ for persistent storage

Quick Start

Option 1: Docker (Recommended)

# Start PostgreSQL
docker run -d --name krypt-db \
  -e POSTGRES_DB=krypt \
  -e POSTGRES_USER=krypt \
  -e POSTGRES_PASSWORD=secret \
  -p 5432:5432 \
  postgres:15

# Start Krypt
docker run -d --name krypt \
  -e KRYPT_DB_URL="postgres://krypt:secret@host.docker.internal:5432/krypt" \
  -p 8200:8200 \
  krypt/krypt:latest

Option 2: Binary

curl -L https://github.com/krypt-io/krypt/releases/latest/download/krypt-linux-amd64 \
  -o /usr/local/bin/krypt
chmod +x /usr/local/bin/krypt

curl -L https://github.com/krypt-io/krypt/releases/latest/download/krypt-darwin-amd64 \
  -o /usr/local/bin/krypt
chmod +x /usr/local/bin/krypt

Download from GitHub Releases and add to PATH.

Your First Secret

# 1. Create an engine (isolated namespace)
krypt engine create myapp --password "master-password"

# 2. Authenticate
krypt login myapp

# 3. Store secrets
krypt put myapp database/postgres host=localhost port=5432 password=secret

# 4. Retrieve
krypt get myapp database/postgres

Output:

host     = localhost
port     = 5432
password = secret

Configuration

Environment Variables

Variable	Description	Default
`KRYPT_DB_URL`	PostgreSQL connection string	Required
`KRYPT_LISTEN`	Server bind address	`127.0.0.1:8200`
`KRYPT_TOKEN`	Authentication token	-

Config File

# ~/.krypt/config.toml
[server]
listen = "0.0.0.0:8200"

[database]
url = "postgres://user:pass@localhost/krypt"
max_connections = 10

[cluster]
name = "production"
peers = ["10.0.0.2:8201", "10.0.0.3:8201"]

Next Steps

Core Concepts — Understand engines, tokens, and policies
CLI Reference — Complete command documentation

Documentation Core Concepts