open-index/open-npm huggingface dataset:
npm package: @flowfuse/driver-docker
Description: Docker driver for FlowFuse
Author: FlowFuse Inc.
Latest version: 2.29.1

# FlowFuse Docker Container Driver

FlowFuse driver to create projects as docker containers

## Configuration

In the `flowforge.yml` file

```yaml
...
driver:
  type: docker
  options:
    socket: /tmp/docker.sock
    registry: containers.flowforge.com
    privateCA: /full/path/to/chain.pem
    logPassthrough: true
    storage:
      enabled: true
```

 - `registry` is the Docker Registry to load Stack Containers from (default: Docker Hub)
 - `socket` is the path to the docker unix domain socket (default: /var/run/docker.sock)
 - `privateCA`: is the fully qualified path to a pem file containing trusted CA cert chain (default: not set)
 - `logPassthrough` Have Node-RED logs printed in JSON format to container stdout (default: false)
 - `storage.enabled` enables volume-based persistent storage for Node-RED instance (default: false)

### Configuration via environment variables

 - `DOCKER_SOCKET` - Path to docker unix domain socket
npm package: @flowfuse/node-red-dashboard-2-migration
Description: A module that exposes a migration script for converting Dashboard 1.0 flows to Dashboard 2.0
Author: Joe Pavitt
Latest version: 0.0.4

# Node-RED Dashboard 2.0 Migration Script

This module provides a script with which you can pass in a Dashboard 1.0 flow, and in return, you will receive a Dashboard 2.0 flow.

Please note that this script does not cover everything, see below for a list of currently supported nodes that can be migrated. The script will be improved over time, and we're open to pull requests to enhance it's functionality.

## Supported Nodes

### Nodes

- `ui_text` - converted to Dashboard 2.0's `ui-text`
- `ui_form` - converted to Dashboard 2.0's `ui-form`
- `ui_button` - converted to Dashboard 2.0's `ui-button`
- `ui_dropdown` - converted to Dashboard 2.0's `ui-dropdown`
- `ui_switch` - converted to Dashboard 2.0's `ui-switch`
    - `.tooltip` is not supported
    - `.decouple` is not supported
    - `.animate` is not supported
- `ui_slider` - converted to Dashboard 2.0's `ui-slider`
- `ui_text_input` - converted to Dashboard 2.0's `ui-text-input`
    - `.tooltip` is not supported
- `ui_numeric` - converted to Dashboard 2.0's `ui-numeric-input`
    
### Config Nodes

- `ui_tab` - converted to Dashboard 2.0's `ui-page`
- `ui_group` - converted to Dashboard 2.0's `ui-group`

### Added

- `ui-base` - Not included in a Dashboard 1.0 `flow.json` export, so we create a standard default in it's place.
- `ui-theme` - Not included in a Dashboard 1.0 `flow.json` export, so we create a standard default in it's place.

## Not Yet Supported:

