nodered_ynh/README.md

---

<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->

# Node-RED for YunoHost

[![Integration level](https://dash.yunohost.org/integration/nodered.svg)](https://dash.yunohost.org/appci/app/nodered) ![](https://ci-apps.yunohost.org/ci/badges/nodered.status.svg)  ![](https://ci-apps.yunohost.org/ci/badges/nodered.maintain.svg)
[![Install nodered with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=nodered)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install nodered quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*

## Overview

Flow-based programming for the Internet of Things

**Shipped version:** 1.3.5~ynh1




## Screenshots


   ![](./doc/screenshots/screenshot.jpg)




## Disclaimers / important information

* YunoHost's permissions system enables to select which users can have access to Node-RED. Upon installation, the selected administrator is the sole user to have access.
* A `ui` permission is available in case you install the `node-red-dashboard` nodes. It makes the dashboard accessible to any authorized user or visitor, at `/ui` under Node-RED's address.
* A `nodes` permission is available in case you need to use the HTTP nodes. By default, visitors have access to these endpoints at `/red-nodes/...` under Node-RED's address.



## Documentation and resources

* Official app website: https://nodered.org
* Official user documentation: https://nodered.org/docs/

* Upstream app code repository:  https://github.com/node-red/node-red
* YunoHost documentation for this app: https://yunohost.org/app_nodered
* Report a bug: https://github.com/YunoHost-Apps/nodered_ynh/issues

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/nodered_ynh/tree/testing).

To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/nodered_ynh/tree/testing --debug
or
sudo yunohost app upgrade nodered -u https://github.com/YunoHost-Apps/nodered_ynh/tree/testing --debug
```

**More info regarding app packaging:** https://yunohost.org/packaging_apps