YunoHost/doc
1
0
Fork 0
mirror of https://github.com/YunoHost/doc.git synced 2024-09-03 20:06:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update packaging_apps_manifest.md

Browse source
This commit is contained in:
ma.azimi@laposte.net 2016-01-26 18:36:57 +01:00 committed by YunoHost
parent cf974d20bf
commit 22c1671647
1 changed files with 13 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
packaging_apps_manifest.md
View file

@ -46,21 +46,27 @@ The `manifest.json` file defines the app's constants, a bunch of values that Yun
} }
``` ```
* **name**: the app name. It does not have to be unique, but it should be, since it is the name shown to all the YunoHost administrators in the app list. * **name**: app name. It does not have to be unique, but it should be, since it is the name shown to all the YunoHost administrators in the app list.
* **id**: the unique ID of the app. You have to ensure that this ID is unique before submit an app integration request. * **id**: ID of the app. You have to ensure that this ID is unique before submit an app integration request.
* **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. * **description**: complete app description. 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. * **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. * **license**: application license: `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. * **maintainer**: informations about the app maintainer for contact.
* **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. * **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.
<br><br>**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. <br /><br />**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`… * **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. * **arguments**:
* **install**: argument for the YunoHost's administrator to enter at installation.
* **name**: argument identification.
* **type**: (optional) argument type among `domain`, `path` et `password`. The field will be hiden in the password case.
* **ask**: question (at least in `en`) that you can translate.
* **example**: (optional) example value to help administrator to fill the input.
* **default**: (optional) default value.