ISPmanager Lite Documentation

Backup copies

How to configure backups in ISPmanager


A backup copy is a copy of all websites, databases and user mailboxes. Backups allow the following:

  • restoring information in case of problems in the operation of the website;
  • restoring the website when moving from server to server;
  • saving data in case of possible server failures, software failures, hardware problems, etc.

Backups can be stored on the server with ISPmanager or in an external storage. The following can be used as the external storage:

  • Dropbox;
  • Google Drive;
  • Amazon S3;
  • S3-compatible storage;
  • FTP server;
  • SFTP server (with connection via SSH).

Backups for all users are created automatically once a day. Read more about the operating principle of backups in Backup system: general information.

To manage backups, enter ToolsBackup copies.

Configuring backup schedule


When you open the Backup copies section for the first time, ISPmanager offers to configure backup settings. Press OK to enter the settings.

  1. Activate the Enable backups option to run the backup process with the specified settings.

    Note

    In order to enable/disable backups for a specific user, you need to enable/disable this option in the user settings.

  2. Select the place to store backups in the Storage type field.
  3. Specify the Backup copy password.
  4. Specify the settings for the selected storage type:

      Local directory
    • Path to directory — the directory on the server where the backups will be saved.
     Dropbox
    • Access code — access code to Dropbox. You can follow the link and login to Dropbox. After that, the field will be filled in automatically.
    • Path to backup directory — the directory in Dropbox where the backups will be saved.
     Google Drive
    • Access code — access code to Google Drive. You can follow the link and login to Google Drive. After that, the field will be filled in automatically.
    • Path to backups — the directory in Google Drive where the backups will be saved.
     Amazon S3
    • Key identifier — access key identifier.
    • Secret key — secret access key.
    • Bucket — Amazon S3 container name for storing backups.

    Read more about Amazon S3 settings in the official documentation.

     S3-compatible storage
    • Storage URL — URL for API requests to the storage.
    • Key identifier — access key identifier.
    • Secret key — secret access key.
    • Bucket — container name for storing backups.
    • Bucket addressing model:
      • subdomain — the URL of the form http[s]://bucket.host[:port][/path] will be used to access the bucket. For example, https://bucket.example.com:5555/backup.
      • URL-path — the URL of the form http[s]://host[:port][/path]/bucket/ will be used to access the bucket.  For example, https://example.com:7777/backup/bucket.
     FTP server
    • Server address — domain name or IP address of the server.
    • Port FTP — connection port. Default value — 21.
    • Path to backup directory — the directory on the server where the backups will be saved.
    • User — FTP user name.
    • Password — FTP user password.
     SFTP server (over SSH)
    • Server URL — domain name or IP address of the server.
    • SSH port — connection port. Default value — 22.
    • — the directory on the server where the backups will be saved.

    • — type of authorization: password or SSH key. In case of password authorization, ISPmanager will generate a key that will be used to access the remote server.

    • Username — SSH user name.
    • Password — SSH user password.
    • Private key — content of the private SSH key.
  5. Set Limits on backups creation:
    1. Total size in bytes. You can specify a unit of measurement in this field. E.g., 100Mib.

      Note

      • For local storage, the limit applies to each node of the cluster separately. If this value is exceeded, the oldest backups will be deleted;
      • You can leave this field blank; in that case the backups will be stored until the storage runs out of space;
      • You can limit the total number of backups using the BackupCountLimit configuration file parameter. The default value of the parameter is 14 (7 daily and 7 weekly backups).


    2. Maximum number of Full backup copies.
    3. Maximum number of Daily backup copies.
    4. In the Exclude files field, specify which files should not be included in the backup. Each exception has to be specified in a new line.

      Note

      • File paths are set relative to the user's home directory (default is /var/www/username/). E.g., data/.filemgr-tmp;
      • You can use the * symbol to replace any characters in the file name.


    5. In the Exclude databases field, specify which databases should not be included in the backup. Each database has to be specified in a new line.
  6. Press OK.


Configuring backup parameters


To change the settings, enter Tools → Backup copiesSettings button.

Restoring data from a backup


Recovery of a user and all user's data

To restore user data from a backup, enter ToolsBackup copies → select the backup→ Details button → select the user → Restore button → OK. When the data are restored, the message "Backup restore has been completed successfully" will appear in the ISPmanager interface.

Note:

The existing files are not overwritten. Before the recovery, delete the database with the same name from the server. Otherwise, ISPmanager will add the files to the existing database rather than recover them from a backup.

Recovery of a deleted user

You can recover a deleted user from a backup under a different name.  Enter Tools Backup copies → select the backup → Details button → select the user → Restore as button → specify the User name to which the data will be restored from the backup or Create user with a new name → Ok. In this case, ISPmanager will not restore matching entities. In addition, the backups created under the old name will not be available to the user.

Note:

If you recover a deleted user from an earlier backup, the data contained in subsequent backups will not be available to the user.

For example, a user was deleted on March 10, but that user's backups for January and February are available. After restoring the user from the January 15 backup, the backups created later than that date will not be displayed to the user; i.e. the user will not be able to access the backups for the period from January 15 to March 10.

Restoring individual files

To restore individual files from a user backup:

  1. Log in with a user account: AccountsUsers → select the user → Log in button.
  2. Open the user's backup: ToolsBackup copies → select the copy → Details button.
  3. Select the data type — Databases, Mail, Files.
  4. Select the required files.
  5. Click the Restore button to restore files from the backup.

When the data are restored, the message "Backup restore has been completed successfully" will appear in the ISPmanager interface.

Downloading the backup


To download one of the backups to the local computer, enter ToolsBackup copies → select the backup → Details button → select the user → Download button. The backup will be downloaded as a tar archive with the file name of YYYY-MM-DD-user.tar.gz.

 Comments

YYYY-MM-DD — backup creation date

user — user name