Docs + string fixes
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
## Overview
|
||||
|
||||
A simple template-based plugin for setting the password.
|
||||
A simple script-based plugin for setting the password.
|
||||
|
||||
### Usage
|
||||
|
||||
@@ -8,4 +8,41 @@ A simple template-based plugin for setting the password.
|
||||
|
||||
### Notes
|
||||
|
||||
- N/A
|
||||
- The plugin is executed on the `RUN` type `before_config_save` so it's possible to update the `pialert.conf` file before the data is loaded into the app.
|
||||
- The executed command is stored in the `CMD` setting: `/home/pi/pialert/back/pialert-cli set_password {password}`
|
||||
- The `{password}` parameter is replaced via the parameter and setting below:
|
||||
|
||||
```json
|
||||
...
|
||||
"params" : [
|
||||
{
|
||||
"name" : "password",
|
||||
"type" : "setting",
|
||||
"value" : "SETPWD_password"
|
||||
}
|
||||
],
|
||||
|
||||
...
|
||||
{
|
||||
"function": "password",
|
||||
"type": "password",
|
||||
"maxLength": 50,
|
||||
"default_value": "123456",
|
||||
"options": [],
|
||||
"localized": ["name", "description"],
|
||||
"name": [
|
||||
{
|
||||
"language_code": "en_us",
|
||||
"string": "Password"
|
||||
}
|
||||
],
|
||||
"description": [
|
||||
{
|
||||
"language_code": "en_us",
|
||||
"string": "The default password is <code>123456</code>. To change the password run <code>/home/pi/pialert/back/pialert-cli set_password {password}</code> in the container"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
```
|
||||
|
||||
@@ -39,7 +39,7 @@
|
||||
}],
|
||||
"description": [{
|
||||
"language_code":"en_us",
|
||||
"string" : "Set to <code>before_config_save</code> and specify password to reset your pasword in <code>SETPWD_password</code>."
|
||||
"string" : "Set to <code>before_config_save</code> and specify password to reset your pasword in <code>SETPWD_password</code>. You can set to <code>disabled</code> once the password is changed."
|
||||
}]
|
||||
},
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user