v6.0.0 (#129)

bfren · web-flow · commit d644fce567ee · 2023-11-22T09:10:01.000Z
**Complete rewrite using [nushell](https://nushell.sh)** ## Major updates and breaking changes * All environment variables now begin `BF_NGINX_WEBDAV` ## Build updates * Updating workflows to latest versions * Using -dev instead of -beta for development builds ## Development updates * Enforcing LF line endings
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,2 @@
+# Always use LF endings.
+* text eol=lf
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@v5
         with:
           build-args: |
             BF_IMAGE=${{ env.REPOSITORY_NAME }}
@@ -53,7 +53,7 @@ jobs:
           platforms: linux/amd64,linux/arm/v7,linux/arm64
           tags: |
             bfren/nginx-webdav:dev
-            bfren/nginx-webdav:${{ steps.version.outputs.contents }}-beta
+            bfren/nginx-webdav:${{ steps.version.outputs.contents }}-dev
       -
         name: Image digest
         run: echo ${{ steps.docker_build.outputs.digest }}
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@v5
         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/Dockerfile b/Dockerfile
@@ -1,16 +1,16 @@
-FROM bfren/nginx:nginx1.24-5.0.16
+FROM bfren/nginx:nginx1.24-alpine3.18-6.0.0
 
 LABEL org.opencontainers.image.source="https://github.com/bfren/docker-nginx-webdav"
 
 ARG BF_IMAGE
 ARG BF_VERSION
 
+COPY ./overlay /
+
 ENV \
     # set to "r" or "rw" (without quotes) to enable read-only / read-write access
-    WEBDAV_ACCESS=r \
+    BF_NGINX_WEBDAV_ACCESS=r \
     # set to "PUT DELETE MKCOL COPY MOVE" (or any variation, without quotes) to enable full write access
-    WEBDAV_METHODS=off
-
-COPY ./overlay /
+    BF_NGINX_WEBDAV_METHODS=off
 
 RUN bf-install
diff --git a/README.md b/README.md
@@ -22,8 +22,8 @@ By default files are served read-only - change two environment variables to enab
 
 | Variable         | Values      | Description                                                              | Default |
 | ---------------- | ----------- | ------------------------------------------------------------------------ | ------- |
-| `WEBDAV_ACCESS`  | 'r' or 'rw' | Set to 'r' for read-only or 'rw' for read/write access (without quotes). | r       |
-| `WEBDAV_METHODS` | string      | For full write access set to 'PUT DELETE MKCOL COPY MOVE'.               | off     |
+| `NGINX_WEBDAV_ACCESS`  | 'r' or 'rw' | Set to 'r' for read-only or 'rw' for read/write access (without quotes). | r       |
+| `NGINX_WEBDAV_METHODS` | string      | For full write access set to 'PUT DELETE MKCOL COPY MOVE'.               | off     |
 
 ## Licence
 
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-5.1.10
+6.0.0
diff --git a/VERSION_MAJOR b/VERSION_MAJOR
@@ -1 +1 @@
-5
+6
diff --git a/VERSION_MINOR b/VERSION_MINOR
@@ -1 +1 @@
-5.1
+6.0
diff --git a/overlay/etc/bf/init.d/12-public b/overlay/etc/bf/init.d/12-public
diff --git a/overlay/etc/bf/init.d/12-public.nu b/overlay/etc/bf/init.d/12-public.nu
@@ -0,0 +1,5 @@
+use bf
+bf env load
+
+# don't do anything
+def main [] { }
diff --git a/overlay/etc/bf/init.d/20-env b/overlay/etc/bf/init.d/20-env
diff --git a/overlay/etc/bf/init.d/20-env.nu b/overlay/etc/bf/init.d/20-env.nu
@@ -0,0 +1,10 @@
+use bf
+bf env load
+
+# Set environment variables
+def main [] {
+    bf env set NGINX_WEBDAV_EXT_METHODS "PROPFIND OPTIONS"
+
+    # return nothing
+    return
+}
diff --git a/overlay/etc/bf/init.d/21-config b/overlay/etc/bf/init.d/21-config
diff --git a/overlay/etc/bf/init.d/21-config.nu b/overlay/etc/bf/init.d/21-config.nu
@@ -0,0 +1,8 @@
+use bf
+bf env load
+
+# Generate nginx configuration file
+def main [] {
+    bf write "Generating nginx configuration file."
+    bf esh template $"(bf env NGINX_ETC_SITES)/localhost.conf"
+}
diff --git a/overlay/etc/bf/templates/localhost.conf.esh b/overlay/etc/bf/templates/localhost.conf.esh
@@ -2,13 +2,13 @@ server {
     listen                          80;
     listen                          [::]:80;
 
-    root                            <%= ${NGINX_WWW} %>;
+    root                            <% bf-env NGINX_WWW %>;
 
     autoindex                       on;
 
-    dav_access                      all:<%= "${WEBDAV_ACCESS}" %>;
-    dav_methods                     <%= "${WEBDAV_METHODS}" %>;
-    dav_ext_methods                 <%= "${WEBDAV_EXT_METHODS}" %>;
+    dav_access                      all:<% bf-env NGINX_WEBDAV_ACCESS %>;
+    dav_methods                     <% bf-env NGINX_WEBDAV_METHODS %>;
+    dav_ext_methods                 <% bf-env NGINX_WEBDAV_EXT_METHODS %>;
 
     client_body_temp_path           /tmp;
 
@@ -17,5 +17,5 @@ server {
     proxy_max_temp_file_size        0;
     proxy_buffering                 off;
 
-    include                         helpers/nginx-uploads.conf;
+    include                         helpers/uploads.conf;
 }
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/tmp/install b/overlay/tmp/install
@@ -1,24 +1,14 @@
-#!/bin/sh
+#!/usr/bin/nu
 
-set -euo pipefail
-export BF_E=`basename ${0}`
+use bf
 
+# Setup and install nginx
+def main [] {
+    # get nginx version and install WebDAV module
+    let version = bf fs read /tmp/NGINX_BUILD
+    bf write $"Installing nginx v($version) WebDAV extension."
+    bf pkg install [$"nginx-mod-http-dav-ext=($version)"]
 
-#======================================================================================================================
-# Get Nginx Version.
-#======================================================================================================================
-
-cd /tmp
-
-VERSION=$(cat NGINX_BUILD)
-bf-echo "Nginx version ${VERSION}."
-
-
-#======================================================================================================================
-# Install Nginx WebDAV extension and dependencies.
-#======================================================================================================================
-
-bf-echo "Installing Nginx v${VERSION} WebDAV extension..."
-apk add --no-cache \
-    nginx-mod-http-dav-ext=${VERSION}
-bf-done
+    # add bf-nginx-webdav module to config
+    bf config use bf-nginx-webdav
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# Always use LF endings.`
	`2`	`+* text eol=lf`
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@v5`
`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 }}`