Caryvane documentation
Written for the engineer with a ticket open. Every page is a task: what to do, in order, with the exact commands and the things that will trip you up called out before you hit them.
Press / anywhere to search. Results point at the exact step, not just the page.
Setting Caryvane up for the first time #
The shortest path from nothing to a working, verified backup:
- Create a deployment token One per customer, in the console. It is what lets a machine join the right tenant. Creating deployment tokens →
- Install the agent on the machine Silently, with the token on the command line. Windows, macOS and Linux all supported — the command differs per platform and per installer. Deploying the agent →
- Add a storage target Where the data goes. You own it; Caryvane never holds a copy. Choosing and adding storage →
- Create the backup job Source, destination, schedule, retention. The job wizard, step by step →
- Prove it restores A backup you have never restored is a hypothesis, not a backup. Restoring →
Find it by task #
Create a backup job
All six wizard steps, every option, and which options apply to which kind of source.
Restore data
The four restore paths, what each one can and cannot do, and which to reach for.
Archive old files
Mark folders with a retention rule, then a job moves what is old enough to cheap storage — copy, verify, catalogue, and only then remove.
Copy cloud to cloud
S3 to Azure, SharePoint to a NAS, Egnyte to Wasabi — on your agent or the Cloud Agent, incrementally or continuously.
Back up Microsoft 365 & Google
Admin consent, domain-wide delegation, what gets backed up, and the “back up everything including new users” switch.
Archive a leaver
A person’s mailbox and OneDrive in ZIP files — or a whole site — before the licence goes. Google Workspace too.
Mount a cloud drive
Object storage as a drive letter. Platform support, cache behaviour and the real limits.
Personal drives & sign-in
A person's own drives on a PC, a Mac or a phone: who signs in, how long it lasts, and importing people from Microsoft 365 or Google.
Deploy the agent
Silent install commands per platform, where everything lives on disk, and the prerequisites that actually bite.
Customers & deployment
Tenants, roles, seats, deployment tokens and per-customer storage.
Troubleshooting
Agent offline, job failing, drive not mounting — the checks in the order worth doing them.
AI assistants & API
Drive Caryvane from Claude or VS Code, or script it. Every tool, every permission tier.
Conventions used here #
Three kinds of callout appear throughout, and they mean different things:
Context or a shortcut. Useful, not load-bearing.
A step people get wrong, or behaviour that surprises. Read before proceeding.
Doing this loses data, or costs money. Do not skip.
Paths are given in full. Where the product still says Aurawolf on disk — the
Windows data folder, some registry keys, the .NET namespaces — that is deliberate and
correct; the company renamed, the file paths did not.