Packaging d'application

Manifeste

Le fichier manifest.json définit les constantes de l’application, un ensemble de valeurs dont YunoHost a besoin pour identifier l’application et l’installer 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/",
    "version": "1.0.1~ynh7",
    "license": "free",
    "maintainer": {
        "name": "kload",
        "email": "kload@kload.fr"
    },
    "requirements": {
        "yunohost": ">= 2.4.0"
    },
    "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 l’application. Son unicité n’est pas nécessaire. Il est tout de même conseillé étant donné que c’est le nom qui apparaît dans la liste des applications pour les administrateurs de serveurs YunoHost.

  • id : identifiant de l’application. 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 l’application. Vous pouvez la détailler comme bon vous semble. Uniquement le champ en (english) est requis, vous pouvez également ajouter la traduction en français :)

  • url : site web de l’application.

  • version : version du package construit à partir du numéro de version de l’application qui est installée et d'un incrément pour chaque changement du paquet sans changement de version de l'application. "Exemple: 1.0.1~ynh7". Le champ doit être une chaîne de caractères.

  • license : licence avec laquelle l’application est distribuée : free, non-free ou une des valeurs de la colonne Identifier du site https://spdx.org/licenses/. 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 l’application pour pouvoir le contacter.

  • requirements : dépendance du paquet de l’application à la version d’un paquet Debian de YunoHost. Par exemple : "yunohost": ">> 2.3.12", le paquet yunohost doit être de version supérieur à 2.3.12.

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

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

  • arguments :

    • install : paramètres à demander à l’administrateur lors de l’installation.
    • name : identifiant du paramètre
    • type : (optionnel) type de paramètre parmi domain, path, user, app, boolean, string et password. Le champ sera caché dans le cas d’un mot de passe.
    • choices : (optionnel) restreint les réponses possibles à plusieurs choix.
    • optional : (optionnel) champ qui indique si ce paramètre est optionnel. Il peut 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 d’exemple pour aider l’administrateur à remplir le formulaire d’installation.
    • default : (optionnel) valeur par défaut.

Vous avez découvert des erreurs ? Vous pensez pouvoir améliorer cette documentation ? Cliquez sur Éditer en haut de la page, puis sur l'icone crayon sur Github pour proposer vos changements.