H-Sphere Versions

For more information contact us

Updating H-Sphere to 3.0 Patch 7

17 Oct 2007


Release Notes  |     Install  |     Change Log  |     Package List

This document also explains how to upgrade H-Sphere to 3.0 Patch 7 from H-Sphere 2.4.3 Patch 11 and up. For lower versions, please upgrade to 2.4.3 Patch 11 first.



Consider this before you update H-Sphere:

  • The upgrade won't work without a valid H-Sphere license to cover all accounts in the system!

  • Please refer to the list of operating systems supported by H-Sphere.

    1. Update to H-Sphere 2.5 and up is not recommended for H-Sphere clusters with CP servers under FreeBSD 4.x up to FreeBSD 4.9, as these FreeBSD versions do not fully support Java 1.5.
    2. H-Sphere Winbox versions earlier than 2.5 won't work correctly with H-Sphere 2.5 Beta 2 and up! In the same way, Winbox 2.5 Beta 2 and up won't work with H-Sphere under 2.5!
    3. Serv-U FTP is no longer supported in H-Sphere Winbox 2.5 and up. If you are currently using it and would like to update to this version, first switch to MS FTP.
    4. We currently don't recommend updating H-Sphere to version 2.5 and up when there are 512 and more ColdFusion mappings on a Windows server (i.e., ColdFusion is turned on for more than 511 Winbox users)
  • Config files for Apache, FTP, PHP, DNS, MySQL, and PostgreSQL should be customized indirectly via respective template files. Otherwise, all custom changes in major default configuration files are removed with each H-Sphere update! Please carefully follow the config file templates customization instruction!

  • Update on boxes with FreeBSD 5.3 and up will halt if the /hsphere directory is a symlink! Please re-partition your servers' HDD to move H-Sphere content to the /hsphere directory before you proceed with the update. Please refer to Preparing Servers: HDD Partitioning.

  • If you have CP installed on a FreeBSD box, especially in case of multiprocessor architecture, please make sure you have the /etc/libmap.conf file on the CP box with this content.

  • If you have a mail server running on the same box as the CP server, and CP server uses port 80, change CP port to 8080 in /hsphere/local/home/cpanel/apache/conf/httpd.conf or contact H-Sphere support.

  • Custom server groups for name (DNS) logical servers are no longer supported! If you are upgrading from H-Sphere 2.4.3 or earlier versions, please remove all custom name server groups (including all respective logical/physical servers). Please refer to Server Groups for details.

  • MySQL Updates.

  • Make sure that port 144 (localhost:144) is opened on all mailservers.

  • If you are installing H-Sphere control panel on FreeBSD box running on multiprocessor computer architecture, create /etc/libmap.conf file. More in Preparing Servers for H-Sphere Installation.

  • Since H-Sphere 3.0 +, you can download installation/update script from our mirror site at http://mirror.psoft.net. More information in H-Sphere install/update script options



  1. Make sure you have H-Sphere 2.4.3 Patch 11 or higher installed:

    # cat ~cpanel/shiva/psoft_config/HS_VERSION

    If you have an older version, update to H-Sphere 2.4.3 Patch 11 first and run a separate PostgreSQL update script to update PostgreSQL to 7.4.x version.
  2. Download the 3.0 Patch 7 install/update script:

    # wget http://www.psoft.net/shiv/HS/releases/U30.0/U30.0P7/U30.0P7


    # fetch http://www.psoft.net/shiv/HS/releases/U30.0/U30.0P7/U30.0P7

  3. Stop H-Sphere using one of the following commands:

    # /etc/rc.d/init.d/httpdcp stop


    # /usr/local/etc/rc.d/apachecp.sh stop

    Stop SiteStudio ImageMaker by running:

    # /hsphere/shared/SiteStudio/imaker.sh stop

  4. Run the update script:

    # sh ./U30.0P7

    You will see a help window with a prompt to enter update options.

  5. Update H-Sphere.
    • If one of the following conditions is met:

      1. if you have customized versions of H-Sphere *nix packages or other system packages that you update via native OS package manager;
      2. if your default config files (Apache, PHP, mail, FTP, databases) are customized not by means of config file templates;

      H-Sphere update will be as follows:

      1. Update H-Sphere core (templates, classes, jars):

        cpupdate [OPTIONS]

      2. In case a, exclude respective packages from being updated by the H-Sphere update script. To do this, type:

        hspackages [ ips=<IP1>,<IP2>,...<IPN>] exclude=add:<pattern1>,<pattern2>,...<patternN> skip=preparing

        Here, <IPx> are physical server IPs, and <patternx> are packages to exclude. For detailed syntax see command line interface of the H-Sphere Updater wrapper.

        To make sure you have successfully excluded the packages, run:

        hspackages [ ips=<IP1>,<IP2>,...<IPN>] exclude=show skip=preparing

        Warning: Please be very careful in excluding the packages from the update list! You must have serious reasons to do this!

      3. In case b, type the following command to create default config file templates to be customized afterwards:

        hspackages ctemplates=php,httpd,ftpd,mysql,pgsql

        For syntax and details please thoroughly read about customizing config files by means of templates.

        Important: This command will create default config file templates in respective directories. After that, you should customize them according to the custom configuration you had before. Typical reasons for such customization may be the use of Zend Optimizer, ChiliASP, ColdFusion Apache modules, etc.

      4. Update H-Sphere related packages:


    • Otherwise, if neither a or b is met:

      • to update H-Sphere and Site Studio, type:

        update [OPTIONS]

      • to update only H-Sphere, enter:

        hsupdate [OPTIONS]

      • to update only Site Studio, enter:

        sitestudio [OPTIONS]

      Important: In H-Sphere 3.0 RC 1 and up the above mentioned options can be used very flexible with a variety of sub-parameters. For example, you may specify the ips=LIST_OF_IPs or groups=LIST_OF_LSERVER_GROUPS parameters to run the update only on particular physical servers to affect only particular logical server groups (Web, mail, etc.). Also if you run the update with the force parameter, new or updated packages will be installed by force, regardless of conflicts. More on H-Sphere update/install script options

    Note: After the update, you'll be able to add more servers or services to the cluster by following the Adding Servers and Services documentation.

  6. Update PostgreSQL:
    hspackages postgres
  7. If you have faced problems on the stage of running post-configuration scripts, you don't need to resume the update from the beginning. Choose the deploy mode to install and run post-configuration scripts once more:

    deploy [OPTIONS]

    More about H-Sphere update/install script options.
  8. Upgrade your Winbox to 3.0 Patch 8 (latest Winbox in this H-Sphere branch).
  9. H-Sphere update script will automatically launch H-Sphere CP after the update. Check if H-Sphere is running, and if not, start CP Apache:

    # /etc/rc.d/init.d/httpdcp start


    # /usr/local/etc/rc.d/apachecp.sh start

  10. Start ImageMaker if your H-Sphere is integrated with SiteStudio, for Linux & FreeBSD:
    # /hsphere/shared/SiteStudio/imaker.sh start
  11. Check the version of H-Sphere by executing the following command on your CP box:

    # cat ~cpanel/shiva/psoft_config/HS_VERSION

    You will see a line similar to this:



    3.0.0 is the version of H-Sphere,
    826 is the H-Sphere build.


