ThatGuyJack/nginx-proxy-manager
1
0
Fork 0
mirror of https://github.com/NginxProxyManager/nginx-proxy-manager.git synced 2025-08-07 09:53:38 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
orianelou
2023-12-20 18:03:11 +02:00
committed by GitHub
parent f43b024e02
commit 4c25b81820
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -43,7 +43,7 @@ The resulting architecture with the open-appsec Agent container and the NGINX Pr
Documentation: https://docs.openappsec.io/integrations/nginx-proxy-manager-integration Documentation: https://docs.openappsec.io/integrations/nginx-proxy-manager-integration
# Deployment Step-by-Step: # Deployment Step-by-Step:
Before you start, make sure to have a Linux environment with Docker and Docker Compose available. Before you start, make sure to have a Linux environment with Docker and Docker Compose suitable with version 3.8 available.
To deploy NGINX Proxy Manager with open-appsec integration follow the steps below: To deploy NGINX Proxy Manager with open-appsec integration follow the steps below:
1. Within the directory which you want to use for the deployment: 1. Within the directory which you want to use for the deployment:
Create a folder appsec-localconfig which will hold the appsec declarative configuration file (this will be managed by the enhanced NPM WebUI) Create a folder appsec-localconfig which will hold the appsec declarative configuration file (this will be managed by the enhanced NPM WebUI)
@@ -53,12 +53,13 @@ mkdir ./appsec-localconfig
2. Download the initial declarative configuration file for open-appsec into that folder. 2. Download the initial declarative configuration file for open-appsec into that folder.
This will be managed from the NPM WebUI. This will be managed from the NPM WebUI.
``` ```
wget https://raw.githubusercontent.com/openappsec/open-appsec-npm/main/deployment/local_policy.yaml wget https://raw.githubusercontent.com/openappsec/open-appsec-npm/main/deployment/local_policy.yaml -O ./appsec-localconfig/local_policy.yaml
-O ./appsec-localconfig/local_policy.yaml
``` ```
3. Create a docker-compose.yaml file with the content below, it can be downloaded as follows: 3. Create a docker-compose.yaml file with the content below, it can be downloaded as follows:
``` ```
wget https://raw.githubusercontent.com/openappsec/open-appsec-npm/main/deployment/docker-compose.yaml wget https://raw.githubusercontent.com/openappsec/open-appsec-npm/main/deployment/docker-compose.yaml
```
```
docker-compose.yaml content: docker-compose.yaml content:
version: '3.8' version: '3.8'
# docker compose for npm open-appsec integration # docker compose for npm open-appsec integration
@@ -152,7 +153,7 @@ https://docs.openappsec.io/integrations/nginx-proxy-manager-integration/**
We offer a pre-compiled ready-to-use "open-appsec-npm" container (see above in the "Deployment" section). We offer a pre-compiled ready-to-use "open-appsec-npm" container (see above in the "Deployment" section).
## Prerequisites ## Prerequisites
- Linux Machine - Linux Machine with Docker engine deployed
- Precompiled libraries for open-appsec Attachment for the specific version of NGINX Proxy Manager - Precompiled libraries for open-appsec Attachment for the specific version of NGINX Proxy Manager
You find the detailed compilation instructions in this repo: You find the detailed compilation instructions in this repo:
https://github.com/openappsec/attachment https://github.com/openappsec/attachment