From 9e2f054a66209d11a7a45117ffd70038e1020d72 Mon Sep 17 00:00:00 2001 From: "ma.azimi@laposte.net" Date: Tue, 26 Jan 2016 17:46:37 +0100 Subject: [PATCH] Update packaging_apps_manifest.md --- packaging_apps_manifest.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/packaging_apps_manifest.md b/packaging_apps_manifest.md index dc5a9811..53c852a7 100644 --- a/packaging_apps_manifest.md +++ b/packaging_apps_manifest.md @@ -8,26 +8,34 @@ The `manifest.json` file defines the app's constants, a bunch of values that Yun "en": "Open Source Webmail software", "fr": "Webmail Open Source" }, - "license": "free", + "url": "http://roundcube.net/", "maintainer": { "name": "kload", - "email": "kload@kload.fr", - "url": "http://kload.fr" + "email": "kload@kload.fr" }, "multi_instance": "true", + "services": [ + "nginx", + "php5-fpm", + "mysql" + ], "arguments": { "install" : [ { "name": "domain", + "type": "domain", "ask": { - "en": "Choose a domain for Roundcube" + "en": "Choose a domain for Roundcube", + "fr": "Choisissez un domaine pour Roundcube" }, "example": "domain.org" }, { "name": "path", + "type": "path", "ask": { - "en": "Choose a path for Roundcube" + "en": "Choose a path for Roundcube", + "fr": "Choisissez un chemin pour Roundcube" }, "example": "/webmail", "default": "/webmail" @@ -43,6 +51,8 @@ The `manifest.json` file defines the app's constants, a bunch of values that Yun * **description**: the complete description of the app. You can make it as detailed as you feel it should be. Only `en` is required right now, but you can translate the description by prepending the locale prefix. +* **url**: software website. + * **license**: software license type: `free` or `non-free`. Be careful to not confuse with package license which must be put in `LICENSE` file. * **maintainer**: informations about the app maintainer. @@ -50,4 +60,6 @@ The `manifest.json` file defines the app's constants, a bunch of values that Yun * **multi_instance**: this defines your app's ability to be installed multiple times. When YunoHost tries to install a second instance of the app, it will replace the `id` in the scripts by an `id__2`. It means that, if you want to be `multi_instance`, you have to put all the identifiers in the scripts.

**E.g.** in the roundcube script, database is called `roundcube`, the install directory `roundcube` and the Nginx configuration `roundcube`. This way, the second instance of roundcube will not conflict with the first one, and will be installed in the `roundcube__2` database, in the `roundcube__2`directory, and with the `roundcube__2` Nginx configuration. +* **services**: services needed by the application among `nginx`, `php5-fpm`, `mysql`, `uwsgi`, `metronome`… + * **arguments**: the settings for the YunoHost's administrator to enter at installation. You have to set a `name` (for argument identification), and a question in `ask` (at least in `en`) that you can translate like the description above. You can also set a `default` value and an `example` to help administrator to fill the input. \ No newline at end of file