Skip to content

Commit b8b483e

Browse files
authored
Merge pull request #6858 from FlowFuse/refersh-documentation
Docs: update documentation to reflect latest release changes
2 parents ba17ef4 + 7df5643 commit b8b483e

3 files changed

Lines changed: 38 additions & 6 deletions

File tree

docs/device-agent/running.md

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,12 @@ The following command line options are available:
4646
```
4747
Options
4848
49-
-c, --config file Device configuration file. Default: device.yml
50-
-d, --dir dir Where the agent should store its state. Default: /opt/flowfuse-device
49+
-c, --config file Device configuration file. Default: device.yml
50+
-d, --dir dir Where the agent should store its state. Default: /opt/flowfuse-device
5151
-i, --interval secs
5252
-p, --port number
53-
-m, --moduleCache Use local npm module cache rather than install
54-
--node-options Adds NodeJS command line arguments, can be specified multiple times, you must include = between the option and the value
53+
-m, --moduleCache Use local npm module cache rather than install
54+
--node-options string Node.js command-line options to pass to the Node-RED process. Can be specified multiple times. You must use `=` between the option and its value.
5555
5656
Web UI Options
5757
@@ -90,10 +90,36 @@ _Start the agent with a different working directory and the Web UI enabled_
9090
flowfuse-device-agent -d /path/to/working/directory -w --ui-user admin --ui-pass password --ui-port 8081
9191
```
9292

93-
_Start the agent with a larger NodeJS memory space and using the openssl CA certs_
93+
## Configuring Node.js Options
94+
95+
Node.js command-line arguments can be passed to the Node-RED process started by the Device Agent. This is useful for memory-intensive workflows or certificate management.
96+
97+
### Via command line
98+
99+
Use `--node-options` — it can be specified multiple times:
94100

95101
```bash
96-
flowfuse-device-agent -d /path/to/working/directory --node-options='--max-old-space-size=1024' --node_options='--use-openssl-ca'
102+
# Set a custom heap size limit
103+
flowfuse-device-agent --node-options='--max-old-space-size=256'
104+
105+
# Enable system certificate authorities (Linux)
106+
flowfuse-device-agent --node-options='--use-openssl-ca'
107+
108+
# Enable system certificate authorities (Windows/macOS)
109+
flowfuse-device-agent --node-options='--use-system-ca'
110+
111+
# Combine multiple options
112+
flowfuse-device-agent --node-options='--max-old-space-size=256' --node-options='--use-openssl-ca'
113+
```
114+
115+
### Via `device.yml`
116+
117+
Add a `nodeOptions` array to the `device.yml` configuration file:
118+
119+
```yaml
120+
nodeOptions:
121+
- "--max-old-space-size=256"
122+
- "--use-openssl-ca"
97123
```
98124
99125
## Running behind a HTTP Proxy

docs/user/expert/chat.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,12 @@ If you have multiple questions, consider asking them separately so the Expert ca
191191

192192
*See also: [Node-RED Embedded AI](/docs/user/expert/node-red-embedded-ai/) for AI features built directly into the Node-RED editor.*
193193

194+
## Keeping Expert Up to Date
195+
196+
When a newer version of FlowFuse Expert is available, a banner appears in the chat area to let you know. You can update with a single click directly from the notification, without leaving your current workflow.
197+
198+
![FlowFuse Expert Update Banner](../images/assistant/ff-expert-update-banner.gif){data-zoomable}
199+
194200
<style>
195201
.assistant-feature {
196202
border: 1px solid #ddd;
132 KB
Loading

0 commit comments

Comments
 (0)