From 69fd7510e4e6a3c257752beb12a861dea0b896f1 Mon Sep 17 00:00:00 2001 From: noam Date: Tue, 12 Jul 2022 19:17:03 +0300 Subject: [PATCH] Update README.md --- README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 2fe5d83..0ba158a 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,11 @@ open-appsec is a machine learning security engine that preemptively and automati open-appsec Attachments connect between processes that provide HTTP data and the open-appsec Agent security logic. -An attachment gets HTTP data (URL, Header, Body, Response) from a hosting process and delivers it to an open-appsec process known as HTTP Transaction handler. The attachment does not keep any state and has no security logic. +An attachment gets HTTP data (URL, Header, Body, Response) from a hosting process and delivers it to an open-appsec process known as HTTP Transaction handler. -To deal with potential issues where the HTTP Transaction handler process is not responding, the Attachment implements a retry mechanism and -configurable fail-open/fail-close mechanism. +To deal with potential issues where the HTTP Transaction handler process is not responding, the Attachment implements a retry mechanism and configurable fail-open/fail-close mechanism. -This repository will host Attachment for different platforms. The first one is the open-appsec attachment for NGINX, implemented as a standard NGINX dynamically loadable module (plugin). +This repository will host Attachment for different platforms. The first one is the open-appsec attachment for NGINX, implemented as a standard NGINX dynamically loadable module (plugin). ## open-appsec NGINX attachment compilation instructions @@ -40,7 +39,10 @@ NGINX Plugins are built per specific version. ```bash $ module_path=//attachment - $ wget 'http://nginx.org/download/nginx-1.23.0.tar.gz' + $ wget 'https://nginx.org/download/nginx-1.23.0.tar.gz' + $ sha256sum nginx-1.23.0.tar.gz + 820acaa35b9272be9e9e72f6defa4a5f2921824709f8aa4772c78ab31ed94cd1 nginx-1.23.0.tar.gz + $ tar -xzvf nginx-1.23.0.tar.gz $ cd nginx-1.23.0/ @@ -54,10 +56,6 @@ The NGINX plugin uses these libraries: shmem_ipc, compression_utils, and nginx_a They can be found under the `lib` directory in the `` given to the CMake. -## Join the open-appssec Community! - -The open-appssec community (https://openappsec.io/community) is committed to fostering an open and welcoming environment, allowing engagement with other users and developers. - ## License open-appsec/attachment is open source and available under the Apache 2.0 license.