Quick start

This guide runs BPMS and its own PostgreSQL database on your machine with Docker Compose, and checks that the platform answers. It takes a few minutes.

Before you startCopy Anchor Link

You need:

• Git, with access to https://git.afglobal.co/bpms/bpms.
• Docker with Docker Compose.

1. Get the codeCopy Anchor Link

git clone https://git.afglobal.co/bpms/bpms.git bpms
cd bpms

2. ConfigureCopy Anchor Link

BPMS is configured only through environment variables. Copy the example file and set DB_PASSWORD in .env to a password of your choice for the local database:

cp .env.example .env

.env stays on your machine: Git ignores it and it never enters the image.

3. StartCopy Anchor Link

docker compose up -d --build --wait

Compose builds the image, starts PostgreSQL 18, waits for it to be healthy, and starts BPMS on port 8080. Set BPMS_HTTP_PORT in .env to use another port.

4. Check that it answersCopy Anchor Link

curl -fsS http://127.0.0.1:8080/livez
curl -fsS http://127.0.0.1:8080/readyz

Both answer {"status":"UP"}. Open http://127.0.0.1:8080/swagger-ui.html in a browser to explore the API, or download its OpenAPI document from http://127.0.0.1:8080/v3/api-docs.

5. StopCopy Anchor Link

docker compose down

Add -v to also delete the database volume.

Next stepsCopy Anchor Link

The local database starts empty, so it shows that the platform runs but holds no users to sign in with. To work with real data, run the bpms:local image that step 3 built with DB_HOST, DB_NAME, DB_USERNAME, and DB_PASSWORD pointing at a copy of a BPMS 3.x database, never at production. Then continue with Authentication to sign in and make your first call.