Skip to content

Quick start

You need a machine with Docker Engine 24+ and the Compose plugin, 2 GB of RAM and a few GB of disk. Get the repository first (git clone https://github.com/Crow-Tech-Pte-Ltd/CrowHR.git), then:

1. Copy the example settings

Section titled “1. Copy the example settings”
Terminal window
cp .env.example .env

2. Set the address people will open

Section titled “2. Set the address people will open”

Edit .env and set PUBLIC_URL:

Terminal window
PUBLIC_URL=https://hr.example.sg        # behind a reverse proxy with HTTPS
# PUBLIC_URL=http://192.168.1.20:8080   # or on your office network, no proxy

3. Start it

Section titled “3. Start it”
Terminal window
docker compose up -d

That is all that is required. Compose pulls the published image (ghcr.io/crow-tech-pte-ltd/crowhr:1, amd64 or arm64), and the database password, the encryption key and a one-time setup code are generated on first start.

Then finish in the browser

Section titled “Then finish in the browser”
  1. Print the setup code: docker compose logs app | grep -A3 'SETUP CODE'.
  2. Open PUBLIC_URL. You land on /setup.
  3. Enter the code, the company’s registered name and the owner’s name, email and password. You are signed in as the owner.
  4. Run docker compose exec app crowhr backup and copy the archive somewhere safe.

Before you store real data, set BACKUP_PASSPHRASE in .env (backups contain the encryption key) and, behind a proxy, TRUSTED_PROXIES. The full walkthrough is install with Docker Compose.

What next

Section titled “What next”