- `ui_date_picker` - [link](https://github.com/FlowFuse/node-red-dashboard-2-migration/issues/22)
- `ui_colour_picker` - [link](https://github.com/FlowFuse/node-red-dashboard-2-migration/issues/23)
- `ui_gauge` - [link](https://github.com/FlowFuse/node-red-dashboard-2-migration/issues/26)
- `ui_chart` - [link](https://github.com/FlowFuse/node-red-dashboard-2-migration/issues/27)
- `ui_audio` - [link](https://github.com/FlowFuse/node-red-dashboard-2-migration/issues/28)
- `ui_toast` - [link](https://github.com/FlowFuse/node-red-dashboard-2-migration/issues/29)
- `ui_control` - [link](https://github.com/FlowFuse/node-red-dashboard-2-migration/issues/30)
- `ui_template` - [link](https://github.com/FlowFuse/node-red-dashboard-2-migration/issues/31)

## Usage

### Terminal

To run this module from the terminal, you can run:

```bash
cd path/to/your/node-red-dashboard-2-migration
node migrate path/to/your/flow.json
```

The script will then print to the terminal a valid `flow.json` which you can copy and paste into your Node-RED editor, via Node-RED's import functionality.

### JavaScript

To run this module from within a `js` environment, you can run:

```js
const d1flow = require('./path/to/your/flow.json')
const MigrateDashboard = require('node-red-dashboard-2-migration')
const d2flow = MigrateDashboard.migrate(d1flow)
```
npm package: @flowfuse/node-red-dashboard-2-ui-iframe
Description: A Node-RED Dashboard 2.0 widget that allows you to embed an iframe into your dashboard
Author: Joe Pavitt
Latest version: 1.1.0

# Dashboard 2.0 Node: `ui-frame`

This node allows you to embed an external webpage into your Dashboard 2.0 applications using an iframe. This can be useful for displaying content from other services or websites.

## Configuration

### Properties

- **size**: Width and height of the iframe in the context of the Dashboard layout. It's recommended _not_ to use _"auto"_ sizing.
- **src**: The URL of the webpage you want to embed in the iframe.

### Dynamic Configuration

You can override the `src` value defined in Node-RED by passing a `msg.src` value to the iframe. This can be useful for dynamically changing the content of the iframe based on user input or other events.
npm package: @flowfuse/node-red-dashboard-2-ui-led
Description: A simple LED status indicator for the Node-RED Dashboard 2.0
Author: Joe Pavitt
Latest version: 1.1.0

# UI LED (Node-RED Dashboard 2.0 Widget)

This repository contains the code base for `ui-led`, a third-party node for the [Node-RED Dashboard 2.0](https://dashboard.flowfuse.com).

<img width="500" alt="Screenshot 2024-02-17 at 09 55 55" src="https://github.com/FlowFuse/node-red-dashboard-2-ui-led/assets/99246719/e90ebb01-a62b-4332-bb2e-958c77d8a798">

## Configuration Options

The `ui-led` node has the following configuration options:

### General

<img width="500" alt="Screenshot 2024-02-17 at 10 02 43" src="https://github.com/FlowFuse/node-red-dashboard-2-ui-led/assets/99246719/8ed8de2a-d300-483d-a2c3-720fe296cf25">

- **Name**: The name of the node within the context of the Node-RED editor.
- **Group**: The UI Group that the LED will render inside.
- **Size**: The relative size of the LED with `width` x `height`

### Label Styling 

<img width="500" alt="Screenshot 2024-02-17 at 10 02 28" src="https://github.com/FlowFuse/node-red-dashboard-2-ui-led/assets/99246719/d82ee430-bdeb-4ae1-bc3b-0a375f41b72d">

- **Text**: The label to display next to the LED.
- **Placement**: Which side of the LED the label will be displayed.
- **Alignment**: Within the space to the left/right of the LED, how the label will be aligned in that space.

### LED Styling

<img width="500" alt="Screenshot 2024-02-17 at 10 01 59" src="https://github.com/FlowFuse/node-red-dashboard-2-ui-led/assets/99246719/0709968e-60cd-4f20-a082-46d4be0ff3b7">

- **Shape**: "Circle" or "Square"
- **Show Border**: Should the LED have a fixed border around the shape, emulating a physical LED.
- **Show Glow**: Should the LED have a glow effect.

### Values

<img width="500" alt="Screenshot 2024-02-17 at 10 01 44" src="https://github.com/FlowFuse/node-red-dashboard-2-ui-led/assets/99246719/debe5d84-454f-43f4-82b9-a48f29b12307">

- Maps a value to a respective color. If a value is provided that it doesn't recognise, a general grey color will be used.
npm package: @flowfuse/nr-tools-plugin
Description: A Node-RED plugin that adds FlowFuse platform tools to the editor
Author: FlowFuse Inc.
Latest version: 0.4.1

# FlowFuse Node-RED Tools plugin

A Node-RED Plugin that allows you to interact with the FlowFuse platform.

Please consult the [FlowFuse documentation](https://flowfuse.com/docs/migration/node-red-tools/) on how to
install and use this plugin.