Linux (Ubuntu) Installation - 4.0.16

From IHRIS Wiki
Revision as of 13:02, 6 July 2011 by Lduncan (talk | contribs)

This page contains installation instructions on installing iHRIS version 4.0.16 manually.


You may wish to see instructions on how to install debian packages for a simpler installation process.

Warning: See Installing iHRIS on Ubuntu 10.4 or 10.10 after completing these instructions to get iHRIS working on the latest release of Ubuntu.


Need help? Try our Project Communication

Getting Ready

First you should install Ubuntu and all the supporting software required by iHRIS by following the Linux (Ubuntu) Installation - Supporting Software instructions.

Optionally, you can install Memcached to speed up your site.


Note: Unless specifically mentioned, all the commands below are run using a terminal. You can start this in Ubuntu by going to Applications -> Accessories -> Terminal. Any time a command begins with sudo it will prompt for your password because this will be run with administrative privileges. When you run sudo multiple times, only the first time will ask for your password.

Note: Some installation commands will prompt for inputs in the terminal window, usually with a blue background. The mouse doesn't work to click on options here. You can use Tab to move between options and the space bar to check or uncheck selections.

Note: Some commands will launch the gedit file editor. Look at the documentation if you need additional help.

Downloading the Software

To download the software you enter these commands: <source lang="bash"> sudo mkdir -p /var/lib/iHRIS/lib/4.0.16 cd /var/lib/iHRIS/lib/4.0.16 sudo wget http://launchpad.net/ihris-manage/4.0/4.0.16/+download/ihris-manage-full-4.0.16.tar.bz2 sudo tar -xjf ihris-manage-full-4.0.16.tar.bz2 </source>

Database Setup

To create the needed database you can do: <source lang="bash"> mysql -u root -p </source> Enter the password you set above (XXXXX) for MySQL. You will now be able to send commands to MySQL and the prompt should always begin with 'mysql> '. Type these commands: <source lang="mysql"> CREATE DATABASE ihris_manage; GRANT ALL PRIVILEGES ON ihris_manage.* TO ihris_manage@localhost identified by 'PASS'; exit </source> Substitute PASS with something appropriate. We'll refer to this password as YYYYY.

If you want to install iHRIS Qualify (or iHRIS Plan) just replace everywhere you see manage with qualify (or plan).

In version 4.0.1 of iHRIS we create mysql functions. If you are having trouble creating routines see this.

Alternatively, you may choose to install phpmyadmin to administer database through the web <source lang="bash"> sudo apt-get install phpmyadmin </source> A screen will come up asking if you want to install for apache2 or lighttpd. Highlight apache2 and press the spacebar to select it. It will ask for the root password (XXXXX) and you may also opt to create a phpmyadmin user to extra features. Select a password for this user as well.

Now browse to:

http://localhost/phpmyadmin

login with the user 'root' and password XXXXX that you set above. Once logged in you will create a database and user called ihris_manage. To do this, click on the 'Privileges' link and select 'Add a new User'. Then fill out the form as follows:

Creating iHRIS_Manage Database and User

For security, make sure the password you choose is different than the root password for MySQL. Let us refer to this password as YYYYY.

Creating a Site Configuration File

We are going to start by modifying the BLANK site for iHRIS Manage. If you wish to install iHRIS Qualify or iHRIS Plan, you can follow the same instructions below but change manage to qualify or plan. To copy the BLANK site: <source lang="bash"> sudo mkdir -p /var/lib/iHRIS/sites sudo cp -R /var/lib/iHRIS/lib/4.0.16/ihris-manage/sites/blank /var/lib/iHRIS/sites/manage </source>

Set Email Address (Optional)

You may optionally choose to change the email address feedback is sent to by editting the site configuration file: <source lang="bash"> sudo gedit /var/lib/iHRIS/sites/manage/iHRIS-Manage-BLANK.xml </source> changing: <source lang="xml"> <configuration name='email' path='to' values='single'>

 <displayName>Email Address</displayName>
 <value>BLANK</value>

</configuration> </source> to: <source lang="xml"> <configuration name='email' path='to' values='single'>

 <displayName>Email Address</displayName>
 <value>my_email@somewhere.com</value>

</configuration> </source>

Making the Site Available

We will now edit the configuration to let the site know about the database user and options: <source lang="bash"> sudo gedit /var/lib/iHRIS/sites/manage/pages/config.values.php </source> We now need to uncomment and set the value of a few variables. Commented lines will begin with two slashes (//) that you'll need to remove.

They are:

Variable NameValue
$i2ce_site_i2ce_path/var/lib/iHRIS/lib/4.0.16/I2CE
$i2ce_site_dsnmysql://ihris_manage:YYYYY@localhost/ihris_manage
$i2ce_site_module_config/var/lib/iHRIS/sites/manage/iHRIS-Manage-BLANK.xml

In $i2ce_site_dsn, YYYYY is the password you set above.

Save and quit.

Finally, we make iHRIS Manage site we just created available via the webserver: <source lang="bash"> sudo ln -s /var/lib/iHRIS/sites/manage/pages /var/www/manage </source>

Pretty URLs

This is an optional step to make URLs cleaner by removing the index.php. <source lang="bash"> sudo cp /var/www/manage/htaccess.TEMPLATE /var/www/manage/.htaccess sudo gedit /var/www/manage/.htaccess </source> We need to look for the line RewriteBase and change it to the web directory we want to use we are using, /manage.

Change the line that looks like: <source lang="apache">

   RewriteBase /iHRIS/manage-BLANK

</source> to: <source lang="apache">

   RewriteBase /manage

</source> You may now save and quit.

Finishing Up

Now we are ready to begin the site installation. Simply browse to:

http://localhost/manage

and wait for the site to initalize itself. Congratulations! You may log in as the i2ce_admin with the password you used to connect to the database (YYYYY that you set above).

Files

Here are samples of the files we edited above. WARNING THESE ARE OUT OF DATE AND REFER TO AN OLD VERSION OF THE SOFTWARE