From ef07e0485c727e61c42ebe5cad436d0115bef3d1 Mon Sep 17 00:00:00 2001 From: Julien Gomes Dias Date: Sun, 7 Feb 2021 17:21:51 +0100 Subject: [PATCH] Some fix on packaging page --- .../09.nginx/packaging_apps_nginx_conf.fr.md | 34 +-- .../09.nginx/packaging_apps_nginx_conf.md | 34 +-- .../11.helpers/packaging_apps_helpers.md | 265 +++++++++--------- 3 files changed, 162 insertions(+), 171 deletions(-) diff --git a/pages/02.contribute/04.packaging_apps/09.nginx/packaging_apps_nginx_conf.fr.md b/pages/02.contribute/04.packaging_apps/09.nginx/packaging_apps_nginx_conf.fr.md index 2c558993..14dc2e5f 100644 --- a/pages/02.contribute/04.packaging_apps/09.nginx/packaging_apps_nginx_conf.fr.md +++ b/pages/02.contribute/04.packaging_apps/09.nginx/packaging_apps_nginx_conf.fr.md @@ -14,24 +14,24 @@ La configuration doit être mise dans `conf/nginx.conf`. Il s’agira d’utilis * **FastCGI** est utilisé dans les applications PHP : ```nginx location YNH_EXAMPLE_PATH { - alias YNH_WWW_PATH ; - if ($scheme = http) { - rewrite ^ https://$server_name$request_uri? permanent; - } - index index.php; - try_files $uri $uri/ index.php; - location ~ [^/]\.php(/|$) { - fastcgi_split_path_info ^(.+?\.php)(/.*)$; - fastcgi_pass unix:/var/run/php5-fpm.sock; - fastcgi_index index.php; - include fastcgi_params; - fastcgi_param REMOTE_USER $remote_user; - fastcgi_param PATH_INFO $fastcgi_path_info; - fastcgi_param SCRIPT_FILENAME $request_filename; - } + alias YNH_WWW_PATH ; + if ($scheme = http) { + rewrite ^ https://$server_name$request_uri? permanent; + } + index index.php; + try_files $uri $uri/ index.php; + location ~ [^/]\.php(/|$) { + fastcgi_split_path_info ^(.+?\.php)(/.*)$; + fastcgi_pass unix:/var/run/php5-fpm.sock; + fastcgi_index index.php; + include fastcgi_params; + fastcgi_param REMOTE_USER $remote_user; + fastcgi_param PATH_INFO $fastcgi_path_info; + fastcgi_param SCRIPT_FILENAME $request_filename; + } - # Include SSOWAT user panel. - include conf.d/yunohost_panel.conf.inc; + # Include SSOWAT user panel. + include conf.d/yunohost_panel.conf.inc; } ``` diff --git a/pages/02.contribute/04.packaging_apps/09.nginx/packaging_apps_nginx_conf.md b/pages/02.contribute/04.packaging_apps/09.nginx/packaging_apps_nginx_conf.md index 04c622f1..f6999fb6 100644 --- a/pages/02.contribute/04.packaging_apps/09.nginx/packaging_apps_nginx_conf.md +++ b/pages/02.contribute/04.packaging_apps/09.nginx/packaging_apps_nginx_conf.md @@ -14,24 +14,24 @@ Configuration must be in `conf/nginx.conf`. We must use **FastCGI** or a **proxy * **FastCGI** is used with PHP applications: ```nginx location YNH_EXAMPLE_PATH { - alias YNH_WWW_PATH ; - if ($scheme = http) { - rewrite ^ https://$server_name$request_uri? permanent; - } - index index.php; - try_files $uri $uri/ index.php; - location ~ [^/]\.php(/|$) { - fastcgi_split_path_info ^(.+?\.php)(/.*)$; - fastcgi_pass unix:/var/run/php5-fpm.sock; - fastcgi_index index.php; - include fastcgi_params; - fastcgi_param REMOTE_USER $remote_user; - fastcgi_param PATH_INFO $fastcgi_path_info; - fastcgi_param SCRIPT_FILENAME $request_filename; - } + alias YNH_WWW_PATH ; + if ($scheme = http) { + rewrite ^ https://$server_name$request_uri? permanent; + } + index index.php; + try_files $uri $uri/ index.php; + location ~ [^/]\.php(/|$) { + fastcgi_split_path_info ^(.+?\.php)(/.*)$; + fastcgi_pass unix:/var/run/php5-fpm.sock; + fastcgi_index index.php; + include fastcgi_params; + fastcgi_param REMOTE_USER $remote_user; + fastcgi_param PATH_INFO $fastcgi_path_info; + fastcgi_param SCRIPT_FILENAME $request_filename; + } - # Include SSOWAT user panel. - include conf.d/yunohost_panel.conf.inc; + # Include SSOWAT user panel. + include conf.d/yunohost_panel.conf.inc; } ``` diff --git a/pages/02.contribute/04.packaging_apps/11.helpers/packaging_apps_helpers.md b/pages/02.contribute/04.packaging_apps/11.helpers/packaging_apps_helpers.md index 803a5af7..f20d1ee8 100644 --- a/pages/02.contribute/04.packaging_apps/11.helpers/packaging_apps_helpers.md +++ b/pages/02.contribute/04.packaging_apps/11.helpers/packaging_apps_helpers.md @@ -7,22 +7,19 @@ routes: default: '/packaging_apps_helpers' --- - +# App helpers -

