cphipps/NetAlertX
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

🔃 Sync Hub v0.8.1 + CSS fixes + Empty settings sanity check + JSON linting + docs

Browse Source
This commit is contained in:
jokob-sk
2024-06-08 18:01:58 +10:00
parent bbd69c60bf
commit 1d525cb84c
41 changed files with 8979 additions and 9066 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
front/plugins/sync/README.md
View File

@@ -5,47 +5,29 @@ Synchronization plugin to synchronize multiple app instances. The Plugin can syc
1. 💻 Devices: The plugin sends an encrypted `table_devices.json` file to synchronize the whole Devices DB table.
1. 🔌 Plugin data: The plugin sends encrypted `last_result.log` files for individual plugins.
### Synchronizing 💻 Devices data
> [!TIP]
> `[n]` indicates a setting taht is usually specified for the node instance. `[n,h]` indicates a setting used both, on the node and on the hub instance.
This is probably what most of the setups will use. Required settings follow.
### Synchronizing 💻 Devices data or 🔌 Plugins data
#### Node (Source) Settings
Most of the setups will probably only use 💻 Devices synchronization. 🔌 Plugins data will be probably used in only special use cases.
- When to run `SYNC_RUN`
- Schedule `SYNC_RUN_SCHD`
- API token `SYNC_api_token`
- Encryption Key `SYNC_encryption_key`
- Node name `SYNC_node_name`
- Hub URL `SYNC_hub_url`
- Send Devices `SYNC_devices` 👈
#### [n] Node (Source) Settings
#### Hub (Target) Settings
- When to run [n,h] `SYNC_RUN`
- Schedule [n,h] `SYNC_RUN_SCHD`
- API token [n,h] `SYNC_api_token`
- Encryption Key [n,h] `SYNC_encryption_key`
- Node name [n] `SYNC_node_name`
- Hub URL [n] `SYNC_hub_url`
- Sync Devices [n] `SYNC_devices` or Sync Plugins [n] `SYNC_plugins` (or both)
- When to run `SYNC_RUN`
- Schedule `SYNC_RUN_SCHD`
- API token `SYNC_api_token`
- Encryption Key `SYNC_encryption_key`
#### [h] Hub (Target) Settings
### Synchronizing 🔌 Plugins data
This mechanism will be probably used in special use cases. Required settings follow.
#### Node (Source) Settings
- When to run `SYNC_RUN`
- Schedule `SYNC_RUN_SCHD`
- API token `SYNC_api_token`
- Encryption Key `SYNC_encryption_key`
- Node name `SYNC_node_name`
- Hub URL `SYNC_hub_url`
- Send Plugins `SYNC_plugins` 👈
#### Hub (Target) Settings
- When to run `SYNC_RUN`
- Schedule `SYNC_RUN_SCHD`
- API token `SYNC_api_token`
- Encryption Key `SYNC_encryption_key`
- When to run [n,h] `SYNC_RUN`
- Schedule [n,h] `SYNC_RUN_SCHD`
- API token [n,h] `SYNC_api_token`
- Encryption Key [n,h] `SYNC_encryption_key`
### Usage
@@ -54,4 +36,4 @@ This mechanism will be probably used in special use cases. Required settings fol
### Notes
- TBC
- If a MAC address already exists on the hub, the device will be skipped in the data coming from this SYNC plugin.