Added docker-compose compatibility version in readme to avoid Invalid…

… interpolation format issue (OWASP#135) * Added docker-compose compatibility version in readme to avoid Invalid interpolation format issue
appsectr · Oct 12, 2022 · 62d5fe5 · 62d5fe5
1 parent fdeac3b
commit 62d5fe5
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -10,9 +10,12 @@ know more about crAPI, please check [crAPI's overview][overview].
 
 ## QuickStart Guide
 
-### Docker
+### Docker and docker-compose
 
-You'll need to have Docker installed and running on your host system.
+You'll need to have Docker and docker-compose installed and running on your host system. Also, the version of docker-compose should be `1.27.0` or above. Check your docker-compose version using:
+```
+docker-compose version
+```
 
 #### Using prebuilt images
 You can use prebuilt images generated by our CI workflow.

diff --git a/docs/setup.md b/docs/setup.md
@@ -1,9 +1,12 @@
 Setup | crAPI
 =============
 
-## Docker
+## Docker and docker-compose
 
-You'll need to have Docker installed and running on your host system.
+You'll need to have Docker and docker-compose installed and running on your host system. Also, the version of docker-compose should be `1.27.0` or above. Check your docker-compose version using:
+```
+docker-compose version
+```
 
 ### Using prebuilt images
 You can use prebuilt images generated by our CI workflow.