Merge pull request #2210 from YunoHost/debian/11.1.6.1

[CI] Update app helpers/resources for debian/11.1.6.1
This commit is contained in:
Alexandre Aubin 2023-02-09 14:29:54 +01:00 committed by GitHub
commit 65b8cb36f5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 203 additions and 214 deletions

View file

@ -7,7 +7,7 @@ routes:
default: '/packaging_apps_helpers'
---
Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/doc/generate_helper_doc.py) on 02/01/2023 (YunoHost version 11.1.5)
Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/doc/generate_helper_doc.py) on 02/08/2023 (YunoHost version 11.1.6.1)
## APPS
@ -25,7 +25,7 @@ Requires YunoHost version *.*.* or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/apps#L9)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/apps#L9)
[/details]
----------------
@ -41,7 +41,7 @@ Requires YunoHost version *.*.* or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/apps#L65)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/apps#L65)
[/details]
----------------
@ -65,7 +65,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/apt#L53)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/apt#L53)
[/details]
----------------
@ -86,7 +86,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/apt#L75)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/apt#L75)
[/details]
----------------
@ -100,7 +100,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/apt#L107)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/apt#L107)
[/details]
----------------
@ -117,7 +117,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/apt#L117)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/apt#L117)
[/details]
----------------
@ -134,7 +134,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/apt#L128)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/apt#L128)
[/details]
----------------
@ -151,7 +151,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/apt#L138)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/apt#L138)
[/details]
----------------
@ -168,7 +168,7 @@ Requires YunoHost version 2.7.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/apt#L148)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/apt#L148)
[/details]
----------------
@ -190,7 +190,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/apt#L225)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/apt#L225)
[/details]
----------------
@ -207,7 +207,7 @@ Requires YunoHost version 3.8.1 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/apt#L335)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/apt#L335)
[/details]
----------------
@ -223,7 +223,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/apt#L354)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/apt#L354)
[/details]
----------------
@ -243,7 +243,7 @@ Requires YunoHost version 3.8.1 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/apt#L382)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/apt#L382)
[/details]
----------------
@ -316,7 +316,7 @@ Requires YunoHost version 3.5.0 or higher for the argument `--not_mandatory`
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/backup#L64)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/backup#L64)
[/details]
----------------
@ -330,7 +330,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/backup#L179)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/backup#L179)
[/details]
----------------
@ -375,7 +375,7 @@ Requires YunoHost version 3.5.0 or higher for the argument --not_mandatory
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/backup#L238)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/backup#L238)
[/details]
----------------
@ -394,7 +394,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/backup#L306)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/backup#L306)
[/details]
----------------
@ -416,7 +416,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/backup#L350)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/backup#L350)
[/details]
----------------
@ -435,7 +435,7 @@ Requires YunoHost version 3.3.1 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/backup#L381)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/backup#L381)
[/details]
----------------
@ -458,7 +458,7 @@ Requires YunoHost version 2.7.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/backup#L416)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/backup#L416)
[/details]
----------------
@ -481,7 +481,7 @@ Requires YunoHost version 2.7.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/backup#L464)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/backup#L464)
[/details]
----------------
@ -558,7 +558,7 @@ Requires YunoHost version 4.1.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/fail2ban#L64)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/fail2ban#L64)
[/details]
----------------
@ -572,7 +572,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/fail2ban#L119)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/fail2ban#L119)
[/details]
----------------
@ -600,7 +600,7 @@ Requires YunoHost version 3.8.1 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/hardware#L13)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/hardware#L13)
[/details]
----------------
@ -623,7 +623,7 @@ Requires YunoHost version 3.8.1 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/hardware#L75)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/hardware#L75)
[/details]
----------------
@ -644,7 +644,7 @@ Requires YunoHost version 2.4.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/logging#L10)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/logging#L10)
[/details]
----------------
@ -661,7 +661,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/logging#L30)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/logging#L30)
[/details]
----------------
@ -678,7 +678,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/logging#L56)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/logging#L56)
[/details]
----------------
@ -695,7 +695,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/logging#L73)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/logging#L73)
[/details]
----------------
@ -714,7 +714,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/logging#L92)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/logging#L92)
[/details]
----------------
@ -733,7 +733,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/logging#L113)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/logging#L113)
[/details]
----------------
@ -752,7 +752,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/logging#L134)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/logging#L134)
[/details]
----------------
@ -771,7 +771,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/logging#L155)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/logging#L155)
[/details]
----------------
@ -790,7 +790,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/logging#L176)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/logging#L176)
[/details]
----------------
@ -810,7 +810,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/logging#L237)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/logging#L237)
[/details]
----------------
@ -825,7 +825,7 @@ Requires YunoHost version 3.6.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/logging#L325)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/logging#L325)
[/details]
----------------
@ -854,7 +854,7 @@ Requires YunoHost version 3.2.0 or higher for the argument `--specific_user`
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/logrotate#L18)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/logrotate#L18)
[/details]
----------------
@ -868,7 +868,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/logrotate#L109)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/logrotate#L109)
[/details]
----------------
@ -885,7 +885,7 @@ Requires YunoHost version 4.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/multimedia#L11)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/multimedia#L11)
[/details]
----------------
@ -905,7 +905,7 @@ Requires YunoHost version 4.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/multimedia#L64)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/multimedia#L64)
[/details]
----------------
@ -922,7 +922,7 @@ Requires YunoHost version 4.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/multimedia#L93)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/multimedia#L93)
[/details]
----------------
@ -955,7 +955,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/mysql#L15)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/mysql#L15)
[/details]
----------------
@ -973,7 +973,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/mysql#L36)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/mysql#L36)
[/details]
----------------
@ -991,7 +991,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/mysql#L60)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/mysql#L60)
[/details]
----------------
@ -1012,7 +1012,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/mysql#L128)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/mysql#L128)
[/details]
----------------
@ -1031,7 +1031,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/mysql#L160)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/mysql#L160)
[/details]
----------------
@ -1053,7 +1053,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/mysql#L198)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/mysql#L198)
[/details]
----------------
@ -1071,7 +1071,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/mysql#L224)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/mysql#L224)
[/details]
----------------
@ -1095,7 +1095,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/network#L12)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/network#L12)
[/details]
----------------
@ -1116,7 +1116,7 @@ Requires YunoHost version 3.8.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/network#L36)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/network#L36)
[/details]
----------------
@ -1137,7 +1137,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/network#L99)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/network#L99)
[/details]
----------------
@ -1158,7 +1158,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/network#L119)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/network#L119)
[/details]
----------------
@ -1186,7 +1186,7 @@ Requires YunoHost version 4.1.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/nginx#L19)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/nginx#L19)
[/details]
----------------
@ -1200,7 +1200,7 @@ Requires YunoHost version 2.7.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/nginx#L41)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/nginx#L41)
[/details]
----------------
@ -1254,7 +1254,7 @@ Requires YunoHost version 2.7.12 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/nodejs#L74)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/nodejs#L74)
[/details]
----------------
@ -1278,7 +1278,7 @@ Requires YunoHost version 2.7.12 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/nodejs#L114)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/nodejs#L114)
[/details]
----------------
@ -1296,7 +1296,7 @@ Requires YunoHost version 2.7.12 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/nodejs#L191)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/nodejs#L191)
[/details]
----------------
@ -1369,7 +1369,7 @@ Requires YunoHost version 3.7.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/permission#L66)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/permission#L66)
[/details]
----------------
@ -1388,7 +1388,7 @@ Requires YunoHost version 3.7.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/permission#L152)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/permission#L152)
[/details]
----------------
@ -1406,7 +1406,7 @@ Requires YunoHost version 3.7.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/permission#L169)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/permission#L169)
[/details]
----------------
@ -1429,7 +1429,7 @@ Requires YunoHost version 3.7.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/permission#L192)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/permission#L192)
[/details]
----------------
@ -1452,7 +1452,7 @@ Requires YunoHost version 3.7.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/permission#L260)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/permission#L260)
[/details]
----------------
@ -1473,7 +1473,7 @@ Requires YunoHost version 3.7.1 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/permission#L329)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/permission#L329)
[/details]
----------------
@ -1488,7 +1488,7 @@ Requires YunoHost version 4.1.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/permission#L359)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/permission#L359)
[/details]
----------------
@ -1499,7 +1499,7 @@ 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/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/permission#L379)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/permission#L379)
[/details]
----------------
@ -1557,7 +1557,7 @@ Requires YunoHost version 4.1.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/php#L59)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/php#L59)
[/details]
----------------
@ -1571,7 +1571,7 @@ Requires YunoHost version 2.7.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/php#L250)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/php#L250)
[/details]
----------------
@ -1590,18 +1590,18 @@ Requires YunoHost version 4.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/php#L483)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/php#L483)
[/details]
----------------
#### ynh_install_composer
[details summary="<i>Install and initialize Composer in the given directory</i>" class="helper-card-subtitle text-muted"]
**Usage**: `ynh_install_composer [--phpversion=phpversion] [--workdir=$final_path] [--install_args="--optimize-autoloader"] [--composerversion=composerversion]`
**Usage**: `ynh_install_composer [--phpversion=phpversion] [--workdir=$install_dir] [--install_args="--optimize-autoloader"] [--composerversion=composerversion]`
**Arguments**:
- `-v`, `--phpversion`: PHP version to use with composer
- `-w`, `--workdir`: The directory from where the command will be executed. Default $final_path.
- `-w`, `--workdir`: The directory from where the command will be executed. Default $install_dir.
- `-a`, `--install_args`: Additional arguments provided to the composer install. Argument --no-dev already include
- `-c`, `--composerversion`: Composer version to install
@ -1610,7 +1610,7 @@ Requires YunoHost version 4.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/php#L509)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/php#L509)
[/details]
----------------
@ -1643,7 +1643,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/postgresql#L18)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/postgresql#L18)
[/details]
----------------
@ -1661,7 +1661,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/postgresql#L39)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/postgresql#L39)
[/details]
----------------
@ -1679,7 +1679,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/postgresql#L64)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/postgresql#L64)
[/details]
----------------
@ -1700,7 +1700,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/postgresql#L135)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/postgresql#L135)
[/details]
----------------
@ -1718,7 +1718,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/postgresql#L168)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/postgresql#L168)
[/details]
----------------
@ -1736,7 +1736,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/postgresql#L190)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/postgresql#L190)
[/details]
----------------
@ -1758,7 +1758,7 @@ Requires YunoHost version 2.7.13 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/postgresql#L234)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/postgresql#L234)
[/details]
----------------
@ -1776,7 +1776,7 @@ Requires YunoHost version 2.7.13 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/postgresql#L265)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/postgresql#L265)
[/details]
----------------
@ -1797,7 +1797,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/setting#L10)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/setting#L10)
[/details]
----------------
@ -1816,7 +1816,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/setting#L36)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/setting#L36)
[/details]
----------------
@ -1834,7 +1834,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/setting#L62)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/setting#L62)
[/details]
----------------
@ -1854,7 +1854,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/setting#L123)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/setting#L123)
[/details]
----------------
@ -1875,7 +1875,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/setting#L145)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/setting#L145)
[/details]
----------------
@ -1900,7 +1900,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/string#L13)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/string#L13)
[/details]
----------------
@ -1922,7 +1922,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/string#L40)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/string#L40)
[/details]
----------------
@ -1944,7 +1944,7 @@ Requires YunoHost version 2.7.7 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/string#L71)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/string#L71)
[/details]
----------------
@ -1967,7 +1967,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/string#L103)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/string#L103)
[/details]
----------------
@ -1993,7 +1993,7 @@ Requires YunoHost version 4.1.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/systemd#L15)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/systemd#L15)
[/details]
----------------
@ -2010,7 +2010,7 @@ Requires YunoHost version 2.7.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/systemd#L38)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/systemd#L38)
[/details]
----------------
@ -2032,7 +2032,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/systemd#L67)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/systemd#L67)
[/details]
----------------
@ -2056,7 +2056,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/user#L12)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/user#L12)
[/details]
----------------
@ -2078,7 +2078,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/user#L33)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/user#L33)
[/details]
----------------
@ -2096,7 +2096,7 @@ Requires YunoHost version 2.4.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/user#L53)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/user#L53)
[/details]
----------------
@ -2115,7 +2115,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/user#L64)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/user#L64)
[/details]
----------------
@ -2134,7 +2134,7 @@ Requires YunoHost version 3.5.0.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/user#L82)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/user#L82)
[/details]
----------------
@ -2163,7 +2163,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/user#L111)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/user#L111)
[/details]
----------------
@ -2180,7 +2180,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/user#L153)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/user#L153)
[/details]
----------------
@ -2194,7 +2194,7 @@ Requires YunoHost version 4.1.7 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/user#L179)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/user#L179)
[/details]
----------------
@ -2215,7 +2215,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/utils#L58)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/utils#L58)
[/details]
----------------
@ -2267,7 +2267,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/utils#L111)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/utils#L111)
[/details]
----------------
@ -2293,7 +2293,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/utils#L285)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/utils#L285)
[/details]
----------------
@ -2330,7 +2330,7 @@ that should be defined before calling this helper :
__NAMETOCHANGE__ by $app
__USER__ by $app
__FINALPATH__ by $final_path
__PHPVERSION__ by $YNH_PHP_VERSION
__PHPVERSION__ by $YNH_PHP_VERSION (packaging v1 only, packaging v2 uses phpversion setting implicitly set by apt resource)
__YNH_NODE_LOAD_PATH__ by $ynh_node_load_PATH
```
And any dynamic variables that should be defined before calling this helper like:
@ -2351,7 +2351,7 @@ Requires YunoHost version 4.1.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/utils#L369)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/utils#L369)
[/details]
----------------
@ -2395,7 +2395,7 @@ Requires YunoHost version 4.3 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/utils#L522)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/utils#L523)
[/details]
----------------
@ -2414,7 +2414,7 @@ Requires YunoHost version 4.3 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/utils#L599)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/utils#L600)
[/details]
----------------
@ -2430,7 +2430,7 @@ Requires YunoHost version 2.7.12 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/utils#L711)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/utils#L715)
[/details]
----------------
@ -2447,7 +2447,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/utils#L742)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/utils#L746)
[/details]
----------------
@ -2467,7 +2467,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/utils#L776)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/utils#L780)
[/details]
----------------
@ -2492,7 +2492,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/utils#L819)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/utils#L823)
[/details]
----------------
@ -2515,7 +2515,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/utils#L848)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/utils#L852)
[/details]
----------------
@ -2538,7 +2538,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/utils#L873)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/utils#L877)
[/details]
----------------
@ -2570,7 +2570,7 @@ Requires YunoHost version 3.8.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/c2c0a66cdf43abccf83fc2bdea66f04eecd5c44e/helpers/utils#L903)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/dd6d083904763b69153ebf464b1ea2881375834a/helpers/utils#L907)
[/details]
----------------

View file

@ -7,64 +7,36 @@ routes:
default: '/packaging_apps_resources'
---
## System User
Provision a system user to be used by the app. The username is exactly equal to the app id
## Apt
Create a virtual package in apt, depending on the list of specified packages that the app needs. The virtual packages is called `$app-ynh-deps` (with `_` being replaced by `-` in the app name, see `ynh_install_app_dependencies`)
##### Example:
```toml
[resources.system_user]
# (empty - defaults are usually okay)
[resources.apt]
packages = "nyancat, lolcat, sl"
# (this part is optional and corresponds to the legacy ynh_install_extra_app_dependencies helper)
extras.yarn.repo = "deb https://dl.yarnpkg.com/debian/ stable main"
extras.yarn.key = "https://dl.yarnpkg.com/debian/pubkey.gpg"
extras.yarn.packages = "yarn"
```
##### Properties:
- `allow_ssh`: (default: False) Adds the user to the ssh.app group, allowing SSH connection via this user
- `allow_sftp`: (defalt: False) Adds the user to the sftp.app group, allowing SFTP connection via this user
- `packages`: Comma-separated list of packages to be installed via `apt`
- `extras`: A dict of (repo, key, packages) corresponding to "extra" repositories to fetch dependencies from
##### Provision/Update:
- will create the system user if it doesn't exists yet
- will add/remove the ssh/sftp.app groups
- The code literally calls the bash helpers `ynh_install_app_dependencies` and `ynh_install_extra_app_dependencies`, similar to what happens in v1.
- Note that when `packages` contains some phpX.Y-foobar dependencies, this will automagically define a `phpversion` setting equal to `X.Y` which can therefore be used in app scripts ($phpversion) or templates (`__PHPVERSION__`)
##### Deprovision:
- deletes the user and group
## Install Dir
Creates a directory to be used by the app as the installation directory, typically where the app sources and assets are located. The corresponding path is stored in the settings as `install_dir`
##### Example:
```toml
[resources.install_dir]
# (empty - defaults are usually okay)
```
##### Properties:
- `dir`: (default: `/var/www/__APP__`) The full path of the install dir
- `owner`: (default: `__APP__:rx`) The owner (and owner permissions) for the install dir
- `group`: (default: `__APP__:rx`) The group (and group permissions) for the install dir
##### Provision/Update:
- during install, the folder will be deleted if it already exists (FIXME: is this what we want?)
- if the dir path changed and a folder exists at the old location, the folder will be `mv`'ed to the new location
- otherwise, creates the directory if it doesn't exists yet
- (re-)apply permissions (only on the folder itself, not recursively)
- save the value of `dir` as `install_dir` in the app's settings, which can be then used by the app scripts (`$install_dir`) and conf templates (`__INSTALL_DIR__`)
##### Deprovision:
- recursively deletes the directory if it exists
##### Legacy management:
- In the past, the setting was called `final_path`. The code will automatically rename it as `install_dir`.
- As explained in the 'Provision/Update' section, the folder will also be moved if the location changed
- The code literally calls the bash helper `ynh_remove_app_dependencies`
## Data Dir
Creates a directory to be used by the app as the data store directory, typically where the app multimedia or large assets added by users are located. The corresponding path is stored in the settings as `data_dir`. This resource behaves very similarly to install_dir.
##### Example:
@ -92,74 +64,66 @@ Creates a directory to be used by the app as the data store directory, typically
- In the past, the setting may have been called `datadir`. The code will automatically rename it as `data_dir`.
- As explained in the 'Provision/Update' section, the folder will also be moved if the location changed
## Database
Initialize a database, either using MySQL or Postgresql. Relevant DB infos are stored in settings `$db_name`, `$db_user` and `$db_pwd`.
## Apt
NB: only one DB can be handled in such a way (is there really an app that would need two completely different DB ?...)
Create a virtual package in apt, depending on the list of specified packages that the app needs. The virtual packages is called `$app-ynh-deps` (with `_` being replaced by `-` in the app name, see `ynh_install_app_dependencies`)
NB2: no automagic migration will happen in an suddenly change `type` from `mysql` to `postgresql` or viceversa in its life
##### Example:
```toml
[resources.apt]
packages = "nyancat, lolcat, sl"
# (this part is optional and corresponds to the legacy ynh_install_extra_app_dependencies helper)
extras.yarn.repo = "deb https://dl.yarnpkg.com/debian/ stable main"
extras.yarn.key = "https://dl.yarnpkg.com/debian/pubkey.gpg"
extras.yarn.packages = "yarn"
[resources.database]
type = "mysql" # or : "postgresql". Only these two values are supported
```
##### Properties:
- `packages`: Comma-separated list of packages to be installed via `apt`
- `extras`: A dict of (repo, key, packages) corresponding to "extra" repositories to fetch dependencies from
- `type`: The database type, either `mysql` or `postgresql`
##### Provision/Update:
- The code literally calls the bash helpers `ynh_install_app_dependencies` and `ynh_install_extra_app_dependencies`, similar to what happens in v1.
- (Re)set the `$db_name` and `$db_user` settings with the sanitized app name (replacing `-` and `.` with `_`)
- If `$db_pwd` doesn't already exists, pick a random database password and store it in that setting
- If the database doesn't exists yet, create the SQL user and DB using `ynh_mysql_create_db` or `ynh_psql_create_db`.
##### Deprovision:
- The code literally calls the bash helper `ynh_remove_app_dependencies`
- Drop the DB using `ynh_mysql_remove_db` or `ynh_psql_remove_db`
- Deletes the `db_name`, `db_user` and `db_pwd` settings
##### Legacy management:
- In the past, the sql passwords may have been named `mysqlpwd` or `psqlpwd`, in which case it will automatically be renamed as `db_pwd`
## Ports
## Install Dir
Book port(s) to be used by the app, typically to be used to the internal reverse-proxy between nginx and the app process.
Note that because multiple ports can be booked, each properties is prefixed by the name of the port. `main` is a special name and will correspond to the setting `$port`, whereas for example `xmpp_client` will correspond to the setting `$port_xmpp_client`.
Creates a directory to be used by the app as the installation directory, typically where the app sources and assets are located. The corresponding path is stored in the settings as `install_dir`
##### Example:
```toml
[resources.port]
# (empty should be fine for most apps ... though you can customize stuff if absolutely needed)
main.default = 12345 # if you really want to specify a prefered value .. but shouldnt matter in the majority of cases
xmpp_client.default = 5222 # if you need another port, pick a name for it (here, "xmpp_client")
xmpp_client.exposed = "TCP" # here, we're telling that the port needs to be publicly exposed on TCP on the firewall
[resources.install_dir]
# (empty - defaults are usually okay)
```
##### Properties (for every port name):
- `default`: The prefered value for the port. If this port is already being used by another process right now, or is booked in another app's setting, the code will increment the value until it finds a free port and store that value as the setting. If no value is specified, a random value between 10000 and 60000 is used.
- `exposed`: (default: `false`) Wether this port should be opened on the firewall and be publicly reachable. This should be kept to `false` for the majority of apps than only need a port for internal reverse-proxying! Possible values: `false`, `true`(=`Both`), `Both`, `TCP`, `UDP`. This will result in the port being opened on the firewall, and the diagnosis checking that a program answers on that port.
- `fixed`: (default: `false`) Tells that the app absolutely needs the specific value provided in `default`, typically because it's needed for a specific protocol
##### Properties:
- `dir`: (default: `/var/www/__APP__`) The full path of the install dir
- `owner`: (default: `__APP__:rx`) The owner (and owner permissions) for the install dir
- `group`: (default: `__APP__:rx`) The group (and group permissions) for the install dir
##### Provision/Update (for every port name):
- If not already booked, look for a free port, starting with the `default` value (or a random value between 10000 and 60000 if no `default` set)
- If `exposed` is not `false`, open the port in the firewall accordingly - otherwise make sure it's closed.
- The value of the port is stored in the `$port` setting for the `main` port, or `$port_NAME` for other `NAME`s
##### Provision/Update:
- during install, the folder will be deleted if it already exists (FIXME: is this what we want?)
- if the dir path changed and a folder exists at the old location, the folder will be `mv`'ed to the new location
- otherwise, creates the directory if it doesn't exists yet
- (re-)apply permissions (only on the folder itself, not recursively)
- save the value of `dir` as `install_dir` in the app's settings, which can be then used by the app scripts (`$install_dir`) and conf templates (`__INSTALL_DIR__`)
##### Deprovision:
- Close the ports on the firewall if relevant
- Deletes all the port settings
- recursively deletes the directory if it exists
##### Legacy management:
- In the past, some settings may have been named `NAME_port` instead of `port_NAME`, in which case the code will automatically rename the old setting.
- In the past, the setting was called `final_path`. The code will automatically rename it as `install_dir`.
- As explained in the 'Provision/Update' section, the folder will also be moved if the location changed
## Permissions
Configure the SSO permissions/tiles. Typically, webapps are expected to have a 'main' permission mapped to '/', meaning that a tile pointing to the `$domain/$path` will be available in the SSO for users allowed to access that app.
Additional permissions can be created, typically to have a specific tile and/or access rules for the admin part of a webapp.
@ -195,33 +159,58 @@ admin.allowed = "admins" # Assuming the "admins" group exists (cf future devel
##### Legacy management:
- Legacy `is_public` setting will be deleted if it exists
## Ports
## Database
Book port(s) to be used by the app, typically to be used to the internal reverse-proxy between nginx and the app process.
Initialize a database, either using MySQL or Postgresql. Relevant DB infos are stored in settings `$db_name`, `$db_user` and `$db_pwd`.
NB: only one DB can be handled in such a way (is there really an app that would need two completely different DB ?...)
NB2: no automagic migration will happen in an suddenly change `type` from `mysql` to `postgresql` or viceversa in its life
Note that because multiple ports can be booked, each properties is prefixed by the name of the port. `main` is a special name and will correspond to the setting `$port`, whereas for example `xmpp_client` will correspond to the setting `$port_xmpp_client`.
##### Example:
```toml
[resources.database]
type = "mysql" # or : "postgresql". Only these two values are supported
[resources.ports]
# (empty should be fine for most apps... though you can customize stuff if absolutely needed)
main.default = 12345 # if you really want to specify a prefered value .. but shouldnt matter in the majority of cases
xmpp_client.default = 5222 # if you need another port, pick a name for it (here, "xmpp_client")
xmpp_client.exposed = "TCP" # here, we're telling that the port needs to be publicly exposed on TCP on the firewall
```
##### Properties (for every port name):
- `default`: The prefered value for the port. If this port is already being used by another process right now, or is booked in another app's setting, the code will increment the value until it finds a free port and store that value as the setting. If no value is specified, a random value between 10000 and 60000 is used.
- `exposed`: (default: `false`) Wether this port should be opened on the firewall and be publicly reachable. This should be kept to `false` for the majority of apps than only need a port for internal reverse-proxying! Possible values: `false`, `true`(=`Both`), `Both`, `TCP`, `UDP`. This will result in the port being opened on the firewall, and the diagnosis checking that a program answers on that port.
- `fixed`: (default: `false`) Tells that the app absolutely needs the specific value provided in `default`, typically because it's needed for a specific protocol
##### Provision/Update (for every port name):
- If not already booked, look for a free port, starting with the `default` value (or a random value between 10000 and 60000 if no `default` set)
- If `exposed` is not `false`, open the port in the firewall accordingly - otherwise make sure it's closed.
- The value of the port is stored in the `$port` setting for the `main` port, or `$port_NAME` for other `NAME`s
##### Deprovision:
- Close the ports on the firewall if relevant
- Deletes all the port settings
##### Legacy management:
- In the past, some settings may have been named `NAME_port` instead of `port_NAME`, in which case the code will automatically rename the old setting.
## System User
Provision a system user to be used by the app. The username is exactly equal to the app id
##### Example:
```toml
[resources.system_user]
# (empty - defaults are usually okay)
```
##### Properties:
- `type`: The database type, either `mysql` or `postgresql`
- `allow_ssh`: (default: False) Adds the user to the ssh.app group, allowing SSH connection via this user
- `allow_sftp`: (defalt: False) Adds the user to the sftp.app group, allowing SFTP connection via this user
##### Provision/Update:
- (Re)set the `$db_name` and `$db_user` settings with the sanitized app name (replacing `-` and `.` with `_`)
- If `$db_pwd` doesn't already exists, pick a random database password and store it in that setting
- If the database doesn't exists yet, create the SQL user and DB using `ynh_mysql_create_db` or `ynh_psql_create_db`.
- will create the system user if it doesn't exists yet
- will add/remove the ssh/sftp.app groups
##### Deprovision:
- Drop the DB using `ynh_mysql_remove_db` or `ynh_psql_remove_db`
- Deletes the `db_name`, `db_user` and `db_pwd` settings
##### Legacy management:
- In the past, the sql passwords may have been named `mysqlpwd` or `psqlpwd`, in which case it will automatically be renamed as `db_pwd`
- deletes the user and group