Database Backup — How to Install

← Back to Database Backup overview

How to Install — Database Backup

Module folder: modules/backup/   Version: v2.3.0

Default module to perform database backup

Before you begin

• Backup your database (Setup → Backup or your host backup tool).
• Use a staff account with Modules / Settings access.
• PHP version and Perfex CRM version should match the module README requirements when listed.
• Keep the module folder name exactly backup.

Step-by-step installation

1. Upload the backup folder into your CRM modules/ directory (FTP, cPanel, or Setup → Modules → Upload when available).
2. Log in to Admin.
3. Go to Setup → Modules.
4. Find Database Backup and click Activate (or Upgrade if already installed).
5. Wait for migrations/tables to finish — do not refresh mid-activation.
6. Go to Setup → Staff → Roles and assign permissions for this module.
7. Open Database Backup → Settings and save defaults.

One-time setup (first time only)

1. Setup → Modules → activate Database Backup.
2. Setup → Staff → Roles → assign Database Backup permissions (view, create, edit, delete, approve, export, settings as needed).
3. Open Database Backup → Settings and complete company defaults, prefixes, integrations, and notification options.
4. Create master data (warehouses, products, templates, accounts, routes, etc.) before processing live transactions.
5. Enable Perfex CRM cron (php /path/to/perfex/index.php cron/index) for sync, retries, alerts, and scheduled jobs.
6. Optionally enable REST API / webhooks in module settings if you integrate external systems.

Verify installation (checklist)

1. Setup → Modules shows Database Backup as Active.
2. Admin sidebar shows the Database Backup menu for an admin user.
3. Setup → Staff → Roles lists this module's permission groups.
4. Opening Database Backup → Settings loads without PHP errors.
5. Creating one sample record succeeds and appears in the list/table.
6. (If used) Cron-dependent features have Perfex CRM cron enabled on the server.

After install — first actions

1. Create master data required by this module.
2. Create one sample record and walk it through approve/complete if applicable.
3. Train staff using the Quick Start Guide.

Related: Features · Quick Start · FAQ · Version & Changelog