mirror of
https://github.com/YunoHost/doc.git
synced 2024-09-03 20:06:26 +02:00
9ccdf22d16
* [enh] Display the list of apps with nice cards * [fix] notworking and uppercase issue in app search
77 lines
5.2 KiB
Markdown
77 lines
5.2 KiB
Markdown
# Packaging d’applications <img src="/images/yunohost_package.png" width=100/>
|
||
|
||
Ce document a pour but de vous apprendre à packager une application pour YunoHost.
|
||
|
||
### Prérequis
|
||
Pour packager une application, voici les prérequis :
|
||
* Un compte sur un serveur git comme [GitHub](https://github.com/) pour pouvoir ensuite publier l’application ;
|
||
* Maîtriser un minimum `git`, le Shell et d’autres notions de programmation ;
|
||
* Une [machine virtuelle ou sur un serveur distant](/install_fr) ou un environnement de développement, [ynh-dev](https://github.com/yunohost/ynh-dev) ou [VirtualBox](/packaging_apps_virtualbox_fr), pour packager et tester son paquet.
|
||
|
||
|
||
Si vous ne comprenez pas ces prérequis, ou si vous ne savez pas comment écrire du code, consulter d'abord l'[introduction au packaging](/packaging_apps_start_fr).
|
||
|
||
### Contenu
|
||
Un paquet YunoHost est composé :
|
||
|
||
* d’un `manifest.json`
|
||
* d’un dossier `scripts`, composé de cinq scripts Shell `install`, `remove`, `upgrade`, `backup` et `restore`
|
||
* de dossiers optionnels, contenant les `sources` ou de la `conf`
|
||
* d’un fichier `LICENSE` contenant la licence du paquet
|
||
* d’une page de présentation du paquet contenu dans un fichier `README.md`
|
||
|
||
<a class="btn btn-lg btn-default" href="https://github.com/YunoHost/example_ynh">Paquet de base</a> n’hésitez pas à vous en servir comme base de travail.
|
||
|
||
## Manifeste
|
||
<a class="btn btn-lg btn-default" href="packaging_apps_manifest_fr">Manifeste</a>
|
||
|
||
## Les scripts
|
||
<a class="btn btn-lg btn-default" href="packaging_apps_scripts_fr">Scripts</a>
|
||
|
||
### Architecture et arguments
|
||
Comme les instances de YunoHost possèdent une architecture unifiée, vous serez capable de deviner la plupart des réglages nécessaires. Mais si vous avez besoin de réglages spécifiques, comme le nom de domaine ou un chemin web pour configurer l’application, vous devrez les demander aux administrateurs lors de l’installation (voir la section `arguments` dans le § **Manifeste** ci-dessus).
|
||
|
||
<a class="btn btn-lg btn-default" href="packaging_apps_arguments_management_fr">Gestion des arguments</a>
|
||
|
||
### Configuration Nginx
|
||
<a class="btn btn-lg btn-default" href="packaging_apps_nginx_conf_fr">Configuration Nginx</a>
|
||
|
||
### Multi-instance
|
||
<a class="btn btn-lg btn-default" href="packaging_apps_multiinstance_fr">Multi-instance</a>
|
||
|
||
### Hooks
|
||
<a class="btn btn-lg btn-default" href="packaging_apps_hooks_fr">Hooks</a>
|
||
|
||
### Commandes pratiques
|
||
<a class="btn btn-lg btn-default" href="packaging_apps_helpers_fr">Commandes pratiques</a>
|
||
|
||
### Améliorer la qualité du paquet d’installation
|
||
Vous trouverez ci-dessous une liste des points à vérifier concernant la qualité de vos scripts :
|
||
* Vos scripts utilisent bien `sudo cp -a ../sources/. $final_path` plutôt que `sudo cp -a ../sources/* $final_path` ;
|
||
* Votre script d’installation contient une gestion en cas d’erreurs du script pour supprimer les fichiers résiduels à l’aide de `set -e` et de [trap](/packaging_apps_trap_fr) ;
|
||
* Votre script d’installation utilise une méthode d’installation en ligne de commande plutôt qu’un appel curl via un formulaire web d’installation ;
|
||
* Votre script d’installation enregistre les réponses de l’utilisateur ;
|
||
* Vous avez vérifié les sources de l’application avec une somme de contrôle (sha256, sha1 ou md5) ou une signature PGP ;
|
||
* Vos scripts ont été testés sur Debian Jessie ainsi que sur les architectures 32 bits, 64 bits et ARM ;
|
||
* Les scripts backup et restore sont présents et fonctionnels.
|
||
|
||
Pour mesurer la qualité d'un paquet, celui-ci obtiendra un [niveau](packaging_apps_levels_fr), déterminé en fonction de divers critères d'installation et selon le respect des [règles de packaging](packaging_apps_guidelines_fr).
|
||
|
||
### Script de vérification du paquet
|
||
<a class="btn btn-lg btn-default" href="https://github.com/YunoHost/package_checker">Vérificateur de paquets</a>
|
||
|
||
Il s’agit d’un script Python qui vérifie :
|
||
* que le paquet est à jour concernant les dernières spécifications
|
||
* que tous les fichiers sont présents
|
||
* que le manifeste ne comporte pas d’erreur de syntaxe
|
||
* que les scripts quittent bien avant de modifier le système lors de vérifications.
|
||
|
||
### Publiez et demandez des tests de votre application
|
||
* Demandez des tests et des retours sur votre application en publiant un [post sur le Forum](https://forum.yunohost.org/) dans la [catégorie `App integration`](https://forum.yunohost.org/c/app-integration).
|
||
|
||
* Faire une demande d’ajout de votre application dans le [dépôt des applications](https://github.com/YunoHost/apps) afin qu’elle soit affichée dans [la liste des apps non officielles](apps_fr). Préciser également son état d’avancement : `notworking`, `inprogress` ou `working`.
|
||
|
||
- Inscrivez-vous à la [mailing list Apps](https://list.yunohost.org/cgi-bin/mailman/listinfo/apps) pour être tenu au courant des évolutions du packaging.
|
||
|
||
### Officialisation d’une application
|
||
Pour qu’une application devienne officielle, elle doit être suffisamment testée, stable et fonctionner sous les architectures 64 bits, 32 bits et ARM sur Debian Jessie. Si ces conditions vous paraissent réunies, demandez l’[intégration officielle](https://github.com/YunoHost/apps) de votre application.
|