Post-Update Issues

After you have updated H-Sphere, please make sure you meet the following requirements:

  • Winbox Update. Don't forget to upgrade Winbox to 3.0 Patch 8 (latest Winbox in this H-Sphere branch) if you haven't done this yet.

  • Customization. If you have custom H-Sphere templates, you may probably need to update them according to changes introduced in this version.
    Starting with HS 2.5 Beta 1, the check! client-side validation attribute is no longer supported in the input and textarea tags. Please update your custom templates with the check="${validation_variable}" construction everywhere instead of check!, where ${validation_variable} is a Freemarker variable which is evaluated to the real name of a validation function (regexp) during the template processing.

  • Ownership. In H-Sphere 2.5 RC 3 and up HTML pages, images, Javascript and CSS files and respective directories have cpanel:httpdcp ownership. H-Sphere updater checks and automatically sets correct ownership and permissions on respective default and custom files and directories. Please make sure however that newly created custom files have correct ownership and permissions (this does not relate to H-Sphere packages).

  • Web Payments. If you are updating from H-Sphere versions earlier than 2.5 Beta 1, please update the format of instant payment notification URL in affected Web payment systems' settings.

  • Web traffic calculation and log rotation. H-Sphere 2.5 Beta 1 and up introduces a completely different approach in Web traffic calculation and log rotation. Now it takes into account both incoming and outgoing traffic. Therefore, after you upgrade from versions earlier than 2.5 Beta 1, your clients may find their traffic increased.

  • VPS.

    1. If you host VPS on your H-Sphere and update from version 2.4.x, you must run the VPS converter tool with the --all option to convert all VPS plans and accounts to comply with VPS resource implementation in H-Sphere 2.5 and up.
    2. After you have updated H-Sphere, please also make sure you run Steps 3-9 of the H-Sphere VPS update instruction.
  • IMP Horde (Webmail). Having updated the package, make sure to migrate your Horde histories data into a separate table, located in Horde database (introduced in a new Horde version).

  • DBD::mysql Perl driver. If you want to update DBD::mysql driver or system Perl version, make sure to execute the script that updates DBD::mysql driver.

  • DNS Zone Duplication. (Update from H-Sphere 2.4.x) If during the H-Sphere update DNS zone duplication takes place, Bind update from 8.x to 9.3.x will be skipped. Then, after the H-Sphere update is over, you need to resolve the DNS zone duplication problem, run the updater again and choose the hspackages option in the update script to update Bind.

  • Set up Kronolith Reminders: If you use Kronolith reminders, make sure to set up them.

Copyright 1998-2018. Positive Software Corporation.
All rights reserved.