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

[enh] packaging_apps_arg: update to env var and new helpers.

Browse source
This commit is contained in:
Moul 2016-06-23 15:39:39 +02:00
parent 00188360b0
commit 23a6d3cfc9
2 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
packaging_apps_arguments_management.md
View file

@ -2,12 +2,12 @@
## Arguments management ## Arguments management
#### Retrieve arguments in the install script from manifest #### Retrieve arguments in the install script from manifest
Arguments are given to the install script from the manifest in it's order. For instance, for Roundcube, `domain` and `path` arguments will respectively be retreived from `$1` and `$2` parameters in the install script. Arguments are given to the install script from the manifest in it's order. For instance, for Roundcube, `domain` and `path` arguments will respectively be retreived from environment variables or from `$1` and `$2` parameters in the install script.
```bash ```bash
# Retrieve arguments # Retrieve arguments
domain=$1 domain=$YNH_APP_ARG_DOMAIN
path=$2 path=$YNH_APP_ARG_PATH
``` ```
#### Save arguments for other scripts #### Save arguments for other scripts
@ -16,12 +16,12 @@ Remove, upgrade, backup and restore scripts could need arguments.
YunoHost could save arguments with this command which is generally used in the install script: YunoHost could save arguments with this command which is generally used in the install script:
```bash ```bash
# Store config on YunoHost instance # Store config on YunoHost instance
sudo yunohost app setting $app domain -v $domain ynh_app_setting_set $app domain $domain
``` ```
Then, the script can retrieve saved arguments with this command: Then, the script can retrieve saved arguments with this command:
```bash ```bash
domain=$(sudo yunohost app setting $app domain) domain=$(ynh_app_setting_get $app domain)
``` ```
Those data are saved in `/etc/yunohost/apps/<app_name>/settings.yml`. Those data are saved in `/etc/yunohost/apps/<app_name>/settings.yml`.

10
packaging_apps_arguments_management_fr.md
View file

@ -2,12 +2,12 @@
## Gestion des arguments ## Gestion des arguments
#### Récupérer les arguments du manifeste dans le script d’installation #### Récupérer les arguments du manifeste dans le script d’installation
Les arguments sont passés au script d’installation dans l’ordre du manifeste. Par exemple pour Roundcube, les arguments `domain` et `path` seront respectivement récupérés avec les paramètres `$1` et `$2` dans le script d’installation. Les arguments sont passés au script d’installation dans l’ordre du manifeste. Par exemple pour Roundcube, les arguments `domain` et `path` seront respectivement récupérés avec via les variables d’environnement ou les paramètres `$1` et `$2` dans le script d’installation.
```bash ```bash
# Retrieve arguments # Retrieve arguments
domain=$1 domain=$YNH_APP_ARG_DOMAIN
path=$2 path=$YNH_APP_ARG_PATH
``` ```
#### Sauvegarder des arguments pour les autres scripts #### Sauvegarder des arguments pour les autres scripts
@ -16,13 +16,13 @@ Les scripts remove, upgrade, backup et restore peuvent avoir besoin de ces argum
Pour cela, YunoHost peut sauvegarder les arguments avec cette commande : Pour cela, YunoHost peut sauvegarder les arguments avec cette commande :
```bash ```bash
# Store config on YunoHost instance # Store config on YunoHost instance
sudo yunohost app setting $app domain -v $domain ynh_app_setting_set $app domain $domain
``` ```
Elle est généralement utilisée dans le script d’installation. Elle est généralement utilisée dans le script d’installation.
Ensuite, le script peut récupérer les arguments sauvegardés avec cette commande : Ensuite, le script peut récupérer les arguments sauvegardés avec cette commande :
```bash ```bash
domain=$(sudo yunohost app setting $app domain) domain=$(ynh_app_setting_get $app domain)
``` ```
Ces données sont sauvegardées dans `/etc/yunohost/apps/<app_name>/settings.yml`. Ces données sont sauvegardées dans `/etc/yunohost/apps/<app_name>/settings.yml`.