v.7.1.0 (#165)

bfren · web-flow · commit 4f405cfa461b · 2024-11-19T15:06:48.000Z
Major updates
* Adding AI bots block by default
* Adding nginx-clear-logs executable and weekly periodic task

Minor updates
* Updating Nginx build

Build updates
* Updating GitHub workflow actions

Documentation updates
* Updating copyright year to 2024
diff --git a/.github/workflows/auto-pr.yml b/.github/workflows/auto-pr.yml
@@ -10,7 +10,7 @@ jobs:
     steps:
     -
       name: Checkout Branch ${{ github.ref_name }}
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     -
       name: Create Pull Request
       uses: bfren/pull-request@v2
diff --git a/.github/workflows/dev.yml b/.github/workflows/dev.yml
@@ -12,13 +12,13 @@ jobs:
     steps:
       -
         name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
   build:
     runs-on: ubuntu-latest
     steps:
       -
         name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Get repository name
         run: echo "REPOSITORY_NAME=$(echo '${{ github.repository }}' | awk -F '/' '{print $2}')" >> $GITHUB_ENV
@@ -31,20 +31,20 @@ jobs:
         id: version
       -
         name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
       -
         name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
       -
         name: Login to DockerHub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
       -
         name: Build and push
         id: docker_build
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v6
         with:
           build-args: |
             BF_IMAGE=${{ env.REPOSITORY_NAME }}
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -11,7 +11,7 @@ jobs:
     steps:
       -
         name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Get repository name
         run: echo "REPOSITORY_NAME=$(echo '${{ github.repository }}' | awk -F '/' '{print $2}')" >> $GITHUB_ENV
@@ -36,20 +36,20 @@ jobs:
         id: version
       -
         name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
       -
         name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
       -
         name: Login to DockerHub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
       -
         name: Build and push
         id: docker_build
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v6
         with:
           build-args: |
             BF_IMAGE=${{ env.REPOSITORY_NAME }}
diff --git a/.github/workflows/update-readme.yml b/.github/workflows/update-readme.yml
@@ -15,10 +15,10 @@ jobs:
         shell: bash
       -
         name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Login to DockerHub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2023 bfren
+Copyright (c) 2020-2024 bfren
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -83,4 +83,4 @@ The image contains a handful of useful Nginx configuration 'helper' files, which
 
 ## Copyright
 
-> Copyright (c) 2020-2023 [bfren](https://bfren.dev) (unless otherwise stated)
+> Copyright (c) 2020-2024 [bfren](https://bfren.dev) (unless otherwise stated)
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-7.0.5
+7.1.0
diff --git a/VERSION_MINOR b/VERSION_MINOR
@@ -1 +1 @@
-7.0
+7.1
diff --git a/overlay/etc/bf/templates/nginx-proxy.conf.esh b/overlay/etc/bf/templates/nginx-proxy.conf.esh
@@ -4,7 +4,7 @@
 #
 # Use environment variable PROXY_DOMAIN to change this file.
 #
-# Copyright (c) 2021-2023 bfren
+# Copyright (c) 2021-2024 bfren
 #======================================================================================================================
 
 #======================================================================================================================
@@ -39,19 +39,19 @@ server {
         return                      301 <%= "https://${DOMAIN_NAME}" %>$request_uri;
     }
 
-    # because he was a legend
-    include                         helpers/nginx-discworld.conf;
-
     # include secure headers
     include                         helpers/proxy-secure-headers.conf;
 
-    # include custom configuration
-    include                         <%= "${CUSTOM_CONF}/*.conf" %>;
-
     # include standard helpers
     include                         helpers/nginx-ignore-favicon.conf;
     include                         helpers/nginx-static-files.conf;
 
+    # include custom configuration
+    include                         <%= "${CUSTOM_CONF}/*.conf" %>;
+
+    # because he was a legend
+    include                         helpers/nginx-discworld.conf;
+
     # serve pages in <%= "${NGINX_PUBLIC}" %> (map volume to override default pages)
     root                            <%= "${NGINX_PUBLIC}" %>;
 
diff --git a/overlay/etc/bf/templates/nginx-site.conf.esh b/overlay/etc/bf/templates/nginx-site.conf.esh
@@ -15,7 +15,7 @@
 #   "custom": true
 # This will cause this file to be regenerated next time the container is started.
 #
-# Copyright (c) 2021-2023 bfren
+# Copyright (c) 2021-2024 bfren
 #======================================================================================================================
 <% else -%>
 #======================================================================================================================
@@ -29,7 +29,7 @@
 #   "custom": true
 # This will stop this file being generated next time the container is started.
 #
-# Copyright (c) 2021-2023 bfren
+# Copyright (c) 2021-2024 bfren
 #======================================================================================================================
 <% fi %>
 #======================================================================================================================
@@ -96,6 +96,9 @@ server {
         include                     helpers/proxy-params.conf;
         include                     helpers/proxy-secure-headers.conf;
 
+        # block AI bots
+        include                     helpers/nginx-block-ai-bots.conf;
+
     <% if [ "${PROXY_ENABLE_NAXSI-}" = "1" ] ; then -%>
         # enable NAXSI web application firewall with custom rules
         include                     helpers/naxsi.conf;
diff --git a/overlay/etc/nginx/helpers/nginx-block-ai-bots.conf b/overlay/etc/nginx/helpers/nginx-block-ai-bots.conf
@@ -0,0 +1,4 @@
+if ($http_user_agent ~* "(AdsBot-Google|Amazonbot|anthropic-ai|Applebot|Applebot-Extended|AwarioRssBot|AwarioSmartBot|Bytespider|CCBot|ChatGPT-User|Claude-Web|ClaudeBot|cohere-ai|DataForSeoBot|Diffbot|FacebookBot|FriendlyCrawler|Google-Extended|GoogleOther|GPTBot|ImagesiftBot|img2dataset|magpie-crawler|Meltwater|omgili|omgilibot|peer39_crawler|peer39_crawler/1.0|PerplexityBot|PiplBot|scoop.it|Seekr|SemrushBot|YandexBot|YouBot)"){
+    access_log off;
+    return 403;
+}
diff --git a/overlay/etc/periodic/weekly/clear-logs b/overlay/etc/periodic/weekly/clear-logs
@@ -0,0 +1,11 @@
+#!/command/with-contenv bash
+
+set -euo pipefail
+export BF_E=`basename ${0}`
+
+
+#======================================================================================================================
+# Clear access and error logs to prevent files getting huge.
+#======================================================================================================================
+
+nginx-clear-logs
diff --git a/overlay/tmp/NGINX_BUILD b/overlay/tmp/NGINX_BUILD
@@ -1 +1 @@
-1.24.0-r6
+1.24.0-r7
diff --git a/overlay/usr/bin/bf/nginx-clear-logs b/overlay/usr/bin/bf/nginx-clear-logs
@@ -0,0 +1,12 @@
+#!/command/with-contenv sh
+
+set -euo pipefail
+export BF_E=`basename ${0}`
+
+
+#======================================================================================================================
+# Echo an empty string to access and error logs.
+#======================================================================================================================
+
+echo "" > /var/log/nginx/access.log
+echo "" > /var/log/nginx/error.log

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ jobs:`
`10`	`10`	`steps:`
`11`	`11`	`-`
`12`	`12`	`name: Checkout Branch ${{ github.ref_name }}`
`13`		`- uses: actions/checkout@v3`
	`13`	`+ uses: actions/checkout@v4`
`14`	`14`	`-`
`15`	`15`	`name: Create Pull Request`
`16`	`16`	`uses: bfren/pull-request@v2`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ jobs:`
`11`	`11`	`steps:`
`12`	`12`	`-`
`13`	`13`	`name: Checkout code`
`14`		`- uses: actions/checkout@v3`
	`14`	`+ uses: actions/checkout@v4`
`15`	`15`	`-`
`16`	`16`	`name: Get repository name`
`17`	`17`	`run: echo "REPOSITORY_NAME=$(echo '${{ github.repository }}' \| awk -F '/' '{print $2}')" >> $GITHUB_ENV`
`@@ -36,20 +36,20 @@ jobs:`
`36`	`36`	`id: version`
`37`	`37`	`-`
`38`	`38`	`name: Set up QEMU`
`39`		`- uses: docker/setup-qemu-action@v2`
	`39`	`+ uses: docker/setup-qemu-action@v3`
`40`	`40`	`-`
`41`	`41`	`name: Set up Docker Buildx`
`42`		`- uses: docker/setup-buildx-action@v2`
	`42`	`+ uses: docker/setup-buildx-action@v3`
`43`	`43`	`-`
`44`	`44`	`name: Login to DockerHub`
`45`		`- uses: docker/login-action@v2`
	`45`	`+ uses: docker/login-action@v3`
`46`	`46`	`with:`
`47`	`47`	`username: ${{ secrets.DOCKERHUB_USERNAME }}`
`48`	`48`	`password: ${{ secrets.DOCKERHUB_TOKEN }}`
`49`	`49`	`-`
`50`	`50`	`name: Build and push`
`51`	`51`	`id: docker_build`
`52`		`- uses: docker/build-push-action@v4`
	`52`	`+ uses: docker/build-push-action@v6`
`53`	`53`	`with:`
`54`	`54`	`build-args: \|`
`55`	`55`	`BF_IMAGE=${{ env.REPOSITORY_NAME }}`
Original file line number	Diff line number	Diff line change
`@@ -15,10 +15,10 @@ jobs:`
`15`	`15`	`shell: bash`
`16`	`16`	`-`
`17`	`17`	`name: Checkout code`
`18`		`- uses: actions/checkout@v3`
	`18`	`+ uses: actions/checkout@v4`
`19`	`19`	`-`
`20`	`20`	`name: Login to DockerHub`
`21`		`- uses: docker/login-action@v2`
	`21`	`+ uses: docker/login-action@v3`
`22`	`22`	`with:`
`23`	`23`	`username: ${{ secrets.DOCKERHUB_USERNAME }}`
`24`	`24`	`password: ${{ secrets.DOCKERHUB_TOKEN }}`
Original file line number	Diff line number	Diff line change
`@@ -83,4 +83,4 @@ The image contains a handful of useful Nginx configuration 'helper' files, which`
`83`	`83`
`84`	`84`	`## Copyright`
`85`	`85`
`86`		`-> Copyright (c) 2020-2023 [bfren](https://bfren.dev) (unless otherwise stated)`
	`86`	`+> Copyright (c) 2020-2024 [bfren](https://bfren.dev) (unless otherwise stated)`