doc/packaging_apps_manifest_fr.md
2016-01-26 18:01:13 +01:00

3.5 KiB
Raw Blame History

Manifeste

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 :

{
    "name": "Roundcube",
    "id": "roundcube",
    "description": {
        "en": "Open Source Webmail software",
        "fr": "Webmail Open Source"
    },
    "url": "http://roundcube.net/",
    "license": "free",
    "maintainer": {
        "name": "kload",
        "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",
                    "fr": "Choisissez un domaine pour Roundcube"
                },
                "example": "domain.org"
            },
            {
                "name": "path",
                "type": "path",
                "ask": {
                    "en": "Choose a path for Roundcube",
                    "fr": "Choisissez un chemin pour Roundcube"
                },
                "example": "/webmail",
                "default": "/webmail"
            }
        ]
    }
}
  • name : le 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.

  • id : lidentifiant unique de lapplication. Vous devez vous assurer de son unicité.

  • description : la description complète de lapplication. Vous pouvez la détailler comme bon vous semble. Uniquement le champs en (English) est requis, mais vous pouvez tout de même ajouter la traduction en français :)

  • url: site de lapplication.

  • license : type de licence avec laquelle le logiciel est distribué : free, non-free. Attention à ne pas confondre avec la licence du paquet qui doit être mise dans le fichier LICENSE.

  • maintainer : informations à propos du mainteneur du paquet de lapplication.

  • multi_instance : définit la possibilité de votre package à être installée plusieurs fois. Quand YunoHost essaie dinstaller une seconde fois votre application, il remplaçera lid dans votre script par id__2. Cela signifie que si voulez être multi_instance, vous devez mettre toutes les valeurs identifiantes dans les scripts.

    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.

  • services: services nécessaires au fonctionnement de lapplication. nginx, php5-fpm, mysql, uwsgi, metronome

  • arguments : les paramètres à demander aux administrateurs du serveur lors de linstallation. name est lidentifiant du paramètre, et ask la question à poser (au minimum en Anglais -- en) que vous pouvez traduire de la même manière que la description ci-dessus. Vous pouvez aussi proposer une valeur par défaut (default) et un exemple (example) pour aider ladministrateur à remplir le formulaire dinstallation.