# Crow HR > Free, MIT-licensed HR and payroll software for Singapore SMEs that you host yourself with Docker Compose: CPF payroll with every figure's working shown, leave, claims, attendance, scheduling, approvals, documents, IR8A, and iPhone and Android apps that connect only to your own server. To install Crow HR with an AI coding agent, give it the setup prompt: https://hr.crow.sg/docs/ai-setup-prompt.md. Every page below is Markdown; https://hr.crow.sg/docs/llms-full.txt has all of them in one file. The HTML docs are at https://hr.crow.sg/docs/, an in-browser demo with a fictional company at https://hr.crow.sg/, and the source at https://github.com/Crow-Tech-Pte-Ltd/CrowHR. ## Get started - [Introduction](https://hr.crow.sg/docs/introduction.md): What Crow HR is, who it is for, how it is licensed and what it means that you host it and own the data. - [Quick start](https://hr.crow.sg/docs/quick-start.md): Install Crow HR with Docker Compose, then finish setup in the browser. - [Project status](https://hr.crow.sg/docs/status.md): Which Crow HR modules are built and tested, which are partly done or only reachable through the API, and what is not built. - [In-browser demo](https://hr.crow.sg/docs/demo.md): How Crow HR's in-browser demo works - the real app and API running in your browser against fictional data - what differs from a self-hosted install, and where to try it (hr.crow.sg). ## Self-hosting - [Install with Docker Compose](https://hr.crow.sg/docs/self-hosting/install.md): Install Crow HR on your own server with Docker Compose, finish setup in the browser and take your first backup. - [Set up with an AI agent](https://hr.crow.sg/docs/self-hosting/ai-agent.md): Copy a ready-made prompt that lets an AI coding agent such as Claude Code or Codex install Crow HR on your server with you, from Docker Compose and HTTPS to backups and your people's first sign-in. - [Configuration reference](https://hr.crow.sg/docs/self-hosting/configuration.md): Every environment variable Crow HR reads, with defaults, valid values and what each one does. - [Reverse proxy (or none)](https://hr.crow.sg/docs/self-hosting/reverse-proxy.md): Run Crow HR behind Caddy, nginx, Traefik or Cloudflare Tunnel, or on a LAN without a proxy, and set TRUSTED_PROXIES correctly. - [Backups and restore](https://hr.crow.sg/docs/self-hosting/backups.md): What a Crow HR backup contains, how scheduled and manual backups work, how to copy them off the server and how to restore. - [Upgrades](https://hr.crow.sg/docs/self-hosting/upgrades.md): Upgrade Crow HR with docker compose pull, what happens during database migrations, image tags and downgrades. - [crowhr CLI reference](https://hr.crow.sg/docs/self-hosting/cli.md): Every command of the crowhr server administration CLI, run inside the app container with docker compose exec. - [Troubleshooting the server](https://hr.crow.sg/docs/self-hosting/troubleshooting.md): Fixes for Crow HR startup errors, lost setup codes, locked-out owners, proxy problems, backups and disk space. ## Administration - [Setup wizard](https://hr.crow.sg/docs/admin/setup-wizard.md): Create your organisation and its owner on a fresh Crow HR server with the one-time setup code. - [Company and structure](https://hr.crow.sg/docs/admin/company-and-structure.md): Set the company profile (UEN, CSN, address), departments, teams, locations, cost centres and work schedules in Crow HR. - [Members and roles](https://hr.crow.sg/docs/admin/members-and-roles.md): Invite people to Crow HR, grant owner, HR admin and payroll admin roles, suspend members and handle former employees. - [Sign-in methods](https://hr.crow.sg/docs/admin/sign-in-methods.md): Choose how people sign in to Crow HR - email and password, Google Workspace, Microsoft Entra ID, generic OpenID Connect or Singpass - and how SSO accounts are linked. - [Two-step verification (MFA)](https://hr.crow.sg/docs/admin/mfa.md): How TOTP two-step verification, recovery codes and the MFA policy for privileged roles work in Crow HR. - [Google Workspace sign-in](https://hr.crow.sg/docs/admin/sso/google-workspace.md): Step-by-step setup of Google Workspace single sign-on (OpenID Connect) for Crow HR, with domain restriction. - [Microsoft Entra ID sign-in](https://hr.crow.sg/docs/admin/sso/microsoft-entra-id.md): Step-by-step setup of Microsoft Entra ID (Azure AD) single sign-on for Crow HR, restricted to your tenant. - [OpenID Connect (Okta, Keycloak, Authentik)](https://hr.crow.sg/docs/admin/sso/generic-oidc.md): Connect any OpenID Connect identity provider with discovery - Okta, Keycloak, Authentik and others - to Crow HR. - [Singpass login](https://hr.crow.sg/docs/admin/sso/singpass.md): What Crow HR's Singpass login does, what your company must do to become a Singpass relying party, and how to configure and test it. Tested against Singpass staging; not yet against production. ## People - [Adding employees](https://hr.crow.sg/docs/people/adding-employees.md): Hire an employee in Crow HR, what each field is used for, how NRIC/FIN and bank numbers are protected, and the employee profile. - [Importing from CSV](https://hr.crow.sg/docs/people/importing.md): Import employees, compensation and year-to-date payroll opening balances into Crow HR from CSV, with a preview that lists every error before anything is saved. - [Employee lifecycle](https://hr.crow.sg/docs/people/lifecycle.md): Transfers, promotions, salary changes, probation, resignations, terminations and rehires in Crow HR, with effective dates and checklists. - [Work passes](https://hr.crow.sg/docs/people/work-passes.md): Record work passes for foreign employees in Crow HR and get expiry reminders. - [Self-service and change requests](https://hr.crow.sg/docs/people/self-service-and-change-requests.md): What employees can change themselves in Crow HR, and how changes to legal and bank details are approved. ## Payroll and compliance - [Payroll settings](https://hr.crow.sg/docs/payroll/settings.md): Set the pay day, payslip release, CPF advice code, foreign worker levy profile and the debit account for the bank file before your first Crow HR payroll run. - [Running payroll](https://hr.crow.sg/docs/payroll/running-payroll.md): Create, compute, review, approve and pay a monthly payroll run in Crow HR, plus off-cycle and adjustment runs. - [Reading the CPF working](https://hr.crow.sg/docs/payroll/cpf-working.md): How Crow HR computes CPF contributions - OW and AW, the OW and AW ceilings, age bands, SPR graduated rates and rounding - and how to read the working shown for each employee. - [SHG funds, SDL and FWL](https://hr.crow.sg/docs/payroll/shg-sdl-fwl.md): How Crow HR computes self-help group fund contributions, the Skills Development Levy and its foreign worker levy estimate. - [Payslips](https://hr.crow.sg/docs/payroll/payslips.md): What Crow HR's itemised payslips contain, when employees can see them, and the PDF version. - [CPF EZPay file](https://hr.crow.sg/docs/payroll/cpf-ezpay-file.md): Download the CPF EZPay (FTP) submission file for a Crow HR payroll run and upload it to CPF EZPay yourself. - [Bank payment file](https://hr.crow.sg/docs/payroll/bank-file.md): Crow HR's generic ISO 20022 pain.001.001.03 salary file, what it contains and why you must check it with your bank first. - [IR8A export](https://hr.crow.sg/docs/payroll/ir8a-export.md): Export each employee's IR8A figures, and the Appendix 8A benefits-in-kind and Appendix 8B share-plan gains, from Crow HR in the column layout of IRAS's IR8A import template, for manual import in myTax Portal. - [How we verify statutory calculations](https://hr.crow.sg/docs/payroll/verification.md): How Crow HR's CPF, SDL, SHG, FWL and Employment Act rules were checked - cited tables, CPF's worked examples, an independent recomputation and 15 cases confirmed in CPF's online calculator. - [Limitations and what needs your judgement](https://hr.crow.sg/docs/payroll/limitations.md): What Crow HR does not do, statutory questions it cannot settle for you, and the results you must check before paying or filing. ## Time and leave - [Leave](https://hr.crow.sg/docs/leave/leave.md): Statutory and company leave in Crow HR - types and eligibility, policies, accrual and carry-forward, applying and approvals, public holidays in lieu, part-timers in hours, the Government-paid leave report and year end. - [Attendance and overtime](https://hr.crow.sg/docs/attendance/attendance.md): Clock in and out (also offline), optional location and office-network checks, timesheets and corrections, optional timesheet approval, lateness rules, overtime claims under Part 4 of the Employment Act, and how approved overtime reaches payroll. - [Scheduling](https://hr.crow.sg/docs/scheduling/scheduling.md): Weekly shift rosters in Crow HR - shift templates, the week grid and its keyboard shortcuts, publishing, conflicts and hour warnings, swaps and open shifts, and how published rosters feed attendance, leave and payroll. ## Claims - [Claims](https://hr.crow.sg/docs/claims/claims.md): Expense claims in Crow HR - claim types and caps, receipts and upload checks, foreign currency, approvals, and reimbursement through payroll or outside it. ## Approvals and notifications - [Approvals](https://hr.crow.sg/docs/approvals/approvals.md): How Crow HR routes requests for approval - policies, steps, fallbacks, delegation, escalation - and where approvers act on them. - [Notifications and reminders](https://hr.crow.sg/docs/approvals/notifications.md): In-app and email notifications in Crow HR, what reminders are sent and what emails never contain. ## Documents - [Employee documents](https://hr.crow.sg/docs/documents/documents.md): Store contracts, passes, certificates and medical documents per employee in Crow HR, with category access rules, versions, expiry reminders and retention reviews. - [HR letters and KETs](https://hr.crow.sg/docs/documents/letters-and-kets.md): Generate offer letters, Key Employment Terms, confirmation, salary-change and employment letters from templates, and collect employee acknowledgements. ## Reports - [Reports](https://hr.crow.sg/docs/reports/running-reports.md): The reports Crow HR ships, who can run each one, the exact formulas behind the numbers, and the CSV and XLSX exports. ## Roles and permissions - [Roles and permissions](https://hr.crow.sg/docs/roles-and-permissions.md): Crow HR's permission matrix - which role can read or change what, with which scope - generated from the server's source code. ## Integrations - [Integrations](https://hr.crow.sg/docs/integrations.md): What Crow HR connects to today (SSO, SMTP, file storage, files for CPF, banks and IRAS) and what is not available (IRAS AIS API, bank-specific formats, Myinfo). ## Mobile apps - [Mobile apps](https://hr.crow.sg/docs/mobile-apps.md): Native iOS and Android apps for Crow HR, version 1.0.0 on the App Store and Google Play. How connecting a phone to your company's server works. ## Developers - [Architecture](https://hr.crow.sg/docs/developers/architecture.md): How the Crow HR codebase is organised - bun workspace packages, the runtime-agnostic core, the request lifecycle, tenancy, RBAC and audit. - [Module guide](https://hr.crow.sg/docs/developers/modules.md): How to add a module to Crow HR's core - routes with defineRoute, org-scoped data access, permissions, audit, approvals and the tests every module adds. - [API conventions](https://hr.crow.sg/docs/developers/api-conventions.md): Versioning and compatibility rules, request and response conventions, lists, errors and authentication for the Crow HR REST API. - [Testing](https://hr.crow.sg/docs/developers/testing.md): How Crow HR is tested - Vitest on PGlite, the permission and cross-organisation sweeps, sg-rules coverage, OpenAPI checks, Playwright, the self-host script and the docs checks. - [The OpenSpec process](https://hr.crow.sg/docs/developers/openspec.md): How requirements, change proposals and task lists are kept in openspec/ and how a change moves from proposal to archive. - [Contributing](https://hr.crow.sg/docs/developers/contributing.md): How to set up a Crow HR development environment, the checks a change must pass, and how to propose larger changes. ## Help - [Troubleshooting](https://hr.crow.sg/docs/help/troubleshooting.md): Fixes for common Crow HR problems with sign-in, single sign-on, invitations, people imports and payroll runs. - [FAQ](https://hr.crow.sg/docs/help/faq.md): Common questions about Crow HR - cost, hosting, data, compliance claims, modules and support. - [Security](https://hr.crow.sg/docs/help/security.md): How to report a vulnerability in Crow HR, and the security measures operators should know about. - [Privacy and PDPA for operators](https://hr.crow.sg/docs/help/privacy-pdpa.md): Guidance for companies that run Crow HR on how the Personal Data Protection Act applies to the employee data they keep in it. ## Optional - [API reference](https://hr.crow.sg/docs/api/): every endpoint of the v1 REST API (HTML, generated from the OpenAPI document)