Pull latest readme. volume updates etc across to master (#202)

Author: dceejay

Diff for: .docker/Dockerfile.alpine

@@ -37,6 +37,7 @@ WORKDIR /usr/src/node-red
 
 # package.json contains Node-RED NPM module and node dependencies
 COPY package.json .
+COPY flows.json /data
 
 #### Stage BUILD #######################################################################################################
 FROM base AS build
@@ -88,9 +89,6 @@ ENV NODE_RED_VERSION=$NODE_RED_VERSION \
 # ENV NODE_RED_ENABLE_SAFE_MODE=true    # Uncomment to enable safe start mode (flows not running)
 # ENV NODE_RED_ENABLE_PROJECTS=true     # Uncomment to enable projects option
 
-# User configuration directory volume
-VOLUME ["/data"]
-
 # Expose the listening port of node-red
 EXPOSE 1880
 

Diff for: README.md

@@ -15,13 +15,14 @@ Previous 0.20.x versions are still available at https://hub.docker.com/r/nodered
 ## Quick Start
 To run in Docker in its simplest form just run:
 
-        docker run -it -p 1880:1880 --name mynodered nodered/node-red
+        docker run -it -p 1880:1880 -v node_red_data:/data --name mynodered nodered/node-red
 
 Let's dissect that command:
 
         docker run              - run this container, initially building locally if necessary
         -it                     - attach a terminal session so we can see what is going on
         -p 1880:1880            - connect local port 1880 to the exposed internal port 1880
+        -v node_red_data:/data  - mount the host node_red_data directory to the container /data directory so any changes made to flows are persisted
         --name mynodered        - give this machine a friendly local name
         nodered/node-red        - the image to base it on - currently Node-RED v1.1.3
 
@@ -101,7 +102,7 @@ The minimal versions (without python and build tools) are not able to install no
 
 For example - to run the latest minimal version, you would run
 ```
-docker run -it -p 1880:1880 --name mynodered nodered/node-red:latest-minimal
+docker run -it -p 1880:1880 -v node_red_data:/data --name mynodered nodered/node-red:latest-minimal
 ```
 
 The Node-RED images are based on [official Node JS Alpine Linux](https://hub.docker.com/_/node/) images to keep them as small as possible.
@@ -186,7 +187,7 @@ Therefore all tags regarding Raspberry PI's are dropped.
 
 For example: suppose you are running on a Raspberry PI 3B, which has `arm32v7` as architecture. Then just run the following command to pull the image (tagged by `1.1.3-10-arm32v7`), and run the container.
 ```
-docker run -it -p 1880:1880 --name mynodered nodered/node-red:latest
+docker run -it -p 1880:1880 -v node_red_data:/data --name mynodered nodered/node-red:latest
 ```
 
 The same command can be used for running on an amd64 system, since docker discovers its running on a amd64 host and pulls the image with the matching tag (`1.1.3-10-amd64`).
@@ -195,7 +196,8 @@ This gives the advantage that you don't need to know/specify which architecture
 
 **Note**: Currently there is a bug in Docker's architecture detection that fails for `arm32v6` - eg Raspberry Pi Zero or 1. For these devices you currently need to specify the full image tag, for example:
 ```
-docker run -it -p 1880:1880 --name mynodered nodered/node-red:1.1.3-10-minimal-arm32v6
+docker run -it -p 1880:1880 -v node_red_data:/data --name mynodered nodered/node-red:1.1.3-10-minimal-arm32v6
+
 ```
 
 ## Raspberry PI - native GPIO support
@@ -256,17 +258,17 @@ to store persistent or shared data outside the container.
 To create a new named data volume to persist our user data and run a new
 container using this volume.
 
-        $ docker volume create --name node_red_user_data
+        $ docker volume create --name node_red_data_vol
         $ docker volume ls
         DRIVER              VOLUME NAME
-        local               node_red_user_data
-        $ docker run -it -p 1880:1880 -v node_red_user_data:/data --name mynodered nodered/node-red
+        local               node_red_data_vol
+        $ docker run -it -p 1880:1880 -v node_red_data_vol:/data --name mynodered nodered/node-red
 
 Using Node-RED to create and deploy some sample flows, we can now destroy the
 container and start a new instance without losing our user data.
 
         $ docker rm mynodered
-        $ docker run -it -p 1880:1880 -v node_red_user_data:/data --name mynodered nodered/node-red
+        $ docker run -it -p 1880:1880 -v node_red_data_vol:/data --name mynodered nodered/node-red
 
 ## Updating
 
@@ -350,7 +352,7 @@ The flows configuration file is set using an environment parameter (**FLOWS**),
 which defaults to *'flows.json'*. This can be changed at runtime using the
 following command-line flag.
 ```
-docker run -it -p 1880:1880 -e FLOWS=my_flows.json nodered/node-red
+docker run -it -p 1880:1880 -e FLOWS=my_flows.json -v node_red_data:/data nodered/node-red
 ```
 
 **Note**: If you set `-e FLOWS=""` then the flow file can be set via the *flowFile*
@@ -360,7 +362,7 @@ Node.js runtime arguments can be passed to the container using an environment
 parameter (**NODE_OPTIONS**). For example, to fix the heap size used by
 the Node.js garbage collector you would use the following command.
 ```
-docker run -it -p 1880:1880 -e NODE_OPTIONS="--max_old_space_size=128" nodered/node-red
+docker run -it -p 1880:1880 -e NODE_OPTIONS="--max_old_space_size=128" -v node_red_data:/data nodered/node-red
 ```
 
 Other useful environment variables include
@@ -439,49 +441,55 @@ docker id number and be running on a random port... to find out run
 You can now point a browser to the host machine on the tcp port reported back, so in the example
 above browse to  `http://{host ip}:49154`
 
+**NOTE**: as this does not mount the `/data` volume externally any changes to flows will not be saved and if the container is redeployed or upgraded these will be lost. The volume may persist on the host filing sysem and can probably be retrieved and remounted if required.
+
 ## Linking Containers
 
-You can link containers "internally" within the docker runtime by using the --link option.
+You can link containers "internally" within the docker runtime by using Docker [user-defined bridges](https://docs.docker.com/network/bridge/).
+
+Before using a bridge, it needs to be created.  The command below will create a new bridge called **iot**
+
+    docker network create iot
 
-For example I have a simple MQTT broker container available as
+Then all containers that need to communicate need to be added to the same bridge using the **--network** command line option
 
-        docker run -it --name mybroker eclipse-mosquitto
+    docker run -itd --network iot --name mybroker eclipse-mosquitto
 
 (no need to expose the port 1883 globally unless you want to... as we do magic below)
 
-Then run nodered docker - but this time with a link parameter (name:alias)
+Then run nodered docker, also added to the same bridge
 
-        docker run -it -p 1880:1880 --name mynodered --link mybroker:broker nodered/node-red
+    docker run -itd -p 1880:1880 --network iot --name mynodered nodered/node-red
 
-the magic here being the `--link` that inserts a entry into the node-red instance
-hosts file called *broker* that links to the external mybroker instance....  but we do
-expose the 1880 port so we can use an external browser to do the node-red editing.
+containers on the same user-defined bridge can take advantage of the built in name resolution provided by the bridge and use the container name (specified using the **--name** option) as the target hostname.  
 
-Then a simple flow like below should work - using the alias *broker* we just set up a second ago.
 
-        [{"id":"190c0df7.e6f3f2","type":"mqtt-broker","broker":"broker","port":"1883","clientid":""},{"id":"37963300.c869cc","type":"mqtt in","name":"","topic":"test","broker":"190c0df7.e6f3f2","x":226,"y":244,"z":"f34f9922.0cb068","wires":[["802d92f9.7fd27"]]},{"id":"edad4162.1252c","type":"mqtt out","name":"","topic":"test","qos":"","retain":"","broker":"190c0df7.e6f3f2","x":453,"y":135,"z":"f34f9922.0cb068","wires":[]},{"id":"13d1cf31.ec2e31","type":"inject","name":"","topic":"","payload":"","payloadType":"date","repeat":"","crontab":"","once":false,"x":226,"y":157,"z":"f34f9922.0cb068","wires":[["edad4162.1252c"]]},{"id":"802d92f9.7fd27","type":"debug","name":"","active":true,"console":"false","complete":"false","x":441,"y":261,"z":"f34f9922.0cb068","wires":[]}]
+In the above example the broker can be reached from the Node-RED application using hostname *mybroker*.
+
+Then a simple flow like below show the mqtt nodes connecting to the broker
+
+        [{"id":"c51cbf73.d90738","type":"mqtt in","z":"3fa278ec.8cbaf","name":"","topic":"test","broker":"5673f1d5.dd5f1","x":290,"y":240,"wires":[["7781c73.639b8b8"]]},{"id":"7008d6ef.b6ee38","type":"mqtt out","z":"3fa278ec.8cbaf","name":"","topic":"test","qos":"","retain":"","broker":"5673f1d5.dd5f1","x":517,"y":131,"wires":[]},{"id":"ef5b970c.7c864","type":"inject","z":"3fa278ec.8cbaf","name":"","repeat":"","crontab":"","once":false,"topic":"","payload":"","payloadType":"date","x":290,"y":153,"wires":[["7008d6ef.b6ee38"]]},{"id":"7781c73.639b8b8","type":"debug","z":"3fa278ec.8cbaf","name":"","active":true,"tosidebar":true,"console":false,"tostatus":true,"complete":"payload","targetType":"msg","statusVal":"payload","statusType":"auto","x":505,"y":257,"wires":[]},{"id":"5673f1d5.dd5f1","type":"mqtt-broker","z":"","name":"","broker":"mybroker","port":"1883","clientid":"","usetls":false,"compatmode":false,"keepalive":"15","cleansession":true,"birthTopic":"","birthQos":"0","birthRetain":"false","birthPayload":"","closeTopic":"","closeRetain":"false","closePayload":"","willTopic":"","willQos":"0","willRetain":"false","willPayload":""}]
 
 This way the internal broker is not exposed outside of the docker host - of course
-you may add `-p 1883:1883`  etc to the broker run command if you want to see it...
+you may add `-p 1883:1883`  etc to the broker run command if you want other systems outside your computer to be able to use the broker.
 
 ### Docker-Compose linking example
 
 Another way to link containers is by using docker-compose. The following docker-compose.yml
-file creates a Node-RED instance, and a local MQTT broker instance. In the Node-RED flow the broker can be addressed simply as `broker` at its default port `1883`.
+file creates a Node-RED instance, and a local MQTT broker instance. In the Node-RED flow the broker can be addressed simply as `mybroker` at its default port `1883`.
 
 ```
 version: "3.7"
 
 services:
-  node-red:
+  mynodered:
     image: nodered/node-red
     restart: unless-stopped
     volumes:
       - /home/pi/.node-red:/data
     ports:
       - 1880:1880
-
-  broker:
+  mybroker:
     image: eclipse-mosquitto
     restart: unless-stopped
 ```
@@ -492,12 +500,12 @@ Sometimes it is useful to debug the code which is running inside the container.
 
 1. In most cases the *'debug'* script will be sufficient, to debug a Node-RED application that is fully up-and-running (i.e. when the application startup code is not relevant).  The NodeJs server can be started in debug mode using following command:
    ```
-   docker run -it -p 1880:1880 -p 9229:9229 --name mynodered --entrypoint npm nodered/node-red run debug -- --userDir /data
+   docker run -it -p 1880:1880 -p 9229:9229 -v node_red_data:/data --name mynodered --entrypoint npm nodered/node-red run debug -- --userDir /data
    ```
 
 2. In case debugging of the Node-RED startup code is required, the  *'debug_brk'* script will instruct NodeJs to break at the first statement of the Node-RED application.  The NodeJs server can be started in debug mode using following command:
    ```
-   docker run -it -p 1880:1880 -p 9229:9229 --name mynodered --entrypoint npm nodered/node-red run debug_brk -- --userDir /data
+   docker run -it -p 1880:1880 -p 9229:9229 -v node_red_data:/data --name mynodered --entrypoint npm nodered/node-red run debug_brk -- --userDir /data
    ```
    Note that in this case NodeJs will wait - at the first statement of the Node-RED application - until a debugger client connects...
 
@@ -512,6 +520,7 @@ Let's dissect both commands:
         -it                     - attach a terminal session so we can see what is going on
         -p 1880:1880            - connect local port 1880 to the exposed internal port 1880
         -p 9229:9229            - connect local port 9229 to the exposed internal port 9229 (for debugger communication)
+        -v node_red_data:/data  - mount the internal /data to the host mode_red_data directory 
         --name mynodered        - give this machine a friendly local name
         --entrypoint npm        - overwrite the default entrypoint (which would run the *'start'* script)
         nodered/node-red        - the image to base it on - currently Node-RED v1.1.0
@@ -533,7 +542,7 @@ on permissions.
 If you are seeing *permission denied* errors opening files or accessing host devices, try running the container as the root user.
 
 ```
-docker run -it -p 1880:1880 --name mynodered -u root nodered/node-red
+docker run -it -p 1880:1880 -v node_red_data:/data --name mynodered -u root nodered/node-red
 ```
 
 __References:__  
@@ -549,7 +558,7 @@ https://github.com/node-red/node-red/issues/8
 If you want to access a device from the host inside the container, e.g. serial port, use the following command-line flag to pass access through.
 
 ```
-docker run -it -p 1880:1880 --name mynodered --device=/dev/ttyACM0 nodered/node-red
+docker run -it -p 1880:1880 -v node_red_data:/data --name mynodered --device=/dev/ttyACM0 nodered/node-red
 ```
 __References:__   
 
@@ -562,7 +571,7 @@ https://github.com/node-red/node-red/issues/15
 If you want to modify the default timezone, use the TZ environment variable with the [relevant timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
 
 ```
-docker run -it -p 1880:1880 --name mynodered -e TZ=Europe/London nodered/node-red
+docker run -it -p 1880:1880 -v node_red_data:/data --name mynodered -e TZ=Europe/London nodered/node-red
 ```
 
 __References:__  

Diff for: docker-custom/Dockerfile.custom

@@ -1,5 +1,5 @@
 ARG ARCH=amd64
-ARG NODE_VERSION=10
+ARG NODE_VERSION=12
 ARG OS=alpine
 
 #### Stage BASE ########################################################################################################
@@ -32,6 +32,7 @@ WORKDIR /usr/src/node-red
 
 # package.json contains Node-RED NPM module and node dependencies
 COPY package.json .
+COPY flows.json /data
 
 #### Stage BUILD #######################################################################################################
 FROM base AS build
@@ -81,9 +82,6 @@ ENV NODE_RED_VERSION=$NODE_RED_VERSION \
 # ENV NODE_RED_ENABLE_SAFE_MODE=true    # Uncomment to enable safe start mode (flows not running)
 # ENV NODE_RED_ENABLE_PROJECTS=true     # Uncomment to enable projects option
 
-# User configuration directory volume
-VOLUME ["/data"]
-
 # Expose the listening port of node-red
 EXPOSE 1880
 

Diff for: docker-custom/Dockerfile.debian

@@ -0,0 +1,92 @@
+ARG ARCH=amd64
+ARG NODE_VERSION=12
+ARG OS=buster-slim
+
+#### Stage BASE ########################################################################################################
+FROM ${ARCH}/node:${NODE_VERSION}-${OS} AS base
+
+# Copy scripts
+COPY scripts/*.sh /tmp/
+
+# Install tools, create Node-RED app and data dir, add user and set rights
+RUN set -ex && \
+    apt-get update && apt-get install -y \
+        bash \
+        tzdata \
+        curl \
+        nano \
+        wget \
+        git \
+        openssl \
+        openssh-client && \
+    mkdir -p /usr/src/node-red /data && \
+    deluser --remove-home node && \
+    # adduser --home /usr/src/node-red --disabled-password --no-create-home node-red --uid 1000 && \
+    useradd --home-dir /usr/src/node-red --uid 1000 node-red && \
+    chown -R node-red:root /data && chmod -R g+rwX /data && \ 
+    chown -R node-red:root /usr/src/node-red && chmod -R g+rwX /usr/src/node-red
+    # chown -R node-red:node-red /data && \
+    # chown -R node-red:node-red /usr/src/node-red
+
+# Set work directory
+WORKDIR /usr/src/node-red
+
+# package.json contains Node-RED NPM module and node dependencies
+COPY package.json .
+COPY flows.json /data
+
+#### Stage BUILD #######################################################################################################
+FROM base AS build
+
+# Install Build tools
+RUN apt-get update && apt-get install -y build-essential python && \
+    npm install --unsafe-perm --no-update-notifier --no-fund --only=production && \
+    npm uninstall node-red-node-gpio && \
+    cp -R node_modules prod_node_modules
+
+#### Stage RELEASE #####################################################################################################
+FROM base AS RELEASE
+ARG BUILD_DATE
+ARG BUILD_VERSION
+ARG BUILD_REF
+ARG NODE_RED_VERSION
+ARG ARCH
+ARG TAG_SUFFIX=default
+
+LABEL org.label-schema.build-date=${BUILD_DATE} \
+    org.label-schema.docker.dockerfile=".docker/Dockerfile.debian" \
+    org.label-schema.license="Apache-2.0" \
+    org.label-schema.name="Node-RED" \
+    org.label-schema.version=${BUILD_VERSION} \
+    org.label-schema.description="Low-code programming for event-driven applications." \
+    org.label-schema.url="https://nodered.org" \
+    org.label-schema.vcs-ref=${BUILD_REF} \
+    org.label-schema.vcs-type="Git" \
+    org.label-schema.vcs-url="https://github.com/node-red/node-red-docker" \
+    org.label-schema.arch=${ARCH} \
+    authors="Dave Conway-Jones, Nick O'Leary, James Thomas, Raymond Mouthaan"
+
+COPY --from=build /usr/src/node-red/prod_node_modules ./node_modules
+
+# Chown, install devtools & Clean up
+RUN chown -R node-red:root /usr/src/node-red && \
+    apt-get update && apt-get install -y build-essential python-dev python3 && \
+    rm -r /tmp/*
+
+USER node-red
+
+# Env variables
+ENV NODE_RED_VERSION=$NODE_RED_VERSION \
+    NODE_PATH=/usr/src/node-red/node_modules:/data/node_modules \
+    FLOWS=flows.json
+
+# ENV NODE_RED_ENABLE_SAFE_MODE=true    # Uncomment to enable safe start mode (flows not running)
+# ENV NODE_RED_ENABLE_PROJECTS=true     # Uncomment to enable projects option
+
+# Expose the listening port of node-red
+EXPOSE 1880
+
+# Add a healthcheck (default every 30 secs)
+# HEALTHCHECK CMD curl http://localhost:1880/ || exit 1
+
+ENTRYPOINT ["npm", "start", "--cache", "/data/.npm", "--", "--userDir", "/data"]