v0.0.1

tasks/cleanup.yml

@@ -0,0 +1,43 @@
+---
+- name: Check n8n directory
+  ansible.builtin.stat:
+    path: "{{ n8n_home }}"
+  register: n8n_home_stat
+
+- name: Stop n8n docker compose
+  ansible.builtin.command: docker compose down
+  args:
+    chdir: "{{ n8n_home }}"
+  when:
+    - n8n_site.deploy_type == "docker"
+    - n8n_home_stat.stat.exists
+  failed_when: false
+
+- name: Stop and disable n8n systemd unit
+  ansible.builtin.systemd:
+    name: "{{ n8n_unit_name }}.service"
+    state: stopped
+    enabled: false
+  when: n8n_systemd
+  failed_when: false
+
+- name: Remove n8n systemd unit
+  ansible.builtin.file:
+    path: "/etc/systemd/system/{{ n8n_unit_name }}.service"
+    state: absent
+  when: n8n_systemd
+
+- name: Reload systemd after cleanup
+  ansible.builtin.systemd:
+    daemon_reload: true
+  when: n8n_systemd
+
+- name: Remove n8n facts file
+  ansible.builtin.file:
+    path: "{{ n8n_fact_path }}"
+    state: absent
+
+- name: Remove n8n directory
+  ansible.builtin.file:
+    path: "{{ n8n_home }}"
+    state: absent

tasks/config.yml

@@ -0,0 +1,106 @@
+---
+- name: Validate n8n site deploy_type
+  assert:
+    that:
+      - n8n_site.name is defined
+      - n8n_site.deploy_type is defined
+      - n8n_site.deploy_type in ["docker", "repo", "package"]
+    fail_msg: "n8n_sites entry must define deploy_type as 'docker', 'repo', or 'package'."
+
+- name: Set n8n site defaults
+  set_fact:
+    n8n_name: "{{ n8n_site.name }}"
+    n8n_home: "{{ n8n_site.path | default('/srv/' + n8n_site.name) }}"
+    n8n_user: "{{ n8n_site.user | default(n8n_default_user) }}"
+    n8n_group: "{{ n8n_site.group | default(n8n_default_group) }}"
+    n8n_systemd: "{{ n8n_site.systemd | default(true) }}"
+    n8n_state: "{{ n8n_site.state | default('present') }}"
+    n8n_app_options: "{{ n8n_site.app_options | default({}) }}"
+    n8n_docker_options: "{{ n8n_site.docker_options | default({}) }}"
+    n8n_unit_name: "n8n-{{ n8n_site.name | regex_replace('[^a-zA-Z0-9]+', '-') }}"
+    n8n_fact_path: "/etc/ansible/facts.d/n8n-{{ n8n_site.name | regex_replace('[^a-zA-Z0-9]+', '-') }}.fact"
+  no_log: true
+
+- name: Set n8n runtime options
+  set_fact:
+    n8n_host: "{{ n8n_app_options.host | default(n8n_default_host) }}"
+    n8n_protocol: "{{ n8n_app_options.protocol | default(n8n_default_protocol) }}"
+    n8n_timezone: "{{ n8n_app_options.timezone | default(n8n_default_timezone) }}"
+    n8n_listen_port: >-
+      {{
+        (n8n_docker_options.listen_port | default(n8n_default_port))
+        if n8n_site.deploy_type == "docker"
+        else (n8n_app_options.port | default(n8n_default_port))
+      }}
+    n8n_webhook_url: >-
+      {{
+        n8n_app_options.webhook_url
+        | default(
+            (n8n_app_options.protocol | default(n8n_default_protocol))
+            ~ '://'
+            ~ (n8n_app_options.host | default(n8n_default_host))
+            ~ ':'
+            ~ (
+              (n8n_docker_options.listen_port | default(n8n_default_port))
+              if n8n_site.deploy_type == "docker"
+              else (n8n_app_options.port | default(n8n_default_port))
+            )
+            ~ '/'
+          )
+      }}
+  no_log: true
+
+- name: Set n8n DB options
+  set_fact:
+    n8n_db_host: "{{ (n8n_site.db | default({})).host | default(n8n_default_db.host) }}"
+    n8n_db_port: "{{ (n8n_site.db | default({})).port | default(n8n_default_db.port) }}"
+    n8n_db_name: "{{ (n8n_site.db | default({})).name | default(n8n_default_db.name) }}"
+    n8n_db_user: "{{ (n8n_site.db | default({})).user | default(n8n_default_db.user) }}"
+    n8n_db_password: "{{ (n8n_site.db | default({})).password | default(n8n_default_db.password) }}"
+    n8n_db_type: "{{ (n8n_site.db | default({})).type | default(n8n_default_db.type) }}"
+  no_log: true
+
+- name: Set n8n DB kind
+  set_fact:
+    n8n_db_kind: "{{ 'mysql' if n8n_db_type in ['mysql', 'mariadb'] else 'postgres' }}"
+  no_log: true
+
+- name: Set n8n deploy options
+  set_fact:
+    n8n_docker_image: "{{ n8n_docker_options.image | default(n8n_default_image) }}"
+    n8n_docker_uid: "{{ n8n_docker_options.uid | default(n8n_default_docker_uid) }}"
+    n8n_docker_gid: "{{ n8n_docker_options.gid | default(n8n_default_docker_gid) }}"
+    n8n_repo_path: "{{ n8n_app_options.repo_path | default(n8n_default_repo) }}"
+    n8n_repo_version: "{{ n8n_app_options.repo_version | default(n8n_default_repo_version) }}"
+    n8n_build_command: "{{ n8n_app_options.build_command | default(n8n_default_build_command) }}"
+    n8n_start_command: "{{ n8n_app_options.start_command | default(n8n_default_start_command) }}"
+    n8n_package_name: "{{ n8n_app_options.package_name | default(n8n_default_package_name) }}"
+    n8n_package_version: "{{ n8n_app_options.package_version | default(n8n_default_package_version) }}"
+    n8n_package_bin: "{{ n8n_app_options.package_bin | default(n8n_default_package_bin) }}"
+  no_log: true
+
+- name: Cleanup n8n site
+  include_tasks: cleanup.yml
+  when: n8n_state == "absent"
+
+- name: Install n8n with Docker
+  include_tasks: install-docker.yml
+  when:
+    - n8n_site.deploy_type == "docker"
+    - n8n_state != "absent"
+
+- name: Install n8n from repo
+  include_tasks: install-repo.yml
+  when:
+    - n8n_site.deploy_type == "repo"
+    - n8n_state != "absent"
+
+- name: Install n8n from package
+  include_tasks: install-package.yml
+  when:
+    - n8n_site.deploy_type == "package"
+    - n8n_state != "absent"
+
+- name: Write n8n facts
+  include_tasks: facts.yml
+  when: n8n_state != "absent"

