Open source & self-hosted

Run code you can inspect.

PayrollOS is licensed under AGPL-3.0-or-later and ships as a containerised application with repository, deployment and running-service verification.

GitHub destinations

Nothing hidden behind a guessed link.

These are the public destinations the project will expose once repository ownership is verified.

Why no placeholder URL?

The current Git remote is an internal deployment service, not a public GitHub repository. Publishing an unrelated or unverified link would undermine the transparency this page is meant to provide.

Self-host installation

Start from a reviewed checkout.

The commands below install the current controlled deployment. They do not, by themselves, authorise the use of real payroll data.

  1. 1

    Prepare the host

    Use a supported Ubuntu LTS host with Docker Engine 27+, Docker Compose 2.24.4+, Git and OpenSSL. Apply security updates, restrict administrative access and arrange encrypted off-host backups.

  2. 2

    Review and configure

    Check out the signed or otherwise reviewed release, copy .env.example, set the public origins and supply separate externally stored secrets and encryption keys.

  3. 3

    Build and start

    Validate Compose and the repository, build pinned images, start the services and wait for their health checks.

  4. 4

    Verify before access

    Run the deployment verifier, inspect every service log, test an encrypted backup restore and confirm only the gateway is reachable.

Ubuntu shellRun from the reviewed checkout
cp .env.example .env
./scripts/bootstrap-secrets.sh
docker compose config --quiet
./scripts/preflight.sh --repository-only
docker compose build --pull
docker compose up -d --wait
./scripts/verify-deployment.sh --running

On Windows PowerShell, run ./scripts/bootstrap-secrets.ps1 for the secret bootstrap. The deployment host remains Linux.

Before real payroll data

Deployment is not the same as live approval.

A production owner must retain evidence for every blocking gate relevant to their environment and providers.

Statutory

Independently validated tax-year rules, representative parallel payroll and authorised payroll-specialist sign-off.

External services

HMRC recognition and credentials, provider certification, reconciled failure handling and explicit live release decisions.

Security

Maintained storage, managed key custody, dependency and image evidence, independent penetration testing and remediated findings.

Operations

Capacity evidence, central monitoring and redaction, on-call ownership, recovery objectives and successful off-site restore drills.