- Usage: ynh_install_app_dependencies dep [dep [...]]
- You can give a choice between some package with this syntax : "dep1|dep2"
- Example : ynh_install_app_dependencies dep1 dep2 "dep3|dep4|dep5"
- This mean in the dependence tree : dep1 & dep2 & (dep3 | dep4 | dep5)
+ Usage: ynh_install_app_dependencies dep [dep [...]]
dep : the package name to install in dependencedep : the package name to install in dependence. Writing "dep3|dep4|dep5" can be used to specify alternatives. For example : dep1 dep2 "dep3|dep4|dep5" will require to install dep1 and dep 2 and (dep3 or dep4 or dep5).Details:
- Requires YunoHost version 2.6.4 or higher. + This helper can/should only be called once per appexample : ynh_install_app_dependencies dep1 dep2 "dep3|dep4|dep5"Requires YunoHost version 2.6.4 or higher.
@@ -478,12 +474,12 @@ This helper can/should only be called once per appDetails:
- Note: this helper could be used in backup hook or in backup script inside anapp packageDetails: ynh_backup writes SRC and the relative DEST into a CSV file. And itcreates the parent destination directoryIf DEST is ended by a slash it complete this path with the basename of SRC.Example in the context of a wordpress appynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf"# => This line will be added into CSV file# "/etc/nginx/conf.d/$domain.d/$app.conf","apps/wordpress/etc/nginx/conf.d/$domain.d/$app.conf"ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "conf/nginx.conf"# => "/etc/nginx/conf.d/$domain.d/$app.conf","apps/wordpress/conf/nginx.conf"ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "conf/"# => "/etc/nginx/conf.d/$domain.d/$app.conf","apps/wordpress/conf/$app.conf"ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "conf"# => "/etc/nginx/conf.d/$domain.d/$app.conf","apps/wordpress/conf"#Deprecated usages (maintained for retro-compatibility)ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "${backup_dir}/conf/nginx.conf"# => "/etc/nginx/conf.d/$domain.d/$app.conf","apps/wordpress/conf/nginx.conf"ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "/conf/"# => "/etc/nginx/conf.d/$domain.d/$app.conf","apps/wordpress/conf/$app.conf"Requires YunoHost version 2.4.0 or higher. + This helper can be used both in a system backup hook, and in an app backup scriptDetails: ynh_backup writes SRC and the relative DEST into a CSV file. And itcreates the parent destination directoryIf DEST is ended by a slash it complete this path with the basename of SRC.Example in the context of a wordpress appynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf"# => This line will be added into CSV file# "/etc/nginx/conf.d/$domain.d/$app.conf","apps/wordpress/etc/nginx/conf.d/$domain.d/$app.conf"ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "conf/nginx.conf"# => "/etc/nginx/conf.d/$domain.d/$app.conf","apps/wordpress/conf/nginx.conf"ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "conf/"# => "/etc/nginx/conf.d/$domain.d/$app.conf","apps/wordpress/conf/$app.conf"ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "conf"# => "/etc/nginx/conf.d/$domain.d/$app.conf","apps/wordpress/conf"#Deprecated usages (maintained for retro-compatibility)ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "${backup_dir}/conf/nginx.conf"# => "/etc/nginx/conf.d/$domain.d/$app.conf","apps/wordpress/conf/nginx.conf"ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "/conf/"# => "/etc/nginx/conf.d/$domain.d/$app.conf","apps/wordpress/conf/$app.conf"Requires YunoHost version 2.4.0 or higher.
Details:
- $app should be defined when calling this helperRequires YunoHost version 2.6.4 or higher. + This helper is primarily meant to allow to easily backup personalised/manuallymodified config files.Requires YunoHost version 2.6.4 or higher.
- Dude, show me the code ! + Dude, show me the code !
@@ -822,7 +816,7 @@ ynh_abort_if_errors- Dude, show me the code ! + Dude, show me the code !
@@ -956,14 +950,13 @@ ynh_abort_if_errors
- Usage:
+ Usage: ynh_die --message=MSG [--ret_code=RETCODE]
- Dude, show me the code ! + Dude, show me the code !
@@ -1109,7 +1102,7 @@ usage: ynh_die --message=MSG [--ret_code=RETCODE]- Dude, show me the code ! + Dude, show me the code !
@@ -1129,10 +1122,8 @@ usage: ynh_die --message=MSG [--ret_code=RETCODE]
- Usage: ynh_exec_err command to execute
-ynh_exec_err "command to execute | following command"
-In case of use of pipes, you have to use double quotes. Otherwise, this helper will be executed with the first command, then be sent to the next pipe.
-If the command to execute uses double quotes, they have to be escaped or they will be interpreted and removed.
+ Usage: ynh_exec_err your_command
+ynh_exec_err "your_command | other_command"
Details:
- Requires YunoHost version 3.2.0 or higher. + When using pipes, double quotes are required - otherwise, this helper will run the first command, and the whole output will be sent through the next pipe.If the command to execute uses double quotes, they have to be escaped or they will be interpreted and removed.Requires YunoHost version 3.2.0 or higher.
- Dude, show me the code ! + Dude, show me the code !
@@ -1179,10 +1170,8 @@ If the command to execute uses double quotes, they have to be escaped or they wi
- Usage: ynh_exec_warn command to execute
-ynh_exec_warn "command to execute | following command"
-In case of use of pipes, you have to use double quotes. Otherwise, this helper will be executed with the first command, then be sent to the next pipe.
-If the command to execute uses double quotes, they have to be escaped or they will be interpreted and removed.
+ Usage: ynh_exec_warn your_command
+ynh_exec_warn "your_command | other_command"
Details:
- Requires YunoHost version 3.2.0 or higher. + When using pipes, double quotes are required - otherwise, this helper will run the first command, and the whole output will be sent through the next pipe.If the command to execute uses double quotes, they have to be escaped or they will be interpreted and removed.Requires YunoHost version 3.2.0 or higher.
- Dude, show me the code ! + Dude, show me the code !
@@ -1229,10 +1218,8 @@ If the command to execute uses double quotes, they have to be escaped or they wi
- Usage: ynh_exec_warn_less command to execute
-ynh_exec_warn_less "command to execute | following command"
-In case of use of pipes, you have to use double quotes. Otherwise, this helper will be executed with the first command, then be sent to the next pipe.
-If the command to execute uses double quotes, they have to be escaped or they will be interpreted and removed.
+ Usage: ynh_exec_warn_less your_command
+ynh_exec_warn_less "your_command | other_command"
Details:
- Requires YunoHost version 3.2.0 or higher. + When using pipes, double quotes are required - otherwise, this helper will run the first command, and the whole output will be sent through the next pipe.If the command to execute uses double quotes, they have to be escaped or they will be interpreted and removed.Requires YunoHost version 3.2.0 or higher.
- Dude, show me the code ! + Dude, show me the code !
@@ -1279,10 +1266,8 @@ If the command to execute uses double quotes, they have to be escaped or they wi
- Usage: ynh_exec_quiet command to execute
-ynh_exec_quiet "command to execute | following command"
-In case of use of pipes, you have to use double quotes. Otherwise, this helper will be executed with the first command, then be sent to the next pipe.
-If the command to execute uses double quotes, they have to be escaped or they will be interpreted and removed.
+ Usage: ynh_exec_quiet your_command
+ynh_exec_quiet "your_command | other_command"
Details:
- Requires YunoHost version 3.2.0 or higher. + When using pipes, double quotes are required - otherwise, this helper will run the first command, and the whole output will be sent through the next pipe.If the command to execute uses double quotes, they have to be escaped or they will be interpreted and removed.Requires YunoHost version 3.2.0 or higher.
- Dude, show me the code ! + Dude, show me the code !
@@ -1329,10 +1314,8 @@ If the command to execute uses double quotes, they have to be escaped or they wi
- Usage: ynh_exec_fully_quiet command to execute
-ynh_exec_fully_quiet "command to execute | following command"
-In case of use of pipes, you have to use double quotes. Otherwise, this helper will be executed with the first command, then be sent to the next pipe.
-If the command to execute uses double quotes, they have to be escaped or they will be interpreted and removed.
+ Usage: ynh_exec_fully_quiet your_command
+ynh_exec_fully_quiet "your_command | other_command"
Details:
- Requires YunoHost version 3.2.0 or higher. + When using pipes, double quotes are required - otherwise, this helper will run the first command, and the whole output will be sent through the next pipe.If the command to execute uses double quotes, they have to be escaped or they will be interpreted and removed.Requires YunoHost version 3.2.0 or higher.
- Dude, show me the code ! + Dude, show me the code !
@@ -1379,8 +1362,7 @@ If the command to execute uses double quotes, they have to be escaped or they wi
- Usage: ynh_print_OFF
-WARNING: You should be careful with this helper, and never forget to use ynh_print_ON as soon as possible to restore the logging.
+ Usage: ynh_print_OFF
Details:
- Requires YunoHost version 3.2.0 or higher. + WARNING: You should be careful with this helper, and never forget to use ynh_print_ON as soon as possible to restore the logging.Requires YunoHost version 3.2.0 or higher.
- Dude, show me the code ! + Dude, show me the code !
@@ -1432,7 +1414,7 @@ WARNING: You should be careful with this helper, and never forget to use ynh_pri- Dude, show me the code ! + Dude, show me the code !
@@ -1444,11 +1426,11 @@ WARNING: You should be careful with this helper, and never forget to use ynh_pri@@ -1492,7 +1474,7 @@ The execution time is given for the duration since the previous call. So the wei
- Usage: ynh_debug_exec command to execute
-ynh_debug_exec "command to execute | following command"
-In case of use of pipes, you have to use double quotes. Otherwise, this helper will be executed with the first command, then be sent to the next pipe.
+ Usage: ynh_debug_exec your_command
+ynh_debug_exec "your_command | other_command"
Details:
- Requires YunoHost version 3.5.0 or higher. + When using pipes, double quotes are required - otherwise, this helper will run the first command, and the whole output will be sent through the next pipe.If the command to execute uses double quotes, they have to be escaped or they will be interpreted and removed.Requires YunoHost version 3.5.0 or higher.
- Usage: ynh_install_nodejs --nodejs_version=nodejs_version
- If possible, prefer to use major version number (e.g. 8 instead of 8.10.0).
- The crontab will handle the update of minor versions when needed.
+ Usage: ynh_install_nodejs --nodejs_version=nodejs_version
-n, --nodejs_version : Version of node to install.-n, --nodejs_version : Version of node to install. When possible, your should prefer to use major version number (e.g. 8 instead of 8.10.0). The crontab will then handle the update of minor versions when needed.
- Example: ynh_psql_connect_as 'user' 'pass' <<< "UPDATE ...;" example: ynh_psql_connect_as 'user' 'pass' < /path/to/file.sql
-
+ Examples:
ynh_psql_connect_as 'user' 'pass' <<< "UPDATE ...;"
+
+ ynh_psql_connect_as 'user' 'pass' < /path/to/file.sql
+
+ @@ -2682,7 +2644,7 @@ In case of use of pipes, you have to use double quotes. Otherwise, this helper w
- Dude, show me the code ! + Dude, show me the code !
@@ -2839,7 +2801,7 @@ In case of use of pipes, you have to use double quotes. Otherwise, this helper w- Dude, show me the code ! + Dude, show me the code !
@@ -2879,7 +2841,7 @@ In case of use of pipes, you have to use double quotes. Otherwise, this helper w- Dude, show me the code ! + Dude, show me the code !
@@ -2919,7 +2881,7 @@ In case of use of pipes, you have to use double quotes. Otherwise, this helper w- Dude, show me the code ! + Dude, show me the code !
@@ -2974,7 +2936,7 @@ In case of use of pipes, you have to use double quotes. Otherwise, this helper w- Dude, show me the code ! + Dude, show me the code !
@@ -3018,7 +2980,7 @@ In case of use of pipes, you have to use double quotes. Otherwise, this helper w- Dude, show me the code ! + Dude, show me the code !
@@ -3048,7 +3010,7 @@ Please always call this script in install and restore scripts- Dude, show me the code ! + Dude, show me the code !
@@ -3912,11 +3874,7 @@ Please always call this script in install and restore scripts
- Usage: ynh_systemd_action [-n service_name] [-a action] [ [-l "line to match"] [-p log_path] [-t timeout] [-e length] ]
- If not defined it don't wait until the service is completely started.
- WARNING: When using --line_match, you should always add `ynh_clean_check_starting` into your
- `ynh_clean_setup` at the beginning of the script. Otherwise, tail will not stop in case of failure
- of the script. The script will then hang forever.
+ Usage: ynh_systemd_action [-n service_name] [-a action] [ [-l "line to match"] [-p log_path] [-t timeout] [-e length] ]
-l, --line_match= : Line to match - The line to find in the log to attest the service have finished to boot.-l, --line_match= : Line to match - The line to find in the log to attest the service have finished to boot. If not defined it don't wait until the service is completely started. WARNING: When using --line_match, you should always add `ynh_clean_check_starting` into your `ynh_clean_setup` at the beginning of the script. Otherwise, tail will not stop in case of failure of the script. The script will then hang forever.- Dude, show me the code ! + Dude, show me the code !
@@ -3986,7 +3944,7 @@ Please always call this script in install and restore scripts- Dude, show me the code ! + Dude, show me the code !
@@ -4762,11 +4720,7 @@ Please always call this script in install and restore scriptsDetails:
- Requires YunoHost version 3.5.0 or higher.
+ The version number in the manifest is defined by
Details:
- Requires YunoHost version 3.5.0 or higher.
+ The version number in the manifest is defined by
Details:
- It stops the current script without error if the package is up-to-dateThis helper should be used to avoid an upgrade of an app, or the upstream partof it, when it's not neededTo force an upgrade, even if the package is up to date,you have to set the variable YNH_FORCE_UPGRADE before.example: sudo YNH_FORCE_UPGRADE=1 yunohost app upgrade MyAppRequires YunoHost version 3.5.0 or higher. + - UPGRADE_APP if the upstream app version has changed- UPGRADE_PACKAGE if only the YunoHost package has changedIt stops the current script without error if the package is up-to-dateThis helper should be used to avoid an upgrade of an app, or the upstream partof it, when it's not neededTo force an upgrade, even if the package is up to date,you have to set the variable YNH_FORCE_UPGRADE before.example: sudo YNH_FORCE_UPGRADE=1 yunohost app upgrade MyAppRequires YunoHost version 3.5.0 or higher.