Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.3ngram.ai/llms.txt

Use this file to discover all available pages before exploring further.

Self-host upgrades are Git-based. Pull the new version, rebuild images, and let the migration service apply database migrations.

​
Backup first

Create a Postgres backup before upgrading: 
docker compose exec db pg_dump -U engram -d engram > engram-backup.sql
For larger installs, use your normal Postgres backup tooling instead of shell redirection.

​
Upgrade

git pull
docker compose up --build
The migrations service runs alembic upgrade head before API, MCP, and the frontend start.

​
Rollback basics

If an upgrade fails before migrations complete, check logs and return to the previous Git revision: 
git checkout <previous-tag-or-commit>
docker compose up --build
If migrations completed, restore from the backup taken before the upgrade unless the release notes explicitly document a downgrade path.

​
Compatibility

  • Keep the API, MCP, frontend, and migrations from the same Git revision.
  • Do not run an older application image against a newer migrated database unless the release notes say it is safe.
  • Review CHANGELOG.md and docs/operations/launch-validation.md for release validation notes before a major upgrade.