Skip to content
Bitnami Docker Image for OrangeHRM
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
4
LICENSE
README.md
docker-compose.yml

README.md

What is OrangeHRM?

OrangeHRM Open Source is a free HR management system that offers a wealth of modules to suit the needs of your business. This widely-used system is feature-rich, intuitive and provides an essential HR management platform along with free documentation and access to a broad community of users.

https://www.orangehrm.com/

TL;DR;

Docker Compose

$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-orangehrm/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d

Why use Bitnami Images?

  • Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
  • With Bitnami images the latest bug fixes and features are available as soon as possible.
  • Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
  • All our images are based on minideb a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading linux distribution.
  • All Bitnami images available in Docker Hub are signed with Docker Content Trust (DTC). You can use DOCKER_CONTENT_TRUST=1 to verify the integrity of the images.
  • Bitnami container images are released daily with the latest distribution packages available.

This CVE scan report contains a security report with all open CVEs. To get the list of actionable security issues, find the "latest" tag, click the vulnerability report link under the corresponding "Security scan" field and then select the "Only show fixable" filter on the next page.

How to deploy OrangeHRM in Kubernetes?

Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the Bitnami OrangeHRM Chart GitHub repository.

Bitnami containers can be used with Kubeapps for deployment and management of Helm Charts in clusters.

Supported tags and respective Dockerfile links

NOTE: Debian 8 images have been deprecated in favor of Debian 9 images. Bitnami will not longer publish new Docker images based on Debian 8.

Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.

Subscribe to project updates by watching the bitnami/orangehrm GitHub repo.

Prerequisites

To run this application you need Docker Engine >= 1.10.0. Docker Compose is recommended with a version 1.6.0 or later.

OrangeHRM requires access to a MySQL database or MariaDB database to store information.

How to use this image

Running OrangeHRM with a database server is the recommended way. You can either use docker-compose or run the containers manually. We'll use our very own MariaDB image for the database requirements.

Using Docker Compose

The main folder of this repository contains a functional docker-compose.yml file. Run the application using it as shown below:

$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-orangehrm/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d

Using the Docker Command Line

If you want to run the application manually instead of using docker-compose, these are the basic steps you need to run:

  1. Create a network
$ docker network create orangehrm-tier
  1. Create a volume for MariaDB persistence and create a MariaDB container
$ docker volume create --name mariadb_data
$ docker run -d --name mariadb -e ALLOW_EMPTY_PASSWORD=yes \
  -e ALLOW_EMPTY_PASSWORD=yes \
  -e MARIADB_USER=bn_orangehrm \
  -e MARIADB_DATABASE=bitnami_orangehrm \
  --net orangehrm-tier \
  --volume mariadb_data:/bitnami \
  bitnami/mariadb:latest
  1. Create volumes for OrangeHRM persistence and launch the container
$ docker volume create --name orangehrm_data
$ docker run -d --name orangehrm -p 80:80 -p 443:443 \
  -e ALLOW_EMPTY_PASSWORD=yes \
  -e ORANGEHRM_DATABASE_USER=bn_orangehrm \
  -e ORANGEHRM_DATABASE_NAME=bitnami_orangehrm \
  --net orangehrm-tier \
  --volume orangehrm_data:/bitnami \
  bitnami/orangehrm:latest

Access your application at http://your-ip/

Persisting your application

If you remove the container all your data and configurations will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.

For persistence you should mount a volume at the /bitnami path. Additionally you should mount a volume for persistence of the MariaDB data.

The above examples define docker volumes namely mariadb_data and orangehrm_data. The OrangeHRM application state will persist as long as these volumes are not removed.

To avoid inadvertent removal of these volumes you can mount host directories as data volumes. Alternatively you can make use of volume plugins to host the volume data.

Mount host directories as data volumes with Docker Compose

This requires a minor change to the docker-compose.yml file present in this repository:

services:
  mariadb:
  ...
    volumes:
      - /path/to/mariadb-persistence:/bitnami
  ...
  orangehrm:
  ...
    volumes:
      - /path/to/orangehrm-persistence:/bitnami
  ...

Mount host directories as data volumes using the Docker command line

  1. Create a network (if it does not exist)
$ docker network create orangehrm-tier
  1. Create a MariaDB container with host volume
$ docker run -d --name mariadb \
  -e ALLOW_EMPTY_PASSWORD=yes \
  -e MARIADB_USER=bn_orangehrm \
  -e MARIADB_DATABASE=bitnami_orangehrm \
  --net orangehrm-tier \
  --volume /path/to/mariadb-persistence:/bitnami \
  bitnami/mariadb:latest
  1. Create the OrangeHRM the container with host volumes
$ docker run -d --name orangehrm -p 80:80 -p 443:443 \
  -e ALLOW_EMPTY_PASSWORD=yes \
  -e ORANGEHRM_DATABASE_USER=bn_orangehrm \
  -e ORANGEHRM_DATABASE_NAME=bitnami_orangehrm \
  --net orangehrm-tier \
  --volume /path/to/orangehrm-persistence:/bitnami \
  bitnami/orangehrm:latest

