SDK
Build on OpenVireo with the TypeScript SDK, the ov CLI, ov connect and the GitHub Action.
-
Chapter 1
OpenVireo SDK
The packages, installing, and a first program.
7 sections -
Chapter 2
Concepts
Keys, vaults, roles, organisations, references, and what the servers see.
9 sections -
Chapter 3
Hosted accounts
Sign up, sign in, unlock and lock, sessions and storage.
5 sections -
Chapter 4
Vaults and sharing
Open, read and write vaults; create, share, revoke; organisations.
7 sections -
Chapter 5
Live updates
React to changes from other devices and to access changes.
-
Chapter 6
Offline
Keep working without the network, and catch up afterwards.
2 sections -
Chapter 7
Moving a database to an account
Turn an existing database into a vault.
-
Chapter 8
Account recovery
Account resets and restoring the old vaults.
3 sections -
Chapter 9
Service accounts
Secrets for CI, servers and long-running processes.
4 sections -
Chapter 10
Self-hosted sync servers
Sync .kdbx files with a self-hosted server, no account needed.
3 sections -
Chapter 11
Testing your app
Test your app against in-memory servers.
1 section -
Chapter 12
CLI: ov
ov: read, inject, run and rotate secrets from the command line.
5 sections -
Chapter 13
Connect: ov connect
ov connect: a REST server for one service account, and Kubernetes.
4 sections -
Chapter 14
GitHub Action
Load secrets into GitHub Actions workflows.
-
Chapter 15
Errors
Every error code and what to do about it.
6 sections -
Chapter 16
Merge behaviour
How concurrent edits are combined, exactly.
8 sections -
Chapter 17
Lower-level APIs
The sync loop, HTTP clients, KDBX helpers, Argon2 and OPAQUE.
6 sections