diff --git a/packaging_apps_arguments_management.md b/packaging_apps_arguments_management.md index c44e6286..e967af6b 100644 --- a/packaging_apps_arguments_management.md +++ b/packaging_apps_arguments_management.md @@ -2,12 +2,12 @@ ## Arguments management #### 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 # Retrieve arguments -domain=$1 -path=$2 +domain=$YNH_APP_ARG_DOMAIN +path=$YNH_APP_ARG_PATH ``` #### 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: ```bash # 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: ```bash -domain=$(sudo yunohost app setting $app domain) +domain=$(ynh_app_setting_get $app domain) ``` Those data are saved in `/etc/yunohost/apps//settings.yml`. diff --git a/packaging_apps_arguments_management_fr.md b/packaging_apps_arguments_management_fr.md index e5883d9c..c7da4720 100644 --- a/packaging_apps_arguments_management_fr.md +++ b/packaging_apps_arguments_management_fr.md @@ -2,12 +2,12 @@ ## Gestion des arguments #### 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 # Retrieve arguments -domain=$1 -path=$2 +domain=$YNH_APP_ARG_DOMAIN +path=$YNH_APP_ARG_PATH ``` #### 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 : ```bash # 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. Ensuite, le script peut récupérer les arguments sauvegardés avec cette commande : ```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//settings.yml`. \ No newline at end of file +Ces données sont sauvegardées dans `/etc/yunohost/apps//settings.yml`.