finalgene.node_red
Ansible Role node_red
Description
This role helps in installing and configuring Node-RED easily.
It includes a script called /usr/local/bin/node-red-backup
for backing up and restoring your configuration and projects.
Requirements
None
Role Variables
Variable | Type | Default | Comments |
---|---|---|---|
nodered_domain_name | string | {{ inventory_hostname }} |
The domain name for the Node-RED host. |
nodered_extra_npm_packages | array | List of NPM packages that Node-RED will use. | |
nodered_user | string | nodered |
The username that runs Node-RED. |
nodered_group | string | {{ nodered_user }} |
The main group name of the user running Node-RED. |
nodered_groups | array | List of extra groups the user should be part of. | |
nodered_allow_low_ports | boolean | false |
Allows binding to ports below 1024. |
nodered_update_nodes | boolean | false |
Runs npm update on existing installed nodes (as listed in package.json). |
nodered_flow_file | string | flows.json |
The file name that contains the flow. |
nodered_credential_secret | string | Key used to encrypt stored credentials. | |
nodered_config_directory | string | The folder where Node-RED configuration files are stored. | |
nodered_admin_users | array | Editor & Admin API security. | |
nodered_https_private_key_file | string | The content of the private key file for HTTPS. | |
nodered_https_certificate_file | string | The content of the HTTPS certificate file. | |
nodered_require_https | boolean | false |
Enables HTTPS. |
nodered_ui_host | string | The address where the UI server listens. | |
nodered_ui_port | integer | 1880 |
The port number for the UI server. |
nodered_api_max_length | string | 5mb |
Maximum size of HTTP requests accepted by the runtime API. |
nodered_lang | string | en-US |
Preferred language for Node-RED. Available options: en-US, ja, de, zh-CN, zh-TW, ru, ko. |
nodered_diagnostics_enabled | boolean | true |
If true , the Node-RED diagnostics endpoint is active. |
nodered_diagnostics_ui | boolean | true |
If true , the Node-RED diagnostics UI is active. |
nodered_runtime_state_enabled | boolean | true |
If true , the Node-RED runtime state endpoint is active. |
nodered_runtime_state_ui | boolean | true |
If true , the Node-RED runtime state UI is active. |
nodered_logging_console_level | string | info |
Defines the logging level (see Logging level). |
nodered_logging_console_metrics | boolean | false |
If true , Node-RED will output flow execution and memory usage information (see Logging metrics). |
nodered_logging_console_audit | boolean | false |
If true , logs HTTP API access events including endpoint, IP address, and timestamp (see Logging audit). |
nodered_context_storage | object | default.module: 'memory' |
Configuration for the context store (see Context Store API). |
nodered_external_modules_auto_install | boolean | true |
Whether the runtime will automatically install missing modules. |
nodered_external_modules_palette_allow_install | boolean | true |
Allows the Palette Manager in the editor to add new modules. |
nodered_external_modules_palette_allow_update | boolean | true |
Allows updates of modules in the Palette Manager. |
nodered_external_modules_palette_allow_upload | boolean | true |
Enables uploading and installing of module tgz files. |
nodered_external_modules_module_allow_install | boolean | true |
Allows installation of node-specified modules. |
nodered_disable_editor | boolean | false |
Disables the Node-RED editor, but the admin API remains active. |
Dependencies
- git
- npm >=5.8
- nodejs >=10
Example Playbook
- name: install Node-Red
hosts: all
become: true
roles:
- finalgene.node_red
License
MIT
Author Information
Installa
ansible-galaxy install finalgene.node_red
Licenza
Unknown
Download
391
Proprietario
Software Development