Saphan StudioDocs
Who you are

For devops

You install it, run it, upgrade it, and get paged when it stops.

Who this is forYou are the person who installs the product, keeps it running, and is paged when it stops.
What you needShell access to the host and permission to open a port.

Your first task: get one machine installed and reach /setup in a browser. An install, end to end is that path in one page, and everything below assumes it is done.

Read these three, in this order

Go hereBecause
1 · An install, end to endOne command, what it verifies before it writes anything, and the address it leaves you at.
2 · First run at /setupThe six screens that configure a machine, and the one step deliberately left to your hand.
3 · Read a refusalThe product refuses in words rather than failing silently. This is how to read them.

Then, in the order you will need them

Go hereBecause
The delivery routesWhich programs each machine gets, and which run centrally.
Air-gapped installationA host with no network path, installed from one signed file.
The central serversWhich of them ships with an install and which does not.
Moving the fleet to a newer engineThe same delivery, repeated — and the traps that make it look like it worked when it did not.
Per-user vs system-wide stateWhere the install goes and where the state goes are independent decisions.
Settings with no defaultThe values you must choose, separated from the ones you can leave alone.
Verifying an installWhy a version string is not the check, and the two checks that are.

The limits worth knowing before you are paged

  • Nothing supervises the product for you. No delivery route installs a service unit; whether a machine runs it under an init system is a separate, explicit act.
  • A version check can pass on a defective binary — verify by content and by behaviour instead (verifying an install).
  • Backup is yours. The record lives in a store you run, and three of its four classes of data are the only copy of what they hold (the databases and what they carry).

On this page