diff --git a/pages/04.contribute/04.packaging_apps/11.helpers/packaging_apps_helpers.md b/pages/04.contribute/04.packaging_apps/11.helpers/packaging_apps_helpers.md index 30626011..6c1caaf2 100644 --- a/pages/04.contribute/04.packaging_apps/11.helpers/packaging_apps_helpers.md +++ b/pages/04.contribute/04.packaging_apps/11.helpers/packaging_apps_helpers.md @@ -7,14 +7,13 @@ routes: default: '/packaging_apps_helpers' --- -Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/1ade4287aaf7976b3c87cd5f889382681a29fcee/doc/generate_helper_doc.py) on 09/10/2021 (YunoHost version 4.2.8.3) +Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/1ade4287aaf7976b3c87cd5f889382681a29fcee/doc/generate_helper_doc.py) on 09/17/2021 (YunoHost version 4.2.8.3) -### APT +## APT -**ynh_package_is_installed**
+#### ynh_package_is_installed [details summary="Check either a package is installed or not" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_package_is_installed --package=name` @@ -34,9 +33,8 @@ Requires YunoHost version 2.2.4 or higher. [/details] ---------------- -**ynh_package_version**
+#### ynh_package_version [details summary="Get the version of an installed package" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_package_version --package=name` @@ -56,9 +54,8 @@ Requires YunoHost version 2.2.4 or higher. [/details] ---------------- -**ynh_package_update**
+#### ynh_package_update [details summary="Update package index files" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_package_update` @@ -71,9 +68,8 @@ Requires YunoHost version 2.2.4 or higher. [/details] ---------------- -**ynh_package_install**
+#### ynh_package_install [details summary="Install package(s)" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_package_install name [name [...]]` @@ -89,9 +85,8 @@ Requires YunoHost version 2.2.4 or higher. [/details] ---------------- -**ynh_package_remove**
+#### ynh_package_remove [details summary="Remove package(s)" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_package_remove name [name [...]]` @@ -107,9 +102,8 @@ Requires YunoHost version 2.2.4 or higher. [/details] ---------------- -**ynh_package_autoremove**
+#### ynh_package_autoremove [details summary="Remove package(s) and their uneeded dependencies" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_package_autoremove name [name [...]]` @@ -125,9 +119,8 @@ Requires YunoHost version 2.2.4 or higher. [/details] ---------------- -**ynh_package_autopurge**
+#### ynh_package_autopurge [details summary="Purge package(s) and their uneeded dependencies" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_package_autopurge name [name [...]]` @@ -143,9 +136,8 @@ Requires YunoHost version 2.7.2 or higher. [/details] ---------------- -**ynh_install_app_dependencies**
+#### ynh_install_app_dependencies [details summary="Define and install dependencies with a equivs control file" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_install_app_dependencies dep [dep [...]]` @@ -166,9 +158,8 @@ Requires YunoHost version 2.6.4 or higher. [/details] ---------------- -**ynh_add_app_dependencies**
+#### ynh_add_app_dependencies [details summary="Add dependencies to install with ynh_install_app_dependencies" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_add_app_dependencies --package=phpversion [--replace]` @@ -185,9 +176,8 @@ Requires YunoHost version 3.8.1 or higher. [/details] ---------------- -**ynh_remove_app_dependencies**
+#### ynh_remove_app_dependencies [details summary="Remove fake package and its dependencies" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_remove_app_dependencies` @@ -202,9 +192,8 @@ Requires YunoHost version 2.6.4 or higher. [/details] ---------------- -**ynh_install_extra_app_dependencies**
+#### ynh_install_extra_app_dependencies [details summary="Install packages from an extra repository properly." class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_install_extra_app_dependencies --repo="repo" --package="dep1 dep2" [--key=key_url] [--name=name]` @@ -224,11 +213,10 @@ Requires YunoHost version 3.8.1 or higher. ---------------- -### BACKUP +## BACKUP -**ynh_backup**
+#### ynh_backup [details summary="Add a file or a directory to the list of paths to backup" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_backup --src_path=src_path [--dest_path=dest_path] [--is_big] [--not_mandatory]` @@ -298,9 +286,8 @@ Requires YunoHost version 3.5.0 or higher for the argument `--not_mandatory` [/details] ---------------- -**ynh_restore**
+#### ynh_restore [details summary="Restore all files that were previously backuped in a core backup script or app backup script" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_restore` @@ -313,9 +300,8 @@ Requires YunoHost version 2.6.4 or higher. [/details] ---------------- -**ynh_restore_file**
+#### ynh_restore_file [details summary="Restore a file or a directory" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_restore_file --origin_path=origin_path [--dest_path=dest_path] [--not_mandatory]` @@ -359,9 +345,8 @@ Requires YunoHost version 3.5.0 or higher for the argument --not_mandatory [/details] ---------------- -**ynh_store_file_checksum**
+#### ynh_store_file_checksum [details summary="Calculate and store a file checksum into the app settings" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_store_file_checksum --file=file` @@ -379,9 +364,8 @@ Requires YunoHost version 2.6.4 or higher. [/details] ---------------- -**ynh_backup_if_checksum_is_different**
+#### ynh_backup_if_checksum_is_different [details summary="Verify the checksum and backup the file if it's different" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_backup_if_checksum_is_different --file=file` @@ -402,9 +386,8 @@ Requires YunoHost version 2.6.4 or higher. [/details] ---------------- -**ynh_delete_file_checksum**
+#### ynh_delete_file_checksum [details summary="Delete a file checksum from the app settings" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_delete_file_checksum --file=file` @@ -422,9 +405,8 @@ Requires YunoHost version 3.3.1 or higher. [/details] ---------------- -**ynh_backup_before_upgrade**
+#### ynh_backup_before_upgrade [details summary="Make a backup in case of failed upgrade" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_backup_before_upgrade` @@ -446,9 +428,8 @@ Requires YunoHost version 2.7.2 or higher. [/details] ---------------- -**ynh_restore_upgradebackup**
+#### ynh_restore_upgradebackup [details summary="Restore a previous backup if the upgrade process failed" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_restore_upgradebackup` @@ -471,11 +452,10 @@ Requires YunoHost version 2.7.2 or higher. ---------------- -### FAIL2BAN +## FAIL2BAN -**ynh_add_fail2ban_config**
+#### ynh_add_fail2ban_config [details summary="Create a dedicated fail2ban config (jail and filter conf files)" class="helper-card-subtitle text-muted"] -

