Directus Extension Auto Backup

directus-extension-auto-backup

About

This extension automatically makes backups of your database for you.

• Automatically backups (with directus flows)
• Manually backups
• Save Location (Custom path or in Directus_Files)
• Custom file name for backup files

Supported databases:

• SQLite

Help Wanted

In order to support more databases, we need help. If you know how to make a backup of a database, please open an issue and we will add you as a contributor, or you can open a pull request.

Installation

1. Backup your database! :D

2. Install the extension

   • Normal project

     cd <directus-project-folder>
     npm install directus-extension-auto-backup
     

   • Docker-Compose Install ist In your docker-compose.yml modify your container:

     directus:
         image: directus/directus:9.16.1
         command: >
             sh -c "
             npm install directus-extension-auto-backup && 
             npx directus bootstrap && echo 'Node' && 
             node node_modules/directus/dist/start.js
             "
         ...
     ...
     

3. Restart the server twice

   1. First time maybe your database is not ready yet
   2. Second time the extension should be installed

4. Go to the extensions page and setup the extension

   • A new table called Auto Backup Settings should be created
   • visit http://0.0.0.0:8055/admin/content/auto_backup_settings
   

Manual Backup

• Go to collection "Auto Backup Settings"
• Ensure you configured everything
• Select state --> select "create"

Automatic Backups

We will use directus flows to create automatic backups.

1. Create a new directus flow
2. Trigger Setup --> Configure as Schedule (CRON)
3. Create a operation --> Update Data
   • Collection: Auto Backup Settings
   • Permission: Full Access
   • Emit Events: true
   • Payload : { "state": "create", "latest_log": "" }
   • Query : { "filter": { "_and": [] } }

Development

• Before uploading to git, run npm run build to build the extension
  • Since the weird error RangeError: Maximum call stack size exceeded of the package rollup, we currently can't auto build the extension on git push

Troubleshooting

• Building the plugin with npm run build
  • Error occurs: RangeError: Maximum call stack size exceeded
    • Just run the command again, it should work the second time

Contributors

The FireboltCasters