Search Engine: Elastic

Article ID: 3243, created on Nov 30, 2007, last review on Apr 16, 2012

  • Applies to:
  • H-Sphere


This document explains how to back up H-Sphere system and user data by means of the H-Sphere backup script.

Currently, the script backs up only the Control Panel server with the PostgreSQL system database. It requires PostgreSQL client version 7.3 or higher installed and the psql program available in the system paths on the CP server. To manually back up H-Sphere content on Unix servers, see the backup and recovery list of H-Sphere related directories and files.

We recommend that you set up a separate server to store backup archives.



Each H-Sphere server has a copy of the backup script located in the /hsphere/shared/backup directory. The script includes the following files:

hs_bck - the main script file (you can only run the script on the CP server);
hs_bck.cfg - custom configuration file. This is the file to store the list of directories to back up. - default configuration file. It can be overwritten with H-Sphere updates. This is where you can find the updated list of parameters to the hs_bck script if it has been changed in a new version.
hs_bck.txt - description/readme file.

Depending on the server, you need to configure the script by editing the hs_bck.cfg file.



To back up H-Sphere CP server:

  1. Log into the CP server as root:
    su -
  2. cd into the backup script directory:
    cd /hsphere/shared/backup
  3. Make sure the files hs_bck.cfg and are identical in what is not your custom settings. The format of the file may change with H-Sphere updates, and it is important to ensure that the backup script is launched with correct parameters.
  4. In hs_bck.cfg, edit the list of directories and databases to back up. See the backup and recovery list for each type of server.
  5. In hs_bck.cfg, edit the the backup storage directory, the number of latest backups to be stored (7 by default), the log file, etc.
  6. Run the backup script.
    • For regular automatic backups, add the execution of the hs_bck file into the CP server crontab configuration, e.g.:
      <TIME> /hsphere/shared/backup/hs_bck hs_bck.cfg 2>&1 > /dev/null
      For example, to run the backup script every day at 6:13 AM, add the following line:
      13 6 * * * /hsphere/shared/backup/hs_bck /hsphere/shared/backup/hs_bck.cfg 2>&1 > /dev/null
    • For additional parameters to this script, please run:

f213b9fa8759d57bee5d547445806fe7 3ef1f5f998c0dc182718a7fe4376f875

Email subscription for changes to this article
Save as PDF