Skip to main content

Restore an Existing Site

You can restore an existing Frappe site on Frappe Cloud using backup files, the Bench CLI, the Frappe Cloud Restore CLI, or by migrating directly from another server. The recommended method depends on your backup size and deployment environment.

Note

When restoring a site using backup files, don’t forget to restore the
Site Config as well. This ensures your encryption key and other configuration values are restored correctly.

Restore from Backup Files

The simplest way to migrate an existing site is by restoring a backup created using the
bench backup command.

  1. Create a backup using the bench backup command.
  2. Ensure the following files are available:
    • Database Backup (.sql.gz)
    • Public Files (.tar)
    • Private Files (.tar)
    • Site Config Backup (.json)
  3. Create a new site from the Frappe Cloud dashboard.
  4. Open the site’s Actions tab.
  5. Select Restore with Files.
  6. Upload each backup file into its corresponding field.
  7. Click Restore.
  8. Wait until the restore process finishes.
Best Practice

For backup files larger than 200 MB, use the Bench CLI or the Frappe Cloud Restore CLI instead of uploading through the dashboard.

Encryption Key

After restoring a site, copy the original encryption_key from your
site_config.json file into the new site’s configuration. Without it,
stored passwords cannot be decrypted.

Important

If the original encryption key is unavailable, you’ll need to re-enter every password field (such as Email Accounts, API keys, and integrations) so they are encrypted using the new key.

Rating: 0 / 5 (0 votes)