Merge pull request 'Allow Alternative Hugo Website Branches' (#10) from dev into main

Reviewed-on: #10

.gitignore

@@ -35,6 +35,10 @@ docker-compose.yml
 # 2024-01-24 Hide static files for Hyperling.com.
 Config/Hyperling.com/files/*
 
-# Ignore things like Config/Hyperling.com-Stage/
+# Ignore things like "Config/Hyperling.com-Stage/""
 *-Stage
 Stage-*
+
+# Ignore copies of the Hugo configuration, such as "Config/Hugo-MyWebsite".
+Hugo-*
+*-Hugo

Config/HugoExample/Dockerfile

@@ -0,0 +1,35 @@
+# 2025-08-13 Hyperling
+
+## Image ##
+FROM debian:bookworm-slim
+
+## Setup ##
+# System Dependencies
+RUN apt-get update && apt-get install -y git hugo nginx cron curl bash sudo htop
+
+# User and Group
+#RUN groupadd -r hugo && useradd -r -g hugo hugo
+
+# Hugo Directory Tree
+RUN mkdir -pv /var/www/hugo/
+
+# NGINX Directory Tree
+RUN mkdir -pv /var/www/html/
+
+# Copy Cron Job to Update Git Repo
+COPY files/crontab /etc/crontab
+COPY files/cronjob.sh /var/www/hugo/cronjob.sh
+
+# Hugo User Permissions
+RUN chown -Rv www-data:www-data /var/www/
+RUN chmod +x /var/www/hugo/cronjob.sh
+
+# Copy Start Script
+COPY files/main.sh /root/main.sh
+RUN chmod +x /root/main.sh
+
+## Main ##
+# Install + Run Website
+WORKDIR /var/www/
+USER root
+CMD /root/main.sh "$REPO" "$BRANCH" "$PROD" "$DEV"

Config/HugoExample/docker-compose.example.yml

@@ -0,0 +1,30 @@
+# 2025-08-13
+# Configuration for running a Hugo website pulled from Git.
+
+services:
+  app:
+    container_name: hugo
+    build:
+      context: ./
+      network: host
+    restart: always
+    ports:
+      - 8013:80   # Production minified files served using NGINX.
+      - 1380:1380 # Development files with drafts served by Hugo Server.
+    environment:
+      - REPO=$REPO
+      - BRANCH=$BRANCH
+      - PROD=$PROD
+      - DEV=$DEV
+    healthcheck:
+      test: curl -sS http://localhost:80 || curl -sS http://localhost:1380 || exit 1
+      interval: 1m
+      timeout: 10s
+      retries: 2
+      start_period: 30s
+    deploy:
+      mode: global
+      resources:
+        limits:
+          cpus: '0.10'
+          memory: 64M

Config/HugoExample/env.example

@@ -0,0 +1,22 @@
+# 2025-08-13 Hyperling
+
+#
+## Docker ##
+#
+COMPOSE_BAKE=true
+
+#
+## Git Website Repository
+#
+REPO=https://git.hyperling.com/me/hugo-jackanope
+BRANCH=main
+
+#
+## Web Environments
+# Please use values YES/TRUE and NO/FALSE.
+
+# Whether to start NGINX
+PROD=YES
+
+# Whether to start Hugo Server
+DEV=NO

Config/HugoExample/files/cronjob.sh

@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+
+cd /var/www/hugo/site
+
+echo "*** Running cronjob @ `date` ***"
+
+# Pull any updates, and if the project is already up to date, exit successfully.
+git pull | grep -v "up to date"
+status="$?"
+echo "* Pull status is '$status'."
+if [[ $status != 0 && -e /var/www/html/index.html ]]; then
+	echo "* Site is already up to date and copied, exiting."
+	exit 0
+fi
+
+# If the project was not already up to date, build the new files for NGINX.
+hugo --gc --minify
+status="$?"
+echo "* Hugo status is '$status'."
+if [[ $status == 0 && -e public/index.html ]]; then
+	echo "* Copying files..."
+	rm -rfv /var/www/html/*
+	mv -v public/* /var/www/html/
+fi
+
+exit 0

Config/HugoExample/files/crontab

@@ -0,0 +1 @@
+* * * * * www-data /var/www/hugo/cronjob.sh

Config/HugoExample/files/main.sh

@@ -0,0 +1,87 @@
+#!/usr/bin/env bash
+
+REPO="$1"
+echo "REPO='$REPO'"
+
+BRANCH="$2"
+if [[ -n $BRANCH ]]; then
+	BRANCH="--branch $BRANCH"
+fi
+echo "BRANCH='$BRANCH'"
+
+PROD="$3"
+typeset -u PROD
+echo "PROD='$PROD'"
+
+DEV="$4"
+typeset -u DEV
+echo "DEV='$DEV'"
+
+echo "*** Creating Git Repo ***"
+sudo -u www-data git clone --recurse-submodules $BRANCH $REPO /var/www/hugo/site
+status="$?"
+
+echo "*** Validating Git Repo ***"
+if [[ $status != 0 || ! -d /var/www/hugo/site/.git ]]; then
+	echo "ERROR: Hugo project may not have cloned correctly. status='$status'"
+	echo "Aborting."
+	exit 1
+fi
+echo "* Site exists!"
+
+echo "*** Copying Static Files to NGINX ***"
+rm -rfv /var/www/html/*
+sudo -u www-data /var/www/hugo/cronjob.sh
+
+echo "*** Starting Cron ***"
+service cron start
+service cron status
+
+if [[ "$PROD" == "Y"* || "$PROD" == "T"*  ]]; then
+	echo "*** Starting Production Server Loop ***"
+
+	while true; do
+		http_code="`curl -sS http://localhost:80 -o /dev/null -w "%{http_code}"`"
+		if [[ $http_code != 200 ]]; then
+			echo "* Prod server not detected, starting..."
+			service nginx status
+			service nginx start
+			service nginx status
+		fi
+		sleep 15
+	done &
+
+	cd /var/log/nginx
+	tail -f access.log error.log &
+fi
+
+if [[ "$DEV" == "Y"* || "$DEV" == "T"* ]]; then
+	echo "*** Starting Development Server Loop ***"
+
+	while true; do
+		http_code="`curl -sS http://localhost:1380 -o /dev/null -w "%{http_code}"`"
+		if [[ $http_code != 200 ]]; then
+			echo "* Dev server not detected, starting..."
+			cd /var/www/hugo/site
+			killall hugo 2>/dev/null
+			sudo -u www-data hugo server -D --noBuildLock --bind 0.0.0.0 -p 1380 &
+		fi
+		sleep 30
+	done &
+fi
+
+echo "*** Following Mail Files ***"
+cd /var/mail
+touch mail www-data
+chown -v mail:mail mail
+chown -v www-data:mail www-data
+chmod -v 660 mail www-data
+tail -f mail www-data &
+
+cd
+
+echo "*** Finished $0 @ `date` ***"
+
+wait -n
+
+exit $?

Config/LibreTranslate/README.md

@@ -1,8 +1,8 @@
-# Libreranslate Configuration
+# LibreTranslate Configuration
 
 ## Install
 
-0. Copy `env.example` to `.env` and adjust the values as necessary.
+1. Copy `env.example` to `.env` and adjust the values as necessary.
 
 ```
 cd $DOCKER_HOME/Config/LibreTranslate
@@ -10,21 +10,22 @@ cp env.example .env
 vi .env
 ```
 
-1. Run the `prep.sh` file to create the volume mounts.
+2. Run the `prep.sh` file to create the volume mounts.
 
 ```
-$DOCKER_HOME/Config/LibreTranslate/prep.sh
+./prep.sh
 ```
 
-2. If using  a temporary location for `models/` such as `/tmp/`, ensure
-that `prep.sh` is in `root`'s crontab.
+3. If using a temporary location for `models/` such as `/tmp/`, ensure
+that the reboot script is in `root`'s crontab to set the folders back up.
 
 ```
-@reboot $DOCKER_HOME/Config/LibreTranslate/prep.sh
+@reboot /opt/Docker/Config/LibreTranslate/cron-reboot.sh
 ```
 
-3. Start the container up as normal.
+4. Start the container up as normal.
 
 ```
+cp docker-compose.main.yml docker-compose.yml
 docker compose up -d
 ```

Config/LibreTranslate/cron-reboot.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+# 2025-07-26 Hyperling
+# Ensure the LibreTranslate container starts correctly after a reboot, especially if placing models/ under /tmp/.
+
+## Setup ##
+
+DIR="$(dirname -- "${BASH_SOURCE[0]}")"
+cd $DIR
+source ./.env
+
+## Main ##
+
+# Shutdown the container.
+docker compose down
+
+# Create folders.
+./prep.sh
+
+# Start the container.
+docker compose up -d
+
+# Finish successfully.
+exit 0

Config/LibreTranslate/docker-compose.main.yml

@@ -1,4 +1,4 @@
-# LibreTranslate configuration for a capable server.
+# LibreTranslate configuration.
 # Example docker-compose.yml:
 #   https://github.com/LibreTranslate/LibreTranslate/blob/main/docker-compose.yml
 
@@ -34,14 +34,14 @@ services:
     tty: true
     healthcheck:
       test: ['CMD-SHELL', './venv/bin/python scripts/healthcheck.py']
-    command: --req-limit 100 --char-limit 2000
+    command: --req-limit $REQUESTS --char-limit $CHARACTERS
     environment:
       # Allow the saving of API Keys. Requires volume libretranslate_api_keys.
       - LT_API_KEYS=true
       - LT_API_KEYS_DB_PATH=/app/db/api_keys.db
       # Optimize loading time. Requires volume libretranslate_models.
       - LT_UPDATE_MODELS=$UPDATE_MODELS
-      - LT_LOAD_ONLY=$LANGUAGES
+      - $LANGUAGES
     volumes:
       # Store the API keys.
       - libretranslate_api_keys:/app/db
@@ -51,5 +51,5 @@ services:
       mode: global
       resources:
         limits:
-          cpus: '2.00'
-          memory: 4G
+          cpus: $CPU
+          memory: $RAM

Config/LibreTranslate/docker-compose.micro.yml

@@ -1,55 +0,0 @@
-# LibreTranslate configuration for a small-scale server (1 CPU, 1GB RAM).
-# Example docker-compose.yml:
-#   https://github.com/LibreTranslate/LibreTranslate/blob/main/docker-compose.yml
-
-# Named volumes ensure that the container user gets the correct permissions.
-volumes:
-
-  libretranslate_api_keys:
-    driver: local
-    driver_opts:
-      type: none
-      device: $API_KEYS_DIR
-      o: bind
-
-  libretranslate_models:
-    driver: local
-    driver_opts:
-      type: none
-      device: $MODELS_DIR
-      o: bind
-
-services:
-
-  ## Main ##
-  lt-app:
-    container_name: lt-app
-    build:
-      context: ./
-      network: host
-    restart: always
-    ports:
-      - "5000:5000"
-    # Uncomment this for logging in docker compose logs
-    tty: true
-    healthcheck:
-      test: ['CMD-SHELL', './venv/bin/python scripts/healthcheck.py']
-    command: --req-limit 100 --char-limit 2000
-    environment:
-      # Allow the saving of API Keys. Requires volume libretranslate_api_keys.
-      - LT_API_KEYS=true
-      - LT_API_KEYS_DB_PATH=/app/db/api_keys.db
-      # Optimize loading time. Requires volume libretranslate_models.
-      - LT_UPDATE_MODELS=$UPDATE_MODELS
-      - LT_LOAD_ONLY=$LANGUAGES
-    volumes:
-      # Store the API keys.
-      - libretranslate_api_keys:/app/db
-      # Avoid re-downloading language models every reboot.
-      - libretranslate_models:/home/libretranslate/.local:rw
-    deploy:
-      mode: global
-      resources:
-        limits:
-          cpus: '0.25'
-          memory: 640M

Config/LibreTranslate/env.example

@@ -2,17 +2,30 @@
 
 COMPOSE_BAKE=true
 
+### Container Specs ###
+
+## For a small-scale server (such as 1 CPU, 1GB RAM).
+# CPU=0.25
+# RAM=640M
+
+## For a fully capable server.
+CPU=2.00
+RAM=4.0G
+
+# How much the users are able to utilize the server.
+REQUESTS=100
+CHARACTERS=2000
+
 ### Languages ###
 
 ## Check for language model updates on each run.
 UPDATE_MODELS=true
 
-## Leave commented, blank, or set to "All" for default behavior.
-# LANGUAGES=
-# LANGUAGES=All
+## Use default behavior of downloading all models.
+# LANGUAGES=ALL
 
 ## Otherwise set to a comma-separated list to enable only the desired models.
-LANGUAGES=en,es,fr,de
+LANGUAGES='LT_LOAD_ONLY=en,es,fr,de'
 
 ### API Keys ###
 
@@ -31,7 +44,6 @@ MODELS_DIR=../../Volumes/LibreTranslate/models
 # MODELS_DIR=
 
 ## Storing them in /tmp/ will cause them to get reset after reboots, but hides
-## them from backup type locations such as Volumes/LibreTranslate and /var/.
-## This will require a CRON entry for prepping the project after a reboot.
-## `@reboot $DOCKER_HOME/Config/LibreTranslate/prep.sh`
+## them from backup type locations such as Volumes/LibreTranslate/ and /var/.
+## Please see the README for the CRON command related to this setting.
 # MODELS_DIR=/tmp/LibreTranslate/models

Config/LibreTranslate/prep.sh

@@ -10,6 +10,7 @@ source $DIR/.env
 
 ## Main ##
 
+# Create folders.
 if [[ $API_KEYS_DIR == "../*" ]]; then
 	API_KEYS_DIR="$DIR/$API_KEYS_DIR"
 fi
@@ -19,3 +20,6 @@ if [[ $MODELS_DIR == "../*" ]]; then
 	MODELS_DIR="$DIR/$MODELS_DIR"
 fi
 mkdir -pv $MODELS_DIR
+
+# Finish successfully.
+exit 0