diff --git a/front/plugins/README.md b/front/plugins/README.md index 1ec61ce0..d7fae4c6 100755 --- a/front/plugins/README.md +++ b/front/plugins/README.md @@ -91,13 +91,13 @@ Follow the below very carefully and check example plugin(s) if you'd like to wri * Adding form controls supported to display the data (Currently supported ones are listed in the section "UI settings in database_column_definitions" below) * ... -## ❗ Known issues: +## ❗ Known limitations: These issues will be hopefully fixed with time, so please don't report them. Instead, if you know how, feel free to investigate and submit a PR to fix the below. Keep the PRs small as it's easier to approve them: -* Existing plugin objects sometimes not interpreted correctly and a new object is created instead, resulting in duplicate entries. (race condition?) +* Existing plugin objects are sometimes not interpreted correctly and a new object is created instead, resulting in duplicate entries. (race condition?) * Occasional (experienced twice) hanging of processing plugin script file. -UI displays outdated values until the API endpoints get refreshed. +* UI displays outdated values until the API endpoints get refreshed. ## Plugin file structure overview @@ -143,7 +143,7 @@ Currently, these data sources are supported (valid `data_source` value). | Pialert DB query | `pialert-db-query` | yes | Executes a SQL query on the PiAlert database in the `CMD` setting. | | Template | `template` | no | Used to generate internal settings, such as default values. | | External SQLite DB query | `sqlite-db-query` | yes | Executes a SQL query from the `CMD` setting on an external SQLite database mapped in the `DB_PATH` setting. | -| Plugin type | `plugin_type` | no | Specifies the type of the plugin and in which section the Plugin settings are displayed (`|||`). | +| Plugin type | `plugin_type` | no | Specifies the type of the plugin and in which section the Plugin settings are displayed (``). | > 🔎Example @@ -643,7 +643,7 @@ The UI will adjust how columns are displayed in the UI based on the resolvers de | `url` | The value is considered to be a URL, so a link is generated. | | `textbox_save` | Generates an editable and saveable text box that saves values in the database. Primarily intended for the `UserData` database column in the `Plugins_Objects` table. | | `url_http_https` | Generates two links with the `https` and `http` prefix as lock icons. | -| `eval` | Evaluates as JavaScript. Use the variable `value` to use the given column value as input (e.g. ``${value}`` ) | +| `eval` | Evaluates as JavaScript. Use the variable `value` to use the given column value as input (e.g. `'${value}'` (replace ' with ` in your code) ) | > [!NOTE] diff --git a/front/plugins/maintenance/config.json b/front/plugins/maintenance/config.json index fbe301de..c4981453 100755 --- a/front/plugins/maintenance/config.json +++ b/front/plugins/maintenance/config.json @@ -164,7 +164,7 @@ }], "description": [{ "language_code":"en_us", - "string" : "How many last pialert.log lines to keep. If LOG_LEVEL is set to debug the app generates about 10000 lines per hour, so when debugging an issue the recommended setting should cover the bug occurence timeframe. For example for a bug with a 3 day periodical appearence the value 1000000 should be sufficient. Setting this value to 1000000 generates approximatelly a 50MB pialert.log file. Set to 0 disables log cleaning." + "string" : "How many last pialert.log lines to keep. If LOG_LEVEL is set to debug the app generates about 10000 lines per hour, so when debugging an issue the recommended setting should cover the bug occurence timeframe. For example for a bug with a 3 day periodical appearence the value 1000000 should be sufficient. Setting this value to 1000000 generates approximatelly a 50MB pialert.log file. Set to 0 to disable log purging." }] } ],