YunoHost/doc
1
0
Fork 0
mirror of https://github.com/YunoHost/doc.git synced 2024-09-03 20:06:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

Merge branch 'YunoHost:master' into master

Browse source
This commit is contained in:
Leandro Noferini 2023-07-22 16:08:24 +02:00 committed by GitHub
commit 11f6f7e341
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
16 changed files with 201 additions and 184 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
pages/02.administer/10.install/install.md
View file

@ -665,7 +665,7 @@ In an internet browser, type **{% if internetcube %}`https://internetcube.local`
!!! If this doesn't work, you can [look for the the local IP address of your server](/finding_the_local_ip). The address typically looks like `192.168.x.y`, and you should therefore type `https://192.168.x.y` in your browser's address bar. !!! If this doesn't work, you can [look for the the local IP address of your server](/finding_the_local_ip). The address typically looks like `192.168.x.y`, and you should therefore type `https://192.168.x.y` in your browser's address bar.
{% else %} {% else %}
You can perform the initial configuration with the web interface by typing in the adress bar of your web browser **the public IP address of your server**. Typically, your VPS provider should have provided you with the IP of the server. You can perform the initial configuration with the web interface by typing in the address bar of your web browser **the public IP address of your server**. Typically, your VPS provider should have provided you with the IP of the server.
{% endif %} {% endif %}
! During the first visit, you will very likely encounter a security warning related to the certificate used by the server. For now, your server uses a self-signed certificate. {% if not wsl %}You will later be able to add a certificate automatically recognized by web browsers as described in the [certificate documentation](/certificate). {% endif %} For now, you should add a security exception to accept the current certificate. (Though, PLEASE, do not take the habit of blindly accepting this kind of security alert!) ! During the first visit, you will very likely encounter a security warning related to the certificate used by the server. For now, your server uses a self-signed certificate. {% if not wsl %}You will later be able to add a certificate automatically recognized by web browsers as described in the [certificate documentation](/certificate). {% endif %} For now, you should add a security exception to accept the current certificate. (Though, PLEASE, do not take the habit of blindly accepting this kind of security alert!)

2
pages/02.administer/15.admin_guide/20.users/users.md
View file

@ -13,7 +13,7 @@ routes:
Users are human being who have access to applications and other services on your server. The administrator can add and manage users through the web administration (in the User category) or through the command line (see `yunohost user --help`). After that, users obtain a personal email address (chosen by the admin), an XMPP account, and can log in the user portal to access applications they have permissions over and configure other parameters. Users are human being who have access to applications and other services on your server. The administrator can add and manage users through the web administration (in the User category) or through the command line (see `yunohost user --help`). After that, users obtain a personal email address (chosen by the admin), an XMPP account, and can log in the user portal to access applications they have permissions over and configure other parameters.
The first user created also automatically gets email aliases `root@main.domain.tld` and `admin@main.domain.tld`, such that mail sent to these adresses will end up in the first user's mailbox. The first user created also automatically gets email aliases `root@main.domain.tld` and `admin@main.domain.tld`, such that mail sent to these addresses will end up in the first user's mailbox.
! You should be careful about who you give your server access to. In terms of security, this largely increase the attack surface for someone who wants to mess with the server one way or another. ! You should be careful about who you give your server access to. In terms of security, this largely increase the attack surface for someone who wants to mess with the server one way or another.

2
pages/02.administer/15.admin_guide/25.domains/domains.md
View file

@ -10,7 +10,7 @@ shortcode-ui:
tabs: lite tabs: lite
--- ---
DNS (Domain Name System) is a system that allows computers from around the world to translate human-readable domain names (such as `yolo.com`) to machine-understandable adresses called IP addresses (such as `11.22.33.44`). For this translation (and other features) to work, you must carefully configure DNS records. DNS (Domain Name System) is a system that allows computers from around the world to translate human-readable domain names (such as `yolo.com`) to machine-understandable addresses called IP addresses (such as `11.22.33.44`). For this translation (and other features) to work, you must carefully configure DNS records.
YunoHost allows you to manage and serve several domains on the same server with the same public ip. For instance, you can host a blog and Nextcloud on a first domain `yolo.com`, and a web mail client on a second domain `swag.nohost.me`. Each domain is automatically configured to handle web services, mail services and XMPP services. YunoHost allows you to manage and serve several domains on the same server with the same public ip. For instance, you can host a blog and Nextcloud on a first domain `yolo.com`, and a web mail client on a second domain `swag.nohost.me`. Each domain is automatically configured to handle web services, mail services and XMPP services.

8
pages/02.administer/15.admin_guide/45.emails/email.md
View file

@ -29,7 +29,7 @@ Desktop and mobile clients have the advantage of copying your emails to the devi
## Configuring email aliases and auto-forwards ## Configuring email aliases and auto-forwards
Mail aliases and forwards can be configured for each users. For instance, the first user created on the server automatically has an alias `root@the.domain.tld` configured - meaning that an email sent to this adress will end in the inbox of the first user. Automatic forwards may be configured, for instance if an user doesn't want to configure an additional email account and just wants to receive emails from the server on, say, his/her gmail address. Mail aliases and forwards can be configured for each users. For instance, the first user created on the server automatically has an alias `root@the.domain.tld` configured - meaning that an email sent to this address will end in the inbox of the first user. Automatic forwards may be configured, for instance if an user doesn't want to configure an additional email account and just wants to receive emails from the server on, say, his/her gmail address.
Another feature which few people know about is the use of suffixes beginning with "+". For example, emails sent to `johndoe+booking@the.domain.tld` will automatically land in the `booking` dir (lowercase) of John Doe's mailbox or in John Doe's inbox if `booking` directory doesn't exist . It is a practical technique for example to provide an e-mail address to a website, then easily sort (via automatic filters) the mail coming from this website. Another feature which few people know about is the use of suffixes beginning with "+". For example, emails sent to `johndoe+booking@the.domain.tld` will automatically land in the `booking` dir (lowercase) of John Doe's mailbox or in John Doe's inbox if `booking` directory doesn't exist . It is a practical technique for example to provide an e-mail address to a website, then easily sort (via automatic filters) the mail coming from this website.
@ -37,12 +37,12 @@ Groups also can use alias features, by default the group `admins` have `root@<do
## What happens if my server becomes unavailable? ## What happens if my server becomes unavailable?
If your server becomes unavailable, emails sent to your server will stay in a pending queue on the sender's side for as long as ~5 days. The sender's hoster will regularly try to resend the email, until it drops it if it was unable to send it. If your server becomes unavailable, emails sent to your server will stay in a pending queue on the sender's side for as long as ~5 days. The sender's host will regularly try to resend the email, until it drops it if it was unable to send it.
## Forms to remove its IP address from the blacklist ## Forms to remove its IP address from the blacklist
It is possible that the sent emails from your YunoHost instance are considered as spam by the big email services. It is possible that the emails sent from your YunoHost instance are considered as spam by the big email services.
Is it possible that the IP address from your server have been previously been used to sent spam or that these email services consider your server as a spam sender. Is it possible that the IP address from your server have been previously been used to sent spam or that these email services consider your server as a spam sender.
To ensure that your servers’ IP address isn’t into this blacklists and to remove it from them, follow this [link](/blacklist_forms). To ensure that your servers’ IP address isn't on these blacklists and to remove it from them, follow this [link](/blacklist_forms).
## Migrating email from an email provider to a YunoHost instance ## Migrating email from an email provider to a YunoHost instance

2
pages/02.administer/15.admin_guide/admin_guide.md
View file

@ -14,7 +14,7 @@ This page provide an overview of the ecosystem of a YunoHost server. While this
Everything starts with the special user **admin**. This is the administrator of the machine who can install, configure and manage things on the server through the web administration interface, or via SSH and the command line interface. *(If you are already familiar with GNU/Linux, it is quite similar to root. YunoHost has this additional 'admin' user for several technical reasons.)* Everything starts with the special user **admin**. This is the administrator of the machine who can install, configure and manage things on the server through the web administration interface, or via SSH and the command line interface. *(If you are already familiar with GNU/Linux, it is quite similar to root. YunoHost has this additional 'admin' user for several technical reasons.)*
The administrator can create users and install applications, among other admin actions. Users automatically have their own email adress as well as an XMPP account when they get created. Users will also be able to connect to the user portal (SSO) to access applications. Some applications can typically be installed either as publicly-accessible, or as private, i.e. only some users will have access to it. The administrator can create users and install applications, among other admin actions. Users automatically have their own email address as well as an XMPP account when they get created. Users will also be able to connect to the user portal (SSO) to access applications. Some applications can typically be installed either as publicly-accessible, or as private, i.e. only some users will have access to it.
Applications and their features of the server rely on different services to work properly. Services (sometimes also called daemons) are programs that are constantly running on the server to ensure various tasks are done, such as answering to web requests from web browsers, or relaying emails. Applications and their features of the server rely on different services to work properly. Services (sometimes also called daemons) are programs that are constantly running on the server to ensure various tasks are done, such as answering to web requests from web browsers, or relaying emails.

2
pages/02.administer/45.tutorials/05.domains/02.dns_dynamic_ip/dns_dynamicip.md
View file

@ -13,7 +13,7 @@ This tutorial aim to get around dynamic IP issue which is: when the IP public ad
After setting up the solution proposed in this tutorial, the redirection from your domain name to the actual IP address of your server will not be lost anymore. After setting up the solution proposed in this tutorial, the redirection from your domain name to the actual IP address of your server will not be lost anymore.
The method proposed here consists of automatizing the fact the box annonces its global IP adress change to the dynamic DNS, so that the DNS zone will automatically be updated. The method proposed here consists of automatizing the fact the box announces its global IP address change to the dynamic DNS, so that the DNS zone will automatically be updated.
### Registrars ### Registrars

2
pages/02.administer/45.tutorials/15.filezilla/filezilla.md
View file

@ -23,7 +23,7 @@ Install the program and run *Filezilla*.
![Main screen of Filezilla](image://filezilla_1.png) ![Main screen of Filezilla](image://filezilla_1.png)
2. Click **New Site** and give a name the server you will be using : *Family* here. Fill the settings as on the screenshot (replace the server adress with your own), and click on **Connect**. (N.B. : if you want to interact with the [custom webapp](https://github.com/YunoHost-Apps/my_webapp_ynh) files, you should use a different user than `admin`. Refer to the custom webapp documentation.) 2. Click **New Site** and give a name the server you will be using : *Family* here. Fill the settings as on the screenshot (replace the server address with your own), and click on **Connect**. (N.B. : if you want to interact with the [custom webapp](https://github.com/YunoHost-Apps/my_webapp_ynh) files, you should use a different user than `admin`. Refer to the custom webapp documentation.)
![Site manager screen](image://filezilla_2.png) ![Site manager screen](image://filezilla_2.png)

4
pages/02.administer/45.tutorials/25.external_storage/external_storage.fr.md
View file

@ -145,7 +145,7 @@ Puis, idéalement on passe en maintenance les applications qui pourraient être
Exemple, pour nextcloud: Exemple, pour nextcloud:
```bash ```bash
sudo -u nextcloud /var/www/occ maintenance:mode --on sudo -u nextcloud /var/www/nextcloud/occ maintenance:mode --on
``` ```
Exemple, pour le mail: Exemple, pour le mail:
@ -196,7 +196,7 @@ ls -la /var/mail/
A partir de là vous pouvez arréter le mode maintenance, la commande ci-dessous est à adapter selon les services que vous avez arrétés. A partir de là vous pouvez arréter le mode maintenance, la commande ci-dessous est à adapter selon les services que vous avez arrétés.
```bash ```bash
sudo -u nextcloud /var/www/occ maintenance:mode --off sudo -u nextcloud /var/www/nextcloud/occ maintenance:mode --off
systemctl start postfix systemctl start postfix
systemctl start dovecot systemctl start dovecot
``` ```

4
pages/02.administer/45.tutorials/25.external_storage/external_storage.md
View file

@ -146,7 +146,7 @@ Then, ideally, we switch to maintenance mode the applications that might be writ
Example, for nextcloud: Example, for nextcloud:
```bash ```bash
sudo -u nextcloud /var/www/occ maintenance:mode --on sudo -u nextcloud /var/www/nextcloud/occ maintenance:mode --on
``` ```
Example, for mail: Example, for mail:
@ -197,7 +197,7 @@ ls -la /var/mail/
From here you can stop maintenance mode, the command below is to be adapted depending on the services you have stopped. From here you can stop maintenance mode, the command below is to be adapted depending on the services you have stopped.
```bash ```bash
sudo -u nextcloud /var/www/occ maintenance:mode --off sudo -u nextcloud /var/www/nextcloud/occ maintenance:mode --off
systemctl start postfix systemctl start postfix
systemctl start dovecot systemctl start dovecot
``` ```

2
pages/02.administer/55.providers/05.registrar/ovh/manualdns/manualdns.md
View file

@ -37,7 +37,7 @@ then erase everything below, and replace it with the configuration generated by
You should follow this part if you have a dynamic IP. You should follow this part if you have a dynamic IP.
Find out if your ISP provides you with a dynamic IP adress [here](/isp). Find out if your ISP provides you with a dynamic IP address [here](/isp).
Let's create a DynHost id. Let's create a DynHost id.

2
pages/03.user_guide/05.emailclients/email_configure_client.md
View file

@ -50,7 +50,7 @@ Follow the following steps. (As for Thunderbird, you might need to accept certif
The first time you can simply choose "Add account". If you already have an account configured, tap the hamburger menu then tap the gear, choose Mail, Accounts and press the '+'-symbol. The first time you can simply choose "Add account". If you already have an account configured, tap the hamburger menu then tap the gear, choose Mail, Accounts and press the '+'-symbol.
Then you choose IMAP. Fill in the fields and press Next. Now Dekko will look for the configuration. Check that all fields are correct. Make sure you have your yunohost username, NOT your mailadress and choose "Allow untrusted certificates". Do this for IMAP and SMTP and press Next. Dekko will now synchronise the account after which you are done. Congratz! Then you choose IMAP. Fill in the fields and press Next. Now Dekko will look for the configuration. Check that all fields are correct. Make sure you have your yunohost username, NOT your email address and choose "Allow untrusted certificates". Do this for IMAP and SMTP and press Next. Dekko will now synchronise the account after which you are done. Congratz!
![](image://dekko_config_1.png?resize=280&classes=inline) ![](image://dekko_config_1.png?resize=280&classes=inline)
![](image://dekko_config_2.png?resize=280&classes=inline) ![](image://dekko_config_2.png?resize=280&classes=inline)

2
pages/04.applications/10.docs/baikal/app_baikal.md
View file

@ -62,7 +62,7 @@ Make sure it is filled with:
Save. Save.
Now, the adressbook is accessible. Now, the address book is accessible.
## Useful links ## Useful links

2
pages/04.applications/10.docs/emailpoubelle/app_emailpoubelle.md
View file

@ -9,7 +9,7 @@ routes:
[![Installer EmailPoubelle with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=emailpoubelle) [![Integration level](https://dash.yunohost.org/integration/emailpoubelle.svg)](https://dash.yunohost.org/appci/app/emailpoubelle) [![Installer EmailPoubelle with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=emailpoubelle) [![Integration level](https://dash.yunohost.org/integration/emailpoubelle.svg)](https://dash.yunohost.org/appci/app/emailpoubelle)
*EmailPoubelle* (Trash email) is a script to create temporay email adresses that aims to your real email address. *EmailPoubelle* (Trash email) is a script to create temporary email addresses that aims to your real email address.
A YunoHost version of EmailPoubelle by David Mercereau. All thanks to David. A YunoHost version of EmailPoubelle by David Mercereau. All thanks to David.
### Disclaimers / important information ### Disclaimers / important information

2
pages/04.applications/10.docs/ttrss/app_ttrss.md
View file

@ -22,7 +22,7 @@ In order to do so, go to Actions -> Configuration -> feed tab -> OPML section ->
You can read your feeds on Android using ttrss-reader application: **[ttrss-reader](https://f-droid.org/packages/org.ttrssreader/)** You can read your feeds on Android using ttrss-reader application: **[ttrss-reader](https://f-droid.org/packages/org.ttrssreader/)**
To use it, you need to go to Actions -> Configuration, in Tiny Tiny RSS web interface and select "Activate API". To use it, you need to go to Actions -> Configuration, in Tiny Tiny RSS web interface and select "Activate API".
Then, in your android ttrss-reader, fill the Tiny Tiny RSS server adress: https://yourdomain.org/ttrss, username, password (no need to use HTTP authentification). Then, in your android ttrss-reader, fill the Tiny Tiny RSS server address: https://yourdomain.org/ttrss, username, password (no need to use HTTP authentication).
**Note**: you may need to uninstall and reinstall the Tiny Tiny RSS application through the YunoHost admin panel in order to be able to connect. **Note**: you may need to uninstall and reinstall the Tiny Tiny RSS application through the YunoHost admin panel in order to be able to connect.

280
pages/06.contribute/10.packaging_apps/80.resources/11.helpers/packaging_apps_helpers.md
View file

@ -7,7 +7,7 @@ routes:
default: '/packaging_apps_helpers' default: '/packaging_apps_helpers'
--- ---
Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/doc/generate_helper_doc.py) on 14/06/2023 (YunoHost version 11.1.21.4) Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/doc/generate_helper_doc.py) on 19/07/2023 (YunoHost version 11.2.2)
## APPS ## APPS
@ -25,7 +25,7 @@ Requires YunoHost version *.*.* or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/apps#L9) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/apps#L9)
[/details] [/details]
---------------- ----------------
@ -41,7 +41,7 @@ Requires YunoHost version *.*.* or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/apps#L65) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/apps#L65)
[/details] [/details]
---------------- ----------------
@ -66,11 +66,11 @@ Requires YunoHost version *.*.* or higher.
Requires YunoHost version 11.0.* or higher, and that the app relies on packaging v2 or higher. Requires YunoHost version 11.0.* or higher, and that the app relies on packaging v2 or higher.
The spawned shell will have environment variables loaded and environment files sourced The spawned shell will have environment variables loaded and environment files sourced
from the app's service configuration file (defaults to $app.service, overridable by the packager with `service` setting). from the app's service configuration file (defaults to $app.service, overridable by the packager with `service` setting).
If the app relies on a specific PHP version, then `php` will be aliased that version. If the app relies on a specific PHP version, then `php` will be aliased that version. The PHP command will also be appended with the `phpflags` settings.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/apps#L128) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/apps#L128)
[/details] [/details]
---------------- ----------------
@ -94,7 +94,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/apt#L53) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/apt#L53)
[/details] [/details]
---------------- ----------------
@ -115,7 +115,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/apt#L75) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/apt#L75)
[/details] [/details]
---------------- ----------------
@ -129,7 +129,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/apt#L107) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/apt#L107)
[/details] [/details]
---------------- ----------------
@ -146,7 +146,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/apt#L117) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/apt#L117)
[/details] [/details]
---------------- ----------------
@ -163,7 +163,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/apt#L128) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/apt#L128)
[/details] [/details]
---------------- ----------------
@ -180,7 +180,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/apt#L138) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/apt#L138)
[/details] [/details]
---------------- ----------------
@ -197,7 +197,7 @@ Requires YunoHost version 2.7.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/apt#L148) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/apt#L148)
[/details] [/details]
---------------- ----------------
@ -219,7 +219,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/apt#L225) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/apt#L225)
[/details] [/details]
---------------- ----------------
@ -236,7 +236,7 @@ Requires YunoHost version 3.8.1 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/apt#L338) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/apt#L338)
[/details] [/details]
---------------- ----------------
@ -252,7 +252,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/apt#L357) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/apt#L357)
[/details] [/details]
---------------- ----------------
@ -272,7 +272,7 @@ Requires YunoHost version 3.8.1 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/apt#L391) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/apt#L391)
[/details] [/details]
---------------- ----------------
@ -345,7 +345,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/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/backup#L64) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/backup#L64)
[/details] [/details]
---------------- ----------------
@ -359,7 +359,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/backup#L179) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/backup#L179)
[/details] [/details]
---------------- ----------------
@ -404,7 +404,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/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/backup#L238) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/backup#L238)
[/details] [/details]
---------------- ----------------
@ -423,7 +423,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/backup#L306) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/backup#L306)
[/details] [/details]
---------------- ----------------
@ -445,7 +445,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/backup#L357) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/backup#L357)
[/details] [/details]
---------------- ----------------
@ -464,7 +464,7 @@ Requires YunoHost version 3.3.1 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/backup#L397) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/backup#L397)
[/details] [/details]
---------------- ----------------
@ -487,7 +487,7 @@ Requires YunoHost version 2.7.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/backup#L432) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/backup#L432)
[/details] [/details]
---------------- ----------------
@ -510,7 +510,7 @@ Requires YunoHost version 2.7.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/backup#L480) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/backup#L480)
[/details] [/details]
---------------- ----------------
@ -587,7 +587,7 @@ Requires YunoHost version 4.1.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/fail2ban#L64) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/fail2ban#L64)
[/details] [/details]
---------------- ----------------
@ -601,7 +601,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/fail2ban#L119) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/fail2ban#L119)
[/details] [/details]
---------------- ----------------
@ -629,7 +629,7 @@ Requires YunoHost version 3.8.1 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/hardware#L13) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/hardware#L13)
[/details] [/details]
---------------- ----------------
@ -652,7 +652,7 @@ Requires YunoHost version 3.8.1 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/hardware#L75) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/hardware#L75)
[/details] [/details]
---------------- ----------------
@ -673,7 +673,7 @@ Requires YunoHost version 2.4.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/logging#L10) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/logging#L10)
[/details] [/details]
---------------- ----------------
@ -690,7 +690,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/logging#L30) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/logging#L30)
[/details] [/details]
---------------- ----------------
@ -707,7 +707,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/logging#L56) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/logging#L56)
[/details] [/details]
---------------- ----------------
@ -724,7 +724,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/logging#L73) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/logging#L73)
[/details] [/details]
---------------- ----------------
@ -743,7 +743,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/logging#L92) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/logging#L92)
[/details] [/details]
---------------- ----------------
@ -762,7 +762,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/logging#L113) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/logging#L113)
[/details] [/details]
---------------- ----------------
@ -781,7 +781,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/logging#L134) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/logging#L134)
[/details] [/details]
---------------- ----------------
@ -800,7 +800,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/logging#L155) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/logging#L155)
[/details] [/details]
---------------- ----------------
@ -819,7 +819,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/logging#L176) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/logging#L176)
[/details] [/details]
---------------- ----------------
@ -839,7 +839,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/logging#L237) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/logging#L237)
[/details] [/details]
---------------- ----------------
@ -854,7 +854,7 @@ Requires YunoHost version 3.6.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/logging#L325) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/logging#L325)
[/details] [/details]
---------------- ----------------
@ -883,7 +883,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/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/logrotate#L18) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/logrotate#L18)
[/details] [/details]
---------------- ----------------
@ -897,7 +897,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/logrotate#L109) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/logrotate#L109)
[/details] [/details]
---------------- ----------------
@ -914,7 +914,7 @@ Requires YunoHost version 4.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/multimedia#L11) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/multimedia#L11)
[/details] [/details]
---------------- ----------------
@ -934,7 +934,7 @@ Requires YunoHost version 4.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/multimedia#L64) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/multimedia#L64)
[/details] [/details]
---------------- ----------------
@ -951,7 +951,7 @@ Requires YunoHost version 4.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/multimedia#L93) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/multimedia#L93)
[/details] [/details]
---------------- ----------------
@ -984,7 +984,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/mysql#L15) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/mysql#L15)
[/details] [/details]
---------------- ----------------
@ -1002,7 +1002,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/mysql#L36) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/mysql#L36)
[/details] [/details]
---------------- ----------------
@ -1020,7 +1020,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/mysql#L60) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/mysql#L60)
[/details] [/details]
---------------- ----------------
@ -1041,7 +1041,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/mysql#L128) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/mysql#L128)
[/details] [/details]
---------------- ----------------
@ -1060,7 +1060,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/mysql#L160) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/mysql#L160)
[/details] [/details]
---------------- ----------------
@ -1082,7 +1082,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/mysql#L198) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/mysql#L198)
[/details] [/details]
---------------- ----------------
@ -1100,7 +1100,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/mysql#L224) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/mysql#L224)
[/details] [/details]
---------------- ----------------
@ -1124,7 +1124,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/network#L12) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/network#L12)
[/details] [/details]
---------------- ----------------
@ -1145,7 +1145,7 @@ Requires YunoHost version 3.8.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/network#L36) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/network#L36)
[/details] [/details]
---------------- ----------------
@ -1166,7 +1166,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/network#L99) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/network#L99)
[/details] [/details]
---------------- ----------------
@ -1187,7 +1187,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/network#L119) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/network#L119)
[/details] [/details]
---------------- ----------------
@ -1215,7 +1215,7 @@ Requires YunoHost version 4.1.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/nginx#L19) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/nginx#L19)
[/details] [/details]
---------------- ----------------
@ -1229,7 +1229,7 @@ Requires YunoHost version 2.7.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/nginx#L41) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/nginx#L41)
[/details] [/details]
---------------- ----------------
@ -1243,7 +1243,7 @@ Requires YunoHost version 11.1.9 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/nginx#L52) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/nginx#L52)
[/details] [/details]
---------------- ----------------
@ -1297,7 +1297,7 @@ Requires YunoHost version 2.7.12 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/nodejs#L52) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/nodejs#L52)
[/details] [/details]
---------------- ----------------
@ -1321,7 +1321,7 @@ Requires YunoHost version 2.7.12 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/nodejs#L92) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/nodejs#L92)
[/details] [/details]
---------------- ----------------
@ -1339,7 +1339,7 @@ Requires YunoHost version 2.7.12 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/nodejs#L165) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/nodejs#L165)
[/details] [/details]
---------------- ----------------
@ -1412,7 +1412,7 @@ Requires YunoHost version 3.7.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/permission#L66) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/permission#L66)
[/details] [/details]
---------------- ----------------
@ -1431,7 +1431,7 @@ Requires YunoHost version 3.7.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/permission#L152) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/permission#L152)
[/details] [/details]
---------------- ----------------
@ -1449,7 +1449,7 @@ Requires YunoHost version 3.7.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/permission#L169) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/permission#L169)
[/details] [/details]
---------------- ----------------
@ -1472,7 +1472,7 @@ Requires YunoHost version 3.7.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/permission#L192) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/permission#L192)
[/details] [/details]
---------------- ----------------
@ -1495,7 +1495,7 @@ Requires YunoHost version 3.7.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/permission#L260) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/permission#L260)
[/details] [/details]
---------------- ----------------
@ -1516,7 +1516,7 @@ Requires YunoHost version 3.7.1 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/permission#L329) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/permission#L329)
[/details] [/details]
---------------- ----------------
@ -1531,7 +1531,7 @@ Requires YunoHost version 4.1.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/permission#L359) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/permission#L359)
[/details] [/details]
---------------- ----------------
@ -1542,7 +1542,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.` **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/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/permission#L379) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/permission#L379)
[/details] [/details]
---------------- ----------------
@ -1552,28 +1552,44 @@ Requires YunoHost version 4.1.2 or higher.
#### ynh_add_fpm_config #### ynh_add_fpm_config
[details summary="<i>Create a dedicated PHP-FPM config</i>" class="helper-card-subtitle text-muted"] [details summary="<i>Create a dedicated PHP-FPM config</i>" class="helper-card-subtitle text-muted"]
**Usage**: `1: ynh_add_fpm_config [--phpversion=7.X] [--use_template] [--package=packages] [--dedicated_service] **Usage**: `ynh_add_fpm_config`
2: ynh_add_fpm_config [--phpversion=7.X] --usage=usage --footprint=footprint [--package=packages] [--dedicated_service]
**Details**:<br/>
Case 1 (recommended) : your provided a snippet conf/extra_php-fpm.conf
The actual PHP configuration will be automatically generated,
and your extra_php-fpm.conf will be appended (typically contains PHP upload limits)
The resulting configuration will be deployed to the appropriate place, /etc/php/$phpversion/fpm/pool.d/$app.conf
Performance-related options in the PHP conf, such as :
pm.max_children, pm.start_servers, pm.min_spare_servers pm.max_spare_servers
are computed from two parameters called "usage" and "footprint" which can be set to low/medium/high. (cf details below)
If you wish to tweak those, please initialize the settings `fpm_usage` and `fpm_footprint`
*prior* to calling this helper. Otherwise, "low" will be used as a default for both values.
Otherwise, if you want the user to have control over these, we encourage to create a config panel
(which should ultimately be standardized by the core ...)
Case 2 (deprecate) : you provided an entire conf/php-fpm.conf
The configuration will be hydrated, replacing __FOOBAR__ placeholders with $foobar values, etc.
The resulting configuration will be deployed to the appropriate place, /etc/php/$phpversion/fpm/pool.d/$app.conf
----------------------
fpm_footprint: Memory footprint of the service (low/medium/high).
low - Less than 20 MB of RAM by pool. low - Less than 20 MB of RAM by pool.
medium - Between 20 MB and 40 MB of RAM by pool. medium - Between 20 MB and 40 MB of RAM by pool.
high - More than 40 MB 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. N - Or you can specify a quantitative footprint as MB by pool (use watch -n0.5 ps -o user,cmd,%cpu,rss -u APP)
To have this value, use the following command and stress the service.
watch -n0.5 ps -o user,cmd,%cpu,rss -u APP`
**Arguments**: fpm_usage: Expected usage of the service (low/medium/high).
- `-v`, `--phpversion=`: Version of PHP to use. low - Personal usage, behind the SSO.
- `-t`, `--use_template`: Use this helper in template mode. medium - Low usage, few people or/and publicly accessible.
- `-p`, `--package=`: Additionnal PHP packages to install high - High usage, frequently visited website.
- `-d`, `--dedicated_service`: Use a dedicated PHP-FPM service instead of the common one.
- `-v`, `--phpversion=`: Version of PHP to use.
- `-f`, `--footprint=`: Memory footprint of the service (low/medium/high).
- `-u`, `--usage=`: Expected usage of the service (low/medium/high).
- `-p`, `--package=`: Additionnal PHP packages to install for a specific version of PHP
- `-d`, `--dedicated_service`: Use a dedicated PHP-FPM service instead of the common one.
**Details**:<br/>
-----------------------------------------------------------------------------
The footprint of the service will be used to defined the maximum footprint we can allow, which is half the maximum RAM. The footprint of the service will be used to defined the maximum footprint we can allow, which is half the maximum RAM.
So it will be used to defined 'pm.max_children' So it will be used to defined 'pm.max_children'
@ -1600,7 +1616,7 @@ Requires YunoHost version 4.1.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/php#L59) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/php#L70)
[/details] [/details]
---------------- ----------------
@ -1614,7 +1630,7 @@ Requires YunoHost version 2.7.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/php#L257) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/php#L281)
[/details] [/details]
---------------- ----------------
@ -1633,7 +1649,7 @@ Requires YunoHost version 4.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/php#L490) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/php#L514)
[/details] [/details]
---------------- ----------------
@ -1653,7 +1669,7 @@ Requires YunoHost version 4.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/php#L522) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/php#L546)
[/details] [/details]
---------------- ----------------
@ -1686,7 +1702,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/postgresql#L18) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/postgresql#L18)
[/details] [/details]
---------------- ----------------
@ -1704,7 +1720,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/postgresql#L39) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/postgresql#L39)
[/details] [/details]
---------------- ----------------
@ -1722,7 +1738,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/postgresql#L64) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/postgresql#L64)
[/details] [/details]
---------------- ----------------
@ -1743,7 +1759,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/postgresql#L135) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/postgresql#L135)
[/details] [/details]
---------------- ----------------
@ -1761,7 +1777,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/postgresql#L168) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/postgresql#L168)
[/details] [/details]
---------------- ----------------
@ -1779,7 +1795,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/postgresql#L190) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/postgresql#L190)
[/details] [/details]
---------------- ----------------
@ -1801,7 +1817,7 @@ Requires YunoHost version 2.7.13 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/postgresql#L234) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/postgresql#L234)
[/details] [/details]
---------------- ----------------
@ -1819,7 +1835,7 @@ Requires YunoHost version 2.7.13 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/postgresql#L265) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/postgresql#L265)
[/details] [/details]
---------------- ----------------
@ -1840,7 +1856,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/setting#L10) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/setting#L10)
[/details] [/details]
---------------- ----------------
@ -1859,7 +1875,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/setting#L36) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/setting#L36)
[/details] [/details]
---------------- ----------------
@ -1877,7 +1893,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/setting#L62) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/setting#L62)
[/details] [/details]
---------------- ----------------
@ -1897,7 +1913,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/setting#L123) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/setting#L123)
[/details] [/details]
---------------- ----------------
@ -1918,7 +1934,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/setting#L145) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/setting#L145)
[/details] [/details]
---------------- ----------------
@ -1943,7 +1959,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/string#L13) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/string#L13)
[/details] [/details]
---------------- ----------------
@ -1965,7 +1981,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/string#L40) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/string#L40)
[/details] [/details]
---------------- ----------------
@ -1987,7 +2003,7 @@ Requires YunoHost version 2.7.7 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/string#L71) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/string#L71)
[/details] [/details]
---------------- ----------------
@ -2010,7 +2026,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/string#L103) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/string#L103)
[/details] [/details]
---------------- ----------------
@ -2036,7 +2052,7 @@ Requires YunoHost version 4.1.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/systemd#L15) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/systemd#L15)
[/details] [/details]
---------------- ----------------
@ -2053,7 +2069,7 @@ Requires YunoHost version 2.7.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/systemd#L38) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/systemd#L38)
[/details] [/details]
---------------- ----------------
@ -2075,7 +2091,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/systemd#L67) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/systemd#L67)
[/details] [/details]
---------------- ----------------
@ -2099,7 +2115,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/user#L12) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/user#L12)
[/details] [/details]
---------------- ----------------
@ -2121,7 +2137,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/user#L33) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/user#L33)
[/details] [/details]
---------------- ----------------
@ -2139,7 +2155,7 @@ Requires YunoHost version 2.4.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/user#L53) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/user#L53)
[/details] [/details]
---------------- ----------------
@ -2158,7 +2174,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/user#L64) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/user#L64)
[/details] [/details]
---------------- ----------------
@ -2177,7 +2193,7 @@ Requires YunoHost version 3.5.0.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/user#L82) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/user#L82)
[/details] [/details]
---------------- ----------------
@ -2206,7 +2222,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/user#L111) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/user#L111)
[/details] [/details]
---------------- ----------------
@ -2223,7 +2239,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/user#L153) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/user#L153)
[/details] [/details]
---------------- ----------------
@ -2237,7 +2253,7 @@ Requires YunoHost version 4.1.7 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/user#L179) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/user#L179)
[/details] [/details]
---------------- ----------------
@ -2258,7 +2274,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/utils#L61) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/utils#L61)
[/details] [/details]
---------------- ----------------
@ -2350,7 +2366,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/utils#L154) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/utils#L154)
[/details] [/details]
---------------- ----------------
@ -2376,7 +2392,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/utils#L397) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/utils#L397)
[/details] [/details]
---------------- ----------------
@ -2434,7 +2450,7 @@ Requires YunoHost version 4.1.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/utils#L481) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/utils#L481)
[/details] [/details]
---------------- ----------------
@ -2478,7 +2494,7 @@ Requires YunoHost version 4.3 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/utils#L635) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/utils#L635)
[/details] [/details]
---------------- ----------------
@ -2497,7 +2513,7 @@ Requires YunoHost version 4.3 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/utils#L712) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/utils#L712)
[/details] [/details]
---------------- ----------------
@ -2513,7 +2529,7 @@ Requires YunoHost version 2.7.12 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/utils#L827) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/utils#L827)
[/details] [/details]
---------------- ----------------
@ -2530,7 +2546,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/utils#L858) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/utils#L858)
[/details] [/details]
---------------- ----------------
@ -2550,7 +2566,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/utils#L892) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/utils#L892)
[/details] [/details]
---------------- ----------------
@ -2575,7 +2591,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/utils#L935) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/utils#L935)
[/details] [/details]
---------------- ----------------
@ -2598,7 +2614,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/utils#L964) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/utils#L964)
[/details] [/details]
---------------- ----------------
@ -2621,7 +2637,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/utils#L989) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/utils#L989)
[/details] [/details]
---------------- ----------------
@ -2653,7 +2669,7 @@ Requires YunoHost version 3.8.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/helpers/utils#L1019) [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/helpers/utils#L1019)
[/details] [/details]
---------------- ----------------

