staticweb_filebrowser recipe: includable nginx stub added to the staticweb

.recipes/staticweb_filebrowser/.templates/nginx/nginx_filebrowser.inc

@@ -0,0 +1,28 @@
+    # Includable nginx configuration.
+    #
+    # Additional Filebrowser service.
+    # Take a look to the proxy port setting.
+    location ~ /(api|files|login|static) {
+        proxy_pass http://localhost:$PAR_PROXYPORT;
+        error_page 500 502 503 504 @proxy_error;
+
+        client_max_body_size 1G;
+        keepalive_timeout 30;
+        proxy_read_timeout  300;
+
+        proxy_request_buffering on;
+        proxy_buffers 2048 16k;
+        proxy_buffer_size 16k;
+
+        proxy_set_header X-Forwarded-Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header Host $host;
+        proxy_set_header X-Forwarded-Server $host;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+
+        #websockets
+        proxy_http_version  1.1;
+        proxy_set_header    Upgrade     $http_upgrade;
+        proxy_set_header Connection "upgrade";
+    }

.templates/bin/rotate_folder

@@ -55,6 +55,9 @@
 # Author: Kovács Zoltán <kovacs.zoltan@smartfront.hu>
 #         Kovács Zoltán <kovacsz@marcusconsulting.hu>
 # License: GNU/GPL v3+ (https://www.gnu.org/licenses/gpl-3.0.en.html)
+# 2025-03-06 v1.1
+# new: added the --noconf option which prevents reading and creating
+#      the configuration file.
 # 2023-06-18 v1.0
 # new: forked from the "SMARTERP_skeleton" repository.
 # 2021.02.12 v0.3
@@ -77,6 +80,7 @@ RETAIN_MONTHS=${RETAIN_MONTHS-"12"}
 # Other initialisations (maybe overridden by configuration).
 #
 DOIT=""
+NOCONF=""
 
 # Messages (maybe overriden by configuration).
 #
@@ -106,6 +110,7 @@ do
     case ${option} in
         "-" )
             if   [ "$OPTARG" = "doit" ]; then DOIT="yes"
+            elif [ "$OPTARG" = "noconf" ]; then NOCONF="yes"
 	    else echo "$MSG_BADOPT --$OPTARG" >&2; exit 1
             fi
         ;;
@@ -135,9 +140,10 @@ BACKUP_FOLDER=${BACKUP_FOLDER%/}
 if [ -z "$BACKUP_FOLDER" -o ! -d "$BACKUP_FOLDER" -o ! -w "$BACKUP_FOLDER" ]
 then echo -e "$MSG_BADFOLDER $BACKUP_FOLDER" >&2; exit 1; fi
 
-# Gets the configuration (if any).
+# Applies the configuration (if it exists and if it doesn't need to be ignored).
 BACKUP_CONF="$BACKUP_FOLDER/.$("$BASENAME" "$0").conf"
-if [ -r $BACKUP_CONF ]; then . "$BACKUP_CONF"
+if [ "$NOCONF" = "yes" ]; then :
+elif [ -r $BACKUP_CONF ]; then . "$BACKUP_CONF"
 else
     # Warns about failure.
     echo -e "$MSG_NOCONF $BACKUP_CONF"

.templates/nginx/nginx.conf

@@ -67,24 +67,15 @@ server {
                 You may report this at <a href='mailto:$server_admin'>$server_admin</a>.</span>";
     }
     #
-    # Static service.
+    # Optional export backups function.
-#   location / {
+    # Needs ACLs, see the include file.
-#       root $PAR_SERVICE/storage/volumes/staticweb/;
+    #include $PAR_SERVICE/configs/nginx_xport.inc;
-#       allow all;
-#       autoindex off;
-#       index index.html index.htm;
-#       try_files $ri $uri/ =404;
-#   }
     #
