v2.5.0 (#64)

bfren · web-flow · commit 5e760ed57cbc · 2021-12-03T12:45:02.000Z
Major updates
* Using latest base image
* `nginx-regenerate`: Check against `NGXCONF` array before deleting configuration

Minor updates
* Moving load conf to separate inc
* Adding standard double newline to inc scripts

Build updates
* Adding image name / version to builds
diff --git a/.github/workflows/dev.yml b/.github/workflows/dev.yml
@@ -21,6 +21,10 @@ jobs:
       -
         name: Checkout code
         uses: actions/checkout@v2
+      -
+        name: Get repository name
+        run: echo "REPOSITORY_NAME=$(echo '${{ github.repository }}' | awk -F '/' '{print $2}')" >> $GITHUB_ENV
+        shell: bash
       -
         name: Read image version
         uses: bfren/read-file@v1
@@ -44,6 +48,9 @@ jobs:
         id: docker_build
         uses: docker/build-push-action@v2
         with:
+          build-args: |
+            BF_IMAGE=${{ env.REPOSITORY_NAME }}
+            BF_VERSION=${{ steps.version.outputs.contents }}
           push: ${{ startsWith(github.ref, 'refs/heads/') }}
           platforms: linux/amd64,linux/arm/v7,linux/arm64
           tags: |
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -12,6 +12,10 @@ jobs:
       -
         name: Checkout code
         uses: actions/checkout@v2
+      -
+        name: Get repository name
+        run: echo "REPOSITORY_NAME=$(echo '${{ github.repository }}' | awk -F '/' '{print $2}')" >> $GITHUB_ENV
+        shell: bash
       -
         name: Read image version
         uses: bfren/read-file@v1
@@ -47,6 +51,9 @@ jobs:
         id: docker_build
         uses: docker/build-push-action@v2
         with:
+          build-args: |
+            BF_IMAGE=${{ env.REPOSITORY_NAME }}
+            BF_VERSION=${{ steps.version.outputs.contents }}
           push: true
           platforms: linux/amd64,linux/arm/v7,linux/arm64
           tags: |
diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,7 @@
-FROM bfren/nginx:nginx1.20-2.3.0
+FROM bfren/nginx:nginx1.20-2.4.0
+
+ARG BF_IMAGE
+ARG BF_VERSION
 
 # port 80 is already exposed by the base image
 EXPOSE 443
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-2.4.0
+2.5.0
diff --git a/VERSION_MINOR b/VERSION_MINOR
@@ -1 +1 @@
-2.4
+2.5
diff --git a/overlay/usr/lib/bf/inc/proxy-check.sh b/overlay/usr/lib/bf/inc/proxy-check.sh
@@ -1,5 +1,6 @@
 #!/usr/bin/with-contenv bash
 
+
 #======================================================================================================================
 # Ensure PROXY_URI is set.
 #======================================================================================================================
@@ -24,17 +25,7 @@ fi
 # Create arrays and include configuration.
 #======================================================================================================================
 
-SSL_CONF=${PROXY_SSL}/conf.sh
-if [ ! -f ${SSL_CONF} ] ; then
-    bf-error "You must create ${SSL_CONF} - see ssl-conf-sample.sh."
-    exit 1
-fi
-
-declare -A DOMAINS
-declare -A ALIASES
-declare -A NGXCONF
-
-source ${SSL_CONF}
+source ${BF_INC}/proxy-load-conf.sh
 
 
 #======================================================================================================================
diff --git a/overlay/usr/lib/bf/inc/proxy-load-conf.sh b/overlay/usr/lib/bf/inc/proxy-load-conf.sh
@@ -0,0 +1,18 @@
+#!/usr/bin/with-contenv bash
+
+
+#======================================================================================================================
+# Create arrays and include configuration.
+#======================================================================================================================
+
+SSL_CONF=${PROXY_SSL}/conf.sh
+if [ ! -f ${SSL_CONF} ] ; then
+    bf-error "You must create ${SSL_CONF} - see ssl-conf-sample.sh."
+    exit 1
+fi
+
+declare -A DOMAINS
+declare -A ALIASES
+declare -A NGXCONF
+
+source ${SSL_CONF}
diff --git a/overlay/usr/lib/bf/inc/proxy-replace.sh b/overlay/usr/lib/bf/inc/proxy-replace.sh
@@ -1,5 +1,6 @@
 #!/usr/bin/with-contenv bash
 
+
 #======================================================================================================================
 # Replace a key/value pair in a file.
 #
diff --git a/overlay/usr/lib/bf/inc/proxy-setup-global.sh b/overlay/usr/lib/bf/inc/proxy-setup-global.sh
@@ -1,5 +1,6 @@
 #!/usr/bin/with-contenv bash
 
+
 #======================================================================================================================
 # Set up global configuration.
 #======================================================================================================================
diff --git a/overlay/usr/lib/bf/inc/proxy-setup-nginx.sh b/overlay/usr/lib/bf/inc/proxy-setup-nginx.sh
@@ -1,5 +1,6 @@
 #!/usr/bin/with-contenv bash
 
+
 #======================================================================================================================
 # Set up Nginx.
 #
diff --git a/overlay/usr/lib/bf/inc/proxy-setup-ssl.sh b/overlay/usr/lib/bf/inc/proxy-setup-ssl.sh
@@ -1,5 +1,6 @@
 #!/usr/bin/with-contenv bash
 
+
 #======================================================================================================================
 # Generate a temporary SSL certificate and key.
 #
diff --git a/overlay/usr/local/bin/nginx-regenerate b/overlay/usr/local/bin/nginx-regenerate
@@ -5,11 +5,69 @@ export BF_E=`basename ${0}`
 
 
 #======================================================================================================================
-# Delete Nginx configuration files and reinitialise.
+# Executable usage.
 #======================================================================================================================
 
-bf-echo "Removing Nginx configuration files..."
-bf-rmrf "${PROXY_SITES}/*.conf"
+usage () {
+    echo "Regenerate Nginx configuration files."
+    echo "Usage: `basename ${0}` [-f] [-h]" 2>&1
+    echo "    -f    Force all configuration files to be deleted (even custom ones)."
+    echo "    -h    Show this usage message."
+    exit 2
+}
+
+MODE=0
+while getopts ":hf" C ; do
+    case ${C} in
+        h) usage ;;
+        f) FORCE=1 ;;
+        ?) bf-notok "Invalid option: -${OPTARG}" "nginx-regenerate" && usage ;;
+    esac
+done
+
+
+#======================================================================================================================
+# Load SSL configuration.
+#======================================================================================================================
+
+bf-echo "Loading SSL configuration."
+source ${BF_INC}/proxy-load-conf.sh
+bf-debug "Loaded: ${!DOMAINS[*]}."
+
+
+#======================================================================================================================
+# Delete Nginx configuration files.
+#======================================================================================================================
+
+bf-echo "Getting Nginx sites configuration."
+NGINX_CONFIGS=(${PROXY_SITES}/*)
+
+bf-echo "Checking against configured domains..."
+for CFG in "${NGINX_CONFIGS[@]}" ; do
+
+    # do nothing if this is a file
+    [[ -f "${CFG}" ]] && continue
+
+    # get name and strip .d from end of directory
+    NAME=$(basename -- "${CFG}")
+    STRIPPED=${NAME::-2}
+    bf-debug " .. ${STRIPPED}"
+
+    # unless the force switch is enabled, if the domain has custom config, don't delete
+    if [[ "${FORCE-}" = "1" ]] || [[ -z "${NGXCONF[${STRIPPED}]-}" ]] ; then
+        bf-debug " .. standard config or force enabled: remove"
+        rm -rf ${PROXY_SITES}/${STRIPPED}*
+    else
+        bf-debug " .. custom config and force not enabled: leave"
+    fi
+
+done
+
 bf-done
 
+
+#======================================================================================================================
+# Reinitialise.
+#======================================================================================================================
+
 ssl-init
diff --git a/overlay/usr/local/bin/ssl-cleanup b/overlay/usr/local/bin/ssl-cleanup
@@ -10,7 +10,7 @@ export BF_E=`basename ${0}`
 
 usage () {
     echo "Cleanup unused SSL and Nginx configuration files."
-    echo "Usage: `basename ${0}` [-d] [-h]" 2>&1
+    echo "Usage: `basename ${0}` [-m] [-h]" 2>&1
     echo "    -m    Mode: 0 = dry run (default), 1 = perform deletions."
     echo "    -h    Show this usage message."
     exit 2
@@ -56,12 +56,7 @@ remove () {
 #======================================================================================================================
 
 bf-echo "Loading SSL configuration."
-
-declare -A DOMAINS
-declare -A ALIASES
-declare -A NGXCONF
-
-source ${PROXY_SSL}/conf.sh
+source ${BF_INC}/proxy-load-conf.sh
 bf-debug "Loaded: ${!DOMAINS[*]}."
 
 

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`#!/usr/bin/with-contenv bash`
`2`	`2`
	`3`	`+`
`3`	`4`	`#======================================================================================================================`
`4`	`5`	`# Replace a key/value pair in a file.`
`5`	`6`	`#`