diff --git a/.vscode/launch.json b/.vscode/launch.json index 18d9e3ab..29bca52e 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -51,7 +51,7 @@ "AYANOVA_SERVER_TEST_MODE": "false", "AYANOVA_REPORT_RENDERING_TIMEOUT":"1", "AYANOVA_SERVER_TEST_MODE_SEEDLEVEL": "small", - "AYANOVA_BACKUP_PG_DUMP_PATH": "C:data\\code\\postgres_14\\bin" + "AYANOVA_BACKUP_PG_DUMP_PATH": "C:\\data\\code\\postgres_14\\bin" }, "sourceFileMap": { "/Views": "${workspaceFolder}/Views" diff --git a/docs/8.0/ayanova/docs/img/form-backup.png b/docs/8.0/ayanova/docs/img/form-backup.png new file mode 100644 index 00000000..17160caf Binary files /dev/null and b/docs/8.0/ayanova/docs/img/form-backup.png differ diff --git a/docs/8.0/ayanova/docs/ops-form-backup.md b/docs/8.0/ayanova/docs/ops-form-backup.md index f1db5324..a1ad83da 100644 --- a/docs/8.0/ayanova/docs/ops-form-backup.md +++ b/docs/8.0/ayanova/docs/ops-form-backup.md @@ -1,5 +1,31 @@ # Operations backup form +![backups form](img/form-backup.png) + +The Backup [form](ay-start-form-overview.md) is used to view and control automated system backups. + +## Authorization Roles required + +This form is available to User's with the following [roles](ay-biz-admin-roles.md): + +Full access + +- System operations + +Read only access + +- Business administration +- Business administration - restricted +- System operations - restricted + +## How to access backup + +Backups are accessed in the following ways: + +- From the `Server operations` navigation pane `Backup` item + +## How backup works + AyaNova can automatically back up to the local file system once per day at a selected time. The backup form is where you can configure how the backup works, perform a test backup and download backups for offsite storage. @@ -16,6 +42,18 @@ The attachments backup file starts with "at-" in the file name followed by a tim The database backup file starts with "db-" in the file name followed by a timstamp and with the extension ".backup". AyaNova uses the [pg_dump](https://www.postgresql.org/docs/current/app-pgdump.html) PostgreSQL utility to backup the database and uses the `-Fc` command line switch to create a "custom" format backup which is compressed. +## Failed backup + +The most important step to detecting failed backups is to ensure several users are subscribed to the **Backup status notification** [subscription](home-notify-subscriptions.md). This is the best way to detect a failed backup in a timely manner and several people should be subscribed to this event to ensure it doesn't get missed. + +Aside from the notification, the backup form itself shows useful information to detect the state of the backup: + +A backup file is almost always generated; even in the case of a total failure to backup a zero byte file will be generated. AyaNova can not always detect if a backup failed but if it's zero bytes that is a certain indication and that backup will display as red in it's row in the backup files table. + +Other indications of a failed backup are unsually small backup files or errors in the [server log](ops-log.md). + +The only **certain** way to know if a backup is good is to test restore it from time to time and we recommend doing so on a regularly scheduled basis to be certain the backup is good if you need it. + ## Best practices for disaster recovery AyaNova backs up to it's own server's **local** drive only. This is **not a full backup solution** only a partial one; you also need to store copies of the backups **off site** from the AyaNova server in case of hardware failure, natural disaster, theft etc. @@ -74,7 +112,7 @@ If you are following a policy of 10 backup rotation as suggested above then you Backups won't run if set to inactive. This is a control to turn on or off the Backup job entirely. -### Backup Files +### Backup Files table This table contains the available backups on the server and provides the link to download them for off site storage.