QuartzControl puts things in three places. Knowing them also tells you what a backup has to cover.
In the project
Everything that makes up the site — and a few things that only concern QuartzControl:
| What | Travels with the project? |
|---|---|
quartz.config.yaml, stylesheets, language files | yes |
| The plugins’ lock file | yes |
| Your own frames | yes |
| The project image | yes |
| The snapshots | no — they belong to this copy on this machine |
| Set-aside content folders | no |
| The built plugin files | no — restorable from the lock file |
| The dependencies and the build folder | no — they come about again |
“Travels with” means: lives in a repository, when the project lives in one.
In QuartzControl’s data folder
The project list, the settings and the connections — everything that does not belong to a single project.
Where that folder is is in the settings under Data & maintenance, with a button that opens it; the same is available via Help → Open data folder.
The theme documentation cache lives there too, and — where needed — the runtime environment QuartzControl rewrites on every start.
In the system’s keychain
Passwords, keys and tokens. Not in a file of QuartzControl’s: they live encrypted in the operating system’s keychain.
Which also means: they travel with no backup — neither with the project nor with the data folder. On a new machine the connections have to be entered again; a project’s targets are then there, but without a login.
On Linux this depends on a running keychain. Where one is missing, the start screen says so explicitly instead of pretending everything is encrypted.
Online
This handbook. It does not live in QuartzControl but online at boxi-os.github.io/QuartzControl;
Help → Handbook and the link in the header of every page open it in the browser. It describes
the most recently published version and needs a network for that.
When one of these files is unreadable
If QuartzControl cannot read one of its own files at startup, it sets it aside rather than overwriting it — so the content is still there. What it held is missing from QuartzControl, and the settings report it under Data & maintenance.