FadenDocumentation
Demo PLEN

Administration

Backups

Admin window: create, schedule, verify, download, upload and restore backups of the whole application.

Address in the app: /admin/backups

The Backups window is for administrators only. A backup holds all application data, including personal data and password hashes, so keep it as a secret.

The top of the window shows the folder where backups are stored. While a backup, check, restore or upload is running, a banner appears and the other buttons are disabled.

What the window looks like

/admin/backups
Schedule, backup list and upload.

Parts of the window

  1. Automatic backups

    A switch, the status of the next and last automatic backup, and the schedule fields. A backup is made once a month, on the given day (1-28) and UTC hour.

    If the app was down at that time, the missed backup runs after it starts again.

  2. Backup list

    The create button and a table, newest first: name with an origin badge (manual, scheduled and others), date, size, app version, database and attachments.

  3. Row actions

    Download saves the file, Verify checks the archive, Restore and Delete open a confirmation under the row. While another operation runs, the last three are disabled.

  4. Unreadable files

    Shown only when the backup folder holds files that cannot be read. It lists the name, size and reason.

  5. Uploading a backup

    Adds a .tar.gz file to the list, within the size limit shown. Uploading alone restores nothing.

/admin/backups
The restore confirmation open under a backup row.

Parts of the window

  1. Restore confirmation

    Warnings, an optional license key field and a box where you must type RESTORE. Only then does Restore now work. Cancel or Esc closes the panel.

How to

  1. Create a backup now

    Click Create backup now. The new backup appears in the list.

  2. Set up automatic backups

    Tick Automatic monthly backups (it takes effect at once). Set the day, hour (UTC) and how many scheduled backups to keep, then choose Save schedule.

  3. Check a backup

    Click Verify in its row. The app checks the files in the archive and shows the result under the row.

  4. Keep a copy off the server

    Click Download and save the file to another disk or machine.

  5. Delete a backup

    Click Delete in its row and confirm with Delete. This cannot be undone.

  6. Restore a backup

    Click Restore, type RESTORE and choose Restore now. Sign in again when it finishes.

  7. Use a backup from another server

    In Upload a backup choose a .tar.gz file and click Upload backup. It joins the list; restore it with Restore in its row.

Good to know

  • Enter a license in License key (optional) while restoring; it must be issued for this installation. Left empty, the license stored in the backup is used. See License.
  • The How to restore without the app instructions at the bottom of the window expand when you click them.

Limitations

  • Restoring replaces all current data and attachments, signs users out and briefly takes the app offline. A safety backup is made first.
  • Backup files contain commands that run in the database during a restore. Restore only your own files or ones from a fully trusted source.
  • Only scheduled (and safety) backups are removed automatically. Manual, uploaded and command-line backups stay until you delete them.

See also