-    # No static service, but we may provide the OPTIONS for a potential DAV client.
+    # Optional simple static service.
-#   location / {
+    #include $PAR_SERVICE/configs/nginx_static.inc;
-#       types { } default_type text/html;
+    #
-##      dav_ext_methods OPTIONS;
+    # Optional simple disabled-static servioe.
-#       if ($request_method != OPTIONS) {
+    #include $PAR_SERVICE/configs/nginx_nostatic.inc;
-#           return 404 "<span style='font-size: x-large'>Sorry try <a href='$scheme://$server_name/$PAR_LOCATION'>$scheme://$server_name/$PAR_LOCATION</a> instead.</span>";
-##          return 302 $scheme://$server_name/$PAR_LOCATION;
-#	}
-#   }
 
     ##################################################################################
     # The SSL part

.templates/nginx/nginx_nostatic.inc

@@ -0,0 +1,11 @@
+    # Includable nginx configuration.
+    #
+    # A simple no-static service.
+    location / {
+        types { } default_type text/html;
+#       dav_ext_methods OPTIONS;
+        if ($request_method != OPTIONS) {
+            return 404 "<span style='font-size: x-large'>Sorry try <a href='$scheme://$server_name/$PAR_LOCATION'>$scheme://$server_name/$PAR_LOCATION</a> instead.</span>";
+#           return 302 $scheme://$server_name/$PAR_LOCATION;
+        }
+    }

.templates/nginx/nginx_static.inc

@@ -0,0 +1,10 @@
+    # Includable nginx configuration.
+    #
+    # A simple static service.
+    location / {
+        root $PAR_SERVICE/storage/volumes/staticweb/;
+        allow all;
+        autoindex off;
+        index index.html index.htm;
+        try_files $ri $uri/ =404;
+    }

.templates/nginx/nginx_xport.inc

@@ -0,0 +1,18 @@
+    # Includable nginx configuration.
+    #
+    # Export backups feature.
+    # Needs
+    #   setfacl -m u:www-data:r    [...]/configs/xport_backup
+    #   setfacl -m u:www-data:rx   [...]/storage/backups
+    #   setfacl -d -m u:www-data:r [...]/storage/backups/export
+    # ACLs.
+    location /export {
+        root $PAR_SERVICE/storage/backups;
+        auth_basic "Export backups area";
+        auth_basic_user_file $PAR_SERVICE/configs/xport_backup;
+        allow all;
+        autoindex on;
+        autoindex_exact_size off;
+        autoindex_format html;
+        autoindex_localtime on;
+    }

configs/.gitignore

@@ -1,4 +1,5 @@
 # Ignore everything else in this directory.
 *
 !certs
+!xport_backup
 !.gitignore

configs/xport_backup

@@ -0,0 +1,3 @@
+# Credentials file for exported backups feature.
+# Needs username:apr1-hashed password entries, one per line.
+# Use https://htpasswd.utils.com/ or some similar to fill in.

storage/.gitignore

@@ -0,0 +1,5 @@
+# Ignore everything in this directory except this folders.
+*
+!.gitignore
+!backups
+!volumes

storage/backups/.gitignore

@@ -0,0 +1,5 @@
+# Ignore everything in this directory except these files.
+*
+!.gitignore
+!export
+!tarballs

storage/backups/export/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory except this file.
+*
+!.gitignore
+!.rotate_folder.conf

storage/backups/export/.rotate_folder.conf

@@ -0,0 +1,9 @@
+# This is a shell script excerpt for configuration purposes only.
+# Handle with care! Please don't put code here, only variables.
+
+CLASSES_PATTERN="^([^.]*)\..*\.$HOSTNAME\.(dmp|sql\.gz|tgz|log)$"
+DOIT="yes"                      # if empty the script makes a dry run
+RETAIN_DAYS=7                   # retains all files created within that many days
+RETAIN_WEEKS=0                  # retains one file per week/month,
+RETAIN_MONTHS=0                 # created within that many weeks/months
+

tools/backup.d/xport_backup.sh

