packaging_apps_arguments_management.md

Application packaging

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 environment variables or from $1 and $2 parameters in the install script.

# Retrieve arguments
domain=$YNH_APP_ARG_DOMAIN
path=$YNH_APP_ARG_PATH

Save arguments for other scripts

Remove, upgrade, backup and restore scripts could need arguments.

YunoHost could save arguments with this command which is generally used in the install script:

# Store config on YunoHost instance
ynh_app_setting_set $app domain $domain

Then, the script can retrieve saved arguments with this command:

domain=$(ynh_app_setting_get $app domain)

Those data are saved in /etc/yunohost/apps/<app_name>/settings.yml.