From 8e1271a1ee0f519dcdc6d5224cdbd123cb2f3d06 Mon Sep 17 00:00:00 2001 From: Mathew Jose Mammoottil Date: Wed, 29 Jan 2025 15:11:19 +0530 Subject: [PATCH 1/3] enhanced readme --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ee7724f7..000d376f 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ docker-compose version ``` #### Using prebuilt images -You can use prebuilt images generated by our CI workflow. +You can use prebuilt images generated by our CI workflow by downloading the docker-compose and .env files. - To use the latest stable version. @@ -26,6 +26,8 @@ You can use prebuilt images generated by our CI workflow. ``` curl -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/docker-compose.yml + + curl -o .env https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/.env docker-compose pull @@ -37,11 +39,19 @@ You can use prebuilt images generated by our CI workflow. ``` curl.exe -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/docker-compose.yml + curl.exe -o .env https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/.env + docker-compose pull docker-compose -f docker-compose.yml --compatibility up -d ``` + To override server configurations, change the values of the variables present in the .env file or add the respective variables to the start of the docker-compose command. + + ``` + LISTEN_IP="127.0.0.1" docker-compose -f docker-compose.yml --compatibility up -d + ``` + - To use the latest development version - Linux Machine From d680f99882ca9f246434b1c273e843cb3c1a3c99 Mon Sep 17 00:00:00 2001 From: Mathew Jose Mammoottil Date: Wed, 29 Jan 2025 15:24:40 +0530 Subject: [PATCH 2/3] enhanced setup.md --- README.md | 4 ++++ docs/setup.md | 39 ++++++++++++++++++++++++++------------- 2 files changed, 30 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 000d376f..cce2c599 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,8 @@ You can use prebuilt images generated by our CI workflow by downloading the dock ``` curl -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/develop/deploy/docker/docker-compose.yml + curl -o .env https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/.env + VERSION=develop docker-compose pull VERSION=develop docker-compose -f docker-compose.yml --compatibility up -d @@ -69,6 +71,8 @@ You can use prebuilt images generated by our CI workflow by downloading the dock ``` curl.exe -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/develop/deploy/docker/docker-compose.yml + curl.exe -o .env https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/.env + set "VERSION=develop" docker-compose pull diff --git a/docs/setup.md b/docs/setup.md index 0a0f8f78..df4209f5 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -14,28 +14,37 @@ docker-compose version You can use prebuilt images generated by our CI workflow. #### Start crAPI -- To use the latest stable version. + - To use the latest stable version. - - Linux Machine + - Linux Machine - ``` - curl -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/docker-compose.yml + ``` + curl -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/docker-compose.yml + + curl -o .env https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/.env - docker-compose pull + docker-compose pull - docker-compose -f docker-compose.yml --compatibility up -d - ``` + docker-compose -f docker-compose.yml --compatibility up -d + ``` - - Windows Machine + - Windows Machine - ``` - curl.exe -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/docker-compose.yml + ``` + curl.exe -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/docker-compose.yml - docker-compose pull + curl.exe -o .env https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/.env - docker-compose -f docker-compose.yml --compatibility up -d - ``` + docker-compose pull + + docker-compose -f docker-compose.yml --compatibility up -d + ``` + To override server configurations, change the values of the variables present in the .env file or add the respective variables to the start of the docker-compose command. + + ``` + LISTEN_IP="127.0.0.1" docker-compose -f docker-compose.yml --compatibility up -d + ``` - To use the latest development version - Linux Machine @@ -43,6 +52,8 @@ You can use prebuilt images generated by our CI workflow. ``` curl -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/develop/deploy/docker/docker-compose.yml + curl -o .env https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/.env + VERSION=develop docker-compose pull VERSION=develop docker-compose -f docker-compose.yml --compatibility up -d @@ -53,6 +64,8 @@ You can use prebuilt images generated by our CI workflow. ``` curl.exe -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/develop/deploy/docker/docker-compose.yml + curl.exe -o .env https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/.env + set "VERSION=develop" docker-compose pull From 062f5ee346144aa2ddb21bfb84f50fb2475d7d4b Mon Sep 17 00:00:00 2001 From: Mathew Jose Mammoottil Date: Wed, 29 Jan 2025 15:27:04 +0530 Subject: [PATCH 3/3] enhanced setup.md --- docs/setup.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/setup.md b/docs/setup.md index df4209f5..104a6f13 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -11,40 +11,40 @@ docker-compose version ``` ### Using prebuilt images -You can use prebuilt images generated by our CI workflow. +You can use prebuilt images generated by our CI workflow by downloading the docker-compose and .env files. #### Start crAPI - - To use the latest stable version. +- To use the latest stable version. - - Linux Machine + - Linux Machine - ``` - curl -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/docker-compose.yml - - curl -o .env https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/.env + ``` + curl -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/docker-compose.yml - docker-compose pull + curl -o .env https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/.env - docker-compose -f docker-compose.yml --compatibility up -d - ``` + docker-compose pull - - Windows Machine + docker-compose -f docker-compose.yml --compatibility up -d + ``` - ``` - curl.exe -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/docker-compose.yml + - Windows Machine - curl.exe -o .env https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/.env + ``` + curl.exe -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/docker-compose.yml - docker-compose pull + curl.exe -o .env https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/.env - docker-compose -f docker-compose.yml --compatibility up -d - ``` + docker-compose pull - To override server configurations, change the values of the variables present in the .env file or add the respective variables to the start of the docker-compose command. + docker-compose -f docker-compose.yml --compatibility up -d + ``` + To override server configurations, change the values of the variables present in the .env file or add the respective variables to the start of the docker-compose command. + + ``` + LISTEN_IP="127.0.0.1" docker-compose -f docker-compose.yml --compatibility up -d + ``` - ``` - LISTEN_IP="127.0.0.1" docker-compose -f docker-compose.yml --compatibility up -d - ``` - To use the latest development version - Linux Machine