Skip to content

Commit 19dad78

Browse files
committed
Updates Project Documentation
This commit updates project documentation to document the new persistent storage settings.
1 parent cfe1743 commit 19dad78

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Node-RED FileMaker nodes. These nodes use [fms-api-client](https://github.com/Lu
66

77
[![npm version](https://badge.fury.io/js/node-red-contrib-filemaker.svg)](https://www.npmjs.com/package/node-red-contrib-filemaker) [![Build Status](https://travis-ci.com/Luidog/node-red-contrib-filemaker.svg?branch=master)](https://travis-ci.com/Luidog/node-red-contrib-filemaker) [![Coverage Status](https://img.shields.io/coveralls/Luidog/node-red-contrib-filemaker/master.svg)](https://coveralls.io/r/Luidog/node-red-contrib-filemaker?branch=master) [![Known Vulnerabilities](https://snyk.io/test/github/Luidog/node-red-contrib-filemaker/badge.svg?targetFile=package.json)](https://snyk.io/test/github/Luidog/node-red-contrib-filemaker?targetFile=package.json)
88

9-
The nodes in this project use [fms-api-client](https://github.com/Luidog/fms-api-client) to connect via the FileMaker Data API to FileMaker Server. The nodes that connect to FileMaker Server depend upon a configurable [client](https://github.com/Luidog/fms-api-client#client-creation) node. The client node uses [marpat](https://github.com/Luidog/marpat) to store and maintain FileMaker Data API session information in-memory. For security client configuration parameters are not exported with a flow.
9+
The nodes in this project use [fms-api-client](https://github.com/Luidog/fms-api-client) to connect via the FileMaker Data API to FileMaker Server. The nodes that connect to FileMaker Server depend upon a configurable [client](https://github.com/Luidog/fms-api-client#client-creation) node. The client node uses [marpat](https://github.com/Luidog/marpat) to store and maintain FileMaker Data API session information in-memory, on the filesystem, or in a [MongoDB](https://www.mongodb.com) cluster. Persistence is configured via Node-RED's [settings file](https://nodered.org/docs/user-guide/runtime/settings-file). For more information see the [storage](#storage) section. For security client configuration parameters are not exported with a flow.
1010

1111
Once configured a client node will automatically create and maintain a FileMaker Data API session as needed. You are not required to call the [login](#login-node) or [logout](#logout-node) nodes in a flow.
1212

@@ -105,14 +105,20 @@ These nodes can also be installed using the Node-RED palette manager.
105105

106106
The nodes in this project all depend on a configurable Data API client. By default the client is saved in-memory. When saved in-memory a client will not persist between restarts of the Node-RED runtime. This means that each restart of the Node-RED runtime will cause the client to open new Data API sessions.
107107

108-
To persist a client between Node-RED runtime restarts and allow active session monitoring and maintenance additional datastores can be configured. This project will accept a url property and an options property from a marpat object in the Node-RED settings.js file. Any datastore made available by [marpat](https://github.com/luidog/marpat). The url property accepts the following formats:
108+
To persist a client between Node-RED runtime restarts and allow active session monitoring and maintenance additional datastores can be configured. This project will accept a url property and an options property from a marpat object in the [Node-RED settings.js](https://nodered.org/docs/user-guide/runtime/settings-file) file. Any datastore made available by [marpat](https://github.com/luidog/marpat). The url property accepts the following formats:
109109

110110
- MongoDB:
111-
- Format: mongodb://[username:password@]host[:port][/db-name]
111+
- Format: `mongodb://[username:password@]host[:port][/db-name]`
112112
- Filesystem:
113-
- Format: nedb://[directory-path]
113+
- Format: `nedb://[directory-path]`
114114
- In Memory:
115-
- Format: nedb://memory
115+
- Format: `nedb://memory`
116+
117+
File based persistence example:
118+
119+
```json
120+
{ "marpat": { "url": "nedb://dapi", "options": {} } }
121+
```
116122

117123
## Status Node
118124

@@ -170,7 +176,6 @@ These nodes can be installed from the command line by running the following comm
170176

171177
### Databases Illustration
172178

173-
174179
![Databases Node](https://github.com/Luidog/node-red-contrib-filemaker/blob/master/examples/images/databases-node.png?raw=true)
175180

176181
These nodes can also be installed using the Node-RED palette manager.

0 commit comments

Comments
 (0)