HRMS Documentation Version 1.0

Overview

Thank you for purchasing HRMS, a Human Resource Management System built on PHP / CodeIgniter 3. This guide covers server requirements, installation, first-time configuration, the admin and employee areas, backups, and how to build your own additional employee-area templates.

HRMS has two separate areas:

  • Admin Panel — company-wide configuration, user management, contracts, projects, messaging, static pages, and backups.
  • Employee Area — a self-service portal where each employee clocks in/out, tracks project activity, views contracts, and exchanges messages with the administrator.

The employee area supports swappable visual templates: the product ships with two ready-to-use templates (default and gemini), and you can add your own — see Creating Additional Employee-Area Templates.

Key Features

Employee self-service

  • Clock in / clock out, and break (pause) tracking, each with IP logging for accountability.
  • Personal attendance history.
  • Project and activity logging (start, edit, delete activities against assigned projects).
  • Contract details view.
  • Internal messaging with the administrator (inbox, sent, trash).
  • Profile management, avatar upload, password change.
  • Multi-language interface (English and Italian included).

Administration

  • User management (employees and admins), roles, avatars.
  • Contracts and projects management, including per-employee project activity oversight.
  • Attendance/presence overview across the company.
  • Internal messaging.
  • Static content pages (Terms of Use, Privacy Policy, Netiquette, Help, Contact).
  • Site configuration: company name, logo, favicon, social links, email settings, timezone, currency, maintenance mode, reCAPTCHA, login security.
  • Database backup, download, and restore from the admin panel.
  • Built-in city/state/country picker (offline dataset, no external API calls or API keys required).

Server Requirements

  • PHP 7.4 or later (PHP 8.0+ recommended)
  • MySQL 5.7+ / MariaDB 10.3+
  • PHP extensions: mysqli, mbstring, json, openssl, curl, gd, fileinfo
  • Apache with mod_rewrite enabled (an .htaccess file is included), or an equivalent rewrite configuration on Nginx/other web servers
  • Write permissions on: application/config/, application/logs/, upload/, upload/users/
The installer (next section) checks all of the above automatically and tells you exactly what is missing before you can proceed.

Installation — Guided Wizard (recommended)