tasks/docker.yml

@@ -0,0 +1,5 @@
+---
+# compatibility wrapper for docker install
+
+- name: Install n8n with Docker
+  include_tasks: install-docker.yml

tasks/facts.yml

@@ -0,0 +1,44 @@
+---
+- name: Ensure facts directory exists
+  ansible.builtin.file:
+    path: /etc/ansible/facts.d
+    state: directory
+    owner: root
+    group: root
+    mode: "0755"
+
+- name: Write n8n facts
+  ansible.builtin.copy:
+    dest: "{{ n8n_fact_path }}"
+    owner: root
+    group: root
+    mode: "0644"
+    content: |
+      {{ {
+        "name": n8n_name,
+        "deploy_type": n8n_site.deploy_type,
+        "path": n8n_home,
+        "user": n8n_user,
+        "group": n8n_group,
+        "systemd": n8n_systemd,
+        "host": n8n_host,
+        "protocol": n8n_protocol,
+        "listen_port": n8n_listen_port,
+        "webhook_url": n8n_webhook_url,
+        "image": (
+          n8n_docker_image if n8n_site.deploy_type == "docker" else ""
+        ),
+        "repo": (
+          n8n_repo_path if n8n_site.deploy_type == "repo" else ""
+        ),
+        "package": (
+          n8n_package_name if n8n_site.deploy_type == "package" else ""
+        ),
+        "db": {
+          "host": n8n_db_host,
+          "port": n8n_db_port,
+          "name": n8n_db_name,
+          "user": n8n_db_user,
+          "type": n8n_db_kind
+        }
+      } | to_nice_json }}

tasks/install-docker.yml

