mirror of
https://github.com/YunoHost/doc.git
synced 2024-09-03 20:06:26 +02:00
[CI] Update app helpers/resources for debian/11.2.21.1
This commit is contained in:
parent
56a076db52
commit
73a6ac03b3
3 changed files with 191 additions and 191 deletions
|
@ -7,7 +7,7 @@ routes:
|
||||||
default: '/packaging_apps_resources'
|
default: '/packaging_apps_resources'
|
||||||
---
|
---
|
||||||
|
|
||||||
Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/doc/generate_resource_doc.py) on 15/07/2024 (YunoHost version 11.2.21)
|
Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/doc/generate_resource_doc.py) on 15/07/2024 (YunoHost version 11.2.21.1)
|
||||||
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
|
@ -7,7 +7,7 @@ routes:
|
||||||
default: '/packaging_apps_helpers'
|
default: '/packaging_apps_helpers'
|
||||||
---
|
---
|
||||||
|
|
||||||
Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/doc/generate_helper_doc.py) on 15/07/2024 (YunoHost version 11.2.21)
|
Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/doc/generate_helper_doc.py) on 15/07/2024 (YunoHost version 11.2.21.1)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@ -90,7 +90,7 @@ The helper will:
|
||||||
Requires YunoHost version 2.6.4 or higher.
|
Requires YunoHost version 2.6.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/sources#L67)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/sources#L67)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -151,7 +151,7 @@ You will replace __YNH_NODE__ with $ynh_node
|
||||||
Requires YunoHost version 2.7.12 or higher.
|
Requires YunoHost version 2.7.12 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/nodejs#L52)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/nodejs#L52)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_install_nodejs
|
#### ynh_install_nodejs
|
||||||
|
@ -174,7 +174,7 @@ Refer to `ynh_use_nodejs` for more information about available commands and vari
|
||||||
Requires YunoHost version 2.7.12 or higher.
|
Requires YunoHost version 2.7.12 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/nodejs#L94)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/nodejs#L94)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_remove_nodejs
|
#### ynh_remove_nodejs
|
||||||
|
@ -191,7 +191,7 @@ This helper will check if another app uses the same version of node.
|
||||||
Requires YunoHost version 2.7.12 or higher.
|
Requires YunoHost version 2.7.12 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/nodejs#L164)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/nodejs#L164)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -240,7 +240,7 @@ one other variable is also available
|
||||||
Requires YunoHost version 3.2.2 or higher.
|
Requires YunoHost version 3.2.2 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/ruby#L53)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/ruby#L53)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_install_ruby
|
#### ynh_install_ruby
|
||||||
|
@ -266,7 +266,7 @@ to rbenv shims (e.g. $RBENV_ROOT/shims/bundle)
|
||||||
Requires YunoHost version 3.2.2 or higher.
|
Requires YunoHost version 3.2.2 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/ruby#L98)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/ruby#L98)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_remove_ruby
|
#### ynh_remove_ruby
|
||||||
|
@ -279,7 +279,7 @@ Requires YunoHost version 3.2.2 or higher.
|
||||||
This helper will also cleanup Ruby versions
|
This helper will also cleanup Ruby versions
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/ruby#L240)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/ruby#L240)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_cleanup_ruby
|
#### ynh_cleanup_ruby
|
||||||
|
@ -294,7 +294,7 @@ and uninstall them
|
||||||
If no app uses Ruby, rbenv will be also removed.
|
If no app uses Ruby, rbenv will be also removed.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/ruby#L265)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/ruby#L265)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -343,7 +343,7 @@ one other variable is also available
|
||||||
Requires YunoHost version 3.2.2 or higher.
|
Requires YunoHost version 3.2.2 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/go#L54)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/go#L54)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_install_go
|
#### ynh_install_go
|
||||||
|
@ -369,7 +369,7 @@ to goenv shims (e.g. $goenv_ROOT/shims/bundle)
|
||||||
Requires YunoHost version 3.2.2 or higher.
|
Requires YunoHost version 3.2.2 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/go#L96)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/go#L96)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_remove_go
|
#### ynh_remove_go
|
||||||
|
@ -382,7 +382,7 @@ Requires YunoHost version 3.2.2 or higher.
|
||||||
This helper will also cleanup Go versions
|
This helper will also cleanup Go versions
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/go#L185)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/go#L185)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_cleanup_go
|
#### ynh_cleanup_go
|
||||||
|
@ -397,7 +397,7 @@ and uninstall them
|
||||||
If no app uses Go, goenv will be also removed.
|
If no app uses Go, goenv will be also removed.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/go#L208)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/go#L208)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -420,7 +420,7 @@ If no app uses Go, goenv will be also removed.
|
||||||
Requires YunoHost version 4.2 or higher.
|
Requires YunoHost version 4.2 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/composer#L16)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/composer#L16)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_install_composer
|
#### ynh_install_composer
|
||||||
|
@ -439,7 +439,7 @@ Requires YunoHost version 4.2 or higher.
|
||||||
Requires YunoHost version 4.2 or higher.
|
Requires YunoHost version 4.2 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/composer#L48)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/composer#L48)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -479,7 +479,7 @@ Requires YunoHost version 4.2 or higher.
|
||||||
Requires YunoHost version 2.2.4 or higher.
|
Requires YunoHost version 2.2.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/mysql#L15)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/mysql#L15)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_mysql_execute_as_root
|
#### ynh_mysql_execute_as_root
|
||||||
|
@ -496,7 +496,7 @@ Requires YunoHost version 2.2.4 or higher.
|
||||||
Requires YunoHost version 2.2.4 or higher.
|
Requires YunoHost version 2.2.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/mysql#L36)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/mysql#L36)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_mysql_execute_file_as_root
|
#### ynh_mysql_execute_file_as_root
|
||||||
|
@ -513,7 +513,7 @@ Requires YunoHost version 2.2.4 or higher.
|
||||||
Requires YunoHost version 2.2.4 or higher.
|
Requires YunoHost version 2.2.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/mysql#L60)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/mysql#L60)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_mysql_dump_db
|
#### ynh_mysql_dump_db
|
||||||
|
@ -533,7 +533,7 @@ Requires YunoHost version 2.2.4 or higher.
|
||||||
Requires YunoHost version 2.2.4 or higher.
|
Requires YunoHost version 2.2.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/mysql#L128)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/mysql#L128)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -567,7 +567,7 @@ Requires YunoHost version 2.2.4 or higher.
|
||||||
Requires YunoHost version 3.5.0 or higher.
|
Requires YunoHost version 3.5.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/postgresql#L18)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/postgresql#L18)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_psql_execute_as_root
|
#### ynh_psql_execute_as_root
|
||||||
|
@ -584,7 +584,7 @@ Requires YunoHost version 3.5.0 or higher.
|
||||||
Requires YunoHost version 3.5.0 or higher.
|
Requires YunoHost version 3.5.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/postgresql#L39)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/postgresql#L39)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_psql_execute_file_as_root
|
#### ynh_psql_execute_file_as_root
|
||||||
|
@ -601,7 +601,7 @@ Requires YunoHost version 3.5.0 or higher.
|
||||||
Requires YunoHost version 3.5.0 or higher.
|
Requires YunoHost version 3.5.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/postgresql#L64)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/postgresql#L64)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_psql_dump_db
|
#### ynh_psql_dump_db
|
||||||
|
@ -621,7 +621,7 @@ Requires YunoHost version 3.5.0 or higher.
|
||||||
Requires YunoHost version 3.5.0 or higher.
|
Requires YunoHost version 3.5.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/postgresql#L135)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/postgresql#L135)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_psql_database_exists
|
#### ynh_psql_database_exists
|
||||||
|
@ -638,7 +638,7 @@ Requires YunoHost version 3.5.0 or higher.
|
||||||
Requires YunoHost version 3.5.0 or higher.
|
Requires YunoHost version 3.5.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/postgresql#L192)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/postgresql#L192)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -668,7 +668,7 @@ Requires YunoHost version 3.5.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/mongodb#L19)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/mongodb#L19)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_mongo_dump_db
|
#### ynh_mongo_dump_db
|
||||||
|
@ -688,7 +688,7 @@ Requires YunoHost version 3.5.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/mongodb#L136)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/mongodb#L136)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_mongo_database_exists
|
#### ynh_mongo_database_exists
|
||||||
|
@ -705,7 +705,7 @@ Requires YunoHost version 3.5.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/mongodb#L181)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/mongodb#L181)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_mongo_restore_db
|
#### ynh_mongo_restore_db
|
||||||
|
@ -723,7 +723,7 @@ Requires YunoHost version 3.5.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/mongodb#L205)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/mongodb#L205)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_mongo_setup_db
|
#### ynh_mongo_setup_db
|
||||||
|
@ -744,7 +744,7 @@ It will also be stored as "mongopwd" into the app settings.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/mongodb#L248)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/mongodb#L248)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_mongo_remove_db
|
#### ynh_mongo_remove_db
|
||||||
|
@ -761,7 +761,7 @@ It will also be stored as "mongopwd" into the app settings.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/mongodb#L276)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/mongodb#L276)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_install_mongo
|
#### ynh_install_mongo
|
||||||
|
@ -777,7 +777,7 @@ It will also be stored as "mongopwd" into the app settings.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/mongodb#L301)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/mongodb#L301)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_remove_mongo
|
#### ynh_remove_mongo
|
||||||
|
@ -792,7 +792,7 @@ if MongoDB package as been removed</i>" class="helper-card-subtitle text-muted"]
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/mongodb#L344)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/mongodb#L344)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -807,7 +807,7 @@ if MongoDB package as been removed</i>" class="helper-card-subtitle text-muted"]
|
||||||
**Usage**: `ynh_redis_get_free_db`
|
**Usage**: `ynh_redis_get_free_db`
|
||||||
|
|
||||||
**Returns**: the database number to use
|
**Returns**: the database number to use
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/redis#L7)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/redis#L7)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_redis_remove_db
|
#### ynh_redis_remove_db
|
||||||
|
@ -819,7 +819,7 @@ Please always call this script in install and restore scripts</i>" class="helper
|
||||||
|
|
||||||
**Arguments**:
|
**Arguments**:
|
||||||
- `database`: the database to erase
|
- `database`: the database to erase
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/redis#L36)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/redis#L36)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -900,7 +900,7 @@ into the app settings when configuration is done.
|
||||||
Requires YunoHost version 4.1.0 or higher.
|
Requires YunoHost version 4.1.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/templating#L56)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/templating#L56)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_read_var_in_file
|
#### ynh_read_var_in_file
|
||||||
|
@ -944,7 +944,7 @@ Example of line this helpers can managed correctly
|
||||||
Requires YunoHost version 4.3 or higher.
|
Requires YunoHost version 4.3 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/templating#L222)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/templating#L222)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_write_var_in_file
|
#### ynh_write_var_in_file
|
||||||
|
@ -963,7 +963,7 @@ Requires YunoHost version 4.3 or higher.
|
||||||
Requires YunoHost version 4.3 or higher.
|
Requires YunoHost version 4.3 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/templating#L300)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/templating#L300)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -992,7 +992,7 @@ location
|
||||||
Requires YunoHost version 4.1.0 or higher.
|
Requires YunoHost version 4.1.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/nginx#L19)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/nginx#L19)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_remove_nginx_config
|
#### ynh_remove_nginx_config
|
||||||
|
@ -1005,7 +1005,7 @@ Requires YunoHost version 4.1.0 or higher.
|
||||||
Requires YunoHost version 2.7.2 or higher.
|
Requires YunoHost version 2.7.2 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/nginx#L41)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/nginx#L41)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_change_url_nginx_config
|
#### ynh_change_url_nginx_config
|
||||||
|
@ -1018,7 +1018,7 @@ Requires YunoHost version 2.7.2 or higher.
|
||||||
Requires YunoHost version 11.1.9 or higher.
|
Requires YunoHost version 11.1.9 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/nginx#L52)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/nginx#L52)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -1093,7 +1093,7 @@ Set as 'high', the process manager will be set at 'static'. There will be always
|
||||||
Requires YunoHost version 4.1.0 or higher.
|
Requires YunoHost version 4.1.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/php#L70)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/php#L70)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_remove_fpm_config
|
#### ynh_remove_fpm_config
|
||||||
|
@ -1106,7 +1106,7 @@ Requires YunoHost version 4.1.0 or higher.
|
||||||
Requires YunoHost version 2.7.2 or higher.
|
Requires YunoHost version 2.7.2 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/php#L284)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/php#L284)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -1133,7 +1133,7 @@ format and how placeholders are replaced with actual variables.
|
||||||
Requires YunoHost version 4.1.0 or higher.
|
Requires YunoHost version 4.1.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/systemd#L15)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/systemd#L15)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_remove_systemd_config
|
#### ynh_remove_systemd_config
|
||||||
|
@ -1149,7 +1149,7 @@ Requires YunoHost version 4.1.0 or higher.
|
||||||
Requires YunoHost version 2.7.2 or higher.
|
Requires YunoHost version 2.7.2 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/systemd#L38)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/systemd#L38)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_systemd_action
|
#### ynh_systemd_action
|
||||||
|
@ -1170,7 +1170,7 @@ Requires YunoHost version 2.7.2 or higher.
|
||||||
Requires YunoHost version 3.5.0 or higher.
|
Requires YunoHost version 3.5.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/systemd#L67)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/systemd#L67)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -1239,7 +1239,7 @@ fail2ban-regex /var/log/YOUR_LOG_FILE_PATH /etc/fail2ban/filter.d/YOUR_APP.conf
|
||||||
Requires YunoHost version 4.1.0 or higher.
|
Requires YunoHost version 4.1.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/fail2ban#L58)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/fail2ban#L58)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_remove_fail2ban_config
|
#### ynh_remove_fail2ban_config
|
||||||
|
@ -1252,7 +1252,7 @@ Requires YunoHost version 4.1.0 or higher.
|
||||||
Requires YunoHost version 3.5.0 or higher.
|
Requires YunoHost version 3.5.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/fail2ban#L130)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/fail2ban#L130)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -1277,7 +1277,7 @@ If no `--logfile` is provided, `/var/log/$app` will be used as default.
|
||||||
Requires YunoHost version 2.6.4 or higher.
|
Requires YunoHost version 2.6.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/logrotate#L15)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/logrotate#L15)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_remove_logrotate
|
#### ynh_remove_logrotate
|
||||||
|
@ -1290,7 +1290,7 @@ Requires YunoHost version 2.6.4 or higher.
|
||||||
Requires YunoHost version 2.6.4 or higher.
|
Requires YunoHost version 2.6.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/logrotate#L99)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/logrotate#L99)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -1326,7 +1326,7 @@ For multiple calls, cookies are persisted between each call for the same app
|
||||||
Requires YunoHost version 2.6.4 or higher.
|
Requires YunoHost version 2.6.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/utils#L90)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/utils#L90)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_secure_remove
|
#### ynh_secure_remove
|
||||||
|
@ -1342,7 +1342,7 @@ Requires YunoHost version 2.6.4 or higher.
|
||||||
Requires YunoHost version 2.6.4 or higher.
|
Requires YunoHost version 2.6.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/utils#L173)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/utils#L173)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_read_manifest
|
#### ynh_read_manifest
|
||||||
|
@ -1361,7 +1361,7 @@ Requires YunoHost version 2.6.4 or higher.
|
||||||
Requires YunoHost version 3.5.0 or higher.
|
Requires YunoHost version 3.5.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/utils#L207)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/utils#L207)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_app_upstream_version
|
#### ynh_app_upstream_version
|
||||||
|
@ -1385,7 +1385,7 @@ For example, if the manifest contains `4.3-2~ynh3` the function will return `4.3
|
||||||
Requires YunoHost version 3.5.0 or higher.
|
Requires YunoHost version 3.5.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/utils#L250)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/utils#L250)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_check_app_version_changed
|
#### ynh_check_app_version_changed
|
||||||
|
@ -1403,7 +1403,7 @@ of it, when it's not needed
|
||||||
Requires YunoHost version 3.5.0 or higher.
|
Requires YunoHost version 3.5.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/utils#L302)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/utils#L302)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_compare_current_package_version
|
#### ynh_compare_current_package_version
|
||||||
|
@ -1434,7 +1434,7 @@ fi
|
||||||
Requires YunoHost version 3.8.0 or higher.
|
Requires YunoHost version 3.8.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/utils#L332)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/utils#L332)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_user_exists
|
#### ynh_user_exists
|
||||||
|
@ -1454,7 +1454,7 @@ Requires YunoHost version 3.8.0 or higher.
|
||||||
Requires YunoHost version 2.2.4 or higher.
|
Requires YunoHost version 2.2.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/utils#L414)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/utils#L414)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_user_get_info
|
#### ynh_user_get_info
|
||||||
|
@ -1475,7 +1475,7 @@ Requires YunoHost version 2.2.4 or higher.
|
||||||
Requires YunoHost version 2.2.4 or higher.
|
Requires YunoHost version 2.2.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/utils#L435)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/utils#L435)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_user_list
|
#### ynh_user_list
|
||||||
|
@ -1492,7 +1492,7 @@ Requires YunoHost version 2.2.4 or higher.
|
||||||
Requires YunoHost version 2.4.0 or higher.
|
Requires YunoHost version 2.4.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/utils#L455)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/utils#L455)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -1514,7 +1514,7 @@ Requires YunoHost version 2.4.0 or higher.
|
||||||
Requires YunoHost version 2.2.4 or higher.
|
Requires YunoHost version 2.2.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/setting#L10)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/setting#L10)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_app_setting_set
|
#### ynh_app_setting_set
|
||||||
|
@ -1532,7 +1532,7 @@ Requires YunoHost version 2.2.4 or higher.
|
||||||
Requires YunoHost version 2.2.4 or higher.
|
Requires YunoHost version 2.2.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/setting#L36)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/setting#L36)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_app_setting_set_default
|
#### ynh_app_setting_set_default
|
||||||
|
@ -1560,7 +1560,7 @@ fi
|
||||||
Requires YunoHost version 11.1.16 or higher.
|
Requires YunoHost version 11.1.16 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/setting#L73)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/setting#L73)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_app_setting_delete
|
#### ynh_app_setting_delete
|
||||||
|
@ -1577,7 +1577,7 @@ Requires YunoHost version 11.1.16 or higher.
|
||||||
Requires YunoHost version 2.2.4 or higher.
|
Requires YunoHost version 2.2.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/setting#L98)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/setting#L98)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -1603,7 +1603,7 @@ Requires YunoHost version 2.2.4 or higher.
|
||||||
Requires YunoHost version 2.2.4 or higher.
|
Requires YunoHost version 2.2.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/string#L13)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/string#L13)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_replace_string
|
#### ynh_replace_string
|
||||||
|
@ -1624,7 +1624,7 @@ sub-expressions can be used (see sed manual page for more information)
|
||||||
Requires YunoHost version 2.6.4 or higher.
|
Requires YunoHost version 2.6.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/string#L40)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/string#L40)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_replace_special_string
|
#### ynh_replace_special_string
|
||||||
|
@ -1645,7 +1645,7 @@ characters, you can't use some regular expressions and sub-expressions.
|
||||||
Requires YunoHost version 2.7.7 or higher.
|
Requires YunoHost version 2.7.7 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/string#L71)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/string#L71)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -1719,7 +1719,7 @@ Requires YunoHost version 2.4.0 or higher.
|
||||||
Requires YunoHost version 3.5.0 or higher for the argument `--not_mandatory`
|
Requires YunoHost version 3.5.0 or higher for the argument `--not_mandatory`
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/backup#L64)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/backup#L64)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_restore
|
#### ynh_restore
|
||||||
|
@ -1732,7 +1732,7 @@ Requires YunoHost version 3.5.0 or higher for the argument `--not_mandatory`
|
||||||
Requires YunoHost version 2.6.4 or higher.
|
Requires YunoHost version 2.6.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/backup#L179)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/backup#L179)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_restore_file
|
#### ynh_restore_file
|
||||||
|
@ -1776,7 +1776,7 @@ Requires YunoHost version 2.6.4 or higher.
|
||||||
Requires YunoHost version 3.5.0 or higher for the argument --not_mandatory
|
Requires YunoHost version 3.5.0 or higher for the argument --not_mandatory
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/backup#L238)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/backup#L238)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_store_file_checksum
|
#### ynh_store_file_checksum
|
||||||
|
@ -1794,7 +1794,7 @@ $app should be defined when calling this helper
|
||||||
Requires YunoHost version 2.6.4 or higher.
|
Requires YunoHost version 2.6.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/backup#L306)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/backup#L306)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_backup_if_checksum_is_different
|
#### ynh_backup_if_checksum_is_different
|
||||||
|
@ -1815,7 +1815,7 @@ modified config files.
|
||||||
Requires YunoHost version 2.6.4 or higher.
|
Requires YunoHost version 2.6.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/backup#L357)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/backup#L357)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_delete_file_checksum
|
#### ynh_delete_file_checksum
|
||||||
|
@ -1833,7 +1833,7 @@ $app should be defined when calling this helper
|
||||||
Requires YunoHost version 3.3.1 or higher.
|
Requires YunoHost version 3.3.1 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/backup#L397)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/backup#L397)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -1855,7 +1855,7 @@ Requires YunoHost version 3.3.1 or higher.
|
||||||
Requires YunoHost version 2.4.0 or higher.
|
Requires YunoHost version 2.4.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/logging#L10)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/logging#L10)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_print_info
|
#### ynh_print_info
|
||||||
|
@ -1871,7 +1871,7 @@ Requires YunoHost version 2.4.0 or higher.
|
||||||
Requires YunoHost version 3.2.0 or higher.
|
Requires YunoHost version 3.2.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/logging#L30)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/logging#L30)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_print_warn
|
#### ynh_print_warn
|
||||||
|
@ -1887,7 +1887,7 @@ Requires YunoHost version 3.2.0 or higher.
|
||||||
Requires YunoHost version 3.2.0 or higher.
|
Requires YunoHost version 3.2.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/logging#L56)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/logging#L56)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_print_err
|
#### ynh_print_err
|
||||||
|
@ -1903,7 +1903,7 @@ Requires YunoHost version 3.2.0 or higher.
|
||||||
Requires YunoHost version 3.2.0 or higher.
|
Requires YunoHost version 3.2.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/logging#L73)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/logging#L73)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_exec_err
|
#### ynh_exec_err
|
||||||
|
@ -1921,7 +1921,7 @@ Note that you should NOT quote the command but only prefix it with ynh_exec_err
|
||||||
Requires YunoHost version 3.2.0 or higher.
|
Requires YunoHost version 3.2.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/logging#L92)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/logging#L92)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_exec_warn
|
#### ynh_exec_warn
|
||||||
|
@ -1939,7 +1939,7 @@ Note that you should NOT quote the command but only prefix it with ynh_exec_warn
|
||||||
Requires YunoHost version 3.2.0 or higher.
|
Requires YunoHost version 3.2.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/logging#L113)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/logging#L113)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_exec_warn_less
|
#### ynh_exec_warn_less
|
||||||
|
@ -1957,7 +1957,7 @@ Note that you should NOT quote the command but only prefix it with ynh_exec_warn
|
||||||
Requires YunoHost version 3.2.0 or higher.
|
Requires YunoHost version 3.2.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/logging#L134)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/logging#L134)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_exec_quiet
|
#### ynh_exec_quiet
|
||||||
|
@ -1975,7 +1975,7 @@ Note that you should NOT quote the command but only prefix it with ynh_exec_warn
|
||||||
Requires YunoHost version 3.2.0 or higher.
|
Requires YunoHost version 3.2.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/logging#L155)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/logging#L155)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_exec_fully_quiet
|
#### ynh_exec_fully_quiet
|
||||||
|
@ -1993,7 +1993,7 @@ Note that you should NOT quote the command but only prefix it with ynh_exec_quie
|
||||||
Requires YunoHost version 3.2.0 or higher.
|
Requires YunoHost version 3.2.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/logging#L176)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/logging#L176)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_exec_and_print_stderr_only_if_error
|
#### ynh_exec_and_print_stderr_only_if_error
|
||||||
|
@ -2011,7 +2011,7 @@ Note that you should NOT quote the command but only prefix it with ynh_exec_and_
|
||||||
Requires YunoHost version 11.2 or higher.
|
Requires YunoHost version 11.2 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/logging#L197)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/logging#L197)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_script_progression
|
#### ynh_script_progression
|
||||||
|
@ -2030,7 +2030,7 @@ Requires YunoHost version 11.2 or higher.
|
||||||
Requires YunoHost version 3.5.0 or higher.
|
Requires YunoHost version 3.5.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/logging#L257)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/logging#L257)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_return
|
#### ynh_return
|
||||||
|
@ -2044,7 +2044,7 @@ Requires YunoHost version 3.5.0 or higher.
|
||||||
Requires YunoHost version 3.6.0 or higher.
|
Requires YunoHost version 3.6.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/logging#L345)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/logging#L345)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -2062,7 +2062,7 @@ Requires YunoHost version 3.6.0 or higher.
|
||||||
Requires YunoHost version 4.2 or higher.
|
Requires YunoHost version 4.2 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/multimedia#L11)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/multimedia#L11)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_multimedia_addfolder
|
#### ynh_multimedia_addfolder
|
||||||
|
@ -2081,7 +2081,7 @@ This "directory" will be a symbolic link to a existing directory.
|
||||||
Requires YunoHost version 4.2 or higher.
|
Requires YunoHost version 4.2 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/multimedia#L64)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/multimedia#L64)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_multimedia_addaccess
|
#### ynh_multimedia_addaccess
|
||||||
|
@ -2097,7 +2097,7 @@ Requires YunoHost version 4.2 or higher.
|
||||||
Requires YunoHost version 4.2 or higher.
|
Requires YunoHost version 4.2 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/multimedia#L93)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/multimedia#L93)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -2177,7 +2177,7 @@ See https://github.com/YunoHost/issues/issues/1420 for more informations
|
||||||
Requires YunoHost version 3.7.0 or higher.
|
Requires YunoHost version 3.7.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/permission#L66)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/permission#L66)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_permission_delete
|
#### ynh_permission_delete
|
||||||
|
@ -2195,7 +2195,7 @@ Requires YunoHost version 3.7.0 or higher.
|
||||||
Requires YunoHost version 3.7.0 or higher.
|
Requires YunoHost version 3.7.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/permission#L152)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/permission#L152)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_permission_exists
|
#### ynh_permission_exists
|
||||||
|
@ -2212,7 +2212,7 @@ Requires YunoHost version 3.7.0 or higher.
|
||||||
Requires YunoHost version 3.7.0 or higher.
|
Requires YunoHost version 3.7.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/permission#L169)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/permission#L169)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_permission_url
|
#### ynh_permission_url
|
||||||
|
@ -2234,7 +2234,7 @@ Requires YunoHost version 3.7.0 or higher.
|
||||||
Requires YunoHost version 3.7.0 or higher.
|
Requires YunoHost version 3.7.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/permission#L192)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/permission#L192)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_permission_update
|
#### ynh_permission_update
|
||||||
|
@ -2256,7 +2256,7 @@ Requires YunoHost version 3.7.0 or higher.
|
||||||
Requires YunoHost version 3.7.0 or higher.
|
Requires YunoHost version 3.7.0 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/permission#L260)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/permission#L260)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_permission_has_user
|
#### ynh_permission_has_user
|
||||||
|
@ -2276,7 +2276,7 @@ Requires YunoHost version 3.7.0 or higher.
|
||||||
Requires YunoHost version 3.7.1 or higher.
|
Requires YunoHost version 3.7.1 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/permission#L329)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/permission#L329)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_legacy_permissions_exists
|
#### ynh_legacy_permissions_exists
|
||||||
|
@ -2290,7 +2290,7 @@ Requires YunoHost version 3.7.1 or higher.
|
||||||
Requires YunoHost version 4.1.2 or higher.
|
Requires YunoHost version 4.1.2 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/permission#L359)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/permission#L359)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_legacy_permissions_delete_all
|
#### ynh_legacy_permissions_delete_all
|
||||||
|
@ -2300,7 +2300,7 @@ Requires YunoHost version 4.1.2 or higher.
|
||||||
**Usage**: `ynh_legacy_permissions_delete_all`
|
**Usage**: `ynh_legacy_permissions_delete_all`
|
||||||
|
|
||||||
**Example**: `if ynh_legacy_permissions_exists then ynh_legacy_permissions_delete_all # You can recreate the required permissions here with ynh_permission_create fi Requires YunoHost version 4.1.2 or higher.`
|
**Example**: `if ynh_legacy_permissions_exists then ynh_legacy_permissions_delete_all # You can recreate the required permissions here with ynh_permission_create fi Requires YunoHost version 4.1.2 or higher.`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/permission#L379)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/permission#L379)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -2325,7 +2325,7 @@ Requires YunoHost version 4.1.2 or higher.
|
||||||
Requires YunoHost version 2.2.4 or higher.
|
Requires YunoHost version 2.2.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/apt#L53)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/apt#L53)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_install_app_dependencies
|
#### ynh_install_app_dependencies
|
||||||
|
@ -2346,7 +2346,7 @@ example : ynh_install_app_dependencies dep1 dep2 "dep3|dep4|dep5"
|
||||||
Requires YunoHost version 2.6.4 or higher.
|
Requires YunoHost version 2.6.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/apt#L236)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/apt#L236)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_remove_app_dependencies
|
#### ynh_remove_app_dependencies
|
||||||
|
@ -2361,7 +2361,7 @@ Dependencies will removed only if no other package need them.
|
||||||
Requires YunoHost version 2.6.4 or higher.
|
Requires YunoHost version 2.6.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/apt#L371)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/apt#L371)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_install_extra_app_dependencies
|
#### ynh_install_extra_app_dependencies
|
||||||
|
@ -2380,7 +2380,7 @@ Requires YunoHost version 2.6.4 or higher.
|
||||||
Requires YunoHost version 3.8.1 or higher.
|
Requires YunoHost version 3.8.1 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/apt#L405)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/apt#L405)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -2413,7 +2413,7 @@ ynh_system_user_create --username=discourse --home_dir=/var/www/discourse --use_
|
||||||
Requires YunoHost version 2.6.4 or higher.
|
Requires YunoHost version 2.6.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/systemuser#L61)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/systemuser#L61)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_system_user_delete
|
#### ynh_system_user_delete
|
||||||
|
@ -2429,7 +2429,7 @@ Requires YunoHost version 2.6.4 or higher.
|
||||||
Requires YunoHost version 2.6.4 or higher.
|
Requires YunoHost version 2.6.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/systemuser#L103)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/systemuser#L103)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_exec_as
|
#### ynh_exec_as
|
||||||
|
@ -2442,7 +2442,7 @@ Requires YunoHost version 2.6.4 or higher.
|
||||||
Requires YunoHost version 4.1.7 or higher.
|
Requires YunoHost version 4.1.7 or higher.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v1.d/systemuser#L129)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v1.d/systemuser#L129)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
|
@ -7,7 +7,7 @@ routes:
|
||||||
default: '/packaging_apps_helpers_v2.1'
|
default: '/packaging_apps_helpers_v2.1'
|
||||||
---
|
---
|
||||||
|
|
||||||
Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/doc/generate_helper_doc.py) on 15/07/2024 (YunoHost version 11.2.21)
|
Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/doc/generate_helper_doc.py) on 15/07/2024 (YunoHost version 11.2.21.1)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@ -86,7 +86,7 @@ The helper will:
|
||||||
- Apply sane default permissions (see _ynh_apply_default_permissions)
|
- Apply sane default permissions (see _ynh_apply_default_permissions)
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/sources#L63)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/sources#L63)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -118,7 +118,7 @@ is preserved when calling ynh_exec_as_app). Also defines:
|
||||||
- `$nodejs_dir`, the directory containing the specific version of nodejs, which may be used in the systemd config too (e.g. `ExecStart=__NODEJS_DIR__/node foo bar`)
|
- `$nodejs_dir`, the directory containing the specific version of nodejs, which may be used in the systemd config too (e.g. `ExecStart=__NODEJS_DIR__/node foo bar`)
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/nodejs#L42)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/nodejs#L42)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_nodejs_remove
|
#### ynh_nodejs_remove
|
||||||
|
@ -133,7 +133,7 @@ This helper will check if another app uses the same version of node.
|
||||||
- If no other app uses node, n will be also removed.
|
- If no other app uses node, n will be also removed.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/nodejs#L107)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/nodejs#L107)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -158,7 +158,7 @@ is preserved when calling ynh_exec_as_app). Also defines:
|
||||||
This helper also creates a /etc/profile.d/rbenv.sh that configures PATH environment for rbenv
|
This helper also creates a /etc/profile.d/rbenv.sh that configures PATH environment for rbenv
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/ruby#L44)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/ruby#L44)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_ruby_remove
|
#### ynh_ruby_remove
|
||||||
|
@ -171,7 +171,7 @@ This helper also creates a /etc/profile.d/rbenv.sh that configures PATH environm
|
||||||
This helper will also cleanup unused Ruby versions
|
This helper will also cleanup unused Ruby versions
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/ruby#L185)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/ruby#L185)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -196,7 +196,7 @@ is preserved when calling `ynh_exec_as_app`). Also defines:
|
||||||
This helper also creates a /etc/profile.d/goenv.sh that configures PATH environment for goenv
|
This helper also creates a /etc/profile.d/goenv.sh that configures PATH environment for goenv
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/go#L42)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/go#L42)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_go_remove
|
#### ynh_go_remove
|
||||||
|
@ -209,7 +209,7 @@ This helper also creates a /etc/profile.d/goenv.sh that configures PATH environm
|
||||||
This helper will also cleanup Go versions
|
This helper will also cleanup Go versions
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/go#L129)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/go#L129)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -230,7 +230,7 @@ as global prior to calling this helper.
|
||||||
Will use `$install_dir` as workdir unless `$composer_workdir` exists (but that shouldnt be necessary)
|
Will use `$install_dir` as workdir unless `$composer_workdir` exists (but that shouldnt be necessary)
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/composer#L11)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/composer#L11)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_composer_exec
|
#### ynh_composer_exec
|
||||||
|
@ -246,7 +246,7 @@ You may also define `composer_user=root` prior to call this helper if you
|
||||||
absolutely need composer to run as root, but this is discouraged...
|
absolutely need composer to run as root, but this is discouraged...
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/composer#L37)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/composer#L37)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -279,7 +279,7 @@ absolutely need composer to run as root, but this is discouraged...
|
||||||
- ` ynh_mysql_db_shell < /path/to/file.sql`
|
- ` ynh_mysql_db_shell < /path/to/file.sql`
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/mysql#L12)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/mysql#L12)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_mysql_dump_db
|
#### ynh_mysql_dump_db
|
||||||
|
@ -294,7 +294,7 @@ absolutely need composer to run as root, but this is discouraged...
|
||||||
**Returns**: The mysqldump output
|
**Returns**: The mysqldump output
|
||||||
|
|
||||||
**Example**: `ynh_mysql_dump_db "roundcube" > ./dump.sql`
|
**Example**: `ynh_mysql_dump_db "roundcube" > ./dump.sql`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/mysql#L65)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/mysql#L65)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -321,7 +321,7 @@ absolutely need composer to run as root, but this is discouraged...
|
||||||
- ` ynh_psql_db_shell < /path/to/file.sql`
|
- ` ynh_psql_db_shell < /path/to/file.sql`
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/postgresql#L15)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/postgresql#L15)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_psql_dump_db
|
#### ynh_psql_dump_db
|
||||||
|
@ -336,7 +336,7 @@ absolutely need composer to run as root, but this is discouraged...
|
||||||
**Returns**: the psqldump output
|
**Returns**: the psqldump output
|
||||||
|
|
||||||
**Example**: `ynh_psql_dump_db 'roundcube' > ./dump.sql`
|
**Example**: `ynh_psql_dump_db 'roundcube' > ./dump.sql`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/postgresql#L70)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/postgresql#L70)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -360,7 +360,7 @@ absolutely need composer to run as root, but this is discouraged...
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/mongodb#L13)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/mongodb#L13)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_mongo_dump_db
|
#### ynh_mongo_dump_db
|
||||||
|
@ -380,7 +380,7 @@ absolutely need composer to run as root, but this is discouraged...
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/mongodb#L64)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/mongodb#L64)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_mongo_database_exists
|
#### ynh_mongo_database_exists
|
||||||
|
@ -397,7 +397,7 @@ absolutely need composer to run as root, but this is discouraged...
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/mongodb#L107)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/mongodb#L107)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_mongo_restore_db
|
#### ynh_mongo_restore_db
|
||||||
|
@ -415,7 +415,7 @@ absolutely need composer to run as root, but this is discouraged...
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/mongodb#L130)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/mongodb#L130)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_mongo_setup_db
|
#### ynh_mongo_setup_db
|
||||||
|
@ -436,7 +436,7 @@ It will also be stored as "mongopwd" into the app settings.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/mongodb#L171)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/mongodb#L171)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_mongo_remove_db
|
#### ynh_mongo_remove_db
|
||||||
|
@ -453,7 +453,7 @@ It will also be stored as "mongopwd" into the app settings.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/mongodb#L198)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/mongodb#L198)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_install_mongo
|
#### ynh_install_mongo
|
||||||
|
@ -466,7 +466,7 @@ It will also be stored as "mongopwd" into the app settings.
|
||||||
The installed version is defined by $mongo_version which should be defined as global prior to calling this helper
|
The installed version is defined by $mongo_version which should be defined as global prior to calling this helper
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/mongodb#L222)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/mongodb#L222)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_remove_mongo
|
#### ynh_remove_mongo
|
||||||
|
@ -481,7 +481,7 @@ if MongoDB package as been removed</i>" class="helper-card-subtitle text-muted"]
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/mongodb#L263)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/mongodb#L263)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -496,7 +496,7 @@ if MongoDB package as been removed</i>" class="helper-card-subtitle text-muted"]
|
||||||
**Usage**: `ynh_redis_get_free_db`
|
**Usage**: `ynh_redis_get_free_db`
|
||||||
|
|
||||||
**Returns**: the database number to use
|
**Returns**: the database number to use
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/redis#L7)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/redis#L7)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_redis_remove_db
|
#### ynh_redis_remove_db
|
||||||
|
@ -508,7 +508,7 @@ Please always call this script in install and restore scripts</i>" class="helper
|
||||||
|
|
||||||
**Arguments**:
|
**Arguments**:
|
||||||
- `database`: the database to erase
|
- `database`: the database to erase
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/redis#L36)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/redis#L36)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -577,7 +577,7 @@ And it will calculate and store the destination file checksum
|
||||||
into the app settings when configuration is done.
|
into the app settings when configuration is done.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/templating#L44)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/templating#L44)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_read_var_in_file
|
#### ynh_read_var_in_file
|
||||||
|
@ -619,7 +619,7 @@ Example of line this helpers can managed correctly
|
||||||
CUSTOM['user'] = 'YunoHost'
|
CUSTOM['user'] = 'YunoHost'
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/templating#L172)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/templating#L172)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_write_var_in_file
|
#### ynh_write_var_in_file
|
||||||
|
@ -633,7 +633,7 @@ Example of line this helpers can managed correctly
|
||||||
- `--key=`: the key to set
|
- `--key=`: the key to set
|
||||||
- `--value=`: the value to set
|
- `--value=`: the value to set
|
||||||
- `--after=`: the line just before the key (in case of multiple lines with the name of the key in the file)
|
- `--after=`: the line just before the key (in case of multiple lines with the name of the key in the file)
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/templating#L247)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/templating#L247)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -660,7 +660,7 @@ This allows to enable/disable specific behaviors dependenging on the install
|
||||||
location
|
location
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/nginx#L17)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/nginx#L17)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_config_remove_nginx
|
#### ynh_config_remove_nginx
|
||||||
|
@ -668,7 +668,7 @@ location
|
||||||
[details summary="<i>Remove the dedicated nginx config</i>" class="helper-card-subtitle text-muted"]
|
[details summary="<i>Remove the dedicated nginx config</i>" class="helper-card-subtitle text-muted"]
|
||||||
|
|
||||||
**Usage**: `ynh_config_remove_nginx`
|
**Usage**: `ynh_config_remove_nginx`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/nginx#L37)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/nginx#L37)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_config_change_url_nginx
|
#### ynh_config_change_url_nginx
|
||||||
|
@ -676,7 +676,7 @@ location
|
||||||
[details summary="<i>Regen the nginx config in a change url context</i>" class="helper-card-subtitle text-muted"]
|
[details summary="<i>Regen the nginx config in a change url context</i>" class="helper-card-subtitle text-muted"]
|
||||||
|
|
||||||
**Usage**: `ynh_config_change_url_nginx`
|
**Usage**: `ynh_config_change_url_nginx`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/nginx#L46)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/nginx#L46)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -732,7 +732,7 @@ Check PHP-FPM's manual for more info on what these are (: ...
|
||||||
- `$php_max_spare_servers`
|
- `$php_max_spare_servers`
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/php#L50)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/php#L50)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_config_remove_phpfpm
|
#### ynh_config_remove_phpfpm
|
||||||
|
@ -740,7 +740,7 @@ Check PHP-FPM's manual for more info on what these are (: ...
|
||||||
[details summary="<i>Remove the dedicated PHP-FPM config</i>" class="helper-card-subtitle text-muted"]
|
[details summary="<i>Remove the dedicated PHP-FPM config</i>" class="helper-card-subtitle text-muted"]
|
||||||
|
|
||||||
**Usage**: `ynh_config_remove_phpfpm`
|
**Usage**: `ynh_config_remove_phpfpm`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/php#L126)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/php#L126)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -765,7 +765,7 @@ See the documentation of `ynh_config_add` for a description of the template
|
||||||
format and how placeholders are replaced with actual variables.
|
format and how placeholders are replaced with actual variables.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/systemd#L13)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/systemd#L13)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_config_remove_systemd
|
#### ynh_config_remove_systemd
|
||||||
|
@ -776,7 +776,7 @@ format and how placeholders are replaced with actual variables.
|
||||||
|
|
||||||
**Arguments**:
|
**Arguments**:
|
||||||
- `service`: Service name (optionnal, $app by default)
|
- `service`: Service name (optionnal, $app by default)
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/systemd#L33)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/systemd#L33)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_systemctl
|
#### ynh_systemctl
|
||||||
|
@ -792,7 +792,7 @@ format and how placeholders are replaced with actual variables.
|
||||||
- `--log_path=`: Log file - Path to the log file. Default : `/var/log/$app/$app.log`
|
- `--log_path=`: Log file - Path to the log file. Default : `/var/log/$app/$app.log`
|
||||||
- `--timeout=`: Timeout - The maximum time to wait before ending the watching. Default : 60 seconds.
|
- `--timeout=`: Timeout - The maximum time to wait before ending the watching. Default : 60 seconds.
|
||||||
- `--length=`: Length of the error log displayed for debugging : Default : 20
|
- `--length=`: Length of the error log displayed for debugging : Default : 20
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/systemd#L52)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/systemd#L52)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -856,7 +856,7 @@ fail2ban-regex /var/log/YOUR_LOG_FILE_PATH /etc/fail2ban/filter.d/YOUR_APP.conf
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/fail2ban#L52)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/fail2ban#L52)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_config_remove_fail2ban
|
#### ynh_config_remove_fail2ban
|
||||||
|
@ -864,7 +864,7 @@ fail2ban-regex /var/log/YOUR_LOG_FILE_PATH /etc/fail2ban/filter.d/YOUR_APP.conf
|
||||||
[details summary="<i>Remove the dedicated fail2ban config (jail and filter conf files)</i>" class="helper-card-subtitle text-muted"]
|
[details summary="<i>Remove the dedicated fail2ban config (jail and filter conf files)</i>" class="helper-card-subtitle text-muted"]
|
||||||
|
|
||||||
**Usage**: `ynh_config_remove_fail2ban`
|
**Usage**: `ynh_config_remove_fail2ban`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/fail2ban#L114)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/fail2ban#L114)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -885,15 +885,15 @@ The configuration is autogenerated by YunoHost
|
||||||
(ie it doesnt come from a specific app template like nginx or systemd conf)
|
(ie it doesnt come from a specific app template like nginx or systemd conf)
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/logrotate#L13)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/logrotate#L13)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_config_remove_logrotate
|
#### ynh_config_remove_logrotate
|
||||||
|
|
||||||
[details summary="<i>Remove the app's logrotate config.</i>" class="helper-card-subtitle text-muted"]
|
[details summary="<i>Remove the app's logrotate config.</i>" class="helper-card-subtitle text-muted"]
|
||||||
|
|
||||||
**Usage**: `ynh_remove_logrotate`
|
**Usage**: ``
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/logrotate#L71)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/logrotate#L71)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -917,7 +917,7 @@ The configuration is autogenerated by YunoHost
|
||||||
Note that the $PATH variable is preserved (using --preserve-env=PATH)
|
Note that the $PATH variable is preserved (using --preserve-env=PATH)
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/utils#L60)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/utils#L60)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_local_curl
|
#### ynh_local_curl
|
||||||
|
@ -940,7 +940,7 @@ For multiple calls, cookies are persisted between each call for the same app
|
||||||
`$domain` and `$path` should be defined externally (and correspond to the domain.tld and the /path (of the app?))
|
`$domain` and `$path` should be defined externally (and correspond to the domain.tld and the /path (of the app?))
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/utils#L77)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/utils#L77)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_safe_rm
|
#### ynh_safe_rm
|
||||||
|
@ -948,7 +948,7 @@ For multiple calls, cookies are persisted between each call for the same app
|
||||||
[details summary="<i>Remove a file or a directory, checking beforehand that it's not a disastrous location to rm such as entire /var or /home</i>" class="helper-card-subtitle text-muted"]
|
[details summary="<i>Remove a file or a directory, checking beforehand that it's not a disastrous location to rm such as entire /var or /home</i>" class="helper-card-subtitle text-muted"]
|
||||||
|
|
||||||
**Usage**: `ynh_safe_rm path_to_remove`
|
**Usage**: `ynh_safe_rm path_to_remove`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/utils#L145)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/utils#L145)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_read_manifest
|
#### ynh_read_manifest
|
||||||
|
@ -961,7 +961,7 @@ For multiple calls, cookies are persisted between each call for the same app
|
||||||
- `key`: Name of the key to find
|
- `key`: Name of the key to find
|
||||||
|
|
||||||
**Returns**: the value associate to that key
|
**Returns**: the value associate to that key
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/utils#L171)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/utils#L171)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_app_upstream_version
|
#### ynh_app_upstream_version
|
||||||
|
@ -976,7 +976,7 @@ For multiple calls, cookies are persisted between each call for the same app
|
||||||
For example, if the manifest contains `4.3-2~ynh3` the function will return `4.3-2`
|
For example, if the manifest contains `4.3-2~ynh3` the function will return `4.3-2`
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/utils#L181)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/utils#L181)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_app_upstream_version_changed
|
#### ynh_app_upstream_version_changed
|
||||||
|
@ -984,7 +984,7 @@ For example, if the manifest contains `4.3-2~ynh3` the function will return `4.3
|
||||||
[details summary="<i>Return 0 if the "upstream" part of the version changed, or 1 otherwise (ie only the ~ynh suffix changed)</i>" class="helper-card-subtitle text-muted"]
|
[details summary="<i>Return 0 if the "upstream" part of the version changed, or 1 otherwise (ie only the ~ynh suffix changed)</i>" class="helper-card-subtitle text-muted"]
|
||||||
|
|
||||||
**Usage**: `if ynh_app_upstream_version_changed; then ...`
|
**Usage**: `if ynh_app_upstream_version_changed; then ...`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/utils#L188)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/utils#L188)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_app_upgrading_from_version_before
|
#### ynh_app_upgrading_from_version_before
|
||||||
|
@ -994,7 +994,7 @@ For example, if the manifest contains `4.3-2~ynh3` the function will return `4.3
|
||||||
**Usage**: ``
|
**Usage**: ``
|
||||||
|
|
||||||
**Example**: `if ynh_app_upgrading_from_version_before 2.3.2~ynh1; then ...`
|
**Example**: `if ynh_app_upgrading_from_version_before 2.3.2~ynh1; then ...`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/utils#L196)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/utils#L196)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_app_upgrading_from_version_before_or_equal_to
|
#### ynh_app_upgrading_from_version_before_or_equal_to
|
||||||
|
@ -1004,7 +1004,7 @@ For example, if the manifest contains `4.3-2~ynh3` the function will return `4.3
|
||||||
**Usage**: ``
|
**Usage**: ``
|
||||||
|
|
||||||
**Example**: `if ynh_app_upgrading_from_version_before_or_equal_to 2.3.2~ynh1; then ...`
|
**Example**: `if ynh_app_upgrading_from_version_before_or_equal_to 2.3.2~ynh1; then ...`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/utils#L206)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/utils#L206)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_validate_ip
|
#### ynh_validate_ip
|
||||||
|
@ -1016,7 +1016,7 @@ For example, if the manifest contains `4.3-2~ynh3` the function will return `4.3
|
||||||
**Returns**: 0 for valid ip addresses, 1 otherwise
|
**Returns**: 0 for valid ip addresses, 1 otherwise
|
||||||
|
|
||||||
**Example**: `ynh_validate_ip 4 111.222.333.444`
|
**Example**: `ynh_validate_ip 4 111.222.333.444`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/utils#L284)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/utils#L284)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_in_ci_tests
|
#### ynh_in_ci_tests
|
||||||
|
@ -1029,7 +1029,7 @@ For example, if the manifest contains `4.3-2~ynh3` the function will return `4.3
|
||||||
Return 0 if in CI, 1 otherwise
|
Return 0 if in CI, 1 otherwise
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/utils#L348)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/utils#L348)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_user_get_info
|
#### ynh_user_get_info
|
||||||
|
@ -1045,7 +1045,7 @@ Return 0 if in CI, 1 otherwise
|
||||||
**Returns**: the value associate to that key
|
**Returns**: the value associate to that key
|
||||||
|
|
||||||
**Example**: `mail=$(ynh_user_get_info --username="toto" --key=mail)`
|
**Example**: `mail=$(ynh_user_get_info --username="toto" --key=mail)`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/utils#L360)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/utils#L360)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_user_list
|
#### ynh_user_list
|
||||||
|
@ -1057,7 +1057,7 @@ Return 0 if in CI, 1 otherwise
|
||||||
**Returns**: one username per line as strings
|
**Returns**: one username per line as strings
|
||||||
|
|
||||||
**Example**: `for u in $(ynh_user_list); do ... ; done`
|
**Example**: `for u in $(ynh_user_list); do ... ; done`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/utils#L377)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/utils#L377)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_spawn_app_shell
|
#### ynh_spawn_app_shell
|
||||||
|
@ -1083,7 +1083,7 @@ from the app's service configuration file (defaults to $app.service, overridable
|
||||||
If the app relies on a specific PHP version, then `php` will be aliased that version. The PHP command will also be appended with the `phpflags` settings.
|
If the app relies on a specific PHP version, then `php` will be aliased that version. The PHP command will also be appended with the `phpflags` settings.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/utils#L392)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/utils#L392)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -1100,7 +1100,7 @@ If the app relies on a specific PHP version, then `php` will be aliased that ver
|
||||||
**Arguments**:
|
**Arguments**:
|
||||||
- `--app=`: the application id (global $app by default)
|
- `--app=`: the application id (global $app by default)
|
||||||
- `--key=`: the setting to get
|
- `--key=`: the setting to get
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/setting#L8)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/setting#L8)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_app_setting_set
|
#### ynh_app_setting_set
|
||||||
|
@ -1113,7 +1113,7 @@ If the app relies on a specific PHP version, then `php` will be aliased that ver
|
||||||
- `--app=`: the application id (global $app by default)
|
- `--app=`: the application id (global $app by default)
|
||||||
- `--key=`: the setting name to set
|
- `--key=`: the setting name to set
|
||||||
- `--value=`: the setting value to set
|
- `--value=`: the setting value to set
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/setting#L27)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/setting#L27)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_app_setting_set_default
|
#### ynh_app_setting_set_default
|
||||||
|
@ -1139,7 +1139,7 @@ then
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/setting#L57)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/setting#L57)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_app_setting_delete
|
#### ynh_app_setting_delete
|
||||||
|
@ -1151,7 +1151,7 @@ fi
|
||||||
**Arguments**:
|
**Arguments**:
|
||||||
- `--app=`: the application id (global $app by default)
|
- `--app=`: the application id (global $app by default)
|
||||||
- `--key=`: the setting to delete
|
- `--key=`: the setting to delete
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/setting#L79)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/setting#L79)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -1172,7 +1172,7 @@ fi
|
||||||
**Returns**: the generated string
|
**Returns**: the generated string
|
||||||
|
|
||||||
**Example**: `pwd=$(ynh_string_random --length=8)`
|
**Example**: `pwd=$(ynh_string_random --length=8)`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/string#L11)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/string#L11)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_replace
|
#### ynh_replace
|
||||||
|
@ -1191,7 +1191,7 @@ As this helper is based on sed command, regular expressions and references to
|
||||||
sub-expressions can be used (see sed manual page for more information)
|
sub-expressions can be used (see sed manual page for more information)
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/string#L35)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/string#L35)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_replace_regex
|
#### ynh_replace_regex
|
||||||
|
@ -1210,7 +1210,7 @@ This helper will use ynh_replace, but as you can use special
|
||||||
characters, you can't use some regular expressions and sub-expressions.
|
characters, you can't use some regular expressions and sub-expressions.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/string#L63)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/string#L63)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_normalize_url_path
|
#### ynh_normalize_url_path
|
||||||
|
@ -1247,7 +1247,7 @@ Handle the slash at the beginning of path and its absence at ending
|
||||||
Return a normalized url path
|
Return a normalized url path
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/string#L118)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/string#L118)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -1278,7 +1278,7 @@ upgrade fails and the script is removed prior to restoring the backup, the
|
||||||
data/logs are not destroyed.
|
data/logs are not destroyed.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/backup#L24)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/backup#L24)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_restore
|
#### ynh_restore
|
||||||
|
@ -1305,7 +1305,7 @@ otheriwse, search for a match in the csv (eg: conf/nginx.conf) and restore it in
|
||||||
`/etc/nginx/conf.d/$domain.d/$app.conf`
|
`/etc/nginx/conf.d/$domain.d/$app.conf`
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/backup#L131)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/backup#L131)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_restore_everything
|
#### ynh_restore_everything
|
||||||
|
@ -1313,7 +1313,7 @@ otheriwse, search for a match in the csv (eg: conf/nginx.conf) and restore it in
|
||||||
[details summary="<i>Restore all files that were previously backuped in an app backup script</i>" class="helper-card-subtitle text-muted"]
|
[details summary="<i>Restore all files that were previously backuped in an app backup script</i>" class="helper-card-subtitle text-muted"]
|
||||||
|
|
||||||
**Usage**: `ynh_restore_everything`
|
**Usage**: `ynh_restore_everything`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/backup#L189)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/backup#L189)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_store_file_checksum
|
#### ynh_store_file_checksum
|
||||||
|
@ -1321,7 +1321,7 @@ otheriwse, search for a match in the csv (eg: conf/nginx.conf) and restore it in
|
||||||
[details summary="<i>Calculate and store a file checksum into the app settings</i>" class="helper-card-subtitle text-muted"]
|
[details summary="<i>Calculate and store a file checksum into the app settings</i>" class="helper-card-subtitle text-muted"]
|
||||||
|
|
||||||
**Usage**: `ynh_store_file_checksum /path/to/file`
|
**Usage**: `ynh_store_file_checksum /path/to/file`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/backup#L211)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/backup#L211)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_backup_if_checksum_is_different
|
#### ynh_backup_if_checksum_is_different
|
||||||
|
@ -1335,7 +1335,7 @@ This helper is primarily meant to allow to easily backup personalised/manually
|
||||||
modified config files.
|
modified config files.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/backup#L242)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/backup#L242)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_delete_file_checksum
|
#### ynh_delete_file_checksum
|
||||||
|
@ -1343,7 +1343,7 @@ modified config files.
|
||||||
[details summary="<i>Delete a file checksum from the app settings</i>" class="helper-card-subtitle text-muted"]
|
[details summary="<i>Delete a file checksum from the app settings</i>" class="helper-card-subtitle text-muted"]
|
||||||
|
|
||||||
**Usage**: `ynh_delete_file_checksum /path/to/file`
|
**Usage**: `ynh_delete_file_checksum /path/to/file`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/backup#L273)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/backup#L273)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -1356,7 +1356,7 @@ modified config files.
|
||||||
[details summary="<i>Print a message to stderr and terminate the current script</i>" class="helper-card-subtitle text-muted"]
|
[details summary="<i>Print a message to stderr and terminate the current script</i>" class="helper-card-subtitle text-muted"]
|
||||||
|
|
||||||
**Usage**: `ynh_die "Some message"`
|
**Usage**: `ynh_die "Some message"`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/logging#L6)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/logging#L6)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_print_info
|
#### ynh_print_info
|
||||||
|
@ -1364,7 +1364,7 @@ modified config files.
|
||||||
[details summary="<i>Print an "INFO" message</i>" class="helper-card-subtitle text-muted"]
|
[details summary="<i>Print an "INFO" message</i>" class="helper-card-subtitle text-muted"]
|
||||||
|
|
||||||
**Usage**: `ynh_print_info "Some message"`
|
**Usage**: `ynh_print_info "Some message"`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/logging#L22)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/logging#L22)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_print_warn
|
#### ynh_print_warn
|
||||||
|
@ -1372,7 +1372,7 @@ modified config files.
|
||||||
[details summary="<i>Print a warning on stderr</i>" class="helper-card-subtitle text-muted"]
|
[details summary="<i>Print a warning on stderr</i>" class="helper-card-subtitle text-muted"]
|
||||||
|
|
||||||
**Usage**: `ynh_print_warn "Some message"`
|
**Usage**: `ynh_print_warn "Some message"`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/logging#L29)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/logging#L29)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_hide_warnings
|
#### ynh_hide_warnings
|
||||||
|
@ -1383,7 +1383,7 @@ modified config files.
|
||||||
|
|
||||||
**Arguments**:
|
**Arguments**:
|
||||||
- `command`: command to execute
|
- `command`: command to execute
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/logging#L38)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/logging#L38)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_exec_and_print_stderr_only_if_error
|
#### ynh_exec_and_print_stderr_only_if_error
|
||||||
|
@ -1399,7 +1399,7 @@ modified config files.
|
||||||
Note that you should NOT quote the command but only prefix it with ynh_exec_and_print_stderr_only_if_error
|
Note that you should NOT quote the command but only prefix it with ynh_exec_and_print_stderr_only_if_error
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/logging#L49)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/logging#L49)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_return
|
#### ynh_return
|
||||||
|
@ -1408,7 +1408,7 @@ Note that you should NOT quote the command but only prefix it with ynh_exec_and_
|
||||||
(to be used by special hooks like app config panel and core diagnosis)</i>" class="helper-card-subtitle text-muted"]
|
(to be used by special hooks like app config panel and core diagnosis)</i>" class="helper-card-subtitle text-muted"]
|
||||||
|
|
||||||
**Usage**: `ynh_return somedata`
|
**Usage**: `ynh_return somedata`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/logging#L65)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/logging#L65)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_script_progression
|
#### ynh_script_progression
|
||||||
|
@ -1416,7 +1416,7 @@ Note that you should NOT quote the command but only prefix it with ynh_exec_and_
|
||||||
[details summary="<i>Print a progress bar showing the progression of an app script</i>" class="helper-card-subtitle text-muted"]
|
[details summary="<i>Print a progress bar showing the progression of an app script</i>" class="helper-card-subtitle text-muted"]
|
||||||
|
|
||||||
**Usage**: `ynh_script_progression "Some message"`
|
**Usage**: `ynh_script_progression "Some message"`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/logging#L83)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/logging#L83)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -1429,7 +1429,7 @@ Note that you should NOT quote the command but only prefix it with ynh_exec_and_
|
||||||
[details summary="<i>Initialize the multimedia directory system</i>" class="helper-card-subtitle text-muted"]
|
[details summary="<i>Initialize the multimedia directory system</i>" class="helper-card-subtitle text-muted"]
|
||||||
|
|
||||||
**Usage**: `ynh_multimedia_build_main_dir`
|
**Usage**: `ynh_multimedia_build_main_dir`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/multimedia#L9)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/multimedia#L9)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_multimedia_addfolder
|
#### ynh_multimedia_addfolder
|
||||||
|
@ -1446,7 +1446,7 @@ Note that you should NOT quote the command but only prefix it with ynh_exec_and_
|
||||||
This "directory" will be a symbolic link to a existing directory.
|
This "directory" will be a symbolic link to a existing directory.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/multimedia#L60)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/multimedia#L60)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_multimedia_addaccess
|
#### ynh_multimedia_addaccess
|
||||||
|
@ -1457,7 +1457,7 @@ This "directory" will be a symbolic link to a existing directory.
|
||||||
|
|
||||||
**Arguments**:
|
**Arguments**:
|
||||||
- `user_name`: The name of the user which gain this access.
|
- `user_name`: The name of the user which gain this access.
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/multimedia#L86)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/multimedia#L86)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -1481,7 +1481,7 @@ This "directory" will be a symbolic link to a existing directory.
|
||||||
- `--permission=`: the name for the permission (by default a permission named "main" is removed automatically when the app is removed)
|
- `--permission=`: the name for the permission (by default a permission named "main" is removed automatically when the app is removed)
|
||||||
|
|
||||||
**Example**: `ynh_permission_delete --permission=editors`
|
**Example**: `ynh_permission_delete --permission=editors`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/permission#L149)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/permission#L149)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_permission_exists
|
#### ynh_permission_exists
|
||||||
|
@ -1493,7 +1493,7 @@ This "directory" will be a symbolic link to a existing directory.
|
||||||
|
|
||||||
**Arguments**:
|
**Arguments**:
|
||||||
- `--permission=`: the permission to check
|
- `--permission=`: the permission to check
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/permission#L164)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/permission#L164)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_permission_url
|
#### ynh_permission_url
|
||||||
|
@ -1510,7 +1510,7 @@ This "directory" will be a symbolic link to a existing directory.
|
||||||
- `--remove_url=`: (optional) List of additional url to remove for which access will be allowed/forbidden
|
- `--remove_url=`: (optional) List of additional url to remove for which access will be allowed/forbidden
|
||||||
- `--auth_header=`: (optional) Define for the URL of this permission, if SSOwat pass the authentication header to the application
|
- `--auth_header=`: (optional) Define for the URL of this permission, if SSOwat pass the authentication header to the application
|
||||||
- `--clear_urls`: (optional) Clean all urls (url and additional_urls)
|
- `--clear_urls`: (optional) Clean all urls (url and additional_urls)
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/permission#L185)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/permission#L185)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_permission_update
|
#### ynh_permission_update
|
||||||
|
@ -1523,7 +1523,7 @@ This "directory" will be a symbolic link to a existing directory.
|
||||||
- `--permission=`: the name for the permission (by default a permission named "main" already exist)
|
- `--permission=`: the name for the permission (by default a permission named "main" already exist)
|
||||||
- `--add=`: the list of group or users to enable add to the permission
|
- `--add=`: the list of group or users to enable add to the permission
|
||||||
- `--remove=`: the list of group or users to remove from the permission
|
- `--remove=`: the list of group or users to remove from the permission
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/permission#L248)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/permission#L248)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_permission_has_user
|
#### ynh_permission_has_user
|
||||||
|
@ -1538,7 +1538,7 @@ This "directory" will be a symbolic link to a existing directory.
|
||||||
- `--user=`: the user seek in the permission
|
- `--user=`: the user seek in the permission
|
||||||
|
|
||||||
**Example**: `ynh_permission_has_user --permission=main --user=visitors`
|
**Example**: `ynh_permission_has_user --permission=main --user=visitors`
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/permission#L289)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/permission#L289)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -1560,7 +1560,7 @@ This "directory" will be a symbolic link to a existing directory.
|
||||||
example : ynh_install_app_dependencies dep1 dep2 "dep3|dep4|dep5"
|
example : ynh_install_app_dependencies dep1 dep2 "dep3|dep4|dep5"
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/apt#L13)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/apt#L13)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_apt_remove_dependencies
|
#### ynh_apt_remove_dependencies
|
||||||
|
@ -1573,7 +1573,7 @@ example : ynh_install_app_dependencies dep1 dep2 "dep3|dep4|dep5"
|
||||||
Dependencies will removed only if no other package need them.
|
Dependencies will removed only if no other package need them.
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/apt#L160)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/apt#L160)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_apt_install_dependencies_from_extra_repository
|
#### ynh_apt_install_dependencies_from_extra_repository
|
||||||
|
@ -1586,7 +1586,7 @@ Dependencies will removed only if no other package need them.
|
||||||
- `--repo=`: Complete url of the extra repository.
|
- `--repo=`: Complete url of the extra repository.
|
||||||
- `--package=`: The packages to install from this extra repository
|
- `--package=`: The packages to install from this extra repository
|
||||||
- `--key=`: url to get the public key.
|
- `--key=`: url to get the public key.
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/apt#L192)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/apt#L192)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -1604,7 +1604,7 @@ Dependencies will removed only if no other package need them.
|
||||||
- `--username=`: the username to check
|
- `--username=`: the username to check
|
||||||
|
|
||||||
**Returns**: 0 if the user exists, 1 otherwise.
|
**Returns**: 0 if the user exists, 1 otherwise.
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/systemuser#L8)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/systemuser#L8)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_system_group_exists
|
#### ynh_system_group_exists
|
||||||
|
@ -1617,7 +1617,7 @@ Dependencies will removed only if no other package need them.
|
||||||
- `--group=`: the group to check
|
- `--group=`: the group to check
|
||||||
|
|
||||||
**Returns**: 0 if the group exists, 1 otherwise.
|
**Returns**: 0 if the group exists, 1 otherwise.
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/systemuser#L23)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/systemuser#L23)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_system_user_create
|
#### ynh_system_user_create
|
||||||
|
@ -1643,7 +1643,7 @@ ynh_system_user_create --username=discourse --home_dir=/var/www/discourse --use_
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/systemuser#L49)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/systemuser#L49)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
#### ynh_system_user_delete
|
#### ynh_system_user_delete
|
||||||
|
@ -1654,7 +1654,7 @@ ynh_system_user_create --username=discourse --home_dir=/var/www/discourse --use_
|
||||||
|
|
||||||
**Arguments**:
|
**Arguments**:
|
||||||
- `--username=`: Name of the system user that will be create
|
- `--username=`: Name of the system user that will be create
|
||||||
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/771a4b34469c39a6516afea37e807b799f5c90b8/helpers/helpers.v2.1.d/systemuser#L87)
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/22201863a18e6c79c0401454fdb3805ee7435403/helpers/helpers.v2.1.d/systemuser#L87)
|
||||||
[/details]
|
[/details]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
Loading…
Reference in a new issue