App helpers

- -

Doc auto-generated by this script on 02/03/2021 (Yunohost version 4.1.7.1)

+Doc auto-generated by [this script]("https://github.com/YunoHost/yunohost/blob/e1062f145777bddbe6294932f7758c557306838c/doc/generate_helper_doc.py") on 02/03/2021 (Yunohost version 4.1.7.1). - -

apt

+## APT
-
ynh_package_is_installed
+
ynh_package_is_installed
Check either a package is installed or not
@@ -73,7 +70,7 @@ routes:
-
ynh_package_version
+
ynh_package_version
Get the version of an installed package
@@ -128,7 +125,7 @@ routes:
-
ynh_package_update
+
ynh_package_update
Update package index files
@@ -164,7 +161,7 @@ routes:
-
ynh_package_install
+
ynh_package_install
Install package(s)
@@ -211,7 +208,7 @@ routes:
-
ynh_package_remove
+
ynh_package_remove
Remove package(s)
@@ -258,7 +255,7 @@ routes:
-
ynh_package_autoremove
+
ynh_package_autoremove
Remove package(s) and their uneeded dependencies
@@ -305,7 +302,7 @@ routes:
-
ynh_package_autopurge
+
ynh_package_autopurge
Purge package(s) and their uneeded dependencies
@@ -352,7 +349,7 @@ routes:
-
ynh_install_app_dependencies
+
ynh_install_app_dependencies
Define and install dependencies with a equivs control file
@@ -399,7 +396,7 @@ routes:
-
ynh_add_app_dependencies
+
ynh_add_app_dependencies
Add dependencies to install with ynh_install_app_dependencies
@@ -450,7 +447,7 @@ routes:
-
ynh_remove_app_dependencies
+
ynh_remove_app_dependencies
Remove fake package and its dependencies
@@ -486,7 +483,7 @@ routes:
-
ynh_install_extra_app_dependencies
+
ynh_install_extra_app_dependencies
Install packages from an extra repository properly.
@@ -541,16 +538,13 @@ routes:
- - -

backup

- +### BACKUP
-
ynh_backup
+
ynh_backup
Add a file or a directory to the list of paths to backup
@@ -613,7 +607,7 @@ routes:
-
ynh_restore
+
ynh_restore
Restore all files that were previously backuped in a core backup script or app backup script
@@ -649,7 +643,7 @@ routes:
-
ynh_restore_file
+
ynh_restore_file
Restore a file or a directory
@@ -725,7 +719,7 @@ routes:
-
ynh_store_file_checksum
+
ynh_store_file_checksum
Calculate and store a file checksum into the app settings
@@ -772,7 +766,7 @@ routes:
-
ynh_backup_if_checksum_is_different
+
ynh_backup_if_checksum_is_different
Verify the checksum and backup the file if it's different
@@ -823,7 +817,7 @@ routes:
-
ynh_delete_file_checksum
+
ynh_delete_file_checksum
Delete a file checksum from the app settings
@@ -870,7 +864,7 @@ routes:
-
ynh_backup_before_upgrade
+
ynh_backup_before_upgrade
Make a backup in case of failed upgrade
@@ -910,7 +904,7 @@ routes:
-
ynh_restore_upgradebackup
+
ynh_restore_upgradebackup
Restore a previous backup if the upgrade process failed
@@ -948,14 +942,14 @@ routes: -

