Installation

Run Vitalog’s API, web app and PostgreSQL with Docker Compose.

Vitalog runs as three services: a Hono API, a Next.js web app and PostgreSQL 17. Docker Compose builds the API and web images from this repository. The API applies Drizzle migrations before starting.

Prepare the checkout

git clone https://github.com/avgeek-oss/vitalog.git
cd vitalog
cp .env.example .env

Use a repository account with access if the repository is private. Install Docker with Compose before starting.

Configure the installation

Edit .env with your own values:

• AUTH_KEY: a high-entropy primary Bearer key with at least 32 random bytes.
• POSTGRES_PASSWORD: the database password used by Compose.
• ROOT_EMAIL and ROOT_PASSWORD: the root credentials for dashboard sign-in, key generation and OAuth consent. Use at least 15 non-padding password characters. The password must differ from AUTH_KEY.

For a loopback preview, retain PUBLIC_BASE_URL=http://127.0.0.1:3000, API_BASE_URL=http://127.0.0.1:3000 and UI_BASE_URL=http://127.0.0.1:3001. Never commit .env.

docker compose up --build -d
docker compose ps

Open http://127.0.0.1:3001/login. The API listens on loopback port 3000 and the UI on loopback port 3001. Compose keeps PostgreSQL on its private network and stores its data in a named volume.

Add public HTTPS origins

Use separate UI and API origins behind your TLS ingress. The checked-in production manifests use vitalog.praveent.com and vitalog-api.praveent.com:

UI_BASE_URL=https://vitalog.praveent.com
API_BASE_URL=https://vitalog-api.praveent.com
PUBLIC_BASE_URL=https://vitalog-api.praveent.com

The API must know its exact public origin for OAuth resource and issuer validation. Use Configuration to configure allowed browser-client origins for your ingress.

For a Towbar deployment, use the checked-in PostgreSQL, API and web manifests.

Develop locally

The repository requires Node.js 24.16 and npm 11.13. Start PostgreSQL and provide DATABASE_URL in .env, then run:

npm ci
npm run db:migrate
npm run dev

In a second terminal, run npm run dev:web. The API and web app read the root .env. Apply forward migrations with npm run db:migrate; do not use schema push for production upgrades.