Package Installation

This document explains how to install custom packages on standard Parallels H-Sphere.

To install a Parallels H-Sphere package:

1. Login to CP server as the cpanel user.
2. Install the package using the Package Installer tool. Use the --help option for the syntax:

   java psoft.hsp.tools.PkgInstaller --package=/path/to/package/file [--upgrade] [--check-only] [--force]

   Options description:

   --package=/path/to/package/file

   Specifies the path to the built package. Parallels H-Sphere package is a Java archive file (JAR) with .hsp extension.

   [--check-only]

   Makes utility not install the package but only perform a check routine if the package can be installed.

   [--upgrade]

   Use this option if you upgrade the package already installed on your Parallels H-Sphere. With this option, you can easily upgrade the package without uninstallation of the older package and restarting Parallels H-Sphere after the uninstallation.

   [--force]

   Forces the package installation even if conflicts were detected. For example, if you are installing two packages that use exactly the same file, install the first one without, and the second one with the --force option. The first instance of the file will be replaced with the second. Use this option only if you are sure this won't damage other packages.

3. Restart Parallels H-Sphere.
4. Check whether all Parallels H-Sphere package components have been successfully installed.
   • The files installed with the package will be copied to the ~cpanel/shiva/packages/PackageName directory, where PackageName is the name of the package without its version and build number. For example, after installation of the MyPackage-1.0.1-2.hsp package its files will be stored in the ~cpanel/shiva/packages/MyPackage directory.
   • If some package components (scripts, 3rd-party bundles, etc.) of Parallels H-Sphere *.hsp packages are missing after the installation or on newly added Parallels H-Sphere physical boxes, run the Parallels H-Sphere update script with the 3rdpackages option. See the Parallels H-Sphere Upgrade Guide for the update script options details.
   • After you installed a package, it will be added to the list of installed packages in your admin Control Panel, in the Settings->Packages menu. Click a package to check its details and files installed by that package. This is helpful to find out whether all package files are installed correctly.

If something goes wrong during or after the installation, you can uninstall the package.