fail2ban

+### FAIL2BAN
-
ynh_add_fail2ban_config
+
ynh_add_fail2ban_config
Create a dedicated fail2ban config (jail and filter conf files)
@@ -1024,7 +1018,7 @@ routes:
-
ynh_remove_fail2ban_config
+
ynh_remove_fail2ban_config
Remove the dedicated fail2ban config (jail and filter conf files)
@@ -1058,19 +1052,19 @@ routes: -

getopts

+### GETOPS -

hardware

+### HARDWARE
-
ynh_get_ram
+
ynh_get_ram
Get the total or free amount of RAM+swap on the system
@@ -1133,7 +1127,7 @@ routes:
-
ynh_require_ram
+
ynh_require_ram
Return 0 or 1 depending if the system has a given amount of RAM+swap free or total
@@ -1194,15 +1188,14 @@ routes: - -

logging

+### LOGGING
-
ynh_die
+
ynh_die
Print a message to stderr and exit
@@ -1253,7 +1246,7 @@ routes:
-
ynh_print_info
+
ynh_print_info
Display a message in the 'INFO' logging category
@@ -1300,7 +1293,7 @@ routes:
-
ynh_print_warn
+
ynh_print_warn
Print a warning on stderr
@@ -1347,7 +1340,7 @@ routes:
-
ynh_print_err
+
ynh_print_err
Print an error on stderr
@@ -1394,7 +1387,7 @@ routes:
-
ynh_exec_err
+
ynh_exec_err
Execute a command and print the result as an error
@@ -1442,7 +1435,7 @@ ynh_exec_err "your_command | other_command"
-
ynh_exec_warn
+
ynh_exec_warn
Execute a command and print the result as a warning
@@ -1490,7 +1483,7 @@ ynh_exec_warn "your_command | other_command"
-
ynh_exec_warn_less
+
ynh_exec_warn_less
Execute a command and force the result to be printed on stdout
@@ -1538,7 +1531,7 @@ ynh_exec_warn_less "your_command | other_command"
-
ynh_exec_quiet
+
ynh_exec_quiet
Execute a command and redirect stdout in /dev/null
@@ -1586,7 +1579,7 @@ ynh_exec_quiet "your_command | other_command"
-
ynh_exec_fully_quiet
+
ynh_exec_fully_quiet
Execute a command and redirect stdout and stderr in /dev/null
@@ -1634,7 +1627,7 @@ ynh_exec_fully_quiet "your_command | other_command"
-
ynh_print_OFF
+
ynh_print_OFF
Remove any logs for all the following commands.
@@ -1670,7 +1663,7 @@ ynh_exec_fully_quiet "your_command | other_command"
-
ynh_print_ON
+
ynh_print_ON
Restore the logging after ynh_print_OFF
@@ -1706,7 +1699,7 @@ ynh_exec_fully_quiet "your_command | other_command"
-
ynh_script_progression
+
ynh_script_progression
Print a progress bar showing the progression of an app script
@@ -1765,7 +1758,7 @@ ynh_exec_fully_quiet "your_command | other_command"
-
ynh_return
+
ynh_return
Return data to the Yunohost core for later processing (to be used by special hooks like app config panel and core diagnosis)
@@ -1802,7 +1795,7 @@ ynh_exec_fully_quiet "your_command | other_command"
-
ynh_debug
+
ynh_debug
Debugger for app packagers
@@ -1853,7 +1846,7 @@ ynh_exec_fully_quiet "your_command | other_command"
-
ynh_debug_exec
+
ynh_debug_exec
Execute a command and print the result as debug
@@ -1899,14 +1892,14 @@ ynh_debug_exec "your_command | other_command" -

