This document gives step-by-step instructions on how to set up OpenSRS for H-Sphere older than 2.3.

1. Registration with OpenSRS
2. Installation of required perl libraries
3. OpenSRS client installation
4. OpenSRS client configuration
5. Control Panel configuration
6. Testing OpenSRS client

Registration with OpenSRS

1. Create your own account with OpenSRS.
   Mind that the IP address you register with OpenSRS account should correspond to the IP address of the server with your Control Panel so that the Control Panel can use your configuration data to enter OpenSRS and register the domain.
2. Go through the Full Access test on the OpenSRS site to get the Reseller status. This requirement is set by OpenSRS to make sure you are familiar with their system and procedures and can resell their services.

Installation of Required Perl Libraries

Before the OpenSRS installation, make sure you have the following perl libraries:

Crypt-Blowfish-2.06.tar.gz
Crypt-CBC-1.25.tar.gz
Crypt-DES-2.01.tar.gz
Storable-1.0.12.tar.gz
Unicode-String-2.06.tar.gz
XML-Parser.2.30.tar.gz

After these libraries have been installed, you can start installing OpenSRS client.

OpenSRS Client Installation

1. Create the directory /hsphere/shared/opensrs
2. Download the OpenSRS client installation file
3. Unpack it into this directory
4. Put the OpenSRS.conf configuration file into the /etc directory.

OpenSRS Client Configuration

1. Log into your OpenSRS account using your login and password. Create your own individual DES key. Keep the page open so you can copy the generated key to the config file when you get to configuring the OpenSRS client.
2. Open the /etc/OpenSRS.conf file in a text editor.
3. Change the following variables:

   - $USERNAME - your OpenSRS login;
   - $PRIVATE_KEY - your individual DES key; this data will be used to connect to OpenSRS server. Copy this file from the web page you opened on step 1;
   - $ADMIN_EMAIL - full e-mail address of the OpenSRS administrator;
   - $TEST_SERVER - set to 1 if the server works in the test mode;
   set to 0 if the server works in the production mode;
   - $PATH_SOURCE - the path to the OpenSRS client. It should be as follows:
   /hsphere/shared/opensrs/opensrs-client-x.x,
   where 'x.x' is the number of the version;
   - set the crypt_type field of the %OPENSRS hash to DES;
   - contact OpenSRS support to find out the value of the REMOTE_HOST field of the %OPENSRS hash. This variable holds the name of the server OpenSRS client will connect to.

4. Change the owner and the group of the /etc/OpenSRS.conf to cpanel:cpanel with the command:
   chown cpanel:cpanel /etc/OpenSRS.conf
5. Change permissions on the /etc/OpenSRS.conf file to 400 with the command:
   chmod 400 /etc/OpenSRS.conf
6. Make sure port 55000 is open for access both ways (i.e. in the firewall)

Control Panel Configuration

1. In the text editor open the file:
   /hsphere/local/home/cpanel/shiva/psoft_config/hsphere.properties
2. Set the OPENSRS_SILENT_MODE variable to
   - FALSE - if OpenSRS account is in the live mode
   - TRUE - if OpenSRS account is in the test mode
3. Restart H-Sphere. The command varies depending on the H-Sphere installation.

Testing OpenSRS client

1. Go to the directory /hsphere/shared/opensrs/opensrs-client-xx/cgi, where x.x is the version of your OpenSRS client.
2. In the script verify_install.cgi, edit the path to the OpenSRS.conf file (/etc/OpenSRS.conf).
3. Run this script. As the result, you will see if all necessary components have been installed. Also, you will see if you OpenSRS client can connect to the OpenSRS server. In case of failure, you will get a respective message.