OrangeHRM Installation Guide

OrangeHRM is very easy to install. Whether you use Windows or Linux, simply watch the video tutorial on the web-based installer, and you will have one of the best HRIS systems running within minutes.

Prerequisites

The pre-requirements are:

  • Apache HTTP Server 2.2.22 or later
  • MySQL 5.5 or later
  • PHP 5.4 or later - If you already have Apache HTTP Web server (and PHP loaded as an Apache Module) and MySQL running, then you have everything you need.

In case you do not have the requisites setup, you have two options:

  1. Use an AMP stack which has Apache, MySQL, and PHP pre-configured to work together.
  2. If you want you can configure Apache, MySQL and PHP on your own manually. You can refer to the OrangeHRM FAQ on how to install/configure them.
AMP Stack

 

AMP Stack for Windows

Recommended AMP stack for Windows is XAMPP Windows.Download

Notice: Make sure you download the Installer from the Basic Package and not the upgrades, developer packs, etc.

After downloading, start installing XAMPP for Windows.

 

    • You can choose the default installation location and click 'Next'
    • When asked to "Install XAMPP Servers (Apache, MySQL etc) as service?", 
      • When asked "Install Apache 2 as service?", select Yes
      • When asked "Install MySQL as service?", select Yes
    • You may skip the other services by selecting No since they are not required for OrangeHRM
    • Select Yes to start the XAMPP control panel too.
    • Notice: In case you use any firewall software (i.e.: Windows Firewall) and if it prompts please make sure that XAMPP services (Apache Web Server, MySQL) are exempted from the blocked list.
    • If you use Skype, this may result in a port conflict with Apache web-server included in XAMPP when install. Therefore make sure you re-start Windows to make sure that XAMPP services start before Skype (then Skype will go for an alternate port).

AMP Stack for Linux

Recommended AMP stack for Linux is XAMPP Linux.Download

Notice: Make sure you download complete stack (usually the biggest download out of the lot) and not the upgrades, developer packs, etc.

After downloading, install XAMPP Linux. Follow the instructions that come with XAMPP Linux or given on the XAMPP site.

Note: You always have to manually start the stack, every time you reboot.

Notes

You will have to change the ownership of OrangeHRM files to nobody.nobody Type the following in the shell. is the path where the OrangeHRM files are located. Ex. /opt/xampp/htdocs/orangehrm2/ $ chown -R nobody:nobody or chown -R nobody

Web Installation

Note: XAMPP users, the Linux stack needs to be started manually. Refer to the stack documentation.

Using a JavaScript enabled browser go to http://hostname/orangehrm2/

Above hostname is "localhost" if it is installed in the machine you are currently working on or IP address if it is remotely hosted (i.e. external to the machine you are using).

 

Recommended Browsers

  • Mozilla Firefox 1.0 or later.
  • Microsoft® Internet Explorer 5.5 or later.

 

Web installation will be briefly described bellow.

Welcome Screen

It will state which version of OrangeHRM will be installed.

Click [Next] button in the Welcome screen to proceed with the installation.

License Acceptance

Here you will be provided with a copy of the GNU GENERAL PUBLIC LICENSE and to continue the installation you will have to accept the license. If you decline simply discontinue the installation and delete all OrangeHRM files you posses.

Click [I Accept] button if you accept the terms and conditions of the license. Then you will be taken to the next page of the Web Installer.

System Check

Here the Web Installer will check whether the pre-requirements are available.

If all responses are green you can safely continue. You have installed the correct versions of the pre-requisites and configured them to work.

See below for all the color codes in a sample situation.

system check

Click [Next] button in the System Check screen to continue.

 

 

Notes

Maximum Session Idle Time before Timeout

Maximum Session Idle Time before Timeout is checked to ensure that users don't get logged out within a short period such as less than 15 minutes. As a precaution it's not possible to continue installing OrangeHRM if the session times out in less than 2 minutes.Maximum Session Idle Time before Timeout is checked to ensure that users don't get logged out within a short period such as less than 15 minutes. As a precaution it's not possible to continue installing OrangeHRM if the session times out in less than 2 minutes.


How to Fix

You will have to change session.gc_maxlifetime in the php.ini file. (Default session.g c_maxlifetime = 1440)


Important

It is still possible that some other php application running in the same server overriding session.gc_maxlifetime value in the php.ini file at runtime. This will be the case if you are running OrangeHRM in a shared host. Workaround is available but beyond the scope of this document.

How to enable InnoDB support in MySQL

To enable "InnoDB" please open "my" (or "my.cnf") file in a text editor and search for "skip-innodb" and add the leading "#" and restart the MySQL database server to enable InnoDB.


ex:
.
.
.
skip-innodb
.
.
.
should read as
.
.
.
#skip-innodb
.
.
.

(in XAMPP for windows my.cnf is found in C:\xampp\mysql\bin\my.cnf)

(in XAMPP for linux my.cnf is found in /opt/lampp/etc/my.cnf)

Database Creation

Enter the relevant information about your MySQL database server and database users.

