Quick start

Install a client from Download, run the sync server, then connect the app, the extension, or the CLI.

Server

cd openkey_server
cp .env.example .env
openssl rand -hex 32   # paste into JWT_SECRET
docker compose up --build -d

API: http://localhost:8000 — OpenAPI at /docs, health at /health.

App

Install the OpenKey app (download channels). In Settings → Data → Self-hosted server, set http://localhost:8000 (or your HTTPS URL), then register or log in and sync.

See Using the app.

Browser extension

cd openkey_extension
npm install
npm run build

Load dist/ as an unpacked extension. Set the server URL in Options and unlock with email + master password. On desktop, enable Autofill in the app so the native messaging host is registered.

Details: Browser extension.

CLI

cd openkey_cli
npm install
npm run build
npm link   # optional

openkey gen -l 24
openkey discover --dry-run
openkey discover -y

Keep the desktop app unlocked for local secret discovery. Optional server sync:

openkey config set-server http://localhost:8000
openkey login --email [email protected]
eval $(openkey unlock)
openkey sync

Next: Security, Server setup, Using the app, Browser extension, FAQ, Changelog, and CLI.