Upgrading OrangeHRM

Bitnami provides up-to-date versions of MariaDB and OrangeHRM, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the OrangeHRM container. For the MariaDB upgrade see https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#upgrade-this-image

The bitnami/orangehrm:latest tag always points to the most recent release. To get the most recent release you can simple repull the latest tag from the Docker Hub with docker pull bitnami/orangehrm:latest. However it is recommended to use tagged versions.

  1. Get the updated images:
$ docker pull bitnami/orangehrm:latest
  1. Stop your container
  • For docker-compose: $ docker-compose stop orangehrm
  • For manual execution: $ docker stop orangehrm
  1. Take a snapshot of the application state
$ rsync -a /path/to/orangehrm-persistence /path/to/orangehrm-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)

Additionally, snapshot the MariaDB data

You can use these snapshots to restore the application state should the upgrade fail.

  1. Remove the currently running container
  • For docker-compose: $ docker-compose rm -v orangehrm
  • For manual execution: $ docker rm -v orangehrm
  1. Run the new image
  • For docker-compose: $ docker-compose up orangehrm
  • For manual execution (mount the directories if needed): docker run --name orangehrm bitnami/orangehrm:latest

Configuration

Environment variables

The OrangeHRM instance can be customized by specifying environment variables on the first run. The following environment values are provided to custom OrangeHRM:

User and Site configuration
  • ORANGEHRM_USERNAME: OrangeHRM application username. Default: admin
  • ORANGEHRM_PASSWORD: OrangeHRM application password. Default: Bitnami.12345
Use an existing database
  • MARIADB_HOST: Hostname for MariaDB server. Default: mariadb
  • MARIADB_PORT_NUMBER: Port used by MariaDB server. Default: 3306
  • ORANGEHRM_DATABASE_NAME: Database name that OrangeHRM will use to connect with the database. Default: bitnami_orangehrm
  • ORANGEHRM_DATABASE_USER: Database user that OrangeHRM will use to connect with the database. Default: bn_orangehrm
  • ORANGEHRM_DATABASE_PASSWORD: Database password that OrangeHRM will use to connect with the database. No defaults.
  • ALLOW_EMPTY_PASSWORD: It can be used to allow blank passwords. Default: no
Create a database for OrangeHRM using mysql-client
  • MARIADB_HOST: Hostname for MariaDB server. Default: mariadb
  • MARIADB_PORT_NUMBER: Port used by MariaDB server. Default: 3306
  • MARIADB_ROOT_USER: Database admin user. Default: root
  • MARIADB_ROOT_PASSWORD: Database password for the MARIADB_ROOT_USER user. No defaults.
  • MYSQL_CLIENT_CREATE_DATABASE_NAME: New database to be created by the mysql client module. No defaults.
  • MYSQL_CLIENT_CREATE_DATABASE_USER: New database user to be created by the mysql client module. No defaults.
  • MYSQL_CLIENT_CREATE_DATABASE_PASSWORD: Database password for the MYSQL_CLIENT_CREATE_DATABASE_USER user. No defaults.
  • ALLOW_EMPTY_PASSWORD: It can be used to allow blank passwords. Default: no

If you want to add a new environment variable:

Specifying Environment variables using Docker Compose

This requires a change to the docker-compose.yml file present in this repository:

services:
  mariadb:
  ...
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
      - MARIADB_USER=bn_orangehrm
      - MARIADB_DATABASE=bitnami_orangehrm
  ...
  orangehrm:
  ...
    environment:
      - ORANGEHRM_PASSWORD=my_password
      - MARIADB_HOST=mariadb
      - MARIADB_PORT_NUMBER=3306
      - ORANGEHRM_DATABASE_USER=bn_orangehrm
      - ORANGEHRM_DATABASE_NAME=bitnami_orangehrm
      - ALLOW_EMPTY_PASSWORD=yes
  ...

Specifying Environment variables on the Docker command line

$ docker run -d --name orangehrm -p 80:80 -p 443:443 \
  --net orangehrm-tier \
  --env ORANGEHRM_PASSWORD=my_password \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env ORANGEHRM_DATABASE_USER=bn_orangehrm \
  --env ORANGEHRM_DATABASE_NAME=bitnami_orangehrm \
  --env ORANGEHRM_PASSWORD=my_password \
  --volume orangehrm_data:/bitnami \
  bitnami/orangehrm:latest

SMTP Configuration

To configure OrangeHRM to send email using SMTP you can set the following environment variables:

  • SMTP_HOST: Host for outgoing SMTP email.
  • SMTP_PORT: Port for outgoing SMTP email.
  • SMTP_USER: User of SMTP used for authentication.
  • SMTP_PASSWORD: Password for SMTP.
  • SMTP_PROTOCOL: Secure connection protocol to use for SMTP [ssl or none].