Click [Next] in Database Creation screen to continue.

Notes

Privileged Database Users and OrangeHRM Database Users

Database Server users could be assigned different rights. For the web installer to create the OrangeHRM Database, you need to give a Database user account details (user-name/password) with permissions CREATE, ALTER, DROP, INSERT under the field Privileged Database User/Password.

Since OrangeHRM requires only permissions INSERT, UPDATE, SELECT and DELETE to interact with database, the web installer could create a separate database user account to for OrangeHRM. It is always recommended that you create a separate user account for OrangeHRM. To do so fill in OrangeHRM User details(username/password) as required by you, and web-installer would create the account for you.

Note: Since the database user account details used by OrangeHRM are stored in plain text, it would be a security threat to have OrangeHRM use Privileged user account.

Admin User Creation

Type in the Admin Username, Password and Confirm Admin User Password.

Click [Next] button in Admin User Creation Screen to continue.

Confirmation

Confirm whether the installation details are correct and Click [Install] button on the Confirmation screen to install.

 

Notes

The installation will begin immediately. Once you click [install there is no way that you can stop the installation from starting. You cannot roll back the installation as well. Click [Install] only if you are sure that you want to install with the given configuration.

Installing

Here you will be shown the progress of the installation. Once the installation is completed the [Next] button will be enabled. Click

Next] button in the Installing screen to continue.

If an error occurs during the installation the whole installation will be aborted.

Click [Clean Up Install] to go to previous pages to correct the error and restart the installation. See screenshots

 

[Skip screen shots]

Following are sample screenshots of the Installing screen:

OrangeHRM Installing

The installation has just started.

OrangeHRM Installing Step 8

Installation in progress.

OrangeHRM Installing Installation in progress.

The installation has finished successfully. 

OrangeHRM Installation Finished

The installation has been aborted due to an error.

 

Registration

If you want to be Up-to-Date on news about OrangeHRM, please provide your E-mail address and a name that the e-mails should be addressed to. We would appreciate if you register here, then we will know how many users have successfully installed OrangeHRM.

You can also provide your comments.

If you want to receive Updates or Newsletters select the tick box [Updates/Newsletter]. Click [Register] to send the information.

If the registration is successful you can click [Login to OrangeHRM] to Login to OrangeHRM.

If you don't want to register click [No thanks!].

 

Notes

If the sending of registration Information fails an error message will be shown. Click [Retry] to send the details again or [Skip] to skip this step an you will not be registered.

FAQ - Self-Extracting Installer

This can be because your current virus guard blocks internal processes of OrangeHRM Self-extracting Installer. Try following steps.

  • Restart the operating system.
  • Quit the virus guard.
  • Start OrangeHRM Self-extracting Installer.
  • Start the virus guard.

 

Can't I run Skype and OrangeHRM Self-extracting Installer together?

OrangeHRM uses Apache web server and that uses the port 80 in your computer. Usually Skype also uses port 80 but it can use different ports too. Try following steps.

  • Go to Skype Options > Advanced Settings > Connection.
  • Uncheck port 80 where it says "Use port 80 and 443 for incoming connections".

You may observe the issue with some other software products as well (like TeamViewer). In such cases, see whether you can change the port of the product in question. If not, you will first have to quit from the software, start OrangeHRM and then start the software.

What's the difference between OrangeHRM Self-extracting Installer and OrangeHRM web installer?

OrangeHRM is a web based product written in PHP and uses a MySQL database to store data. It has an HTML interface. To run OrangeHRM, you need to have Apache, MySQL and PHP (AMP) already installed in your computer. If you haven't installed these software products, you can use OrangeHRM Self-extracting Installer that automatically installs AMP. If you already have an AMP setup, try OrangeHRM web installer (zip or tar.gz) which only contains OrangeHRM source files.

I already have Apache, MySQL and PHP installed. Can I use OrangeHRM Self-extracting Installer still?

If you already have an AMP setup, you need not use OrangeHRM Self-extracting Installer since it also installs an AMP stack. Try OrangeHRM web installer instead.

I can't open OrangeHRM?

Once you have installed OrangeHRM, there will be a Desktop icon and you will also be able to access it under Programs of your Start menu. However for some reason, if OrangeHRM doesn't start, try following steps.

  • Go to OrangeHRM installed location (Usually C:\Program Files\OrangeHRM).
  • Locate XAMPP control panel and make sure Apache and MySQL are running (Alternatively you can type http://127.0.0.1/ in your web browser and see whether you get XAMPP default page).
  • Type OrangeHRM URL in your web browser based on your OrangeHRM version. For an example, if you installed OrangeHRM 2.7, URL you need to type would be http://127.0.0.1/orangehrm-2.7/
XAMPP Control Panel crashes on exit?

On Windows Vista / Windows 7 systems with UAC () enabled, if OrangeHRM is installed under the Program Files directory, XAMPP control panel can crash on exit if run as a normal user. You should run XAMPP control panel as an administrator, using the right click -> run as administrator option to avoid this issue.