From 63305a8b5d176820887d19b572ffac29d120d960 Mon Sep 17 00:00:00 2001 From: hael Date: Fri, 18 Oct 2024 20:06:55 +0000 Subject: [PATCH 1/2] Update README.md --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 204c3e7..80ccc72 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ # default-applications-tree +You can add more application sections into applications-tree.json. +You have to specify the application name and version. For example: + + { + "name": "nextcloud", + "version": "latest" + } + +The name must be the same as the directory name of the application. + +The directory of an application have to contain a template.json file and can contain more json files (service, domain, secret, etc. files). + +The mandatory template.json file's structure is the following. + - "name" - the name of the application, must be the same as the directory name + - "fields" - array of used variables by service + + + From b1e4b7124940d0d9598ab328d99d923d6cb6f3d7 Mon Sep 17 00:00:00 2001 From: hael Date: Fri, 18 Oct 2024 20:17:29 +0000 Subject: [PATCH 2/2] Update README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 80ccc72..acaef1b 100644 --- a/README.md +++ b/README.md @@ -16,5 +16,20 @@ The mandatory template.json file's structure is the following. - "name" - the name of the application, must be the same as the directory name - "fields" - array of used variables by service +An element of fields can contain the following keys. + - description + - key + - value + - required + - type + - generated +For example: + { + "description": "Please add Nextcloud password:", + "key": "NEXTCLOUD_PASSWORD", + "value": "", + "required": "true", + "type": "password" + },