Skip to content

/reference/

Reference

The exact facts: what each route takes and answers, the encrypted blob byte by byte, the frames of the live stream, every command of the CLI, every variable the server reads, and how to run on one SQLite file instead of PostgreSQL. Each page is a file of the repository’s docs/, turned into a page when this site is built, so the reference and the repository say the same thing. For the ideas behind them, read Concepts first.

page from
HTTP API Every route of @vol-a/server. docs/API.md
Encryption How an encrypted file is stored, who holds which key, what a dump reveals and what to do when something answers 409, 423, 429 or 503. docs/CRYPTO.md
Real-time A client that shows the files of an instance (or of one folder of it) sees changes as they happen. docs/REALTIME.md
CLI @vol-a/cli is the vola command (packages/cli). docs/CLI.md
Environment variables Every variable the server, the worker and the CLI read (packages/server/src/config.ts; .env.example has the same list with comments). docs/DEPLOYMENT.md, “Environment variables”
SQLite JSVola runs on PostgreSQL or on a single SQLite file. docs/SQLITE.md

v1.1.1released built 519e3dc