HRMS includes a step-by-step installer that configures the database connection, imports the schema and seed data, and creates your admin account — no manual SQL import or file editing required.

  1. Upload the full contents of the package to your web server (or extract it directly into your hosting's document root / a subdirectory).
  2. Make sure the folders listed under Server Requirements are writable by the web server.
  3. Open https://your-domain.com/install/ in your browser.
  4. Step 1 — Requirements check. The installer verifies PHP version, required extensions, and folder permissions. Fix anything marked in red and reload the page.
  5. Step 2 — Database. Enter your MySQL/MariaDB host, port, username, password, and the database name to use (it is created automatically if it does not exist yet). The installer tests the connection before continuing.
  6. Step 3 — Data import. Click "Start import". This loads the database schema, default settings, the world cities/states/countries reference data, and the two demo accounts. This step also generates a unique encryption key for your installation and re-encrypts the demo account passwords with it, so every installation of HRMS has its own key rather than sharing one across all buyers.
  7. Step 4 — Site & admin account. Enter your company/site name and administrator email address. You can optionally set your own admin and employee passwords right away (recommended) instead of keeping the demo ones.
Once installation completes, the installer writes a lock file (application/config/installed.lock) so it cannot be run again by mistake — see Security Recommendations.

Default Demo Credentials

If you did not set your own passwords in Step 4 of the installer, the two demo accounts are:

RoleUsernamePassword
Administratoradminadmin
Employeeemployeeemployee
Change these as soon as possible on a production/public site.

Manual Installation (advanced users)

If you prefer not to use the wizard, you can install manually:

  1. Copy application/config/database.php.example to application/config/database.php and fill in your database credentials.
  2. Import _db/hrms_db.sql into your database using your preferred tool (phpMyAdmin, Adminer, the mysql command-line client, etc.).
    Note: this file is large (it embeds a full world cities/states/countries dataset), so command-line import is faster than a web upload form on most hosts.
  3. Generate a unique encryption key and set it in application/config/config.php ($config['encryption_key']).
  4. Update the demo account passwords directly in the users table if you change the encryption key (the stored password hash is tied to it — see application/libraries/Libutils.php).
  5. Create application/config/installed.lock yourself (any content is fine) once you are done, to disable the install/ wizard.

First Login & Basic Configuration

  1. Go to https://your-domain.com/ and log in with your administrator account.
  2. In the admin panel, open Configuration → General Setting to set your company name, logo, favicon, contact details, timezone, currency, and social links.
  3. Under the Visual setting tab of the same page (field Site Template) you can choose which employee-area template is active — see Creating Additional Templates — and preview its favicon.
  4. Review Configuration → Login Security settings (failed-login lockout threshold, PIN/email verification) to match your company policy.
  5. If you use Google reCAPTCHA or a transactional email provider, enter your own API keys/SMTP details under Configuration — HRMS ships without any pre-filled third-party API keys.

Admin Panel vs. Employee Area

  • The Admin Panel (/admin/...) has a single, fixed interface — it is not template-swappable, by design, to keep the administrative UI consistent and easy to support.
  • The Employee Area (everything an employee sees after logging in, plus the public login/forgot-password pages) is fully template-swappable. Two templates are included out of the box:
    • default — light, neutral shell.
    • gemini — rounded cards, alternate color palette.
    Both share the exact same functionality; only the look changes.

Creating Additional Employee-Area Templates

This is the recommended way to give the employee area your own branding without touching any PHP business logic.

How template selection works

Every employee-facing template lives in its own folder under template/, e.g. template/default/ and template/gemini/. HRMS automatically detects every folder inside template/ — see application/helpers/utils_helper.php, function get_template_list() — and lists them in Admin Panel → Configuration → General Setting → Visual setting → Site Template. There is nothing to register in code: creating a new folder with the correct files is enough for it to appear in that dropdown.

Required files in a template folder

Every template folder must contain exactly this set of files (copy them from template/default/ as a starting point):

template/your-template-name/ ├── assets/ │ ├── clean.css (sidebar / topbar shell styling) │ └── theme.css (page content styling: cards, tables, etc.) ├── include/ │ ├── head_v2.php (<head> section: CSS includes, meta tags) │ ├── header_v2.php (top bar / sidebar navigation) │ ├── footer_v2.php (closing tags, footer) │ ├── script_v2.php (JS includes, CSRF handling, sidebar toggle, │ │ logout, language switcher) │ ├── login_head.php (<head> for the login page) │ └── login_script.php (JS for the login page) ├── change_password.php ├── dashboard.php ├── forgot_password.php ├── home.php (login page) ├── message-read.php ├── messages.php ├── myactivity.php ├── myattendances.php ├── mycontract.php ├── myprofile.php ├── myproject.php └── myprojects.php

You may optionally add a favicon at assets/favicon.ico inside your template folder (as default does), or reuse the shared one at assets/images/favicon.ico (as gemini does) — reference whichever you choose from include/head_v2.php.

Step-by-step

  1. Duplicate template/default/ (the simplest of the two) into a new folder, e.g. template/mytemplate/.
  2. Edit assets/clean.css and assets/theme.css to change colors, spacing, fonts, etc. Both templates already use Bootstrap 5 (vanilla) and Boxicons loaded from include/head_v2.php / include/script_v2.php — keep using these rather than introducing a different CSS framework, to stay consistent with the rest of the product.
  3. Edit the PHP view files (dashboard.php, myprofile.php, etc.) to change markup/layout as needed. These files receive the same data variables that the current templates already use — if you are only re-styling (not adding new functionality), you generally only need to change HTML/CSS, not the PHP logic around <?= ... ?> output tags.
  4. Do not rename any of the files listed above — the controllers reference these exact filenames when loading a view from the active template folder.
  5. Save your new folder under template/.
  6. In Admin Panel → Configuration → General Setting → Visual setting, your new template now appears automatically in the Site Template dropdown. Select it and click Save.
  7. Log out and reload the login page to verify your new template is being served.

Notes on include/script_v2.php

This file wires up a few pieces of shared behavior that your template should keep, so it stays consistent with the rest of the application:

  • CSRF token injection for all AJAX requests ($.ajax/$.post overrides) — required for any form/AJAX action to work with CSRF protection enabled.
  • The logout() and change_language() JavaScript functions used by the header/sidebar.
  • The sidebar collapse/toggle behavior.

If you copy an existing template as your starting point, this is already handled — you only need to keep the same function names if you rewrite this file from scratch.

Testing safely: the admin panel switches the live template for all employees immediately when you click Save. Test a new template on a staging copy first, or during low-traffic hours, and note the previously active template name so you can switch back instantly if needed.

Backup & Restore

The admin panel (Configuration → Backup, or the "Backup" menu entry) lets you:

  • Configure a backup folder.
  • Run an on-demand database backup.
  • Download a previously created backup file.
  • Restore the database from a backup file.
  • Delete old backup files.
We still recommend keeping your own off-server backups (via your hosting provider or a scheduled mysqldump) as a second safety net.

Security Recommendations

  • Change the default admin/admin and employee/employee credentials immediately if you did not already set your own during installation.
  • Delete the install/ folder (or verify application/config/installed.lock exists) once installation is complete.
  • Keep application/config/database.php out of version control / public access (already excluded via .gitignore if you use Git).
  • Configure your own SMTP/email and reCAPTCHA credentials under Configuration — do not reuse any keys you may find in third-party demo content.
  • Keep CSRF protection enabled ($config['csrf_protection'] = TRUE in application/config/config.php) — enabled by default and required for the CSRF token handling built into every template's script_v2.php to work correctly.

Third-Party Licenses & Attribution

HRMS includes the following third-party components. Full license texts are bundled in the licenses/third-party/ folder of this package.

Geographic data

The cities/states/countries picker is sourced from the Countries States Cities Database project, licensed under the Open Database License (ODbL) v1.0 / Database Contents License (DbCL) v1.0. Required attribution:

Data by Countries States Cities Database
https://github.com/dr5hn/countries-states-cities-database | ODbL v1.0

Front-end libraries

All MIT-licensed: Bootstrap 5.1.3, jQuery 3.6.0, jquery-confirm 3.3.4, ApexCharts 3.29.0, DataTables (+ DataTables Bootstrap 4 styling), Dropzone.js, and Boxicons 2.1.4. See licenses/third-party/frontend-libraries/NOTICE.txt for the exact copyright line of each.

Framework

CodeIgniter 3, MIT license (license.txt in the package root).

Support

If you run into an issue not covered by this guide, please get in touch through the support channel indicated on the marketplace page where you purchased HRMS with:

  • A description of the issue and the steps to reproduce it.
  • Your PHP and MySQL/MariaDB versions.
  • Any relevant error message from application/logs/.

Thank you again for choosing HRMS!