**Usage**: `1: ynh_add_fail2ban_config --logpath=log_file --failregex=filter [--max_retry=max_retry] [--ports=ports] 2: ynh_add_fail2ban_config --use_template [--others_var="list of others variables to replace"]` @@ -546,9 +526,8 @@ Requires YunoHost version 4.1.0 or higher. [/details] ---------------- -**ynh_remove_fail2ban_config**
+#### ynh_remove_fail2ban_config [details summary="Remove the dedicated fail2ban config (jail and filter conf files)" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_remove_fail2ban_config` @@ -562,14 +541,13 @@ Requires YunoHost version 3.5.0 or higher. ---------------- -### GETOPTS +## GETOPTS -### HARDWARE +## HARDWARE -**ynh_get_ram**
+#### ynh_get_ram [details summary="Get the total or free amount of RAM+swap on the system" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_get_ram [--free|--total] [--ignore_swap|--only_swap]` @@ -590,9 +568,8 @@ Requires YunoHost version 3.8.1 or higher. [/details] ---------------- -**ynh_require_ram**
+#### ynh_require_ram [details summary="Return 0 or 1 depending if the system has a given amount of RAM+swap free or total" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_require_ram --required=RAM [--free|--total] [--ignore_swap|--only_swap]` @@ -615,11 +592,10 @@ Requires YunoHost version 3.8.1 or higher. ---------------- -### LOGGING +## LOGGING -**ynh_die**
+#### ynh_die [details summary="Print a message to stderr and exit" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_die --message=MSG [--ret_code=RETCODE]` @@ -636,9 +612,8 @@ Requires YunoHost version 2.4.0 or higher. [/details] ---------------- -**ynh_print_info**
+#### ynh_print_info [details summary="Display a message in the 'INFO' logging category" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_print_info --message="Some message"` @@ -654,9 +629,8 @@ Requires YunoHost version 3.2.0 or higher. [/details] ---------------- -**ynh_print_warn**
+#### ynh_print_warn [details summary="Print a warning on stderr" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_print_warn --message="Text to print"` @@ -672,9 +646,8 @@ Requires YunoHost version 3.2.0 or higher. [/details] ---------------- -**ynh_print_err**
+#### ynh_print_err [details summary="Print an error on stderr" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_print_err --message="Text to print"` @@ -690,9 +663,8 @@ Requires YunoHost version 3.2.0 or higher. [/details] ---------------- -**ynh_exec_err**
+#### ynh_exec_err [details summary="Execute a command and print the result as an error" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_exec_err "your_command [ | other_command ]"` @@ -712,9 +684,8 @@ Requires YunoHost version 3.2.0 or higher. [/details] ---------------- -**ynh_exec_warn**
+#### ynh_exec_warn [details summary="Execute a command and print the result as a warning" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_exec_warn "your_command [ | other_command ]"` @@ -734,9 +705,8 @@ Requires YunoHost version 3.2.0 or higher. [/details] ---------------- -**ynh_exec_warn_less**
+#### ynh_exec_warn_less [details summary="Execute a command and force the result to be printed on stdout" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_exec_warn_less "your_command [ | other_command ]"` @@ -756,9 +726,8 @@ Requires YunoHost version 3.2.0 or higher. [/details] ---------------- -**ynh_exec_quiet**
+#### ynh_exec_quiet [details summary="Execute a command and redirect stdout in /dev/null" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_exec_quiet "your_command [ | other_command ]"` @@ -778,9 +747,8 @@ Requires YunoHost version 3.2.0 or higher. [/details] ---------------- -**ynh_exec_fully_quiet**
+#### ynh_exec_fully_quiet [details summary="Execute a command and redirect stdout and stderr in /dev/null" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_exec_fully_quiet "your_command [ | other_command ]"` @@ -800,9 +768,8 @@ Requires YunoHost version 3.2.0 or higher. [/details] ---------------- -**ynh_print_OFF**
+#### ynh_print_OFF [details summary="Remove any logs for all the following commands." class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_print_OFF` @@ -817,9 +784,8 @@ Requires YunoHost version 3.2.0 or higher. [/details] ---------------- -**ynh_print_ON**
+#### ynh_print_ON [details summary="Restore the logging after ynh_print_OFF" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_print_ON` @@ -832,9 +798,8 @@ Requires YunoHost version 3.2.0 or higher. [/details] ---------------- -**ynh_script_progression**
+#### ynh_script_progression [details summary="Print a progress bar showing the progression of an app script" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_script_progression --message=message [--weight=weight] [--time]` @@ -853,10 +818,9 @@ Requires YunoHost version 3.5.0 or higher. [/details] ---------------- -**ynh_return**
+#### ynh_return [details summary="Return data to the YunoHost core for later processing (to be used by special hooks like app config panel and core diagnosis)" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_return somedata` @@ -869,9 +833,8 @@ Requires YunoHost version 3.6.0 or higher. [/details] ---------------- -**ynh_debug**
+#### ynh_debug [details summary="Debugger for app packagers" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_debug [--message=message] [--trace=1/0]` @@ -888,9 +851,8 @@ Requires YunoHost version 3.5.0 or higher. [/details] ---------------- -**ynh_debug_exec**
+#### ynh_debug_exec [details summary="Execute a command and print the result as debug" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_debug_exec "your_command [ | other_command ]"` @@ -911,11 +873,10 @@ Requires YunoHost version 3.5.0 or higher. ---------------- -### LOGROTATE +## LOGROTATE -**ynh_use_logrotate**
+#### ynh_use_logrotate [details summary="Use logrotate to manage the logfile" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_use_logrotate [--logfile=/log/file] [--nonappend] [--specific_user=user/group]` @@ -940,9 +901,8 @@ Requires YunoHost version 3.2.0 or higher for the argument `--specific_user` [/details] ---------------- -**ynh_remove_logrotate**
+#### ynh_remove_logrotate [details summary="Remove the app's logrotate config." class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_remove_logrotate` @@ -956,11 +916,10 @@ Requires YunoHost version 2.6.4 or higher. ---------------- -### MULTIMEDIA +## MULTIMEDIA -**ynh_multimedia_build_main_dir**
+#### ynh_multimedia_build_main_dir [details summary="Initialize the multimedia directory system" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_multimedia_build_main_dir` @@ -973,9 +932,8 @@ Requires YunoHost version 4.2 or higher. [/details] ---------------- -**ynh_multimedia_addfolder**
+#### ynh_multimedia_addfolder [details summary="Add a directory in yunohost.multimedia" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_multimedia_addfolder --source_dir="source_dir" --dest_dir="dest_dir"` @@ -994,9 +952,8 @@ Requires YunoHost version 4.2 or higher. [/details] ---------------- -**ynh_multimedia_addaccess**
+#### ynh_multimedia_addaccess [details summary="Allow an user to have an write authorisation in multimedia directories" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_multimedia_addaccess user_name` @@ -1013,11 +970,10 @@ Requires YunoHost version 4.2 or higher. ---------------- -### MYSQL +## MYSQL -**ynh_mysql_connect_as**
+#### ynh_mysql_connect_as [details summary="Open a connection as a user" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_mysql_connect_as --user=user --password=password [--database=database]` @@ -1046,9 +1002,8 @@ Requires YunoHost version 2.2.4 or higher. [/details] ---------------- -**ynh_mysql_execute_as_root**
+#### ynh_mysql_execute_as_root [details summary="Execute a command as root user" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_mysql_execute_as_root --sql=sql [--database=database]` @@ -1065,9 +1020,8 @@ Requires YunoHost version 2.2.4 or higher. [/details] ---------------- -**ynh_mysql_execute_file_as_root**
+#### ynh_mysql_execute_file_as_root [details summary="Execute a command from a file as root user" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_mysql_execute_file_as_root --file=file [--database=database]` @@ -1084,9 +1038,8 @@ Requires YunoHost version 2.2.4 or higher. [/details] ---------------- -**ynh_mysql_dump_db**
+#### ynh_mysql_dump_db [details summary="Dump a database" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_mysql_dump_db --database=database` @@ -1106,9 +1059,8 @@ Requires YunoHost version 2.2.4 or higher. [/details] ---------------- -**ynh_mysql_user_exists**
+#### ynh_mysql_user_exists [details summary="Check if a mysql user exists" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_mysql_user_exists --user=user` @@ -1126,9 +1078,8 @@ Requires YunoHost version 2.2.4 or higher. [/details] ---------------- -**ynh_mysql_setup_db**
+#### ynh_mysql_setup_db [details summary="Create a database, an user and its password. Then store the password in the app's config" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_mysql_setup_db --db_user=user --db_name=name [--db_pwd=pwd]` @@ -1149,9 +1100,8 @@ Requires YunoHost version 2.6.4 or higher. [/details] ---------------- -**ynh_mysql_remove_db**
+#### ynh_mysql_remove_db [details summary="Remove a database if it exists, and the associated user" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_mysql_remove_db --db_user=user --db_name=name` @@ -1169,11 +1119,10 @@ Requires YunoHost version 2.6.4 or higher. ---------------- -### NETWORK +## NETWORK -**ynh_find_port**
+#### ynh_find_port [details summary="Find a free port and return it" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_find_port --port=begin_port` @@ -1193,9 +1142,8 @@ Requires YunoHost version 2.6.4 or higher. [/details] ---------------- -**ynh_port_available**
+#### ynh_port_available [details summary="Test if a port is available" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_find_port --port=XYZ` @@ -1215,9 +1163,8 @@ Requires YunoHost version 3.8.0 or higher. [/details] ---------------- -**ynh_validate_ip4**
+#### ynh_validate_ip4 [details summary="Validate an IPv4 address" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_validate_ip4 --ip_address=ip_address` @@ -1237,9 +1184,8 @@ Requires YunoHost version 2.2.4 or higher. [/details] ---------------- -**ynh_validate_ip6**
+#### ynh_validate_ip6 [details summary="Validate an IPv6 address" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_validate_ip6 --ip_address=ip_address` @@ -1260,11 +1206,10 @@ Requires YunoHost version 2.2.4 or higher. ---------------- -### NGINX +## NGINX -**ynh_add_nginx_config**
+#### ynh_add_nginx_config [details summary="Create a dedicated nginx config" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_add_nginx_config` @@ -1288,9 +1233,8 @@ Requires YunoHost version 4.1.0 or higher. [/details] ---------------- -**ynh_remove_nginx_config**
+#### ynh_remove_nginx_config [details summary="Remove the dedicated nginx config" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_remove_nginx_config` @@ -1304,11 +1248,10 @@ Requires YunoHost version 2.7.2 or higher. ---------------- -### NODEJS +## NODEJS -**ynh_use_nodejs**
+#### ynh_use_nodejs [details summary="Load the version of node for an app, and set variables." class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_use_nodejs` @@ -1358,9 +1301,8 @@ Requires YunoHost version 2.7.12 or higher. [/details] ---------------- -**ynh_install_nodejs**
+#### ynh_install_nodejs [details summary="Install a specific version of nodejs" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_install_nodejs --nodejs_version=nodejs_version` @@ -1383,9 +1325,8 @@ Requires YunoHost version 2.7.12 or higher. [/details] ---------------- -**ynh_remove_nodejs**
+#### ynh_remove_nodejs [details summary="Remove the version of node used by the app." class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_remove_nodejs` @@ -1403,11 +1344,10 @@ Requires YunoHost version 2.7.12 or higher. ---------------- -### PERMISSION +## PERMISSION -**ynh_permission_create**
+#### ynh_permission_create [details summary="Create a new permission for the app" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_permission_create --permission="permission" [--url="url"] [--additional_urls="second-url" [ "third-url" ]] [--auth_header=true|false] [--allowed=group1 [ group2 ]] [--label="label"] [--show_tile=true|false] @@ -1476,9 +1416,8 @@ Requires YunoHost version 3.7.0 or higher. [/details] ---------------- -**ynh_permission_delete**
+#### ynh_permission_delete [details summary="Remove a permission for the app (note that when the app is removed all permission is automatically removed)" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_permission_delete --permission="permission"` @@ -1496,9 +1435,8 @@ Requires YunoHost version 3.7.0 or higher. [/details] ---------------- -**ynh_permission_exists**
+#### ynh_permission_exists [details summary="Check if a permission exists" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_permission_exists --permission=permission | exit: Return 1 if the permission doesn't exist, 0 otherwise` @@ -1515,9 +1453,8 @@ Requires YunoHost version 3.7.0 or higher. [/details] ---------------- -**ynh_permission_url**
+#### ynh_permission_url [details summary="Redefine the url associated to a permission" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_permission_url --permission "permission" [--url="url"] [--add_url="new-url" [ "other-new-url" ]] [--remove_url="old-url" [ "other-old-url" ]] [--auth_header=true|false] [--clear_urls]` @@ -1539,9 +1476,8 @@ Requires YunoHost version 3.7.0 or higher. [/details] ---------------- -**ynh_permission_update**
+#### ynh_permission_update [details summary="Update a permission for the app" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_permission_update --permission "permission" [--add="group" ["group" ...]] [--remove="group" ["group" ...]] [--label="label"] [--show_tile=true|false] [--protected=true|false]` @@ -1563,9 +1499,8 @@ Requires YunoHost version 3.7.0 or higher. [/details] ---------------- -**ynh_permission_has_user**
+#### ynh_permission_has_user [details summary="Check if a permission has an user" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_permission_has_user --permission=permission --user=user | exit: Return 1 if the permission doesn't have that user or doesn't exist, 0 otherwise` @@ -1585,9 +1520,8 @@ Requires YunoHost version 3.7.1 or higher. [/details] ---------------- -**ynh_legacy_permissions_exists**
+#### ynh_legacy_permissions_exists [details summary="Check if a legacy permissions exist" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_legacy_permissions_exists | exit: Return 1 if the permission doesn't exist, 0 otherwise` @@ -1601,9 +1535,8 @@ Requires YunoHost version 4.1.2 or higher. [/details] ---------------- -**ynh_legacy_permissions_delete_all**
+#### ynh_legacy_permissions_delete_all [details summary="Remove all legacy permissions" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_legacy_permissions_delete_all` @@ -1614,11 +1547,10 @@ Requires YunoHost version 4.1.2 or higher. ---------------- -### PHP +## PHP -**ynh_add_fpm_config**
+#### ynh_add_fpm_config [details summary="Create a dedicated PHP-FPM config" class="helper-card-subtitle text-muted"] -

