Sync Server
Run your own OpenVireo Sync Server, or build a client for its HTTP API.
-
Chapter 1
OpenVireo Sync Server
What the server does, how sync works, and a quick start.
4 sections -
Chapter 2
Installing and deploying
Build from source, run the Docker image, deploy to DigitalOcean, put HTTPS in front.
4 sections -
Chapter 3
Configuration
Every SYNC_* setting, and the data directory or Postgres and S3 storage.
4 sections -
Chapter 4
Users and devices
Add users and devices, pair new devices, shut out a lost one.
4 sections -
Chapter 5
Accounts and vaults
Run the server behind an OpenVireo account server, with access tokens and vaults.
6 sections -
Chapter 6
HTTP API
Routes, concurrency, history, events, CORS and errors.
9 sections -
Chapter 7
API reference
Every route, its parameters and responses, from the OpenAPI description.
8 sections -
Chapter 8
Operations
Backups, upgrades, moving to Postgres, scaling and monitoring.
5 sections -
Chapter 9
Development
Source layout, tests and releases.
4 sections