hotfix - fix docs get_git_branch

Upgrade ModSecurity-nginx to v1.0.2 - @thelittlefireman

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE]"
+labels: enhancement
+assignees: ''
+
+---
+
+**What's needed and why ?**
+Describe the feature you would like to see in the project and why it should be implemented.
+
+**Implementations ideas (optional)**
+How it should be used and integrated into the project ? List some posts, research papers or codes that we can use as implementation.

.github/workflows/autotest-bunkerized-nginx.yml

@@ -24,5 +24,3 @@ jobs:
           exit-code: '1'
           ignore-unfixed: true
           severity: 'UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL'
-          skip-dirs: '/usr/lib/go'
-

.github/workflows/build-bunkerized-nginx-autoconf.yml

@@ -0,0 +1,50 @@
+name: Build and push bunkerized-nginx-autoconf
+
+on:
+  push:
+    branches: [dev, master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout source code
+        uses: actions/checkout@v2
+
+      - name: Set variables
+        run: |
+          VER=$(cat VERSION | tr -d '\n')
+          echo "VERSION=$VER" >> $GITHUB_ENV
+
+      - name: Setup QEMU
+        uses: docker/setup-qemu-action@v1
+
+      - name: Setup Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+
+      - name: Build and push (dev)
+        uses: docker/build-push-action@v2
+        if: github.ref == 'refs/heads/dev'
+        with:
+          context: .
+          file: autoconf/Dockerfile
+          platforms: linux/amd64,linux/386,linux/arm/v7,linux/arm64/v8
+          push: true
+          tags: bunkerity/bunkerized-nginx-autoconf:dev
+
+      - name: Build and push (master)
+        uses: docker/build-push-action@v2
+        if: github.ref == 'refs/heads/master'
+        with:
+          context: .
+          file: autoconf/Dockerfile
+          platforms: linux/amd64,linux/386,linux/arm/v7,linux/arm64/v8
+          push: true
+          tags: bunkerity/bunkerized-nginx-autoconf:latest,bunkerity/bunkerized-nginx-autoconf:${{ env.VERSION }}

.github/workflows/build-bunkerized-nginx-ui.yml

@@ -0,0 +1,50 @@
+name: Build and push bunkerized-nginx-ui
+
+on:
+  push:
+    branches: [dev, master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout source code
+        uses: actions/checkout@v2
+
+      - name: Set variables
+        run: |
+          VER=$(cat VERSION | tr -d '\n')
+          echo "VERSION=$VER" >> $GITHUB_ENV
+
+      - name: Setup QEMU
+        uses: docker/setup-qemu-action@v1
+
+      - name: Setup Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+
+      - name: Build and push (dev)
+        uses: docker/build-push-action@v2
+        if: github.ref == 'refs/heads/dev'
+        with:
+          context: .
+          file: ui/Dockerfile
+          platforms: linux/amd64,linux/386,linux/arm/v7,linux/arm64/v8
+          push: true
+          tags: bunkerity/bunkerized-nginx-ui:dev
+
+      - name: Build and push (master)
+        uses: docker/build-push-action@v2
+        if: github.ref == 'refs/heads/master'
+        with:
+          context: .
+          file: ui/Dockerfile
+          platforms: linux/amd64,linux/386,linux/arm/v7,linux/arm64/v8
+          push: true
+          tags: bunkerity/bunkerized-nginx-ui:latest,bunkerity/bunkerized-nginx-ui:${{ env.VERSION }}

.github/workflows/build-bunkerized-nginx.yml

@@ -0,0 +1,65 @@
+name: Build and push bunkerized-nginx
+
+on:
+  push:
+    branches: [dev, master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout source code
+        uses: actions/checkout@v2
+
+      - name: Set variables
+        run: |
+          VER=$(cat VERSION | tr -d '\n')
+          echo "VERSION=$VER" >> $GITHUB_ENV
+
+      - name: Setup QEMU
+        uses: docker/setup-qemu-action@v1
+
+      - name: Setup Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Setup Docker cache
+        uses: actions/cache@v2
+        if: github.ref == 'refs/heads/dev'
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+
+      - name: Build and push (dev)
+        uses: docker/build-push-action@v2
+        if: github.ref == 'refs/heads/dev'
+        with:
+          context: .
+          platforms: linux/amd64,linux/386,linux/arm/v7,linux/arm64/v8
+          push: true
+          tags: bunkerity/bunkerized-nginx:dev
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache-new
+
+      - name: Move Docker cache
+        if: github.ref == 'refs/heads/dev'
+        run: |
+          rm -rf /tmp/.buildx-cache
+          mv /tmp/.buildx-cache-new /tmp/.buildx-cache
+
+      - name: Build and push (master)
+        uses: docker/build-push-action@v2
+        if: github.ref == 'refs/heads/master'
+        with:
+          context: .
+          platforms: linux/amd64,linux/386,linux/arm/v7,linux/arm64/v8
+          push: true
+          tags: bunkerity/bunkerized-nginx:latest,bunkerity/bunkerized-nginx:${{ env.VERSION }}

CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+## v1.2.7 - 2021/06/14
+
+- Add custom robots.txt and sitemap to RTD
+- Fix missing GeoIP DB bug when using BLACKLIST/WHITELIST_COUNTRY
+- Add underscore "_" to allowed chars for CUSTOM_HTTPS_CERT/KEY
+- Fix bug when using automatic self-signed certificate
+- Build and push images from GitHub actions instead of Docker Hub autobuild
+- Display the reason when generator is ignoring a variable
+- Various bug fixes related to certbot and jobs
+- Split jobs into pre and post jobs
+- Add HEALTHCHECK to image
+- Fix race condition when using autoconf without Swarm by checking healthy state
+- Bump modsecurity-nginx to v1.0.2
+- Community chat with bridged platforms
+
+## v1.2.6 - 2021/06/06
+
+- Move from "ghetto-style" shell scripts to generic jinja2 templating
+- Init work on a basic plugins system
+- Move ClamAV to external plugin
+- Reduce image size by removing unnecessary dependencies
+- Fix CrowdSec example
+- Change some global variables to multisite
+- Add LOG_LEVEL environment variable
+- Read-only container support
+- Improved antibot javascript with a basic proof of work
+- Update nginx to 1.20.1
+- Support of docker-socket-proxy with web UI
+- Add certbot-cloudflare example
+- Disable DNSBL checks when IP is local
+
+## v1.2.5 - 2021/05/14
+
+- Performance improvement : move some nginx security checks to LUA and external blacklist parsing enhancement
+- Init work on official documentation on readthedocs
+- Fix default value for CONTENT_SECURITY_POLICY to allow file downloads
+- Add ROOT_SITE_SUBFOLDER environment variable
+
+## TODO - retrospective changelog

CONTRIBUTING.md

@@ -0,0 +1,24 @@
+# Contributing to bunkerized-nginx
+
+First off all, thanks for being here and showing your support to the project !
+
+We accept many types of contributions whether they are technical or not. Every community feedback, work or help is, and will always be, appreciated.
+
+## Talk about the project
+
+The first thing you can do is to talk about the project. You can share it on social media, make a blog post about it or simply tell your friends/colleagues that's an awesome project.
+
+## Join the community chat
+
+You can join [the community chat](https://coso.me/bunkerity-chat) to talk about the project and ask for help. Please note that you can choose the platform you want, thanks to [matterbridge](https://github.com/42wim/matterbridge) all messages coming from a platform are relayed to the others.
+
+## Reporting bugs / ask for features
+
+The preferred way to report bugs and asking for features is using [issues](https://github.com/bunkerity/bunkerized-nginx/issues). Before opening a new one, please check if a related issue is already opened using the "filters" bar. When creating a new issue please select and fill the "Bug report" or "Feature request" template.
+
+## Code contribution
+
+The preferred way to contribute code is using [pull requests](https://github.com/bunkerity/bunkerized-nginx/pulls). Before creating a pull request, please check if your code is related to an opened issue. If that's not the case, you should first create an issue so we can discuss about it. This procedure is here to avoid wasting your time in case the PR will be rejected. For minor changes (e.g. : typo, quick fix, ...), opening an issue might be facultative. **Don't forget to edit the documentations when needed !**
+
+
+

Dockerfile

@@ -1,4 +1,4 @@
-FROM nginx:1.20.0-alpine
+FROM nginx:1.20.1-alpine
 
 COPY nginx-keys/ /tmp/nginx-keys
 COPY compile.sh /tmp/compile.sh
@@ -11,23 +11,30 @@ RUN chmod +x /tmp/dependencies.sh && \
     /tmp/dependencies.sh && \
     rm -rf /tmp/dependencies.sh
 
+COPY gen/ /opt/gen
 COPY entrypoint/ /opt/entrypoint
 COPY confs/ /opt/confs
 COPY scripts/ /opt/scripts
-COPY lua/ /opt/lua
+COPY lua/ /usr/local/lib/lua
+COPY antibot/ /antibot
+COPY defaults/ /defaults
+COPY settings.json /opt
+COPY misc/cron /etc/crontabs/nginx
 
 COPY prepare.sh /tmp/prepare.sh
 RUN chmod +x /tmp/prepare.sh && \
     /tmp/prepare.sh && \
     rm -f /tmp/prepare.sh
 
-# fix CVE-2021-20205
-RUN apk add "libjpeg-turbo>=2.1.0-r0"
+# Fix CVE-2021-22901, CVE-2021-22898 and CVE-2021-22897
+RUN apk add "curl>=7.77.0-r0"
 
-VOLUME /www /http-confs /server-confs /modsec-confs /modsec-crs-confs /cache /pre-server-confs /acme-challenge
+VOLUME /www /http-confs /server-confs /modsec-confs /modsec-crs-confs /cache /pre-server-confs /acme-challenge /plugins
 
 EXPOSE 8080/tcp 8443/tcp
 
 USER nginx:nginx
 
+HEALTHCHECK --interval=30s --timeout=10s --start-period=120s --retries=3 CMD [ -f /tmp/nginx.pid ] || exit 1
+
 ENTRYPOINT ["/opt/entrypoint/entrypoint.sh"]

Dockerfile-amd64

@@ -1,33 +0,0 @@
-FROM amd64/nginx:1.20.0-alpine
-
-COPY nginx-keys/ /tmp/nginx-keys
-COPY compile.sh /tmp/compile.sh
-RUN chmod +x /tmp/compile.sh && \
-    /tmp/compile.sh && \
-    rm -rf /tmp/*
-
-COPY dependencies.sh /tmp/dependencies.sh
-RUN chmod +x /tmp/dependencies.sh && \
-    /tmp/dependencies.sh && \
-    rm -rf /tmp/dependencies.sh
-
-COPY entrypoint/ /opt/entrypoint
-COPY confs/ /opt/confs
-COPY scripts/ /opt/scripts
-COPY lua/ /opt/lua
-
-COPY prepare.sh /tmp/prepare.sh
-RUN chmod +x /tmp/prepare.sh && \
-    /tmp/prepare.sh && \
-    rm -f /tmp/prepare.sh
-
-# fix CVE-2021-20205
-RUN apk add "libjpeg-turbo>=2.1.0-r0"
-
-VOLUME /www /http-confs /server-confs /modsec-confs /modsec-crs-confs /cache /pre-server-confs /acme-challenge
-
-EXPOSE 8080/tcp 8443/tcp
-
-USER nginx:nginx
-
-ENTRYPOINT ["/opt/entrypoint/entrypoint.sh"]

Dockerfile-arm32v7

@@ -1,40 +0,0 @@
-FROM alpine AS builder
-
-ENV QEMU_URL https://github.com/balena-io/qemu/releases/download/v4.0.0%2Bbalena2/qemu-4.0.0.balena2-arm.tar.gz
-RUN apk add curl && curl -L ${QEMU_URL} | tar zxvf - -C . --strip-components 1
-
-FROM arm32v7/nginx:1.20.0-alpine
-
-COPY --from=builder qemu-arm-static /usr/bin
-
-COPY nginx-keys/ /tmp/nginx-keys
-COPY compile.sh /tmp/compile.sh
-RUN chmod +x /tmp/compile.sh && \
-    /tmp/compile.sh && \
-    rm -rf /tmp/*
-
-COPY dependencies.sh /tmp/dependencies.sh
-RUN chmod +x /tmp/dependencies.sh && \
-    /tmp/dependencies.sh && \
-    rm -rf /tmp/dependencies.sh
-
-COPY entrypoint/ /opt/entrypoint
-COPY confs/ /opt/confs
-COPY scripts/ /opt/scripts
-COPY lua/ /opt/lua
-
-COPY prepare.sh /tmp/prepare.sh
-RUN chmod +x /tmp/prepare.sh && \
-    /tmp/prepare.sh && \
-    rm -f /tmp/prepare.sh
-
-# fix CVE-2021-20205
-RUN apk add "libjpeg-turbo>=2.1.0-r0"
-
-VOLUME /www /http-confs /server-confs /modsec-confs /modsec-crs-confs /cache /pre-server-confs /acme-challenge
-
-EXPOSE 8080/tcp 8443/tcp
-
-USER nginx:nginx
-
-ENTRYPOINT ["/opt/entrypoint/entrypoint.sh"]

Dockerfile-arm64v8

@@ -1,40 +0,0 @@
-FROM alpine AS builder
-
-ENV QEMU_URL https://github.com/balena-io/qemu/releases/download/v4.0.0%2Bbalena2/qemu-4.0.0.balena2-aarch64.tar.gz
-RUN apk add curl && curl -L ${QEMU_URL} | tar zxvf - -C . --strip-components 1
-
-FROM arm64v8/nginx:1.20.0-alpine
-
-COPY --from=builder qemu-aarch64-static /usr/bin
-
-COPY nginx-keys/ /tmp/nginx-keys
-COPY compile.sh /tmp/compile.sh
-RUN chmod +x /tmp/compile.sh && \
-    /tmp/compile.sh && \
-    rm -rf /tmp/*
-
-COPY dependencies.sh /tmp/dependencies.sh
-RUN chmod +x /tmp/dependencies.sh && \
-    /tmp/dependencies.sh && \
-    rm -rf /tmp/dependencies.sh
-
-COPY entrypoint/ /opt/entrypoint
-COPY confs/ /opt/confs
-COPY scripts/ /opt/scripts
-COPY lua/ /opt/lua
-
-COPY prepare.sh /tmp/prepare.sh
-RUN chmod +x /tmp/prepare.sh && \
-    /tmp/prepare.sh && \
-    rm -f /tmp/prepare.sh
-
-# fix CVE-2021-20205
-RUN apk add "libjpeg-turbo>=2.1.0-r0"
-
-VOLUME /www /http-confs /server-confs /modsec-confs /modsec-crs-confs /cache /pre-server-confs /acme-challenge
-
-EXPOSE 8080/tcp 8443/tcp
-
-USER nginx:nginx
-
-ENTRYPOINT ["/opt/entrypoint/entrypoint.sh"]

Dockerfile-i386

@@ -1,33 +0,0 @@
-FROM i386/nginx:1.20.0-alpine
-
-COPY nginx-keys/ /tmp/nginx-keys
-COPY compile.sh /tmp/compile.sh
-RUN chmod +x /tmp/compile.sh && \
-    /tmp/compile.sh && \
-    rm -rf /tmp/*
-
-COPY dependencies.sh /tmp/dependencies.sh
-RUN chmod +x /tmp/dependencies.sh && \
-    /tmp/dependencies.sh && \
-    rm -rf /tmp/dependencies.sh
-
-COPY entrypoint/ /opt/entrypoint
-COPY confs/ /opt/confs
-COPY scripts/ /opt/scripts
-COPY lua/ /opt/lua
-
-COPY prepare.sh /tmp/prepare.sh
-RUN chmod +x /tmp/prepare.sh && \
-    /tmp/prepare.sh && \
-    rm -f /tmp/prepare.sh
-
-# fix CVE-2021-20205
-RUN apk add "libjpeg-turbo>=2.1.0-r0"
-
-VOLUME /www /http-confs /server-confs /modsec-confs /modsec-crs-confs /cache /pre-server-confs /acme-challenge
-
-EXPOSE 8080/tcp 8443/tcp
-
-USER nginx:nginx
-
-ENTRYPOINT ["/opt/entrypoint/entrypoint.sh"]

LICENSE.md

@@ -0,0 +1,660 @@
+### GNU AFFERO GENERAL PUBLIC LICENSE
+
+Version 3, 19 November 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc.
+<https://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+### Preamble
+
+The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains
+free software for all its users.
+
+When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate. Many developers of free software are heartened and
+encouraged by the resulting cooperation. However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community. It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server. Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals. This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing
+under this license.
+
+The precise terms and conditions for copying, distribution and
+modification follow.
+
+### TERMS AND CONDITIONS
+
+#### 0. Definitions.
+
+"This License" refers to version 3 of the GNU Affero General Public
+License.
+
+"Copyright" also means copyright-like laws that apply to other kinds
+of works, such as semiconductor masks.
+
+"The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of
+an exact copy. The resulting work is called a "modified version" of
+the earlier work or a work "based on" the earlier work.
+
+A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user
+through a computer network, with no transfer of a copy, is not
+conveying.
+
+An interactive user interface displays "Appropriate Legal Notices" to
+the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+#### 1. Source Code.
+
+The "source code" for a work means the preferred form of the work for
+making modifications to it. "Object code" means any non-source form of
+a work.
+
+A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+The Corresponding Source need not include anything that users can
+regenerate automatically from other parts of the Corresponding Source.
+
+The Corresponding Source for a work in source code form is that same
+work.
+
+#### 2. Basic Permissions.
+
+All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+You may make, run and propagate covered works that you do not convey,
+without conditions so long as your license otherwise remains in force.
+You may convey covered works to others for the sole purpose of having
+them make modifications exclusively for you, or provide you with
+facilities for running those works, provided that you comply with the
+terms of this License in conveying all material for which you do not
+control copyright. Those thus making or running the covered works for
+you must do so exclusively on your behalf, under your direction and
+control, on terms that prohibit them from making any copies of your
+copyrighted material outside their relationship with you.
+
+Conveying under any other circumstances is permitted solely under the
+conditions stated below. Sublicensing is not allowed; section 10 makes
+it unnecessary.
+
+#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such
+circumvention is effected by exercising rights under this License with
+respect to the covered work, and you disclaim any intention to limit
+operation or modification of the work as a means of enforcing, against
+the work's users, your or third parties' legal rights to forbid
+circumvention of technological measures.
+
+#### 4. Conveying Verbatim Copies.
+
+You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+#### 5. Conveying Modified Source Versions.
+
+You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these
+conditions:
+
+-   a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+-   b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under
+    section 7. This requirement modifies the requirement in section 4
+    to "keep intact all notices".
+-   c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy. This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged. This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+-   d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+#### 6. Conveying Non-Source Forms.
+
+You may convey a covered work in object code form under the terms of
+sections 4 and 5, provided that you also convey the machine-readable
+Corresponding Source under the terms of this License, in one of these
+ways:
+
+-   a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+-   b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the Corresponding
+    Source from a network server at no charge.
+-   c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source. This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+-   d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge. You need not require recipients to copy the
+    Corresponding Source along with the object code. If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source. Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+-   e) Convey the object code using peer-to-peer transmission,
+    provided you inform other peers where the object code and
+    Corresponding Source of the work are being offered to the general
+    public at no charge under subsection 6d.
+
+A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal,
+family, or household purposes, or (2) anything designed or sold for
+incorporation into a dwelling. In determining whether a product is a
+consumer product, doubtful cases shall be resolved in favor of
+coverage. For a particular product received by a particular user,
+"normally used" refers to a typical or common use of that class of
+product, regardless of the status of the particular user or of the way
+in which the particular user actually uses, or expects or is expected
+to use, the product. A product is a consumer product regardless of
+whether the product has substantial commercial, industrial or
+non-consumer uses, unless such uses represent the only significant
+mode of use of the product.
+
+"Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to
+install and execute modified versions of a covered work in that User
+Product from a modified version of its Corresponding Source. The
+information must suffice to ensure that the continued functioning of
+the modified object code is in no case prevented or interfered with
+solely because modification has been made.
+
+If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or
+updates for a work that has been modified or installed by the
+recipient, or for the User Product in which it has been modified or
+installed. Access to a network may be denied when the modification
+itself materially and adversely affects the operation of the network
+or violates the rules and protocols for communication across the
+network.
+
+Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+#### 7. Additional Terms.
+
+"Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders
+of that material) supplement the terms of this License with terms:
+
+-   a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+-   b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+-   c) Prohibiting misrepresentation of the origin of that material,
+    or requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+-   d) Limiting the use for publicity purposes of names of licensors
+    or authors of the material; or
+-   e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+-   f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions
+    of it) with contractual assumptions of liability to the recipient,
+    for any liability that these contractual assumptions directly
+    impose on those licensors and authors.
+
+All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions; the
+above requirements apply either way.
+
+#### 8. Termination.
+
+You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+However, if you cease all violation of this License, then your license
+from a particular copyright holder is reinstated (a) provisionally,
+unless and until the copyright holder explicitly and finally
+terminates your license, and (b) permanently, if the copyright holder
+fails to notify you of the violation by some reasonable means prior to
+60 days after the cessation.
+
+Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+#### 9. Acceptance Not Required for Having Copies.
+
+You are not required to accept this License in order to receive or run
+a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+#### 10. Automatic Licensing of Downstream Recipients.
+
+Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+#### 11. Patents.
+
+A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+A contributor's "essential patent claims" are all patent claims owned
+or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+A patent license is "discriminatory" if it does not include within the
+scope of its coverage, prohibits the exercise of, or is conditioned on
+the non-exercise of one or more of the rights that are specifically
+granted under this License. You may not convey a covered work if you
+are a party to an arrangement with a third party that is in the
+business of distributing software, under which you make payment to the
+third party based on the extent of your activity of conveying the
+work, and under which the third party grants, to any of the parties
+who would receive the covered work from you, a discriminatory patent
+license (a) in connection with copies of the covered work conveyed by
+you (or copies made from those copies), or (b) primarily for and in
+connection with specific products or compilations that contain the
+covered work, unless you entered into that arrangement, or that patent
+license was granted, prior to 28 March 2007.
+
+Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+#### 12. No Surrender of Others' Freedom.
+
+If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under
+this License and any other pertinent obligations, then as a
+consequence you may not convey it at all. For example, if you agree to
+terms that obligate you to collect a royalty for further conveying
+from those to whom you convey the Program, the only way you could
+satisfy both those terms and this License would be to refrain entirely
+from conveying the Program.
+
+#### 13. Remote Network Interaction; Use with the GNU General Public License.
+
+Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your
+version supports such interaction) an opportunity to receive the
+Corresponding Source of your version by providing access to the
+Corresponding Source from a network server at no charge, through some
+standard or customary means of facilitating copying of software. This
+Corresponding Source shall include the Corresponding Source for any
+work covered by version 3 of the GNU General Public License that is
+incorporated pursuant to the following paragraph.
+
+Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+#### 14. Revised Versions of this License.
+
+The Free Software Foundation may publish revised and/or new versions
+of the GNU Affero General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever
+published by the Free Software Foundation.
+
+If the Program specifies that a proxy can decide which future versions
+of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+#### 15. Disclaimer of Warranty.
+
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
+WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
+PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
+DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
+CORRECTION.
+
+#### 16. Limitation of Liability.
+
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
+CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
+ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
+NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
+LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
+TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
+PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+#### 17. Interpretation of Sections 15 and 16.
+
+If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+END OF TERMS AND CONDITIONS
+
+### How to Apply These Terms to Your New Programs
+
+If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these
+terms.
+
+To do so, attach the following notices to the program. It is safest to
+attach them to the start of each source file to most effectively state
+the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+        <one line to give the program's name and a brief idea of what it does.>
+        Copyright (C) <year>  <name of author>
+
+        This program is free software: you can redistribute it and/or modify
+        it under the terms of the GNU Affero General Public License as
+        published by the Free Software Foundation, either version 3 of the
+        License, or (at your option) any later version.
+
+        This program is distributed in the hope that it will be useful,
+        but WITHOUT ANY WARRANTY; without even the implied warranty of
+        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+        GNU Affero General Public License for more details.
+
+        You should have received a copy of the GNU Affero General Public License
+        along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper
+mail.
+
+If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source. For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code. There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for
+the specific requirements.
+
+You should also get your employer (if you work as a programmer) or
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. For more information on this, and how to apply and follow
+the GNU AGPL, see <https://www.gnu.org/licenses/>.

README.md

@@ -3,19 +3,26 @@
 </p>
 
 <p align="center">
-        <img src="https://img.shields.io/badge/bunkerized--nginx-1.2.5-blue" />
-        <img src="https://img.shields.io/badge/nginx-1.20.0-blue" />
+        <img src="https://img.shields.io/badge/bunkerized--nginx-1.2.7-blue" />
+        <img src="https://img.shields.io/badge/nginx-1.20.1-blue" />
         <img src="https://img.shields.io/github/last-commit/bunkerity/bunkerized-nginx" />
         <img src="https://img.shields.io/github/workflow/status/bunkerity/bunkerized-nginx/Automatic%20test?label=automatic%20test" />
-        <img src="https://img.shields.io/docker/cloud/build/bunkerity/bunkerized-nginx" />
+        <img src="https://img.shields.io/github/workflow/status/bunkerity/bunkerized-nginx/Build%20and%20push%20bunkerized-nginx?label=docker%20build" />
         <img src="https://img.shields.io/readthedocs/bunkerized-nginx" />
 </p>
 
 <p align="center">
-        <a href="https://bunkerized-nginx.readthedocs.io"><img src="https://img.shields.io/badge/documentation-bunkerized--nginx.readthedocs.io-blue" /></a>  
-	<a href="https://matrix.to/#/#bunkerized-nginx:matrix.org"><img src="https://img.shields.io/badge/matrix%20chat-%23bunkerized--nginx%3Amatrix.org-blue" /></a>
-        <a href="https://www.bunkerity.com"><img src="https://img.shields.io/badge/website-www.bunkerity.com-blue" /></a>  
-        <a href="https://twitter.com/bunkerity"><img src="https://img.shields.io/twitter/follow/bunkerity?style=social" /></a>
+	<strong>
+		<a href="https://bunkerized-nginx.readthedocs.io">Documentation</a>
+		<span> | </span>
+		<a href="https://github.com/bunkerity/bunkerized-nginx/tree/master/examples">Examples</a>
+		<span> | </span>
+		<a href="https://www.bunkerity.com/category/bunkerized-nginx/">Blog posts</a>
+		<span> | </span>
+		<a href="https://coso.me/bunkerity-chat">Community chat</a>
+		<span> | </span>
+		<a href="https://coso.me/bunkerity">Follow us</a>
+	</strong>
 </p>
 
 nginx Docker image secure by default.  
@@ -31,7 +38,7 @@ Non-exhaustive list of features :
 - Block TOR, proxies, bad user-agents, countries, ...
 - Block known bad IP with DNSBL and CrowdSec
 - Prevent bruteforce attacks with rate limiting
-- Detect bad files with ClamAV
+- Plugins system for external security checks (e.g. : ClamAV)
 - Easy to configure with environment variables or web UI
 - Automatic configuration with container labels
 - Docker Swarm support
@@ -59,6 +66,8 @@ You can find a live demo at https://demo-nginx.bunkerity.com, feel free to do so
   * [Web UI](#web-ui)
 - [Security tuning](#security-tuning)
 - [Going further](#going-further)
+- [License](#license)
+- [Contributing](#contributing)
 </details>
 
 # Quickstart guide
@@ -357,17 +366,29 @@ docker service create --name anotherapp \
 
 ## Web UI
 
-**This feature exposes, for now, a security risk because you need to mount the docker socket inside a container exposing a web application. You can test it but you should not use it in servers facing the internet.**  
-
 A dedicated image, *bunkerized-nginx-ui*, lets you manage bunkerized-nginx instances and services configurations through a web user interface. This feature is still in beta, feel free to open a new issue if you find a bug and/or you have an idea to improve it. 
 
-First we need a volume that will store the configurations :
+First we need a volume that will store the configurations and a network because bunkerized-nginx will be used as a reverse proxy for the web UI :
 
 ```shell
 docker volume create nginx_conf
+docker network create mynet
 ```
 
-Then, we can create the bunkerized-nginx instance with the `bunkerized-nginx.UI` label and a reverse proxy configuration for our web UI :
+Let's create the bunkerized-nginx-ui container that will host the web UI behind bunkerized-nginx :
+
+```shell
+docker run --network mynet \
+           --name myui \
+           -v /var/run/docker.sock:/var/run/docker.sock:ro \
+           -v nginx_conf:/etc/nginx \
+           -e ABSOLUTE_URI=https://admin.domain.com/webui/ \
+           bunkerity/bunkerized-nginx-ui
+```
+
+You will need to edit the `ABSOLUTE_URI` environment variable to reflect your actual URI of the web UI.
+
+We can now setup the bunkerized-nginx instance with the `bunkerized-nginx.UI` label and a reverse proxy configuration for our web UI :
 
 ```shell
 docker network create mynet
@@ -383,6 +404,7 @@ docker run -p 80:8080 \
            -e AUTO_LETS_ENCRYPT=yes \
            -e REDIRECT_HTTP_TO_HTTPS=yes \
            -e DISABLE_DEFAULT_SERVER=yes \
+           -e admin.domain.com_USE_MODSECURITY=no \
            -e admin.domain.com_SERVE_FILES=no \
            -e admin.domain.com_USE_AUTH_BASIC=yes \
            -e admin.domain.com_AUTH_BASIC_USER=admin \
@@ -394,19 +416,9 @@ docker run -p 80:8080 \
            bunkerity/bunkerized-nginx
 ```
 
-The `AUTH_BASIC` environment variables let you define a login/password that must be provided before accessing to the web UI. At the moment, there is no authentication mechanism integrated into bunkerized-nginx-ui.
+The `AUTH_BASIC` environment variables let you define a login/password that must be provided before accessing to the web UI. At the moment, there is no authentication mechanism integrated into bunkerized-nginx-ui so **using auth basic with a strong password coupled with a "hard to guess" URI is strongly recommended**.
 
-We can now create the bunkerized-nginx-ui container that will host the web UI behind bunkerized-nginx :
-
-```shell
-docker run --network mynet \
-           -v /var/run/docker.sock:/var/run/docker.sock:ro \
-           -v nginx_conf:/etc/nginx \
-           -e ABSOLUTE_URI=https://admin.domain.com/webui/ \
-           bunkerity/bunkerized-nginx-ui
-```
-
-After that, the web UI should be accessible from https://admin.domain.com/webui/.
+Web UI should now be accessible from https://admin.domain.com/webui/.
 
 # Security tuning
 
@@ -417,3 +429,11 @@ bunkerized-nginx comes with a set of predefined security settings that you can (
 - [Official documentation](https://bunkerized-nginx.readthedocs.io/)
 - [Full concrete examples](https://github.com/bunkerity/bunkerized-nginx/tree/master/examples)
 - [Tutorials in our blog](https://www.bunkerity.com/blog)
+
+# License
+
+This project is licensed under the terms of the [GNU Affero General Public License (AGPL) version 3](https://github.com/bunkerity/bunkerized-nginx/LICENSE.md).
+
+# Contributing
+
+If you would like to contribute to the project you can read the [contributing guidelines](https://github.com/bunkerity/bunkerized-nginx/CONTRIBUTING.md) to get started.

VERSION

@@ -1 +1 @@
-1.2.5
+1.2.7

antibot/captcha.data

@@ -0,0 +1,5 @@
+<form method="POST" action="%s">
+	<img src="data:image/jpeg;base64,%s" /><br>
+	Captcha : <input type="text" name="captcha" /><br />
+	<input type="submit" value="send" />
+</form>

antibot/captcha.html

@@ -0,0 +1,24 @@
+<html>
+	<head>
+		<title>Website protection</title>
+		<style>
+			body {
+				background-color: #1d70b7;
+			}
+			.centered {
+				position: fixed;
+				top: 50%;
+				left: 50%;
+				transform: translate(-50%, -50%);
+				text-align: center;
+			}
+		</style>
+	</head>
+	<body>
+		<div class="centered" style="color: white;">
+			<h1>As a security measure, we ask you to complete this captcha to access our website :</h1>
+			%CAPTCHA%
+			<div>&#128737;&#65039; this website is protected with <a href="https://github.com/bunkerity/bunkerized-nginx" target="_blank">bunkerized-nginx</a> &#128737;&#65039;</div>
+		</div>
+	</body>
+</html>

antibot/javascript.data

@@ -0,0 +1,29 @@
+<script>
+	async function digestMessage(message) {
+		const msgUint8 = new TextEncoder().encode(message);
+		const hashBuffer = await crypto.subtle.digest('SHA-256', msgUint8);
+		const hashArray = Array.from(new Uint8Array(hashBuffer));
+		const hashHex = hashArray.map(b => b.toString(16).padStart(2, '0')).join('');
+		return hashHex;
+	}
+	(async () => {
+		const nonce = '%s';
+		var i = 0;
+		while (true) {
+			var digestHex = await digestMessage(nonce + i.toString());
+			if (digestHex.startsWith("0000")) {
+				break;
+			}
+			i++;
+		}
+		xhr = new XMLHttpRequest();
+		xhr.open('POST', '%s');
+		xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
+		xhr.onload = function() {
+			if (xhr.status === 200) {
+				window.location.replace('%s');
+			}
+		};
+		xhr.send(encodeURI('challenge=' + i.toString()));
+	})();
+</script>

antibot/javascript.html

@@ -0,0 +1,43 @@
+<html>
+	<head>
+		<title>Website protection</title>
+		<style>
+			body {
+				background-color: #1d70b7;
+			}
+			.centered {
+				position: fixed;
+				top: 50%;
+				left: 50%;
+				transform: translate(-50%, -50%);
+				text-align: center;
+			}
+			.loader {
+				border: 16px solid #1d70b7;
+				border-top: 16px solid #2dab66;
+				border-radius: 50%;
+				width: 120px;
+				height: 120px;
+				animation: spin 2s linear infinite;
+				display: block;
+				margin-left: auto;
+				margin-right: auto;
+			}
+			@keyframes spin {
+				0% { transform: rotate(0deg); }
+				100% { transform: rotate(360deg); }
+			}
+		</style>
+	</head>
+	<body>
+		<div class="centered" style="color: white;">
+			<div class="loader"></div>
+			<noscript>
+				<h1 style="color: red;">In order to access this website, you need to enable JavaScript.</h1>
+			</noscript>
+			<h1>Please wait while we are doing some security checks...</h1>
+			&#128737;&#65039; this website is protected with <a href="https://github.com/bunkerity/bunkerized-nginx" target="_blank">bunkerized-nginx</a> &#128737;&#65039;
+		</div>
+		%JAVASCRIPT%
+	</body>
+</html>

antibot/recaptcha-body.data

@@ -0,0 +1,11 @@
+<form method="POST" action="%s" id="form">
+	<input type="hidden" name="token" id="token">
+</form>
+<script>
+	grecaptcha.ready(function() {
+		grecaptcha.execute('%s', {action: 'recaptcha'}).then(function(token) {
+			document.getElementById("token").value = token;
+			document.getElementById("form").submit();
+		});;
+	});
+</script>

antibot/recaptcha-head.data

@@ -0,0 +1 @@
+<script src="https://www.google.com/recaptcha/api.js?render=%s"></script>

antibot/recaptcha.html

@@ -0,0 +1,44 @@
+<html>
+	<head>
+		<title>Website protection</title>
+		<style>
+			body {
+				background-color: #1d70b7;
+			}
+			.centered {
+				position: fixed;
+				top: 50%;
+				left: 50%;
+				transform: translate(-50%, -50%);
+				text-align: center;
+			}
+			.loader {
+				border: 16px solid #1d70b7;
+				border-top: 16px solid #2dab66;
+				border-radius: 50%;
+				width: 120px;
+				height: 120px;
+				animation: spin 2s linear infinite;
+				display: block;
+				margin-left: auto;
+				margin-right: auto;
+			}
+			@keyframes spin {
+				0% { transform: rotate(0deg); }
+				100% { transform: rotate(360deg); }
+			}
+		</style>
+		%RECAPTCHA_HEAD%
+	</head>
+	<body>
+		<div class="centered" style="color: white;">
+			<div class="loader"></div>
+			<noscript>
+				<h1 style="color: red;">In order to access this website, you need to enable JavaScript.</h1>
+			</noscript>
+			<h1>Please wait while we are doing some security checks...</h1>
+			&#128737;&#65039; this website is protected with <a href="https://github.com/bunkerity/bunkerized-nginx" target="_blank">bunkerized-nginx</a> &#128737;&#65039;
+		</div>
+		%RECAPTCHA_BODY%
+	</body>
+</html>

autoconf/AutoConf.py

@@ -1,6 +1,8 @@
 from Config import Config
+
 import utils
-import os
+
+import os, time
 
 class AutoConf :
 
@@ -8,7 +10,7 @@ class AutoConf :
 		self.__swarm = swarm
 		self.__servers = {}
 		self.__instances = {}
-		self.__sites = {}
+		self.__env = {}
 		self.__config = Config(self.__swarm, api)
 
 	def get_server(self, id) :
@@ -19,6 +21,36 @@ class AutoConf :
 	def reload(self) :
 		return self.__config.reload(self.__instances)
 
+	def __gen_env(self) :
+		self.__env.clear()
+		# TODO : check actual state (e.g. : running, stopped ?)
+		for id, instance in self.__instances.items() :
+			env = []
+			if self.__swarm :
+				env = instance.attrs["Spec"]["TaskTemplate"]["ContainerSpec"]["Env"]
+			else :
+				env = instance.attrs["Config"]["Env"]
+			for entry in env :
+				self.__env[entry.split("=")[0]] = entry.replace(entry.split("=")[0] + "=", "", 1)
+			blacklist = ["NGINX_VERSION", "NJS_VERSION", "PATH", "PKG_RELEASE"]
+			for entry in blacklist :
+				if entry in self.__env :
+					del self.__env[entry]
+		if not "SERVER_NAME" in self.__env or self.__env["SERVER_NAME"] == "" :
+			self.__env["SERVER_NAME"] = []
+		else :
+			self.__env["SERVER_NAME"] = self.__env["SERVER_NAME"].split(" ")
+		for server in self.__servers :
+			(id, name, labels) = self.__get_infos(self.__servers[server])
+			first_server = labels["bunkerized-nginx.SERVER_NAME"].split(" ")[0]
+			for label in labels :
+				if label.startswith("bunkerized-nginx.") :
+					self.__env[first_server + "_" + label.replace("bunkerized-nginx.", "", 1)] = labels[label]
+			for server_name in labels["bunkerized-nginx.SERVER_NAME"].split(" ") :
+				if not server_name in self.__env["SERVER_NAME"] :
+					self.__env["SERVER_NAME"].append(server_name)
+		self.__env["SERVER_NAME"] = " ".join(self.__env["SERVER_NAME"])
+
 	def pre_process(self, objs) :
 		for instance in objs :
 			(id, name, labels) = self.__get_infos(instance)
@@ -61,71 +93,103 @@ class AutoConf :
 		return (id, name, labels)
 
 	def __process_instance(self, instance, event, id, name, labels) :
+
 		if event == "create" :
 			self.__instances[id] = instance
+			self.__gen_env()
+			utils.log("[*] bunkerized-nginx instance created : " + name + " / " + id)
 			if self.__swarm and len(self.__instances) == 1 :
-				if self.__config.initconf(self.__instances) :
+				if self.__config.generate(self.__env) :
 					utils.log("[*] Initial config succeeded")
+					if not self.__config.swarm_wait(self.__instances) :
+						utils.log("[!] Removing bunkerized-nginx instances from list (API not available)")
+						del self.__instances[id]
 				else :
 					utils.log("[!] Initial config failed")
-			utils.log("[*] bunkerized-nginx instance created : " + name + " / " + id)
+			elif not self.__swarm and len(self.__instances) == 1 :
+				utils.log("[*] Wait until bunkerized-nginx is healthy (timeout = 120s) ...")
+				i = 0
+				healthy = False
+				while i < 120 :
+					self.__instances[id].reload()
+					if self.__instances[id].attrs["State"]["Health"]["Status"] == "healthy" :
+						healthy = True
+						break
+					time.sleep(1)
+					i = i + 1
+				if not healthy :
+					utils.log("[!] Removing bunkerized-nginx instances from list (unhealthy)")
+					del self.__instances[id]
+
 		elif event == "start" :
 			self.__instances[id].reload()
+			self.__gen_env()
 			utils.log("[*] bunkerized-nginx instance started : " + name + " / " + id)
+
 		elif event == "die" :
 			self.__instances[id].reload()
+			self.__gen_env()
 			utils.log("[*] bunkerized-nginx instance stopped : " + name + " / " + id)
+
 		elif event == "destroy" or event == "remove" :
 			del self.__instances[id]
-			if self.__swarm and len(self.__instances) == 0 :
-				with open("/etc/crontabs/nginx", "w") as f :
-					f.write("")
-				if os.path.exists("/etc/nginx/autoconf") :
-					os.remove("/etc/nginx/autoconf")
+			self.__gen_env()
 			utils.log("[*] bunkerized-nginx instance removed : " + name + " / " + id)
 
 	def __process_server(self, instance, event, id, name, labels) :
+
 		vars = { k.replace("bunkerized-nginx.", "", 1) : v for k, v in labels.items() if k.startswith("bunkerized-nginx.")}
+
 		if event == "create" :
 			utils.log("[*] Generating config for " + vars["SERVER_NAME"] + " ...")
-			if self.__config.generate(self.__instances, vars) :
+			self.__servers[id] = instance
+			self.__gen_env()
+			if self.__config.generate(self.__env) :
 				utils.log("[*] Generated config for " + vars["SERVER_NAME"])
-				self.__servers[id] = instance
 				if self.__swarm :
 					utils.log("[*] Activating config for " + vars["SERVER_NAME"] + " ...")
-					if self.__config.activate(self.__instances, vars) :
+					if self.__config.reload(self.__instances) :
 						utils.log("[*] Activated config for " + vars["SERVER_NAME"])
 					else :
-						utils.log("[!] Can't activate config for " + vars["SERVER_NAME"])
+ 						utils.log("[!] Can't activate config for " + vars["SERVER_NAME"])
 			else :
 				utils.log("[!] Can't generate config for " + vars["SERVER_NAME"])
+				del self.__servers[id]
+				self.__gen_env()
+				self.__config.generate(self.__env)
+
 		elif event == "start" :
 			if id in self.__servers :
 				self.__servers[id].reload()
 				utils.log("[*] Activating config for " + vars["SERVER_NAME"] + " ...")
-				if self.__config.activate(self.__instances, vars) :
+				self.__gen_env()
+				if self.__config.reload(self.__instances) :
 					utils.log("[*] Activated config for " + vars["SERVER_NAME"])
 				else :
 					utils.log("[!] Can't activate config for " + vars["SERVER_NAME"])
+
 		elif event == "die" :
 			if id in self.__servers :
 				self.__servers[id].reload()
 				utils.log("[*] Deactivating config for " + vars["SERVER_NAME"])
-				if self.__config.deactivate(self.__instances, vars) :
+				self.__gen_env()
+				if self.__config.reload() :
 					utils.log("[*] Deactivated config for " + vars["SERVER_NAME"])
 				else :
 					utils.log("[!] Can't deactivate config for " + vars["SERVER_NAME"])
+
 		elif event == "destroy" or event == "remove" :
 			if id in self.__servers :
-				if self.__swarm :
-					utils.log("[*] Deactivating config for " + vars["SERVER_NAME"])
-					if self.__config.deactivate(self.__instances, vars) :
-						utils.log("[*] Deactivated config for " + vars["SERVER_NAME"])
-					else :
-						utils.log("[!] Can't deactivate config for " + vars["SERVER_NAME"])
-				del self.__servers[id]
 				utils.log("[*] Removing config for " + vars["SERVER_NAME"])
-				if self.__config.remove(vars) :
+				del self.__servers[id]
+				self.__gen_env()
+				if self.__config.generate(self.__env) :
 					utils.log("[*] Removed config for " + vars["SERVER_NAME"])
 				else :
 					utils.log("[!] Can't remove config for " + vars["SERVER_NAME"])
+				utils.log("[*] Deactivating config for " + vars["SERVER_NAME"])
+				if self.__config.reload(self.__instances) :
+					utils.log("[*] Deactivated config for " + vars["SERVER_NAME"])
+				else :
+					utils.log("[!] Can't deactivate config for " + vars["SERVER_NAME"])
+

autoconf/Config.py

@@ -9,36 +9,26 @@ class Config :
 		self.__swarm = swarm
 		self.__api = api
 
+	def __jobs(self, type) :
+		utils.log("[*] Starting jobs (type = " + type + ") ...")
+		proc = subprocess.run(["/bin/su", "-c", "/opt/entrypoint/" + type + "-jobs.sh", "nginx"], capture_output=True)
+		stdout = proc.stdout.decode("ascii")
+		stderr = proc.stderr.decode("ascii")
+		if len(stdout) > 1 :
+			utils.log("[*] Jobs stdout :")
+			utils.log(stdout)
+		if stderr != "" :
+			utils.log("[!] Jobs stderr :")
+			utils.log(stderr)
+		if proc.returncode != 0 :
+			utils.log("[!] Jobs error : return code != 0")
+			return False
+		return True
 
-	def initconf(self, instances) :
+	def swarm_wait(self, instances) :
 		try :
-			for instance_id, instance in instances.items() :
-				env = instance.attrs["Spec"]["TaskTemplate"]["ContainerSpec"]["Env"]
-				break
-			vars = {}
-			for var_value in env :
-				var = var_value.split("=")[0]
-				value = var_value.replace(var + "=", "", 1)
-				vars[var] = value
-
-			utils.log("[*] Generating global config ...")
-			if not self.globalconf(instances) :
-				utils.log("[!] Can't generate global config")
-				return False
-			utils.log("[*] Generated global config")
-
-			if "SERVER_NAME" in vars and vars["SERVER_NAME"] != "" :
-				for server in vars["SERVER_NAME"].split(" ") :
-					vars_site = vars.copy()
-					vars_site["SERVER_NAME"] = server
-					utils.log("[*] Generating config for " + vars["SERVER_NAME"] + " ...")
-					if not self.generate(instances, vars_site) or not self.activate(instances, vars_site, reload=False) :
-						utils.log("[!] Can't generate/activate site config for " + server)
-						return False
-					utils.log("[*] Generated config for " + vars["SERVER_NAME"])
 			with open("/etc/nginx/autoconf", "w") as f :
 				f.write("ok")
-
 			utils.log("[*] Waiting for bunkerized-nginx tasks ...")
 			i = 1
 			started = False
@@ -51,124 +41,50 @@ class Config :
 				utils.log("[!] Waiting " + str(i) + " seconds before retrying to contact bunkerized-nginx tasks")
 			if started :
 				utils.log("[*] bunkerized-nginx tasks started")
-				proc = subprocess.run(["/bin/su", "-s", "/opt/entrypoint/jobs.sh", "nginx"], env=vars, capture_output=True)
-				return proc.returncode == 0
+				return True
 			else :
 				utils.log("[!] bunkerized-nginx tasks are not started")
 		except Exception as e :
-			utils.log("[!] Error while initializing config : " + str(e))
+			utils.log("[!] Error while waiting for Swarm tasks : " + str(e))
 		return False
 
-	def globalconf(self, instances) :
+	def generate(self, env) :
 		try :
-			for instance_id, instance in instances.items() :
-				env = instance.attrs["Spec"]["TaskTemplate"]["ContainerSpec"]["Env"]
-				break
-			vars = {}
-			for var_value in env :
-				var = var_value.split("=")[0]
-				value = var_value.replace(var + "=", "", 1)
-				vars[var] = value
-			proc = subprocess.run(["/bin/su", "-s", "/opt/entrypoint/global-config.sh", "nginx"], env=vars, capture_output=True)
+			# Write environment variables to a file
+			with open("/tmp/variables.env", "w") as f :
+				for k, v in env.items() :
+					f.write(k + "=" + v + "\n")
+
+			# Call the generator
+			proc = subprocess.run(["/bin/su", "-c", "/opt/gen/main.py --settings /opt/settings.json --templates /opt/confs --output /etc/nginx --variables /tmp/variables.env", "nginx"], capture_output=True)
+
+			# Print stdout/stderr
+			stdout = proc.stdout.decode("ascii")
+			stderr = proc.stderr.decode("ascii")
+			if len(stdout) > 1 :
+				utils.log("[*] Generator output :")
+				utils.log(stdout)
+			if stderr != "" :
+				utils.log("[*] Generator error :")
+				utils.log(error)
+
+			# We're done
 			if proc.returncode == 0 :
-				return True
-			else :
-				utils.log("[*] Error while generating global config : return code = " + str(proc.returncode))
-		except Exception as e :
-			utils.log("[!] Exception while generating global config : " + str(e))
-		return False
-
-	def generate(self, instances, vars) :
-		try :
-			# Get env vars from bunkerized-nginx instances
-			vars_instances = {}
-			for instance_id, instance in instances.items() :
 				if self.__swarm :
-					env = instance.attrs["Spec"]["TaskTemplate"]["ContainerSpec"]["Env"]
-				else :
-					env = instance.attrs["Config"]["Env"]
-				for var_value in env :
-					var = var_value.split("=")[0]
-					value = var_value.replace(var + "=", "", 1)
-					vars_instances[var] = value
-			vars_defaults = vars.copy()
-			vars_defaults.update(vars_instances)
-			vars_defaults.update(vars)
-			# Call site-config.sh to generate the config
-			proc = subprocess.run(["/bin/su", "-s", "/bin/sh", "-c", "/opt/entrypoint/site-config.sh" + " \"" + vars["SERVER_NAME"] + "\"", "nginx"], env=vars_defaults, capture_output=True)
-			if proc.returncode == 0 and vars_defaults["MULTISITE"] == "yes" and self.__swarm :
-				proc = subprocess.run(["/bin/su", "-s", "/opt/entrypoint/multisite-config.sh", "nginx"], env=vars_defaults, capture_output=True)
-			if proc.returncode == 0 :
+					return self.__jobs("pre")
 				return True
-			utils.log("[!] Error while generating site config for " + vars["SERVER_NAME"] + "  : return code = " + str(proc.returncode))
+			utils.log("[!] Error while generating site config for " + env["SERVER_NAME"] + " : return code = " + str(proc.returncode))
+
 		except Exception as e :
 			utils.log("[!] Exception while generating site config : " + str(e))
 		return False
 
-	def activate(self, instances, vars, reload=True) :
-		try :
-			# Get first server name
-			first_server_name = vars["SERVER_NAME"].split(" ")[0]
-
-			# Check if file exists
-			if not os.path.isfile("/etc/nginx/" + first_server_name + "/server.conf") :
-				utils.log("[!] /etc/nginx/" + first_server_name + "/server.conf doesn't exist")
-				return False
-
-			# Include the server conf
-			utils.replace_in_file("/etc/nginx/nginx.conf", "}", "include /etc/nginx/" + first_server_name + "/server.conf;\n}")
-
-			# Reload
-			if not reload or self.reload(instances) :
-				return True
-
-		except Exception as e :
-			utils.log("[!] Exception while activating config : " + str(e))
-
-		return False
-
-	def deactivate(self, instances, vars) :
-		try :
-			# Get first server name
-			first_server_name = vars["SERVER_NAME"].split(" ")[0]
-
-			# Check if file exists
-			if not os.path.isfile("/etc/nginx/" + first_server_name + "/server.conf") :
-				utils.log("[!] /etc/nginx/" + first_server_name + "/server.conf doesn't exist")
-				return False
-
-			# Remove the include
-			utils.replace_in_file("/etc/nginx/nginx.conf", "include /etc/nginx/" + first_server_name + "/server.conf;\n", "")
-
-			# Reload
-			if self.reload(instances) :
-				return True
-
-		except Exception as e :
-			utils.log("[!] Exception while deactivating config : " + str(e))
-
-		return False
-
-	def remove(self, vars) :
-		try :
-			# Get first server name
-			first_server_name = vars["SERVER_NAME"].split(" ")[0]
-
-			# Check if file exists
-			if not os.path.isfile("/etc/nginx/" + first_server_name + "/server.conf") :
-				utils.log("[!] /etc/nginx/" + first_server_name + "/server.conf doesn't exist")
-				return False
-
-			# Remove the folder
-			shutil.rmtree("/etc/nginx/" + first_server_name)
-			return True
-		except Exception as e :
-			utils.log("[!] Error while deactivating config : " + str(e))
-
-		return False
-
 	def reload(self, instances) :
-		return self.__api_call(instances, "/reload")
+		if self.__api_call(instances, "/reload") :
+			if self.__swarm :
+				return self.__jobs("post")
+			return True
+		return False
 
 	def __ping(self, instances) :
 		return self.__api_call(instances, "/ping")
@@ -193,7 +109,7 @@ class Config :
 						req = requests.post("http://" + fqdn + ":8080" + self.__api + path)
 					except :
 						pass
-					if req and req.status_code == 200 :
+					if req and req.status_code == 200 and req.text == "ok" :
 						utils.log("[*] Sent API order " + path + " to instance " + fqdn + " (service.node.task)")
 					else :
 						utils.log("[!] Can't send API order " + path + " to instance " + fqdn + " (service.node.task)")

autoconf/Dockerfile

@@ -1,45 +1,22 @@
-FROM nginx:stable-alpine AS builder
-
 FROM alpine
 
-COPY --from=builder /etc/nginx/ /opt/confs/nginx
+COPY autoconf/dependencies.sh /tmp
+RUN chmod +x /tmp/dependencies.sh && \
+    /tmp/dependencies.sh && \
+    rm -f /tmp/dependencies.sh
 
-RUN apk add py3-pip apache2-utils bash certbot curl logrotate openssl && \
-    pip3 install docker requests && \
-    mkdir /opt/entrypoint && \
-    mkdir -p /opt/confs/site && \
-    mkdir -p /opt/confs/global && \
-    mkdir /opt/scripts && \
-    addgroup -g 101 nginx && \
-    adduser -h /var/cache/nginx -g nginx -s /sbin/nologin -G nginx -D -H -u 101 nginx && \
-    mkdir /etc/letsencrypt && \
-    chown root:nginx /etc/letsencrypt && \
-    chmod 770 /etc/letsencrypt && \
-    mkdir /var/log/letsencrypt && \
-    chown root:nginx /var/log/letsencrypt && \
-    chmod 770 /var/log/letsencrypt && \
-    mkdir /var/lib/letsencrypt && \
-    chown root:nginx /var/lib/letsencrypt && \
-    chmod 770 /var/lib/letsencrypt && \
-    mkdir /cache && \
-    chown root:nginx /cache && \
-    chmod 770 /cache && \
-    touch /var/log/jobs.log && \
-    chown root:nginx /var/log/jobs.log && \
-    chmod 770 /var/log/jobs.log && \
-    chown -R root:nginx /opt/confs/nginx && \
-    chmod -R 770 /opt/confs/nginx && \
-    mkdir /acme-challenge && \
-    chown root:nginx /acme-challenge && \
-    chmod 770 /acme-challenge
-
-
-COPY autoconf/misc/logrotate.conf /etc/logrotate.conf
-COPY scripts/* /opt/scripts/
-COPY confs/site/ /opt/confs/site
+COPY gen/ /opt/gen
+COPY entrypoint/ /opt/entrypoint
 COPY confs/global/ /opt/confs/global
-COPY entrypoint/* /opt/entrypoint/
+COPY confs/site/ /opt/confs/site
+COPY scripts/ /opt/scripts
+COPY settings.json /opt
+COPY misc/cron /etc/crontabs/nginx
 COPY autoconf/* /opt/entrypoint/
-RUN chmod +x /opt/entrypoint/*.py /opt/entrypoint/*.sh /opt/scripts/*.sh
+
+COPY autoconf/prepare.sh /tmp
+RUN chmod +x /tmp/prepare.sh && \
+    /tmp/prepare.sh && \
+    rm -f /tmp/prepare.sh
 
 ENTRYPOINT ["/opt/entrypoint/entrypoint.sh"]

autoconf/Dockerfile-amd64

@@ -1,44 +0,0 @@
-FROM nginx:stable-alpine AS builder
-
-FROM amd64/alpine
-
-COPY --from=builder /etc/nginx/ /opt/confs/nginx
-
-RUN apk add py3-pip apache2-utils bash certbot curl logrotate openssl && \
-    pip3 install docker requests && \
-    mkdir /opt/entrypoint && \
-    mkdir -p /opt/confs/site && \
-    mkdir -p /opt/confs/global && \
-    mkdir /opt/scripts && \
-    addgroup -g 101 nginx && \
-    adduser -h /var/cache/nginx -g nginx -s /sbin/nologin -G nginx -D -H -u 101 nginx && \
-    mkdir /etc/letsencrypt && \
-    chown root:nginx /etc/letsencrypt && \
-    chmod 770 /etc/letsencrypt && \
-    mkdir /var/log/letsencrypt && \
-    chown root:nginx /var/log/letsencrypt && \
-    chmod 770 /var/log/letsencrypt && \
-    mkdir /var/lib/letsencrypt && \
-    chown root:nginx /var/lib/letsencrypt && \
-    chmod 770 /var/lib/letsencrypt && \
-    mkdir /cache && \
-    chown root:nginx /cache && \
-    chmod 770 /cache && \
-    touch /var/log/jobs.log && \
-    chown root:nginx /var/log/jobs.log && \
-    chmod 770 /var/log/jobs.log && \
-    chown -R root:nginx /opt/confs/nginx && \
-    chmod -R 770 /opt/confs/nginx && \
-    mkdir /acme-challenge && \
-    chown root:nginx /acme-challenge && \
-    chmod 770 /acme-challenge
-
-COPY autoconf/misc/logrotate.conf /etc/logrotate.conf
-COPY scripts/* /opt/scripts/
-COPY confs/global/ /opt/confs/global
-COPY confs/site/ /opt/confs/site
-COPY entrypoint/* /opt/entrypoint/
-COPY autoconf/* /opt/entrypoint/
-RUN chmod +x /opt/entrypoint/*.py /opt/entrypoint/*.sh /opt/scripts/*.sh
-
-ENTRYPOINT ["/opt/entrypoint/entrypoint.sh"]

autoconf/Dockerfile-arm32v7

@@ -1,50 +0,0 @@
-FROM alpine AS builder
-
-ENV QEMU_URL https://github.com/balena-io/qemu/releases/download/v4.0.0%2Bbalena2/qemu-4.0.0.balena2-arm.tar.gz
-RUN apk add curl && curl -L ${QEMU_URL} | tar zxvf - -C . --strip-components 1
-
-FROM nginx:stable-alpine AS builder2
-
-FROM arm32v7/alpine
-
-COPY --from=builder qemu-arm-static /usr/bin
-COPY --from=builder2 /etc/nginx/ /opt/confs/nginx
-
-RUN apk add py3-pip apache2-utils bash certbot curl logrotate openssl && \
-    pip3 install docker requests && \
-    mkdir /opt/entrypoint && \
-    mkdir -p /opt/confs/site && \
-    mkdir -p /opt/confs/global && \
-    mkdir /opt/scripts && \
-    addgroup -g 101 nginx && \
-    adduser -h /var/cache/nginx -g nginx -s /sbin/nologin -G nginx -D -H -u 101 nginx && \
-    mkdir /etc/letsencrypt && \
-    chown root:nginx /etc/letsencrypt && \
-    chmod 770 /etc/letsencrypt && \
-    mkdir /var/log/letsencrypt && \
-    chown root:nginx /var/log/letsencrypt && \
-    chmod 770 /var/log/letsencrypt && \
-    mkdir /var/lib/letsencrypt && \
-    chown root:nginx /var/lib/letsencrypt && \
-    chmod 770 /var/lib/letsencrypt && \
-    mkdir /cache && \
-    chown root:nginx /cache && \
-    chmod 770 /cache && \
-    touch /var/log/jobs.log && \
-    chown root:nginx /var/log/jobs.log && \
-    chmod 770 /var/log/jobs.log && \
-    chown -R root:nginx /opt/confs/nginx && \
-    chmod -R 770 /opt/confs/nginx && \
-    mkdir /acme-challenge && \
-    chown root:nginx /acme-challenge && \
-    chmod 770 /acme-challenge
-
-COPY autoconf/misc/logrotate.conf /etc/logrotate.conf
-COPY scripts/* /opt/scripts/
-COPY confs/global/ /opt/confs/global
-COPY confs/site/ /opt/confs/site
-COPY entrypoint/* /opt/entrypoint/
-COPY autoconf/* /opt/entrypoint/
-RUN chmod +x /opt/entrypoint/*.py /opt/entrypoint/*.sh /opt/scripts/*.sh
-
-ENTRYPOINT ["/opt/entrypoint/entrypoint.sh"]

autoconf/Dockerfile-arm64v8

@@ -1,50 +0,0 @@
-FROM alpine AS builder
-
-ENV QEMU_URL https://github.com/balena-io/qemu/releases/download/v4.0.0%2Bbalena2/qemu-4.0.0.balena2-aarch64.tar.gz
-RUN apk add curl && curl -L ${QEMU_URL} | tar zxvf - -C . --strip-components 1
-
-FROM nginx:stable-alpine AS builder2
-
-FROM arm64v8/alpine
-
-COPY --from=builder qemu-aarch64-static /usr/bin
-COPY --from=builder2 /etc/nginx/ /opt/confs/nginx
-
-RUN apk add py3-pip apache2-utils bash certbot curl logrotate openssl && \
-    pip3 install docker requests && \
-    mkdir /opt/entrypoint && \
-    mkdir -p /opt/confs/site && \
-    mkdir -p /opt/confs/global && \
-    mkdir /opt/scripts && \
-    addgroup -g 101 nginx && \
-    adduser -h /var/cache/nginx -g nginx -s /sbin/nologin -G nginx -D -H -u 101 nginx && \
-    mkdir /etc/letsencrypt && \
-    chown root:nginx /etc/letsencrypt && \
-    chmod 770 /etc/letsencrypt && \
-    mkdir /var/log/letsencrypt && \
-    chown root:nginx /var/log/letsencrypt && \
-    chmod 770 /var/log/letsencrypt && \
-    mkdir /var/lib/letsencrypt && \
-    chown root:nginx /var/lib/letsencrypt && \
-    chmod 770 /var/lib/letsencrypt && \
-    mkdir /cache && \
-    chown root:nginx /cache && \
-    chmod 770 /cache && \
-    touch /var/log/jobs.log && \
-    chown root:nginx /var/log/jobs.log && \
-    chmod 770 /var/log/jobs.log && \
-    chown -R root:nginx /opt/confs/nginx && \
-    chmod -R 770 /opt/confs/nginx && \
-    mkdir /acme-challenge && \
-    chown root:nginx /acme-challenge && \
-    chmod 770 /acme-challenge
-
-COPY autoconf/misc/logrotate.conf /etc/logrotate.conf
-COPY scripts/* /opt/scripts/
-COPY confs/global/ /opt/confs/global
-COPY confs/site/ /opt/confs/site
-COPY entrypoint/* /opt/entrypoint/
-COPY autoconf/* /opt/entrypoint/
-RUN chmod +x /opt/entrypoint/*.py /opt/entrypoint/*.sh /opt/scripts/*.sh
-
-ENTRYPOINT ["/opt/entrypoint/entrypoint.sh"]

autoconf/Dockerfile-i386

@@ -1,44 +0,0 @@
-FROM nginx:stable-alpine AS builder
-
-FROM i386/alpine
-
-COPY --from=builder /etc/nginx/ /opt/confs/nginx
-
-RUN apk add py3-pip apache2-utils bash certbot curl logrotate openssl && \
-    pip3 install docker requests && \
-    mkdir /opt/entrypoint && \
-    mkdir -p /opt/confs/site && \
-    mkdir -p /opt/confs/global && \
-    mkdir /opt/scripts && \
-    addgroup -g 101 nginx && \
-    adduser -h /var/cache/nginx -g nginx -s /sbin/nologin -G nginx -D -H -u 101 nginx && \
-    mkdir /etc/letsencrypt && \
-    chown root:nginx /etc/letsencrypt && \
-    chmod 770 /etc/letsencrypt && \
-    mkdir /var/log/letsencrypt && \
-    chown root:nginx /var/log/letsencrypt && \
-    chmod 770 /var/log/letsencrypt && \
-    mkdir /var/lib/letsencrypt && \
-    chown root:nginx /var/lib/letsencrypt && \
-    chmod 770 /var/lib/letsencrypt && \
-    mkdir /cache && \
-    chown root:nginx /cache && \
-    chmod 770 /cache && \
-    touch /var/log/jobs.log && \
-    chown root:nginx /var/log/jobs.log && \
-    chmod 770 /var/log/jobs.log && \
-    chown -R root:nginx /opt/confs/nginx && \
-    chmod -R 770 /opt/confs/nginx && \
-    mkdir /acme-challenge && \
-    chown root:nginx /acme-challenge && \
-    chmod 770 /acme-challenge
-
-COPY autoconf/misc/logrotate.conf /etc/logrotate.conf
-COPY scripts/* /opt/scripts/
-COPY confs/global/ /opt/confs/global
-COPY confs/site/ /opt/confs/site
-COPY entrypoint/* /opt/entrypoint/
-COPY autoconf/* /opt/entrypoint/
-RUN chmod +x /opt/entrypoint/*.py /opt/entrypoint/*.sh /opt/scripts/*.sh
-
-ENTRYPOINT ["/opt/entrypoint/entrypoint.sh"]

autoconf/app.py

@@ -39,8 +39,7 @@ except docker.errors.APIError as e :
 	sys.exit(3)
 
 # Process them before events
-with lock :
-	autoconf.pre_process(before)
+autoconf.pre_process(before)
 
 # Process events received from Docker
 try :
@@ -65,8 +64,7 @@ try :
 				continue
 
 		# Process the event
-		with lock :
-			autoconf.process(server, event["Action"])
+		autoconf.process(server, event["Action"])
 
 except docker.errors.APIError as e :
 	utils.log("[!] Docker API error " + str(e))

autoconf/dependencies.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+# install dependencies
+apk add py3-pip bash certbot curl openssl
+pip3 install docker requests jinja2

autoconf/entrypoint.sh

@@ -9,7 +9,6 @@ if [ "$?" -ne 0 ] ; then
 fi
 
 if [ "$SWARM_MODE" = "yes" ] ; then
-	cp -r /opt/confs/nginx/* /etc/nginx
 	chown -R root:nginx /etc/nginx
 	chmod -R 770 /etc/nginx
 fi
@@ -19,28 +18,19 @@ function trap_exit() {
 	echo "[*] Catched stop operation"
 	echo "[*] Stopping crond ..."
 	pkill -TERM crond
-	echo "[*] Stopping python3 ..."
+	echo "[*] Stopping autoconf ..."
 	pkill -TERM python3
-	pkill -TERM tail
 }
 trap "trap_exit" TERM INT QUIT
 
-# remove old crontabs
-echo "" > /etc/crontabs/root
-
-# setup logrotate
-touch /var/log/jobs.log
-echo "0 0 * * * /usr/sbin/logrotate -f /etc/logrotate.conf > /dev/null 2>&1" >> /etc/crontabs/root
-
 # start cron
 crond
 
 # run autoconf app
 /opt/entrypoint/app.py &
-
-# display logs
-tail -F /var/log/jobs.log &
 pid="$!"
+
+# wait while app is up
 wait "$pid"
 
 # stop

autoconf/misc/logrotate.conf

@@ -1,23 +0,0 @@
-/var/log/*.log /var/log/letsencrypt/*.log {
-	# compress old files using gzip
-	compress
-
-	# rotate everyday
-	daily
-
-	# remove old logs after X days
-	maxage 7
-	rotate 7
-
-	# no errors if a file is missing
-	missingok
-
-	# disable mailing
-	nomail
-
-	# mininum size of a logfile before rotating
-	minsize 10M
-
-	# make a copy and truncate the files
-	copytruncate
-}

autoconf/prepare.sh

@@ -0,0 +1,44 @@
+#!/bin/sh
+
+# create nginx user
+addgroup -g 101 nginx
+adduser -h /var/cache/nginx -g nginx -s /bin/sh -G nginx -D -H -u 101 nginx
+
+# prepare /opt
+chown -R root:nginx /opt
+find /opt -type f -exec chmod 0740 {} \;
+find /opt -type d -exec chmod 0750 {} \;
+chmod ugo+x /opt/entrypoint/* /opt/scripts/*
+chmod ugo+x /opt/gen/main.py
+chmod 770 /opt
+chmod 440 /opt/settings.json
+
+# prepare /var/log
+ln -s /proc/1/fd/1 /var/log/jobs.log
+mkdir /var/log/letsencrypt
+chown nginx:nginx /var/log/letsencrypt
+chmod 770 /var/log/letsencrypt
+
+# prepare /etc/letsencrypt
+mkdir /etc/letsencrypt
+chown root:nginx /etc/letsencrypt
+chmod 770 /etc/letsencrypt
+
+# prepare /var/lib/letsencrypt
+mkdir /var/lib/letsencrypt
+chown root:nginx /var/lib/letsencrypt
+chmod 770 /var/lib/letsencrypt
+
+# prepare /cache
+mkdir /cache
+chown root:nginx /cache
+chmod 770 /cache
+
+# prepare /acme-challenge
+mkdir /acme-challenge
+chown root:nginx /acme-challenge
+chmod 770 /acme-challenge
+
+# prepare /etc/crontabs/nginx
+chown root:nginx /etc/crontabs/nginx
+chmod 440 /etc/crontabs/nginx

compile.sh

@@ -57,7 +57,7 @@ cp crs-setup.conf.example /opt/owasp/crs.conf
 # get nginx modules
 cd /tmp
 # ModSecurity connector for nginx
-git_secure_clone https://github.com/SpiderLabs/ModSecurity-nginx.git 22e53aba4e3ae8c7d59a3672d6727e49246afe96
+git_secure_clone https://github.com/SpiderLabs/ModSecurity-nginx.git 2497e6ac654d0b117b9534aa735b757c6b11c84f
 # headers more
 git_secure_clone https://github.com/openresty/headers-more-nginx-module.git d6d7ebab3c0c5b32ab421ba186783d3e5d2c6a17
 # geoip
@@ -130,9 +130,6 @@ git_secure_clone https://github.com/crowdsecurity/lua-cs-bouncer.git 3c235c813fc
 cd lua-cs-bouncer
 mkdir /usr/local/lib/lua/crowdsec
 cp lib/*.lua /usr/local/lib/lua/crowdsec
-cp template.conf /usr/local/lib/lua/crowdsec/crowdsec.conf
-sed -i 's/^API_URL=.*/API_URL=%CROWDSEC_HOST%/' /usr/local/lib/lua/crowdsec/crowdsec.conf
-sed -i 's/^API_KEY=.*/API_KEY=%CROWDSEC_KEY%/' /usr/local/lib/lua/crowdsec/crowdsec.conf
 sed -i 's/require "lrucache"/require "resty.lrucache"/' /usr/local/lib/lua/crowdsec/CrowdSec.lua
 sed -i 's/require "config"/require "crowdsec.config"/' /usr/local/lib/lua/crowdsec/CrowdSec.lua
 cd /tmp

confs/global/api-temp.conf

@@ -1,22 +1,23 @@
-
 location ~ ^%API_URI%/ping {
 	return 444;
 }
 
-location ~ ^%API_URI% {
+location ~ %API_URI% {
 
 rewrite_by_lua_block {
 	
-	local api = require "api"
-	local api_uri = "%API_URI%"
+	local api		= require "api"
+	local api_whitelist_ip  = { %API_WHITELIST_IP% }
+	local api_uri		= "%API_URI%"
+	local logger		= require "logger"
 
-	if api.is_api_call(api_uri) then
+	if api.is_api_call(api_uri, api_whitelist_ip) then
 		ngx.header.content_type = 'text/plain'
 		if api.do_api_call(api_uri) then
-			ngx.log(ngx.NOTICE, "[API] API call " .. ngx.var.request_uri .. " successfull from " .. ngx.var.remote_addr)
+			logger.log(ngx.NOTICE, "API", "API call " .. ngx.var.request_uri .. " successfull from " .. ngx.var.remote_addr)
 			ngx.say("ok")
 		else
-			ngx.log(ngx.WARN, "[API] API call " .. ngx.var.request_uri .. " failed from " .. ngx.var.remote_addr)
+			logger.log(ngx.WARN, "API", "API call " .. ngx.var.request_uri .. " failed from " .. ngx.var.remote_addr)
 			ngx.say("ko")
 		end
 

confs/global/api.conf

@@ -1,16 +1,19 @@
+# todo : if api_uri == "random"
 rewrite_by_lua_block {
 	
-	local api = require "api"
-	local api_uri = "%API_URI%"
+	local api		= require "api"
+	local api_whitelist_ip	= {% raw %}{{% endraw %}{% if API_WHITELIST_IP != ""%}{% set elements = API_WHITELIST_IP.split(" ") %}{% for i in range(0, elements|length) %}"{{ elements[i] }}"{% if i < elements|length-1 %},{% endif %}{% endfor %}{% endif %}{% raw %}}{% endraw %}
+	local api_uri		= "{{ API_URI }}"
+	local logger		= require "logger"
 
-	if api.is_api_call(api_uri) then
+	if api.is_api_call(api_uri, api_whitelist_ip) then
 		ngx.header.content_type = 'text/plain'
 		if api.do_api_call(api_uri) then
-			ngx.log(ngx.NOTICE, "[API] API call " .. ngx.var.request_uri .. " successfull from " .. ngx.var.remote_addr)
-			ngx.say("ok")
+			logger.log(ngx.NOTICE, "API", "API call " .. ngx.var.request_uri .. " successfull from " .. ngx.var.remote_addr)
+			ngx.print("ok")
 		else
-			ngx.log(ngx.WARN, "[API] API call " .. ngx.var.request_uri .. " failed from " .. ngx.var.remote_addr)
-			ngx.say("ko")
+			logger.log(ngx.WARN, "API", "API call " .. ngx.var.request_uri .. " failed from " .. ngx.var.remote_addr)
+			ngx.print("ko")
 		end
 
 		ngx.exit(ngx.HTTP_OK)

confs/global/cache.conf

@@ -1,4 +0,0 @@
-open_file_cache %CACHE%;
-open_file_cache_errors %CACHE_ERRORS%;
-open_file_cache_min_uses %CACHE_USES%;
-open_file_cache_valid %CACHE_VALID%;

confs/global/crowdsec.conf

@@ -1,9 +1,5 @@
-init_by_lua_block {
-	local cs = require "crowdsec.CrowdSec"
-	local ok, err = cs.init("/usr/local/lib/lua/crowdsec/crowdsec.conf")
-	if ok == nil then
-		ngx.log(ngx.ERR, "[Crowdsec] " .. err)
-		error()
-	end
-	ngx.log(ngx.NOTICE, "[Crowdsec] Initialisation done")
-}
+API_URL={{ CROWDSEC_HOST }}
+API_KEY={{ CROWDSEC_KEY }}
+LOG_FILE=/tmp/lua_mod.log
+CACHE_EXPIRATION=1
+CACHE_SIZE=1000

confs/global/fastcgi.conf

@@ -0,0 +1,25 @@
+fastcgi_param  SCRIPT_FILENAME    $document_root$fastcgi_script_name;
+fastcgi_param  QUERY_STRING       $query_string;
+fastcgi_param  REQUEST_METHOD     $request_method;
+fastcgi_param  CONTENT_TYPE       $content_type;
+fastcgi_param  CONTENT_LENGTH     $content_length;
+
+fastcgi_param  SCRIPT_NAME        $fastcgi_script_name;
+fastcgi_param  REQUEST_URI        $request_uri;
+fastcgi_param  DOCUMENT_URI       $document_uri;
+fastcgi_param  DOCUMENT_ROOT      $document_root;
+fastcgi_param  SERVER_PROTOCOL    $server_protocol;
+fastcgi_param  REQUEST_SCHEME     $scheme;
+fastcgi_param  HTTPS              $https if_not_empty;
+
+fastcgi_param  GATEWAY_INTERFACE  CGI/1.1;
+fastcgi_param  SERVER_SOFTWARE    nginx/$nginx_version;
+
+fastcgi_param  REMOTE_ADDR        $remote_addr;
+fastcgi_param  REMOTE_PORT        $remote_port;
+fastcgi_param  SERVER_ADDR        $server_addr;
+fastcgi_param  SERVER_PORT        $server_port;
+fastcgi_param  SERVER_NAME        $server_name;
+
+# PHP only, required if PHP was built with --enable-force-cgi-redirect
+fastcgi_param  REDIRECT_STATUS    200;

confs/global/geoip.conf

@@ -5,6 +5,15 @@ geoip2 /etc/nginx/geoip.mmdb {
 }
 
 map $geoip2_data_country_code $allowed_country {
-	default %DEFAULT%;
-	%COUNTRY%
+	default {% if WHITELIST_COUNTRY != "" %}no{% else %}yes{% endif %};
+	{% if WHITELIST_COUNTRY != "" %}
+		{% for country in WHITELIST_COUNTRY.split(" ") %}
+	{{ country }} yes;
+		{% endfor %}
+	{% endif %}
+	{% if BLACKLIST_COUNTRY != "" %}
+		{% for country in BLACKLIST_COUNTRY.split(" ") %}
+	{{ country }} no;
+		{% endfor %}
+	{% endif %}
 }

confs/global/init-lua.conf

@@ -1,12 +1,15 @@
 init_by_lua_block {
 
-local dataloader		= require "dataloader"
+local dataloader			= require "dataloader"
+local logger				= require "logger"
+local cjson					= require "cjson"
 
-local use_proxies		= %USE_PROXIES%
-local use_abusers		= %USE_ABUSERS%
-local use_tor_exit_nodes	= %USE_TOR_EXIT_NODES%
-local use_user_agents		= %USE_USER_AGENTS%
-local use_referrers		= %USE_REFERRERS%
+local use_proxies			= {% if has_value("BLOCK_PROXIES", "yes") %}true{% else %}false{% endif %}
+local use_abusers			= {% if has_value("BLOCK_ABUSERS", "yes") %}true{% else %}false{% endif %}
+local use_tor_exit_nodes	= {% if has_value("BLOCK_TOR_EXIT_NODE", "yes") %}true{% else %}false{% endif %}
+local use_user_agents		= {% if has_value("BLOCK_USER_AGENT", "yes") %}true{% else %}false{% endif %}
+local use_referrers			= {% if has_value("BLOCK_REFERRER", "yes") %}true{% else %}false{% endif %}
+local use_crowdsec			= {% if has_value("USE_CROWDSEC", "yes") %}true{% else %}false{% endif %}
 
 if use_proxies then
 	dataloader.load_ip("/etc/nginx/proxies.list", ngx.shared.proxies_data)
@@ -28,4 +31,42 @@ if use_referrers then
 	dataloader.load_raw("/etc/nginx/referrers.list", ngx.shared.referrers_data)
 end
 
+if use_crowdsec then
+	local cs = require "crowdsec.CrowdSec"
+	local ok, err = cs.init("/etc/nginx/crowdsec.conf")
+	if ok == nil then
+		logger.log(ngx.ERR, "CROWDSEC", err)
+		error()
+	end
+	logger.log(ngx.ERR, "CROWDSEC", "*NOT AN ERROR* initialisation done")
+end
+
+-- Load plugins
+ngx.shared.plugins_data:safe_set("plugins", nil, 0)
+local p = io.popen("find /plugins -maxdepth 1 -type d ! -path /plugins")
+for dir in p:lines() do
+	-- read JSON
+	local file = io.open(dir .. "/plugin.json")
+	if file then
+		-- store settings
+		local data = cjson.decode(file:read("*a"))
+		for k, v in pairs(data.settings) do
+			ngx.shared.plugins_data:safe_set(data.id .. "_" .. k, v, 0)
+		end
+		file:close()
+		-- store plugin
+		local plugins, flags = ngx.shared.plugins_data:get("plugins")
+		if plugins == nil then
+			ngx.shared.plugins_data:safe_set("plugins", data.id, 0)
+		else
+			ngx.shared.plugins_data:safe_set("plugins", plugins .. " " .. data.id, 0)
+		end
+		logger.log(ngx.ERR, "PLUGINS", "*NOT AN ERROR* plugin " .. data.name .. "/" .. data.version .. " has been loaded")
+	else
+		logger.log(ngx.ERR, "PLUGINS", "Can't load " .. dir .. "/plugin.json")
+	end
+
+end
+p:close()
+
 }

confs/global/mime.types

@@ -0,0 +1,96 @@
+types {
+    text/html                                        html htm shtml;
+    text/css                                         css;
+    text/xml                                         xml;
+    image/gif                                        gif;
+    image/jpeg                                       jpeg jpg;
+    application/javascript                           js;
+    application/atom+xml                             atom;
+    application/rss+xml                              rss;
+
+    text/mathml                                      mml;
+    text/plain                                       txt;
+    text/vnd.sun.j2me.app-descriptor                 jad;
+    text/vnd.wap.wml                                 wml;
+    text/x-component                                 htc;
+
+    image/png                                        png;
+    image/svg+xml                                    svg svgz;
+    image/tiff                                       tif tiff;
+    image/vnd.wap.wbmp                               wbmp;
+    image/webp                                       webp;
+    image/x-icon                                     ico;
+    image/x-jng                                      jng;
+    image/x-ms-bmp                                   bmp;
+
+    font/woff                                        woff;
+    font/woff2                                       woff2;
+
+    application/java-archive                         jar war ear;
+    application/json                                 json;
+    application/mac-binhex40                         hqx;
+    application/msword                               doc;
+    application/pdf                                  pdf;
+    application/postscript                           ps eps ai;
+    application/rtf                                  rtf;
+    application/vnd.apple.mpegurl                    m3u8;
+    application/vnd.google-earth.kml+xml             kml;
+    application/vnd.google-earth.kmz                 kmz;
+    application/vnd.ms-excel                         xls;
+    application/vnd.ms-fontobject                    eot;
+    application/vnd.ms-powerpoint                    ppt;
+    application/vnd.oasis.opendocument.graphics      odg;
+    application/vnd.oasis.opendocument.presentation  odp;
+    application/vnd.oasis.opendocument.spreadsheet   ods;
+    application/vnd.oasis.opendocument.text          odt;
+    application/vnd.openxmlformats-officedocument.presentationml.presentation
+                                                     pptx;
+    application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
+                                                     xlsx;
+    application/vnd.openxmlformats-officedocument.wordprocessingml.document
+                                                     docx;
+    application/vnd.wap.wmlc                         wmlc;
+    application/x-7z-compressed                      7z;
+    application/x-cocoa                              cco;
+    application/x-java-archive-diff                  jardiff;
+    application/x-java-jnlp-file                     jnlp;
+    application/x-makeself                           run;
+    application/x-perl                               pl pm;
+    application/x-pilot                              prc pdb;
+    application/x-rar-compressed                     rar;
+    application/x-redhat-package-manager             rpm;
+    application/x-sea                                sea;
+    application/x-shockwave-flash                    swf;
+    application/x-stuffit                            sit;
+    application/x-tcl                                tcl tk;
+    application/x-x509-ca-cert                       der pem crt;
+    application/x-xpinstall                          xpi;
+    application/xhtml+xml                            xhtml;
+    application/xspf+xml                             xspf;
+    application/zip                                  zip;
+
+    application/octet-stream                         bin exe dll;
+    application/octet-stream                         deb;
+    application/octet-stream                         dmg;
+    application/octet-stream                         iso img;
+    application/octet-stream                         msi msp msm;
+
+    audio/midi                                       mid midi kar;
+    audio/mpeg                                       mp3;
+    audio/ogg                                        ogg;
+    audio/x-m4a                                      m4a;
+    audio/x-realaudio                                ra;
+
+    video/3gpp                                       3gpp 3gp;
+    video/mp2t                                       ts;
+    video/mp4                                        mp4;
+    video/mpeg                                       mpeg mpg;
+    video/quicktime                                  mov;
+    video/webm                                       webm;
+    video/x-flv                                      flv;
+    video/x-m4v                                      m4v;
+    video/x-mng                                      mng;
+    video/x-ms-asf                                   asx asf;
+    video/x-ms-wmv                                   wmv;
+    video/x-msvideo                                  avi;
+}

confs/global/multisite-default-server-https.conf

@@ -1,11 +1,13 @@
-listen 0.0.0.0:%HTTPS_PORT% default_server ssl %HTTP2%;
+listen 0.0.0.0:{{ HTTPS_PORT }} default_server ssl {% if USE_HTTP2 == "yes" %}http2{% endif %};
 ssl_certificate /etc/nginx/default-cert.pem;
 ssl_certificate_key /etc/nginx/default-key.pem;
-ssl_protocols %HTTPS_PROTOCOLS%;
+ssl_protocols {{ HTTPS_PROTOCOLS }};
 ssl_prefer_server_ciphers off;
 ssl_session_tickets off;
 ssl_session_timeout 1d;
 ssl_session_cache shared:MozSSL:10m;
-%SSL_DHPARAM%
-%SSL_CIPHERS%
-%LETS_ENCRYPT_WEBROOT%
+{% if "TLSv1.2" in HTTPS_PROTOCOLS %}
+ssl_dhparam /etc/nginx/dhparam;
+ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384;
+{% endif %}
+include /etc/nginx/multisite-default-server-lets-encrypt-webroot.conf;

confs/global/multisite-default-server.conf

@@ -1,6 +1,11 @@
 server {
-	%LISTEN_HTTP%
+	{% if LISTEN_HTTP == "yes" %}listen 0.0.0.0:{{ HTTP_PORT }} default_server{% endif %};
 	server_name _;
-	%USE_HTTPS%
-	%MULTISITE_DISABLE_DEFAULT_SERVER%
+	{% if has_value("AUTO_LETS_ENCRYPT", "yes") %}include /etc/nginx/multisite-default-server-https.conf;{% endif %}
+	{% if USE_API == "yes" %}
+	location ^~ {{ API_URI }} {
+		include /etc/nginx/api.conf;
+	}
+	{% endif %}
+	{% if DISABLE_DEFAULT_SERVER == "yes" %}include /etc/nginx/multisite-disable-default-server.conf;{% endif %}
 }

confs/global/nginx.conf

@@ -26,11 +26,11 @@ pcre_jit on;
 include /etc/nginx/modules/*.conf;
 
 # max open files for each worker
-worker_rlimit_nofile %WORKER_RLIMIT_NOFILE%;
+worker_rlimit_nofile {{ WORKER_RLIMIT_NOFILE }};
 
 events {
 	# max connections per worker
-	worker_connections %WORKER_CONNECTIONS%;
+	worker_connections {{ WORKER_CONNECTIONS }};
 
 	# epoll seems to be the best on Linux
 	use epoll;
@@ -51,9 +51,9 @@ http {
 	default_type application/octet-stream;
 
 	# write logs to local syslog
-	log_format logf '%LOG_FORMAT%';
+	log_format logf '{{ LOG_FORMAT }}';
 	access_log /var/log/access.log logf;
-	error_log /var/log/error.log info;
+	error_log /var/log/error.log {{ LOG_LEVEL }};
 
 	# temp paths
 	proxy_temp_path /tmp/proxy_temp;
@@ -72,39 +72,40 @@ http {
 	send_timeout 10;
 
 	# resolvers to use
-	resolver %DNS_RESOLVERS% ipv6=off;
+	resolver {{ DNS_RESOLVERS }} ipv6=off;
 
 	# remove ports when sending redirects
 	port_in_redirect off;
 
 	# lua path and dicts
-	lua_package_path "/usr/local/lib/lua/?.lua;;";
-	%WHITELIST_IP_CACHE%
-	%WHITELIST_REVERSE_CACHE%
-	%BLACKLIST_IP_CACHE%
-	%BLACKLIST_REVERSE_CACHE%
-	%DNSBL_CACHE%
-	%BLOCK_PROXIES%
-	%BLOCK_ABUSERS%
-	%BLOCK_TOR_EXIT_NODES%
-	%BLOCK_USER_AGENTS%
-	%BLOCK_REFERRERS%
-	%BAD_BEHAVIOR%
+	lua_package_path "/usr/local/lib/lua/?.lua;/plugins/?.lua;;";
+	{% if has_value("USE_WHITELIST_IP", "yes") %}lua_shared_dict whitelist_ip_cache 10m;{% endif %}
+	{% if has_value("USE_WHITELIST_REVERSE", "yes") %}lua_shared_dict whitelist_reverse_cache 10m;{% endif %}
+	{% if has_value("USE_BLACKLIST_IP", "yes") %}lua_shared_dict blacklist_ip_cache 10m;{% endif %}
+	{% if has_value("USE_BLACKLIST_REVERSE", "yes") %}lua_shared_dict blacklist_reverse_cache 10m;{% endif %}
+	{% if has_value("USE_DNSBL", "yes") %}lua_shared_dict dnsbl_cache 10m;{% endif %}
+	{% if has_value("BLOCK_PROXIES", "yes") %}lua_shared_dict proxies_data 250m;{% endif %}
+	{% if has_value("BLOCK_ABUSERS", "yes") %}lua_shared_dict abusers_data 50m;{% endif %}
+	{% if has_value("BLOCK_TOR_EXIT_NODE", "yes") %}lua_shared_dict tor_exit_nodes_data 1m;{% endif %}
+	{% if has_value("BLOCK_USER_AGENT", "yes") %}lua_shared_dict user_agents_data 1m;{% endif %}
+	{% if has_value("BLOCK_USER_AGENT", "yes") %}lua_shared_dict user_agents_cache 10m;{% endif %}
+	{% if has_value("BLOCK_REFERRER", "yes") %}lua_shared_dict referrers_data 1m;{% endif %}
+	{% if has_value("BLOCK_REFERRER", "yes") %}lua_shared_dict referrers_cache 10m;{% endif %}
+	{% if has_value("USE_BAD_BEHAVIOR", "yes") %}lua_shared_dict behavior_ban 10m;{% endif %}
+	{% if has_value("USE_BAD_BEHAVIOR", "yes") %}lua_shared_dict behavior_count 10m;{% endif %}
+	lua_shared_dict plugins_data 10m;
 
-	# crowdsec init
-	%USE_CROWDSEC%
-	
 	# shared memory zone for limit_req
-	%LIMIT_REQ_ZONE%
+	{% if has_value("USE_LIMIT_REQ", "yes") %}limit_req_zone $binary_remote_addr$uri zone=limit:{{ LIMIT_REQ_CACHE }} rate={{ LIMIT_REQ_RATE }};{% endif %}
 
 	# shared memory zone for limit_conn
-	%LIMIT_CONN_ZONE%
+	{% if has_value("USE_LIMIT_CONN", "yes") %}limit_conn_zone $binary_remote_addr zone=ddos:{{ LIMIT_CONN_CACHE }};{% endif %}
 
 	# whitelist or blacklist country
-	%USE_COUNTRY%
+	{% if BLACKLIST_COUNTRY != "" or WHITELIST_COUNTRY != "" %}include /etc/nginx/geoip.conf;{% endif %}
 
 	# zone for proxy_cache
-	%PROXY_CACHE_PATH%
+	{% if has_value("USE_PROXY_CACHE", "yes") %}proxy_cache_path /tmp/proxy_cache keys_zone=proxycache:{{ PROXY_CACHE_PATH_ZONE_SIZE }} {{ PROXY_CACHE_PATH_PARAMS }};{% endif %}
 
 	# custom http confs
 	include /http-confs/*.conf;
@@ -113,11 +114,36 @@ http {
 	include /etc/nginx/init-lua.conf;
 
 	# default server when MULTISITE=yes
-	%MULTISITE_DEFAULT_SERVER%
+	{% if MULTISITE == "yes" %}include /etc/nginx/multisite-default-server.conf;{% endif %}
 
 	# server config(s)
-	%INCLUDE_SERVER%
+	{% if MULTISITE == "yes" and SERVER_NAME != "" %}
+		{% set map_servers = {} %}
+		{% for server_name in SERVER_NAME.split(" ") %}
+			{% if server_name + "_SERVER_NAME" in all %}
+				{% set x = map_servers.update({server_name : all[server_name + "_SERVER_NAME"].split(" ")}) %}
+			{% endif %}
+		{% endfor %}
+		{% for server_name in SERVER_NAME.split(" ") %}
+			{% if not server_name in map_servers %}
+				{% set found = {"res": false} %}
+				{% for first_server, servers in map_servers.items() %}
+					{% if server_name in servers %}
+						{% set x = found.update({"res" : true}) %}
+					{% endif %}
+				{% endfor %}
+				{% if not found["res"] %}
+					{% set x = map_servers.update({server_name : [server_name]}) %}
+				{% endif %} 
+			{% endif %}
+		{% endfor %}
+		{% for first_server in map_servers %}
+	include /etc/nginx/{{ first_server }}/server.conf;
+		{% endfor %}
+	{% elif MULTISITE == "no" %}
+	include /etc/nginx/server.conf;
+	{% endif %}
 
 	# API
-	%USE_API%
+	{% if USE_API == "yes" %}include /etc/nginx/api.conf;{% endif %}
 }

confs/site/antibot-captcha.conf

@@ -1,4 +1,4 @@
-location = %ANTIBOT_URI% {
+location = {{ ANTIBOT_URI }} {
 
 	default_type 'text/html';
 	
@@ -6,13 +6,14 @@ location = %ANTIBOT_URI% {
 		content_by_lua_block {
 			local cookie	= require "cookie"
 			local captcha	= require "captcha"
+			local logger	= require "logger"
 			if not cookie.is_set("uri") then
-				ngx.log(ngx.NOTICE, "[ANTIBOT] captcha fail (1) for " .. ngx.var.remote_addr)
+				logger.log(ngx.WARN, "ANTIBOT", "captcha fail (1) for " .. ngx.var.remote_addr)
 				return ngx.exit(ngx.HTTP_FORBIDDEN)
 			end
 			local img, res = captcha.get_challenge()
 			cookie.set({captchares = res})
-			local code = captcha.get_code(img, "%ANTIBOT_URI%")
+			local code = captcha.get_code(img, "{{ ANTIBOT_URI }}")
 			ngx.say(code)
 		}
 	}
@@ -21,21 +22,22 @@ location = %ANTIBOT_URI% {
 		access_by_lua_block {
 			local cookie	= require "cookie"
 			local captcha	= require "captcha"
+			local logger	= require "logger"
 			if not cookie.is_set("captchares") then
-				ngx.log(ngx.NOTICE, "[ANTIBOT] captcha fail (2) for " .. ngx.var.remote_addr)
+				logger.log(ngx.WARN, "ANTIBOT", "captcha fail (2) for " .. ngx.var.remote_addr)
 				return ngx.exit(ngx.HTTP_FORBIDDEN)
 			end
 			ngx.req.read_body()
 			local args, err = ngx.req.get_post_args(1)
 			if err == "truncated" or not args or not args["captcha"] then
-				ngx.log(ngx.NOTICE, "[ANTIBOT] captcha fail (3) for " .. ngx.var.remote_addr)
+				logger.log(ngx.WARN, "ANTIBOT", "captcha fail (3) for " .. ngx.var.remote_addr)
 				return ngx.exit(ngx.HTTP_FORBIDDEN)
 			end
 			local captcha_user	= args["captcha"]
 			local check		= captcha.check(captcha_user, cookie.get("captchares"))
 			if not check then
-				ngx.log(ngx.NOTICE, "[ANTIBOT] captcha fail (4) for " .. ngx.var.remote_addr)
-				return ngx.redirect("%ANTIBOT_URI%")
+				logger.log(ngx.WARN, "ANTIBOT", "captcha fail (4) for " .. ngx.var.remote_addr)
+				return ngx.redirect("{{ ANTIBOT_URI }}")
 			end
 			cookie.set({captcha = "ok"})
 			return ngx.redirect(cookie.get("uri"))

confs/site/antibot-javascript.conf

@@ -1,4 +1,4 @@
-location = %ANTIBOT_URI% {
+location = {{ ANTIBOT_URI }} {
 
 	default_type 'text/html';
 	
@@ -6,12 +6,13 @@ location = %ANTIBOT_URI% {
 		content_by_lua_block {
 			local cookie		= require "cookie"
 			local javascript	= require "javascript"
+			local logger		= require "logger"
 			if not cookie.is_set("challenge") then
-				ngx.log(ngx.WARN, "[ANTIBOT] javascript fail (1) for " .. ngx.var.remote_addr)
+				logger.log(ngx.WARN, "ANTIBOT", "javascript fail (1) for " .. ngx.var.remote_addr)
 				return ngx.exit(ngx.HTTP_FORBIDDEN)
 			end
 			local challenge	= cookie.get("challenge")
-			local code	= javascript.get_code(challenge, "%ANTIBOT_URI%", cookie.get("uri"))
+			local code	= javascript.get_code(challenge, "{{ ANTIBOT_URI }}", cookie.get("uri"))
 			ngx.say(code)
 		}
 	}
@@ -20,20 +21,21 @@ location = %ANTIBOT_URI% {
 		content_by_lua_block {
 			local cookie		= require "cookie"
 			local javascript	= require "javascript"
+			local logger		= require "logger"
 			if not cookie.is_set("challenge") then
-				ngx.log(ngx.WARN, "[ANTIBOT] javascript fail (2) for " .. ngx.var.remote_addr)
+				logger.log(ngx.WARN, "ANTIBOT", "javascript fail (2) for " .. ngx.var.remote_addr)
 				return ngx.exit(ngx.HTTP_FORBIDDEN)
 			end
 			ngx.req.read_body()
 			local args, err = ngx.req.get_post_args(1)
 			if err == "truncated" or not args or not args["challenge"] then
-				ngx.log(ngx.WARN, "[ANTIBOT] javascript fail (3) for " .. ngx.var.remote_addr)
+				logger.log(ngx.WARN, "ANTIBOT", "javascript fail (3) for " .. ngx.var.remote_addr)
 				return ngx.exit(ngx.HTTP_FORBIDDEN)
 			end
 			local challenge		= args["challenge"]
 			local check		= javascript.check(cookie.get("challenge"), challenge)
 			if not check then
-				ngx.log(ngx.WARN, "[ANTIBOT] javascript fail (4) for " .. ngx.var.remote_addr)
+				logger.log(ngx.WARN, "ANTIBOT", "javascript fail (4) for " .. ngx.var.remote_addr)
 				return ngx.exit(ngx.HTTP_FORBIDDEN)
 			end
 			cookie.set({javascript = "ok"})

confs/site/antibot-recaptcha.conf

@@ -1,4 +1,4 @@
-location = %ANTIBOT_URI% {
+location = {{ ANTIBOT_URI }} {
 
 	default_type 'text/html';
 	
@@ -6,11 +6,12 @@ location = %ANTIBOT_URI% {
 		content_by_lua_block {
 			local cookie	= require "cookie"
 			local recaptcha	= require "recaptcha"
+			local loggger	= require "logger"
 			if not cookie.is_set("uri") then
-				ngx.log(ngx.NOTICE, "[ANTIBOT] recaptcha fail (1) for " .. ngx.var.remote_addr)
+				logger.log(ngx.WARN, "ANTIBOT", "recaptcha fail (1) for " .. ngx.var.remote_addr)
 				return ngx.exit(ngx.HTTP_FORBIDDEN)
 			end
-			local code = recaptcha.get_code("%ANTIBOT_URI%", "%ANTIBOT_RECAPTCHA_SITEKEY%")
+			local code = recaptcha.get_code("{{ ANTIBOT_URI }}", "{{ ANTIBOT_RECAPTCHA_SITEKEY }}")
 			ngx.say(code)
 		}
 	}
@@ -19,20 +20,21 @@ location = %ANTIBOT_URI% {
 		access_by_lua_block {
 			local cookie	= require "cookie"
 			local recaptcha	= require "recaptcha"
+			local logger	= require "logger"
 			if not cookie.is_set("uri") then
-				ngx.log(ngx.NOTICE, "[ANTIBOT] recaptcha fail (2) for " .. ngx.var.remote_addr)
+				logger.log(ngx.WARN, "ANTIBOT", "recaptcha fail (2) for " .. ngx.var.remote_addr)
 				return ngx.exit(ngx.HTTP_FORBIDDEN)
 			end
 			ngx.req.read_body()
 			local args, err = ngx.req.get_post_args(1)
 			if err == "truncated" or not args or not args["token"] then
-				ngx.log(ngx.NOTICE, "[ANTIBOT] recaptcha fail (3) for " .. ngx.var.remote_addr)
+				logger.log(ngx.WARN, "ANTIBOT", "recaptcha fail (3) for " .. ngx.var.remote_addr)
 				return ngx.exit(ngx.HTTP_FORBIDDEN)
 			end
 			local token	= args["token"]
-			local check	= recaptcha.check(token, "%ANTIBOT_RECAPTCHA_SECRET%")
-			if check < %ANTIBOT_RECAPTCHA_SCORE% then
-				ngx.log(ngx.NOTICE, "[ANTIBOT] recaptcha fail (4) for " .. ngx.var.remote_addr .. " (score = " .. tostring(check) .. ")")
+			local check	= recaptcha.check(token, "{{ ANTIBOT_RECAPTCHA_SECRET }}")
+			if check < {{ ANTIBOT_RECAPTCHA_SCORE }} then
+				logger.log(ngx.WARN, "ANTIBOT", "recaptcha fail (4) for " .. ngx.var.remote_addr .. " (score = " .. tostring(check) .. ")")
 				return ngx.exit(ngx.HTTP_FORBIDDEN)
 			end
 			cookie.set({recaptcha = "ok"})

confs/site/auth-basic-sitewide.conf

@@ -1,2 +1,2 @@
-auth_basic "%AUTH_BASIC_TEXT%";
-auth_basic_user_file %NGINX_PREFIX%.htpasswd;
+auth_basic "{{ AUTH_BASIC_TEXT }}";
+auth_basic_user_file {{ NGINX_PREFIX }}htpasswd;

confs/site/auth-basic.conf

@@ -1,4 +1,4 @@
-location %AUTH_BASIC_LOCATION% {
-	auth_basic "%AUTH_BASIC_TEXT%";
-	auth_basic_user_file %NGINX_PREFIX%.htpasswd; 
+location {{ AUTH_BASIC_LOCATION }} {
+	auth_basic "{{ AUTH_BASIC_TEXT }}";
+	auth_basic_user_file {{ NGINX_PREFIX }}htpasswd; 
 }

confs/site/brotli.conf

@@ -1,4 +1,4 @@
 brotli on;
-brotli_types %BROTLI_TYPES%;
-brotli_comp_level %BROTLI_COMP_LEVEL%;
-brotli_min_length %BROTLI_MIN_LENGTH%;
+brotli_types {{ BROTLI_TYPES }};
+brotli_comp_level {{ BROTLI_COMP_LEVEL }};
+brotli_min_length {{ BROTLI_MIN_LENGTH }};

confs/site/client-cache.conf

@@ -1,6 +1,6 @@
-etag %CLIENT_CACHE_ETAG%;
+etag {{ CLIENT_CACHE_ETAG }};
 set $cache "";
-if ($uri ~* \.(%CLIENT_CACHE_EXTENSIONS%)$) {
-	set $cache "%CLIENT_CACHE_CONTROL%";
+if ($uri ~* \.({{ CLIENT_CACHE_EXTENSIONS }})$) {
+	set $cache "{{ CLIENT_CACHE_CONTROL }}";
 }
 add_header Cache-Control $cache;

confs/site/content-security-policy.conf

@@ -1 +1 @@
-more_set_headers "Content-Security-Policy: %CONTENT_SECURITY_POLICY%";
+more_set_headers "Content-Security-Policy: {{ CONTENT_SECURITY_POLICY }}";

confs/site/cookie-flags.conf

@@ -1 +1 @@
-set_cookie_flag %COOKIE_FLAGS%;
+set_cookie_flag {{ COOKIE_FLAGS }}{% if COOKIE_AUTO_SECURE_FLAG == "yes" %} Secure{% endif %};

confs/site/custom-https.conf

@@ -1,7 +1,9 @@
-listen 0.0.0.0:443 ssl %HTTP2%;
-ssl_certificate %HTTPS_CUSTOM_CERT%;
-ssl_certificate_key %HTTPS_CUSTOM_KEY%;
+listen 0.0.0.0:443 ssl {% if HTTP2 == "yes" %}http2{% endif %};
+ssl_certificate {{ HTTPS_CUSTOM_CERT }};
+ssl_certificate_key {{ HTTPS_CUSTOM_KEY }};
 ssl_protocols TLSv1.3;
 ssl_prefer_server_ciphers off;
 ssl_session_tickets off;
-%STRICT_TRANSPORT_SECURITY%
+{% if STRICT_TRANSPORT_SECURITY != "" %}
+more_set_headers 'Strict-Transport-Security: {{ STRICT_TRANSPORT_SECURITY }}';
+{% endif %}

confs/site/disable-default-server.conf

@@ -1,3 +1,3 @@
-if ($host !~ ^(%SERVER_NAME%)$) {
+if ($host !~ ^({{ SERVER_NAME.replace(" ", "|") }})$) {
 	return 444;
 }

confs/site/error.conf

@@ -1,7 +1,26 @@
-error_page %CODE% %PAGE%;
+{% if ERRORS != "" %}
+	{% for element in ERRORS.split(" ") %}
+		{% set code = element.split("=")[0] %}
+		{% set page = element.split("=")[1] %}
+error_page {{ code }} {{ page }};
 
-location = %PAGE% {
-    root %ROOT_FOLDER%;
+location = {{ page }} {
+    root {{ ROOT_FOLDER }};
     modsecurity off;
     internal;
 }
+	{% endfor %}
+{% endif %}
+
+{% set default_errors = ["400", "401", "403", "404", "429", "500", "501", "502", "503", "504"] %}
+{% for default_error in default_errors %}
+	{% if not default_error + "=" in ERRORS %}
+error_page {{ default_error }} /errors/{{ default_error }}.html;
+
+location = /errors/{{ default_error }}.html {
+    root /defaults;
+    modsecurity off;
+    internal;
+}
+	{% endif %}
+{% endfor %}

confs/site/fastcgi.conf

@@ -1,4 +1,4 @@
-fastcgi_param  SCRIPT_FILENAME    $document_root$fastcgi_script_name;
+fastcgi_param  SCRIPT_FILENAME    {{ REMOTE_PHP_PATH }}/$fastcgi_script_name;
 fastcgi_param  QUERY_STRING       $query_string;
 fastcgi_param  REQUEST_METHOD     $request_method;
 fastcgi_param  CONTENT_TYPE       $content_type;
@@ -13,7 +13,7 @@ fastcgi_param  REQUEST_SCHEME     $scheme;
 fastcgi_param  HTTPS              $https if_not_empty;
 
 fastcgi_param  GATEWAY_INTERFACE  CGI/1.1;
-fastcgi_param  SERVER_SOFTWARE    nginx/$nginx_version;
+fastcgi_param  SERVER_SOFTWARE    nginx;
 
 fastcgi_param  REMOTE_ADDR        $remote_addr;
 fastcgi_param  REMOTE_PORT        $remote_port;

confs/site/feature-policy.conf

@@ -1 +1 @@
-more_set_headers "Feature-Policy: %FEATURE_POLICY%";
+more_set_headers "Feature-Policy: {{ FEATURE_POLICY }}";

confs/site/gzip.conf

@@ -1,4 +1,4 @@
 gzip on;
-gzip_comp_level %GZIP_COMP_LEVEL%;
-gzip_min_length %GZIP_MIN_LENGTH%;
-gzip_types %GZIP_TYPES%;
+gzip_comp_level {{ GZIP_COMP_LEVEL }};
+gzip_min_length {{ GZIP_MIN_LENGTH }};
+gzip_types {{ GZIP_TYPES }};

confs/site/htpasswd

@@ -0,0 +1,3 @@
+{% if USE_AUTH_BASIC == "yes" %}
+{{ AUTH_BASIC_USER }}:{{ sha512_crypt(AUTH_BASIC_PASSWORD) }}
+{% endif %}

confs/site/https.conf

@@ -1,12 +1,34 @@
-listen 0.0.0.0:%HTTPS_PORT% ssl %HTTP2%;
-ssl_certificate %HTTPS_CERT%;
-ssl_certificate_key %HTTPS_KEY%;
-ssl_protocols %HTTPS_PROTOCOLS%;
+listen 0.0.0.0:{{ HTTPS_PORT }} ssl {% if HTTP2 == "yes" %}http2{% endif %};
+{% set paths = {"cert": "", "key": ""} %}
+{% if AUTO_LETS_ENCRYPT == "yes" %}
+	{% set x = paths.update({"cert": "/etc/letsencrypt/live/" + FIRST_SERVER + "/fullchain.pem"}) %}
+	{% set x = paths.update({"key": "/etc/letsencrypt/live/" + FIRST_SERVER + "/privkey.pem"}) %}
+{% elif USE_CUSTOM_HTTPS == "yes" %}
+	{% set x = paths.update({"cert": CUSTOM_HTTPS_CERT}) %}
+	{% set x = paths.update({"key": CUSTOM_HTTPS_KEY}) %}
+{% elif GENERATE_SELF_SIGNED_SSL == "yes" %}
+	{% if MULTISITE == "yes" %}
+		{% set x = paths.update({"cert": "/etc/nginx/" + FIRST_SERVER + "/self-cert.pem"}) %}
+		{% set x = paths.update({"key": "/etc/nginx/" + FIRST_SERVER + "/self-key.pem"}) %}
+	{% else %}
+		{% set x = paths.update({"cert": "/etc/nginx/self-cert.pem"}) %}
+		{% set x = paths.update({"key": "/etc/nginx/self-key.pem"}) %}
+	{% endif %}
+{% endif %}
+ssl_certificate {{ paths["cert"] }};
+ssl_certificate_key {{ paths["key"] }};
+ssl_protocols {{ HTTPS_PROTOCOLS }};
 ssl_prefer_server_ciphers on;
 ssl_session_tickets off;
 ssl_session_timeout 1d;
 ssl_session_cache shared:MozSSL:10m;
-%STRICT_TRANSPORT_SECURITY%
-%SSL_DHPARAM%
-%SSL_CIPHERS%
-%LETS_ENCRYPT_WEBROOT%
+{% if STRICT_TRANSPORT_SECURITY != "" %}
+more_set_headers 'Strict-Transport-Security: {{ STRICT_TRANSPORT_SECURITY }}';
+{% endif %}
+{% if "TLSv1.2" in HTTPS_PROTOCOLS %}
+ssl_dhparam /etc/nginx/dhparam;
+ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384;
+{% endif %}
+{% if AUTO_LETS_ENCRYPT %}
+include {{ NGINX_PREFIX }}lets-encrypt-webroot.conf;
+{% endif %}

confs/site/limit-conn.conf

@@ -1 +1 @@
-limit_conn ddos %LIMIT_CONN_MAX%;
+limit_conn ddos {{ LIMIT_CONN_MAX }};

confs/site/limit-req.conf

@@ -1,3 +1,3 @@
 limit_req_status 429;
-limit_req zone=limit burst=%LIMIT_REQ_BURST% nodelay;
+limit_req zone=limit burst={{ LIMIT_REQ_BURST }} nodelay;
 

confs/site/log-lua.conf

@@ -1,11 +1,15 @@
 log_by_lua_block {
 
-local use_bad_behavior	= %USE_BAD_BEHAVIOR%
-
-local behavior		= require "behavior"
+-- bad behavior
+local use_bad_behavior		= {% if USE_BAD_BEHAVIOR == "yes" %}true{% else %}false{% endif %}
+local behavior			= require "behavior"
+local bad_behavior_status_codes = {% raw %}{{% endraw %}{% if BAD_BEHAVIOR_STATUS_CODES != "" %}{% set elements = BAD_BEHAVIOR_STATUS_CODES.split(" ") %}{% for i in range(0, elements|length) %}"{{ elements[i] }}"{% if i < elements|length-1 %},{% endif %}{% endfor %}{% endif %}{% raw %}}{% endraw %}
+local bad_behavior_threshold    = {{ BAD_BEHAVIOR_THRESHOLD }}
+local bad_behavior_count_time   = {{ BAD_BEHAVIOR_COUNT_TIME }}
+local bad_behavior_ban_time     = {{ BAD_BEHAVIOR_BAN_TIME }}
 
 if use_bad_behavior then
-	behavior.count()	
+	behavior.count(bad_behavior_status_codes, bad_behavior_threshold, bad_behavior_count_time, bad_behavior_ban_time)
 end
 
 }

confs/site/main-lua.conf

@@ -1,42 +1,77 @@
-set $session_secret %ANTIBOT_SESSION_SECRET%;
+{% if ANTIBOT_SESSION_SECRET == "random" %}
+set $session_secret {{ random(32) }} ;
+{% else %}
+set $session_secret {{ ANTIBOT_SESSION_SECRET }};
+{% endif %}
 set $session_check_addr on;
 
 access_by_lua_block {
 
-local use_lets_encrypt		= %USE_LETS_ENCRYPT%
-local use_whitelist_ip		= %USE_WHITELIST_IP%
-local use_whitelist_reverse	= %USE_WHITELIST_REVERSE%
-local use_user_agents		= %USE_USER_AGENTS%
-local use_proxies		= %USE_PROXIES%
-local use_abusers		= %USE_ABUSERS%
-local use_tor_exit_nodes	= %USE_TOR_EXIT_NODES%
-local use_referrers		= %USE_REFERRERS%
-local use_country		= %USE_COUNTRY%
-local use_blacklist_ip		= %USE_BLACKLIST_IP%
-local use_blacklist_reverse	= %USE_BLACKLIST_REVERSE%
-local use_dnsbl			= %USE_DNSBL%
-local use_crowdsec		= %USE_CROWDSEC%
-local use_antibot_cookie	= %USE_ANTIBOT_COOKIE%
-local use_antibot_javascript	= %USE_ANTIBOT_JAVASCRIPT%
-local use_antibot_captcha	= %USE_ANTIBOT_CAPTCHA%
-local use_antibot_recaptcha	= %USE_ANTIBOT_RECAPTCHA%
-local use_bad_behavior		= %USE_BAD_BEHAVIOR%
+-- disable checks for internal requests
+if ngx.req.is_internal() then
+	return
+end
+
+-- let's encrypt
+local use_lets_encrypt		= {% if AUTO_LETS_ENCRYPT == "yes" %}true{% else %}false{% endif %}
+
+-- external blacklists
+local use_user_agents		= {% if BLOCK_USER_AGENT == "yes" %}true{% else %}false{% endif %}
+local use_proxies		= {% if BLOCK_PROXIES == "yes" %}true{% else %}false{% endif %}
+local use_abusers		= {% if BLOCK_ABUSERS == "yes" %}true{% else %}false{% endif %}
+local use_tor_exit_nodes	= {% if BLOCK_TOR_EXIT_NODE == "yes" %}true{% else %}false{% endif %}
+local use_referrers		= {% if BLOCK_REFERRER == "yes" %}true{% else %}false{% endif %}
+
+-- countries
+local use_country		= {% if WHITELIST_COUNTRY != "" or BLACKLIST_COUNTRY != "" %}true{% else %}false{% endif %}
+
+-- crowdsec
+local use_crowdsec		= {% if USE_CROWDSEC == "yes" %}true{% else %}false{% endif %}
+
+-- antibot
+local use_antibot_cookie	= {% if USE_ANTIBOT == "cookie" %}true{% else %}false{% endif %}
+local use_antibot_javascript	= {% if USE_ANTIBOT == "javascript" %}true{% else %}false{% endif %}
+local use_antibot_captcha	= {% if USE_ANTIBOT == "captcha" %}true{% else %}false{% endif %}
+local use_antibot_recaptcha	= {% if USE_ANTIBOT == "recaptcha" %}true{% else %}false{% endif %}
+
+-- resolvers
+local dns_resolvers		= {% raw %}{{% endraw %}{% if DNS_RESOLVERS != "" %}{% set elements = DNS_RESOLVERS.split(" ") %}{% for i in range(0, elements|length) %}"{{ elements[i] }}"{% if i < elements|length-1 %},{% endif %}{% endfor %}{% endif %}{% raw %}}{% endraw %}
+
+-- whitelist
+local use_whitelist_ip		= {% if USE_WHITELIST_IP == "yes" %}true{% else %}false{% endif %}
+local use_whitelist_reverse	= {% if USE_WHITELIST_REVERSE == "yes" %}true{% else %}false{% endif %}
+local whitelist_ip_list		= {% raw %}{{% endraw %}{% if WHITELIST_IP_LIST != "" %}{% set elements = WHITELIST_IP_LIST.split(" ") %}{% for i in range(0, elements|length) %}"{{ elements[i] }}"{% if i < elements|length-1 %},{% endif %}{% endfor %}{% endif %}{% raw %}}{% endraw %}
+local whitelist_reverse_list	= {% raw %}{{% endraw %}{% if WHITELIST_REVERSE_LIST != "" %}{% set elements = WHITELIST_REVERSE_LIST.split(" ") %}{% for i in range(0, elements|length) %}"{{ elements[i] }}"{% if i < elements|length-1 %},{% endif %}{% endfor %}{% endif %}{% raw %}}{% endraw %}
+
+-- blacklist
+local use_blacklist_ip		= {% if USE_BLACKLIST_IP == "yes" %}true{% else %}false{% endif %}
+local use_blacklist_reverse	= {% if USE_BLACKLIST_REVERSE == "yes" %}true{% else %}false{% endif %}
+local blacklist_ip_list		= {% raw %}{{% endraw %}{% if BLACKLIST_IP_LIST != "" %}{% set elements = BLACKLIST_IP_LIST.split(" ") %}{% for i in range(0, elements|length) %}"{{ elements[i] }}"{% if i < elements|length-1 %},{% endif %}{% endfor %}{% endif %}{% raw %}}{% endraw %}
+local blacklist_reverse_list	= {% raw %}{{% endraw %}{% if BLACKLIST_REVERSE_LIST != "" %}{% set elements = BLACKLIST_REVERSE_LIST.split(" ") %}{% for i in range(0, elements|length) %}"{{ elements[i] }}"{% if i < elements|length-1 %},{% endif %}{% endfor %}{% endif %}{% raw %}}{% endraw %}
+
+-- dnsbl
+local use_dnsbl			= {% if USE_DNSBL == "yes" %}true{% else %}false{% endif %}
+local dnsbl_list		= {% raw %}{{% endraw %}{% if DNSBL_LIST != "" %}{% set elements = DNSBL_LIST.split(" ") %}{% for i in range(0, elements|length) %}"{{ elements[i] }}"{% if i < elements|length-1 %},{% endif %}{% endfor %}{% endif %}{% raw %}}{% endraw %}
+
+-- bad behavior
+local use_bad_behavior		= {% if USE_BAD_BEHAVIOR == "yes" %}true{% else %}false{% endif %}
 
 -- include LUA code
-local whitelist		= require "whitelist"
-local blacklist		= require "blacklist"
-local dnsbl		= require "dnsbl"
-local cookie		= require "cookie"
-local javascript	= require "javascript"
-local captcha		= require "captcha"
-local recaptcha		= require "recaptcha"
-local iputils		= require "resty.iputils"
-local behavior		= require "behavior"
+local whitelist			= require "whitelist"
+local blacklist			= require "blacklist"
+local dnsbl			= require "dnsbl"
+local cookie			= require "cookie"
+local javascript		= require "javascript"
+local captcha			= require "captcha"
+local recaptcha			= require "recaptcha"
+local iputils			= require "resty.iputils"
+local behavior			= require "behavior"
+local logger			= require "logger"
 
 -- user variables
-local antibot_uri		= "%ANTIBOT_URI%"
-local whitelist_user_agent	= {%WHITELIST_USER_AGENT%}
-local whitelist_uri		= {%WHITELIST_URI%}
+local antibot_uri		= "{{ ANTIBOT_URI }}"
+local whitelist_user_agent	= {% raw %}{{% endraw %}{% if WHITELIST_USER_AGENT != "" %}{% set elements = WHITELIST_USER_AGENT.split(" ") %}{% for i in range(0, elements|length) %}"{{ elements[i] }}"{% if i < elements|length-1 %},{% endif %}{% endfor %}{% endif %}{% raw %}}{% endraw %}
+local whitelist_uri		= {% raw %}{{% endraw %}{% if WHITELIST_URI != "" %}{% set elements = WHITELIST_URI.split(" ") %}{% for i in range(0, elements|length) %}"{{ elements[i] }}"{% if i < elements|length-1 %},{% endif %}{% endfor %}{% endif %}{% raw %}}{% endraw %}
 
 -- check if already in whitelist cache
 if use_whitelist_ip and whitelist.ip_cached_ok() then
@@ -61,14 +96,14 @@ end
 
 -- check if IP is whitelisted (only if not in cache)
 if use_whitelist_ip and not whitelist.ip_cached() then
-	if whitelist.check_ip() then
+	if whitelist.check_ip(whitelist_ip_list) then
 		ngx.exit(ngx.OK)
 	end
 end
 
 -- check if reverse is whitelisted (only if not in cache)
 if use_whitelist_reverse and not whitelist.reverse_cached() then
-	if whitelist.check_reverse() then
+	if whitelist.check_reverse(whitelist_reverse_list) then
 		ngx.exit(ngx.OK)
 	end
 end
@@ -76,33 +111,34 @@ end
 -- check if URI is whitelisted
 for k, v in pairs(whitelist_uri) do
 	if ngx.var.request_uri == v then
-		ngx.log(ngx.NOTICE, "[WHITELIST] URI " .. v .. " is whitelisted")
+		logger.log(ngx.NOTICE, "WHITELIST", "URI " .. v .. " is whitelisted")
 		ngx.exit(ngx.OK)
 	end
 end
 
 -- check if it's certbot
 if use_lets_encrypt and string.match(ngx.var.request_uri, "^/.well-known/acme-challenge/") then
+	logger.log(ngx.INFO, "LETSENCRYPT", "got a visit from Let's Encrypt")
 	ngx.exit(ngx.OK)
 end
 
 -- check if IP is blacklisted (only if not in cache)
 if use_blacklist_ip and not blacklist.ip_cached() then
-	if blacklist.check_ip() then
+	if blacklist.check_ip(blacklist_ip_list) then
 		ngx.exit(ngx.HTTP_FORBIDDEN)
 	end
 end
 
 -- check if reverse is blacklisted (only if not in cache)
 if use_blacklist_reverse and not blacklist.reverse_cached() then
-	if blacklist.check_reverse() then
+	if blacklist.check_reverse(blacklist_reverse_list, dns_resolvers) then
 		ngx.exit(ngx.HTTP_FORBIDDEN)
 	end
 end
 
 -- check if IP is banned because of "bad behavior"
 if use_bad_behavior and behavior.is_banned() then
-	ngx.log(ngx.NOTICE, "[BLOCK] IP " .. ngx.var.remote_addr .. " is banned because of bad behavior")
+	logger.log(ngx.WARN, "BEHAVIOR", "IP " .. ngx.var.remote_addr .. " is banned because of bad behavior")
 	ngx.exit(ngx.HTTP_FORBIDDEN)
 end
 
@@ -110,7 +146,7 @@ end
 if use_proxies then
 	local value, flags = ngx.shared.proxies_data:get(iputils.ip2bin(ngx.var.remote_addr))
 	if value ~= nil then
-		ngx.log(ngx.NOTICE, "[BLOCK] IP " .. ngx.var.remote_addr .. " is in proxies list")
+		logger.log(ngx.WARN, "PROXIES", "IP " .. ngx.var.remote_addr .. " is in proxies list")
 		ngx.exit(ngx.HTTP_FORBIDDEN)
 	end
 end
@@ -119,7 +155,7 @@ end
 if use_abusers then
 	local value, flags = ngx.shared.abusers_data:get(iputils.ip2bin(ngx.var.remote_addr))
 	if value ~= nil then
-		ngx.log(ngx.NOTICE, "[BLOCK] IP " .. ngx.var.remote_addr .. " is in abusers list")
+		logger.log(ngx.WARN, "ABUSERS", "IP " .. ngx.var.remote_addr .. " is in abusers list")
 		ngx.exit(ngx.HTTP_FORBIDDEN)
 	end
 end
@@ -128,7 +164,7 @@ end
 if use_tor_exit_nodes then
 	local value, flags = ngx.shared.tor_exit_nodes_data:get(iputils.ip2bin(ngx.var.remote_addr))
 	if value ~= nil then
-		ngx.log(ngx.NOTICE, "[BLOCK] IP " .. ngx.var.remote_addr .. " is in TOR exit nodes list")
+		logger.log(ngx.WARN, "TOR", "IP " .. ngx.var.remote_addr .. " is in TOR exit nodes list")
 		ngx.exit(ngx.HTTP_FORBIDDEN)
 	end
 end
@@ -138,7 +174,7 @@ if use_user_agents and ngx.var.http_user_agent ~= nil then
 	local whitelisted = false
 	for k, v in pairs(whitelist_user_agent) do
 		if string.match(ngx.var.http_user_agent, v) then
-			ngx.log(ngx.NOTICE, "[ALLOW] User-Agent " .. ngx.var.http_user_agent .. " is whitelisted")
+			logger.log(ngx.NOTICE, "WHITELIST", "User-Agent " .. ngx.var.http_user_agent .. " is whitelisted")
 			whitelisted = true
 			break
 		end
@@ -160,7 +196,7 @@ if use_user_agents and ngx.var.http_user_agent ~= nil then
 			end
 		end
 		if value == "ko" then
-			ngx.log(ngx.NOTICE, "[BLOCK] User-Agent " .. ngx.var.http_user_agent .. " is blacklisted")
+			logger.log(ngx.WARN, "USER-AGENT", "User-Agent " .. ngx.var.http_user_agent .. " is blacklisted")
 			ngx.exit(ngx.HTTP_FORBIDDEN)
 		end
 	end
@@ -184,20 +220,20 @@ if use_referrer and ngx.var.http_referer ~= nil then
 		end
 	end
 	if value == "ko" then
-		ngx.log(ngx.NOTICE, "[BLOCK] Referrer " .. ngx.var.http_referer .. " is blacklisted")
+		logger.log(ngx.WARN, "REFERRER", "Referrer " .. ngx.var.http_referer .. " is blacklisted")
 		ngx.exit(ngx.HTTP_FORBIDDEN)
 	end
 end
 
 -- check if country is allowed
 if use_country and ngx.var.allowed_country == "no" then
-	ngx.log(ngx.NOTICE, "[BLOCK] Country of " .. ngx.var.remote_addr .. " is blacklisted")
+	logger.log(ngx.WARN, "COUNTRY", "Country of " .. ngx.var.remote_addr .. " is blacklisted")
 	ngx.exit(ngx.HTTP_FORBIDDEN)
 end
 
 -- check if IP is in DNSBLs (only if not in cache)
 if use_dnsbl and not dnsbl.cached() then
-	if dnsbl.check() then
+	if dnsbl.check(dnsbl_list, dns_resolvers) then
 		ngx.exit(ngx.HTTP_FORBIDDEN)
 	end
 end
@@ -206,22 +242,22 @@ end
 if use_crowdsec then
 	local ok, err = require "crowdsec.CrowdSec".allowIp(ngx.var.remote_addr)
 	if ok == nil then
-		ngx.log(ngx.ERR, "[Crowdsec] " .. err)
+		logger.log(ngx.ERR, "CROWDSEC", err)
 	end
 	if not ok then
-		ngx.log(ngx.NOTICE, "[Crowdsec] denied '" .. ngx.var.remote_addr .. "'")
+		logger.log(ngx.WARN, "CROWDSEC", "denied " .. ngx.var.remote_addr)
 		ngx.exit(ngx.HTTP_FORBIDDEN)
 	end
 end
 
 -- cookie check
-if use_antibot_cookie then
+if use_antibot_cookie and ngx.var.uri ~= "/favicon.ico" then
 	if not cookie.is_set("uri") then
 		if ngx.var.request_uri ~= antibot_uri then
 			cookie.set({uri = ngx.var.request_uri})
 			return ngx.redirect(antibot_uri)
 		end
-		ngx.log(ngx.NOTICE, "[ANTIBOT] cookie fail for " .. ngx.var.remote_addr)
+		logger.log(ngx.WARN, "ANTIBOT", "cookie fail for " .. ngx.var.remote_addr)
 		return ngx.exit(ngx.HTTP_FORBIDDEN)
 	else
 		if ngx.var.request_uri == antibot_uri then
@@ -231,7 +267,7 @@ if use_antibot_cookie then
 end
 
 -- javascript check
-if use_antibot_javascript then
+if use_antibot_javascript and ngx.var.uri ~= "/favicon.ico" then
 	if not cookie.is_set("javascript") then
 		if ngx.var.request_uri ~= antibot_uri then
 			cookie.set({uri = ngx.var.request_uri, challenge = javascript.get_challenge()})
@@ -241,7 +277,7 @@ if use_antibot_javascript then
 end
 
 -- captcha check
-if use_antibot_captcha then
+if use_antibot_captcha and ngx.var.uri ~= "/favicon.ico" then
 	if not cookie.is_set("captcha") then
 		if ngx.var.request_uri ~= antibot_uri then
 			cookie.set({uri = ngx.var.request_uri})
@@ -251,7 +287,7 @@ if use_antibot_captcha then
 end
 
 -- recaptcha check
-if use_antibot_recaptcha then
+if use_antibot_recaptcha and ngx.var.uri ~= "/favicon.ico" then
 	if not cookie.is_set("recaptcha") then
 		if ngx.var.request_uri ~= antibot_uri then
 			cookie.set({uri = ngx.var.request_uri})
@@ -260,12 +296,23 @@ if use_antibot_recaptcha then
 	end
 end
 
+-- plugins check
+local plugins, flags = ngx.shared.plugins_data:get("plugins")
+if plugins ~= nil then
+	for plugin_id in string.gmatch(plugins, "%w+") do
+		local plugin = require(plugin_id .. "/" .. plugin_id)
+		plugin.check()
+	end
+end
+
 ngx.exit(ngx.OK)
 
 }
 
-%INCLUDE_ANTIBOT_JAVASCRIPT%
-
-%INCLUDE_ANTIBOT_CAPTCHA%
-
-%INCLUDE_ANTIBOT_RECAPTCHA%
+{% if USE_ANTIBOT == "javascript" %}
+include {{ NGINX_PREFIX }}antibot-javascript.conf;
+{% elif USE_ANTIBOT == "captcha" %}
+include {{ NGINX_PREFIX }}antibot-captcha.conf;
+{% elif USE_ANTIBOT == "recaptcha" %}
+include {{ NGINX_PREFIX }}antibot-recaptcha.conf;
+{% endif %}

confs/site/modsecurity-clamav.conf

@@ -1,4 +0,0 @@
-SecUploadDir /tmp
-SecUploadKeepFiles On
-SecRule FILES_TMPNAMES "@inspectFile /opt/scripts/clamav.sh" \
-"phase:2,t:none,deny,msg:'Virus found in uploaded file',id:'399999'"

confs/site/modsecurity-rules.conf

@@ -49,17 +49,30 @@ SecResponseBodyLimit 524288
 SecResponseBodyLimitAction ProcessPartial
 
 # log usefull stuff
-SecAuditEngine %MODSECURITY_SEC_AUDIT_ENGINE%
+SecAuditEngine {{ MODSECURITY_SEC_AUDIT_ENGINE }}
 SecAuditLogType Serial
 SecAuditLog /var/log/nginx/modsec_audit.log
 
-# scan uploaded files with clamv
-%USE_CLAMAV_UPLOAD%
+# include OWASP CRS configuration
+{% if USE_MODSECURITY_CRS == "yes" %}
+include /opt/owasp/crs.conf
+
+# custom CRS configurations before loading rules (exclusions) 
+{% if is_custom_conf("/modsec-crs-confs") %}
+include /modsec-crs-confs/*.conf
+{% endif %}
+{% if MULTISITE == "yes" and is_custom_conf("/modsec-crs-confs/" + FIRST_SERVER) %}
+include /modsec-crs-confs/{{ FIRST_SERVER }}/*.conf
+{% endif %}
 
 # include OWASP CRS rules
-%MODSECURITY_INCLUDE_CRS%
-%MODSECURITY_INCLUDE_CUSTOM_CRS%
-%MODSECURITY_INCLUDE_CRS_RULES%
+include /opt/owasp/crs/*.conf
+{% endif %}
 
-# include custom rules
-%MODSECURITY_INCLUDE_CUSTOM_RULES%
+# custom rules after loading the CRS
+{% if is_custom_conf("/modsec-confs") %}
+include /modsec-confs/*.conf
+{% endif %}
+{% if MULTISITE == "yes" and is_custom_conf("/modsec-confs/" + FIRST_SERVER) %}
+include /modsec-confs/{{ FIRST_SERVER }}/*.conf
+{% endif %}

confs/site/modsecurity.conf

@@ -1,2 +1,2 @@
 modsecurity on;
-modsecurity_rules_file %MODSEC_RULES_FILE%;
+modsecurity_rules_file {{ NGINX_PREFIX }}modsecurity-rules.conf;

confs/site/open-file-cache.conf

@@ -1,4 +1,4 @@
-open_file_cache %OPEN_FILE_CACHE%;
-open_file_cache_errors %OPEN_FILE_CACHE_ERRORS%;
-open_file_cache_min_uses %OPEN_FILE_CACHE_MIN_USES%;
-open_file_cache_valid %OPEN_FILE_CACHE_VALID%;
+open_file_cache {{ OPEN_FILE_CACHE }};
+open_file_cache_errors {{ OPEN_FILE_CACHE_ERRORS }};
+open_file_cache_min_uses {{ OPEN_FILE_CACHE_MIN_USES }};
+open_file_cache_valid {{ OPEN_FILE_CACHE_VALID }};

confs/site/permissions-policy.conf

@@ -1 +1 @@
-more_set_headers "Permissions-Policy: %PERMISSIONS_POLICY%";
+more_set_headers "Permissions-Policy: {{ PERMISSIONS_POLICY }}";

confs/site/php.conf

@@ -1,4 +1,4 @@
 location ~ \.php$ {
-	fastcgi_pass      %REMOTE_PHP%:9000;
+	fastcgi_pass      {{ REMOTE_PHP }}:9000;
 	fastcgi_index     index.php;
 }

confs/site/proxy-cache.conf

@@ -1,7 +1,11 @@
 proxy_cache proxycache;
-proxy_cache_methods %PROXY_CACHE_METHODS%;
-proxy_cache_min_uses %PROXY_CACHE_MIN_USES%;
-proxy_cache_key %PROXY_CACHE_KEY%;
-proxy_no_cache %PROXY_NO_CACHE%;
-proxy_cache_bypass %PROXY_CACHE_BYPASS%;
-%PROXY_CACHE_VALID%
+proxy_cache_methods {{ PROXY_CACHE_METHODS }};
+proxy_cache_min_uses {{ PROXY_CACHE_MIN_USES }};
+proxy_cache_key {{ PROXY_CACHE_KEY }};
+proxy_no_cache {{ PROXY_NO_CACHE }};
+proxy_cache_bypass {{ PROXY_CACHE_BYPASS }};
+{% if PROXY_CACHE_VALID != "" %}
+{% for element in PROXY_CACHE_VALID.split(" ") %}
+proxy_cache_valid {{ element.split("=")[0] }} {{ element.split("=")[1] }};
+{% endfor %}
+{% endif %}

confs/site/proxy-real-ip.conf

@@ -1,4 +1,8 @@
-%PROXY_REAL_IP_FROM%
-real_ip_header %PROXY_REAL_IP_HEADER%;
-real_ip_recursive %PROXY_REAL_IP_RECURSIVE%;
+{% if PROXY_REAL_IP_FROM != "" %}
+	{% for element in PROXY_REAL_IP_FROM.split(" ") %}
+set_real_ip_from {{ element }};
+	{% endfor %}
+{% endif %}
+real_ip_header {{ PROXY_REAL_IP_HEADER }};
+real_ip_recursive {{ PROXY_REAL_IP_RECURSIVE }};
 

confs/site/referrer-policy.conf

@@ -1 +1 @@
-more_set_headers "Referrer-Policy: %REFERRER_POLICY%";
+more_set_headers "Referrer-Policy: {{ REFERRER_POLICY }}";

confs/site/reverse-proxy.conf

@@ -1,7 +1,25 @@
-location %REVERSE_PROXY_URL% {
+{% if USE_REVERSE_PROXY == "yes" %}
+	{% for k, v in all.items() %}
+		{% if k.startswith("REVERSE_PROXY_URL") and v != "" %}
+			{% set url = v %}
+			{% set host = all[k.replace("URL", "HOST")] if k.replace("URL", "HOST") in all else "" %}
+			{% set ws = all[k.replace("URL", "WS")] if k.replace("URL", "WS") in all else "" %}
+			{% set headers = all[k.replace("URL", "HEADERS")] if k.replace("URL", "HEADERS") in all else "" %}
+location {{ url }} {% raw %}{{% endraw %}
 	etag off;
-	proxy_pass %REVERSE_PROXY_HOST%;
-	%REVERSE_PROXY_HEADERS%
-	%REVERSE_PROXY_WS%
-	%REVERSE_PROXY_CUSTOM_HEADERS%
-}
+	proxy_pass {{ host }};
+	include {{ NGINX_PREFIX }}reverse-proxy-headers.conf;
+			{% if ws == "yes" %}
+	proxy_http_version 1.1;
+	proxy_set_header Upgrade $http_upgrade;
+	proxy_set_header Connection "Upgrade";
+			{% endif %}
+			{% if headers != "" %}
+				{% for header in headers.split(";") %}
+	proxy_set_header {{ header }};
+				{% endfor %}
+			{% endif %}
+{% raw %}}{% endraw %}
+		{% endif %}
+	{% endfor %}
+{% endif %}

confs/site/serve-files.conf

@@ -1,3 +1,3 @@
-root %ROOT_FOLDER%;
+root {{ ROOT_FOLDER }};
 index index.html index.php;
 try_files $uri $uri/ =404;

confs/site/server.conf

@@ -1,41 +1,177 @@
-%PRE_SERVER_CONF%
+# custom config before server block
+include /pre-server-confs/*.conf;
+{% if MULTISITE == "yes" %}
+include /pre-server-confs/{{ FIRST_SERVER }}/*.conf;
+{% endif %}
 
 server {
-	%FASTCGI_PATH%
-	%SERVER_CONF%
-	%PROXY_REAL_IP%
-	%INCLUDE_LUA%
-	%USE_MODSECURITY%
-	%LISTEN_HTTP%
-	%USE_HTTPS%
-	%REDIRECT_HTTP_TO_HTTPS%
-	server_name %SERVER_NAME%;
-	%DISABLE_DEFAULT_SERVER%
-	%SERVE_FILES%
-	if ($request_method !~ ^(%ALLOWED_METHODS%)$)
-	{
+
+	# FastCGI variables
+{% if REMOTE_PHP != "" %}
+	include {{ NGINX_PREFIX }}fastcgi.conf;
+{% endif %}
+
+	# custom config
+	include /server-confs/*.conf;
+{% if MULTISITE == "yes" %}
+	include /server-confs/{{ FIRST_SERVER }}/*.conf;
+{% endif %}
+
+	# proxy real IP
+{% if PROXY_REAL_IP == "yes" %}
+	include {{ NGINX_PREFIX }}proxy-real-ip.conf;
+{% endif %}
+
+	# include LUA files
+	include {{ NGINX_PREFIX }}main-lua.conf;
+	include {{ NGINX_PREFIX }}log-lua.conf;
+
+	# ModSecurity
+{% if USE_MODSECURITY == "yes" %}
+	include {{ NGINX_PREFIX }}modsecurity.conf;
+{% endif %}
+
+	# HTTP listen
+{% if LISTEN_HTTP == "yes" %}
+	listen 0.0.0.0:{{ HTTP_PORT }};
+{% endif %}
+
+	# HTTPS listen + config
+{% if AUTO_LETS_ENCRYPT == "yes" or USE_CUSTOM_HTTPS == "yes" or GENERATE_SELF_SIGNED_SSL == "yes" %}
+	include {{ NGINX_PREFIX }}https.conf;
+{% endif %}
+
+	# HTTP to HTTPS
+{% if REDIRECT_HTTP_TO_HTTPS == "yes" %}
+	include {{ NGINX_PREFIX }}redirect-http-to-https.conf;
+{% endif %}
+
+	# server name (vhost)
+	server_name {{ SERVER_NAME }};
+
+	# disable default server
+{% if DISABLE_DEFAULT_SERVER == "yes" and MULTISITE != "yes" %}
+	include {{ NGINX_PREFIX }}disable-default-server.conf;
+{% endif %}
+
+	# serve local files
+{% if SERVE_FILES == "yes" %}
+	include {{ NGINX_PREFIX }}serve-files.conf;
+{% endif %}
+
+	# allowed HTTP methods
+	if ($request_method !~ ^({{ ALLOWED_METHODS }})$) {
 		return 405;
 	}
-	%LIMIT_REQ%
-	%LIMIT_CONN%
-	%AUTH_BASIC%
-	%REMOVE_HEADERS%
-	%X_FRAME_OPTIONS%
-	%X_XSS_PROTECTION%
-	%X_CONTENT_TYPE_OPTIONS%
-	%CONTENT_SECURITY_POLICY%
-	%REFERRER_POLICY%
-	%FEATURE_POLICY%
-	%PERMISSIONS_POLICY%
-	%COOKIE_FLAGS%
-	%ERRORS%
-	%USE_CLIENT_CACHE%
-	%USE_GZIP%
-	%USE_BROTLI%
-	client_max_body_size %MAX_CLIENT_SIZE%;
-	server_tokens %SERVER_TOKENS%;
-	%USE_OPEN_FILE_CACHE%
-	%USE_PROXY_CACHE%
-	%USE_REVERSE_PROXY%
-	%USE_PHP%
+
+	# requests limiting
+{% if USE_LIMIT_REQ == "yes" %}
+	include {{ NGINX_PREFIX }}limit-req.conf;
+{% endif %}
+
+	# connections limiting
+{% if USE_LIMIT_CONN == "yes" %}
+	include {{ NGINX_PREFIX }}limit-conn.conf;
+{% endif %}
+
+	# auth basic
+{% if USE_AUTH_BASIC == "yes" %}
+	{% if AUTH_BASIC_LOCATION == "sitewide" %}
+	include {{ NGINX_PREFIX }}auth-basic-sitewide.conf;
+	{% else %}
+	include {{ NGINX_PREFIX }}auth-basic.conf;
+	{% endif %}
+{% endif %}
+
+	# remove headers
+{% if REMOVE_HEADERS != "" %}
+	{% for header in REMOVE_HEADERS.split(" ") %}
+	more_clear_headers '{{ header }}';
+	{% endfor %}
+{% endif %}
+
+	# X-Frame-Option header
+{% if X_FRAME_OPTIONS != "" %}
+	include {{ NGINX_PREFIX }}x-frame-options.conf;
+{% endif %}
+
+	# X-XSS-Protection header
+{% if X_XSS_PROTECTION != "" %}
+	include {{ NGINX_PREFIX }}x-xss-protection.conf;
+{% endif %}
+
+	# X-Content-Type header
+{% if X_CONTENT_TYPE_OPTIONS != "" %}
+	include {{ NGINX_PREFIX }}x-content-type-options.conf;
+{% endif %}
+
+	# Content-Security-Policy header
+{% if CONTENT_SECURITY_POLICY != "" %}
+	include {{ NGINX_PREFIX }}content-security-policy.conf;
+{% endif %}
+
+	# Referrer-Policy header
+{% if REFERRER_POLICY != "" %}
+	include {{ NGINX_PREFIX }}referrer-policy.conf;
+{% endif %}
+
+	# Feature-Policy header
+{% if FEATURE_POLICY != "" %}
+	include {{ NGINX_PREFIX }}feature-policy.conf;
+{% endif %}
+
+	# Permissions-Policy header
+{% if PERMISSIONS_POLICY != "" %}
+	include {{ NGINX_PREFIX }}permissions-policy.conf;
+{% endif %}
+
+	# cookie flags
+{% if COOKIE_FLAGS != "" %}
+	include {{ NGINX_PREFIX }}cookie-flags.conf;
+{% endif %}
+
+	# custom errors
+	include {{ NGINX_PREFIX }}error.conf;
+
+	# client caching
+{% if USE_CLIENT_CACHE == "yes" %}
+	include {{ NGINX_PREFIX }}client-cache.conf;
+{% endif %}
+
+	# gzip compression
+{% if USE_GZIP == "yes" %}
+	include {{ NGINX_PREFIX }}gzip.conf;
+{% endif %}
+
+	# brotli compression
+{% if USE_BROTLI == "yes" %}
+	include {{ NGINX_PREFIX }}brotli.conf;
+{% endif %}
+
+	# maximum body size
+	client_max_body_size {{ MAX_CLIENT_SIZE }};
+	
+	# enable/disable showing version
+	server_tokens {{ SERVER_TOKENS }};
+
+	# open file caching
+{% if USE_OPEN_FILE_CACHE == "yes" %}
+	include {{ NGINX_PREFIX }}open-file-cache.conf;	
+{% endif %}
+
+	# proxy caching
+{% if USE_PROXY_CACHE == "yes" %}
+	include {{ NGINX_PREFIX }}proxy-cache.conf;	
+{% endif %}
+
+	# reverse proxy
+{% if USE_REVERSE_PROXY == "yes" %}
+	include {{ NGINX_PREFIX }}reverse-proxy.conf;
+{% endif %}
+
+	# remote PHP
+{% if REMOTE_PHP != "" %}
+	include {{ NGINX_PREFIX }}php.conf;
+{% endif %}
+
 }

confs/site/x-content-type-options.conf

@@ -1 +1 @@
-more_set_headers "X-Content-Type-Options: %X_CONTENT_TYPE_OPTIONS%";
+more_set_headers "X-Content-Type-Options: {{ X_CONTENT_TYPE_OPTIONS }}";

confs/site/x-frame-options.conf

@@ -1 +1 @@
-more_set_headers "X-Frame-Options: %X_FRAME_OPTIONS%";
+more_set_headers "X-Frame-Options: {{ X_FRAME_OPTIONS }}";

confs/site/x-xss-protection.conf

@@ -1 +1 @@
-more_set_headers "X-XSS-Protection: %X_XSS_PROTECTION%";
+more_set_headers "X-XSS-Protection: {{ X_XSS_PROTECTION }}";

defaults/errors/400.html

@@ -0,0 +1,23 @@
+<html>
+	<head>
+		<title>400 - Bad Request</title>
+		<style>
+			body {
+				background-color: #1d70b7;
+			}
+			.centered {
+				position: fixed;
+				top: 50%;
+				left: 50%;
+				transform: translate(-50%, -50%);
+				text-align: center;
+			}
+		</style>
+	</head>
+	<body>
+		<div class="centered" style="color: white;">
+			<h1>400 - Bad Request</h1>
+			&#128737;&#65039; this website is protected with <a href="https://github.com/bunkerity/bunkerized-nginx" target="_blank">bunkerized-nginx</a> &#128737;&#65039;
+		</div>
+	</body>
+</html>

defaults/errors/401.html

@@ -0,0 +1,23 @@
+<html>
+	<head>
+		<title>401 - Unauthorized</title>
+		<style>
+			body {
+				background-color: #1d70b7;
+			}
+			.centered {
+				position: fixed;
+				top: 50%;
+				left: 50%;
+				transform: translate(-50%, -50%);
+				text-align: center;
+			}
+		</style>
+	</head>
+	<body>
+		<div class="centered" style="color: white;">
+			<h1>401 - Unauthorized</h1>
+			&#128737;&#65039; this website is protected with <a href="https://github.com/bunkerity/bunkerized-nginx" target="_blank">bunkerized-nginx</a> &#128737;&#65039;
+		</div>
+	</body>
+</html>

defaults/errors/403.html

@@ -0,0 +1,23 @@
+<html>
+	<head>
+		<title>403 - Forbidden</title>
+		<style>
+			body {
+				background-color: #1d70b7;
+			}
+			.centered {
+				position: fixed;
+				top: 50%;
+				left: 50%;
+				transform: translate(-50%, -50%);
+				text-align: center;
+			}
+		</style>
+	</head>
+	<body>
+		<div class="centered" style="color: white;">
+			<h1>403 - Forbidden</h1>
+			&#128737;&#65039; this website is protected with <a href="https://github.com/bunkerity/bunkerized-nginx" target="_blank">bunkerized-nginx</a> &#128737;&#65039;
+		</div>
+	</body>
+</html>

defaults/errors/404.html

@@ -0,0 +1,23 @@
+<html>
+	<head>
+		<title>404 - Not Found</title>
+		<style>
+			body {
+				background-color: #1d70b7;
+			}
+			.centered {
+				position: fixed;
+				top: 50%;
+				left: 50%;
+				transform: translate(-50%, -50%);
+				text-align: center;
+			}
+		</style>
+	</head>
+	<body>
+		<div class="centered" style="color: white;">
+			<h1>404 - Not Found</h1>
+			&#128737;&#65039; this website is protected with <a href="https://github.com/bunkerity/bunkerized-nginx" target="_blank">bunkerized-nginx</a> &#128737;&#65039;
+		</div>
+	</body>
+</html>

defaults/errors/429.html

@@ -0,0 +1,23 @@
+<html>
+	<head>
+		<title>429 - Too Many Requests</title>
+		<style>
+			body {
+				background-color: #1d70b7;
+			}
+			.centered {
+				position: fixed;
+				top: 50%;
+				left: 50%;
+				transform: translate(-50%, -50%);
+				text-align: center;
+			}
+		</style>
+	</head>
+	<body>
+		<div class="centered" style="color: white;">
+			<h1>429 - Too Many Requests</h1>
+			&#128737;&#65039; this website is protected with <a href="https://github.com/bunkerity/bunkerized-nginx" target="_blank">bunkerized-nginx</a> &#128737;&#65039;
+		</div>
+	</body>
+</html>

defaults/errors/500.html

@@ -0,0 +1,23 @@
+<html>
+	<head>
+		<title>500 - Internal Server Error</title>
+		<style>
+			body {
+				background-color: #1d70b7;
+			}
+			.centered {
+				position: fixed;
+				top: 50%;
+				left: 50%;
+				transform: translate(-50%, -50%);
+				text-align: center;
+			}
+		</style>
+	</head>
+	<body>
+		<div class="centered" style="color: white;">
+			<h1>500 - Internal Server Error</h1>
+			&#128737;&#65039; this website is protected with <a href="https://github.com/bunkerity/bunkerized-nginx" target="_blank">bunkerized-nginx</a> &#128737;&#65039;
+		</div>
+	</body>
+</html>

defaults/errors/501.html

@@ -0,0 +1,23 @@
+<html>
+	<head>
+		<title>501 - Not Implemented</title>
+		<style>
+			body {
+				background-color: #1d70b7;
+			}
+			.centered {
+				position: fixed;
+				top: 50%;
+				left: 50%;
+				transform: translate(-50%, -50%);
+				text-align: center;
+			}
+		</style>
+	</head>
+	<body>
+		<div class="centered" style="color: white;">
+			<h1>501 - Not Implemented</h1>
+			&#128737;&#65039; this website is protected with <a href="https://github.com/bunkerity/bunkerized-nginx" target="_blank">bunkerized-nginx</a> &#128737;&#65039;
+		</div>
+	</body>
+</html>

defaults/errors/502.html

@@ -0,0 +1,23 @@
+<html>
+	<head>
+		<title>502 - Bad Gateway</title>
+		<style>
+			body {
+				background-color: #1d70b7;
+			}
+			.centered {
+				position: fixed;
+				top: 50%;
+				left: 50%;
+				transform: translate(-50%, -50%);
+				text-align: center;
+			}
+		</style>
+	</head>
+	<body>
+		<div class="centered" style="color: white;">
+			<h1>502 - Bad Gateway</h1>
+			&#128737;&#65039; this website is protected with <a href="https://github.com/bunkerity/bunkerized-nginx" target="_blank">bunkerized-nginx</a> &#128737;&#65039;
+		</div>
+	</body>
+</html>

defaults/errors/503.html

@@ -0,0 +1,23 @@
+<html>
+	<head>
+		<title>503 - Service Unavailable</title>
+		<style>
+			body {
+				background-color: #1d70b7;
+			}
+			.centered {
+				position: fixed;
+				top: 50%;
+				left: 50%;
+				transform: translate(-50%, -50%);
+				text-align: center;
+			}
+		</style>
+	</head>
+	<body>
+		<div class="centered" style="color: white;">
+			<h1>503 - Service Unavailable</h1>
+			&#128737;&#65039; this website is protected with <a href="https://github.com/bunkerity/bunkerized-nginx" target="_blank">bunkerized-nginx</a> &#128737;&#65039;
+		</div>
+	</body>
+</html>

defaults/errors/504.html

@@ -0,0 +1,23 @@
+<html>
+	<head>
+		<title>504 - Gateway Time-out</title>
+		<style>
+			body {
+				background-color: #1d70b7;
+			}
+			.centered {
+				position: fixed;
+				top: 50%;
+				left: 50%;
+				transform: translate(-50%, -50%);
+				text-align: center;
+			}
+		</style>
+	</head>
+	<body>
+		<div class="centered" style="color: white;">
+			<h1>504 - Gateway Time-out</h1>
+			&#128737;&#65039; this website is protected with <a href="https://github.com/bunkerity/bunkerized-nginx" target="_blank">bunkerized-nginx</a> &#128737;&#65039;
+		</div>
+	</body>
+</html>

dependencies.sh

@@ -1,4 +1,5 @@
 #!/bin/sh
 
 # install dependencies
-apk --no-cache add certbot libstdc++ libmaxminddb geoip pcre yajl clamav apache2-utils openssl lua libgd go jq mariadb-connector-c bash brotli
+apk add certbot bash libmaxminddb libgcc lua yajl libstdc++ openssl py3-pip
+pip3 install jinja2

docs/conf.py

@@ -14,15 +14,43 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
+import os, subprocess, re
+
+def get_git_branch():
+    """Get the git branch this repository is currently on"""
+    path_to_here = os.path.abspath(os.path.dirname(__file__))
+
+    # Invoke git to get the current branch which we use to get the theme
+    try:
+        p = subprocess.Popen(['git', 'branch'], stdout=subprocess.PIPE, cwd=path_to_here)
+
+        # This will contain something like "* (HEAD detached at origin/MYBRANCH)"
+        # or something like "* MYBRANCH"
+        branch_output = p.communicate()[0].decode("ascii")
+
+        # This is if git is in a normal branch state
+        match = re.search(r'\* (?P<branch_name>[^\(\)\n ]+)', branch_output)
+        if match:
+            return match.groupdict()['branch_name']
+
+        # git is in a detached HEAD state
+        match = re.search(r'\(HEAD detached at origin/(?P<branch_name>[^\)]+)\)', branch_output)
+        if match:
+            return match.groupdict()['branch_name']
+    except Exception as e :
+        print(e)
+        print(u'Could not get the branch')
+
+    # Couldn't figure out the branch probably due to an error
+    return None
 
 # -- Project information -----------------------------------------------------
-
 project = 'bunkerized-nginx'
 copyright = '2021, bunkerity'
 author = 'bunkerity'
 
 # The full version, including alpha/beta/rc tags
-release = 'v1.2.5'
+release = 'v1.2.7'
 
 
 # -- General configuration ---------------------------------------------------
@@ -30,7 +58,7 @@ release = 'v1.2.5'
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['myst_parser']
+extensions = ['myst_parser', 'sphinx_sitemap']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -53,3 +81,14 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
+
+# for sitemap
+sitemap_filename = "sm.xml"
+branch = get_git_branch()
+if branch == "master" :
+	html_baseurl = 'https://bunkerized-nginx.readthedocs.io/en/latest/'
+else :
+	html_baseurl = 'https://bunkerized-nginx.readthedocs.io/en/dev/'
+
+# custom robots.txt
+html_extra_path = ['robots.txt']

docs/environment_variables.md

@@ -14,7 +14,7 @@ Any environment variable tagged as *multisite* context can be used for a specifi
 `SERVER_NAME`  
 Values : *<first name> <second name> ...*  
 Default value : *www.bunkerity.com*  
-Context : *global*  
+Context : *global*, *multisite*  
 Sets the host names of the webserver separated with spaces. This must match the Host header sent by clients.  
 Useful when used with `MULTISITE=yes` and/or `AUTO_LETSENCRYPT=yes` and/or `DISABLE_DEFAULT_SERVER=yes`.
 
@@ -55,7 +55,7 @@ The IP addresses of the DNS resolvers to use when performing DNS lookups.
 Values : *\<any valid path to web files\>*  
 Default value : */www*  
 Context : *global*  
-The default folder where nginx will search for web files. Don't change it unless you want to make your own image.
+The default folder where nginx will search for web files. Don't change it unless you know what you are doing.
 
 `ROOT_SITE_SUBFOLDER`  
 Values : *\<any valid directory name\>*  
@@ -69,6 +69,12 @@ Default value : *$host $remote_addr - $remote_user \[$time_local\] "$request" $s
 Context : *global*  
 The log format used by nginx to generate logs. More info [here](http://nginx.org/en/docs/http/ngx_http_log_module.html#log_format).
 
+`LOG_LEVEL`  
+Values : *debug, info, notice, warn, error, crit, alert, or emerg*  
+Default value : *info*  
+Context : *global*  
+The level of logging : *debug* means more logs and *emerg* means less logs. More info [here](https://nginx.org/en/docs/ngx_core_module.html#error_log).
+
 `HTTP_PORT`  
 Values : *\<any valid port greater than 1024\>*  
 Default value : *8080*  
@@ -81,6 +87,18 @@ Default value : *8443*
 Context : *global*  
 The HTTPS port number used by nginx inside the container.
 
+`WORKER_CONNECTIONS`
+Values : *\<any positive integer\>*  
+Default value : 1024  
+Context : *global*  
+Sets the value of the [worker_connections](https://nginx.org/en/docs/ngx_core_module.html#worker_connections) directive.
+
+`WORKER_RLIMIT_NOFILE`
+Values : *\<any positive integer\>*  
+Default value : 2048  
+Context : *global*  
+Sets the value of the [worker_rlimit_nofile](https://nginx.org/en/docs/ngx_core_module.html#worker_rlimit_nofile) directive.
+
 ### Information leak
 
 `SERVER_TOKENS`  
@@ -97,12 +115,12 @@ List of header to remove when sending responses to clients.
 
 ### Custom error pages
 
-`ERROR_XXX`  
-Values : *\<relative path to the error page\>*  
+`ERRORS`  
+Values : *\<error1=/page1 error2=/page2\>*  
 Default value :  
 Context : *global*, *multisite*  
-Use this kind of environment variable to define custom error page depending on the HTTP error code. Replace XXX with HTTP code.  
-For example : `ERROR_404=/404.html` means the /404.html page will be displayed when 404 code is generated. The path is relative to the root web folder.
+Use this kind of environment variable to define custom error page depending on the HTTP error code. Replace errorX with HTTP code.  
+Example : `ERRORS=404=/404.html 403=/403.html` the /404.html page will be displayed when 404 code is generated (same for 403 and /403.html page). The path is relative to the root web folder.
 
 ### HTTP basic authentication
 
@@ -176,7 +194,7 @@ You can set multiple url/host by adding a suffix number to the variable name lik
 Values : *yes* | *no*  
 Default value : *no*  
 Context : *global*, *multisite*  
-Set this environment variable to *yes* if you're using bunkerized-nginx behind a reverse proxy. This means you will see the real client address instead of the proxy one inside your logs. Modsecurity, fail2ban and others security tools will also then work correctly.
+Set this environment variable to *yes* if you're using bunkerized-nginx behind a reverse proxy. This means you will see the real client address instead of the proxy one inside your logs. Ssecurity tools will also then work correctly.
 
 `PROXY_REAL_IP_FROM`  
 Values : *\<list of trusted IP addresses and/or networks separated with spaces\>*  
@@ -413,55 +431,55 @@ Full path of the key file to use when `USE_CUSTOM_HTTPS` is set to yes.
 `GENERATE_SELF_SIGNED_SSL`  
 Values : *yes* | *no*  
 Default value : *no*  
-Context : *global*  
+Context : *global*, *multisite*  
 If set to yes, HTTPS will be enabled with a container generated self-signed certificate.
 
 `SELF_SIGNED_SSL_EXPIRY`  
 Values : *integer*  
 Default value : *365* (1 year)  
-Context : *global*  
+Context : *global*, *multisite*  
 Needs `GENERATE_SELF_SIGNED_SSL` to work.
 Sets the expiry date for the self generated certificate.
 
 `SELF_SIGNED_SSL_COUNTRY`  
 Values : *text*  
 Default value : *Switzerland*  
-Context : *global*  
+Context : *global*, *multisite*  
 Needs `GENERATE_SELF_SIGNED_SSL` to work.
 Sets the country for the self generated certificate.
 
 `SELF_SIGNED_SSL_STATE`  
-Values : *text*  
+Values : *text*, *multisite*  
 Default value : *Switzerland*  
-Context : *global*  
+Context : *global*, *multisite*  
 Needs `GENERATE_SELF_SIGNED_SSL` to work.
 Sets the state for the self generated certificate.
 
 `SELF_SIGNED_SSL_CITY`  
 Values : *text*  
 Default value : *Bern*  
-Context : *global*  
+Context : *global*, *multisite*  
 Needs `GENERATE_SELF_SIGNED_SSL` to work.
 Sets the city for the self generated certificate.
 
 `SELF_SIGNED_SSL_ORG`  
 Values : *text*  
 Default value : *AcmeInc*  
-Context : *global*  
+Context : *global*, *multisite*  
 Needs `GENERATE_SELF_SIGNED_SSL` to work.
 Sets the organisation name for the self generated certificate.
 
 `SELF_SIGNED_SSL_OU`  
 Values : *text*  
 Default value : *IT*  
-Context : *global*  
+Context : *global*, *multisite*  
 Needs `GENERATE_SELF_SIGNED_SSL` to work.
 Sets the organisitional unit for the self generated certificate.
 
 `SELF_SIGNED_SSL_CN`  
 Values : *text*  
 Default value : *bunkerity-nginx*  
-Context : *global*  
+Context : *global*, *multisite*  
 Needs `GENERATE_SELF_SIGNED_SSL` to work.
 Sets the CN server name for the self generated certificate.
 
@@ -495,6 +513,12 @@ Context : *global*, *multisite*
 If set to yes, the [OWASP ModSecurity Core Rule Set](https://coreruleset.org/) will be used. It provides generic rules to detect common web attacks.  
 You can customize the CRS (i.e. : add WordPress exclusions) by adding custom .conf files into the /modsec-crs-confs/ directory inside the container (i.e : through a volume). Files inside this directory are included before the CRS rules. If you need to tweak (i.e. : SecRuleUpdateTargetById) put .conf files inside the /modsec-confs/ which is included after the CRS rules.
 
+`MODSECURITY_SEC_AUDIT_ENGINE`  
+Values : *On* | *Off* | *RelevantOnly*  
+Default value : *RelevantOnly*  
+Context : *global*, *multisite*  
+Sets the value of the [SecAuditEngine directive](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#SecAuditEngine) of ModSecurity.
+
 ## Security headers
 
 `X_FRAME_OPTIONS`  
@@ -601,13 +625,13 @@ The minimum score required when `USE_ANTIBOT` is set to *recaptcha*.
 `ANTIBOT_RECAPTCHA_SITEKEY`  
 Values : *\<public key given by Google\>*  
 Default value :  
-Context : *global*  
+Context : *global*, *multisite*  
 The sitekey given by Google when `USE_ANTIBOT` is set to *recaptcha*.
 
 `ANTIBOT_RECAPTCHA_SECRET`  
 Values : *\<private key given by Google\>*  
 Default value :  
-Context : *global*  
+Context : *global*, *multisite*  
 The secret given by Google when `USE_ANTIBOT` is set to *recaptcha*.
 
 ### External blacklists
@@ -658,7 +682,7 @@ If set to *yes*, DNSBL checks will be performed to the servers specified in the
 `DNSBL_LIST`  
 Values : *\<list of DNS zones separated with spaces\>*  
 Default value : *bl.blocklist.de problems.dnsbl.sorbs.net sbl.spamhaus.org xbl.spamhaus.org*  
-Context : *global*  
+Context : *global*, *multisite*  
 The list of DNSBL zones to query when `USE_DNSBL` is set to *yes*.
 
 ### CrowdSec
@@ -692,7 +716,7 @@ If set to *yes*, lets you define custom IP addresses to be whitelisted through t
 `WHITELIST_IP_LIST`  
 Values : *\<list of IP addresses and/or network CIDR blocks separated with spaces\>*  
 Default value : *23.21.227.69 40.88.21.235 50.16.241.113 50.16.241.114 50.16.241.117 50.16.247.234 52.204.97.54 52.5.190.19 54.197.234.188 54.208.100.253 54.208.102.37 107.21.1.8*  
-Context : *global*  
+Context : *global*, *multisite*  
 The list of IP addresses and/or network CIDR blocks to whitelist when `USE_WHITELIST_IP` is set to *yes*. The default list contains IP addresses of the [DuckDuckGo crawler](https://help.duckduckgo.com/duckduckgo-help-pages/results/duckduckbot/).
 
 `USE_WHITELIST_REVERSE`  
@@ -704,7 +728,7 @@ If set to *yes*, lets you define custom reverse DNS suffixes to be whitelisted t
 `WHITELIST_REVERSE_LIST`  
 Values : *\<list of reverse DNS suffixes separated with spaces\>*  
 Default value : *.googlebot.com .google.com .search.msn.com .crawl.yahoot.net .crawl.baidu.jp .crawl.baidu.com .yandex.com .yandex.ru .yandex.net*  
-Context : *global*  
+Context : *global*, *multisite*  
 The list of reverse DNS suffixes to whitelist when `USE_WHITELIST_REVERSE` is set to *yes*. The default list contains suffixes of major search engines.
 
 `WHITELIST_USER_AGENT`  
@@ -730,7 +754,7 @@ If set to *yes*, lets you define custom IP addresses to be blacklisted through t
 `BLACKLIST_IP_LIST`  
 Values : *\<list of IP addresses and/or network CIDR blocks separated with spaces\>*  
 Default value :  
-Context : *global*  
+Context : *global*, *multisite*  
 The list of IP addresses and/or network CIDR blocks to blacklist when `USE_BLACKLIST_IP` is set to *yes*.
 
 `USE_BLACKLIST_REVERSE`  
@@ -742,7 +766,7 @@ If set to *yes*, lets you define custom reverse DNS suffixes to be blacklisted t
 `BLACKLIST_REVERSE_LIST`  
 Values : *\<list of reverse DNS suffixes separated with spaces\>*  
 Default value : *.shodan.io*  
-Context : *global*  
+Context : *global*, *multisite*  
 The list of reverse DNS suffixes to blacklist when `USE_BLACKLIST_REVERSE` is set to *yes*.
 
 ### Requests limiting
@@ -832,102 +856,26 @@ If set to yes, bunkerized-nginx will block users getting too much "suspicious" H
 `BAD_BEHAVIOR_STATUS_CODES`   
 Values : *\<HTTP status codes separated with space\>*  
 Default value : *400 401 403 404 405 429 444*  
-Context : *global*  
+Context : *global*, *multisite*  
 List of HTTP status codes considered as "suspicious".   
 
 `BAD_BEHAVIOR_THRESHOLD`  
 Values : *<any positive integer>*  
 Default value : *10*  
-Context : *global*  
+Context : *global*, *multisite*  
 The number of "suspicious" HTTP status code before the corresponding IP is banned.
 
 `BAD_BEHAVIOR_BAN_TIME`  
 Values : *<any positive integer>*  
 Default value : *86400*  
-Context : *global*  
+Context : *global*, *multisite*  
 The duration time (in seconds) of a ban when the corresponding IP has reached the `BAD_BEHAVIOR_THRESHOLD`.
 
 `BAD_BEHAVIOR_COUNT_TIME`  
 Values : *<any positive integer>*  
 Default value : *60*  
-Context : *global*  
-The duration time (in seconds) before the counter of "suspicious" HTTP is reset.
-
-## ClamAV
-
-`USE_CLAMAV_UPLOAD`  
-Values : *yes* | *no*  
-Default value : *yes*  
 Context : *global*, *multisite*  
-If set to yes, ClamAV will scan every file uploads and block the upload if the file is detected.
-
-`USE_CLAMAV_SCAN`  
-Values : *yes* | *no*  
-Default value : *yes*  
-Context : *global*  
-If set to yes, ClamAV will scan all the files inside the container every day.  
-
-`CLAMAV_SCAN_REMOVE`  
-Values : *yes* | *no*  
-Default value : *yes*  
-Context : *global*  
-If set to yes, ClamAV will automatically remove the detected files.  
-
-## Cron jobs
-
-`AUTO_LETS_ENCRYPT_CRON`  
-Values : *\<cron expression\>*   
-Default value : *15 0 \* \* \**  
-Context : *global*  
-Cron expression of how often certbot will try to renew the certificates.
-
-`BLOCK_USER_AGENT_CRON`  
-Values : *\<cron expression\>*   
-Default value : *30 0 \* \* \* \**  
-Context : *global*  
-Cron expression of how often the blacklist of user agent is updated.
-
-`BLOCK_TOR_EXIT_NODE_CRON`  
-Values : *\<cron expression\>*   
-Default value : *0 \*/1 \* \* \* \**  
-Context : *global*  
-Cron expression of how often the blacklist of tor exit node is updated.
-
-`BLOCK_PROXIES_CRON`  
-Values : *\<cron expression\>*   
-Default value : *0 3 \* \* \* \**  
-Context : *global*  
-Cron expression of how often the blacklist of proxies is updated.
-
-`BLOCK_ABUSERS_CRON`  
-Values : *\<cron expression\>*   
-Default value : *0 2 \* \* \* \**  
-Context : *global*  
-Cron expression of how often the blacklist of abusers is updated.
-
-`BLOCK_REFERRER_CRON`  
-Values : *\<cron expression\>*   
-Default value : *45 0 \* \* \* \**  
-Context : *global*  
-Cron expression of how often the blacklist of referrer is updated.
-
-`GEOIP_CRON`  
-Values : *\<cron expression\>*  
-Default value : *0 4 2 \* \**  
-Context : *global*  
-Cron expression of how often the GeoIP database is updated.
-
-`USE_CLAMAV_SCAN_CRON`  
-Values : *\<cron expression\>*   
-Default value : *30 1 \* \* \**  
-Context : *global*  
-Cron expression of how often ClamAV will scan all the files inside the container.
-
-`CLAMAV_UPDATE_CRON`  
-Values : *\<cron expression\>*   
-Default value : *0 1 \* \* \**  
-Context : *global*  
-Cron expression of how often ClamAV will update its database.
+The duration time (in seconds) before the counter of "suspicious" HTTP is reset.
 
 ## misc
 

docs/index.md

@@ -9,4 +9,5 @@ security_tuning
 troubleshooting
 volumes
 environment_variables
+plugins
 ```

docs/introduction.md

@@ -17,7 +17,7 @@ Non-exhaustive list of features :
 - Block TOR, proxies, bad user-agents, countries, ...
 - Block known bad IP with DNSBL and CrowdSec
 - Prevent bruteforce attacks with rate limiting
-- Detect bad files with ClamAV
+- Plugins system for external security checks (e.g. : ClamAV)
 - Easy to configure with environment variables or web UI
 - Automatic configuration with container labels
 - Docker Swarm support

docs/plugins.md

@@ -0,0 +1,108 @@
+# Plugins
+
+Bunkerized-nginx comes with a plugin system that lets you extend the core with extra security features. To add a plugin you will need to download it, edit its settings and mount it to the `/plugins` volume.
+
+## Official plugins
+
+- [ClamAV](https://github.com/bunkerity/bunkerized-nginx-clamav) : automatically scan uploaded files and deny access if a virus is detected
+
+## Community plugins
+
+If you have made a plugin and want it to be listed here, feel free to [create a pull request](https://github.com/bunkerity/bunkerized-nginx/pulls) and edit that section.
+
+## Use a plugin
+
+The generic way of using a plugin consists of :
+- Download it to a folder (e.g. : myplugin/)
+- Edit the settings inside the plugin.json files (e.g. : myplugin/plugin.json)
+- Mount the plugin folder to the /plugins/plugin-id inside the container (e.g. : /where/is/myplugin:/plugins/myplugin)
+
+To check if the plugin is loaded you should see log entries like that :
+
+```log
+2021/06/05 09:19:47 [error] 104#104: [PLUGINS] *NOT AN ERROR* plugin MyPlugin/1.0 has been loaded
+```
+
+## Write a plugin
+
+A plugin is composed of a plugin.json which contains metadata (e.g. : name, settings, ...) and a set of LUA files for the plugin code.
+
+### plugin.json
+
+```json
+{
+	"id": "myplugin",
+	"name": "My Plugin",
+	"description": "Short description of my plugin.",
+	"version": "1.0",
+	"settings": {
+		"MY_SETTING": "value1",
+		"ANOTHER_SETTING": "value2",
+	}
+}
+```
+
+The `id` value is really important because it must match the subfolder name inside the `plugins` volume. Choose one which isn't already used to avoid conflicts.
+
+Settings names and default values can be choosen freely. There will be no conflict when you retrieve them because they will be prefixed with your plugin id (e.g. : `myplugin_MY_SETTING`).
+
+### Main code
+
+```lua
+local M		= {}
+local logger	= require "logger"
+
+-- this function will be called for each request
+-- the name MUST be check without any argument
+function M.check ()
+
+	-- the logger.log function lets you write into the logs
+	logger.log(ngx.NOTICE, "MyPlugin", "check called")
+
+	-- here is how to retrieve a setting
+	local my_setting = ngx.shared.plugins_data:get("pluginid_MY_SETTING")
+
+	-- a dummy example to show how to block a request
+	if my_setting == "block" then
+		ngx.exit(ngx.HTTP_FORBIDDEN)
+	end
+
+end
+
+return M
+```
+
+That file must have the same name as the `id` defined in the plugin.json with a .lua suffix (e.g. : `myplugin.lua`).
+
+Under the hood, bunkerized-nginx uses the [lua nginx module](https://github.com/openresty/lua-nginx-module) therefore you should be able to access to the whole **ngx.\*** functions.
+
+### Dependencies
+
+Since the core already uses some external libraries you can use it in your own plugins too (see the [compile.sh](https://github.com/bunkerity/bunkerized-nginx/blob/master/compile.sh) file and the [core lua files](https://github.com/bunkerity/bunkerized-nginx/tree/master/lua)).
+
+In case you need to add dependencies, you can do it by placing the corresponding files into the same folder of your main plugin code. Here is an example with a file named **dependency.lua** :
+
+```lua
+local M = {}
+
+function M.my_function ()
+	return "42"
+end
+
+return M
+```
+
+To include it from you main code you will need to prefix it with your plugin id like that :
+
+```lua
+...
+local my_dependency = require "pluginid.dependency"
+
+function M.check ()
+	...
+	local my_value = my_dependency.my_function()
+	...
+end
+...
+```
+

docs/quickstart_guide.md

@@ -294,17 +294,29 @@ docker service create --name anotherapp \
 
 ## Web UI
 
-**This feature exposes, for now, a security risk because you need to mount the docker socket inside a container exposing a web application. You can test it but you should not use it in servers facing the internet.**  
-
 A dedicated image, *bunkerized-nginx-ui*, lets you manage bunkerized-nginx instances and services configurations through a web user interface. This feature is still in beta, feel free to open a new issue if you find a bug and/or you have an idea to improve it. 
 
-First we need a volume that will store the configurations :
+First we need a volume that will store the configurations and a network because bunkerized-nginx will be used as a reverse proxy for the web UI :
 
 ```shell
 docker volume create nginx_conf
+docker network create mynet
 ```
 
-Then, we can create the bunkerized-nginx instance with the `bunkerized-nginx.UI` label and a reverse proxy configuration for our web UI :
+Let's create the bunkerized-nginx-ui container that will host the web UI behind bunkerized-nginx :
+
+```shell
+docker run --network mynet \
+           --name myui \
+           -v /var/run/docker.sock:/var/run/docker.sock:ro \
+           -v nginx_conf:/etc/nginx \
+           -e ABSOLUTE_URI=https://admin.domain.com/webui/ \
+           bunkerity/bunkerized-nginx-ui
+```
+
+You will need to edit the `ABSOLUTE_URI` environment variable to reflect your actual URI of the web UI.
+
+We can now setup the bunkerized-nginx instance with the `bunkerized-nginx.UI` label and a reverse proxy configuration for our web UI :
 
 ```shell
 docker network create mynet
@@ -320,6 +332,7 @@ docker run -p 80:8080 \
            -e AUTO_LETS_ENCRYPT=yes \
            -e REDIRECT_HTTP_TO_HTTPS=yes \
            -e DISABLE_DEFAULT_SERVER=yes \
+           -e admin.domain.com_USE_MODSECURITY=no \
            -e admin.domain.com_SERVE_FILES=no \
            -e admin.domain.com_USE_AUTH_BASIC=yes \
            -e admin.domain.com_AUTH_BASIC_USER=admin \
@@ -331,16 +344,6 @@ docker run -p 80:8080 \
            bunkerity/bunkerized-nginx
 ```
 
-The `AUTH_BASIC` environment variables let you define a login/password that must be provided before accessing to the web UI. At the moment, there is no authentication mechanism integrated into bunkerized-nginx-ui.
+The `AUTH_BASIC` environment variables let you define a login/password that must be provided before accessing to the web UI. At the moment, there is no authentication mechanism integrated into bunkerized-nginx-ui so **using auth basic with a strong password coupled with a "hard to guess" URI is strongly recommended**.
 
-We can now create the bunkerized-nginx-ui container that will host the web UI behind bunkerized-nginx :
-
-```shell
-docker run --network mynet \
-           -v /var/run/docker.sock:/var/run/docker.sock:ro \
-           -v nginx_conf:/etc/nginx \
-           -e ABSOLUTE_URI=https://admin.domain.com/webui/ \
-           bunkerity/bunkerized-nginx-ui
-```
-
-After that, the web UI should be accessible from https://admin.domain.com/webui/.
+Web UI should now be accessible from https://admin.domain.com/webui/.

docs/requirements.txt

@@ -1,3 +1,4 @@
 sphinx
 sphinx-rtd-theme
 myst-parser
+sphinx-sitemap