Installation & Requirements
Requirements
The 16.x series requires:
- Python 3.14 or later
- Frappe Framework 16.x, ERPNext 16.x and HRMS 16.x, kept on mutually compatible version-16 revisions
- MariaDB (or another database Frappe supports)
- At least one Company, one Branch and one Employee
za_local is no longer required. Its South African localisation has been absorbed into ir itself (as the ir_vat, ir_payroll, ir_labour, ir_coida and ir_setup modules). Do not install za_local alongside ir 16.10 or later.
Installing
From your bench directory:
bench get-app https://github.com/buff0k/ir --branch version-16
bench --site your.site.name install-app ir
bench --site your.site.name migrate
bench build --app ir
bench restart
Confirm it's installed:
bench --site your.site.name list-apps
Upgrading
Always back up first:
bench --site your.site.name backup --with-files
Then:
cd apps/ir
git pull
cd ../..
bench --site your.site.name migrate
bench build --app ir
bench --site your.site.name clear-cache
bench restart
Always run clear-cache after an upgrade, so browsers pick up the new form scripts. The app carries historical patches that migrate retired fields and DocTypes into newer models. Don't run bench trim-tables until those patches have finished; some read columns that trim-tables would remove.
Upgrading from a site that had za_local
ir 16.10 takes over za_local's DocTypes, custom fields, fixtures and setup steps. On an existing site, upgrade ir and migrate first, check that the SA workspaces and your existing VAT/payroll records are intact, and only then remove za_local from the site. See the SA Practitioner Guide for the full checklist.
The IR Manager role is retired
The former IR Manager role has been replaced by the standard HR Manager role everywhere in ir: permissions, workspaces, reports, restrictions and client-side checks. Give your senior IR users HR Manager. See Roles & Access Model.
After installing
- Complete the ERPNext/HRMS foundation the app builds on: Company (with a Default Letter Head, which ir uses on its print formats), Branches, Departments, Designations (with their Occupational Level), Employees and users.
- Assign roles. See Roles & Access Model.
- Configure IR Role Restrictions: limits and notification recipients.
- Review the supplied master data (Offence Outcome, Disciplinary Offence, Employee Rights, Contract Type and Contract Section, Reason for Termination and so on) against your own policy and the law. It ships as a starting point, not legal advice.
- For South African payroll and VAT, run ZA Local Setup for each company. See the SA Practitioner Guide.
- Enable the scheduler so the daily and weekly jobs run:
bench --site your.site.name enable-scheduler
bench --site your.site.name doctor
Next: Navigating IR.