diff --git a/deployment/APISIX/.env b/deployment/APISIX/.env index 77d8b4d..6be06df 100644 --- a/deployment/APISIX/.env +++ b/deployment/APISIX/.env @@ -6,10 +6,17 @@ APPSEC_CONFIG=./appsec-config APPSEC_DATA=./appsec-data APPSEC_LOGS=./appsec-logs APPSEC_LOCALCONFIG=./appsec-localconfig + +## Make sure the parameter APPSEC_AUTO_POLICY_LOAD is set to false when centrally managing +## open-appsec configuration via open-appsec Web UI. +## You can optionally set it to true when using local, declarative management for open-appsec, +## declarative configuration will then get applied automatically when changed. APPSEC_AUTO_POLICY_LOAD=false + ## Example for configuring HTTPS Proxy: ## APPSEC_HTTPS_PROXY=user:password@proxy_address:port APPSEC_HTTPS_PROXY= + APPSEC_SMART_SYNC_STORAGE=./appsec-smartsync-storage APPSEC_USER_EMAIL=user@email.com APPSEC_DB_PASSWORD=pass @@ -17,13 +24,32 @@ APPSEC_DB_USER=postgres APPSEC_DB_HOST=appsec-db APPSEC_POSTGRES_STORAGE=./appsec-postgres-data +## Make sure to have a valid apisix configuration for APISIX in standalone mode in the following file: +## 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. APISIX_CONFIG=./apisix-config/apisix.yaml -## To connect your deployment to central WebUI you can uncomment following line -## and provide the token for a profile which you created in open-appsec WebUI at https://my.openappsec.io +## 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 ## Example: APPSEC_AGENT_TOKEN=111-22222-111 APPSEC_AGENT_TOKEN= -## When not providing token for connection to central WebUI please uncomment following line -## which will enable sharing of learning between processes and allow you to perform tuning locally on CLI -# COMPOSE_PROFILES=standalone +## Important: When not providing token for connection to central WebUI: +## Make sure to add the value "standalone" to the COMPOSE_PROFILES value, this will enable +## sharing of learning between processes and allow you to perform tuning locally on CLI +COMPOSE_PROFILES= + +## JUICE SHOP DEMO CONTAINER: +## 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 apisix.yaml file in APISIX_CONFIG folder +## to include route and node configuration for forwarding external traffic to the juiceshop-backend container +## (apisix listens by default for HTTP/HTTPS on port 9080/9443) +## you can use the example file available here: +## https://raw.githubusercontent.com/openappsec/openappsec/refs/heads/main/examples/juiceshop/apisix.yaml +## in the appsec-apisix service definition +## 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: +## COMPOSE_PROFILES=standalone,juiceshop