# open-appsec ## open-appsec - [open-appsec Documentation](https://docs.openappsec.io/open-appsec-documentation.md) - [What is open-appsec?](https://docs.openappsec.io/what-is-open-appsec.md) - [open-appsec Video Tutorials](https://docs.openappsec.io/open-appsec-video-tutorials.md) - [Release Notes](https://docs.openappsec.io/release-notes.md) - [Getting Started](https://docs.openappsec.io/getting-started/getting-started.md) - [Start With Linux](https://docs.openappsec.io/getting-started/start-with-linux.md) - [Install open-appsec for Linux](https://docs.openappsec.io/getting-started/start-with-linux/install-open-appsec-for-linux.md) - [Using the open-appsec-ctl Tool](https://docs.openappsec.io/getting-started/start-with-linux/using-the-open-appsec-ctl-tool.md) - [Configuration Using Local Policy File (Linux)](https://docs.openappsec.io/getting-started/start-with-linux/configuration-using-local-policy-file-linux.md) - [Local Policy File (Advanced)](https://docs.openappsec.io/getting-started/start-with-linux/local-policy-file-advanced.md) - [Local Policy File v1beta2 (beta)](https://docs.openappsec.io/getting-started/start-with-linux/local-policy-file-v1beta2-beta.md) - [Monitor Events](https://docs.openappsec.io/getting-started/start-with-linux/monitor-events.md) - [Start with Docker](https://docs.openappsec.io/getting-started/start-with-docker.md) - [Deploy With Docker-Compose](https://docs.openappsec.io/getting-started/start-with-docker/deploy-with-docker-compose.md) - [Configuration Using Local Policy File (Docker)](https://docs.openappsec.io/getting-started/start-with-docker/configuration-using-local-policy-file-docker.md) - [Local Policy File (Advanced)](https://docs.openappsec.io/getting-started/start-with-docker/local-policy-file-advanced.md) - [Deprecated Deployment Options](https://docs.openappsec.io/getting-started/start-with-docker/deprecated-deployment-options.md) - [Install With Docker (Centrally Managed)](https://docs.openappsec.io/getting-started/start-with-docker/deprecated-deployment-options/install-with-docker-centrally-managed.md) - [Install With Docker (Locally Managed)](https://docs.openappsec.io/getting-started/start-with-docker/deprecated-deployment-options/install-with-docker-locally-managed.md) - [Start With Kubernetes](https://docs.openappsec.io/getting-started/start-with-kubernetes.md) - [Install Using Interactive CLI Tool (Ingress NGINX)](https://docs.openappsec.io/getting-started/start-with-kubernetes/install-using-interactive-cli-tool-ingress-nginx.md) - [Configuration Using Interactive CLI Tool](https://docs.openappsec.io/getting-started/start-with-kubernetes/configuration-using-interactive-cli-tool.md) - [Install Using Helm](https://docs.openappsec.io/getting-started/start-with-kubernetes/install-using-helm.md) - [Install Using Helm - new flow (beta)](https://docs.openappsec.io/getting-started/start-with-kubernetes/install-using-helm-new-flow-beta.md) - [Install With Helm using Webhook](https://docs.openappsec.io/getting-started/start-with-kubernetes/install-with-helm-using-webhook.md) - [Integrate with Envoy Gateway](https://docs.openappsec.io/getting-started/start-with-kubernetes/integrate-with-envoy-gateway.md) - [Configuration Using CRDs](https://docs.openappsec.io/getting-started/start-with-kubernetes/configuration-using-crds.md) - [Configuration Using CRDs - v1beta2](https://docs.openappsec.io/getting-started/start-with-kubernetes/configuration-using-crds-v1beta2.md) - [Configuration using CRDs - special options for Large Scale Deployments](https://docs.openappsec.io/getting-started/start-with-kubernetes/configuration-using-crds-special-options-for-large-scale-deployments.md) - [Using appsec class for assigning separate custom resources to specific deployments](https://docs.openappsec.io/getting-started/start-with-kubernetes/configuration-using-crds-special-options-for-large-scale-deployments/using-appsec-class-for-assigning-separate-custom-resources-to-specific-deployments.md) - [Using namespace-scoped custom resources](https://docs.openappsec.io/getting-started/start-with-kubernetes/configuration-using-crds-special-options-for-large-scale-deployments/using-namespace-scoped-custom-resources.md) - [Monitor Events](https://docs.openappsec.io/getting-started/start-with-kubernetes/monitor-events.md) - [Using the Web UI (SaaS)](https://docs.openappsec.io/getting-started/using-the-web-ui-saas.md) - [Sign-Up and Login to Portal](https://docs.openappsec.io/getting-started/using-the-web-ui-saas/sign-up-and-login-to-portal.md) - [Agents Deployment](https://docs.openappsec.io/getting-started/using-the-web-ui-saas/agents-deployment.md): Skip this page if you already have Agents deployed - [Connect Deployed Agents to SaaS Management Using Tool (K8s & Linux)](https://docs.openappsec.io/getting-started/using-the-web-ui-saas/connect-deployed-agents-to-saas-management-using-tool-k8s-and-linux.md) - [Connect Deployed Agents to SaaS Management Using Helm (K8s)](https://docs.openappsec.io/getting-started/using-the-web-ui-saas/connect-deployed-agents-to-saas-management-using-helm-k8s.md) - [Connect Deployed Agents to SaaS Management (Docker)](https://docs.openappsec.io/getting-started/using-the-web-ui-saas/connect-deployed-agents-to-saas-management-docker.md) - [Create a Profile](https://docs.openappsec.io/getting-started/using-the-web-ui-saas/create-a-profile.md) - [Protect Additional Assets](https://docs.openappsec.io/getting-started/using-the-web-ui-saas/protect-additional-assets.md) - [Monitor Events](https://docs.openappsec.io/getting-started/using-the-web-ui-saas/monitor-events.md) - [Using Kong Konnect (Kong only)](https://docs.openappsec.io/getting-started/using-the-web-ui-saas/using-kong-konnect-kong-only.md) - [Using the Advanced Machine Learning Model](https://docs.openappsec.io/getting-started/using-the-advanced-machine-learning-model.md) - [Agents](https://docs.openappsec.io/concepts/agents.md) - [Management & Automation](https://docs.openappsec.io/concepts/management-and-automation.md) - [Security Practices](https://docs.openappsec.io/concepts/security-practices.md) - [Contextual Machine Learning](https://docs.openappsec.io/concepts/contextual-machine-learning.md) - [Setup Web Application Settings](https://docs.openappsec.io/setup-instructions/setup-web-application-settings.md) - [Setup Custom Rules and Exceptions](https://docs.openappsec.io/setup-instructions/setup-custom-rules-and-exceptions.md) - [Setup Web User Response Pages](https://docs.openappsec.io/setup-instructions/setup-web-user-response-pages.md) - [Setup Log Triggers](https://docs.openappsec.io/setup-instructions/setup-log-triggers.md) - [Setup E-Mail Notification Triggers](https://docs.openappsec.io/setup-instructions/setup-e-mail-notification-triggers.md) - [Setup Behavior Upon Failure](https://docs.openappsec.io/setup-instructions/setup-behavior-upon-failure.md) - [Setup Agent Upgrade Schedule](https://docs.openappsec.io/setup-instructions/setup-agent-upgrade-schedule.md) - [Setup Multi-Factor Authentication](https://docs.openappsec.io/setup-instructions/setup-multi-factor-authentication.md) - [Anti-Bot](https://docs.openappsec.io/additional-security-engines/anti-bot.md) - [API Schema Enforcement](https://docs.openappsec.io/additional-security-engines/api-schema-enforcement.md) - [Data Loss Prevention (DLP) Rules](https://docs.openappsec.io/additional-security-engines/data-loss-prevention-dlp-rules.md) - [File Security](https://docs.openappsec.io/additional-security-engines/file-security.md) - [Intrusion Prevention System (IPS)](https://docs.openappsec.io/additional-security-engines/intrusion-prevention-system-ips.md) - [Rate Limit](https://docs.openappsec.io/additional-security-engines/rate-limit.md): Rate Limit / DDOS Control - [Snort Rules](https://docs.openappsec.io/snort-rules.md) - [Import Snort Rules](https://docs.openappsec.io/snort-rules/import-snort-rules.md) - [Write Snort Signatures](https://docs.openappsec.io/snort-rules/write-snort-signatures.md) - [Configuration and Learning](https://docs.openappsec.io/how-to/configuration-and-learning.md) - [Track Learning and Move From Learn/Detect to Prevent](https://docs.openappsec.io/how-to/configuration-and-learning/track-learning-and-move-from-learn-detect-to-prevent.md) - [Configure Contextual Machine Learning for Best Accuracy](https://docs.openappsec.io/how-to/configuration-and-learning/configure-contextual-machine-learning-for-best-accuracy.md) - [Track Learning and Local Tuning in Standalone Deployments](https://docs.openappsec.io/how-to/configuration-and-learning/track-learning-and-local-tuning-in-standalone-deployments.md) - [Move From Detect to Prevent in K8s With Many Ingress Rules](https://docs.openappsec.io/how-to/configuration-and-learning/move-from-detect-to-prevent-in-k8s-with-many-ingress-rules.md) - [Deployment and Upgrade](https://docs.openappsec.io/deployment-and-upgrade.md) - [Load the Attachment in Proxy Configuration](https://docs.openappsec.io/deployment-and-upgrade/load-the-attachment-in-proxy-configuration.md) - [Upgrade Your Reverse Proxy/API Gateway When an Agent is Installed](https://docs.openappsec.io/deployment-and-upgrade/upgrade-your-reverse-proxy-api-gateway-when-an-agent-is-installed.md) - [Integration in GitOps CD (K8s)](https://docs.openappsec.io/deployment-and-upgrade/integration-in-gitops-cd-k8s.md) - [Build open-appsec Based on Source Code](https://docs.openappsec.io/deployment-and-upgrade/build-open-appsec-based-on-source-code.md) - [Deploying open-appsec WAF on AWS ECS](https://docs.openappsec.io/deployment-and-upgrade/deploying-open-appsec-waf-on-aws-ecs.md) - [Upgrade Postgres version (Docker-Compose)](https://docs.openappsec.io/deployment-and-upgrade/upgrade-postgres-version-docker-compose.md) - [Management Web UI](https://docs.openappsec.io/management-web-ui.md) - [Analyze Security Events with Event Advisor](https://docs.openappsec.io/management-web-ui/analyze-security-events-with-event-advisor.md) - [Track Agent Status](https://docs.openappsec.io/management-web-ui/track-agent-status.md) - [Delete or Reset Management Tenant (SaaS)](https://docs.openappsec.io/management-web-ui/delete-or-reset-management-tenant-saas.md) - [Disconnect an open-appsec agent from Central Management](https://docs.openappsec.io/management-web-ui/disconnect-an-open-appsec-agent-from-central-management.md) - [About Integrations With 3rd Party Solutions](https://docs.openappsec.io/integrations/about-integrations-with-3rd-party-solutions.md) - [CrowdSec](https://docs.openappsec.io/integrations/crowdsec.md) - [CrowdSec Bouncer Support](https://docs.openappsec.io/integrations/crowdsec/crowdsec-bouncer-support.md) - [CrowdSec Intelligence Sharing Using open-appsec Parser/Scenario](https://docs.openappsec.io/integrations/crowdsec/crowdsec-intelligence-sharing-using-open-appsec-parser-scenario.md) - [NGINX Proxy Manager](https://docs.openappsec.io/integrations/nginx-proxy-manager.md): Deploy and configure open-appsec ML-based WAF integrated with NGINX Proxy Manager to preemptively protect your web apps and APIs against zero-day attacks and OWASP Top 10 attacks. - [Deploy NGINX Proxy Manager with open-appsec managed from NPM WebUI](https://docs.openappsec.io/integrations/nginx-proxy-manager/deploy-nginx-proxy-manager-with-open-appsec-managed-from-npm-webui.md) - [Deploy NGINX Proxy Manager with open-appsec managed from central WebUI (SaaS)](https://docs.openappsec.io/integrations/nginx-proxy-manager/deploy-nginx-proxy-manager-with-open-appsec-managed-from-central-webui-saas.md) - [How to Migrate from an Existing NGINX Proxy Manager Deployment and Keep Configuration](https://docs.openappsec.io/integrations/nginx-proxy-manager/how-to-migrate-from-an-existing-nginx-proxy-manager-deployment-and-keep-configuration.md) - [(OLD VERSION) How to Migrate from an Existing NGINX Proxy Manager Deployment and Keep Configuration](https://docs.openappsec.io/integrations/nginx-proxy-manager/old-version-how-to-migrate-from-an-existing-nginx-proxy-manager-deployment-and-keep-configuration.md) - [Frequently Asked Questions](https://docs.openappsec.io/integrations/nginx-proxy-manager/frequently-asked-questions.md) - [NPMplus](https://docs.openappsec.io/integrations/npmplus.md) - [Docker SWAG](https://docs.openappsec.io/integrations/docker-swag.md): Deploy and configure open-appsec ML-based WAF integrated with Docker SWAG to preemptively protect your web apps and APIs against zero-day attacks and OWASP Top 10 attacks. - [How to connect locally managed Docker SWAG with open-appsec to WebUI](https://docs.openappsec.io/integrations/docker-swag/how-to-connect-locally-managed-docker-swag-with-open-appsec-to-webui.md) - [Deploy Docker SWAG with open-appsec](https://docs.openappsec.io/integrations/docker-swag/deploy-docker-swag-with-open-appsec.md) - [Frequently Asked Questions](https://docs.openappsec.io/integrations/docker-swag/frequently-asked-questions.md) - [Deprecated Deployment Options](https://docs.openappsec.io/integrations/docker-swag/deprecated-deployment-options.md) - [Install Docker SWAG with open-appsec (locally managed)](https://docs.openappsec.io/integrations/docker-swag/deprecated-deployment-options/install-docker-swag-with-open-appsec-locally-managed.md) - [Install Docker SWAG with open-appsec (centrally managed)](https://docs.openappsec.io/integrations/docker-swag/deprecated-deployment-options/install-docker-swag-with-open-appsec-centrally-managed.md) - [Prometheus](https://docs.openappsec.io/prometheus.md) - [Troubleshooting](https://docs.openappsec.io/troubleshooting/troubleshooting.md) - [Troubleshooting Guides](https://docs.openappsec.io/troubleshooting/troubleshooting-guides.md) - [Configuration contains ingress/asset with URL which already has asset attached to it in your tenant](https://docs.openappsec.io/troubleshooting/troubleshooting-guides/configuration-contains-ingress-asset-with-url-which-already-has-asset-attached-to-it-in-your-tenant.md) - [HTTP Request to Port 80 Not Returning as Expected](https://docs.openappsec.io/troubleshooting/troubleshooting-guides/http-request-to-port-80-not-returning-as-expected.md): Guide for Handling NGINX Port 80 HTTP Requests in Linux - [Agent Fails to Recognize HTTP Transactions with NGINX](https://docs.openappsec.io/troubleshooting/troubleshooting-guides/agent-fails-to-recognize-http-transactions-with-nginx.md): If you're experiencing issues with your WAF agent not recognizing traffic, follow these steps to troubleshoot and resolve the problem - [Agent Not Recognizing Initial HTTP Requests](https://docs.openappsec.io/troubleshooting/troubleshooting-guides/agent-not-recognizing-initial-http-requests.md) - [Handling Large Requests (413 Responses)](https://docs.openappsec.io/troubleshooting/troubleshooting-guides/handling-large-requests-413-responses.md) - [open-appsec on Docker HTTP Transaction Handler Is Set To Ready](https://docs.openappsec.io/troubleshooting/troubleshooting-guides/open-appsec-on-docker-http-transaction-handler-is-set-to-ready.md) - [Traffic Recognition Issue on Single-Core Machine/Connection Timed Out](https://docs.openappsec.io/troubleshooting/troubleshooting-guides/traffic-recognition-issue-on-single-core-machine-connection-timed-out.md) - [Installing open-appsec on CentOS 7](https://docs.openappsec.io/troubleshooting/troubleshooting-guides/installing-open-appsec-on-centos-7.md): If you encounter issues during the installation of the agent on CentOS 7, follow these troubleshooting steps to ensure a successful setup. - [SELinux: checking status and disabling](https://docs.openappsec.io/troubleshooting/troubleshooting-guides/selinux-checking-status-and-disabling.md) - [Deploy open-appsec directly on the web server hosting the application to protect](https://docs.openappsec.io/troubleshooting/troubleshooting-guides/deploy-open-appsec-directly-on-the-web-server-hosting-the-application-to-protect.md) - [object is locked or remote, and therefore cannot be modified](https://docs.openappsec.io/troubleshooting/troubleshooting-guides/object-is-locked-or-remote-and-therefore-cannot-be-modified.md) - [Policy Load Status: Error / Failed to Register to Fog](https://docs.openappsec.io/troubleshooting/troubleshooting-guides/policy-load-status-error-failed-to-register-to-fog.md) - [Failed to set sitePolicy for asset... using the original signatures](https://docs.openappsec.io/troubleshooting/troubleshooting-guides/failed-to-set-sitepolicy-for-asset...-using-the-original-signatures.md) - [Agent CLI](https://docs.openappsec.io/references/agent-cli.md) - [Event Query Language](https://docs.openappsec.io/references/event-query-language.md) - [Events/Logs Schema](https://docs.openappsec.io/references/events-logs-schema.md) - [WAF Comparison Project](https://docs.openappsec.io/references/waf-comparison-project.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.openappsec.io/open-appsec-documentation.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.