https://github.com/muhlba91/node-red-container

An opinionated Node-RED container
https://github.com/muhlba91/node-red-container

container node-red

Last synced: about 2 months ago
JSON representation

An opinionated Node-RED container

• Host: GitHub
• URL: https://github.com/muhlba91/node-red-container
• Owner: muhlba91
• License: mit
• Created: 2022-08-04T13:16:33.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-26T15:04:16.000Z (about 2 months ago)
• Last Synced: 2024-11-26T16:21:55.775Z (about 2 months ago)
• Topics: container, node-red
• Language: Dockerfile
• Homepage:
• Size: 69.3 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Node-RED Container

[![](https://img.shields.io/github/license/muhlba91/node-red-container?style=for-the-badge)](LICENSE)

[![](https://img.shields.io/github/actions/workflow/status/muhlba91/node-red-container/release.yml?style=for-the-badge)](https://github.com/muhlba91/node-red-container/actions/workflows/release.yml)

[![](https://api.scorecard.dev/projects/github.com/muhlba91/node-red-container/badge?style=for-the-badge)](https://scorecard.dev/viewer/?uri=github.com/muhlba91/node-red-container)

[![](https://img.shields.io/github/v/tag/muhlba91/node-red-container?style=for-the-badge)](https://github.com/muhlba91/node-red-container/releases)

[![](https://img.shields.io/github/release-date/muhlba91/node-red-container?style=for-the-badge)](https://github.com/muhlba91/node-red-container/releases)



An opinionated containerized version of [Node-RED](https://nodered.org).

---

## Installation Notes

Create your Node-RED configuration files locally and start the container:

```shell

$ docker run --name node-red \

  --network host \

  -v ${PWD}/config:/data \

  ghcr.io/muhlba91/node-red:

```

### Container Tags

The container images are tagged according to:

1. the Node-RED version and current release (`ghcr.io/muhlba91/node-red:`)

2. the Git Commit SHA (`ghcr.io/muhlba91/node-red:`)

### Helm Chart

The [app-template by bjw-s](https://github.com/bjw-s/helm-charts/tree/main/charts/other/app-template) is the recommended chart to use this container with.

For example, to mount a `packages.txt` file from a ConfigMap you can add the folloiwng block to your `values.yaml` file:

```yaml

persistence:

  packages:

    enabled: true

    type: configMap

    name: node-red-packages-config

    globalMounts:

      - path: /init

```

---

## Configuration

Mount your Node-RED configuration files in `/data` when running the container.

Alternatively, you can mount a `settings.js` file in `/init/settings.js` which will be copied the `/data` upon starting up.

If you want to install additional packages on start-up, create a file `packages.txt` and mount it in `/init/packages.txt`:

```txt

package@version

```

---

## Contributing

We welcome community contributions to this project.

## Supporting

If you enjoy the application and want to support my efforts, please feel free to buy me a coffe. :)