open-appsec
WebsiteManagement PortalPlaygroundGitHub
  • open-appsec Documentation
  • What is open-appsec?
  • open-appsec Video Tutorials
  • Release Notes
  • Getting started
    • Getting Started
    • Start With Kubernetes
      • Install Using Interactive CLI Tool (Ingress NGINX)
      • Configuration Using Interactive CLI Tool
      • Install Using Helm
      • Install Using Helm - new flow (beta)
      • Configuration Using CRDs
      • Configuration Using CRDs - v1beta2
      • Configuration using CRDs - special options for Large Scale Deployments
        • Using appsec class for assigning separate custom resources to specific deployments
        • Using namespace-scoped custom resources
      • Monitor Events
    • Start With Linux
      • Install open-appsec for Linux
      • Using the open-appsec-ctl Tool
      • Configuration Using Local Policy File (Linux)
      • Local Policy File (Advanced)
      • Local Policy File v1beta2 (beta)
      • Monitor Events
    • Start with Docker
      • Install With Docker (Centrally Managed)
      • Install With Docker (Locally Managed)
      • Deploy With Docker-Compose (Beta)
      • Configuration Using Local Policy File (Docker)
      • Local Policy File (Advanced)
    • Using the Web UI (SaaS)
      • Sign-Up and Login to Portal
      • Agents Deployment
      • Connect Deployed Agents to SaaS Management Using Tool (K8s & Linux)
      • Connect Deployed Agents to SaaS Management Using Helm (K8s)
      • Connect Deployed Agents to SaaS Management (Docker)
      • Create a Profile
      • Protect Additional Assets
      • Monitor Events
    • Using the Advanced Machine Learning Model
  • Concepts
    • Agents
    • Management & Automation
    • Security Practices
    • Contextual Machine Learning
  • SETUP INSTRUCTIONS
    • Setup Web Application Settings
    • Setup Custom Rules and Exceptions
    • Setup Web User Response Pages
    • Setup Log Triggers
    • Setup Behavior Upon Failure
    • Setup Agent Upgrade Schedule
  • Additional Security Engines
    • Anti-Bot
    • API Schema Enforcement
    • Data Loss Prevention (DLP) Rules
    • File Security
    • Intrusion Prevention System (IPS)
    • Rate Limit
  • Snort Rules
    • Import Snort Rules
    • Write Snort Signatures
  • HOW TO
    • Configuration and Learning
      • Track Learning and Move From Learn/Detect to Prevent
      • Configure Contextual Machine Learning for Best Accuracy
      • Track Learning and Local Tuning in Standalone Deployments
      • Move From Detect to Prevent in K8s With Many Ingress Rules
  • Deployment and Upgrade
    • Load the Attachment in Proxy Configuration
    • Upgrade Your Reverse Proxy/API Gateway When an Agent is Installed
    • Integration in GitOps CD (K8s)
    • Build open-appsec Based on Source Code
  • Management Web UI
    • Track Agent Status
    • Delete or Reset Management Tenant (SaaS)
    • Disconnect an open-appsec agent from Central Management
  • Integrations
    • About Integrations With 3rd Party Solutions
    • CrowdSec
      • CrowdSec Bouncer Support
      • CrowdSec Intelligence Sharing Using open-appsec Parser/Scenario
    • NGINX Proxy Manager
      • Install NGINX Proxy Manager with open-appsec managed from NPM WebUI
      • Install NGINX Proxy Manager with open-appsec managed from central WebUI (SaaS)
      • Frequently Asked Questions
      • How to Migrate from an Existing NGINX Proxy Manager Deployment and Keep Configuration
    • NPMplus
    • Docker SWAG
      • Install Docker SWAG with open-appsec (locally managed)
      • How to connect locally managed Docker SWAG with open-appsec to WebUI
      • Install Docker SWAG with open-appsec (centrally managed)
      • Deploy Docker SWAG with docker-compose (beta)
      • Frequently Asked Questions
  • Troubleshooting
    • Troubleshooting
    • Troubleshooting Guides
      • Configuration contains ingress/asset with URL which already has asset attached to it in your tenant
      • HTTP Request to Port 80 Not Returning as Expected
      • Agent Fails to Recognize HTTP Transactions with NGINX
      • Agent Not Recognizing Initial HTTP Requests
      • Handling Large Requests (413 Responses)
      • open-appsec on Docker HTTP Transaction Handler Is Set To Ready
      • Traffic Recognition Issue on Single-Core Machine/Connection Timed Out
      • Installing open-appsec on CentOS 7
      • SELinux: checking status and disabling
      • Deploy open-appsec directly on the web server hosting the application to protect
      • object is locked or remote, and therefore cannot be modified
      • Failed to Register to Fog
  • references
    • Agent CLI
    • Event Query Language
    • Events/Logs Schema
    • WAF Comparison Project
Powered by GitBook
On this page
  • open-appsec Source Code (GitHub)
  • Available open-appsec Source Code Repositories

Was this helpful?

  1. Deployment and Upgrade

Build open-appsec Based on Source Code

PreviousIntegration in GitOps CD (K8s)NextManagement Web UI

Last updated 3 months ago

Was this helpful?

open-appsec Source Code (GitHub)

As open-appsec is open source you can build/compile its different software components yourself based on the available sources.

The different source code repos are available in the open-appsec GitHub account:

Available open-appsec Source Code Repositories

Here's a list of open-appsec software components and the corresponding source code repos. In each of the repos you find instructions how to build software and if relevant also the containerized version yourself, deployment instructions where relevant as well as the license information.

open-appsec Agent

This is the main open-appsec software running as the open-appsec agent. It contains the contextual machine learning engine.

The source code for the open-appsec software is available in this repo:

In the README.md you will find instructions how to

  • build the installation package

  • build a corresponding container image

  • install it

open-appsec Attachment

open-appsec Attachments connect between processes that provide HTTP data and the open-appsec Agent security logic.

The source code for the open-appsec attachment is available in this repo:

In the README.md you will find instructions how to

  • build the attachment suitable for your specific environment (OS, NGINX version, Platform)

  • build a container image enhanced with the open-appsec attachment for an existing nginx container

  • deploy it to NGINX / Kong

smartsync Service (relevant for K8s only)

open-appsec smartsync service is in charge of correlating learning data from multiple agent instances and delivering a unified learning model for each asset.

The source code for the open-appsec smartsync service is available in this repo:

In the README.md you will find instructions how to

  • build the smartsync service

  • build a container image for the smartsync service

smartsync-shared-files Service (relevant for K8s only)

open-appsec smartsync-shared-files service provides an interface to physical storage used by smartsync service for storing learning data. The source code for the open-appsec smartsync-shared-files service is available in this repo:

In the README.md you will find instructions how to

  • build the smartsync-shared-files service

  • build a container image for the smartsync-shared-files service

https://github.com/openappsec
GitHub - openappsec/openappsec: open-appsec is a machine learning security engine that preemptively and automatically prevents threats against Web Application & APIs. This repo include the main code and logic.GitHub
GitHub - openappsec/attachment: Attachments connect between processes that provide HTTP data and the open-appsec Agent security logic.GitHub
GitHub - openappsec/smartsync: smartsync service is in charge of correlating learning data from multiple agent instances and delivering a unified learning model for each asset.GitHub
GitHub - openappsec/smartsync-shared-files: smartsync shared files service is in charge of providing shared file storage services for open-appsec smartsync service.GitHub
Logo
Logo
Logo
Logo