Skip to main content

PostgreSQL

PostgreSQL can be automatically configured by Devbox via the built-in Postgres Plugin. This plugin will activate automatically when you install Postgres using devbox add postgresql

Example Repo

Open In Devbox.sh

Adding Postgres to your Shell​

You can install the PostgreSQL server and client by runningdevbox add postgresql. In some Linux distributions, you may also need to add glibcLocales, which can be added using devbox add glibcLocales --platform=x86_64-linux,aarch64-linux.

Alternatively, you can add the following to your devbox.json:

  "packages": {
    "postgresql": "latest",
    "glibcLocales": {
      "version":   "latest",
      "platforms": ["x86_64-linux", "aarch64-linux"]
    }
  }

This will install the latest version of Postgres. You can find other installable versions of Postgres by running devbox search postgresql. You can also view the available versions on Nixhub

PostgreSQL Plugin Support​

Devbox will automatically create the following configuration when you run devbox add postgresql:

Services​

  • postgresql

You can use devbox services start|stop postgresql to start or stop the Postgres server in the background.

Environment Variables​

PGHOST=./.devbox/virtenv/postgresql PGDATA=./.devbox/virtenv/postgresql/data

This variable tells PostgreSQL which directory to use for creating and storing databases.

Notes​

To initialize PostgreSQL run initdb. You also need to create a database using createdb <db-name>