PostgreSQL Setup

Run Auvyra on PostgreSQL.

PostgreSQL is fully supported. It passes the same contract test suite as MongoDB, and every Auvyra feature works the same on every engine. Choose it if you already run PostgreSQL.

With Docker Compose

Use the PostgreSQL Compose file instead of the default one:

node scripts/generate-env.mjs
docker compose -f docker-compose.postgres.yml up -d --build

Use the same -f docker-compose.postgres.yml for every later docker compose command, such as logs and down.

PostgreSQL is not published to the host, and a MongoDB installation needs none of this.

If you already have a .env, running the script again adds the passwords it lacks and changes nothing else.

Your own server

Create an empty database, then set these in .env:

DATABASE_PROVIDER=postgresql
DATABASE_URL=postgresql://user:password@localhost:5432/auvyra

Percent-encode any special characters in the password. The user needs permission to create tables in that database.

For a local test server, bound to this machine only:

docker run -d --name auvyra-postgres -e POSTGRES_PASSWORD=change-me -e POSTGRES_DB=auvyra -p 127.0.0.1:5432:5432 -v auvyra-postgres:/var/lib/postgresql postgres:18

Check the connection

pnpm db:init

A success prints the server version. Tables are also created automatically when Auvyra starts.

Versions

Auvyra is tested against PostgreSQL 18.