Sign in Talk to us Free trial
Free trial

Design and software studio
Colour

Backups

See where backup files are kept, choose another folder or disk for them, make a backup file now, and test restore the newest one.

For
Owner
Hosting
Any hosting
Devices
Web browser
Business
All businesses

Checked against Pop Street Dispatch 0.1.0

Dispatch makes a backup file every night. Each file holds the business data, the photos and signatures, and a sealed copy of the data key, so it can be restored on a new computer with the recovery key. The Backups step shows where the files are kept, lets you choose another folder (a second disk or a network share), makes a backup file now, and test restores the newest one.

Before you start #

Decide on the folder, if you want one other than the default. It is best on a different disk from the data folder. Have the recovery key from the owner step in a safe place: a backup file opens only with it.

Steps #

The Backups step with the backup folder line, the folder box and its Check and save the folder button, the Make a backup file now button with its result, and the Test restore the newest backup button with its result.
The Backups step after a backup file and a test restore.
  1. Read Backup folder now. This is where backup files are kept.
  2. Optional: type the full path of another folder in Folder for backup files. For example, /Volumes/Backup/dispatch on a Mac, or D:\Dispatch backups on Windows.
  3. Select Check and save the folder. The server makes the folder if needed and writes a small test file to it. The page shows "This folder works and is saved" followed by the path.
  4. Select Make a backup file now. The page shows "Backup file" followed by its name and "was made and checked."
  5. Select Test restore the newest backup. The server unpacks the newest file in a staging area and checks it. The page shows "Test restore passed" with what it found, or "Test restore failed" with the reason.
  6. Read Last good backup. The server also tests a restore about once a month, and the console shows a banner on every page when no good backup has been made for 48 hours.
  7. Select Continue when you are done.
Technical details
  • The step uses GET /backup/status, PATCH /backup/settings, POST /backup/archives and POST /backup/test-restore. Only the owner can use them.
  • A backup file is a single .psdbackup file. It holds no passwords: after a restore each owner gets a new one-time password.
  • To restore a backup, see the Backups and restore article, or the Welcome step for a new server.

If something goes wrong #

  • The folder is refused. Check that the path is a full path, that the disk or network share is connected, and that this computer may write to it.
  • The page says this server has no recovery key yet. Run dispatch-server init or ask for a new recovery key, write it down, then make the backup file again.
  • The test restore failed. Make a new backup file, then test restore again. If it fails again, check the message and the Backups and restore article.
  • "Only the owner can run backups." Sign in as the owner to run backups.