doc/packaging_apps_manifest_fr.md

3.5 KiB
Raw Blame History

Packaging dapplication

Manifeste

Le fichier manifest.json définit les constantes de lapplication, un ensemble de valeurs dont YunoHost a besoin pour identifier lapplication et linstaller correctement. Voici un exemple :

{
    "name": "Roundcube",
    "id": "roundcube",
    "packaging_format": 1,
    "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 : 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 : identifiant de lapplication. Vous devez vous assurer de son unicité.

  • packaging_format : version de packaging du paquet. La version 1 est la version actuelle. Cette clé a été mise en place afin de faire évoluer les versions de packaging de manière décorrélée des versions de YunoHost.
  • 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 :)

  • url: site de lapplication.

  • 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.

  • maintainer : informations à propos du mainteneur du paquet de lapplication pour pouvoir le contacter.

  • multi_instance : capacité dune application dêtre installée plusieurs fois.

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

  • arguments :

    • install : paramètres à demander à ladministrateur lors de linstallation.
      • name : identifiant du paramètre
      • type : (optionnel) type de paramètre parmis domain, path, user, boolean et password. Le champ sera caché dans le cas dun mot de passe.
      • optional : (optionnel) champs qui indique si ce paramètre est optionnel. Il peux avoir les valeurs true ou false.
      • ask : question posée (au minimum en anglais en) que vous pouvez traduire dans plusieurs langues.
      • example : (optionnel) valeur dexemple pour aider ladministrateur à remplir le formulaire dinstallation.
      • default : (optionnel) valeur par défaut.