Run Aidbox on managed PostgreSQL

This quickstart guide explains how to run Aidbox on managed PostgreSQL instance.

Aurora PostgreSQL

Prerequisites

  • aws CLI

  • psql

Connect to db cluster

Follow AWS documentation to connect to cluster using aws-cli and psql

Create role

Execute following sql in psql

CREATE USER aidbox WITH CREATEDB ENCRYPTED PASSWORD 'aidboxpass';

Azure Database for PostgreSQL flexible server

Prerequisites

  • azure CLI

Create Role

Follow Azure Documentation and execute following SQL to create role:

CREATE USER aidbox WITH CREATEDB ENCRYPTED PASSWORD 'aidboxpass';

Disable installation of PostgreSQL extensions on Aidbox startup

If your PostgreSQL user used by Aidbox does not have sufficient privileges to install extensions, you can disable the installation of extensions on startup of Aidbox by setting the environment variable AIDBOX_INSTALL_PG_EXTENSIONS to false.

The list of required extensions:

  • pgcrypto

  • unaccent

  • pg_trgm

  • fuzzystrmatch

If AIDBOX_INSTALL_PG_EXTENSIONS is set to false, Aidbox will not start without them, so you have to install them manually.

Optional list of extensions:

  • pg_similarity

  • jsonknife

  • jsquery

  • pg_stat_statements

  • postgis

Setup Aidbox to use new user

You may encounter permission denied error when creating extensions. Just connect to PostgreSQL database using user that can create extension (usually admin user created with a server) and create failed extension manually.

Setup following environment variables. If you're using existing PGDATABASE make sure aidbox role has CREATE privilege on it. Otherwise Aidbox won't be able to install most of the extensions.

PGUSER=aidbox
PGPASSWORD=aidboxpass
PGDATABASE=aidbox

Last updated