@@ -0,0 +1,54 @@
+---
+# docker tasks file for n8n
+
+- name: Ensure n8n directory exists
+  ansible.builtin.file:
+    path: "{{ n8n_home }}"
+    state: directory
+
+- name: Ensure n8n data directory exists
+  ansible.builtin.file:
+    path: "{{ n8n_home }}/data"
+    state: directory
+    owner: "{{ n8n_docker_uid }}"
+    group: "{{ n8n_docker_gid }}"
+    mode: "0750"
+  become: true
+
+- name: Generate n8n docker-compose template
+  ansible.builtin.template:
+    src: "{{ n8n_docker_options.compose_template | default('docker-compose.yml.j2') }}"
+    dest: "{{ n8n_home }}/docker-compose.yml"
+
+- name: Generate n8n env template
+  ansible.builtin.template:
+    src: "{{ n8n_docker_options.env_template | default('n8n-docker.env.j2') }}"
+    dest: "{{ n8n_home }}/.env"
+
+- name: Generate n8n systemd service
+  ansible.builtin.template:
+    src: "{{ n8n_docker_options.systemd_template | default('n8n-docker.service.j2') }}"
+    dest: "/etc/systemd/system/{{ n8n_unit_name }}.service"
+  become: true
+  when: n8n_systemd
+
+- name: Deploy n8n
+  community.docker.docker_compose_v2:
+    project_src: "{{ n8n_home }}"
+    files:
+      - docker-compose.yml
+    build: never
+
+- name: Reload systemd daemon
+  ansible.builtin.systemd:
+    daemon_reload: true
+  become: true
+  when: n8n_systemd
+
+- name: Enable and start {{ n8n_unit_name }} service
+  ansible.builtin.systemd:
+    name: "{{ n8n_unit_name }}"
+    enabled: true
+    state: started
+  become: true
+  when: n8n_systemd

tasks/install-package.yml

@@ -0,0 +1,61 @@
+---
+# package tasks file for n8n
+
+- name: Ensure n8n group exists
+  ansible.builtin.group:
+    name: "{{ n8n_group }}"
+    system: true
+
+- name: Ensure n8n user exists
+  ansible.builtin.user:
+    name: "{{ n8n_user }}"
+    group: "{{ n8n_group }}"
+    system: true
+    create_home: false
+    shell: /usr/sbin/nologin
+
+- name: Ensure n8n directory exists
+  ansible.builtin.file:
+    path: "{{ n8n_home }}"
+    state: directory
+    owner: "{{ n8n_user }}"
+    group: "{{ n8n_group }}"
+    mode: "0755"
+
+- name: Install n8n package
+  npm:
+    name: "{{ n8n_package_name }}"
+    version: "{{ n8n_package_version }}"
+    global: true
+    state: present
+  become: true
+
+- name: Create n8n env file
+  ansible.builtin.template:
+    src: "{{ n8n_app_options.env_template | default('n8n.env.j2') }}"
+    dest: "{{ n8n_home }}/.env"
+    owner: "{{ n8n_user }}"
+    group: "{{ n8n_group }}"
+    mode: "0640"
+
+- name: Write n8n package systemd unit
+  ansible.builtin.template:
+    src: "{{ n8n_app_options.systemd_template | default('n8n-package.service.j2') }}"
+    dest: "/etc/systemd/system/{{ n8n_unit_name }}.service"
+    mode: "0644"
+  become: true
+  when: n8n_systemd
+
+- name: Reload systemd for n8n package
+  ansible.builtin.systemd:
+    daemon_reload: true
+  become: true
+  when: n8n_systemd
+
+- name: Enable and start n8n package
+  ansible.builtin.systemd:
+    name: "{{ n8n_unit_name }}.service"
+    enabled: true
+    state: started
+  become: true
+  when: n8n_systemd

tasks/install-repo.yml

@@ -0,0 +1,154 @@
+---
+# repo tasks file for n8n
+
+- name: Ensure n8n group exists
+  ansible.builtin.group:
+    name: "{{ n8n_group }}"
+    system: true
+
+- name: Ensure n8n user exists
+  ansible.builtin.user:
+    name: "{{ n8n_user }}"
+    group: "{{ n8n_group }}"
+    system: true
+    create_home: false
+    shell: /usr/sbin/nologin
+
+- name: Ensure n8n directory exists
+  ansible.builtin.file:
+    path: "{{ n8n_home }}"
+    state: directory
+    owner: "{{ n8n_user }}"
+    group: "{{ n8n_group }}"
+    mode: "0755"
+
+- name: Check n8n repo directory
+  ansible.builtin.stat:
+    path: "{{ n8n_home }}"
+  register: n8n_repo_home
+
+- name: Check n8n git metadata
+  ansible.builtin.stat:
+    path: "{{ n8n_home }}/.git"
+  register: n8n_repo_git
+
+- name: Check n8n directory contents
+  ansible.builtin.find:
+    paths: "{{ n8n_home }}"
+    hidden: true
+    recurse: false
+  register: n8n_repo_contents
+  when: n8n_repo_home.stat.exists
+
+- name: Remove n8n directory when not a git repo
+  ansible.builtin.file:
+    path: "{{ n8n_home }}"
+    state: absent
+  when:
+    - n8n_repo_git.stat.exists is not defined or not n8n_repo_git.stat.exists
+    - (n8n_app_options.clean_path | default(false))
+
+- name: Abort when n8n directory is not a git repo
+  ansible.builtin.fail:
+    msg: "n8n path {{ n8n_home }} exists but is not a git repo. Set app_options.clean_path: true to wipe it."
+  when:
+    - n8n_repo_home.stat.exists
+    - n8n_repo_git.stat.exists is not defined or not n8n_repo_git.stat.exists
+    - (n8n_repo_contents.files | default([]) | length) > 0
+    - not (n8n_app_options.clean_path | default(false))
+
+- name: Ensure n8n repo ownership
+  ansible.builtin.file:
+    path: "{{ n8n_home }}"
+    state: directory
+    owner: "{{ n8n_user }}"
+    group: "{{ n8n_group }}"
+    recurse: true
+  when: n8n_repo_git.stat.exists
+
+- name: Mark n8n repo as safe for git
+  ansible.builtin.command: "git config --global --add safe.directory {{ n8n_home }}"
+  become_user: "{{ n8n_user }}"
+  when: n8n_repo_git.stat.exists
+
+- name: Ensure n8n repo origin exists
+  ansible.builtin.command: "git remote add origin {{ n8n_repo_path }}"
+  args:
+    chdir: "{{ n8n_home }}"
+  become_user: "{{ n8n_user }}"
+  changed_when: false
+  failed_when: false
+  when: n8n_repo_git.stat.exists
+
+- name: Ensure n8n repo origin matches
+  ansible.builtin.command: "git remote set-url origin {{ n8n_repo_path }}"
+  args:
+    chdir: "{{ n8n_home }}"
+  become_user: "{{ n8n_user }}"
+  when: n8n_repo_git.stat.exists
+
+- name: Install pnpm globally
+  npm:
+    name: pnpm
+    global: true
+    state: present
+  become: true
+
+- name: Clone n8n repo
+  ansible.builtin.git:
+    repo: "{{ n8n_repo_path }}"
+    dest: "{{ n8n_home }}"
+    version: "{{ n8n_repo_version }}"
+    update: true
+    force: true
+  become_user: "{{ n8n_user }}"
+
+- name: Ensure n8n repo ownership
+  ansible.builtin.file:
+    path: "{{ n8n_home }}"
+    state: directory
+    owner: "{{ n8n_user }}"
+    group: "{{ n8n_group }}"
+    recurse: true
+
+- name: Create n8n env file
+  ansible.builtin.template:
+    src: "{{ n8n_app_options.env_template | default('n8n.env.j2') }}"
+    dest: "{{ n8n_home }}/.env"
+    owner: "{{ n8n_user }}"
+    group: "{{ n8n_group }}"
+    mode: "0640"
+
+- name: Install n8n dependencies (pnpm install)
+  ansible.builtin.command: pnpm install --frozen-lockfile=false
+  args:
+    chdir: "{{ n8n_home }}"
+  become_user: "{{ n8n_user }}"
+
+- name: Build n8n
+  ansible.builtin.command: /bin/sh -lc "{{ n8n_build_command }}"
+  args:
+    chdir: "{{ n8n_home }}"
+  become_user: "{{ n8n_user }}"
+
+- name: Write n8n repo systemd unit
+  ansible.builtin.template:
+    src: "{{ n8n_app_options.systemd_template | default('n8n-repo.service.j2') }}"
+    dest: "/etc/systemd/system/{{ n8n_unit_name }}.service"
+    mode: "0644"
+  become: true
+  when: n8n_systemd
+
+- name: Reload systemd for n8n repo
+  ansible.builtin.systemd:
+    daemon_reload: true
+  become: true
+  when: n8n_systemd
+
+- name: Enable and start n8n repo
+  ansible.builtin.systemd:
+    name: "{{ n8n_unit_name }}.service"
+    enabled: true
+    state: started
+  become: true
+  when: n8n_systemd

tasks/main.yml

@@ -0,0 +1,12 @@
+---
+# tasks file for lsa.n8n
+
+- name: Configure n8n sites
+  include_tasks: config.yml
+  loop: "{{ n8n_sites | default([]) }}"
+  loop_control:
+    loop_var: n8n_site
+
+- name: Setup n8n readme
+  include_tasks: readme.yml
+  when: n8n_readme

tasks/readme.yml

@@ -0,0 +1,16 @@
+---
+# Readme Tasks
+
+- name: "Create Readme Directory"
+  ansible.builtin.file:
+    path: "{{ n8n_readme_path }}"
+    state: directory
+    mode: "{{ n8n_readme_mode }}"
+  become: true
+
+- name: "Update Readme"
+  ansible.builtin.template:
+    src: "n8n.md.j2"
+    dest: "{{ n8n_readme_path }}n8n.md"
+    mode: "{{ n8n_readme_mode }}"
+  become: true