Installation & Requirements

Requirements

The current 16.x series requires:

• Python 3.14 or later
• Frappe Framework 16.x, ERPNext 16.x, HRMS 16.x - keep all three on mutually compatible version-16 revisions
• za_local (Cohenix Local ZA)
• MariaDB (or another database Frappe supports)
• At least one Company, one Branch, and one Employee already set up

Installing

From your bench directory:

bench get-app https://github.com/buff0k/ir
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

ir should appear in the list.

If Local ZA isn't already present

bench get-app https://github.com/EPIUSECX/cohenix_local_za
bench --site your.site.name install-app za_local
bench --site your.site.name migrate

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

The app carries historical patches that migrate retired fields and DocTypes into newer consolidated models - don't run bench trim-tables until migration patches have finished, since some of them read the columns trim-tables would remove.

After installing

1. Complete the ERPNext/HRMS foundation this app builds on: Company, Branch, Departments, Designations, Employees, users, letterheads.
2. Assign IR roles to your users - see Roles & Access Model.
3. Configure IR Role Restrictions - see IR Role Restrictions - Designation Limits & Branch Limits.
4. Review the supplied master data (Offence Outcome, Employee Rights, Contract Type/Section, and similar) against your own organisation's policy and applicable law before going live - these ship as a starting point, not legal advice.
5. Enable the scheduler so weekly/daily notifications actually run:

bench --site your.site.name enable-scheduler
bench --site your.site.name doctor

Next: Roles & Access Model.