From 0e7dc2133d285127046e54d32f354579d47a86df Mon Sep 17 00:00:00 2001 From: orianelou <126462046+orianelou@users.noreply.github.com> Date: Mon, 20 Jan 2025 14:31:39 +0200 Subject: [PATCH] Update .env --- deployment/docker-compose/kong/.env | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/deployment/docker-compose/kong/.env b/deployment/docker-compose/kong/.env index 297335b..b5471ec 100644 --- a/deployment/docker-compose/kong/.env +++ b/deployment/docker-compose/kong/.env @@ -1,4 +1,4 @@ -## .env file for docker-compose deployments of open-appsec integrated with NGINX +## .env file for docker-compose deployments of open-appsec integrated with Kong ## for more info see https://docs.openappsec.io APPSEC_VERSION=latest @@ -24,10 +24,13 @@ APPSEC_DB_USER=postgres APPSEC_DB_HOST=appsec-db APPSEC_POSTGRES_STORAGE=./appsec-postgres-data -## Make sure to have a valid NGINX configuration file default.conf in the folder specified for NGINX_CONFIG. +## Make sure to have a valid Kong declarative configuration file kong.yaml in the folder specified for KONG_CONFIG. ## For deployment of a simple lab testing environment, you can deploy the example configuration provided ## for the vulnerable juice-shop container, see instructions further below. -NGINX_CONFIG=./nginx-config +KONG_CONFIG=./kong-config + +## For Kong Gateway Enterprise Edition set KONG_IMAGE to kong-gateway-attachment instead of kong-attachment +KONG_IMAGE=kong-attachment ## To connect your deployment to central open-appsec WebUI provide the token for a profile ## which you created in open-appsec WebUI at https://my.openappsec.io @@ -43,11 +46,11 @@ COMPOSE_PROFILES= ## In order to deploy the optional, additional, vulnerable juiceshop container (for demo and testing purposes only!): ## Add the value "juiceshop" to the COMPOSE_PROFILES value above. -## Make sure to also adjust the nginx.conf file in NGINX_CONFIG folder -## to include a proxy_pass directive forwarding external traffic on e.g. port 80 to the juiceshop-backend container +## Make sure to also adjust the kong.yaml file in KONG_CONFIG folder +## to include service and route configuration for forwarding external traffic to the juiceshop-backend container +## (kong listens by default for HTTP/HTTPS on port 8000/8443) ## you can use the example file available here: -## https://raw.githubusercontent.com/openappsec/openappsec/examples/juiceshop/nginx/default.conf -## place the file above in NGINX_CONFIG folder +## https://raw.githubusercontent.com/openappsec/openappsec/examples/juiceshop/kong/kong.yaml ## note that juiceshop container listens on HTTP port 3000 by default ## Note that COMPOSE_PROFILES can also receive multiple values, e.g. as shown here: