Doc auto-generated by this script on 12/31/2020 (YunoHost version 4.1.2)
+Doc auto-generated by this script on 01/08/2021 (Yunohost version 4.1.4)
@@ -51,7 +51,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -106,7 +106,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -142,7 +142,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -189,7 +189,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -236,7 +236,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -283,7 +283,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -330,7 +330,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -377,7 +377,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -428,7 +428,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -464,7 +464,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -523,7 +523,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -591,7 +591,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -627,7 +627,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -703,7 +703,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -750,7 +750,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -801,7 +801,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -848,7 +848,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -888,7 +888,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -928,7 +928,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -1002,7 +1002,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -1038,7 +1038,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -1111,7 +1111,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -1175,7 +1175,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -1231,7 +1231,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -1278,7 +1278,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -1325,7 +1325,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -1372,7 +1372,7 @@- Dude, show me the code ! + Dude, show me the code !
@@ -1420,7 +1420,7 @@ ynh_exec_err "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -1468,7 +1468,7 @@ ynh_exec_warn "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -1516,7 +1516,7 @@ ynh_exec_warn_less "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -1564,7 +1564,7 @@ ynh_exec_quiet "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -1612,7 +1612,7 @@ ynh_exec_fully_quiet "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -1648,7 +1648,7 @@ ynh_exec_fully_quiet "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -1684,7 +1684,7 @@ ynh_exec_fully_quiet "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -1743,7 +1743,7 @@ ynh_exec_fully_quiet "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -1757,7 +1757,7 @@ ynh_exec_fully_quiet "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -1939,7 +1939,7 @@ ynh_debug_exec "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -1975,7 +1975,7 @@ ynh_debug_exec "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -2039,7 +2039,7 @@ ynh_debug_exec "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -2090,7 +2090,7 @@ ynh_debug_exec "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -2141,7 +2141,7 @@ ynh_debug_exec "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -2196,7 +2196,7 @@ ynh_debug_exec "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -2244,7 +2244,7 @@ ynh_debug_exec "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -2299,7 +2299,7 @@ ynh_debug_exec "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -2350,7 +2350,7 @@ ynh_debug_exec "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -2410,7 +2410,7 @@ ynh_debug_exec "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -2462,7 +2462,7 @@ ynh_debug_exec "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -2517,7 +2517,7 @@ ynh_debug_exec "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -2572,7 +2572,7 @@ ynh_debug_exec "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -2624,7 +2624,7 @@ ynh_debug_exec "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -2660,7 +2660,7 @@ ynh_debug_exec "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -2701,7 +2701,7 @@ ynh_debug_exec "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -2748,7 +2748,7 @@ ynh_debug_exec "your_command | other_command"- Dude, show me the code ! + Dude, show me the code !
@@ -2784,7 +2784,457 @@ ynh_debug_exec "your_command | other_command"- Dude, show me the code ! + Dude, show me the code ! +
+ + + + + + + + + +
+
+ Usage: ynh_permission_create --permission="permission" [--url="url"] [--additional_urls="second-url" [ "third-url" ]] [--auth_header=true|false]
+ [--allowed=group1 [ group2 ]] [--label="label"] [--show_tile=true|false]
+ [--protected=true|false]
+| Not that if 'show_tile' is enabled, this URL will be the URL of the tile.
+| Default is "APP_LABEL (permission name)".
+| Default is false (for the permission different than 'main').
+| won't be able to add or remove the visitors group of this permission.
+| By default it's 'false'
+
+
+ Arguments: +
-p, : - the name for the permission (by default a permission named "main" already exist)-u, : - (optional) URL for which access will be allowed/forbidden.-A, : - (optional) List of additional URL for which access will be allowed/forbidden-h, : - (optional) Define for the URL of this permission, if SSOwat pass the authentication header to the application. Default is true-a, : - (optional) A list of group/user to allow for the permission-l, : - (optional) Define a name for the permission. This label will be shown on the SSO and in the admin.-t, : - (optional) Define if a tile will be shown in the SSO. If yes the name of the tile will be the 'label' parameter.-P, : - (optional) Define if this permission is protected. If it is protected the administrator+ Details: +
+ example 1: ynh_permission_create --permission=admin --url=/admin --additional_urls=domain.tld/admin /superadmin --allowed=alice bob \ --label="My app admin" --show_tile=trueThis example will create a new permission permission with this following effect:- A tile named "My app admin" in the SSO will be available for the users alice and bob. This tile will point to the relative url '/admin'.- Only the user alice and bob will have the access to theses following url: /admin, domain.tld/admin, /superadminexample 2: ynh_permission_create --permission=api --url=domain.tld/api --auth_header=false --allowed=visitors \ --label="MyApp API" --protected=trueThis example will create a new protected permission. So the admin won't be able to add/remove the visitors group of this permission.In case of an API with need to be always public it avoid that the admin break anything.With this permission all client will be allowed to access to the url 'domain.tld/api'.Note that in this case no tile will be show on the SSO.Note that the auth_header parameter is to 'false'. So no authentication header will be passed to the application.Generally the API is requested by an application and enabling the auth_header has no advantage and could bring some issues in some case.So in this case it's better to disable this option for all API.If provided, 'url' or 'additional_urls' 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' or 'additional_urls' can be treated as a PCRE (not lua) 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]*$Note that globally the parameter 'url' and 'additional_urls' are same. The only difference is:- 'url' is only one url, 'additional_urls' can be a list of urls. There are no limitation of 'additional_urls'- 'url' is used for the url of tile in the SSO (if enabled with the 'show_tile' parameter)About the authentication header (auth_header parameter).The SSO pass (by default) to the application theses following HTTP header (linked to the authenticated user) to the application: - "Auth-User": username - "Remote-User": username - "Email": user emailGenerally this feature is usefull to authenticate automatically the user in the application but in some case the application don't work with theses header and theses header need to be disabled to have the application to work correctly.See https://github.com/YunoHost/issues/issues/1420 for more informationsRequires YunoHost version 3.7.0 or higher. +
+ + + + +
+
+ Usage: ynh_permission_delete --permission="permission"
+
+
+ Arguments: +
-p, --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
+| exit: Return 1 if the permission doesn't exist, 0 otherwise
+
+
+ Arguments: +
-p, --permission= : the permission to check+ Details: +
+ Requires YunoHost version 3.7.0 or higher. +
+ + + + +
+
+ Usage: ynh_permission_url --permission "permission" [--url="url"] [--add_url="new-url" [ "other-new-url" ]] [--remove_url="old-url" [ "other-old-url" ]]
+ [--auth_header=true|false] [--clear_urls]
+| Note that if you want to remove url you can pass an empty sting as arguments ("").
+
+
+ Arguments: +
-p, : - the name for the permission (by default a permission named "main" is removed automatically when the app is removed)-u, : - (optional) URL for which access will be allowed/forbidden.-a, : - (optional) List of additional url to add for which access will be allowed/forbidden.-r, : - (optional) List of additional url to remove for which access will be allowed/forbidden-h, : - (optional) Define for the URL of this permission, if SSOwat pass the authentication header to the application-c, : - (optional) Clean all urls (url and additional_urls)+ Details: +
+ Requires YunoHost version 3.7.0 or higher. +
+ + + + +
+
+ Usage: ynh_permission_update --permission "permission" [--add="group" ["group" ...]] [--remove="group" ["group" ...]]
+ [--label="label"] [--show_tile=true|false] [--protected=true|false]
+| won't be able to add or remove the visitors group of this permission.
+
+
+ Arguments: +
-p, : - the name for the permission (by default a permission named "main" already exist)-a, : - the list of group or users to enable add to the permission-r, : - the list of group or users to remove from the permission-l, : - (optional) Define a name for the permission. This label will be shown on the SSO and in the admin.-t, : - (optional) Define if a tile will be shown in the SSO-P, : - (optional) Define if this permission is protected. If it is protected the administrator+ Details: +
+ Requires YunoHost version 3.7.0 or higher. +
+ + + + +
+
+ Usage: ynh_permission_has_user --permission=permission --user=user
+| exit: Return 1 if the permission doesn't have that user or doesn't exist, 0 otherwise
+
+
+ Arguments: +
-p, --permission= : the permission to check-u, --user= : the user seek in the permission
+ Example: ynh_permission_has_user --permission=main --user=visitors
+
+ Details: +
+ Requires YunoHost version 3.7.1 or higher. +
+ + + + +
+
+ Usage: ynh_legacy_permissions_exists
+| exit: Return 1 if the permission doesn't exist, 0 otherwise
+
+
+ Details: +
+ Requires YunoHost version 4.1.2 or higher. +
+ + + + +
+
+ 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.
+
- Dude, show me the code ! + Dude, show me the code !
@@ -3038,7 +3488,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP- Dude, show me the code ! + Dude, show me the code !
@@ -3089,7 +3539,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP- Dude, show me the code ! + Dude, show me the code !
@@ -3144,7 +3594,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP- Dude, show me the code ! + Dude, show me the code !
@@ -3192,7 +3642,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP- Dude, show me the code ! + Dude, show me the code !
@@ -3240,7 +3690,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP- Dude, show me the code ! + Dude, show me the code !
@@ -3295,7 +3745,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP- Dude, show me the code ! + Dude, show me the code !
@@ -3346,7 +3796,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP- Dude, show me the code ! + Dude, show me the code !
@@ -3384,7 +3834,7 @@ Please always call this script in install and restore scripts- Dude, show me the code ! + Dude, show me the code !
@@ -3440,7 +3890,7 @@ Please always call this script in install and restore scripts- Dude, show me the code ! + Dude, show me the code !
@@ -3495,7 +3945,7 @@ Please always call this script in install and restore scripts- Dude, show me the code ! + Dude, show me the code !
@@ -3546,7 +3996,7 @@ Please always call this script in install and restore scripts- Dude, show me the code ! + Dude, show me the code !
@@ -3601,7 +4051,7 @@ Please always call this script in install and restore scripts- Dude, show me the code ! + Dude, show me the code !
@@ -3660,382 +4110,7 @@ Please always call this script in install and restore scripts - - - - - - - - -
-
- Usage: ynh_permission_create --permission="permission" [--url="url"] [--additional_urls="second-url" [ "third-url" ]] [--auth_header=true|false]
- [--allowed=group1 [ group2 ]] [--label="label"] [--show_tile=true|false]
- [--protected=true|false]
-| Not that if 'show_tile' is enabled, this URL will be the URL of the tile.
-| Default is "APP_LABEL (permission name)".
-| Default is false (for the permission different than 'main').
-| won't be able to add or remove the visitors group of this permission.
-| By default it's 'false'
-
-
- Arguments: -
-p, : - the name for the permission (by default a permission named "main" already exist)-u, : - (optional) URL for which access will be allowed/forbidden.-A, : - (optional) List of additional URL for which access will be allowed/forbidden-h, : - (optional) Define for the URL of this permission, if SSOwat pass the authentication header to the application. Default is true-a, : - (optional) A list of group/user to allow for the permission-l, : - (optional) Define a name for the permission. This label will be shown on the SSO and in the admin.-t, : - (optional) Define if a tile will be shown in the SSO. If yes the name of the tile will be the 'label' parameter.-P, : - (optional) Define if this permission is protected. If it is protected the administrator- Details: -
- example 1: ynh_permission_create --permission=admin --url=/admin --additional_urls=domain.tld/admin /superadmin --allowed=alice bob \ --label="My app admin" --show_tile=trueThis example will create a new permission permission with this following effect:- A tile named "My app admin" in the SSO will be available for the users alice and bob. This tile will point to the relative url '/admin'.- Only the user alice and bob will have the access to theses following url: /admin, domain.tld/admin, /superadminexample 2: ynh_permission_create --permission=api --url=domain.tld/api --auth_header=false --allowed=visitors \ --label="MyApp API" --protected=trueThis example will create a new protected permission. So the admin won't be able to add/remove the visitors group of this permission.In case of an API with need to be always public it avoid that the admin break anything.With this permission all client will be allowed to access to the url 'domain.tld/api'.Note that in this case no tile will be show on the SSO.Note that the auth_header parameter is to 'false'. So no authentication header will be passed to the application.Generally the API is requested by an application and enabling the auth_header has no advantage and could bring some issues in some case.So in this case it's better to disable this option for all API.If provided, 'url' or 'additional_urls' 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' or 'additional_urls' can be treated as a PCRE (not lua) 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]*$Note that globally the parameter 'url' and 'additional_urls' are same. The only difference is:- 'url' is only one url, 'additional_urls' can be a list of urls. There are no limitation of 'additional_urls'- 'url' is used for the url of tile in the SSO (if enabled with the 'show_tile' parameter)About the authentication header (auth_header parameter).The SSO pass (by default) to the application theses following HTTP header (linked to the authenticated user) to the application: - "Auth-User": username - "Remote-User": username - "Email": user emailGenerally this feature is usefull to authenticate automatically the user in the application but in some case the application don't work with theses header and theses header need to be disabled to have the application to work correctly.See https://github.com/YunoHost/issues/issues/1420 for more informationsRequires YunoHost version 3.7.0 or higher. -
- - - - -
-
- Usage: ynh_permission_delete --permission="permission"
-
-
- Arguments: -
-p, --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
-| exit: Return 1 if the permission doesn't exist, 0 otherwise
-
-
- Arguments: -
-p, --permission= : the permission to check- Details: -
- Requires YunoHost version 3.7.0 or higher. -
- - - - -
-
- Usage: ynh_permission_url --permission "permission" [--url="url"] [--add_url="new-url" [ "other-new-url" ]] [--remove_url="old-url" [ "other-old-url" ]]
- [--auth_header=true|false] [--clear_urls]
-| Note that if you want to remove url you can pass an empty sting as arguments ("").
-
-
- Arguments: -
-p, : - the name for the permission (by default a permission named "main" is removed automatically when the app is removed)-u, : - (optional) URL for which access will be allowed/forbidden.-a, : - (optional) List of additional url to add for which access will be allowed/forbidden.-r, : - (optional) List of additional url to remove for which access will be allowed/forbidden-h, : - (optional) Define for the URL of this permission, if SSOwat pass the authentication header to the application-c, : - (optional) Clean all urls (url and additional_urls)- Details: -
- Requires YunoHost version 3.7.0 or higher. -
- - - - -
-
- Usage: ynh_permission_update --permission "permission" [--add="group" ["group" ...]] [--remove="group" ["group" ...]]
- [--label="label"] [--show_tile=true|false] [--protected=true|false]
-| won't be able to add or remove the visitors group of this permission.
-
-
- Arguments: -
-p, : - the name for the permission (by default a permission named "main" already exist)-a, : - the list of group or users to enable add to the permission-r, : - the list of group or users to remove from the permission-l, : - (optional) Define a name for the permission. This label will be shown on the SSO and in the admin.-t, : - (optional) Define if a tile will be shown in the SSO-P, : - (optional) Define if this permission is protected. If it is protected the administrator- Details: -
- Requires YunoHost version 3.7.0 or higher. -
- - - - -
-
- Usage: ynh_permission_has_user --permission=permission --user=user
-| exit: Return 1 if the permission doesn't have that user or doesn't exist, 0 otherwise
-
-
- Arguments: -
-p, --permission= : the permission to check-u, --user= : the user seek in the permission
- Example: ynh_permission_has_user --permission=main --user=visitors
-
- Details: -
- Requires YunoHost version 3.7.1 or higher. -
- - -- Dude, show me the code ! + Dude, show me the code !
@@ -4261,7 +4336,7 @@ Please always call this script in install and restore scripts- Dude, show me the code ! + Dude, show me the code !
@@ -4322,7 +4397,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="- Dude, show me the code ! + Dude, show me the code !
@@ -4369,7 +4444,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="- Dude, show me the code ! + Dude, show me the code !
@@ -4436,7 +4511,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="- Dude, show me the code ! + Dude, show me the code !
@@ -4473,7 +4548,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="- Dude, show me the code ! + Dude, show me the code !
@@ -4530,7 +4605,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="- Dude, show me the code ! + Dude, show me the code !
@@ -4589,7 +4664,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="- Dude, show me the code ! + Dude, show me the code !
@@ -4633,7 +4708,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="- Dude, show me the code ! + Dude, show me the code !
@@ -4681,7 +4756,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="- Dude, show me the code ! + Dude, show me the code !
@@ -4729,7 +4804,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="- Dude, show me the code ! + Dude, show me the code !
@@ -4810,7 +4885,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="- Dude, show me the code ! + Dude, show me the code !
@@ -4857,7 +4932,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="- Dude, show me the code ! + Dude, show me the code !
@@ -4898,7 +4973,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="- Dude, show me the code ! + Dude, show me the code !
@@ -4949,7 +5024,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="- Dude, show me the code ! + Dude, show me the code !
@@ -5012,7 +5087,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="- Dude, show me the code ! + Dude, show me the code !
@@ -5084,7 +5159,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="- Dude, show me the code ! + Dude, show me the code !
@@ -5124,7 +5199,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="- Dude, show me the code ! + Dude, show me the code !
@@ -5171,7 +5246,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="- Dude, show me the code ! + Dude, show me the code !
@@ -5226,7 +5301,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="- Dude, show me the code ! + Dude, show me the code !
@@ -5277,7 +5352,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="- Dude, show me the code ! + Dude, show me the code !
@@ -5328,7 +5403,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="- Dude, show me the code ! + Dude, show me the code !
@@ -5364,7 +5439,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var=" @@ -5421,7 +5496,7 @@ This is really useful when we need to do some actions only for some old package