docs: added deployment docs

metabrainz · Sep 22, 2024 · d38dc34 · d38dc34
1 parent 72b9ee8
commit d38dc34
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git 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
+RUN_MODE=development
diff --git 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
@@ -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.