logrotate

+### LOGROTATE
-
ynh_use_logrotate
+
ynh_use_logrotate
Use logrotate to manage the logfile
@@ -1961,7 +1954,7 @@ ynh_debug_exec "your_command | other_command"
-
ynh_remove_logrotate
+
ynh_remove_logrotate
Remove the app's logrotate config.
@@ -1995,14 +1988,14 @@ ynh_debug_exec "your_command | other_command" -

mysql

+### MYSQL
-
ynh_mysql_connect_as
+
ynh_mysql_connect_as
Open a connection as a user
@@ -2061,7 +2054,7 @@ ynh_debug_exec "your_command | other_command"
-
ynh_mysql_execute_as_root
+
ynh_mysql_execute_as_root
Execute a command as root user
@@ -2112,7 +2105,7 @@ ynh_debug_exec "your_command | other_command"
-
ynh_mysql_execute_file_as_root
+
ynh_mysql_execute_file_as_root
Execute a command from a file as root user
@@ -2163,7 +2156,7 @@ ynh_debug_exec "your_command | other_command"
-
ynh_mysql_dump_db
+
ynh_mysql_dump_db
Dump a database
@@ -2218,7 +2211,7 @@ ynh_debug_exec "your_command | other_command"
-
ynh_mysql_user_exists
+
ynh_mysql_user_exists
Check if a mysql user exists
@@ -2266,7 +2259,7 @@ ynh_debug_exec "your_command | other_command"
-
ynh_mysql_setup_db
+
ynh_mysql_setup_db
Create a database, an user and its password. Then store the password in the app's config
@@ -2321,7 +2314,7 @@ ynh_debug_exec "your_command | other_command"
-
ynh_mysql_remove_db
+
ynh_mysql_remove_db
Remove a database if it exists, and the associated user
@@ -2370,14 +2363,14 @@ ynh_debug_exec "your_command | other_command" -

network

+### NETWORK
-
ynh_find_port
+
ynh_find_port
Find a free port and return it
@@ -2432,7 +2425,7 @@ ynh_debug_exec "your_command | other_command"
-
ynh_port_available
+
ynh_port_available
Test if a port is available
@@ -2484,7 +2477,7 @@ ynh_debug_exec "your_command | other_command"
-
ynh_validate_ip4
+
ynh_validate_ip4
Validate an IPv4 address
@@ -2539,7 +2532,7 @@ ynh_debug_exec "your_command | other_command"
-
ynh_validate_ip6
+
ynh_validate_ip6
Validate an IPv6 address
@@ -2592,14 +2585,14 @@ ynh_debug_exec "your_command | other_command" -

nginx

+### NGINX
-
ynh_add_nginx_config
+
ynh_add_nginx_config
Create a dedicated nginx config
@@ -2646,7 +2639,7 @@ ynh_debug_exec "your_command | other_command"
-
ynh_remove_nginx_config
+
ynh_remove_nginx_config
Remove the dedicated nginx config
@@ -2680,14 +2673,14 @@ ynh_debug_exec "your_command | other_command" -

nodejs

+### NODEJS
-
ynh_use_nodejs
+
ynh_use_nodejs
Load the version of node for an app, and set variables.
@@ -2723,7 +2716,7 @@ ynh_debug_exec "your_command | other_command"
-
ynh_install_nodejs
+
ynh_install_nodejs
Install a specific version of nodejs
@@ -2770,7 +2763,7 @@ ynh_debug_exec "your_command | other_command"
-
ynh_remove_nodejs
+
ynh_remove_nodejs
Remove the version of node used by the app.
@@ -2804,14 +2797,14 @@ ynh_debug_exec "your_command | other_command" -

permission

