diff --git a/packaging_apps_helpers.md b/packaging_apps_helpers.md index 71cb32f7..476d7822 100644 --- a/packaging_apps_helpers.md +++ b/packaging_apps_helpers.md @@ -2,6 +2,7 @@
Doc auto-generated by this script on 03/30/2020 (Yunohost version 3.7.0.12)
- Dude, show me the code ! + Dude, show me the code !
@@ -1428,14 +1429,13 @@ ynh_exec_fully_quiet "your_command | other_command"
- Usage: ynh_script_progression --message=message [--weight=weight] [--time]
-The execution time is given for the duration since the previous call. So the weight should be applied to this previous call.
+ Usage: ynh_script_progression --message=message [--weight=weight] [--time]
-t
, --time=
: Print the execution time since the last call to this helper. Especially usefull to define weights.-t
, --time=
: Print the execution time since the last call to this helper. Especially usefull to define weights. The execution time is given for the duration since the previous call. So the weight should be applied to this previous call.- Dude, show me the code ! + Dude, show me the code !
@@ -1610,7 +1610,7 @@ ynh_debug_exec "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -1706,7 +1706,7 @@ ynh_debug_exec "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -3392,7 +3392,7 @@ Please always call this script in install and restore scripts- Dude, show me the code ! + Dude, show me the code !
@@ -3451,7 +3451,267 @@ Please always call this script in install and restore scripts- Dude, show me the code ! + Dude, show me the code ! +
+ + + + + + + + +
+
+ Usage: ynh_permission_create --permission "permission" [--url "url"] [--allowed group1 group2]
+
+
+ Arguments: +
permission
: the name for the permission (by default a permission named "main" already exist)url
: (optional) URL for which access will be allowed/forbiddenallowed
: (optional) A list of group/user to allow for the permission
+ Example: ynh_permission_create --permission admin --url /admin --allowed alice bob
+
+ Details: +
+ If provided, 'url' is assumed to be relative to the app domain/path if theystart with '/'. For example: / -> domain.tld/app /admin -> domain.tld/app/admin domain.tld/app/api -> domain.tld/app/api'url' can be later treated as a regex if it starts with "re:".For example: re:/api/[A-Z]*$ -> domain.tld/app/api/[A-Z]*$ re:domain.tld/app/api/[A-Z]*$ -> domain.tld/app/api/[A-Z]*$Requires YunoHost version 3.7.0 or higher. +
+ + + + +
+
+ Usage: ynh_permission_delete --permission "permission"
+
+
+ Arguments: +
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
+
+ Details: +
+ Requires YunoHost version 3.7.0 or higher. +
+ + + + +
+
+ Usage: ynh_permission_exists --permission=permission
+
+
+ Arguments: +
-p
, --permission
: the permission to check+ Details: +
+ Requires YunoHost version 3.7.0 or higher. +
+ + + + +
+
+ Usage: ynh_permission_url --permission "permission" --url "url"
+
+
+ Arguments: +
permission
: the name for the permission (by default a permission named "main" is removed automatically when the app is removed)url
: (optional) URL for which access will be allowed/forbidden+ Details: +
+ Requires YunoHost version 3.7.0 or higher. +
+ + + + +
+
+ Usage: ynh_permission_update --permission "permission" --add "group" ["group" ...] --remove "group" ["group" ...]
+
+
+ Arguments: +
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 permissionremove
: the list of group or users to remove from the permission
+ Example: ynh_permission_update --permission admin --add samdoe --remove all_users Requires YunoHost version 3.7.0 or higher.
+
- Dude, show me the code ! + Dude, show me the code !
@@ -4524,7 +4784,7 @@ Please always call this script in install and restore scripts- Dude, show me the code ! + Dude, show me the code !
@@ -4564,7 +4824,7 @@ Please always call this script in install and restore scripts- Dude, show me the code ! + Dude, show me the code !
@@ -4611,7 +4871,7 @@ Please always call this script in install and restore scripts- Dude, show me the code ! + Dude, show me the code !
@@ -4655,7 +4915,7 @@ Please always call this script in install and restore scripts- Dude, show me the code ! + Dude, show me the code !
@@ -4706,7 +4966,7 @@ Please always call this script in install and restore scripts- Dude, show me the code ! + Dude, show me the code !
@@ -4753,7 +5013,7 @@ Please always call this script in install and restore scripts- Dude, show me the code ! + Dude, show me the code !
@@ -4800,7 +5060,7 @@ Please always call this script in install and restore scripts- Dude, show me the code ! + Dude, show me the code !
@@ -4836,7 +5096,7 @@ Please always call this script in install and restore scripts- Dude, show me the code ! + Dude, show me the code !
@@ -4847,9 +5107,6 @@ Please always call this script in install and restore scripts -Generated by this script on 07/11/2019 (Yunohost version 3.6.4.3)
- -