Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 1.34 KB

INSTALL.md

File metadata and controls

40 lines (28 loc) · 1.34 KB
Raw

Software Dependencies

Ergo is developed against PostgreSQL 12 and Redis 6, but will probably work with recent earlier versions as well. No special extensions are needed.

Initialize the Environment

First, you need to set up the environment variables so that database migrations will work. The simplest way is to create a .env file in the project workspace. To initialize the database, only DATABASE_URL is needed, and the rest of the information can be added afterward.

# Fill this in with the actual connection string for a user that can create databases and roles.
DATABASE_URL=postgresql://postgres@localhost/ergo

DATABASE_ROLE_WEB_PASSWORD=*****
DATABASE_ROLE_BACKEND_PASSWORD=*****
DATABASE_ROLE_ENQUEUER_PASSWORD=*****

# These are only necessary if they are different from these defaults
DATABASE_NAME=ergo
DATABASE_HOST=localhost
DATABASE_PORT=5432
DATABASE_ROLE_WEB_USERNAME=ergo_web
DATABASE_ROLE_BACKEND_USERNAME=ergo_backend
DATABASE_ROLE_ENQUEUER_USERNAME=ergo_enqueuer
REDIS_URL=localhost

Create the Database

  1. Install sqlx-cli: cargo install sqlx-cli
  2. Run sqlx database setup to create the database and run all the migrations.

Once this is done, you can run any future database migrations with sqlx migrate run. Once Ergo reaches a semi-stable state I'll be sure to mention if this is needed when upgrading between releases.