Initial commit

.gitignore

@@ -0,0 +1,2 @@
+.idea
+

README.md

@@ -1,51 +1,31 @@
-[![tests](https://github.com/ddev/ddev-addon-template/actions/workflows/tests.yml/badge.svg)](https://github.com/ddev/ddev-addon-template/actions/workflows/tests.yml) ![project is maintained](https://img.shields.io/maintenance/yes/2024.svg)
+# DDEV n8n Addon
 
-# ddev-addon-template <!-- omit in toc -->
+This addon sets up a n8n instance for your DDEV project. n8n is a free and open fair-code licensed node based Workflow Automation Tool.
 
-* [What is ddev-addon-template?](#what-is-ddev-addon-template)
-* [Components of the repository](#components-of-the-repository)
-* [Getting started](#getting-started)
+## Installation
 
-## What is ddev-addon-template?
+1. Copy `docker-compose.n8n.yaml` into your `.ddev` directory.
+2. Copy `install.yaml` into your `.ddev` directory.
+3. Modify the environment variables in `docker-compose.n8n.yaml` to match your setup. Be sure to replace `n8n` and `n8n` with the username and password you want to use for n8n.
+4. Add the `post-start` hook in `.ddev/config.yaml` to create the `n8n` database.
+5. Run `ddev restart` to restart your project.
 
-This repository is a template for providing [DDEV](https://ddev.readthedocs.io) add-ons and services.
+## Basic Authentication
 
-In DDEV addons can be installed from the command line using the `ddev get` command, for example, `ddev get ddev/ddev-addon-template` or `ddev get ddev/ddev-drupal9-solr`.
+If not changed it's set to `n8n` and `n8n`.
 
-A repository like this one is the way to get started. You can create a new repo from this one by clicking the template button in the top right corner of the page.
+## Usage
 
-![template button](images/template-button.png)
+After installation, you can access the n8n instance by visiting `http://n8n.ddev.site:5678` and using the username and password you set.
 
-## Components of the repository
+## Database Configuration
 
-* The fundamental contents of the add-on service or other component. For example, in this template there is a [docker-compose.addon-template.yaml](docker-compose.addon-template.yaml) file.
-* An [install.yaml](install.yaml) file that describes how to install the service or other component.
-* A test suite in [test.bats](tests/test.bats) that makes sure the service continues to work as expected.
-* [Github actions setup](.github/workflows/tests.yml) so that the tests run automatically when you push to the repository.
+The n8n service uses the existing DDEV MySQL server. The `post-start` hook in `.ddev/config.yaml` creates a new database named `n8n`. The username, password, and hostname for the MySQL server are `db`.
 
-## Getting started
+## Logging
 
-1. Choose a good descriptive name for your add-on. It should probably start with "ddev-" and include the basic service or functionality. If it's particular to a specific CMS, perhaps `ddev-<CMS>-servicename`.
-2. Create the new template repository by using the template button.
-3. Globally replace "addon-template" with the name of your add-on.
-4. Add the files that need to be added to a ddev project to the repository. For example, you might remove `docker-compose.addon-template.yaml` with the `docker-compose.*.yaml` for your recipe.
-5. Update the install.yaml to give the necessary instructions for installing the add-on.
+n8n logs are directed to the container's stdout. You can view the logs with `ddev logs n8n`.
 
-   * The fundamental line is the `project_files` directive, a list of files to be copied from this repo into the project `.ddev` directory.
-   * You can optionally add files to the `global_files` directive as well, which will cause files to be placed in the global `.ddev` directory, `~/.ddev`.
-   * Finally, `pre_install_commands` and `post_install_commands` are supported. These can use the host-side environment variables documented [in ddev docs](https://ddev.readthedocs.io/en/stable/users/extend/custom-commands/#environment-variables-provided).
+## Security
 
-6. Update `tests/test.bats` to provide a reasonable test for the repository. You can run it manually with `bats tests` and it will be run on push and nightly as well. Please make sure to attend to test failures when they happen. Others will be depending on you. `bats` is a simple testing framework that just uses `bash`. You can install it with `brew install bats-core` or [see other techniques](https://bats-core.readthedocs.io/en/stable/installation.html). See [bats tutorial](https://bats-core.readthedocs.io/en/stable/).
-7. When everything is working, including the tests, you can push the repository to GitHub.
-8. Create a release on GitHub.
-9. Test manually with `ddev get <owner/repo>`.
-10. You can test PRs with `ddev get https://github.com/<user>/<repo>/tarball/<branch>`
-11. Update the README.md to describe the add-on, how to use it, and how to contribute. If there are any manual actions that have to be taken, please explain them. If it requires special configuration of the using project, please explain how to do those. Examples in [ddev/ddev-drupal9-solr](https://github.com/ddev/ddev-drupal9-solr), [ddev/ddev-memcached](github.com/ddev/ddev-memcached), and [ddev/ddev-beanstalkd](https://github.com/ddev/ddev-beanstalkd).
-12. Add a good short description to your repo, and add the label "ddev-get". It will immediately be added to the list provided by `ddev get --list --all`.
-13. When it has matured you will hopefully want to have it become an "official" maintained add-on. Open an issue in the [ddev queue](https://github.com/ddev/ddev/issues) for that.
-
-Note that more advanced techniques are discussed in [DDEV docs](https://ddev.readthedocs.io/en/latest/users/extend/additional-services/#additional-service-configurations-and-add-ons-for-ddev).
-
-**Contributed and maintained by [@CONTRIBUTOR](https://github.com/CONTRIBUTOR) based on the original [ddev-contrib recipe](https://github.com/ddev/ddev-contrib/tree/master/docker-compose-services/RECIPE) by [@CONTRIBUTOR](https://github.com/CONTRIBUTOR)**
-
-**Originally Contributed by [somebody](https://github.com/somebody) in <https://github.com/ddev/ddev-contrib/>
+The n8n service is protected with basic authentication. You can set the username and password in the `docker-compose.n8n.yaml` file.

docker-compose.n8n.yaml

@@ -0,0 +1,41 @@
+# DDEV n8n recipe file.
+#ddev-generated
+version: '3.6'
+services:
+  n8n:
+    container_name: ddev-${DDEV_SITENAME}-n8n
+    build:
+      context: ./n8n/
+      dockerfile: Dockerfile
+    command: ["/bin/sh", "/startup-script.sh"]
+    networks: [default, ddev_default]
+    labels:
+      com.ddev.site-name: ${DDEV_SITENAME}
+      com.ddev.approot: $DDEV_APPROOT
+      com.ddev.app-url: $DDEV_URL
+    restart: "no"
+    expose:
+      - "5678"
+    depends_on:
+      - db
+    volumes:
+      - ".:/mnt/ddev_config"
+      - "./n8n/startup-script.sh:/startup-script.sh"
+    environment:
+      GENERIC_TIMEZONE: "Europe/Berlin"
+      N8N_BASIC_AUTH_ACTIVE: true
+      N8N_BASIC_AUTH_USER: "n8n"
+      N8N_BASIC_AUTH_PASSWORD: "n8n"
+      N8N_HOST: "${DDEV_SITENAME}.ddev.site"
+      N8N_PORT: 5678
+      N8N_PROTOCOL: http
+      N8N_LOG_OUTPUT: "stdout"
+      VIRTUAL_HOST: "$DDEV_HOSTNAME"
+      DB_TYPE: mysqldb
+      DB_MYSQLDB_HOST: db
+      DB_MYSQLDB_PORT: 3306
+      DB_MYSQLDB_USER: db
+      DB_MYSQLDB_PASSWORD: db
+      DB_MYSQLDB_DATABASE: n8n
+      HTTP_EXPOSE: "5678:5678"
+      HTTPS_EXPOSE: "5679:5678"

install.yaml

@@ -1,81 +1,5 @@
-name: addon-template
+name: n8n
 
-# pre_install_actions - list of actions to run before installing the addon.
-# Examples would be removing an extraneous docker volume,
-# or doing a sanity check for requirements.
-# DDEV environment variables can be interpolated into these actions
-pre_install_actions:
-  # Actions with #ddev-nodisplay will not show the execution of the action, but may show their output
-# - |
-  # #ddev-nodisplay
-  #ddev-description:Check architecture type for incompatible arm64 type
-  # if [ "$(arch)" = "arm64" -o "$(arch)" = "aarch64" ]; then
-    # echo "This package does not work on arm64 machines";
-    # exit 1;
-  #fi
-
-# - "docker volume rm ddev-${DDEV_PROJECT}_solr 2>/dev/null || true"
-#- |
-#  # Using #ddev-nodisplay tells ddev to be quiet about this action and not show it or its output.
-#  #ddev-nodisplay
-#  #ddev-description:Remove solr volume
-#  if ! ( ddev debug capabilities 2>/dev/null | grep multiple-dockerfiles >/dev/null 2>&1 ) ; then
-#    echo "This add-on requires DDEV v1.19.4 or higher, please upgrade." && exit 2
-#  fi
-#- 'echo "what is your platform.sh token" && read x'
-
-# This item shows templating using DDEV environment variables.
-# -
-#   #ddev-description:Touch a file to create it
-#   touch somefile.${DDEV_PROJECT_TYPE}.${DDEV_DOCROOT}.txt
-#
-
-# This item shows complex go templating possibilities based on yaml_read_files
-#- |
-#- #ddev-description:Create a config.platformsh.yaml
-#  cat <<EOF >.ddev/config.platformsh.yaml
-#  php_version: {{ trimPrefix "php:" .platformapp.type }}
-#  database:
-#    type: {{ regexReplaceAll ":.*$" .services.db.type "" }}
-#    version: {{ regexReplaceAll "^.*:" .services.db.type "" }}
-#
-#  docroot: {{ dig "web" "locations" "/" "root" "notfound" .platformapp }}
-#  {{ if eq .platformapp.build.flavor "composer" }}
-#  hooks:
-#    post-start:
-#      - composer: install
-#  {{ if .platformapp.hooks.deploy }}
-#      - exec: "{{ trimAll "\n" .platformapp.hooks.deploy | splitList "\n" | join ` && ` }}"
-#  {{ end }}
-#  {{ end }}
-#
-#  EOF
-
-# list of files and directories listed that are copied into project .ddev directory
-# Each file should contain #ddev-generated so it can be replaced by a later `ddev get`
-# if it hasn't been modified by the user.
-# DDEV environment variables can be interpolated into these filenames
 project_files:
-- docker-compose.addon-template.yaml
-# - extra_files/
-# - somefile.sh
-
-# List of files and directories that are copied into the global .ddev directory
-# DDEV environment variables can be interpolated into these filenames
-global_files:
-# - commands
-# - homeadditions
-
-# DDEV environment variables can be interpolated into these actions
-post_install_actions:
-# - chmod +x ~/.ddev/commands/web/somecommand
-# - touch somefile.${GOOS}.${DDEV_WEBSERVER}
-# - perl -pi -e 's/oldstring/newstring/g' docker-compose.addon-template.yaml
-
-# Advanced usage - yaml files can be read in and then used as go template actions
-# in pre_install_actions and post_install_actions
-# See example in
-# https://github.com/rfay/ddev/blob/20220606_yaml_read_experiment/cmd/ddev/cmd/testdata/TestCmdGetComplex/recipe/install.yaml
-yaml_read_files:
-# someyaml: someyaml.yaml
-# otheryaml: someotheryaml.yaml
+- n8n/
+- docker-compose.n8n.yaml

n8n/Dockerfile

@@ -0,0 +1,5 @@
+# Use the n8nio/n8n image as base
+FROM n8nio/n8n:latest
+
+# Install the MySQL client
+RUN apk add --no-cache mysql-client

n8n/startup-script.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+set -e
+
+# Wait for MySQL to be ready
+until mysqladmin ping -h"$DB_MYSQLDB_HOST" --silent; do
+    sleep 1
+done
+
+# Create the database
+mysql -u"root" -p"root" -h"$DB_MYSQLDB_HOST" -e "CREATE DATABASE IF NOT EXISTS \`$DB_MYSQLDB_DATABASE\`; GRANT ALL PRIVILEGES ON n8n.* TO 'db'@'%'; FLUSH PRIVILEGES;"
+
+# Start n8n
+exec n8n