From 0c0da6d91bb6cab304cc1e08ff4d3f5bef0cc934 Mon Sep 17 00:00:00 2001 From: orianelou <126462046+orianelou@users.noreply.github.com> Date: Tue, 2 Sep 2025 10:34:35 +0300 Subject: [PATCH] Update README.md --- README.md | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 0e878ec..ea87816 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/6629/badge)](https://bestpractices.coreinfrastructure.org/projects/6629) # About -[open-appsec](https://www.openappsec.io) (openappsec.io) builds on machine learning to provide preemptive web app & API threat protection against OWASP-Top-10 and zero-day attacks. It can be deployed as an add-on to Kubernetes Ingress, NGINX, Envoy (soon), and API Gateways. +[open-appsec](https://www.openappsec.io) (openappsec.io) builds on machine learning to provide preemptive web app & API threat protection against OWASP-Top-10 and zero-day attacks. It can be deployed as an add-on to Linux, Docker or K8s deployments, on NGINX, Kong, APISIX, or Envoy. The open-appsec engine learns how users normally interact with your web application. It then uses this information to automatically detect requests that fall outside of normal operations, and conducts further analysis to decide whether the request is malicious or not. @@ -39,13 +39,13 @@ open-appsec can be managed using multiple methods: * [Using SaaS Web Management](https://docs.openappsec.io/getting-started/using-the-web-ui-saas) open-appsec Web UI: -![image](https://github.com/openappsec/openappsec/assets/114033741/22d99379-df52-45c8-984f-1b820635f3b9) +image + ## Deployment Playgrounds (Virtual labs) You can experiment with open-appsec using [Playgrounds](https://www.openappsec.io/playground) - -![image](https://github.com/openappsec/openappsec/assets/114033741/14d35d69-4577-48fc-ae87-ea344888e94d) +image # Resources * [Project Website](https://openappsec.io) @@ -54,21 +54,15 @@ You can experiment with open-appsec using [Playgrounds](https://www.openappsec.i # Installation -For Kubernetes (NGINX Ingress) using the installer: +For Kubernetes (NGINX /Kong / APISIX / Istio) using Helm: follow [documentation](https://docs.openappsec.io/getting-started/start-with-kubernetes) -```bash -$ wget https://downloads.openappsec.io/open-appsec-k8s-install && chmod +x open-appsec-k8s-install -$ ./open-appsec-k8s-install -``` - -For Kubernetes (NGINX or Kong) using Helm: follow [documentation](https://docs.openappsec.io/getting-started/start-with-kubernetes/install-using-helm-ingress-nginx-and-kong) – use this method if you’ve built your own containers. - -For Linux (NGINX or Kong) using the installer (list of supported/pre-compiled NGINX attachments is available [here](https://downloads.openappsec.io/packages/supported-nginx.txt)): +For Linux (NGINX / Kong / APISIX) using the installer (list of supported/pre-compiled NGINX attachments is available [here](https://downloads.openappsec.io/packages/supported-nginx.txt)): ```bash $ wget https://downloads.openappsec.io/open-appsec-install && chmod +x open-appsec-install $ ./open-appsec-install --auto ``` +For kong Lua Based plug in follow [documentation](https://docs.openappsec.io/getting-started/start-with-linux) For Linux, if you’ve built your own package use the following commands: