Describe the problem/error/question
Hi! I’m setting up a custom nodes development environment + deployment using docker (for easy sharing across OSs). The only thing I’m missing for making it great, is having the ReloadNodesAndCredentials functionality that I’ve seen it’s skipped for the docker images and production build.
I see different approaches going forward, but I would like to have your thoughts:
First, I assume that it’s removed to prevent any code injection into the docker.
- I can build my own n8n image from the source code, but it has the problem of building it and keeping it up to date with your images
- Or, you can add it to docker and conditionally remove it in the docker-entrypoint.sh based on a Environment variable flag that we can change to keep that functionality while developing but not in the prod image.
My idea is to use this to improve the PR I made a week ago to the template repo to smooth everything out, specially with the problem with symlinks, mounted docker volumes and non-root users (Previous post). This is what I have:
docker-compose.override.yaml
version: "3"
services:
n8n:
image: redacted-repo/n8n-customized
restart: unless-stopped
user: "1000:1000"
build:
dockerfile: ./docker/Dockerfile
context: .
target: base
ports:
- "5678:5678"
environment:
- GENERIC_TIMEZONE=${GENERIC_TIMEZONE}
- NODE_OPTIONS="--max-old-space-size=2048"
- N8N_LOG_LEVEL=debug
- N8N_DEV_RELOAD=true
volumes:
- n8n-data:/home/node/.n8n
- .:/custom-nodes
volumes:
n8n-data:
name: n8n-data
external: true
run-dev.sh
#!/bin/sh
N8N_PATH="${N8N_USER_FOLDER:-$HOME}/.n8n/nodes/"
echo Starting...
mkdir -p "${N8N_PATH}" && echo "Created folder ${N8N_PATH}"
cd "${N8N_PATH}" && echo "Moved to folder ${N8N_PATH}"
pnpm add file:/custom-nodes && echo "Linked custom nodes to ${N8N_PATH}"
/docker-entrypoint.sh
Dockerfile (I need to install PNPM globally but in a non-root folder because the issues with symlinks I mentioned previously)
# Base image for the final layer. Written here for ease of configuration
FROM redacted-repo/n8n:latest AS base
ENV PNPM_HOME="/home/node/pnpm"
ENV PATH="$PNPM_HOME:$PATH"
# https://github.com/sindresorhus/guides/blob/main/npm-global-without-sudo.md
ENV NPM_PACKAGES="/home/node/.npm-packages"
ENV PATH="$PATH:$NPM_PACKAGES/bin"
RUN npm config set prefix "/home/node/.npm-packages"
RUN npm i npm@latest -g
RUN npm install -g pnpm rimraf
# Debug reasons
COPY --chown=node:node --chmod=755 ./docker/run-dev.sh /run-dev.sh
ENTRYPOINT [ "tini", "--", "/run-dev.sh" ]
FROM node:18-alpine AS base-build
ENV PNPM_HOME="/pnpm"
ENV PATH="$PNPM_HOME:$PATH"
RUN npm i npm@latest -g
RUN npm install -g pnpm rimraf
FROM base-build AS build
WORKDIR /build
COPY . .
RUN --mount=type=cache,id=pnpm,target=/pnpm/store pnpm install --frozen-lockfile --prefer-offline
RUN pnpm run build
FROM base-build as prod-deps
WORKDIR /deps
COPY --from=build /build/dist/package.json .
COPY --from=build /build/pnpm-lock.yaml .
RUN --mount=type=cache,id=pnpm,target=/pnpm/store pnpm install --prod --frozen-lockfile --prefer-offline
# Final build, from n8n
FROM base as final
WORKDIR /custom-nodes
COPY --from=build --chown=node:node /build/dist ./dist
COPY --from=build --chown=node:node /build/dist/package.json .
COPY --from=build --chown=node:node /build/pnpm-lock.yaml .
COPY --from=prod-deps --chown=node:node /deps/node_modules ./node_modules
COPY --from=build --chown=node:node --chmod=755 /build/docker/run.sh /run.sh
WORKDIR /installed-nodes
RUN pnpm config set node-linker hoisted
RUN pnpm config set symlink false
RUN pnpm add file:/custom-nodes
RUN pnpm install
ENTRYPOINT [ "tini", "--", "/run.sh" ]