From 3e4e0576586d9ca7b474c12f6edcdc09d7ac50f2 Mon Sep 17 00:00:00 2001
From: Germain <germain@souquet.com>
Date: Thu, 9 Mar 2023 09:33:05 +0000
Subject: [PATCH] Add instructions to setup db locally

---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README.md b/README.md
index 96f715e8f..674498eb5 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,11 @@ See the [Documentation](https://matrix-org.github.io/matrix-authentication-servi
   cd ..
   ```
 - Generate the sample config via `cargo run -- config generate > config.yaml`
+- Run a PostgreSQL database locally
+  ```sh
+  docker run -p 5432:5432 -e 'POSTGRES_USER=postgres' -e 'POSTGRES_PASSWORD=postgres' -e 'POSTGRES_DATABASE=postgres' postgres
+  ```
+- Update the database URI in `config.yaml` to `postgresql://postgres:postgres@localhost/postgres`
 - Run the database migrations via `cargo run -- database migrate`
 - Run the server via `cargo run -- server -c config.yaml`
 - Go to <http://localhost:8080/>