Update packaging_apps_helpers.md

This commit is contained in:
Kayou 2020-11-25 00:11:39 +01:00 committed by GitHub
parent c587571b7d
commit 09b982592f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -2,7 +2,7 @@
<h1>App helpers</h1> <h1>App helpers</h1>
<p>Doc auto-generated by <a href="https://github.com/YunoHost/yunohost/blob/stretch-unstable/doc/generate_helper_doc.py">this script</a> on 05/21/2020 (Yunohost version 3.8.4.3)</p> <p>Doc auto-generated by <a href="https://github.com/YunoHost/yunohost/blob/stretch-unstable/doc/generate_helper_doc.py">this script</a> on 11/04/2020 (Yunohost version 4.0.8.2)</p>
@ -377,7 +377,7 @@
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/apt#L242">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/apt#L222">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -428,7 +428,7 @@
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/apt#L319">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/apt#L295">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -464,7 +464,7 @@
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/apt#L351">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/apt#L327">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -523,7 +523,7 @@
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/apt#L365">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/apt#L341">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -2141,7 +2141,7 @@ ynh_debug_exec "your_command | other_command"</code>
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/mysql#L58">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/mysql#L63">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -2196,7 +2196,7 @@ ynh_debug_exec "your_command | other_command"</code>
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/mysql#L124">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/mysql#L135">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -2244,7 +2244,7 @@ ynh_debug_exec "your_command | other_command"</code>
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/mysql#L156">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/mysql#L167">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -2299,7 +2299,7 @@ ynh_debug_exec "your_command | other_command"</code>
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/mysql#L196">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/mysql#L207">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -2350,7 +2350,7 @@ ynh_debug_exec "your_command | other_command"</code>
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/mysql#L221">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/mysql#L232">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -2701,7 +2701,7 @@ ynh_debug_exec "your_command | other_command"</code>
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/nodejs#L67">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/nodejs#L68">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -2748,7 +2748,7 @@ ynh_debug_exec "your_command | other_command"</code>
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/nodejs#L105">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/nodejs#L106">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -2784,7 +2784,7 @@ ynh_debug_exec "your_command | other_command"</code>
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/nodejs#L183">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/nodejs#L187">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -2803,7 +2803,7 @@ ynh_debug_exec "your_command | other_command"</code>
<div class="helper-card-body"> <div class="helper-card-body">
<div data-toggle="collapse" href="#collapse-ynh_add_fpm_config" style="cursor:pointer"> <div data-toggle="collapse" href="#collapse-ynh_add_fpm_config" style="cursor:pointer">
<h5 class="helper-card-title"><tt>ynh_add_fpm_config</tt></h5> <h5 class="helper-card-title"><tt>ynh_add_fpm_config</tt></h5>
<h6 class="helper-card-subtitle text-muted">Create a dedicated php-fpm config</h6> <h6 class="helper-card-subtitle text-muted">Create a dedicated PHP-FPM config</h6>
</div> </div>
<div id="collapse-ynh_add_fpm_config" class="collapse" role="tabpanel"> <div id="collapse-ynh_add_fpm_config" class="collapse" role="tabpanel">
<hr style="margin-top:25px; margin-bottom:25px;"> <hr style="margin-top:25px; margin-bottom:25px;">
@ -2811,10 +2811,10 @@ ynh_debug_exec "your_command | other_command"</code>
<strong>Usage</strong>: <code class="helper-code helper-usage">1: ynh_add_fpm_config [--phpversion=7.X] [--use_template] [--package=packages] [--dedicated_service] <strong>Usage</strong>: <code class="helper-code helper-usage">1: ynh_add_fpm_config [--phpversion=7.X] [--use_template] [--package=packages] [--dedicated_service]
2: ynh_add_fpm_config [--phpversion=7.X] --usage=usage --footprint=footprint [--package=packages] [--dedicated_service] 2: ynh_add_fpm_config [--phpversion=7.X] --usage=usage --footprint=footprint [--package=packages] [--dedicated_service]
low - Less than 20Mb of ram by pool. low - Less than 20 MB of RAM by pool.
medium - Between 20Mb and 40Mb of ram by pool. medium - Between 20 MB and 40 MB of RAM by pool.
high - More than 40Mb of ram by pool. high - More than 40 MB of RAM by pool.
Or specify exactly the footprint, the load of the service as Mb by pool instead of having a standard value. Or specify exactly the footprint, the load of the service as MB by pool instead of having a standard value.
To have this value, use the following command and stress the service. To have this value, use the following command and stress the service.
watch -n0.5 ps -o user,cmd,%cpu,rss -u APP</code> watch -n0.5 ps -o user,cmd,%cpu,rss -u APP</code>
@ -2825,7 +2825,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP</code>
<ul> <ul>
<li><code>-v</code>, <code>--phpversion=</code> : Version of php to use.</li> <li><code>-v</code>, <code>--phpversion=</code> : Version of PHP to use.</li>
@ -2833,15 +2833,15 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP</code>
<li><code>-p</code>, <code>--package=</code> : Additionnal php packages to install</li> <li><code>-p</code>, <code>--package=</code> : Additionnal PHP packages to install</li>
<li><code>-d</code>, <code>--dedicated_service</code> : Use a dedicated php-fpm service instead of the common one.</li> <li><code>-d</code>, <code>--dedicated_service</code> : Use a dedicated PHP-FPM service instead of the common one.</li>
<li><code>-v</code>, <code>--phpversion=</code> : Version of php to use.</li> <li><code>-v</code>, <code>--phpversion=</code> : Version of PHP to use.</li>
@ -2853,11 +2853,11 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP</code>
<li><code>-p</code>, <code>--package=</code> : Additionnal php packages to install for a specific version of php</li> <li><code>-p</code>, <code>--package=</code> : Additionnal PHP packages to install for a specific version of PHP</li>
<li><code>-d</code>, <code>--dedicated_service</code> : Use a dedicated php-fpm service instead of the common one.</li> <li><code>-d</code>, <code>--dedicated_service</code> : Use a dedicated PHP-FPM service instead of the common one.</li>
</ul> </ul>
@ -2889,7 +2889,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP</code>
<div class="helper-card-body"> <div class="helper-card-body">
<div data-toggle="collapse" href="#collapse-ynh_remove_fpm_config" style="cursor:pointer"> <div data-toggle="collapse" href="#collapse-ynh_remove_fpm_config" style="cursor:pointer">
<h5 class="helper-card-title"><tt>ynh_remove_fpm_config</tt></h5> <h5 class="helper-card-title"><tt>ynh_remove_fpm_config</tt></h5>
<h6 class="helper-card-subtitle text-muted">Remove the dedicated php-fpm config</h6> <h6 class="helper-card-subtitle text-muted">Remove the dedicated PHP-FPM config</h6>
</div> </div>
<div id="collapse-ynh_remove_fpm_config" class="collapse" role="tabpanel"> <div id="collapse-ynh_remove_fpm_config" class="collapse" role="tabpanel">
<hr style="margin-top:25px; margin-bottom:25px;"> <hr style="margin-top:25px; margin-bottom:25px;">
@ -2911,7 +2911,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP</code>
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/php#L269">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/php#L275">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -3089,7 +3089,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP</code>
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/postgresql#L60">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/postgresql#L65">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -3144,7 +3144,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP</code>
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/postgresql#L127">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/postgresql#L137">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -3192,7 +3192,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP</code>
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/postgresql#L160">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/postgresql#L170">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -3240,7 +3240,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP</code>
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/postgresql#L183">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/postgresql#L193">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -3277,7 +3277,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP</code>
<li><code>-p</code>, <code>--db_pwd=</code> : Password of the database. If not given, a password will be generated</li> <li><code>-p</code>, <code>--db_pwd=</code> : Password of the database. If not provided, a password will be generated</li>
</ul> </ul>
@ -3295,7 +3295,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP</code>
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/postgresql#L222">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/postgresql#L232">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -3346,7 +3346,7 @@ watch -n0.5 ps -o user,cmd,%cpu,rss -u APP</code>
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/postgresql#L251">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/postgresql#L263">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -3384,7 +3384,7 @@ Please always call this script in install and restore scripts</h6>
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/postgresql#L283">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/postgresql#L295">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -4961,7 +4961,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/utils#L225">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/utils#L230">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -5001,7 +5001,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/utils#L287">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/utils#L292">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -5048,7 +5048,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/utils#L317">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/utils#L322">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -5103,7 +5103,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/utils#L398">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/utils#L403">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -5154,7 +5154,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/utils#L427">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/utils#L432">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -5205,7 +5205,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/utils#L452">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/utils#L457">Dude, show me the code !</a>
</p> </p>
</div> </div>
@ -5241,7 +5241,7 @@ ynh_add_systemd_config [--service=service] [--template=template] [--others_var="
</p> </p>
<p> <p>
<a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/utils#L482">Dude, show me the code !</a> <a href="https://github.com/YunoHost/yunohost/blob/stretch-stable/data/helpers.d/utils#L487">Dude, show me the code !</a>
</p> </p>
</div> </div>