diff --git a/.env.example b/.env.example index 138d486..fb5df50 100644 --- a/.env.example +++ b/.env.example @@ -1,3 +1,2 @@ # Rename this file to .env for development, DATABASE_URL will be needed by sqlx to run cargo test -RUN_MODE=development -DATABASE_URL=postgres://musicbrainz:musicbrainz@localhost:5432/musicbrainz_db \ No newline at end of file +RUN_MODE=development \ No newline at end of file diff --git a/README.md b/README.md index 1054c4d..37e834a 100644 --- a/README.md +++ b/README.md @@ -29,3 +29,6 @@ For understanding how the project is structured, check [here](docs/ARCHITECTURE. Refer to [Maintenance guide](docs/MAINTENANCE.md) for guidelines and instructions for maintaining the project. +## Deployment +Checkout [Deployment Guidelines](docs/DEPLOYMENT.md) for deployment related information. + diff --git a/docs/DEPLOYMENT.md b/docs/DEPLOYMENT.md new file mode 100644 index 0000000..57ddbbe --- /dev/null +++ b/docs/DEPLOYMENT.md @@ -0,0 +1,4 @@ +# DEPLOYMENT GUIDELINES +- All the production configs need to be added in `config/production.toml` (See `config/production.example.toml`). +- One can override all the default configs present in `config/default.toml` by adding them directly in `config/production.toml`. +- The project relies heavily on [LISTEN/NOTIFY](https://www.postgresql.org/docs/current/sql-notify.html) and [prepared statements](https://docs.rs/sqlx/latest/sqlx/fn.query.html) to be working. Unfortunately, these features do not work with PgBouncer + Transaction pooling [[here](https://github.com/pgbouncer/pgbouncer/issues/655)]. Therefore, we cannot run the app with PgBouncer. \ No newline at end of file