@@ -0,0 +1,105 @@
+#!/bin/bash
+#
+# Optional additional backup operation, intended to export an (almost)
+# up-to-date downloadable copy for our customers about their data
+# handled by us. The script synchronizes some of the existing backup
+# files to an export folder that can be downloaded from the web.
+#
+# Uses the rotate_folder tool to select files to synchronize.
+# This tool must be somewhere in the path.
+#
+# Author: Kovács Zoltán <kovacsz@marcusconsulting.hu>
+# License: GNU/GPL v3+ (https://www.gnu.org/licenses/gpl-3.0.en.html)
+# 2025-03-06 v0.1 Initial release
+
+# Accepted environment variables and their defaults.
+PAR_BASEDIR=${PAR_BASEDIR:-""}                  # Service's base folder
+PAR_DUMPDIR=${PAR_DUMPDIR:-""}                  # Absolute path to DB dumps
+PAR_EXPORTDIR=${PAR_EXPORTDIR:-""}              # Absolute path to export dir
+PAR_RETAINDAYS=${PAR_RETAINDAYS:-"1"}		# Days to retain the copies
+PAR_TARBALLDIR=${PAR_TARBALLDIR:-""}            # Absolute path to tgz dumps
+
+# Other initialisations.
+CLASSES_PATTERN="^([^.]*)\..*\.$HOSTNAME\.(dmp|sql\.gz|tgz|log)$"
+DUMPPATH="storage/backups/dumps"                # Default path to DB dumps
+EXPORTPATH="storage/backups/export"             # Default path to export dir
+TARBALLPATH="storage/backups/tarballs"          # Default path to tgz dumps
+USER=${USER:-LOGNAME}                           # Fix for cron enviroment only
+YMLFILE="docker-compose.yml"
+
+# Messages.
+MSG_MISSINGDEP="Fatal: missing dependency"
+MSG_MISSINGYML="Fatal: didn't find the docker-compose.yml file"
+MSG_NONWRITE="The target directory isn't writable"
+
+# Checks the dependencies.
+TR=$(which tr 2>/dev/null)
+if [ -z "$TR" ]; then echo "$MSG_MISSINGDEP tr."; exit 1 ; fi
+for item in cp cut date dirname grep hostname readlink rotate_folder tar
+do
+    if [ -n "$(which $item)" ]
+    then export $(echo $item | "$TR" '[:lower:]' '[:upper:]' | "$TR" '-' '_')=$(which $item)
+    else echo "$MSG_MISSINGDEP $item." >&2; exit 1; fi
+done
+
+# Where I'm?
+# https://gist.github.com/TheMengzor/968e5ea87e99d9c41782
+SOURCE="$0"
+while [ -h "$SOURCE" ]; do
+    # resolve $SOURCE until the file is no longer a symlink
+    SCRPATH="$( cd -P "$("$DIRNAME" "$SOURCE" )" && pwd )" #"
+    SOURCE="$("$READLINK" "$SOURCE")"
+    # if $SOURCE was a relative symlink, we need to resolve it
+    # relative to the path where the symlink file was located
+    [[ $SOURCE != /* ]] && SOURCE="$SCRPATH/$SOURCE"
+done; SCRPATH="$( cd -P "$("$DIRNAME" "$SOURCE" )" && pwd )" #"
+
+# Searches the base folder, containing a docker-compose.yml file.
+# Called from the base folder (./)?
+BASE_DIR="$PAR_BASEDIR"
+TEST_DIR="$SCRPATH"
+[[ -z "$BASE_DIR" ]] && [[ -r "$TEST_DIR/$YMLFILE" ]] && BASE_DIR="$TEST_DIR"
+# Called from ./tools?
+TEST_DIR="$("$DIRNAME" "$TEST_DIR")"
+[[ -z "$BASE_DIR" ]] && [[ -r "$TEST_DIR/$YMLFILE" ]] && BASE_DIR="$TEST_DIR"
+# Called from ./tools/*.d?
+TEST_DIR="$("$DIRNAME" "$TEST_DIR")"
+[[ -z "$BASE_DIR" ]] && [[ -r "$TEST_DIR/$YMLFILE" ]] && BASE_DIR="$TEST_DIR"
+# On failure gives it up here.
+if [ -z "$BASE_DIR" -o ! -r "$BASE_DIR/$YMLFILE" ]; then
+    echo "$MSG_MISSINGYML" >&2; exit 1
+fi
+# Sets the absolute paths.
+DUMPDIR="${PAR_DUMPDIR:-$BASE_DIR/$DUMPPATH}"
+EXPORTDIR="${PAR_EXPORTDIR:-$BASE_DIR/$EXPORTPATH}"
+TARBALLDIR="${PAR_TARBALLDIR:-$BASE_DIR/$TARBALLPATH}"
+
+# Exits silently if EXPORTDIR isn't present.
+[[ ! -e "$EXPORTDIR" ]] && exit 0
+# EXPORTDIR must be writable.
+[[ ! -w "$EXPORTDIR" ]] \
+&& echo "$MSG_NONWRITE: $BACKUPDIR" >&2 && exit 1
+
+# Let's select and copy the appropriate backup files.
+#
+# We'll call rotate_folder (dry run) with CLASSES_PATTERN and PAR_RETAINDAYS
+# set above to select relevant files created in the backup folders within last
+# PAR_RETAINDAYS days. These files are synchronized with the cp -u statement.
+#
+# Enumerates the folders.
+for folder in "$DUMPDIR" "$TARBALLDIR"
+do
+    # Selects the appropriate files (which have the "DR" - daily retain - tag).
+    for filename in $((export CLASSES_PATTERN="$CLASSES_PATTERN" \
+                              RETAIN_DAYS="$PAR_RETAINDAYS" RETAIN_WEEKS=0 RETAIN_MONTHS=0; \
+                       "$ROTATE_FOLDER" --noconf -f "$folder") | \
+                      "$GREP" '^DR ' | "$CUT" -d' ' -f2) ""
+    do
+	# Updates the current file.
+	if [ -n "$filename" ]; then
+	    "$CP" -u "$folder/$filename" "$EXPORTDIR/" 2>/dev/null
+	fi
+    done
+done
+
+# That's all, Folks! :)

tools/customize_nginx.sh

@@ -1,11 +1,11 @@
 #!/bin/bash
 
-PAR_SERVICENAME=
+PAR_SERVICENAME=""
 PAR_PROXYHOST="localhost"
 PAR_PROXYPORT="8201"
 PAR_SERVERNAME="myservice.example.com"
 PAR_LOCATION=
-PAR_WEBMASTER="webmaster@example.com"  # Valid support email address
+PAR_WEBMASTER="webmaster@example.com"	# Valid support email address
 
 ################################################################################
 # There is nothing to change below this line (I hope)
@@ -18,8 +18,13 @@ PAR_SERVICE="$HOME/services/$PAR_SERVICENAME"
 PARAMETERS='$PAR_ACMEHOST:$PAR_ACMEPORT:$PAR_SERVICE:$PAR_PROXYHOST:$PAR_PROXYPORT:$PAR_SERVERNAME:$PAR_LOCATION:$PAR_WEBMASTER'
 for parameter in $(echo "$PARAMETERS" | tr ":" "\n")
 do export ${parameter:1}; done
-cat "$PAR_SERVICE/.templates/nginx/nginx.conf" | envsubst "$PARAMETERS" \
+for template in $(cd "$PAR_SERVICE/.templates/nginx/"; ls -1 nginx*) ""
-  > "$PAR_SERVICE/configs/nginx.conf"
+do
+    if [ -n "$template" ]; then
+	cat "$PAR_SERVICE/.templates/nginx/$template" | envsubst "$PARAMETERS" \
+	  > "$PAR_SERVICE/configs/$template"
+    fi
+done
 
 touch      $PAR_SERVICE/logs/web/access.log $PAR_SERVICE/logs/web/error.log
 chmod 660  $PAR_SERVICE/logs/web/access.log $PAR_SERVICE/logs/web/error.log