Update README.md

This commit is contained in:
hael
2024-10-19 10:27:49 +00:00
parent 368a9647da
commit 48cbf5cd7a

View File

@@ -17,14 +17,23 @@ The mandatory template.json file's structure is the following.
- "fields" - array of used variables by service - "fields" - array of used variables by service
An element of fields can contain the following keys. An element of fields can contain the following keys.
- description - description - label of the field, this text will appear before element
- key - key - name of variable
- value - value - default value of variable in the form
- required - required - if set "true" then fill in of the field is required in the form
- type - type - if not set then default is text, available field types: text, password, textarea, select
- generated - if type is "select" then options are separated by ",". Option's value and text is separated by ":", but text is not mandatory. For example:
"value": "yes,no"
"value": "1:gmail,2:microsoft outlook/hotmail,3:other",
- generated - the value of the variable is auto generated, so the field will not appear in the form. Generated examples:
"time|md5|8" - generated from time, encoded by md5 and character length is 8
"random|md5|20" - random generated number, encoded by sha256, length is 20
Field element example:
For example:
{ {
"description": "Please add Nextcloud password:", "description": "Please add Nextcloud password:",
"key": "NEXTCLOUD_PASSWORD", "key": "NEXTCLOUD_PASSWORD",