From fb7b706f40901f794b2412617c8568325e6cc7bb Mon Sep 17 00:00:00 2001 From: Christopher Lutat Date: Wed, 18 Jan 2023 12:27:03 +0100 Subject: [PATCH] Update README.md Fixed typos and added additional info for deployment on docker. --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e4e0a09..b4a47ac 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
-

openappsec/attachement

+

openappsec/attachment

## About @@ -18,7 +18,7 @@ This repository will host Attachment for different platforms. The first one is t ## open-appsec NGINX attachment compilation instructions -The attchment can be compiled to support an existing alpine based nginx server or an nginx/ingress-nginx alpine based docker. +The attachment can be compiled to support an existing alpine based nginx server or an nginx/ingress-nginx alpine based docker. Your compilation environment must be alpine based and contain git, docker, cmake and g++. @@ -71,9 +71,9 @@ They can be found under the `lib` directory in the `` given to the `load_module /usr/lib/nginx/modules/libngx_module.so;` 4. Restart your nginx server. -### Compiling the attachment code and create a docker image for an existing nginx/ingres-nginx alpine docker +### Compiling the attachment code and creating a docker image for an existing nginx/ingress-nginx alpine docker -This step requires Docker to be installed on your comilation environment +This step requires Docker to be installed on your compilation environment 1. Clone this repository 3. Run Configuration script with the required docker image name and tag @@ -90,6 +90,9 @@ This step requires Docker to be installed on your comilation environment Later on, you can push the image to your own registry and use it as needed. +For deployment on docker you can deploy it using the same docker command you used before with regular nginx container, just make sure to add the parameter `--ipc=host`. + + ## License open-appsec/attachment is open source and available under the Apache 2.0 license.