**Usage**: `1: ynh_add_fpm_config [--phpversion=7.X] [--use_template] [--package=packages] [--dedicated_service] 2: ynh_add_fpm_config [--phpversion=7.X] --usage=usage --footprint=footprint [--package=packages] [--dedicated_service] @@ -1672,9 +1604,8 @@ Requires YunoHost version 4.1.0 or higher. [/details] ---------------- -**ynh_remove_fpm_config**
+#### ynh_remove_fpm_config [details summary="Remove the dedicated PHP-FPM config" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_remove_fpm_config` @@ -1687,9 +1618,8 @@ Requires YunoHost version 2.7.2 or higher. [/details] ---------------- -**ynh_composer_exec**
+#### ynh_composer_exec [details summary="Execute a command with Composer" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_composer_exec [--phpversion=phpversion] [--workdir=$final_path] --commands="commands"` @@ -1707,9 +1637,8 @@ Requires YunoHost version 4.2 or higher. [/details] ---------------- -**ynh_install_composer**
+#### ynh_install_composer [details summary="Install and initialize Composer in the given directory" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_install_composer [--phpversion=phpversion] [--workdir=$final_path] [--install_args="--optimize-autoloader"] [--composerversion=composerversion]` @@ -1729,11 +1658,10 @@ Requires YunoHost version 4.2 or higher. ---------------- -### POSTGRESQL +## POSTGRESQL -**ynh_psql_connect_as**
+#### ynh_psql_connect_as [details summary="Open a connection as a user" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_psql_connect_as --user=user --password=password [--database=database]` @@ -1762,9 +1690,8 @@ Requires YunoHost version 3.5.0 or higher. [/details] ---------------- -**ynh_psql_execute_as_root**
+#### ynh_psql_execute_as_root [details summary="Execute a command as root user" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_psql_execute_as_root --sql=sql [--database=database]` @@ -1781,9 +1708,8 @@ Requires YunoHost version 3.5.0 or higher. [/details] ---------------- -**ynh_psql_execute_file_as_root**
+#### ynh_psql_execute_file_as_root [details summary="Execute a command from a file as root user" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_psql_execute_file_as_root --file=file [--database=database]` @@ -1800,9 +1726,8 @@ Requires YunoHost version 3.5.0 or higher. [/details] ---------------- -**ynh_psql_dump_db**
+#### ynh_psql_dump_db [details summary="Dump a database" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_psql_dump_db --database=database` @@ -1822,9 +1747,8 @@ Requires YunoHost version 3.5.0 or higher. [/details] ---------------- -**ynh_psql_user_exists**
+#### ynh_psql_user_exists [details summary="Check if a psql user exists" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_psql_user_exists --user=user | exit: Return 1 if the user doesn't exist, 0 otherwise` @@ -1841,9 +1765,8 @@ Requires YunoHost version 3.5.0 or higher. [/details] ---------------- -**ynh_psql_database_exists**
+#### ynh_psql_database_exists [details summary="Check if a psql database exists" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_psql_database_exists --database=database | exit: Return 1 if the database doesn't exist, 0 otherwise` @@ -1860,9 +1783,8 @@ Requires YunoHost version 3.5.0 or higher. [/details] ---------------- -**ynh_psql_setup_db**
+#### ynh_psql_setup_db [details summary="Create a database, an user and its password. Then store the password in the app's config" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_psql_setup_db --db_user=user --db_name=name [--db_pwd=pwd]` @@ -1883,9 +1805,8 @@ Requires YunoHost version 2.7.13 or higher. [/details] ---------------- -**ynh_psql_remove_db**
+#### ynh_psql_remove_db [details summary="Remove a database if it exists, and the associated user" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_psql_remove_db --db_user=user --db_name=name` @@ -1902,9 +1823,8 @@ Requires YunoHost version 2.7.13 or higher. [/details] ---------------- -**ynh_psql_test_if_first_run**
+#### ynh_psql_test_if_first_run [details summary="Create a master password and set up global settings" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_psql_test_if_first_run` @@ -1921,11 +1841,10 @@ Requires YunoHost version 2.7.13 or higher. ---------------- -### SETTING +## SETTING -**ynh_app_setting_get**
+#### ynh_app_setting_get [details summary="Get an application setting" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_app_setting_get --app=app --key=key` @@ -1942,9 +1861,8 @@ Requires YunoHost version 2.2.4 or higher. [/details] ---------------- -**ynh_app_setting_set**
+#### ynh_app_setting_set [details summary="Set an application setting" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_app_setting_set --app=app --key=key --value=value` @@ -1962,9 +1880,8 @@ Requires YunoHost version 2.2.4 or higher. [/details] ---------------- -**ynh_app_setting_delete**
+#### ynh_app_setting_delete [details summary="Delete an application setting" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_app_setting_delete --app=app --key=key` @@ -1981,9 +1898,8 @@ Requires YunoHost version 2.2.4 or higher. [/details] ---------------- -**ynh_webpath_available**
+#### ynh_webpath_available [details summary="Check availability of a web path" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_webpath_available --domain=domain --path_url=path` @@ -2002,9 +1918,8 @@ Requires YunoHost version 2.6.4 or higher. [/details] ---------------- -**ynh_webpath_register**
+#### ynh_webpath_register [details summary="Register/book a web path for an app" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_webpath_register --app=app --domain=domain --path_url=path` @@ -2025,11 +1940,10 @@ Requires YunoHost version 2.6.4 or higher. ---------------- -### STRING +## STRING -**ynh_string_random**
+#### ynh_string_random [details summary="Generate a random string" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_string_random [--length=string_length]` @@ -2049,9 +1963,8 @@ Requires YunoHost version 2.2.4 or higher. [/details] ---------------- -**ynh_replace_string**
+#### ynh_replace_string [details summary="Substitute/replace a string (or expression) by another in a file" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_replace_string --match_string=match_string --replace_string=replace_string --target_file=target_file` @@ -2072,9 +1985,8 @@ Requires YunoHost version 2.6.4 or higher. [/details] ---------------- -**ynh_replace_special_string**
+#### ynh_replace_special_string [details summary="Substitute/replace a special string by another in a file" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_replace_special_string --match_string=match_string --replace_string=replace_string --target_file=target_file` @@ -2095,9 +2007,8 @@ Requires YunoHost version 2.7.7 or higher. [/details] ---------------- -**ynh_sanitize_dbid**
+#### ynh_sanitize_dbid [details summary="Sanitize a string intended to be the name of a database" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_sanitize_dbid --db_name=name` @@ -2120,11 +2031,10 @@ Requires YunoHost version 2.2.4 or higher. ---------------- -### SYSTEMD +## SYSTEMD -**ynh_add_systemd_config**
+#### ynh_add_systemd_config [details summary="Create a dedicated systemd config" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_add_systemd_config [--service=service] [--template=template]` @@ -2146,9 +2056,8 @@ Requires YunoHost version 4.1.0 or higher. [/details] ---------------- -**ynh_remove_systemd_config**
+#### ynh_remove_systemd_config [details summary="Remove the dedicated systemd config" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_remove_systemd_config [--service=service]` @@ -2164,9 +2073,8 @@ Requires YunoHost version 2.7.2 or higher. [/details] ---------------- -**ynh_systemd_action**
+#### ynh_systemd_action [details summary="Start (or other actions) a service, print a log in case of failure and optionnaly wait until the service is completely started" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_systemd_action [--service_name=service_name] [--action=action] [ [--line_match="line to match"] [--log_path=log_path] [--timeout=300] [--length=20] ]` @@ -2188,11 +2096,10 @@ Requires YunoHost version 3.5.0 or higher. ---------------- -### USER +## USER -**ynh_user_exists**
+#### ynh_user_exists [details summary="Check if a YunoHost user exists" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_user_exists --username=username` @@ -2212,9 +2119,8 @@ Requires YunoHost version 2.2.4 or higher. [/details] ---------------- -**ynh_user_get_info**
+#### ynh_user_get_info [details summary="Retrieve a YunoHost user information" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_user_get_info --username=username --key=key` @@ -2235,9 +2141,8 @@ Requires YunoHost version 2.2.4 or higher. [/details] ---------------- -**ynh_user_list**
+#### ynh_user_list [details summary="Get the list of YunoHost users" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_user_list` @@ -2254,9 +2159,8 @@ Requires YunoHost version 2.4.0 or higher. [/details] ---------------- -**ynh_system_user_exists**
+#### ynh_system_user_exists [details summary="Check if a user exists on the system" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_system_user_exists --username=username` @@ -2274,9 +2178,8 @@ Requires YunoHost version 2.2.4 or higher. [/details] ---------------- -**ynh_system_group_exists**
+#### ynh_system_group_exists [details summary="Check if a group exists on the system" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_system_group_exists --group=group` @@ -2294,9 +2197,8 @@ Requires YunoHost version 3.5.0.2 or higher. [/details] ---------------- -**ynh_system_user_create**
+#### ynh_system_user_create [details summary="Create a system user" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_system_user_create --username=user_name [--home_dir=home_dir] [--use_shell] [--groups="group1 group2"]` @@ -2324,9 +2226,8 @@ Requires YunoHost version 2.6.4 or higher. [/details] ---------------- -**ynh_system_user_delete**
+#### ynh_system_user_delete [details summary="Delete a system user" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_system_user_delete --username=user_name` @@ -2342,9 +2243,8 @@ Requires YunoHost version 2.6.4 or higher. [/details] ---------------- -**ynh_exec_as**
+#### ynh_exec_as [details summary="Execute a command as another user" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_exec_as $USER COMMAND [ARG ...]` @@ -2358,11 +2258,10 @@ Requires YunoHost version 4.1.7 or higher. ---------------- -### UTILS +## UTILS -**ynh_abort_if_errors**
+#### ynh_abort_if_errors [details summary="Exits if an error occurs during the execution of the script." class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_abort_if_errors` @@ -2379,9 +2278,8 @@ Requires YunoHost version 2.6.4 or higher. [/details] ---------------- -**ynh_setup_source**
+#### ynh_setup_source [details summary="Download, check integrity, uncompress and patch the source from app.src" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_setup_source --dest_dir=dest_dir [--source_id=source_id] [--keep="file1 file2"]` @@ -2429,9 +2327,8 @@ Requires YunoHost version 2.6.4 or higher. [/details] ---------------- -**ynh_local_curl**
+#### ynh_local_curl [details summary="Curl abstraction to help with POST requests to local pages (such as installation forms)" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_local_curl "page_uri" "key1=value1" "key2=value2" ...` @@ -2456,9 +2353,8 @@ Requires YunoHost version 2.6.4 or higher. [/details] ---------------- -**ynh_add_config**
+#### ynh_add_config [details summary="Create a dedicated config file from a template" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_add_config --template="template" --destination="destination"` @@ -2519,9 +2415,8 @@ Requires YunoHost version 4.1.0 or higher. [/details] ---------------- -**ynh_get_debian_release**
+#### ynh_get_debian_release [details summary="Fetch the Debian release codename" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_get_debian_release` @@ -2536,9 +2431,8 @@ Requires YunoHost version 2.7.12 or higher. [/details] ---------------- -**ynh_secure_remove**
+#### ynh_secure_remove [details summary="Remove a file or a directory securely" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_secure_remove --file=path_to_remove` @@ -2554,9 +2448,8 @@ Requires YunoHost version 2.6.4 or higher. [/details] ---------------- -**ynh_read_manifest**
+#### ynh_read_manifest [details summary="Read the value of a key in a ynh manifest file" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_read_manifest --manifest="manifest.json" --key="key"` @@ -2575,9 +2468,8 @@ Requires YunoHost version 3.5.0 or higher. [/details] ---------------- -**ynh_app_upstream_version**
+#### ynh_app_upstream_version [details summary="Read the upstream version from the manifest or `$YNH_APP_MANIFEST_VERSION`" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_app_upstream_version [--manifest="manifest.json"]` @@ -2601,9 +2493,8 @@ Requires YunoHost version 3.5.0 or higher. [/details] ---------------- -**ynh_app_package_version**
+#### ynh_app_package_version [details summary="Read package version from the manifest" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_app_package_version [--manifest="manifest.json"]` @@ -2625,9 +2516,8 @@ Requires YunoHost version 3.5.0 or higher. [/details] ---------------- -**ynh_check_app_version_changed**
+#### ynh_check_app_version_changed [details summary="Checks the app version to upgrade with the existing app version and returns:" class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_check_app_version_changed` @@ -2649,9 +2539,8 @@ Requires YunoHost version 3.5.0 or higher. [/details] ---------------- -**ynh_compare_current_package_version**
+#### ynh_compare_current_package_version [details summary="Compare the current package version against another version given as an argument." class="helper-card-subtitle text-muted"] -

**Usage**: `ynh_compare_current_package_version --comparison (lt|le|eq|ne|ge|gt) --version `