YunoHost/doc
1
0
Fork 0
mirror of https://github.com/YunoHost/doc.git synced 2024-09-03 20:06:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update dev_fr.md

Browse source
This commit is contained in:
ma.azimi@laposte.net 2016-01-29 19:15:32 +01:00 committed by YunoHost
parent e97a8ce106
commit 070c67d5df
1 changed files with 22 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
dev_fr.md
View file

@ -3,45 +3,45 @@
Ce document a pour but de donner les clés pour créer un environnement de développement correct afin de développer sur le cœur de YunoHost. Il peut également vous permettre de tester vos applications que ce soit avec les versions `stable`, `testing`, `unstable` ou même des versions customisées issues des branches des dépôts. Ce document a pour but de donner les clés pour créer un environnement de développement correct afin de développer sur le cœur de YunoHost. Il peut également vous permettre de tester vos applications que ce soit avec les versions `stable`, `testing`, `unstable` ou même des versions customisées issues des branches des dépôts.
### Présentation des branches de développement de YunoHost ### Présentation des branches de développement de YunoHost
Afin de mettre en place un système automatisé de compilation des paquets Debian, le développement de YunoHost progresse désormais autour de trois branches principales : Afin de mettre en place un système automatisé de compilation des paquets Debian, le développement de YunoHost progresse désormais autour de trois branches principales :
- stable : il s'agit du code des paquets Debian utilisés en live par les utilisateurs de YunoHost. - stable : il s’agit du code des paquets Debian utilisés en live par les utilisateurs de YunoHost.
- testing : il s'agit du code éligible pour la création d'une nouvelle version de YunoHost, il est supposé stable mais manque de test. La branche testing peut notamment servir pour corriger rapidement certains bugs. - testing : il s’agit du code éligible pour la création d’une nouvelle version de YunoHost, il est supposé stable mais manque de test. La branche testing peut notamment servir pour corriger rapidement certains bugs.
- unstable : il s'agit là des derniers codes ajoutés au dépôt mais qui sont connus pour être instables voir inachevés. C'est à destination de cette branche que vous devez faire vos pull request. Si votre travail est conséquent mais inachevé, il convient d'envisager de créer une branche à part thématique (exemple : backup). - unstable : il s’agit là des derniers codes ajoutés au dépôt mais qui sont connus pour être instables voir inachevés. C’est à destination de cette branche que vous devez faire vos pull request. Si votre travail est conséquent mais inachevé, il convient d’envisager de créer une branche à part thématique (exemple : backup).
Les numéros de version des paquets stable sont pairs, les numéros de version des paquets testing sont impairs. Ainsi, la version 2.3 de YunoHost est une version de test qui sera peut être transformée en version 2.4 si les tests sont concluants. Les numéros de version des paquets stable sont pairs, les numéros de version des paquets testing sont impairs. Ainsi, la version 2.3 de YunoHost est une version de test qui sera peut être transformée en version 2.4 si les tests sont concluants.
### Présentation des paquets YunoHost ### Présentation des paquets YunoHost
Avant d'aller plus loin, il convient de rappeler le rôle des différents paquets YunoHost. Avant d’aller plus loin, il convient de rappeler le rôle des différents paquets YunoHost.
#### Paquet moulinette #### Paquet moulinette
La moulinette est un framework qui permet de créer une API web ainsi qu'une API en ligne de commande à partir d'un même code Python et d'un schéma en yaml. La moulinette est un framework qui permet de créer une API web ainsi qu’une API en ligne de commande à partir d’un même code Python et d’un schéma en yaml.
La ligne de commande `yunohost` est écrite avec ce framework, La moulinette est donc une dépendance de YunoHost. La ligne de commande `yunohost` est écrite avec ce framework, La moulinette est donc une dépendance de YunoHost.
La moulinette est un code écrit par les développeurs YunoHost. À l'origine, la moulinette était fusionnée avec le code YunoHost, mais il a été décidé de scinder les deux afin de permettre l'utilisation de la moulinette pour d'autres projets. La moulinette est un code écrit par les développeurs YunoHost. À l’origine, la moulinette était fusionnée avec le code YunoHost, mais il a été décidé de scinder les deux afin de permettre l’utilisation de la moulinette pour d’autres projets.
#### Paquet SSOwat #### Paquet SSOwat
SSOwat est un système de Single Sign On pour Nginx écrit en Lua. C'est ce système qui génére l'interface que les utilisateurs YunoHost voit. Il permet de protéger des URLs et d'autoriser des utilisateurs à accéder ou non à ces ressources. SSOwat est un système de Single Sign On pour Nginx écrit en Lua. C’est ce système qui génére l’interface que les utilisateurs YunoHost voit. Il permet de protéger des URLs et d’autoriser des utilisateurs à accéder ou non à ces ressources.
SSOwat est comme la moulinette une dépendance de YunoHost, mais peut aussi être utilisée séparément sur d'autres projets. SSOwat est comme la moulinette une dépendance de YunoHost, mais peut aussi être utilisée séparément sur d’autres projets.
#### Paquet yunohost #### Paquet yunohost
Le paquet yunohost est le cœur de YunoHost, ce paquet contient depuis la version 2.3 (testing) le code du programme en ligne de commande `yunohost`. Il contient également des helpers qui peuvent être utilisées par les scripts des apps YunoHost, ainsi que les templates de configuration des dépendances de YunoHost. Le paquet yunohost est le cœur de YunoHost, ce paquet contient depuis la version 2.3 (testing) le code du programme en ligne de commande `yunohost`. Il contient également des helpers qui peuvent être utilisées par les scripts des apps YunoHost, ainsi que les templates de configuration des dépendances de YunoHost.
Note : à partir de la version 2.3 (testing), le code de la ligne de commande `yunohost` initialement dans le paquet moulinette-yunohost a été rapatrié dans le paquet yunohost. Un système 2.2 contient donc deux paquets au lieu d'un seul : yunohost et moulinette-yunohost. Note : à partir de la version 2.3 (testing), le code de la ligne de commande `yunohost` initialement dans le paquet moulinette-yunohost a été rapatrié dans le paquet yunohost. Un système 2.2 contient donc deux paquets au lieu d’un seul : yunohost et moulinette-yunohost.
#### Paquet yunohost-admin (optionnel) #### Paquet yunohost-admin (optionnel)
Ce paquet contient l'interface d'administration web de YunoHost, obligatoire dans la version 2.2, il est optionnel depuis la version 2.3 (testing). Ce paquet contient l’interface d’administration web de YunoHost, obligatoire dans la version 2.2, il est optionnel depuis la version 2.3 (testing).
L'interface d’administration n'est en réalité qu'un client qui se connecte à l'API web généré par la moulinette et le paquet yunohost. L’interface d’administration n’est en réalité qu’un client qui se connecte à l’API web généré par la moulinette et le paquet yunohost.
Le service yunohost-api doit donc être start pour utiliser l'administration web. Le service yunohost-api doit donc être start pour utiliser l’administration web.
### Installation de l’environnement de développement ### Installation de l’environnement de développement
<div class="alert alert-warning"> <div class="alert alert-warning">
<b>Attention :</b> Cette partie est en cours de rédaction. La ligne de commande `ynh-dev` vient juste d'être créée il est possible qu'il y ai des manques. <b>Attention :</b> Cette partie est en cours de rédaction. La ligne de commande `ynh-dev` vient juste d’être créée il est possible qu’il y ai des manques.
</div> </div>
<div class="alert alert-warning"> <div class="alert alert-warning">
<b>Note :</b> `ynh-dev` fonctionne avec apt-get. Debian et linux mint ont été testé. Ubuntu fonctionne sans doute. <b>Note :</b> `ynh-dev` fonctionne avec apt-get. Debian et linux mint ont été testé. Ubuntu fonctionne sans doute.
@ -58,13 +58,13 @@ Pour créer votre environnement, commencez par faire un `create-env`
```bash ```bash
./ynh-dev create-env ~/project/my/yunohost/env ./ynh-dev create-env ~/project/my/yunohost/env
``` ```
Cette sous commande va cloner les dépots principaux et les positionner en `unstable`. Si vous avez vos propres fork, vous pouvez ensuite faire ce qu'il faut pour changer l'origine et le remote repository. Cette sous commande va cloner les dépots principaux et les positionner en `unstable`. Si vous avez vos propres fork, vous pouvez ensuite faire ce qu’il faut pour changer l’origine et le remote repository.
#### Usage #### Usage
##### Lancer un container ##### Lancer un container
Positionner vous dans votre environnement, puis créer et entrer dans une vm à l'aide de `ynh-dev run` Positionner vous dans votre environnement, puis créer et entrer dans une vm à l’aide de `ynh-dev run`
```bash ```bash
cd ~/project/my/yunohost/env cd ~/project/my/yunohost/env
./ynh-dev run exemple.local docker stable8 ./ynh-dev run exemple.local docker stable8
@ -75,13 +75,13 @@ Dockerfile LICENSE README.md SSOwat apps backup moulinette ynh-dev yunohos
##### Mettre à jour un container ##### Mettre à jour un container
Si la vm n'est pas à jour lancez un `ynh-dev upgrade` : Si la vm n’est pas à jour lancez un `ynh-dev upgrade` :
```bash ```bash
root@yunohost:/yunohost/# ./ynh-dev upgrade root@yunohost:/yunohost/# ./ynh-dev upgrade
``` ```
##### Déployer les sources présentes dans votre environnement ##### Déployer les sources présentes dans votre environnement
Pour déployer les sources se trouvant dans votre environnement de développement faites : Pour déployer les sources se trouvant dans votre environnement de développement faites :
```bash ```bash
root@yunohost:/yunohost/# ./ynh-dev deploy root@yunohost:/yunohost/# ./ynh-dev deploy
``` ```
@ -93,7 +93,7 @@ root@yunohost:/yunohost/# ./ynh-dev deploy
<div class="alert alert-warning"> <div class="alert alert-warning">
<b>Note :</b> vous pouvez sélectionner les paquets à déployer exemple : `./ynh-dev deploy yunohost yunohost-admin` <b>Note :</b> vous pouvez sélectionner les paquets à déployer exemple : `./ynh-dev deploy yunohost yunohost-admin`
</div> </div>
@ -107,14 +107,14 @@ Avec VirtualBox/Vagrant
root@yunohost:/yunohost/# yunohost tools postinstall root@yunohost:/yunohost/# yunohost tools postinstall
``` ```
##### Récupérer l'ip de la vm et parametrer son `/etc/hosts` ##### Récupérer l’IP de la vm et parametrer son `/etc/hosts`
Si vous ne connaissez pas l'ip de votre vm : si vous ne connaissez pas l’IP de votre vm :
```bash ```bash
root@yunohost:/yunohost/# ./ynh-dev ip root@yunohost:/yunohost/# ./ynh-dev ip
172.17.0.1 172.17.0.1
``` ```
Pour tester dans votre navigateur vous pouvez modifier votre fichier `/etc/hosts` afin de faire pointer votre domaine sur la bonne adresse IP. Par exemple en y ajoutant une ligne semblable à celle-ci : Pour tester dans votre navigateur vous pouvez modifier votre fichier `/etc/hosts` afin de faire pointer votre domaine sur la bonne adresse IP. Par exemple en y ajoutant une ligne semblable à celle-ci :
```bash ```bash
172.17.0.1 exemple.local 172.17.0.1 exemple.local
``` ```