@mashroom/mashroom-storage-provider-filestore
v2.7.1
Published
Simple Mashroom storage provider based on JSON files
Downloads
18
Readme
Mashroom Storage Filestore Provider
Plugin for Mashroom Server, a Microfrontend Integration Platform.
This plugin adds a simple but cluster-safe, JSON based storage provider.
Usage
If node_modules/@mashroom is configured as plugin path just add @mashroom/mashroom-storage-provider-filestore as dependency.
To activate this provider configure the Mashroom Security plugin like this:
{
"plugins": {
"Mashroom Storage Services": {
"provider": "Mashroom Storage Filestore Provider"
}
}
}
And configure this plugin like this in the Mashroom config file:
{
"plugins": {
"Mashroom Storage Filestore Provider": {
"dataFolder": "/var/mashroom/data/storage",
"checkExternalChangePeriodMs": 100,
"prettyPrintJson": true
}
}
}
- dataFolder: The shared folder to store the data files. The base for relative paths is the Mashroom config file (Default: ./data/storage)
- checkExternalChangePeriodMs: Poll interval for external file changes (by other servers in the cluster). You can increase the default if you run a single server, the config is readonly or performance is more important than consistency (Default: 100)
- prettyPrintJson: Pretty print the JSON files to make it human-readable (Default: true)