+### PERMISSION
-
ynh_permission_create
+
ynh_permission_create
Create a new permission for the app
@@ -2893,7 +2886,7 @@ ynh_debug_exec "your_command | other_command"
-
ynh_permission_delete
+
ynh_permission_delete
Remove a permission for the app (note that when the app is removed all permission is automatically removed)
@@ -2944,7 +2937,7 @@ ynh_debug_exec "your_command | other_command"
-
ynh_permission_exists
+
ynh_permission_exists
Check if a permission exists
@@ -2992,7 +2985,7 @@ ynh_debug_exec "your_command | other_command"
-
ynh_permission_url
+
ynh_permission_url
Redefine the url associated to a permission
@@ -3061,7 +3054,7 @@ ynh_debug_exec "your_command | other_command"
-
ynh_permission_update
+
ynh_permission_update
Update a permission for the app
@@ -3130,7 +3123,7 @@ ynh_debug_exec "your_command | other_command"
-
ynh_permission_has_user
+
ynh_permission_has_user
Check if a permission has an user
@@ -3186,7 +3179,7 @@ ynh_debug_exec "your_command | other_command"
-
ynh_legacy_permissions_exists
+
ynh_legacy_permissions_exists
Check if a legacy permissions exist
@@ -3223,7 +3216,7 @@ ynh_debug_exec "your_command | other_command"
-
ynh_legacy_permissions_delete_all
+
ynh_legacy_permissions_delete_all
Remove all legacy permissions
@@ -3254,14 +3247,13 @@ ynh_debug_exec "your_command | other_command" -

php

- +### PHP
-
ynh_add_fpm_config
+
ynh_add_fpm_config
Create a dedicated PHP-FPM config
@@ -3347,7 +3339,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP
-
ynh_remove_fpm_config
+
ynh_remove_fpm_config
Remove the dedicated PHP-FPM config
@@ -3381,14 +3373,14 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP -

postgresql

+### POSTGRESQL
-
ynh_psql_connect_as
+
ynh_psql_connect_as
Open a connection as a user
@@ -3459,7 +3451,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP
-
ynh_psql_execute_as_root
+
ynh_psql_execute_as_root
Execute a command as root user
@@ -3510,7 +3502,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP
-
ynh_psql_execute_file_as_root
+
ynh_psql_execute_file_as_root
Execute a command from a file as root user
@@ -3561,7 +3553,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP
-
ynh_psql_dump_db
+
ynh_psql_dump_db
Dump a database
@@ -3616,7 +3608,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP
-
ynh_psql_user_exists
+
ynh_psql_user_exists
Check if a psql user exists
@@ -3664,7 +3656,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP
-
ynh_psql_database_exists
+
ynh_psql_database_exists
Check if a psql database exists
@@ -3712,7 +3704,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP
-
ynh_psql_setup_db
+
ynh_psql_setup_db
Create a database, an user and its password. Then store the password in the app's config
@@ -3767,7 +3759,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP
-
ynh_psql_remove_db
+
ynh_psql_remove_db
Remove a database if it exists, and the associated user
@@ -3818,7 +3810,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP
-
ynh_psql_test_if_first_run
+
ynh_psql_test_if_first_run
Create a master password and set up global settings It also make sure that postgresql is installed and running Please always call this script in install and restore scripts
@@ -3854,14 +3846,14 @@ Please always call this script in install and restore scripts -

setting

+### SETTING
-
ynh_app_setting_get
+
ynh_app_setting_get
Get an application setting
@@ -3912,7 +3904,7 @@ Please always call this script in install and restore scripts
-
ynh_app_setting_set
+
ynh_app_setting_set
Set an application setting
@@ -3967,7 +3959,7 @@ Please always call this script in install and restore scripts
-
ynh_app_setting_delete
+
ynh_app_setting_delete
Delete an application setting
@@ -4018,7 +4010,7 @@ Please always call this script in install and restore scripts
-
ynh_webpath_available
+
ynh_webpath_available
Check availability of a web path
@@ -4073,7 +4065,7 @@ Please always call this script in install and restore scripts
-
ynh_webpath_register
+
ynh_webpath_register
Register/book a web path for an app
@@ -4130,14 +4122,14 @@ Please always call this script in install and restore scripts -

string

