diff --git a/deployment/docker-compose/kong-lua-plugin/.env b/deployment/docker-compose/kong-lua-plugin/.env new file mode 100644 index 0000000..b5471ec --- /dev/null +++ b/deployment/docker-compose/kong-lua-plugin/.env @@ -0,0 +1,57 @@ +## .env file for docker-compose deployments of open-appsec integrated with Kong +## for more info see https://docs.openappsec.io + +APPSEC_VERSION=latest +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 +APPSEC_DB_USER=postgres +APPSEC_DB_HOST=appsec-db +APPSEC_POSTGRES_STORAGE=./appsec-postgres-data + +## 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. +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 +## Example: APPSEC_AGENT_TOKEN=111-22222-111 +APPSEC_AGENT_TOKEN= + +## 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 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/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: +## COMPOSE_PROFILES=standalone,juiceshop