diff --git a/README.md b/README.md index ee7724f7..cce2c599 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 @@ -49,6 +59,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 @@ -59,6 +71,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 diff --git a/docs/setup.md b/docs/setup.md index 0a0f8f78..104a6f13 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -11,7 +11,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. #### Start crAPI - To use the latest stable version. @@ -21,6 +21,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 docker-compose -f docker-compose.yml --compatibility up -d @@ -31,10 +33,17 @@ 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 @@ -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