Skip to content

Latest commit

 

History

History
92 lines (56 loc) · 2.95 KB

CONTRIBUTING.MD

File metadata and controls

92 lines (56 loc) · 2.95 KB

NODE-RED

The tech stack used has a relatively simple setup process, install node js followed by nodered. You can either do this process in your local systems, or follow our docker setup process to use the power and portability of containers.

Node-red Using Docker

Setup

  • Use this line to create the image
docker run -it -p 1880:1880 -v <path_to_workspace_folder>:/data --name <name_of_container> ghcr.io/aadhityasw/iot-nodered:latest

After following through the whole process once, you can also use your own image here in place of ghcr.io/aadhityasw/iot-nodered:latest.

The path path_to_workspace_folder can be the path to any folder in the host computer. Its path should be stated as the absolute path to the location where we need the setup to exist to copy the files. But this is not required for the execution of the codes available here. So a simpler command can be :

docker run -it -p 1880:1880 --name ghcr.io/aadhityasw/iot-nodered:latest

This just sets up the image, creates a new container with the name specfied in <name_of_container>. It also sets up port forwarding in order for the server to run in that port.

Running the container

  • Use this command to start the container :
docker start -i <name_of_container>
  • Go to the url :
http://127.0.0.1:1880/
  • Use this to stop the container :
docker stop <name_of_container>

Making your own custom image with any changes made

  • Commit the container to image with your docker username, so as to save the changes made if any in the container
docker container commit <name_of_container> <docker_username>/<image_name>
  • Push this image to dockerhub
docker push <docker_username>/<image_name>

You can use any container registry of your choice, I have provided an example with docker, but there are others including the ones offered by github(ghcr), etc.

Using Node Red Installation

If you do choose to install node red directly on your system instead of using a docker container, here are a few key points to know, some of these can also be used for the usage with docker container as well

  • To know the version of node red installed Also runs the server
node-red -v
  • To run the node red server
node-red

  • To open the server that is run http://127.0.0.1:1880/

  • If you get any error while running this or shutting down or restarting the server, you can follow these steps, but they are just informal and just seemed to work for me :)

It should also me mentioned that I used a Mac OSX environment, and so some of this might not be suited for other environments

In case node red is stuck

    • Open Terminal.
    • Run the command with the port used : example : lsof -i :<port_number> (example : lsof -i :1880)
    • You will get an output with ProcessID - PID if some process is running on it..
    • Now kill the process by running the following command : kill -9 <PID> (example : kill -9 4133)