docs: add requirements for building docker images and connecting to p…

…eerdb (#508) - Prevent OOM when building docker images - Add compatible psql versions
PeerDB-io · Oct 13, 2023 · b48507e · b48507e
1 parent 55e7183
commit b48507e
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 .vscode
 .env
 tmp/
+.envrc
diff --git a/README.md b/README.md
@@ -28,10 +28,11 @@ git clone --recursive [email protected]:PeerDB-io/peerdb.git
 cd peerdb
 
 # Run docker containers: peerdb-server, postgres as catalog, temporal
+# Make sure to have at least 5GB of RAM for building PeerDB docker images
 export COMPOSE_PROJECT_NAME=peerdb-stack
 docker compose up
 
-# connect to peerdb and query away
+# connect to peerdb and query away (Use psql version >=14.0, <16.0)
 psql "port=9900 host=localhost password=peerdb"
 ```
-Original file line number
+Diff line change
@@ -1,3 +1,4 @@
     .vscode
     .env
     tmp/
+    .envrc