Installation

What this page covers

Install-time requirements, dependency setup, and minimal local configuration.

Core workflow

1. Install dependencies at the repo root:

npm install

2. Copy and edit environment variables:

cp .env.example .env

Set at least:

POSTGRES_PASSWORD=postgram
OPENAI_API_KEY=<your-openai-key>
LOG_LEVEL=info
PORT=3100

3. (Optional but recommended) install global CLI:

npm install -g @ivotoby/postgram-cli

4. Continue to Quick Start to boot the stack.

Notes

• Required:
  • Node.js 22+
  • Docker and Docker Compose
  • OpenAI API key for embeddings
  • gpg for encrypted backups
• Optional:
  • Anthropic API key for alternative extraction models
  • Ollama for local LLM extraction