One-Click Installation

OrangeHRM Initialization:

Overview:

This guide will walk you through initializing OrangeHRM on your AWS instance in just one click. The setup process is streamlined using our custom script, designed for ease of use and efficiency. Before starting the script, ensure the minimum requirement is met.

Pro Tip: We recommend associating an AWS Elastic IP with your instance before running the setup. This prevents your IP address from changing when the instance is stopped and restarted.

Step 1: Access Your AWS Instance

1. Launch Your AWS EC2 Instance:

• Choose your desired AWS EC2 instance type. (Recommended: t3a.small / t3.small)
• Open ports 22, 80 and 443 in the security group.
• Once the instance is running, connect to it via SSH.

2. Connect to the Instance:

• Open your terminal (Mac/Linux) or use an SSH client (e.g., PuTTY for Windows).
• Run the following SSH command:

3. Run the Initialization Script:

• To initiate the installation, run the following command:

• Note: This script automates the entire installation process. While it runs, ensure your terminal remains active, and do not close the session. It typically takes two to four minutes: the application is downloaded, then OrangeHRM creates its database, its schema and your administrator account before the site is served. The script generates new credentials for this instance.

Step 2: Instance Set Up and Installation

1. Completion Confirmation:

• Once the installation is finished, you will see a summary on the screen with your address and your administrator sign-in.
• Write the password down. It is generated for this instance and is not stored anywhere you can read it back.

2. Sign in with the USERNAME, not an email address

Please note: OrangeHRM asks for a “Username”. The account is keyed on that name, not on an email address. The summary prints it for you. The work email shown alongside it is a separate field on the employee record, and it is not what you sign in with.

• Open http://<your-public-ip>/ in your browser. You will be taken to the sign-in page.
• Enter the username and password from the summary.
• You will arrive at the dashboard, with Admin, PIM, Leave, Time, Recruitment, Performance and My Info reachable from the left.

3. Change the administrator email address

Do this before you go any further. The address the installer generates cannot receive mail. It is on a placeholder domain, so if you lose the password there is no way to reset it. Open My Info, then Contact Details, set your own work email address, and save.

Before you add your staff

• Your organisation. Under Admin, then Organization, set your general information, then add your locations and your structure. Job titles and pay grades live under Admin, then Job.
• Outgoing mail. Under Admin, then Configuration, then Email Configuration. This image does not include a mail server, so no leave notification, no password reset and no interview invitation is delivered until you set a provider.
• Leave. Under Leave, then Configure, define your leave types and entitlements before your staff start requesting time off.
• Then add employees under PIM. Adding people before the structure exists means going back to each record afterwards.

Step 3: Add Your Own Domain and SSL

• Your system is served over plain HTTP until you associate a domain. To use your own domain name with a free SSL certificate, run:

• Full instructions are in Associating Your Domain.
• Do this before your staff start using it. They will be entering personal data, and it should not travel over plain HTTP.

Important Notes:

• Mail Sending Blockage:
  AWS may have email-sending restrictions in place by default. Before using the instance for email sending, submit a request to AWS to lift the restriction on outbound email traffic.
• The database is not reachable from the internet.
  MariaDB runs on a private network inside the instance with no published port. Port 3306 does not need to be open and must not be opened.
• Nothing is registered with the vendor on your behalf.
  A standard OrangeHRM installation ends by sending your organisation name and administrator details upstream. This build declines that. You can register from inside the product if you want to.
• Do not run the installer a second time.
  Each run generates new database passwords, while an existing database keeps the ones it was created with. If you think something went wrong, email [email protected] rather than running it again.