OpenHR PH documentation
This documentation is split into two paths. Pick the one that matches what you need to do.
It is also published as a searchable site at kawayanmedia.github.io/openhrph.
Run it locally from docs-site/ with npm start.
Try the demo first. The hosted demo creates an isolated workspace with sample employees, timesheets, and an open payroll. Sign up, verify your email address, and the workspace opens.
I use OpenHR PH
For HR officers, payroll staff, administrators, and employees who use the system day to day. No programming knowledge is needed.
| Guide | What it covers |
|---|---|
| Company to payslip walkthrough | One complete first run: company profile, reference data, payroll group, employee, portal access, payroll, payslip, and corrections |
| Getting started | Signing in, switching companies, navigation, and changing your password |
| Employees | Employee records, documents, schedules, compensation, and import |
| Attendance and requests | Timesheets, overtime, leave, undertime, official business, and corrections |
| Payroll | Payroll groups, previews, processing, approval, locking, and payslips |
| Reports and payslips | Exports, registers, remittances, and employee payslip access |
| Settings and access | Offices, departments, holidays, users, groups, and permissions |
| Troubleshooting | Common problems and when to contact an administrator |
Start with the company-to-payslip walkthrough if you are setting up a company for the first time, or Getting started if you only need to sign in and find your way around.
I build, extend, or operate OpenHR PH
For developers, integrators, and system administrators.
Understand the system
| Guide | What it covers |
|---|---|
| Architecture | Layers, request flow, admin panels, payroll engine, tenancy, queues, and storage |
| Multi-tenancy | Tenant resolution, scoping rules, queues, cache, storage, and adding tenant tables |
| Payroll engine | Build, run, statutory tables, preview, processing, and fallback driver |
| Government and Private sectors | Sector policy, catalogues, government commands, and the regulatory research matrix |
Work on the code
| Guide | What it covers |
|---|---|
| Local development | Prerequisites, installation, database, assets, queues, payroll engine, and first admin |
| Admin panel | Adding Livewire resources, fields, filters, actions, validation, and navigation |
| Testing | Pest/PHPUnit, Playwright, Go tests, and test data |
| Troubleshooting | Setup and runtime failures |
| Contributing | Branching, conventions, checks, and pull requests |
Deploy and operate
| Guide | What it covers |
|---|---|
| Deployment overview | Choosing Docker, a cloud golden image, or managed hosting |
| Docker deployment | Compose stack, image build, TLS, backups, and operations |
| AWS AMI deployment | Packer AMI and Terraform stack, step by step |
| GCP deployment | Packer image and Terraform stack, step by step |
| Azure deployment | Packer managed image and Terraform stack, step by step |
| Operations | Logs, backups, updates, scaling, health checks, and teardown |
| Laravel Cloud | Managed hosting with Laravel Cloud or Vapor |
| Desktop app | Standalone macOS, Windows, and Linux builds with NativePHP, local SQLite, and auto-updates |
Release and security
| Guide | What it covers |
|---|---|
| Open-source release checklist | Credential rotation, history cleanup, PII review, and publishing |
| Security policy | Reporting vulnerabilities and handling secrets |
| Philippine payroll compliance audit — 2026 update | 2026 statutory basis, end-to-end payroll procedure, advisory checklist, and open findings F-25–F-37 |
| Official sources used by the audit | Statutory circulars and references behind the payroll rules |
A note on terms
- Company / tenant — one organisation using the installation. Data is separated by
company_id. - Workspace — the admin interface at
/app. - Employee portal — the self-service area for employees.
- Payroll group — the rules and schedule used to compute a payroll (for example, semi-monthly).
- Payroll run — one processing period for a payroll group.
- Payslip — the employee-level result of a payroll run.
If you are not sure where to start, read Getting started or open an issue on GitHub.