Merge pull request #12 from geniusdynamics/dev

Update N8n to v2.1.1

Author: kemboi22

README.md

@@ -1,98 +1,180 @@
-# n8n
-n8n allows you to build flexible workflows focused on deep data integration
+# NS8 n8n Module
 
-## Install
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+[![n8n Version](https://img.shields.io/badge/n8n-2.1.1-orange.svg)](https://github.com/n8n-io/n8n)
+
+n8n allows you to build flexible workflows focused on deep data integration. This NS8 module provides a complete containerized deployment with PostgreSQL, Redis, and Traefik integration.
+
+## 🏗️ Architecture
+
+The module consists of multiple services orchestrated by systemd:
+
+- **n8n.service**: Main pod service that manages network connectivity
+- **n8n-pgsql.service**: PostgreSQL database (v15.5-bookworm)
+- **n8n-redis.service**: Redis cache (v7.2.3-bookworm) 
+- **n8n-server.service**: n8n application server (v2.1.1)
+
+## 📦 Container Images
+
+The build process uses the following container images:
+
+- `docker.io/library/redis:7.2.3-bookworm` - Redis database
+- `docker.io/library/postgres:15.5-bookworm` - PostgreSQL database
+- `docker.io/n8nio/n8n:2.1.1` - n8n workflow automation
+- `docker.io/library/node:lts` - Node.js build environment
+
+## 🔧 Build Process
+
+The `build-images.sh` script creates the module image using Buildah:
+
+1. **UI Compilation**: Builds the Vue.js frontend with Node.js
+2. **Image Assembly**: Adds imageroot directory and compiled UI
+3. **Configuration**: Sets up entrypoint, labels, and container requirements
+4. **Publishing**: Pushes to GitHub Container Registry
+
+Key build features:
+- Reuses `nodebuilder-ns8-n8n` container for faster builds
+- Configures Traefik integration with route authorization
+- Sets rootless container with TCP port requirements
+- Supports CI/CD with GitHub Actions
+
+## 🚀 Installation
 
 Instantiate the module with:
 
-    add-module ghcr.io/compgeniuses/n8n:latest 1
+```bash
+add-module ghcr.io/geniusdynamics/n8n:latest 1
+```
+
+The output will return the instance name:
+
+```json
+{"module_id": "n8n", "image_name": "n8n", "image_url": "ghcr.io/geniusdynamics/n8n:latest"}
+```
+
+## ⚙️ Configuration
+
+Assuming the n8n instance is named `n8n1`, configure with:
+
+```bash
+api-cli run module/n8n1/configure-module --data '{
+    "host": "n8n.domain.com",
+    "lets_encrypt": false,
+    "http2https": true
+}'
+```
+
+### Configuration Parameters
+
+- `host`: Traefik host URL for the project
+- `lets_encrypt`: Enable/disable Let's Encrypt (default: false)
+- `http2https`: Enable HTTP to HTTPS redirect (default: true)
 
-The output of the command will return the instance name.
-Output example:
+## 🔍 Service Management
 
-    {"module_id": "n8n", "image_name": "n8n", "image_url": "ghcr.io/compgeniuses/n8n:latest"}
+### Systemd Services
 
-## Configure
+All services are managed by systemd with the following characteristics:
 
-Let's assume that the n8n instance is named `n8n1`.
+- **Restart Policy**: `always` for high availability
+- **Timeout**: 70 seconds for graceful shutdown
+- **Dependencies**: Proper service ordering (PostgreSQL → Redis → n8n)
+- **Health Checks**: Built-in container health monitoring
 
-Launch `configure-module`, by setting the following parameters:
+### Service Dependencies
 
+```
+n8n.service (pod)
+├── n8n-pgsql.service (database)
+├── n8n-redis.service (cache)
+└── n8n-server.service (application)
+```
 
-- `lets_encrypt`: Set LEtsecnrypt to True or False, Default is FALSE
-- `http2https`: set redirect to True or False, Default is True
-- `host`: the traefik host url for the project
+## 🌐 Network Configuration
 
-- ...
+The module publishes the n8n web interface on:
 
-Example:
+- **Internal**: Port 5678 within the pod
+- **External**: `127.0.0.1:${TCP_PORT}` via Traefik
 
-    api-cli run module/n8n1/configure-module --data '{"host": "n8n.domain.com"}'
+Test the service:
 
-    or if modifying another value: 
+```bash
+curl http://127.0.0.1/n8n/
+```
 
-    api-cli run module/n8n5/configure-module --data '{"host": "n8n.domain.com","n8n_name": "Myn8n"}'
+## 🔄 Smarthost Integration
 
-    api-cli run module/n8n1/configure-module --data '{
-        "host": "n8n.host.org",
-        "lets_encrypt": false,
-        "http2https": true,
-    }'
+The module automatically discovers smarthost settings from Redis:
 
+- `bin/discover-smarthost` refreshes `state/smarthost.env`
+- `events/smarthost-changed/10reload_services` handles configuration updates
+- Ensures email settings stay synchronized with NS8 core
 
-The above command will:
-- start and configure the n8n instance
-- (describe configuration process)
-- ...
+## 🧪 Testing
 
+Test the module using the provided test script:
 
+```bash
+./test-module.sh <NODE_ADDR> ghcr.io/geniusdynamics/n8n:latest
+```
 
-Send a test HTTP request to the ns8-n8n backend service:
+Tests are implemented using [Robot Framework](https://robotframework.org/).
 
-    curl http://127.0.0.1/n8n/
+## 🌍 Internationalization
 
-## Smarthost setting discovery
+The UI supports multiple languages through Weblate:
 
-Some configuration settings, like the smarthost setup, are not part of the
-`configure-module` action input: they are discovered by looking at some
-Redis keys.  To ensure the module is always up-to-date with the
-centralized [smarthost
-setup](https://nethserver.github.io/ns8-core/core/smarthost/) every time
-kickstart starts, the command `bin/discover-smarthost` runs and refreshes
-the `state/smarthost.env` file with fresh values from Redis.
+- **Supported Languages**: English, German, Spanish, Basque, Italian
+- **Translation Platform**: [Weblate](https://hosted.weblate.org/projects/ns8/)
 
-Furthermore if smarthost setup is changed when ns8-n8n-ngx is already
-running, the event handler `events/smarthost-changed/10reload_services`
-restarts the main module service.
+To enable translation updates:
+1. Add [GitHub Weblate app](https://docs.weblate.org/en/latest/admin/continuous.html#github-setup)
+2. Request addition to NS8 Weblate project
 
-See also the `systemd/user/n8n-server.service` file.
+## 🔄 Updates
 
-This setting discovery is just an example to understand how the module is
-expected to work: it can be rewritten or discarded completely.
+Update the module to the latest version:
 
-## Uninstall
+```bash
+api-cli run update-module --data '{
+  "module_url": "ghcr.io/geniusdynamics/n8n:latest",
+  "instances": ["n8n1"],
+  "force": true
+}'
+```
 
-To uninstall the instance:
+## 🗑️ Uninstallation
 
-    remove-module --no-preserve n8n1
+Remove the instance (data will be preserved unless `--no-preserve` is used):
 
-## Testing
+```bash
+remove-module --no-preserve n8n1
+```
 
-Test the module using the `test-module.sh` script:
+## 📁 Volume Storage
 
+The module uses persistent volumes for:
 
-    ./test-module.sh <NODE_ADDR> ghcr.io/compgeniuses/n8n:latest
+- `db_storage`: PostgreSQL data directory
+- `n8n-redis-data`: Redis data with AOF enabled
+- `n8n_data`: n8n user data and workflows
 
-The tests are made using [Robot Framework](https://robotframework.org/)
+## 🔒 Security Features
 
-## UI translation
+- **Rootless Containers**: All services run without root privileges
+- **Network Isolation**: Services communicate within a private pod
+- **Traefik Integration**: Secure HTTPS termination and routing
+- **Environment Files**: Sensitive configuration stored separately
 
-Translated with [Weblate](https://hosted.weblate.org/projects/ns8/).
+## 📄 License
 
-To setup the translation process:
+This module is licensed under GPL-3.0-or-later. See [LICENSE](LICENSE) for details.
 
-- add [GitHub Weblate app](https://docs.weblate.org/en/latest/admin/continuous.html#github-setup) to your repository
-- add your repository to [hosted.weblate.org]((https://hosted.weblate.org) or ask a NethServer developer to add it to ns8 Weblate project
+## 🤝 Contributing
 
-## To Do
+Contributions are welcome! Please ensure all changes:
+- Follow the existing code style
+- Include appropriate tests
+- Update documentation as needed
 

build-images.sh

@@ -14,35 +14,37 @@ images=()
 repobase="${REPOBASE:-ghcr.io/geniusdynamics}"
 # Configure the image name
 reponame="n8n"
-N8N_VERSION="1.57.0"
+
+N8N_VERSION="2.1.1"
+
 
 # Create a new empty container image
 container=$(buildah from scratch)
 
 # Reuse existing nodebuilder-kickstart container, to speed up builds
 if ! buildah containers --format "{{.ContainerName}}" | grep -q nodebuilder-ns8-n8n; then
-    echo "Pulling NodeJS runtime..."
-    buildah from --name nodebuilder-ns8-n8n -v "${PWD}:/usr/src:Z" docker.io/library/node:lts
+	echo "Pulling NodeJS runtime..."
+	buildah from --name nodebuilder-ns8-n8n -v "${PWD}:/usr/src:Z" docker.io/library/node:lts
 fi
 
 echo "Build static UI files with node..."
 buildah run \
-    --workingdir=/usr/src/ui \
-    --env="NODE_OPTIONS=--openssl-legacy-provider" \
-    nodebuilder-ns8-n8n \
-    sh -c "yarn install && yarn build"
+	--workingdir=/usr/src/ui \
+	--env="NODE_OPTIONS=--openssl-legacy-provider" \
+	nodebuilder-ns8-n8n \
+	sh -c "yarn install && yarn build"
 
 # Add imageroot directory to the container image
 buildah add "${container}" imageroot /imageroot
 buildah add "${container}" ui/dist /ui
 # Setup the entrypoint, ask to reserve one TCP port with the label and set a rootless container
 buildah config --entrypoint=/ \
-    --label="org.nethserver.authorizations=traefik@node:routeadm" \
-    --label="org.nethserver.tcp-ports-demand=1" \
-    --label="org.nethserver.rootfull=0" \
-    --label="org.nethserver.images=docker.io/library/redis:7.2.3-bookworm docker.io/library/postgres:15.5-bookworm docker.io/n8nio/n8n:${N8N_VERSION}" \
-    --label="org.nethserver.tcp-ports-demand=1" \
-    "${container}"
+	--label="org.nethserver.authorizations=traefik@node:routeadm" \
+	--label="org.nethserver.tcp-ports-demand=1" \
+	--label="org.nethserver.rootfull=0" \
+	--label="org.nethserver.images=docker.io/library/redis:7.2.3-bookworm docker.io/library/postgres:15.5-bookworm docker.io/n8nio/n8n:${N8N_VERSION} docker.io/n8nio/runners:2.1.1" \
+	--label="org.nethserver.tcp-ports-demand=1" \
+	"${container}"
 # Commit the image
 buildah commit "${container}" "${repobase}/${reponame}"
 
@@ -60,14 +62,14 @@ images+=("${repobase}/${reponame}")
 #
 
 #
-# Setup CI when pushing to Github. 
+# Setup CI when pushing to Github.
 # Warning! docker::// protocol expects lowercase letters (,,)
 if [[ -n "${CI}" ]]; then
-    # Set output value for Github Actions
-    printf "images=%s\n" "${images[*],,}" >> "${GITHUB_OUTPUT}"
+	# Set output value for Github Actions
+	printf "images=%s\n" "${images[*],,}" >>"${GITHUB_OUTPUT}"
 else
-    # Just print info for manual push
-    printf "Publish the images with:\n\n"
-    for image in "${images[@],,}"; do printf "  buildah push %s docker://%s:%s\n" "${image}" "${image}" "${IMAGETAG:-latest}" ; done
-    printf "\n"
+	# Just print info for manual push
+	printf "Publish the images with:\n\n"
+	for image in "${images[@],,}"; do printf "  buildah push %s docker://%s:%s\n" "${image}" "${image}" "${IMAGETAG:-latest}"; done
+	printf "\n"
 fi