Back to all templates
OrangeHRM logo

OrangeHRM

Application512MB+ RAM

Open-source human resource management system

hrhrmsemployeesmanagement

Deploy OrangeHRM in 3 Steps

1

Connect Your VPS

Add your server credentials to Server Compass

2

Select OrangeHRM

Choose from our template library

3

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required
Step-by-step deployment guide

Deploy OrangeHRM on a VPS with Server Compass

Use the OrangeHRM template in Server Compass to deploy a self-hosted human resource management system with MySQL on your VPS, then verify the OrangeHRM web UI in a browser.

About 7 minutesBrowser verified
1
Step 1

Open the server Apps tab

Select your VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.

Server Compass Apps tab before creating a OrangeHRM app
2
Step 2

Choose an app template

Click New App and choose the template deployment path so Server Compass can load the built-in catalog.

Choosing to deploy an app from a Server Compass template
3
Step 3

Search for OrangeHRM

Use the template picker search to find OrangeHRM in the Server Compass template catalog.

Searching for OrangeHRM in the Server Compass template picker
4
Step 4

Select the OrangeHRM template

Choose the OrangeHRM template. Server Compass fills in the OrangeHRM web service, MySQL database, generated database password, and generated root database password.

OrangeHRM template selected in Server Compass
5
Step 5

Review the OrangeHRM settings

Confirm the app name and compose services. In this run, the app was named orangehrm-demo and used host port 3001.

Reviewing OrangeHRM project settings and compose services
6
Step 6

Deploy OrangeHRM

Review the generated environment values, confirm the port is available, and click Deploy Now.

Reviewing OrangeHRM environment variables and port before deployment
7
Step 7

Watch the deployment progress

Keep the deployment modal open while Server Compass uploads the compose file, pulls the OrangeHRM image, starts the container, and verifies the stack.

Server Compass deploying the OrangeHRM template on the VPS
8
Step 8

Confirm OrangeHRM is running

After deployment finishes, return to the Apps tab and confirm the OrangeHRM app is marked Running with its application URL available.

OrangeHRM template running in the Server Compass Apps tab
9
Step 9

Open OrangeHRM in the browser

Open the application URL in a browser. The OrangeHRM web UI confirms the HR system is reachable.

The deployed OrangeHRM web UI loaded in a browser

After OrangeHRM Opens

  • Complete the OrangeHRM installation wizard and create the administrator account before production use.
  • Configure HTTPS, email delivery, employee records, roles, and organization settings before inviting HR users.
  • Back up the OrangeHRM files and MySQL volumes before relying on production HR data.

Verified Result

The OrangeHRM web UI loaded successfully in a browser.

OrangeHRM deployment questions

What does the OrangeHRM template deploy?

It deploys OrangeHRM with MySQL so teams can run a self-hosted HR management system.

Which port did the tutorial use?

The tutorial used host port 3001, which maps to the OrangeHRM web service on container port 80.

Why does the guide stop at the login or setup web UI?

The tutorial verifies the clean OrangeHRM web UI because employee records, roles, organization structure, and HR workflows depend on the production instance.

Should this become a blog post?

No. The deployment guide should live on the OrangeHRM template detail page and be linked from the reusable template deployment docs page.

Manual Setup Guide

Set Up OrangeHRM from Terminal

Get your hands dirty: manual OrangeHRM deployment guide for developers.

1

Remote into Your Server

Initiate a secure shell connection to your server using the command below.

terminal
# Connect to your VPS
ssh root@your-server-ip

# Or with a specific SSH key
ssh -i ~/.ssh/your-key root@your-server-ip

First time? Docker required! Install it with: curl -fsSL https://get.docker.com | sh

2

Create the App Directory

Organize your deployment by creating a dedicated project folder.

terminal
# Create and navigate to project directory
mkdir -p ~/apps/orangehrm
cd ~/apps/orangehrm
3

Write Your docker-compose.yml

Create a new docker-compose.yml file and paste this configuration:

docker-compose.yml
services:
  orangehrm:
    image: orangehrm/orangehrm:latest
    ports:
      - "8080:80"
    environment:
      - ORANGEHRM_DATABASE_HOST=db
      - ORANGEHRM_DATABASE_USER=orangehrm
      - ORANGEHRM_DATABASE_PASSWORD=<your-db-password>
      - ORANGEHRM_DATABASE_NAME=orangehrm
    volumes:
      - orangehrm_data:/var/www/html
    restart: unless-stopped
    depends_on:
      - db

  db:
    image: mysql:8.0
    environment:
      - MYSQL_ROOT_PASSWORD=<your-db-root-password>
      - MYSQL_DATABASE=orangehrm
      - MYSQL_USER=orangehrm
      - MYSQL_PASSWORD=<your-db-password>
    volumes:
      - mysql_data:/var/lib/mysql
    restart: unless-stopped

volumes:
  orangehrm_data:
  mysql_data:
Environment Variables
PORTHost port(default: 8080)
DB_PASSWORDDB password
DB_ROOT_PASSWORDRoot password
4

Launch the Containers

Start the services and tail the logs to verify startup.

terminal
# Spin up containers
docker compose up -d

# Verify deployment
docker compose ps

# Check logs for errors
docker compose logs -f
5

Open Firewall Ports

Open the required port in your firewall to allow access.

terminal
# Allow the application port through firewall
sudo ufw allow 8080/tcp
sudo ufw reload

# Access your app at:
# http://your-server-ip:8080
Skip the Terminal

Want the easy way? Try Server Compass.

Why type commands when you can click? Deploy OrangeHRM the easy way with Server Compass.

  • Visual config editor
  • Instant deployment
  • Automatic HTTPS
  • Smooth updates
  • Live monitoring
  • Quick rollbacks
Download Server Compass$29 one-time • Lifetime license

After Deployment

After deploying OrangeHRM with Server Compass, complete these steps to finish setup

1

Complete installation wizard

2

Create admin account

3

Configure organization structure

Need help? Check out our documentation for detailed guides.

OrangeHRM FAQ

Common questions about self-hosting OrangeHRM

How do I deploy OrangeHRM with Server Compass?

Simply download Server Compass, connect to your VPS, and select OrangeHRM from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for OrangeHRM?

OrangeHRM requires a minimum of 512MB RAM. We recommend a VPS with at least 1024MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing OrangeHRM data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard OrangeHRM backup and restore procedures.

How do I update OrangeHRM to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest OrangeHRM image will be pulled and deployed with zero downtime.

Is OrangeHRM free to self-host?

OrangeHRM is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.

Ready to Self-Host OrangeHRM?

Download Server Compass and deploy OrangeHRM to your VPS in under 3 minutes. No Docker expertise required.

Download Server Compass