Added:

- Dockerfile and related documentation
Fixed:
- shasum was missing in requirements check
- References to URL file removed

Author: kryptonianson

.devcontainer/devcontainer.json

@@ -20,7 +20,9 @@
 				"yzhang.markdown-all-in-one",
 				"christian-kohler.path-intellisense",
 				"esbenp.prettier-vscode",
-				"foxundermoon.shell-format"
+				"foxundermoon.shell-format",
+				"ms-azuretools.vscode-docker",
+				"Gruntfuggly.todo-tree"
 			]
 		}
 	}

.vscode/settings.json

@@ -1,7 +1,17 @@
 {
     "cSpell.words": [
+        "Anson",
+        "binarynoir",
+        "cirolosapio",
         "coreutils",
+        "devcontainers",
+        "esbenp",
+        "foxundermoon",
+        "Ganepola",
         "grealpath",
+        "Gruntfuggly",
+        "kohler",
+        "libnotify",
         "mandb",
         "mktemp",
         "msys",
@@ -11,7 +21,11 @@
         "noscript",
         "nslookup",
         "osascript",
+        "pacman",
         "realpath",
-        "subshell"
+        "rogalmic",
+        "Sanjula",
+        "subshell",
+        "yzhang"
     ]
 }

CHANGELOG.md

@@ -9,6 +9,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - none
 
+## [1.3.1] - 2024-12-20
+
+### Added
+
+- Dockerfile and related documentation
+
+### Fixed
+
+- shasum was missing in requirements check
+- References to URL file removed
+
 ## [1.3.0] - 2024-12-20
 
 ### Added

Dockerfile

@@ -0,0 +1,41 @@
+FROM alpine:latest
+
+# Upgrade all installed packages and install necessary packages
+RUN apk upgrade && \
+    apk add --no-cache bash coreutils jq curl libxml2-utils perl-utils
+
+# Set the working directory
+WORKDIR /app
+
+# Fetch the latest release tar.gz from GitHub
+RUN curl -L \
+    -H "Accept: application/vnd.github+json" \
+    -H "X-GitHub-Api-Version: 2022-11-28" \
+    https://api.github.com/repos/binarynoir/noirwatch/releases/latest | \
+    jq -r '.tarball_url' | \
+    xargs curl -L -o /tmp/noirwatch.tar.gz
+
+# Create the temporary directory and extract the tarball
+RUN mkdir -p /tmp/noirwatch && \
+    tar -xzf /tmp/noirwatch.tar.gz -C /tmp/noirwatch --strip-components=1
+
+# Copy the noirwatch script to /usr/local/bin
+RUN cp /tmp/noirwatch/noirwatch /usr/local/bin/noirwatch
+
+# Copy the man page to the appropriate location
+RUN mkdir -p /usr/share/man/man1 && \
+    cp /tmp/noirwatch/noirwatch.1 /usr/share/man/man1/noirwatch.1
+
+# Clean up the temporary files
+RUN rm -rf /tmp/noirwatch /tmp/noirwatch.tar.gz
+
+# Make the script executable
+RUN chmod +x /usr/local/bin/noirwatch
+
+# Run noirwatch --init during the build process
+ENV NOIRWATCH_CONFIG="/app/noirwatch.json"
+ENV NOIRWATCH_CACHE="/app/cache"
+RUN /usr/local/bin/noirwatch --init -c "$NOIRWATCH_CONFIG" -C "$NOIRWATCH_CACHE"
+
+# Set the CMD to run the startup script and keep the container running
+CMD ["/bin/sh", "-c", "/usr/local/bin/noirwatch -c '/app/noirwatch.json' --start && tail -f /dev/null"]

README.md

@@ -34,6 +34,7 @@ NoirWatch monitors specified websites for changes and sends notifications. It su
 - Bash 4.0+
 - `curl` for fetching website content
 - `sed` for HTML content normalization
+- `shasum` for change comparisons
 - `timeout` for custom command files
 - `xmllint` for HTML content normalization
 - `powershell` for Windows desktop notifications
@@ -382,6 +383,37 @@ NoirWatch uses a configuration file to store default settings. The default locat
 - `-r, --restart`: Restart the AppName service.
 - `-t, --status`: Check the current status of the AppName service.
 
+## Docker Deployment Instructions
+
+This guide provides step-by-step instructions to deploy the NoirWatch service using Docker.
+
+### Docker Prerequisites
+
+Ensure you have the following installed on your system:
+
+- Docker
+
+### Using the Dockerfile
+
+To download the `Dockerfile` from the GitHub repository, run the following command:
+
+```sh
+curl -O https://raw.githubusercontent.com/binarynoir/noirwatch/main/Dockerfile
+```
+
+### Build and Deploy
+
+Navigate to the directory containing the `Dockerfile` and run the following command to build and start the service:
+
+```sh
+docker build -t noirwatch-image .
+docker run -d --name noirwatch noirwatch-image
+```
+
+### Conclusion
+
+You have successfully deployed the NoirWatch service using Docker. The service will automatically start when the container is created and will restart if it stops unexpectedly. For any further modifications or assistance, feel free to ask!
+
 ## Instructions for Running the Tests
 
 To run the tests for the `NoirWatch` script, follow these steps:

noirwatch

@@ -7,7 +7,7 @@
 
 # App version and name
 APP_NAME="NoirWatch"
-VERSION=1.3.0
+VERSION=1.3.1
 LAST_UPDATED="2024-12-20"
 
 # TODO:
@@ -24,7 +24,7 @@ CLI_URLS=()
 THRESHOLD=0
 
 # Application specific dependencies
-DEPENDENCIES=("timeout" "xmllint")
+DEPENDENCIES=("shasum" "timeout" "xmllint")
 
 # ==============================
 # Base Application Variables
@@ -976,7 +976,6 @@ show_config() {
     log_message "INFO" "Check interval: $CHECK_INTERVAL" "$LINENO"
     log_message "INFO" "Timeout interval: $TIMEOUT" "$LINENO"
     log_message "INFO" "Repeat times: ${REPEAT:-0}" "$LINENO"
-    log_message "INFO" "URL file: $URL_FILE" "$LINENO"
     log_message "INFO" "Threshold for changes: $THRESHOLD" "$LINENO"
 }
 
@@ -1048,10 +1047,7 @@ show_help() {
     printf "  Start the service with URLS:\n"
     printf "    %s --start 'https://example.com'\n" "$(basename "$0")"
     printf "\n"
-    printf "  Start the service with URL file:\n"
-    printf "    %s --start --url-file '/path/to/file'\n" "$(basename "$0")"
-    printf "\n"
-    printf "  Start the service with default URL file:\n"
+    printf "  Start the service with default settings:\n"
     printf "    %s --start\n" "$(basename "$0")"
     printf "\n"
     printf "  Restart the service with default settings:\n"

noirwatch.1

@@ -1,4 +1,4 @@
-.TH NOIRWATCH 1 "December 20, 2024" "NoirWatch 1.3.0" "User Commands"
+.TH NOIRWATCH 1 "December 20, 2024" "NoirWatch 1.3.1" "User Commands"
 .SH NAME
 NoirWatch \- Monitor specified websites for changes and send notifications.
 .SH SYNOPSIS