# Open Core HR

> HR and field workforce management in one self-hosted platform: employees, attendance, leave, customer visits, live GPS tracking and AI on your own provider. Source code included.

Every page of this documentation is available as Markdown, and the whole manual is published as llms.txt and llms-full.txt. Paste a page into your AI tool, or point your coding agent at the full manual.

## Installation

- [Installation overview](https://czappstudio.com/docs/installation/overview.md): The order of steps for installing and running a self-hosted Open Core HR server.
- [Install with an AI agent](https://czappstudio.com/docs/installation/ai-assisted.md): Let Claude Code, Cursor, Codex, GitHub Copilot or Gemini set up Open Core HR for you, on your own computer or on a server, free, using this documentation.
- [Requirements and hosting](https://czappstudio.com/docs/installation/requirements.md): Server software, PHP extensions and hosting platforms that Open Core HR needs.
- [Prepare your installation](https://czappstudio.com/docs/installation/prepare.md): Extract the release, create the database, install dependencies and create the private configuration.
- [Install on cPanel](https://czappstudio.com/docs/installation/cpanel.md): Install Open Core HR on a cPanel account that supports SSH, Composer, cron and persistent workers.
- [Install on a Linux VPS](https://czappstudio.com/docs/installation/linux-vps.md): Install Open Core HR on a Linux server with Nginx, PHP-FPM, MySQL and a process manager.
- [Plesk, Apache and Windows](https://czappstudio.com/docs/installation/other-platforms.md): Notes for installing Open Core HR on Plesk, Apache and Windows with IIS.
- [Local development](https://czappstudio.com/docs/installation/local-development.md): Run Open Core HR on your own computer for development and testing.
- [Configure and initialize](https://czappstudio.com/docs/installation/configuration.md): Set environment values, initialize a fresh database and configure modules, reCAPTCHA and maps.
- [Email, queues and real-time services](https://czappstudio.com/docs/installation/services.md): Set up outgoing email, the queue worker, the scheduler, webhook delivery and Reverb.
- [Installation checklist](https://czappstudio.com/docs/installation/checklist.md): Checks to complete before you invite employees to a new installation.
- [Licences and activation](https://czappstudio.com/docs/installation/activation.md): Link an installation to your licence so it can install add-ons and receive updates.
- [Installing and managing add-ons](https://czappstudio.com/docs/installation/add-ons.md): Buy, install, update, switch on and configure add-ons from **Settings → Modules**.
- [Backups and updates](https://czappstudio.com/docs/installation/backups-and-updates.md): Back up an installation, update Core from the product or the command line, roll back, and recover access when reCAPTCHA blocks login.
- [Customization and integrations](https://czappstudio.com/docs/installation/customization.md): Guidance for source changes, provider integrations and building the mobile app.
- [Building your own module](https://czappstudio.com/docs/installation/custom-modules.md): Add your own features without breaking Core updates or store add-ons.
- [Using AI coding agents](https://czappstudio.com/docs/installation/ai-agents.md): Set up, customise and extend Open Core HR with Claude Code, Codex, Cursor, GitHub Copilot or any coding agent.
- [Troubleshooting and FAQ](https://czappstudio.com/docs/installation/troubleshooting.md): Fixes for common installation problems such as 500 errors, missing assets and stuck imports.
- [Support and licences](https://czappstudio.com/docs/installation/support.md): How to ask for help, what your licence covers, and third-party licences.

## Getting started

- [Welcome to Open Core HR](https://czappstudio.com/docs/getting-started/welcome.md): An introduction to Open Core HR for employees, managers, HR teams and installers.
- [Signing in for the first time](https://czappstudio.com/docs/getting-started/first-login.md): Sign in to Open Core HR for the first time and set up your account.
- [Changing your password](https://czappstudio.com/docs/getting-started/changing-your-password.md): Change your Open Core HR sign-in password from the account menu or your profile.
- [Finding your way around](https://czappstudio.com/docs/getting-started/finding-your-way-around.md): Learn the layout of the Open Core HR workspace and how to move between pages.
- [Using the mobile app](https://czappstudio.com/docs/getting-started/mobile-app.md): Sign in to the Open Core HR mobile app and use its main areas.

## Self-service

- [Personal work](https://czappstudio.com/docs/self-service/overview.md): An overview of your personal workspace and the dashboard you see after signing in.
- [Your profile](https://czappstudio.com/docs/self-service/profile.md): View and update your profile, contact details, private details, picture, letters, bank details and status.
- [Your Inbox](https://czappstudio.com/docs/self-service/inbox.md): Read and manage the notifications that Open Core HR sends you.
- [Your attendance](https://czappstudio.com/docs/self-service/attendance.md): Check in and out, review today's status and look back at your sessions and monthly summary.
- [Leave](https://czappstudio.com/docs/self-service/leave.md): Apply for leave, follow your requests, cancel them and check your leave balance.
- [Compensatory offs](https://czappstudio.com/docs/self-service/compensatory-offs.md): Request, edit and track compensatory offs earned for extra work.
- [Your expenses](https://czappstudio.com/docs/self-service/expenses.md): Create, submit, track and cancel expense and travel claims.
- [Holidays](https://czappstudio.com/docs/self-service/holidays.md): See the holidays that apply to you.
- [Your calendar](https://czappstudio.com/docs/self-service/calendar.md): Use the Core calendar to view, create, edit and respond to events.

## Administration

- [HR and administration](https://czappstudio.com/docs/administration/overview.md): An overview of the HR and admin guide and the administrator dashboard.
- [Employees](https://czappstudio.com/docs/administration/employees.md): Find, add, import, export and manage the status and history of employees.
- [The employee profile](https://czappstudio.com/docs/administration/employee-profile.md): Maintain an employee's identity, work, compensation, personal, contact, bank, leave, device and location details.
- [Attendance](https://czappstudio.com/docs/administration/attendance.md): Review attendance records and analytics, close open sessions and set attendance policies.
- [Leave requests](https://czappstudio.com/docs/administration/leave-requests.md): Review leave requests, create leave for employees, use the leave calendar and manage compensatory offs.
- [Leave types and balances](https://czappstudio.com/docs/administration/leave-types-and-balances.md): Set up leave types and set, adjust or bulk import leave balances.
- [Approvals](https://czappstudio.com/docs/administration/approvals.md): Work through the approval inbox, approve, reject or reassign requests and configure approval workflows.
- [Expense administration](https://czappstudio.com/docs/administration/expenses.md): Review expense claims, record reimbursements and set up expense categories and approvals.
- [Organization and master data](https://czappstudio.com/docs/administration/organization.md): Maintain the organization hierarchy, departments, designations and locations.
- [Shifts and holidays](https://czappstudio.com/docs/administration/shifts-and-holidays.md): Define work shifts and maintain the holiday calendar.
- [Import and export](https://czappstudio.com/docs/administration/import-export.md): Import spreadsheets and setup data, export records and download files from transfer history.
- [Generating reports](https://czappstudio.com/docs/administration/reports.md): Generate reports from the data you are permitted to see.
- [Settings](https://czappstudio.com/docs/administration/settings.md): Configure general, security, code prefix, localisation, signature and app update settings.
- [Mail, storage and push notifications](https://czappstudio.com/docs/administration/mail-storage-and-notifications.md): Configure outgoing mail, push notifications, file storage and the media library.
- [Roles and permissions](https://czappstudio.com/docs/administration/roles-and-permissions.md): Control what people can see and do with roles and individual permission overrides.
- [Audit logs](https://czappstudio.com/docs/administration/audit-logs.md): Review the record of changes made across Open Core HR.
- [Home profiles](https://czappstudio.com/docs/administration/home-profiles.md): Choose what different groups of people see on their home screen.

## Field operations

- [Customer visits and offline work](https://czappstudio.com/docs/field-operations/visits.md): Record customer visits on mobile, review your team and recover work saved offline.
- [Plan and review field work](https://czappstudio.com/docs/field-operations/planning.md): Plan journeys, maintain customers and review field work on the web.
- [Live tracking](https://czappstudio.com/docs/field-operations/live-tracking.md): Follow field employees on a live map and play back their routes.

## Add-on modules

- [Announcements](https://czappstudio.com/docs/modules/announcements.md): Post announcements to employees and read the announcements sent to you.
- [Assets](https://czappstudio.com/docs/modules/assets.md): Track company assets through inventory, assignment, return, maintenance and documents.
- [Chat and calls](https://czappstudio.com/docs/modules/chat-and-calls.md): Message colleagues in conversations and groups, share files and make audio or video calls.
- [Disciplinary actions](https://czappstudio.com/docs/modules/disciplinary-actions.md): Issue and review warnings and appeals, and respond to warnings you receive.
- [Documents](https://czappstudio.com/docs/modules/documents.md): Define document types, keep employee documents and upload your own documents.
- [Employee lifecycle](https://czappstudio.com/docs/modules/employee-lifecycle.md): Manage recruitment, offers, onboarding, probation, employment changes, separations and final settlements.
- [Company feed](https://czappstudio.com/docs/modules/feed.md): Share posts in the company feed and configure how the feed works.
- [Loans](https://czappstudio.com/docs/modules/loans.md): Create, approve, disburse, repay and close employee loans, and review loan reports.
- [Payroll](https://czappstudio.com/docs/modules/payroll.md): Set up payroll, prepare and approve payroll runs, record payments and download payslips.
- [Performance](https://czappstudio.com/docs/modules/performance.md): Set weighted goals, run self and manager reviews on a schedule, sign off final ratings and share them with employees.
- [Policies](https://czappstudio.com/docs/modules/policies.md): Publish and version company policies, deliver them to employees and track acknowledgments.
- [Tasks](https://czappstudio.com/docs/modules/tasks.md): Create, work and update tasks, handle recurring tasks and monitor the task board.
- [Webhooks](https://czappstudio.com/docs/modules/webhooks.md): Send signed event notifications from Open Core HR to your own systems.

## AI

- [AI in Open Core HR](https://czappstudio.com/docs/ai/overview.md): Connect your own AI provider, choose who can use each AI feature and keep usage within your limits.
- [AI writing assistant](https://czappstudio.com/docs/ai/writing-assistant.md): Draft, improve, shorten, formalise or translate long text with a Write with AI button.
- [HR assistant](https://czappstudio.com/docs/ai/hr-assistant.md): Give employees an Ask HR page that answers from your own policies and prepares requests for them to send.
- [Receipt scanning](https://czappstudio.com/docs/ai/receipt-scanning.md): Fill in expense claims from a receipt photo and point reviewers to claims that do not match their receipts.
- [Ask your HR data](https://czappstudio.com/docs/ai/ask-your-data.md): Ask plain questions about headcount, leave, attendance and expenses, and check every answer against the records it came from.

## Microsoft 365

- [Microsoft 365 setup](https://czappstudio.com/docs/microsoft-365/setup.md): Connect Open Core HR to a Microsoft Entra application and grant the permissions each feature needs.
- [Microsoft 365 Connector](https://czappstudio.com/docs/microsoft-365/connector.md): The shared connection that the Microsoft 365 modules use.
- [Microsoft 365 account management](https://czappstudio.com/docs/microsoft-365/account-management.md): Provision, link, reset, disable and deprovision Microsoft 365 accounts for employees.
- [Outlook Email](https://czappstudio.com/docs/microsoft-365/outlook-email.md): Read, search, send, reply to and organize your Microsoft 365 mail inside Open Core HR.
- [Outlook Calendar Sync](https://czappstudio.com/docs/microsoft-365/outlook-calendar-sync.md): Keep your Core calendar and your Outlook calendar in step.

## SaaS

- [SaaS hosting setup](https://czappstudio.com/docs/saas/hosting-setup.md): Sell subscriptions to separate company workspaces with the optional SaaS module.
- [Manage your subscription](https://czappstudio.com/docs/saas/subscription.md): Start, renew, change or cancel your hosted workspace subscription and review billing records.

## Optional

- [Full manual](https://czappstudio.com/llms-full.txt): every guide in one Markdown file
- [Installation plans](https://czappstudio.com/installation): human installation, mobile builds and training by our team
- [Pricing](https://czappstudio.com/pricing): Core and add-on licenses