+### STRING
-
ynh_string_random
+
ynh_string_random
Generate a random string
@@ -4192,7 +4184,7 @@ Please always call this script in install and restore scripts
-
ynh_replace_string
+
ynh_replace_string
Substitute/replace a string (or expression) by another in a file
@@ -4247,7 +4239,7 @@ Please always call this script in install and restore scripts
-
ynh_replace_special_string
+
ynh_replace_special_string
Substitute/replace a special string by another in a file
@@ -4302,7 +4294,7 @@ Please always call this script in install and restore scripts
-
ynh_sanitize_dbid
+
ynh_sanitize_dbid
Sanitize a string intended to be the name of a database (More specifically : replace - and . by _)
@@ -4356,14 +4348,13 @@ Please always call this script in install and restore scripts -

systemd

- +### SYSTEMD
-
ynh_add_systemd_config
+
ynh_add_systemd_config
Create a dedicated systemd config
@@ -4419,7 +4410,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
-
ynh_remove_systemd_config
+
ynh_remove_systemd_config
Remove the dedicated systemd config
@@ -4466,7 +4457,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
-
ynh_systemd_action
+
ynh_systemd_action
Start (or other actions) a service, print a log in case of failure and optionnaly wait until the service is completely started
@@ -4533,7 +4524,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
-
ynh_clean_check_starting
+
ynh_clean_check_starting
Clean temporary process and file used by ynh_check_starting (usually used in ynh_clean_setup scripts)
@@ -4568,14 +4559,14 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var=" -

user

+### USER
-
ynh_user_exists
+
ynh_user_exists
Check if a YunoHost user exists
@@ -4627,7 +4618,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
-
ynh_user_get_info
+
ynh_user_get_info
Retrieve a YunoHost user information
@@ -4686,7 +4677,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
-
ynh_user_list
+
ynh_user_list
Get the list of YunoHost users
@@ -4730,7 +4721,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
-
ynh_system_user_exists
+
ynh_system_user_exists
Check if a user exists on the system
@@ -4778,7 +4769,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
-
ynh_system_group_exists
+
ynh_system_group_exists
Check if a group exists on the system
@@ -4826,7 +4817,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
-
ynh_system_user_create
+
ynh_system_user_create
Create a system user
@@ -4907,7 +4898,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
-
ynh_system_user_delete
+
ynh_system_user_delete
Delete a system user
@@ -4954,7 +4945,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
-
ynh_exec_as
+
ynh_exec_as
Execute a command as another user
@@ -4988,14 +4979,14 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var=" -

utils

+### UTILS
-
ynh_abort_if_errors
+
ynh_abort_if_errors
Exits if an error occurs during the execution of the script.
@@ -5031,7 +5022,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
-
ynh_setup_source
+
ynh_setup_source
Download, check integrity, uncompress and patch the source from app.src
@@ -5082,7 +5073,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
-
ynh_local_curl
+
ynh_local_curl
Curl abstraction to help with POST requests to local pages (such as installation forms)
@@ -5145,7 +5136,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
-
ynh_add_config
+
ynh_add_config
Create a dedicated config file from a template
@@ -5217,7 +5208,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
-
ynh_get_debian_release
+
ynh_get_debian_release
Fetch the Debian release codename
@@ -5257,7 +5248,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
-
ynh_secure_remove
+
ynh_secure_remove
Remove a file or a directory securely
@@ -5304,7 +5295,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
-
ynh_read_manifest
+
ynh_read_manifest
Read the value of a key in a ynh manifest file
@@ -5359,7 +5350,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
-
ynh_app_upstream_version
+
ynh_app_upstream_version
Read the upstream version from the manifest, or from the env variable $YNH_APP_MANIFEST_VERSION if not given
@@ -5410,7 +5401,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
-
ynh_app_package_version
+
ynh_app_package_version
Read package version from the manifest
@@ -5461,7 +5452,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
-
ynh_check_app_version_changed
+
ynh_check_app_version_changed
Checks the app version to upgrade with the existing app version and returns:
@@ -5497,7 +5488,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
-
ynh_compare_current_package_version
+
ynh_compare_current_package_version
Compare the current package version against another version given as an argument. This is really useful when we need to do some actions only for some old package versions.