Skip to main content

Install with Docker Compose

The supported 0.1.x deployment is the pinned source release on one Docker Compose host.

Prerequisites​

  • Docker Engine 29 or another current release with Compose v2 support.
  • At least 4 GB of memory available to Docker.
  • Linux amd64 or arm64, Docker Desktop on macOS, or WSL2 on Windows.
  • gh or a browser to download the GitHub release.

Node.js is not required to run the Compose stack. Host-side development requires Node.js 24.15+ on the 24.x line and pnpm 10.34.5.

Download and verify​

mkdir indexlume-0.1.0-download
cd indexlume-0.1.0-download
gh release download v0.1.0 --repo junaidtariq48/indexlume
sha256sum -c SHA256SUMS
tar -xzf indexlume-0.1.0.tar.gz
cd indexlume-0.1.0

On macOS, use shasum -a 256 -c SHA256SUMS.

Expected result: both files report OK, and the extracted directory contains LICENSE, NOTICE, README.md, compose.yaml, and the application source.

Configure​

cp .env.example .env

Replace every value described as development-only. At minimum, generate independent values for the PostgreSQL password, Typesense administrative key, setup token, encryption key, HMAC key, and search-key pepper. See Configuration and secrets.

Start and verify​

docker compose up --detach --build --wait
./infra/smoke.sh

Expected result: Compose reports healthy services and the smoke script confirms the web page, API liveness, and API readiness.

  • Dashboard: http://localhost:3000
  • Liveness: http://localhost:3001/api/v1/health/live
  • Readiness: http://localhost:3001/api/v1/health/ready

Stop without deleting data​

docker compose down

Do not add --volumes unless you intend to delete the deployment's named data volumes.

Roll back​

Application rollback is not a database rollback. Before upgrading, take a consistent backup. Restore the previous source revision, secrets, PostgreSQL dump, and service volumes as one set.