This would be an example of SMTP configuration using a GMail account:

  orangehrm:
  ...
    environment:
      - MARIADB_HOST=mariadb
      - MARIADB_PORT_NUMBER=3306
      - ORANGEHRM_DATABASE_USER=bn_orangehrm
      - ORANGEHRM_DATABASE_NAME=bitnami_orangehrm
      - SMTP_HOST=smtp.gmail.com
      - SMTP_PORT=465
      - SMTP_USER=your_email@gmail.com
      - SMTP_PASSWORD=your_password
      - SMTP_PROTOCOL=ssl
  ...
  • For manual execution:
 $ docker run -d --name orangehrm -p 80:80 -p 443:443 \
   --net orangehrm-tier \
   --env MARIADB_HOST=mariadb \
   --env MARIADB_PORT_NUMBER=3306 \
   --env ORANGEHRM_DATABASE_USER=bn_orangehrm \
   --env ORANGEHRM_DATABASE_NAME=bitnami_orangehrm \
   --env SMTP_HOST=smtp.gmail.com \
   --env SMTP_PORT=465 --env SMTP_PROTOCOL=ssl \
   --env SMTP_USER=your_email@gmail.com \
   --env SMTP_PASSWORD=your_password \
   --volume orangehrm_data:/bitnami \
   bitnami/orangehrm:latest

Customize this image

The Bitnami OrangeHRM Docker image is designed to be extended so it can be used as the base image for your custom web applications.

Extend this image

Before extending this image, please note there are certain configuration settings you can modify using the original image:

If your desired customizations cannot be covered using the methods mentioned above, extend the image. To do so, create your own image using a Dockerfile with the format below:

FROM bitnami/orangehrm
## Put your customizations below
...

Here is an example of extending the image with the following modifications:

  • Install the vim editor
  • Modify the Apache configuration file
  • Modify the ports used by Apache
FROM bitnami/orangehrm
LABEL maintainer "Bitnami <containers@bitnami.com>"

## Install 'vim'
RUN install_packages vim

## Enable mod_ratelimit module
RUN sed -i -r 's/#LoadModule ratelimit_module/LoadModule ratelimit_module/' /opt/bitnami/apache/conf/httpd.conf

## Modify the ports used by Apache by default
# It is also possible to change these environment variables at runtime
ENV APACHE_HTTP_PORT_NUMBER=8181 
ENV APACHE_HTTPS_PORT_NUMBER=8143
EXPOSE 8181 8143

Based on the extended image, you can use a Docker Compose file like the one below to add other features:

version: '2'

services:
  mariadb:
    image: 'bitnami/mariadb:10.2'
    environment:
      - MARIADB_USER=bn_orangehrm
      - MARIADB_DATABASE=bitnami_orangehrm
      - ALLOW_EMPTY_PASSWORD=yes
    volumes:
      - 'mariadb_data:/bitnami'
  orangehrm:
    build: .
    environment:
      - MARIADB_HOST=mariadb
      - MARIADB_PORT_NUMBER=3306
      - ORANGEHRM_DATABASE_USER=bn_orangehrm
      - ORANGEHRM_DATABASE_NAME=bitnami_orangehrm
      - ALLOW_EMPTY_PASSWORD=yes
    ports:
      - '80:8181'
      - '443:8143'
    depends_on:
      - mariadb
    volumes:
      - 'orangehrm_data:/bitnami'

volumes:
  mariadb_data:
    driver: local
  orangehrm_data:
    driver: local

Notable Changes

4.3.1-0-debian-9-r8 and 4.3.1-0-ol-7-r20

  • This image has been adapted so it's easier to customize. See the Customize this image section for more information.
  • The Apache configuration volume (/bitnami/apache) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the Apache configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom Apache configuration files are advised to mount a volume for the configuration at /opt/bitnami/apache/conf, or mount specific configuration files individually.
  • The PHP configuration volume (/bitnami/php) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the PHP configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom PHP configuration files are advised to mount a volume for the configuration at /opt/bitnami/php/conf, or mount specific configuration files individually.
  • Enabling custom Apache certificates by placing them at /opt/bitnami/apache/certs has been deprecated, and support for this functionality will be dropped in the near future. Users wanting to enable custom certificates are advised to mount their certificate files on top of the preconfigured ones at /certs.

Contributing

We'd love for you to contribute to this container. You can request new features by creating an issue, or submit a pull request with your contribution.

Issues

If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to include the following information in your issue:

  • Host OS and version
  • Docker version ($ docker version)
  • Output of $ docker info
  • Version of this container ($ echo $BITNAMI_IMAGE_VERSION inside the container)
  • The command you used to run the container, and any relevant output you saw (masking any sensitive information)

License

Copyright 2016-2019 Bitnami

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

You can’t perform that action at this time.