diff --git a/README.md b/README.md index 2da92f2..49d6b1e 100644 --- a/README.md +++ b/README.md @@ -62,3 +62,38 @@ On your compilation environment: #### NGINX plugin associated libraries The NGINX plugin uses these libraries: shmem_ipc, compression_utils, and nginx_attachment_util. +They can be found under the `lib` directory in the `` given to the CMake. + +#### Deploying the attachment on an existing nginx server + +1. Copy the associated libraries to /usr/lib on your existing nginx server +2. Copy the nginx attachment file lib/libngx_module.so to the following path on your existing nginx server: /usr/lib/nginx/modules/ +3. Load the attachment on your nginx by adding the following command to the main nginx.conf file: + `load_module /usr/lib/nginx/modules/libngx_module.so;` +4. Restart your nginx server. + +### Compiling the attachment code and creating a docker image for an existing nginx/ingress-nginx docker + +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 +4. Run CMake command +5. Run make command + +```bash + $ git clone https://github.com/openappsec/attachment.git + $ ./attachments/nginx/ngx_module/nginx_version_configuration.sh --docker build_out + $ cmake -DCMAKE_INSTALL_PREFIX=build_out -DOUTPUT_DOCKER_IMAGE= . + $ make install + $ make docker +``` + +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.