How to Install OrangeHRM on Your Synology NAS

by

How to Install OrangeHRM on Your Synology NAS

OrangeHRM is a comprehensive Human Resource Management (HRM) System that captures all the essential functionalities required for any enterprise. The software is built to support teams of any size, including start-ups, SMEs as well as Large Multinational organizations. In this step by step guide I will show you how to install OrangeHRM on your Synology NAS using Docker and Portainer.

💡Note: This guide works perfectly with the latest OrangeHRM v5.7 release.

  • STEP 1

Please Support My work by Making a Donation.

  • STEP 2

Install Portainer using my step by step guide. If you already have Portainer installed on your Synology NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.

  • STEP 3

Go to File Station and open the docker folder. Inside the docker folder, create one new folder and name it orangehrm. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

OrangeHRM Synology NAS Set up 1 new 2023

  • STEP 4

Now create two new folders inside the orangehrm folder that you created at STEP 3 and name them data and db. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

OrangeHRM Synology NAS Set up 2 new 2023

  • STEP 5

Log into Portainer using your username and password. On the left sidebar in Portainer, click on Stacks then + Add stack. Follow the instructions in the image below.

1 Synology Portainer Add Stack

  • STEP 6

In the Name field type in orangehrm. Follow the instructions in the image below.

Note: Copy Paste the code below in the Portainer Stacks Web editor.

version: "3.9"
services:
  db:
    image: mariadb:10.8-jammy
    container_name: OrangeHRM-db
    hostname: orangehrm-db
    mem_limit: 512m
    mem_reservation: 128m
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD-SHELL", "mysqladmin ping -P 3306 -prootpass | grep 'mysqld is alive' || exit 1"]
    volumes:
      - /volume1/docker/orangehrm/db:/var/lib/mysql:rw
    environment:
      PUID: 1026
      PGID: 100
      TZ: Europe/Bucharest
      MYSQL_ROOT_PASSWORD: rootpass
      MYSQL_DATABASE: orangehrm
      MYSQL_USER: orangeuser
      MYSQL_PASSWORD: orangepass
    restart: on-failure:5

  orangehrm:
    image: orangehrm/orangehrm:latest
    container_name: OrangeHRM
    hostname: orangehrm
    mem_limit: 1g
    mem_reservation: 128m
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: curl -f http://localhost || exit 1
    ports:
      - 8797:80
    volumes:
      - /volume1/docker/orangehrm/data:/orangehrm:rw
    environment:
      PUID: 1026
      PGID: 100
      ORANGEHRM_DATABASE_HOST: orangehrm-db
      ORANGEHRM_DATABASE_USER: orangeuser
      ORANGEHRM_DATABASE_PASSWORD: orangepass
      ORANGEHRM_DATABASE_NAME: orangehrm
    restart: on-failure:5
    depends_on:
      db:
        condition: service_started

Note: Before you paste the code above in the Web editor area below, change the value numbers for PUID and PGID with your own values. (Follow my step by step guide on how to do this.) 1026 is my personal PUID value and 100 is my personal PGID value. You have to type in your own values.
Note: Before you paste the code above in the Web editor area below, change the value for TZ. (Select your current Time Zone from this list.)

OrangeHRM Synology NAS Set up 3 new1 2023

  • STEP 7

Scroll down on the page until you see a button named Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.

OrangeHRM Synology NAS Set up 4 new2 2023

  • STEP 8

If everything goes right, you will see the following message at the top right of your screen: “Success Stack successfully deployed“.

OrangeHRM Synology NAS Set up 5 new 2023

  • STEP 9

Go back to STEP 1 or you will deal with karma 🙂

  • STEP 10

Open your browser and type in http://Synology-ip-address:8797 Select Fresh Installation then click Next. Follow the instructions in the image below.

OrangeHRM Synology NAS Set up 6 new 2023

  • STEP 11

Check I accept the terms in the License Agreement. Click Next. Follow the instructions in the image below.

OrangeHRM Synology NAS Set up 7 new 2023

  • STEP 12

Select “Existing Empty Database” then add the following parameters. After that, click Next. Follow the instructions in the image below.

Database Host Name: orangehrm-db
Database Host Port: 3306
Database Name: orangehrm
OrangeHRM Database Username: orangeuser
OrangeHRM Database Password: orangepass

OrangeHRM Synology NAS Set up 8 new 2023

  • STEP 13

Click Next. Follow the instructions in the image below.

OrangeHRM Synology NAS Set up 9 new 2023

  • STEP 14

Add your own organization details then click Next. Follow the instructions in the image below.

OrangeHRM Synology NAS Set up 10 new 2023

  • STEP 15

Add your own Admin details then click Next. Follow the instructions in the image below.
Note: You will need the Username and Password later at STEP 19. Write them down somewhere.

OrangeHRM Synology NAS Set up 11 new 2023

  • STEP 16

Click Install. Follow the instructions in the image below.

OrangeHRM Install Synology NAS Set up 12 new 2023

  • STEP 17

Make sure ALL the checkmarks are GREEN before you touch anything!
DO NOT refresh the page!
DO NOT click Next even if the progress bar reaches 100%!
Wait until absolutely every checkmark is GREEN, then click Next.
The process can last up to 10 minutes so be patient.
Note: At first, the progress bar will stop at 99%. Wait a few minutes. In the second phase, the progress bar will reach 100%, but not all the checkmarks will be green. Wait some more without touching anything at all. As soon as all the checkmarks are green, click Next.

OrangeHRM Synology NAS Set up 13 new 2023

  • STEP 18

Click Launch OrangeHRM. Follow the instructions in the image below.

OrangeHRM Synology NAS Set up 14 new 2023

  • STEP 19

Type in your own Username and Password that you have previously created at STEP 15. Follow the instructions in the image below.

OrangeHRM Synology NAS Set up 15 new 2023

  • STEP 20

Your OrangeHRM Dashboard at a glance!

OrangeHRM Synology NAS Set up 16 new 2023

Enjoy OrangeHRM!

🆘TROUBLESHOOTING

If you encounter issues by using this container, make sure to check out the Common Docker issues article.

Note: If you want to run the OrangeHRM container over HTTPS, check out my article How to Run Docker Containers Over HTTPS. In order to make OrangeHRM work via HTTPS, it’s mandatory to activate WebSocket. ⚠️Warning: The OrangeHRM guide was not launched in HTTPS from the beginning because the initial database creation works only in http/localhost. Once you have installed it in localhost, you can Reverse Proxy OrangeHRM without any issues.

Note: Can I run Docker on my Synology NAS? See the supported models.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Find out how to update the OrangeHRM container with the latest image.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: Instead of the synology.me DDNS you can also use your own domain name.
Note: How to Schedule Start & Stop For Docker Containers.
Note: How to Activate Email Notifications.
Note: How to Add Access Control Profile on Your NAS.
Note: How to Change Docker Containers Restart Policy.
Note: How to Use Docker Containers With VPN.
Note: Convert Docker Run Into Docker Compose.
Note: How to Clean Docker.
Note: How to Clean Docker Automatically.
Note: Best Practices When Using Docker and DDNS.
Note: Some Docker Containers Need WebSocket.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Containers.

This post was updated on Friday / August 23rd, 2024 at 3:14 AM

🧡 I Need Your Help!