doc/packaging_apps_manifest_fr.md

74 lines
3.7 KiB
Markdown
Raw Normal View History

2016-01-26 19:04:50 +01:00
<a class="btn btn-lg btn-default" href="packaging_apps_fr">Packaging dapplication</a>
2016-01-26 17:31:26 +01:00
## Manifeste
2016-01-26 18:01:13 +01:00
Le fichier `manifest.json` définit les constantes de lapplication, un ensemble de valeurs dont YunoHost a besoin pour identifier l'application et linstaller correctement. Voici un exemple :
2016-01-26 17:31:26 +01:00
```json
{
"name": "Roundcube",
"id": "roundcube",
"description": {
"en": "Open Source Webmail software",
"fr": "Webmail Open Source"
},
2016-01-26 17:56:17 +01:00
"url": "http://roundcube.net/",
2016-01-26 17:31:26 +01:00
"license": "free",
"maintainer": {
"name": "kload",
2016-01-26 17:56:17 +01:00
"email": "kload@kload.fr"
2016-01-26 17:31:26 +01:00
},
"multi_instance": "true",
2016-01-26 17:56:17 +01:00
"services": [
"nginx",
"php5-fpm",
"mysql"
],
2016-01-26 17:31:26 +01:00
"arguments": {
"install" : [
{
"name": "domain",
2016-01-26 17:56:17 +01:00
"type": "domain",
2016-01-26 17:31:26 +01:00
"ask": {
2016-01-26 17:56:17 +01:00
"en": "Choose a domain for Roundcube",
"fr": "Choisissez un domaine pour Roundcube"
2016-01-26 17:31:26 +01:00
},
"example": "domain.org"
},
{
"name": "path",
2016-01-26 17:56:17 +01:00
"type": "path",
2016-01-26 17:31:26 +01:00
"ask": {
2016-01-26 17:56:17 +01:00
"en": "Choose a path for Roundcube",
"fr": "Choisissez un chemin pour Roundcube"
2016-01-26 17:31:26 +01:00
},
"example": "/webmail",
"default": "/webmail"
}
]
}
}
```
2016-01-26 18:22:32 +01:00
* **name** : nom de lapplication. Son unicité nest pas nécessaire. Il est tout de même conseillé étant donné que cest le nom qui apparaît dans la liste des applications pour les administrateurs de serveurs YunoHost.
2016-01-26 17:31:26 +01:00
2016-01-26 18:22:32 +01:00
* **id** : identifiant de lapplication. Vous devez vous assurer de son unicité.
2016-01-26 17:31:26 +01:00
2016-01-26 18:22:32 +01:00
* **description** : description complète de lapplication. Vous pouvez la détailler comme bon vous semble. Uniquement le champs `en` (english) est requis, vous pouvez également ajouter la traduction en français :)
2016-01-26 17:31:26 +01:00
2016-01-26 17:56:17 +01:00
* **url**: site de lapplication.
2016-01-26 18:22:32 +01:00
* **license** : licence avec laquelle lapplication est distribuée : `free`, `non-free`. Attention à ne pas confondre avec la licence du paquet qui doit être mise dans le fichier `LICENSE`.
2016-01-26 17:31:26 +01:00
2016-01-26 18:22:32 +01:00
* **maintainer** : informations à propos du mainteneur du paquet de lapplication pour pouvoir le contacter.
2016-01-26 17:31:26 +01:00
2016-01-26 18:22:32 +01:00
* **multi_instance** : définit la possibilité du paquet à être installé plusieurs fois. Quand YunoHost essaie dinstaller une seconde fois lapplication, il remplaçera l`id` dans votre script par `id__2`. Cela signifie que si voulez que lapplication soit `multi_instance`, vous devez mettre toutes les valeurs identifiantes dans les scripts.
<br /><br />**Par exemple** : dans le script roundcube, il faut nommer la base de donnée `roundcube`, le dossier dinstallation `roundcube` et la configuration Nginx `roundcube`. De cette manière, la seconde installation de roundcube ne rentrera pas en conflit avec la première, et sera installée dans la base de donnée `roundcube__2`, dans le répertoire `roundcube__2`, et avec la configuration Nginx `roundcube__2`.
2016-01-26 17:31:26 +01:00
2016-01-26 18:22:32 +01:00
* **services** : liste des services nécessaires au fonctionnement de lapplication. `nginx`, `php5-fpm`, `mysql`, `uwsgi`, `metronome`
2016-01-26 17:56:17 +01:00
2016-01-26 18:22:32 +01:00
* **arguments** :
* **install** : paramètres à demander à ladministrateur lors de linstallation.
* **name** : identifiant du paramètre
2016-01-28 19:29:18 +01:00
* **type** : (optionnel) type de paramètre parmis `domain`, `path` et `password`. Le champ sera caché dans le cas dun mot de passe.
2016-01-26 18:22:32 +01:00
* **ask** : question posée (au minimum en anglais `en`) que vous pouvez traduire dans plusieurs langues.
2016-01-28 19:29:18 +01:00
* **example** : (optionnel) valeur dexemple pour aider ladministrateur à remplir le formulaire dinstallation.
* **default** : (optionnel) valeur par défaut.