67
pages/06.contribute/10.packaging_apps/80.resources/15.appresources/packaging_apps_resources.md
View file

@ -7,7 +7,7 @@ routes:
default: '/packaging_apps_resources' default: '/packaging_apps_resources'
--- ---
Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/19eb48b6e73267685e1417122ac47908c1cf2472/doc/generate_resource_doc.py) on 14/06/2023 (YunoHost version 11.1.21.4) Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/53bc30b9fb1ca698b971ae10e579abce605b56b0/doc/generate_resource_doc.py) on 19/07/2023 (YunoHost version 11.2.2)
---------------- ----------------
@ -19,16 +19,16 @@ Create a virtual package in apt, depending on the list of specified packages tha
##### Example ##### Example
```toml ```toml
[resources.apt] [resources.apt]
packages = "nyancat, lolcat, sl" packages = ["nyancat", "lolcat", "sl"]
# (this part is optional and corresponds to the legacy ynh_install_extra_app_dependencies helper) # (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.repo = "deb https://dl.yarnpkg.com/debian/ stable main"
extras.yarn.key = "https://dl.yarnpkg.com/debian/pubkey.gpg" extras.yarn.key = "https://dl.yarnpkg.com/debian/pubkey.gpg"
extras.yarn.packages = "yarn" extras.yarn.packages = ["yarn"]
``` ```
##### Properties ##### Properties
- `packages`: Comma-separated list of packages to be installed via `apt` - `packages`: List of packages to be installed via `apt`
- `packages_from_raw_bash`: A multi-line bash snippet (using triple quotes as open/close) which should echo additional packages to be installed. Meant to be used for packages to be conditionally installed depending on architecture, debian version, install questions, or other logic. - `packages_from_raw_bash`: A multi-line bash snippet (using triple quotes as open/close) which should echo additional packages to be installed. Meant to be used for packages to be conditionally installed depending on architecture, debian version, install questions, or other logic.
- `extras`: A dict of (repo, key, packages) corresponding to "extra" repositories to fetch dependencies from - `extras`: A dict of (repo, key, packages) corresponding to "extra" repositories to fetch dependencies from
@ -225,11 +225,11 @@ Various options are available to accomodate the behavior according to the asset
```toml ```toml
[resources.sources] [resources.sources]
[resources.sources.main] [resources.sources.main]
url = "https://github.com/foo/bar/archive/refs/tags/v1.2.3.tar.gz" url = "https://github.com/foo/bar/archive/refs/tags/v1.2.3.tar.gz"
sha256 = "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b" sha256 = "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
autoupdate.strategy = "latest_github_tag" autoupdate.strategy = "latest_github_tag"
``` ```
Or more complex examples with several element, including one with asset that depends on the arch Or more complex examples with several element, including one with asset that depends on the arch
@ -237,25 +237,25 @@ Or more complex examples with several element, including one with asset that dep
```toml ```toml
[resources.sources] [resources.sources]
[resources.sources.main] [resources.sources.main]
in_subdir = false in_subdir = false
amd64.url = "https://github.com/foo/bar/archive/refs/tags/v1.2.3.amd64.tar.gz" amd64.url = "https://github.com/foo/bar/archive/refs/tags/v1.2.3.amd64.tar.gz"
amd64.sha256 = "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b" amd64.sha256 = "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
i386.url = "https://github.com/foo/bar/archive/refs/tags/v1.2.3.386.tar.gz" i386.url = "https://github.com/foo/bar/archive/refs/tags/v1.2.3.386.tar.gz"
i386.sha256 = "53c234e5e8472b6ac51c1ae1cab3fe06fad053beb8ebfd8977b010655bfdd3c3" i386.sha256 = "53c234e5e8472b6ac51c1ae1cab3fe06fad053beb8ebfd8977b010655bfdd3c3"
armhf.url = "https://github.com/foo/bar/archive/refs/tags/v1.2.3.arm.tar.gz" armhf.url = "https://github.com/foo/bar/archive/refs/tags/v1.2.3.arm.tar.gz"
armhf.sha256 = "4355a46b19d348dc2f57c046f8ef63d4538ebb936000f3c9ee954a27460dd865" armhf.sha256 = "4355a46b19d348dc2f57c046f8ef63d4538ebb936000f3c9ee954a27460dd865"
autoupdate.strategy = "latest_github_release" autoupdate.strategy = "latest_github_release"
autoupdate.asset.amd64 = ".*\.amd64.tar.gz" autoupdate.asset.amd64 = ".*\.amd64.tar.gz"
autoupdate.asset.i386 = ".*\.386.tar.gz" autoupdate.asset.i386 = ".*\.386.tar.gz"
autoupdate.asset.armhf = ".*\.arm.tar.gz" autoupdate.asset.armhf = ".*\.arm.tar.gz"
[resources.sources.zblerg] [resources.sources.zblerg]
url = "https://zblerg.com/download/zblerg" url = "https://zblerg.com/download/zblerg"
sha256 = "1121cfccd5913f0a63fec40a6ffd44ea64f9dc135c66634ba001d10bcf4302a2" sha256 = "1121cfccd5913f0a63fec40a6ffd44ea64f9dc135c66634ba001d10bcf4302a2"
format = "script" format = "script"
rename = "zblerg.sh" rename = "zblerg.sh"
``` ```
@ -263,14 +263,14 @@ rename = "zblerg.sh"
- `prefetch` : `true` (default) or `false`, wether or not to pre-fetch this asset during the provisioning phase of the resource. If several arch-dependent url are provided, YunoHost will only prefetch the one for the current system architecture. - `prefetch` : `true` (default) or `false`, wether or not to pre-fetch this asset during the provisioning phase of the resource. If several arch-dependent url are provided, YunoHost will only prefetch the one for the current system architecture.
- `url` : the asset's URL - `url` : the asset's URL
- If the asset's URL depend on the architecture, you may instead provide `amd64.url`, `i386.url`, `armhf.url` and `arm64.url` (depending on what architectures are supported), using the same `dpkg --print-architecture` nomenclature as for the supported architecture key in the manifest - If the asset's URL depend on the architecture, you may instead provide `amd64.url`, `i386.url`, `armhf.url` and `arm64.url` (depending on what architectures are supported), using the same `dpkg --print-architecture` nomenclature as for the supported architecture key in the manifest
- `sha256` : the asset's sha256sum. This is used both as an integrity check, and as a layer of security to protect against malicious actors which could have injected malicious code inside the asset... - `sha256` : the asset's sha256sum. This is used both as an integrity check, and as a layer of security to protect against malicious actors which could have injected malicious code inside the asset...
- Same as `url` : if the asset's URL depend on the architecture, you may instead provide `amd64.sha256`, `i386.sha256`, ... - Same as `url` : if the asset's URL depend on the architecture, you may instead provide `amd64.sha256`, `i386.sha256`, ...
- `format` : The "format" of the asset. It is typically automatically guessed from the extension of the URL (or the mention of "tarball", "zipball" in the URL), but can be set explicitly: - `format` : The "format" of the asset. It is typically automatically guessed from the extension of the URL (or the mention of "tarball", "zipball" in the URL), but can be set explicitly:
- `tar.gz`, `tar.xz`, `tar.bz2` : will use `tar` to extract the archive - `tar.gz`, `tar.xz`, `tar.bz2` : will use `tar` to extract the archive
- `zip` : will use `unzip` to extract the archive - `zip` : will use `unzip` to extract the archive
- `docker` : useful to extract files from an already-built docker image (instead of rebuilding them locally). Will use `docker-image-extract` - `docker` : useful to extract files from an already-built docker image (instead of rebuilding them locally). Will use `docker-image-extract`
- `whatever`: whatever arbitrary value, not really meaningful except to imply that the file won't be extracted (eg because it's a .deb to be manually installed with dpkg/apt, or a script, or ...) - `whatever`: whatever arbitrary value, not really meaningful except to imply that the file won't be extracted (eg because it's a .deb to be manually installed with dpkg/apt, or a script, or ...)
- `in_subdir`: `true` (default) or `false`, depending on if there's an intermediate subdir in the archive before accessing the actual files. Can also be `N` (an integer) to handle special cases where there's `N` level of subdir to get rid of to actually access the files - `in_subdir`: `true` (default) or `false`, depending on if there's an intermediate subdir in the archive before accessing the actual files. Can also be `N` (an integer) to handle special cases where there's `N` level of subdir to get rid of to actually access the files
- `extract` : `true` or `false`. Defaults to `true` for archives such as `zip`, `tar.gz`, `tar.bz2`, ... Or defaults to `false` when `format` is not something that should be extracted. When `extract = false`, the file will only be `mv`ed to the location, possibly renamed using the `rename` value - `extract` : `true` or `false`. Defaults to `true` for archives such as `zip`, `tar.gz`, `tar.bz2`, ... Or defaults to `false` when `format` is not something that should be extracted. When `extract = false`, the file will only be `mv`ed to the location, possibly renamed using the `rename` value
- `rename`: some string like `whatever_your_want`, to be used for convenience when `extract` is `false` and the default name of the file is not practical - `rename`: some string like `whatever_your_want`, to be used for convenience when `extract` is `false` and the default name of the file is not practical
@ -287,8 +287,8 @@ The script will rely on the code repo specified in the upstream section of the m
`autoupdate.strategy` is expected to be one of : `autoupdate.strategy` is expected to be one of :
- `latest_github_tag` : look for the latest tag (by sorting tags and finding the "largest" version). Then using the corresponding tar.gz url. Tags containing `rc`, `beta`, `alpha`, `start` are ignored, and actually any tag which doesn't look like `x.y.z` or `vx.y.z` - `latest_github_tag` : look for the latest tag (by sorting tags and finding the "largest" version). Then using the corresponding tar.gz url. Tags containing `rc`, `beta`, `alpha`, `start` are ignored, and actually any tag which doesn't look like `x.y.z` or `vx.y.z`
- `latest_github_release` : similar to `latest_github_tags`, but starting from the list of releases. Pre- or draft releases are ignored. Releases may have assets attached to them, in which case you can define: - `latest_github_release` : similar to `latest_github_tags`, but starting from the list of releases. Pre- or draft releases are ignored. Releases may have assets attached to them, in which case you can define:
- `autoupdate.asset = "some regex"` (when there's only one asset to use). The regex is used to find the appropriate asset among the list of all assets. Note that the regex must follow [Python's regex implementation](https://docs.python.org/3/howto/regex.html#regex-howto) (for instance a double backslash is to be used as escape character). - `autoupdate.asset = "some regex"` (when there's only one asset to use). The regex is used to find the appropriate asset among the list of all assets
- or several `autoupdate.asset.$arch = "some_regex"` (when the asset is arch-specific). The regex is used to find the appropriate asset for the specific arch among the list of assets - or several `autoupdate.asset.$arch = "some_regex"` (when the asset is arch-specific). The regex is used to find the appropriate asset for the specific arch among the list of assets
- `latest_github_commit` : will use the latest commit on github, and the corresponding tarball. If this is used for the 'main' source, it will also assume that the version is YYYY.MM.DD corresponding to the date of the commit. - `latest_github_commit` : will use the latest commit on github, and the corresponding tarball. If this is used for the 'main' source, it will also assume that the version is YYYY.MM.DD corresponding to the date of the commit.
It is also possible to define `autoupdate.upstream` to use a different Git(hub) repository instead of the code repository from the upstream section of the manifest. This can be useful when, for example, the app uses other assets such as plugin from a different repository. It is also possible to define `autoupdate.upstream` to use a different Git(hub) repository instead of the code repository from the upstream section of the manifest. This can be useful when, for example, the app uses other assets such as plugin from a different repository.
@ -314,6 +314,7 @@ Provision a system user to be used by the app. The username is exactly equal to
##### Properties ##### Properties
- `allow_ssh`: (default: False) Adds the user to the ssh.app group, allowing SSH connection via this user - `allow_ssh`: (default: False) Adds the user to the ssh.app group, allowing SSH connection via this user
- `allow_sftp`: (default: False) Adds the user to the sftp.app group, allowing SFTP connection via this user - `allow_sftp`: (default: False) Adds the user to the sftp.app group, allowing SFTP connection via this user
- `allow_email`: (default: False) Enable authentication on the mail stack for the system user and send mail using `__APP__@__DOMAIN__`. A `mail_pwd` setting is automatically defined (similar to `db_pwd` for databases). You can then configure the app to use `__APP__` and `__MAIL_PWD__` as SMTP credentials (with host 127.0.0.1). You can also tweak the user-part of the domain-part of the email used by manually defining a custom setting `mail_user` or `mail_domain`
- `home`: (default: `/var/www/__APP__`) Defines the home property for this user. NB: unfortunately you can't simply use `__INSTALL_DIR__` or `__DATA_DIR__` for now - `home`: (default: `/var/www/__APP__`) Defines the home property for this user. NB: unfortunately you can't simply use `__INSTALL_DIR__` or `__DATA_DIR__` for now
##### Provision/Update ##### Provision/Update