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 conflicts

Browse source
This commit is contained in:
Yunohost-Bot 2024-03-01 05:12:38 +00:00
commit b2e063cc35
31 changed files with 436 additions and 200 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,12 @@
## Problem
- *Description of why you made this PR, what is its purpose*
## Solution
- *And how do you relevantly fix that problem*
## PR checklist
- [ ] I'm not doing a PR for an application, I promise, I know that this kind of changes must go directly into the app packages themselves
- [ ] PR finished and ready to be reviewed

9
README.md
View file

@ -5,6 +5,11 @@
Please report [issues on YunoHost bugtracker](https://github.com/YunoHost/issues/issues).
## Note about package documentation
Package documentation should be done in the package repository itself, under the `/doc` folder.
You can learn about it here: <https://yunohost.org/packaging_app_doc>
# Contributing
This repo use a **submodule** to provide the theme. So when you clone use:
@ -13,7 +18,6 @@ This repo use a **submodule** to provide the theme. So when you clone use:
git clone --recursive https://github.com/YunoHost/doc.git
```
You can refer to the page on [writing documentation](https://yunohost.org/write_documentation).
If you know docker, you can run:
@ -35,5 +39,4 @@ Finally you can rebuild the CSS with (You can replace `expanded` by `compressed`
```
Source:
https://sass-lang.com/guide
<https://sass-lang.com/guide>

55
pages/02.administer/10.install/25.installing_debian/installing_debian.md Normal file
View file

@ -0,0 +1,55 @@
---
title: Installing Debian for Yunohost
template: docs
taxonomy:
category: docs
routes:
default: '/installing_debian'
---
If you can't install Yunohost successfully, there's always the option to install Debian and then install Yunohost on top.
## Which Debian version
At the time of writing, only Debian 11 is supported by Yunohost. Don't use Debian 12.
## Before you start
The Debian installer isn't the easiest Linux installer, especially for beginners. It'll be easier to **format the hard drive** you plan to use for Debian+Yunohost **before you install Debian**, using your disk utility of choice.
## Installing Debian
### Booting the installer
This guide won't go into details on how to boot the Debian installer. You can use Debian's own documentation for that. The short version is you'll need to flash a USB stick with the Debian 11 image, like you would flash the Yunohost image.
### Installing
In general, you can simply follow the instructions on screen and use the suggested defaults.
Debian installer will ask for a **hostname** and a **domain name**. You can use “yunohost” and “yunohost.local”. It’s not really important since the Yunohost Installer will overwrite those anyway.
Debian will ask for a **root password**. Make sure you pick a **really long and complex** one and save it to your password manager of choice (Bitwarden, Firefox, etc…) or write it somewhere safe. Remember that this is a server that will be available on the internet, making it vulnerable to possible attacks so you should be extra safe here!
The installer will also ask for a **user account** and another password. **Important:** name it something that won’t be used by your Yunohost server later. For example, you can name it `debian`. Be sure to also use a long complex password.
When the install asks about where to install and how to **create disk partitions**, select the option to use the whole disk, unless you know what you're doing.
- Don’t separate the /home, /var or /tmp partitions. Use the option to “keep all files in one partition”.
- Don’t encrypt any partitions, [as recommended](https://yunohost.org/en/administer/install/hardware:regular#about-encryption))
The installer will ask about **mirrors**. Select a country and server close to your location, or use the default options.
The installer will ask about which **desktop environment** you want. You should not install a desktop environment on a server:
- Unselect all desktop environment
- Keep “standard system utilities” checked
## After installing Debian
1. Remove the installation media (unplug the USB stick)
2. Reboot
3. Login as `root` with the long complex password you created earlier.
4. Install curl by typing `apt install curl`
5. Proceed to install Yunohost on Debian using these instructions: https://yunohost.org/en/install/hardware:vps_debian
- The installer will ask for permission to overwrite some configuration files. Select Yes.

18
pages/02.administer/10.install/install.fr.md
View file

@ -334,6 +334,17 @@ Pour les anciens matériels, il vous faut peut-être utiliser un CD/DVD. Le logi
* Sur GNU/Linux, vous avez plusieurs choix, tels que [Brasero](https://wiki.gnome.org/Apps/Brasero) ou [K3b](http://www.k3b.org/)
[/ui-tab]
[ui-tab title="Utiliser Ventoy"]
Ventoy sera utile si vous n'arrivez pas à démarrer l'image de Yunohost en utilisant les autres méthodes
[Ventoy](https://www.ventoy.net/) est un outil pratique qui permet de mettre plusieurs images Linux sur une même clé USB et démarrer ces images sans devoir re-flasher la clé USB à chaque fois. C'est aussi pratique pour démarer une image qui refuse de démarrer: Ventoy réussi habituellement à tout démarrer!
1. Installer [Ventoy](https://www.ventoy.net/) sur la clé USB. Référez-vous aux [instructions d'installation](https://www.ventoy.net/en/doc_start.html).
- Cela va créer 2 partition sur la clé USB.
3. En utilisant votre application de fichiers préférée, copiez l'image Yunohost sur la grande partition "Ventoy (pas celle "VTOYEFI")
- N'utilisez pas *Balena Etcher*, USBImager ou `dd` pour faire ça!
Insérez cette clé USB dans l'ordinateur et démarrez en utisant celle-ci. Ventoy va apparaitre et lister toutes les images qui sont sur la clé USB. Sélectionnez l'image de Yunohost. Sélectionnez ensuite "GRUB2" comme option de démarrage (ou utilisez n'importe laquelle qui fonctionnera sur votre ordinateur 😉)
[/ui-tab]
{% endif %}
[/ui-tabs]
@ -372,7 +383,7 @@ Allez dans **Réglages** > **Réseau** :
## [fa=plug /] Démarrer la carte
* Branchez le câble Ethernet (un côté sur votre box, l'autre côté à votre carte).
* Pour les utilisateurs et utilisatrices souhaitant configurer la carte pour la connecter via le WiFi à la place, voir [cet exemple](https://www.raspberrypi.org/documentation/configuration/wireless/wireless-cli.md).
* Pour les utilisateurs et utilisatrices souhaitant configurer la carte pour la connecter via le WiFi à la place, voir [cet exemple](https://www.raspberrypi.com/documentation/computers/configuration.html#connect-to-a-wireless-network) ([ou là avant YunoHost12/bookworm](https://www.raspberryme.com/configurer-le-wifi-sur-un-pi-manuellement-a-laide-de-wpa_supplicant-conf/).
* Mettez la carte SD dans le serveur.
* (Facultatif) Il est possible de brancher un écran et un clavier sur votre serveur en cas de soucis, pour vérifier que le processus de démarrage (boot) se passe bien, ou encore pour avoir un accès direct en console.
* Branchez l'alimentation.
@ -393,8 +404,10 @@ Démarrez votre machine virtuelle après avoir sélectionné l'image YunoHost.
* Branchez le câble Ethernet (un côté à votre box, de l'autre côté à votre carte).
* Démarrez votre serveur avec la clé USB ou le CD-ROM inséré, et sélectionnez-le comme **périphérique de démarrage (bootable device)** en pressant l’une des touches suivantes (dépendant de votre ordinateur) :
`<ESC>`, `<F9>`, `<F10>`, `<F11>`, `<F12>` or `<DEL>`.
`<F9>`, `<F10>`, `<F11>`, `<F12>`, `<DEL>`, `<ESC>` ou <Alt>.
* N.B. : si le serveur était précédemment installé avec une version récente de Windows (8+), vous devez d'abord demander à Windows de « redémarrer réellement ». Vous pouvez le faire dans une option du menu « Options de démarrage avancées ».
!!! Si vous n'arrivez pas à démarrer l'image Yunohost, essayez d'utiliser Ventoy (sélectionnez "Ventoy" dans la section "Flasher l'image YunoHost" ci-dessus).
{% endif %}
{% if regular or virtualbox %}
@ -458,6 +471,7 @@ Ne perdez pas de vue que:
[/ui-tab]
[/ui-tabs]
!!! Si l'installation de Yunohost échoue sur votre machine et que vous n'arrivez pas à résoudre le problème, sachez qu'il est aussi possible d'installer Debian et ensuite d'installer Yunohost dessus. Pour les instructions, au sommet de cette page, sélectionnez "Serveur distant" puis "VPS ou serveur dédié avec Debian".
{% endif %}

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

@ -468,6 +468,17 @@ For older devices, you might want to burn a CD/DVD. The software to use depends
* On GNU/Linux, you have plenty of choices, like [Brasero](https://wiki.gnome.org/Apps/Brasero) or [K3b](http://www.k3b.org/)
[/ui-tab]
[ui-tab title="Using Ventoy"]
Ventoy will be useful if you can't sucessfully boot the Yunohost image using the other methods.
[Ventoy](https://www.ventoy.net/) is a nice tool that makes it really easy to put multiple linux images on a USB stick. When the computer refuses to boot from an image on a usb stick, Ventoy will usually be able to boot it anyway!
1. Install [Ventoy](https://www.ventoy.net/) on the USB stick. Refer to the [install instructions](https://www.ventoy.net/en/doc_start.html).
- This will create 2 partitions on the stick.
3. Using your favorite file explorer app, copy the Yunohost image file on the big `Ventoy` partition (not "VTOYEFI")
- Don't use *Balena Etcher*, USBImager or `dd` for this!
Later, when you'll boot the computer using this usb stick, Ventoy will appear and will list the images on the USB stick. Select the Yunohost image, then select GRUB2 launch option (or use whichever works for your computer 😉)
[/ui-tab]
{% endif %}
[/ui-tabs]
@ -505,7 +516,7 @@ Go to **Settings** > **Network**:
## [fa=plug /] Power up the board
* Plug the ethernet cable (one side on your main router, the other on your board).
* For advanced users willing to configure the board to connect to WiFi instead, see for example [here](https://www.raspberrypi.org/documentation/configuration/wireless/wireless-cli.md).
* For advanced users willing to configure the board to connect to WiFi instead, see for example [here](https://www.raspberrypi.com/documentation/computers/configuration.html#connect-to-a-wireless-network) ([or here prior to YunoHost12/bookworm](https://www.raspberryme.com/configurer-le-wifi-sur-un-pi-manuellement-a-laide-de-wpa_supplicant-conf/).
* Plug the SD card in your board
* (Optional) You can connect a screen+keyboard directly on your board if you want to troubleshoot the boot process or if you're more comfortable to "see what happens" or want a direct access to the board.
* Power up the board
@ -526,9 +537,11 @@ Start the virtual machine after selecting the YunoHost image.
## [fa=plug /] Boot the machine on your USB stick
* Plug the ethernet cable (one side on your main router, the other on your server).
* Boot up your server with the USB stick or a CD-ROM inserted, and select it as **bootable device** by pressing one of the following keys (hardware specific):
`<ESC>`, `<F9>`, `<F10>`, `<F11>`, `<F12>` or `<DEL>`.
* Boot up your server with the USB stick or a CD-ROM inserted, and select it as **bootable device**. Depending on your hardware, you will need to press one of the following keys:
`<F9>`, `<F10>`, `<F11>`, `<F12>`, `<DEL>`, `<ESC>` or `<Alt>`.
* N.B. : if the server was previously installed with a recent version of Windows (8+), you first need to tell Windows, to "actually reboot". This can be done somewhere in "Advanced startup options".
!!! If you can't boot the Yunohost image, try using Ventoy (select "Ventoy" in the section "Flash the YunoHost image" above).
{% endif %}
{% if regular or virtualbox %}
@ -592,6 +605,8 @@ Keep in mind that:
[/ui-tab]
[/ui-tabs]
!!! If the Yunohost installer fails and you can't solve the issue, know that it's also possible to install Debian and then install Yunohost on top. For instructions, at the top of this page, select "Remote server", then "VPS or dedicated server with Debian".
{% endif %}

2
pages/02.administer/15.admin_guide/55.upgrade/15.buster_bullseye/buster_bullseye_migration.md
View file

@ -120,5 +120,5 @@ If you can't restore your app but your system has been restored, you probably sh
yunohost tools regenconf nginx --force
```
After that you should be able to restore your apps. Don't forget to force upgrade theme if you have 502 errors.
After that you should be able to restore your apps. Don't forget to force upgrade them if you have 502 errors.

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

@ -31,9 +31,10 @@ Voici des sites qui proposent un service de DynDNS gratuitement :
* [DNSexit](https://www.dnsexit.com/Direct.sv?cmd=dynDns)
* [No-IP](https://www.noip.com/remote-access)
* [ChangeIP](https://changeip.com)
* [DynDNS (en italien)](https://dyndns.it)
* [DynDNS.it (en italien, payant)](https://dyndns.it)
* [DynDNS avec votre propre nom de domaine](https://github.com/opi/DynDNS-with-HE.NET)
* [Duck DNS](https://www.duckdns.org/)
* [ydns.io (en anglais, gratuit)](https://ydns.io/)
* [ydns.io](https://ydns.io/)
Créer un compte chez l’un d’eux.

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

@ -15,7 +15,7 @@ Dopo aver applicato le configurazioni proposte in questo tutorial la redirezione
La configurazione che adotteremo consiste nel rendere automatica la comunicazione del router al servizio di DNS dinamico la variazione dell'indirizzo IP pubblico e che la zona DNS può essere aggiornata.
### Registrar
### Registrars
Di seguito un elenco, non esaustivo, dei registrar. Qui potere acquistare il vostro dominio:
* [OVH](http://ovh.com/)
@ -33,7 +33,8 @@ Di seguito un elenco, non esaustivo, di offerte dei servizi DynDNS:
* [DNSexit](https://www.dnsexit.com/Direct.sv?cmd=dynDns)
* [No-IP](https://www.noip.com/remote-access)
* [ChangeIP](https://changeip.com/)
* [DynDNS (in italiano)](https://dyndns.it/)
* [DynDNS.it (in italiano, a pagamento)](https://dyndns.it/)
* [DynDNS con il suo nome di dominio](https://github.com/opi/DynDNS-with-HE.NET)
* [Duck DNS](https://www.duckdns.org/)
* [ydns.io](https://ydns.io/)

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

@ -31,9 +31,10 @@ Here are sites which offer a DynDNS service free of charge:
* [DNSexit](https://www.dnsexit.com/Direct.sv?cmd=dynDns)
* [No-IP](https://www.noip.com/remote-access)
* [ChangeIP](https://changeip.com)
* [DynDNS (in italian)](https://dyndns.it)
* [DynDNS with your own domain](https://github.com/jodumont/DynDNS-with-HE.NET)
* [DynDNS.it (in italian, paid plan)](https://dyndns.it)
* [DynDNS with your own domain](https://github.com/opi/DynDNS-with-HE.NET)
* [Duck DNS](https://www.duckdns.org/)
* [ydns.io](https://ydns.io/)
Register to one of them. It should provide you with one (or more) IP address to reach the service, and a login (that you may be able to self-define).

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

@ -68,9 +68,10 @@ Sources
Depuis n'importe quel GNU/Linux récent, vous devriez pouvoir utiliser le gestionnaire de fichiers pour accéder à votre serveur.
Nautilus de Gnome3 intègre de base des fonctionnalités similaires à FileZilla :
Nautilus de Gnome3 et Dolphin de KDE intègrent de base des fonctionnalités similaires à FileZilla :
* <https://help.gnome.org/users/gnome-help/stable/nautilus-connect.html.en>
* <https://docs.kde.org/stable5/en/dolphin/dolphin/location-bar.html#location-bar-editable-kioslaves>
* <https://www.techrepublic.com/article/how-to-use-linux-file-manager-to-connect-to-an-sftp-server/>
### Sous Windows

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

@ -68,9 +68,10 @@ Sources
From any recent GNU/Linux, you should be able to use the `file manager` to reach your server.
Nautilus from Gnome3 has features similar to FileZilla, out of the box.
Nautilus from Gnome3 and Dolphin from KDE have features similar to FileZilla, out of the box.
* <https://help.gnome.org/users/gnome-help/stable/nautilus-connect.html.en>
* <https://docs.kde.org/stable5/en/dolphin/dolphin/location-bar.html#location-bar-editable-kioslaves>
* <https://www.techrepublic.com/article/how-to-use-linux-file-manager-to-connect-to-an-sftp-server/>
### Windows

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

@ -238,7 +238,7 @@ Use Ctrl+X then `y` to save.
You can then try rebooting the system to check if the disk and subfolders are mounted automatically.
## 7. Clean up old data
Once your new setup is validated, you can proceed to delete the old data from step 6.3:
Once your new setup is validated, you can proceed to delete the old data from step 5.3:
```bash
rm -Rf /home/yunohost.app.bkp

3
pages/02.administer/45.tutorials/60.security/security.fr.md
View file

@ -62,6 +62,7 @@ sudo yunohost settings set security.ssh.password_authentication -v no
Pour éviter des tentatives de connexion SSH par des robots qui scannent tout Internet pour tenter des connexions SSH avec tout serveur accessible, on peut modifier le port SSH.
C'est géré par un paramètre système, qui se charge de configurer les services SSH et Fail2Ban.
Il n'est pas utile de modifier ce port si vous avez désactivé l'authentification par mot de passe.
```bash
sudo yunohost settings set security.ssh.port -v <votre_numero_de_port_ssh>
@ -84,11 +85,13 @@ La configuration TLS par défaut des services tend à offrir une bonne compatibi
Changer le niveau de compatibilité n'est pas définitif et il est possible de rechanger le paramètre si vous concluez qu'il faut revenir en arrière.
**Sur votre serveur**, modifiez la politique pour NGINX :
```bash
sudo yunohost settings set security.nginx.compatibility -v modern
```
**Sur votre serveur**, modifiez la politique pour SSH :
```bash
sudo yunohost settings set security.ssh.compatibility -v modern
```

4
pages/02.administer/45.tutorials/60.security/security.md
View file

@ -51,12 +51,14 @@ Type your admnistration password and your key will be copied onto your server.
```bash
sudo yunohost settings set security.ssh.password_authentication -v no
```
---
### Modify the SSH port
To prevent SSH connection attempts by robots that scan the internet for any server with SSH enabled, you can change the SSH port.
This is handled by a system setting, which takes care of updating the SSH and Fail2Ban configuration.
There's no need to change this port if you've disabled password authentication.
! If you modify anything in the `/etc/ssh/sshd_config` file, even if only the port, YunoHost will no longer manage this file. For this reason, always use the YunoHost admin tools to make changes to the systems configuration files!
@ -81,11 +83,13 @@ The default TLS configuration for services tends to offer good compatibility to
Changing the compatibility level is not definitive and can be reverted if it doesn't fit with your environment.
**On your server**, change the policy for NGINX
```bash
sudo yunohost settings set security.nginx.compatibility -v modern
```
**On your server**, change the policy for SSH
```bash
sudo yunohost settings set security.ssh.compatibility -v modern
```

2
pages/02.administer/50.troubleshooting/10.admin_password/change_admin_password.it.md
View file

@ -22,5 +22,5 @@ Poi vai su Strumenti > Cambia password amministrazione.
```bash
yunohost tools adminpw
yunohost tools rootpw
```

11
pages/02.administer/55.providers/05.registrar/namecheap/autodns.md Normal file
View file

@ -0,0 +1,11 @@
[API Documentation](https://www.namecheap.com/support/api/intro/)
> 1. Login to your Namecheap account.
>
> 2. Go to the Profile > Tools menu.
>
> 3. Scroll down to the Business & Dev Tools section. Click on MANAGE next to Namecheap API Access.
>
> 4. Toggle ON/OFF, read our Terms of Service, enter your account password.
>
> 5. After enabling API access, you will be allotted an APIKey. Your Namecheap account username will act as API username. Your access to the API is authenticated using these elements.

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

@ -27,4 +27,4 @@ The list below can help you to choose a registrar if you plan to buy a domain na
| --------- | ------------- | ------------------ |
| [Gandi](https://www.gandi.net) | ✔ (tested) | ✔ | [Obtain an API key](/providers/registrar/gandi/autodns) |
| [OVH](https://www.ovh.com/domaines/) | ✔ (tested) | ✘ | [Obtain an API key](/providers/registrar/ovh/autodns) <br> [Configure manually](/providers/registrar/ovh/manualdns) |
| [Namecheap](https://www.namecheap.com/) | ✘ (in lexicon but untested) | ✘✘✘ API not available without 50$ on the account | |
| [Namecheap](https://www.namecheap.com/) | ✘ (in lexicon but untested) | ✘✘✘ API not available without 50$ on the account | [Obtain an API key](/providers/registrar/namecheap/autodns)|

2
pages/02.administer/55.providers/10.isp/isp.md
View file

@ -32,7 +32,7 @@ Here is a non-comprehensive list of internet service providers by country, which
* [South Korea](/isp/country:kor)
[/ui-tab]
[ui-tab title="Europa"]
[ui-tab title="Europe"]
* [Belgium (nl)](/isp/country:belnl)
* [Belgium (fr)](/isp/country:belfr)

2
pages/02.administer/55.providers/15.vpn/vpn.md
View file

@ -51,7 +51,7 @@ Below, you can find a list of providers compatible for self-hosting and especial
| [Igwan.net](https://igwan.net) | ✘ (L2TP/IPSec) | ? | ? | ? | 4 ou 8€ / mois | ? / an | <span class="ffdn">FFDN</span> <span class="label label-success label-as-badge">Non Profit</span> |
| [Illyse](https://www.illyse.net/acces-internet-par-vpn/) | ✔ (manuelle) | ✔ | ✔ | ✔ | 6 ou 8€ / mois | 20€ / an | <span class="ffdn">FFDN</span> <span class="label label-success label-as-badge">Non Profit</span> |
| [ILOTH](https://iloth.net/vpn/) | ✔ (.cube) | ✘ | ✔ | ✘ | 80€ / an | 5 à 100€ / an | <span class="ffdn">FFDN</span> <span class="label label-success label-as-badge">Non Profit</span> |
| [Milkywan](https://milkywan.fr/prices#popupTunnel) | ✔ (manuelle) | ✔ | ✔ | ✔ | 5 € / mois | incluse | |
| [Milkywan](https://milkywan.fr/prices#popupTunnel) | ✔ (manuelle) | ✔ | ✔ | ✔ | 5 € / mois | incluse | <span class="label label-success label-as-badge">Non Profit</span> |
| [Mycélium](https://mycelium-fai.org/wiki/documentation/services/vpn) | ✔ (manuelle) | ✘ | ✘ | ✘ | Prix libre | incluse<br>Réservé aux nordistes(FR 59) | <span class="ffdn">FFDN</span> <span class="label label-success label-as-badge">Non Profit</span> |
| [Neutrinet](https://neutrinet.be/en/vpn) | ✔ (.cube + [internetcube](https://internetcu.be)) | ✔ | ✔ | ? | ~8 €¹ / mois | incluse | <span class="ffdn">FFDN</span> <span class="label label-success label-as-badge">Non Profit</span> |
| [Rézine](https://www.rezine.org/acces_internet/tunnels_chiffr%C3%A9s/) | ✔ (manuelle) | ✔ | ✔ | ✔ | 5 à 10€ / mois | Prix libre | <span class="ffdn">FFDN</span> <span class="label label-success label-as-badge">Non Profit</span> |

4
pages/02.administer/60.extend/05.install_unpackaged_app/install_unpackaged_app.md
View file

@ -13,11 +13,11 @@ If your app is a PHP or HTML/JS app, you probably should use the `Custom Webapp`
## Other technologies
If you use an other techno, you should install it like on a classical debian.
If you use some other technology, you should install it like on a classical debian.
To expose the app on the web through nginx and be able to manage access permissions to the webapp, you could use the [`redirect` app](https://github.com/YunoHost-Apps/redirect_ynh/) to create a nginx reverse proxy on your local ip/port running the service.
!!! You should use the proxy mode of the redirect app and not HTTP redirections mode.
You probably should create custom backup and restore hooks to integrate your app to your YunoHost backup/restore process. See [Backup and restore hooks]()
You probably should create custom backup and restore hooks to integrate your app to your YunoHost backup/restore process. See [Backup and restore hooks](/packaging_apps_hooks#backup-restore)

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

@ -34,6 +34,7 @@ Pour configurer manuellement un nouveau compte dans Thunderbird commencez par re
* [Gérer les alias mails](https://support.mozilla.org/en-US/kb/configuring-email-aliases)
[/ui-tab]
[ui-tab title="K-9 Mail"]
##### ![](image://k9mail.png?resize=50&classes=inline) Configurer K-9 Mail (sur Android)
@ -45,6 +46,7 @@ Suivez les instructions suivantes (comme pour Thunderbird, il vous faudra peut-
![](image://k9mail_config_4.png?resize=280&classes=inline)
[/ui-tab]
[ui-tab title="Dekko"]
##### ![](image://dekko-app.png?resize=50&classes=inline) Configurer Dekko (sur Ubuntu Touch)

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

@ -11,9 +11,9 @@ routes:
[![Install Baïkal with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=baikal) [![Integration level](https://dash.yunohost.org/integration/baikal.svg)](https://dash.yunohost.org/appci/app/baikal)
Baïkal is a server for calendars and address books, which uses the CalDav and CardDav protocol. Baïkal can be synced with a lot of clients, like Thunderbird + Lightning.
Baïkal is a server for calendars and address books, which uses the CalDAV and CardDAV protocol. Baïkal can be synced with a lot of clients, like Thunderbird + Lightning.
**WARNING**: Baïkal will not work if you have installed a **Nextcloud** (the Nextcloud CardDav/CalDav functions conflict).
**WARNING**: Baïkal will not work if you have installed a **Nextcloud** (the Nextcloud CardDAV/CalDAV functions conflict).
## Configuration
@ -28,25 +28,31 @@ By default, Baïkal is configured to look for users in YunoHost's LDAP
directory. YunoHost's users will appear under `User and ressources` menu after their
first authentication.
### CalDAV/CardDAV access
To be able to connect CalDAV or CardDAV clients to Baïkal, you must allow access to the app for visitors during installation.
Clients will still need to to authenticate with username and password of an YNH user.
Also note that the admin interface of Baïkal is always available only to logged-in YNH admin users.
## CalDAV connection
### Connecting Thunderbird with Lightning
Add a new agenda with type "Network" and "CalDAV"
The new URL to add is:
https://domain.org/baikal/cal.php/calendars/username/default
Be careful to replace "domain.org" with your own domain and the "username" with your username.
- Open the Calendar view, select "New Calendar...".
- Choose "On the Network", click "Next".
- Type in your YNH username in the "Username" input field and your server's "https://domain.tld" in the "Location" input field.
- (You only need to enter the domain, Baïkal configures the webserver to forward CalDAV and CardDAV requests to Baïkal.)
- Click "Find Calendars" and enter your YNH user's password.
- If this is the first time your YNH user logs in to Baïkal, a "Default Calendar" is automatically created for you.
- Select the calendar you want to add to Thunderbird and click "Subscribe".
### Connecting to AgenDAV
AgenDAV is a web client for using your calendars. It's packaged for YunoHost and you can used it after installing Baïkal.
AgenDAV is a web client for using your calendars. It's packaged for YunoHost and you can use it after installing Baïkal.
AgenDAV is already connected to Baïkal, any other configuration is necessary. If you create a new entry in Thunderbird + Lightning calendar, refresh your AgenDAV page is enough to see your modifications.
AgenDAV is already connected to Baïkal, no other configuration is necessary. If you create a new entry in Thunderbird + Lightning calendar, refreshing your AgenDAV page is enough to see your modifications.
AgenDAV also allows you to create a new calendars very easily.
AgenDAV also allows you to create new calendars very easily.
## CardDAV Connection

3
pages/05.community/10.chat_rooms/chat_rooms.md
View file

@ -7,13 +7,14 @@ routes:
default: '/chat_rooms'
---
Amoung other communication tools, YunoHost project use chat rooms to communicate.
Among other communication tools, YunoHost project use chat rooms to communicate.
You could join those chat rooms using:
- an [IRC Client](https://en.wikipedia.org/wiki/Comparison_of_Internet_Relay_Chat_clients) for example [KiwiIRC](https://web.libera.chat/#yunohost)
- an [XMPP client](https://en.wikipedia.org/wiki/Comparison_of_instant_messaging_clients)
- a [Matrix client](https://matrix.org/docs/guides/faq.html#what-clients-are-available%3F)
**NB: Currently, the IRC bridge ([due to Matrix](https://libera.chat/guides/faq#are-bridges-allowed)) is disabled. So while the XMPP and Matrix are bridged, the IRC channel is not.**
#### Help and support chat room

2
pages/06.contribute/05.write_documentation/03.git/doc_use_git.md
View file

@ -39,7 +39,7 @@ When you've already create a Pull Request (PR), changes to your development bran
YunoHost has a specific Git repository to collect issues: [github.com/YunoHost/issues](https://github.com/YunoHost/issues)
An issue, also called a ticket, is an identified problem or a development wish; in this case for documentation, but it is valid for any software repository. Within the framework of the YunoHost documentation it will be mainly proposed issues for the development of the documentation, the identified problems being easily correctable.
## Going further with Git and working on his workstation
## Going further with Git and working on your workstation
Using the power of Git to work on your personal computer means you don't have to create a `commit` each time you save modified documentation pages. It also allows you to use tools and software that make it easier to distinguish between tags used in a documentation page.
- Online resource: [docs.microsoft.com - Setting up a Git repository locally for documentation](https://docs.microsoft.com/fr-fr/contribute/get-started-setup-local)

4
pages/06.contribute/10.packaging_apps/30.doc/doc.md
View file

@ -7,7 +7,8 @@ routes:
default: '/packaging_app_doc'
---
Properly documenting your app is important for user experience ;). YunoHost provides several mechanism to display information to users.
Properly documenting your app is important for user experience ;).
YunoHost provides several mechanism to display information to users.
## Extensive description : `doc/DESCRIPTION.md` and `doc/screenshots/`
@ -34,6 +35,7 @@ These notes will be available in the app info page in the webadmin after the app
## Pre/post-install notes, pre/post-upgrade notes
Sometimes, you may want to display important information to the admin at key points in the app's life cycle. You can do so by providing special markdown files:
- `doc/PRE_INSTALL.md`: displayed right before the installation (for example to warn that « This app install is expected to take around 30 minutes, be patient! » or « This app will automatically add 1GB swap to your system »)
- NB: try to not overlap with the anti-feature tags from the catalog (cf Publishing your app in the catalog) which can be used to warn that the app's upstream is alpha-stage or deprecated among other things.
- `doc/POST_INSTALL.md`: displayed in a popup after the installation AND a dismissable note in the webadmin app info view.

243
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'
---
Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/doc/generate_helper_doc.py) on 27/11/2023 (YunoHost version 11.2.7)
Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/doc/generate_helper_doc.py) on 01/03/2024 (YunoHost version 11.2.10.3)
## APPS
@ -25,7 +25,7 @@ Requires YunoHost version *.*.* or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/apps#L9)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apps#L9)
[/details]
----------------
@ -41,7 +41,7 @@ Requires YunoHost version *.*.* or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/apps#L65)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apps#L65)
[/details]
----------------
@ -70,7 +70,7 @@ If the app relies on a specific PHP version, then `php` will be aliased that ver
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/apps#L128)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apps#L128)
[/details]
----------------
@ -94,7 +94,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/apt#L53)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L53)
[/details]
----------------
@ -115,7 +115,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/apt#L75)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L75)
[/details]
----------------
@ -129,7 +129,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/apt#L107)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L107)
[/details]
----------------
@ -146,7 +146,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/apt#L117)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L117)
[/details]
----------------
@ -163,7 +163,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/apt#L128)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L128)
[/details]
----------------
@ -180,7 +180,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/apt#L138)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L138)
[/details]
----------------
@ -197,7 +197,7 @@ Requires YunoHost version 2.7.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/apt#L148)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L148)
[/details]
----------------
@ -219,7 +219,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/apt#L225)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L225)
[/details]
----------------
@ -236,7 +236,7 @@ Requires YunoHost version 3.8.1 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/apt#L338)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L338)
[/details]
----------------
@ -252,7 +252,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/apt#L357)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L357)
[/details]
----------------
@ -272,7 +272,7 @@ Requires YunoHost version 3.8.1 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/apt#L391)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L391)
[/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/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/backup#L64)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/backup#L64)
[/details]
----------------
@ -359,7 +359,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/backup#L179)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/backup#L179)
[/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/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/backup#L238)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/backup#L238)
[/details]
----------------
@ -423,7 +423,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/backup#L306)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/backup#L306)
[/details]
----------------
@ -445,7 +445,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/backup#L357)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/backup#L357)
[/details]
----------------
@ -464,7 +464,7 @@ Requires YunoHost version 3.3.1 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/backup#L397)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/backup#L397)
[/details]
----------------
@ -487,7 +487,7 @@ Requires YunoHost version 2.7.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/backup#L432)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/backup#L432)
[/details]
----------------
@ -510,7 +510,7 @@ Requires YunoHost version 2.7.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/backup#L480)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/backup#L480)
[/details]
----------------
@ -585,7 +585,7 @@ Requires YunoHost version 4.1.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/fail2ban#L62)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/fail2ban#L62)
[/details]
----------------
@ -599,7 +599,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/fail2ban#L134)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/fail2ban#L134)
[/details]
----------------
@ -627,7 +627,7 @@ Requires YunoHost version 3.8.1 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/hardware#L13)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/hardware#L13)
[/details]
----------------
@ -650,7 +650,7 @@ Requires YunoHost version 3.8.1 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/hardware#L75)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/hardware#L75)
[/details]
----------------
@ -671,7 +671,7 @@ Requires YunoHost version 2.4.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/logging#L10)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L10)
[/details]
----------------
@ -688,7 +688,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/logging#L30)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L30)
[/details]
----------------
@ -705,7 +705,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/logging#L56)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L56)
[/details]
----------------
@ -722,7 +722,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/logging#L73)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L73)
[/details]
----------------
@ -741,7 +741,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/logging#L92)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L92)
[/details]
----------------
@ -760,7 +760,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/logging#L113)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L113)
[/details]
----------------
@ -779,7 +779,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/logging#L134)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L134)
[/details]
----------------
@ -798,7 +798,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/logging#L155)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L155)
[/details]
----------------
@ -817,7 +817,7 @@ Requires YunoHost version 3.2.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/logging#L176)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L176)
[/details]
----------------
@ -836,7 +836,7 @@ Requires YunoHost version 11.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/logging#L197)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L197)
[/details]
----------------
@ -856,7 +856,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/logging#L257)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L257)
[/details]
----------------
@ -871,7 +871,7 @@ Requires YunoHost version 3.6.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/logging#L345)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L345)
[/details]
----------------
@ -881,26 +881,21 @@ Requires YunoHost version 3.6.0 or higher.
#### ynh_use_logrotate
[details summary="<i>Use logrotate to manage the logfile</i>" class="helper-card-subtitle text-muted"]
**Usage**: `ynh_use_logrotate [--logfile=/log/file] [--nonappend] [--specific_user=user/group]`
**Usage**: `ynh_use_logrotate [--logfile=/log/file] [--specific_user=user/group]`
**Arguments**:
- `-l`, `--logfile=`: absolute path of logfile
- `-n`, `--nonappend`: (optional) Replace the config file instead of appending this new config.
- `-u`, `--specific_user=`: run logrotate as the specified user and group. If not specified logrotate is runned as root.
**Details**:<br/>
If no `--logfile` is provided, `/var/log/$app` will be used as default.
`logfile` can point to a directory or a file.
It's possible to use this helper multiple times, each config will be added to
the same logrotate config file. Unless you use the option `--non-append`
Requires YunoHost version 2.6.4 or higher.
Requires YunoHost version 3.2.0 or higher for the argument `--specific_user`
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/logrotate#L18)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logrotate#L15)
[/details]
----------------
@ -914,7 +909,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/logrotate#L110)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logrotate#L99)
[/details]
----------------
@ -931,7 +926,7 @@ Requires YunoHost version 4.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/multimedia#L11)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/multimedia#L11)
[/details]
----------------
@ -951,7 +946,7 @@ Requires YunoHost version 4.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/multimedia#L64)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/multimedia#L64)
[/details]
----------------
@ -968,7 +963,7 @@ Requires YunoHost version 4.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/multimedia#L93)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/multimedia#L93)
[/details]
----------------
@ -1001,7 +996,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/mysql#L15)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/mysql#L15)
[/details]
----------------
@ -1019,7 +1014,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/mysql#L36)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/mysql#L36)
[/details]
----------------
@ -1037,7 +1032,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/mysql#L60)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/mysql#L60)
[/details]
----------------
@ -1058,7 +1053,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/mysql#L128)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/mysql#L128)
[/details]
----------------
@ -1077,7 +1072,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/mysql#L160)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/mysql#L160)
[/details]
----------------
@ -1099,7 +1094,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/mysql#L198)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/mysql#L198)
[/details]
----------------
@ -1117,7 +1112,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/mysql#L224)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/mysql#L224)
[/details]
----------------
@ -1141,7 +1136,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/network#L12)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/network#L12)
[/details]
----------------
@ -1162,7 +1157,7 @@ Requires YunoHost version 3.8.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/network#L36)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/network#L36)
[/details]
----------------
@ -1183,7 +1178,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/network#L99)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/network#L99)
[/details]
----------------
@ -1204,7 +1199,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/network#L119)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/network#L119)
[/details]
----------------
@ -1232,7 +1227,7 @@ Requires YunoHost version 4.1.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/nginx#L19)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/nginx#L19)
[/details]
----------------
@ -1246,12 +1241,12 @@ Requires YunoHost version 2.7.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/nginx#L41)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/nginx#L41)
[/details]
----------------
#### ynh_change_url_nginx_config
[details summary="<i>Move / regen the nginx config in a change url context</i>" class="helper-card-subtitle text-muted"]
[details summary="<i>Regen the nginx config in a change url context</i>" class="helper-card-subtitle text-muted"]
**Usage**: `ynh_change_url_nginx_config`
@ -1260,7 +1255,7 @@ Requires YunoHost version 11.1.9 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/nginx#L52)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/nginx#L52)
[/details]
----------------
@ -1314,7 +1309,7 @@ Requires YunoHost version 2.7.12 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/nodejs#L52)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/nodejs#L52)
[/details]
----------------
@ -1338,7 +1333,7 @@ Requires YunoHost version 2.7.12 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/nodejs#L92)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/nodejs#L92)
[/details]
----------------
@ -1356,7 +1351,7 @@ Requires YunoHost version 2.7.12 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/nodejs#L165)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/nodejs#L165)
[/details]
----------------
@ -1429,7 +1424,7 @@ Requires YunoHost version 3.7.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/permission#L66)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/permission#L66)
[/details]
----------------
@ -1448,7 +1443,7 @@ Requires YunoHost version 3.7.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/permission#L152)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/permission#L152)
[/details]
----------------
@ -1466,7 +1461,7 @@ Requires YunoHost version 3.7.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/permission#L169)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/permission#L169)
[/details]
----------------
@ -1489,7 +1484,7 @@ Requires YunoHost version 3.7.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/permission#L192)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/permission#L192)
[/details]
----------------
@ -1512,7 +1507,7 @@ Requires YunoHost version 3.7.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/permission#L260)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/permission#L260)
[/details]
----------------
@ -1533,7 +1528,7 @@ Requires YunoHost version 3.7.1 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/permission#L329)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/permission#L329)
[/details]
----------------
@ -1548,7 +1543,7 @@ Requires YunoHost version 4.1.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/permission#L359)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/permission#L359)
[/details]
----------------
@ -1559,7 +1554,7 @@ Requires YunoHost version 4.1.2 or higher.
**Example**: `if ynh_legacy_permissions_exists then ynh_legacy_permissions_delete_all # You can recreate the required permissions here with ynh_permission_create fi Requires YunoHost version 4.1.2 or higher.`
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/permission#L379)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/permission#L379)
[/details]
----------------
@ -1633,7 +1628,7 @@ Requires YunoHost version 4.1.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/php#L70)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/php#L70)
[/details]
----------------
@ -1647,7 +1642,7 @@ Requires YunoHost version 2.7.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/php#L284)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/php#L284)
[/details]
----------------
@ -1666,7 +1661,7 @@ Requires YunoHost version 4.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/php#L517)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/php#L517)
[/details]
----------------
@ -1686,7 +1681,7 @@ Requires YunoHost version 4.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/php#L549)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/php#L549)
[/details]
----------------
@ -1719,7 +1714,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/postgresql#L18)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/postgresql#L18)
[/details]
----------------
@ -1737,7 +1732,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/postgresql#L39)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/postgresql#L39)
[/details]
----------------
@ -1755,7 +1750,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/postgresql#L64)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/postgresql#L64)
[/details]
----------------
@ -1776,7 +1771,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/postgresql#L135)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/postgresql#L135)
[/details]
----------------
@ -1794,7 +1789,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/postgresql#L168)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/postgresql#L168)
[/details]
----------------
@ -1812,7 +1807,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/postgresql#L190)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/postgresql#L190)
[/details]
----------------
@ -1834,7 +1829,7 @@ Requires YunoHost version 2.7.13 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/postgresql#L234)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/postgresql#L234)
[/details]
----------------
@ -1852,7 +1847,7 @@ Requires YunoHost version 2.7.13 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/postgresql#L265)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/postgresql#L265)
[/details]
----------------
@ -1873,7 +1868,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/setting#L10)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/setting#L10)
[/details]
----------------
@ -1892,7 +1887,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/setting#L36)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/setting#L36)
[/details]
----------------
@ -1910,7 +1905,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/setting#L62)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/setting#L62)
[/details]
----------------
@ -1930,7 +1925,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/setting#L123)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/setting#L123)
[/details]
----------------
@ -1951,7 +1946,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/setting#L145)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/setting#L145)
[/details]
----------------
@ -1976,7 +1971,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/string#L13)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/string#L13)
[/details]
----------------
@ -1998,7 +1993,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/string#L40)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/string#L40)
[/details]
----------------
@ -2020,7 +2015,7 @@ Requires YunoHost version 2.7.7 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/string#L71)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/string#L71)
[/details]
----------------
@ -2043,7 +2038,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/string#L103)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/string#L103)
[/details]
----------------
@ -2069,7 +2064,7 @@ Requires YunoHost version 4.1.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/systemd#L15)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/systemd#L15)
[/details]
----------------
@ -2086,7 +2081,7 @@ Requires YunoHost version 2.7.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/systemd#L38)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/systemd#L38)
[/details]
----------------
@ -2108,7 +2103,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/systemd#L67)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/systemd#L67)
[/details]
----------------
@ -2132,7 +2127,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/user#L12)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/user#L12)
[/details]
----------------
@ -2154,7 +2149,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/user#L33)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/user#L33)
[/details]
----------------
@ -2172,7 +2167,7 @@ Requires YunoHost version 2.4.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/user#L53)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/user#L53)
[/details]
----------------
@ -2191,7 +2186,7 @@ Requires YunoHost version 2.2.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/user#L64)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/user#L64)
[/details]
----------------
@ -2210,7 +2205,7 @@ Requires YunoHost version 3.5.0.2 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/user#L82)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/user#L82)
[/details]
----------------
@ -2239,7 +2234,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/user#L111)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/user#L111)
[/details]
----------------
@ -2256,7 +2251,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/user#L153)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/user#L153)
[/details]
----------------
@ -2270,7 +2265,7 @@ Requires YunoHost version 4.1.7 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/user#L179)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/user#L179)
[/details]
----------------
@ -2291,7 +2286,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/utils#L61)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L61)
[/details]
----------------
@ -2383,7 +2378,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/utils#L154)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L154)
[/details]
----------------
@ -2409,7 +2404,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/utils#L399)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L404)
[/details]
----------------
@ -2467,7 +2462,7 @@ Requires YunoHost version 4.1.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/utils#L483)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L488)
[/details]
----------------
@ -2479,6 +2474,7 @@ Requires YunoHost version 4.1.0 or higher.
**Arguments**:
- `-f`, `--file=`: the path to the file
- `-k`, `--key=`: the key to get
- `-a`, `--after=`: the line just before the key (in case of multiple lines with the name of the key in the file)
**Details**:<br/>
This helpers match several var affectation use case in several languages
@ -2511,7 +2507,7 @@ Requires YunoHost version 4.3 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/utils#L637)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L646)
[/details]
----------------
@ -2524,13 +2520,14 @@ Requires YunoHost version 4.3 or higher.
- `-f`, `--file=`: the path to the file
- `-k`, `--key=`: the key to set
- `-v`, `--value=`: the value to set
- `-a`, `--after=`: the line just before the key (in case of multiple lines with the name of the key in the file)
**Details**:<br/>
Requires YunoHost version 4.3 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/utils#L714)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L724)
[/details]
----------------
@ -2546,7 +2543,7 @@ Requires YunoHost version 2.7.12 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/utils#L829)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L839)
[/details]
----------------
@ -2563,7 +2560,7 @@ Requires YunoHost version 2.6.4 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/utils#L860)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L870)
[/details]
----------------
@ -2583,7 +2580,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/utils#L894)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L904)
[/details]
----------------
@ -2608,7 +2605,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/utils#L937)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L947)
[/details]
----------------
@ -2631,7 +2628,7 @@ Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/utils#L966)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L976)
[/details]
----------------
@ -2646,15 +2643,11 @@ Requires YunoHost version 3.5.0 or higher.
This helper should be used to avoid an upgrade of an app, or the upstream part
of it, when it's not needed
You can force an upgrade, even if the package is up to date, with the `--force` (or `-F`) argument :
```
sudo yunohost app upgrade <appname> --force
```
Requires YunoHost version 3.5.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/utils#L991)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L997)
[/details]
----------------
@ -2686,7 +2679,7 @@ Requires YunoHost version 3.8.0 or higher.
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/helpers/utils#L1021)
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L1027)
[/details]
----------------

34
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'
---
Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/4897f72974fff30b168a40bf55bf917395cca4cc/doc/generate_resource_doc.py) on 27/11/2023 (YunoHost version 11.2.7)
Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/doc/generate_resource_doc.py) on 01/03/2024 (YunoHost version 11.2.10.3)
----------------
@ -280,18 +280,36 @@ Or more complex examples with several element, including one with asset that dep
Strictly speaking, this has nothing to do with the actual app install. `autoupdate` is expected to contain metadata for automatic maintenance / update of the app sources info in the manifest. It is meant to be a simpler replacement for "autoupdate" Github workflow mechanism.
The infos are used by this script : https://github.com/YunoHost/apps/blob/master/tools/autoupdate_app_sources/autoupdate_app_sources.py which is ran by the YunoHost infrastructure periodically and will create the corresponding pull request automatically.
The infos are used by this script : <https://github.com/YunoHost/apps/blob/master/tools/autoupdate_app_sources/autoupdate_app_sources.py> which is ran by the YunoHost infrastructure periodically and will create the corresponding pull request automatically.
The script will rely on the code repo specified in the upstream section of the manifest.
The script will rely on the code repo specified in `code` in the upstream section of the manifest.
`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_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:
The `autoupdate.strategy` is expected to be constructed like this: `latest_<gitforge>_<strategy>`
You need to replace the `<gitforge>` in the strategy name by either `github`, `gitlab`, `gitea` or `forgejo`, as the autoupdater supports:
- GitHub
- GitLab (official and self-hosted instances)
- Gitea & Forgejo instances
And choose one strategy in the following ones:
- `latest_<gitforge>_release` : similar to `latest_<gitforge>_tag`, but starting from the list of releases. Note that it's the only strategy that provides the changelog link in the PR message. 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
- 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_<gitforge>_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_<gitforge>_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 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.
If the upstream project provides non-standard tag or release names, you can fix this, with a regex with a matching group.
For example, if tags look like `release-v4.1`, put:
```toml
autoupdate.version_regex = "^release-v(.*)$"
```
And the autoupdater will use the matched group (here: `4.1`) as the version.
##### Provision/Update
- For elements with `prefetch = true`, will download the asset (for the appropriate architecture) and store them in `/var/cache/yunohost/download/$app/$source_id`, to be later picked up by `ynh_setup_source`. (NB: this only happens during install and upgrade, not restore)

29
pages/07.help/help.fr.md
View file

@ -7,31 +7,38 @@ routes:
default: '/help-me'
---
Bien que les contributeurs de YunoHost essaient continuellement de l'améliorer, YunoHost ou sa documentation ne sont exempts de bugs ou d'erreurs. Pour nous aider à vous aider, vous devez cependant suivre ces instructions.
Bien que les personnes contribuant à YunoHost essaient continuellement de l'améliorer, YunoHost ou sa documentation ne sont exempts de bugs ou d'erreurs. Pour nous aider à vous aider, vous devez cependant suivre ces instructions.
Le support n'est prodigué que sur [le forum](https://forum.yunohost.org?target=_blank) ou sur [nos salons de discussion](/chat_rooms?target=_blank).
Nous sommes présents sur Mastodon, mais nous ne prodiguons pas d'aide sur cette plateforme.
Nous avons un compte Mastodon, mais nous ne prodiguons pas d'aide sur cette plateforme.
Pour que nous puissions être en mesure de vous aider sur le forum, vous devez impérativement remplir le modèle de demande de support.
Pour que nous puissions être en mesure de vous aider sur le forum, vous devez impérativement remplir le modèle de demande de support qui s'affichera lors de la création du message.
# À faire
## Soyez courtois et patient
## Patience et courtoisie
L'aide dans les salons de discussion ou sur le forum est apportée par nos utilisateurs et contributeurs, tous bénévoles. Que vous soyiez peut-être pressé, ou épuisé par des essais infructueux... Faites une pause, buvez une gorgée de votre boisson apaisante préférée, puis poursuivez votre lecture. Nous avons besoin de vous dans un bon état d'esprit pour vous aider.
L'aide dans les salons de discussion ou sur le forum est apportée par des personnes entièrement bénévoles. Peut-être que vous-vous sentez sous pression, que les essais infructueux vous épuisent ou encore que de mauvaises émotions vous submergent... Faites une pause, buvez une gorgée de votre boisson apaisante préférée, soufflez, et une fois votre contenance revenue, poursuivez votre lecture. Nous avons besoin de vous dans un bon état d'esprit pour vous aider.
## Expliquez le contexte
Votre demande doit être formulée de manière complète mais concise. Expliquez clairement ce que vous voulez obtenir et en quoi cela ne fonctionne pas pour vous.
N'hésitez pas à fournir toute information qui peut être pertinente, même des choses qui peuvent sembler être une évidence, la ou les personnes qui vont essayer de vous aider auront peut-être besoin de ces informations.
## Montrez les erreurs et les journaux
Ceci est absolument primordial si YunoHost ou une commande échoue. YunoHost explique toujours pourquoi, que ce soit par un simple code d'erreur ou par un pavé de texte apparemment incompréhensible.
YunoHost fournit des boutons verts "Partager avec YunoPaste" lorsque quelque chose échoue ou dans la page Services de la webadmin. Cliquez dessus, ce qui ouvrira une nouvelle page web dont vous pourrez partager l'URL.
![YunoPaste button](image://yunopaste.png)
Il est recommandé de partager ces logs dans leur intégralité à l'aide du lien généré par YunoPaste.
Évitez les extraits de logs, une information déterminante est peut-être ailleurs.
Évitez aussi de les copier-coller de manière brutte dans le forum, car c'est désagréable de les parcourir comme ça, partagez le lien de YunoPaste.
![YunoPaste from install error](image://yunopaste_install.mp4?loop=1&controls=0&autoplay=1&muted)
![YunoPaste from service](image://yunopaste_service.mp4?loop=1&controls=0&autoplay=1&muted)
![Bouton YunoPaste](image://yunopaste.png)
![Vidéo indiquant qu'on peut trouver le bouton YunoPaste en bas à droite des pages de logs sur la web admin](image://yunopaste_install.mp4?loop=1&controls=0&autoplay=1&muted)
![Vidéo montrant qu'on peut partager un log depuis la web admin en allant dans Outils puis Services puis en sélectionnant le services dont on veut partager les logs](image://yunopaste_service.mp4?loop=1&controls=0&autoplay=1&muted)
Si votre problème n'est pas lié à un processus d'installation ou de mise à jour, mais plutôt à une application qui ne se charge pas correctement, vous pouvez déjà enquêter avec la console de votre navigateur (s'ouvrant avec la touche F12) : son onglet Réseau peut vous montrer les codes d'erreur HTTP (y compris les bien connus 403, 404, 500...), et sa Console peut également afficher des erreurs.
@ -40,14 +47,17 @@ Les captures d'écran sont les bienvenues.
# À ne pas faire
## Évitez le [problème XY](https://xyproblem.info/)
En résumé, expliquez la cause de votre problème. Vous pouvez faire part de votre tentative de solution, mais le *pourquoi* vous avez besoin de cette solution potentielle est le plus important.
## Ne soyez pas vague
Ne supposez pas que nous comprenons ce dont vous parlez, ne prenez pas de raccourcis, ne reformulez pas, ne simplifiez pas, n'éditorialisez pas les messages d'erreur.
N'écrivez pas "ça ne marche pas", "ça ne veut pas", "ça ne se charge pas", ou d'autres phrases vides de sens.
Expliquez ce qui ne va pas et comment cela apparaît à l'écran. Il y a, par exemple, une différence importante entre une page complètement blanche et une page blanche avec un code d'erreur, même minimaliste.
Expliquez ce qui ne va pas et comment cela apparaît à l'écran.
Il y a, par exemple, une différence importante entre une page complètement blanche et une page blanche avec un code d'erreur, même minimaliste.
## Ne tournez pas autour du pot
@ -56,4 +66,5 @@ Il n'est pas nécessaire de demander l'autorisation pour demander de l'aide. Il
Ne posez pas votre question comme un sondage, comme dans "Est-ce que quelqu'un a réussi à faire fonctionner l'application XY ?" Si cela ne fonctionne pas pour vous, expliquez directement le problème que vous avez rencontré, expliquez le contexte, partagez les logs.
## Ne soyez pas un trou du cul
L'accès au forum ou aux salons de discussion est un privilège qui peut être révoqué.

69
pages/07.help/help.it.md Normal file
View file

@ -0,0 +1,69 @@
---
title: Aiuto
template: docs
taxonomy:
category: docs
routes:
default: '/help-me'
---
Nonostante i collaboratori di YunoHost cerchino continuamente di migliorarlo, YunoHost e la sua documentazione non sono esenti da bug o errori. Per aiutarci ad aiutarvi, dovreste seguire queste istruzioni.
L'aiuto è fornito sul [forum](https://forum.yunohost.org?target=_blank) o sui [gruppi di discussione](/chat_rooms?target=_blank).
Ci trovate anche su Mastodon, ma non forniamo aiuto su questa piattaforma.
Affinché ci sia possibile aiutarvi, sul forum dovete porre le domande seguendo il modello proposto.
# Come fare
## Siate gentili e pazienti.
L'aiuto nei gruppi o sul forum viene fornito dai collaboratori e dagli utilizzatori, tutti volontari. A volte succede di avere fretta o essere stressati da tentativi infruttuosi... prendetevi una pausa, bevete un sorso della vostra bevanda rilassante preferita e poi rileggete. Abbiamo bisogno che siate in una buona condizione mentale per potervi aiutare.
## Spiegate il contesto.
La richiesta di aiuto deve essere posta in maniera completa e concisa. Spiegate chiaramente cosa volete ottenere e cosa non riuscite a fare.
## Riportate gli errori e i log
Di fondamentale importanza nelle richieste di aiuto è fornire log e messaggi di errore. Se un comando fallisce, YunoHost ci comunica sempre cosa succede, attraverso un codice di errore o un elenco di stringhe apparentemente incomprensibili.
Quando qualcosa non va come dovrebbe, trovate dei pulsanti di colore verde "Condividere con YunoPaste" nella pagina dei Servizi nella pagina webadmin. Cliccando sul pulsante si aprirà una pagina web della quale dovrete condividere l'URL.
![Bottone YunoPaste](image://yunopaste.png)
![YunoPaste da un errore di installazione](image://yunopaste_install.mp4?loop=1&controls=0&autoplay=1&muted)
![YunoPaste da service](image://yunopaste_service.mp4?loop=1&controls=0&autoplay=1&muted)
Se il vostro problema non è dovuto ad un processo di installazione o di aggiornamento, ma più probabilmente ad una app che non parte correttamente, potete iniziare ad indagare tramite la console del vostro browser (tasto F12): la scheda Rete riporterà i codici di errore HTTP (compresi e i ben noti 403, 404, 500...) e anche la Console riporterà gli errori.
Gli screenshot sono i benvenuti.
# Da non fare assolutamente
## Evitate il terribile [problema XY](https://xyproblem.info/)
In breve, spiegate quando si verifica il problema. Potete illustrare i tentativi intrapresi per risolverlo ma è importante spiegare ***perché*** avete bisogno di questa particolare soluzione.
## Non siate vaghi
Non date per scontato che le vostre spiegazioni siano comprese, non usate scorciatoie, non abbreviate, non semplificate. Non abbreviate i messaggi di errore.
Non scrivete "non funziona", "non si installa", "non carica" e ["lo dice il computer"](https://en.wikipedia.org/wiki/Computer_says_no).
Spiegate cosa non va e come l'errore si manifesta a schermo. C'è una differenza fondamentale, ad esempio, tra una pagina completamente bianca e una pagina completamente bianca con un codice di errore minimale.
## Non "menate il can per l'aia"
Non è necessario chiedere il permesso per chiedere aiuto. Trattandosi di una chat/forum di assistenza potete, ebbene sì, potete porre domande.
Non fate domande come fosse un sondaggio, ad esempio "Qualcuno è riuscito a fare andare l'applicazione XY?" Se riscontrate dei problemi con un'applicazione spiegate direttamente il problema riscontrato, illustrate il contesto e condividete i log.
## Non rompete le p...e
La partecipazione al forum e alle chat è un privilegio che può essere rimosso.

22
pages/07.help/help.md
View file

@ -12,25 +12,33 @@ Even though YunoHost contributors try to continuously perfect it, YunoHost itsel
Support is only available on [the forum](https://forum.yunohost.org?target=_blank) or our [chatrooms](/chat_rooms?target=_blank).
We are also on Mastodon, but we do not offer help on this platform.
To allow us to help you on the forum, you absolutely need to fill in the Support request template.
To allow us to help you on the forum, you absolutely need to fill in the Support request template, it will be displayed on message creation.
# Dos
## Be courteous and patient
Help in the chatrooms or on the forum is given by our users and contributors, all volunteers. You may be in a hurry, you may be exhausted by fruitless trials... Have a break, have a sip of your preferred soothing beverage, then continue reading. We need you in a good mindset to help you.
Help in the chatrooms or on the forum is given by our users and contributors, all volunteers. You may be in a hurry, you may be exhausted by fruitless trials or overwhelmed by unpleasant emotions... Have a break, have a sip of your preferred soothing beverage, breathe and once you've recovered your composure continue reading. We need you in a good mindset to help you.
## Explain the context
Your request needs to be stated in a complete but concise way. Explain plainly what you want to achieve and in what manner it is not working for you.
Don't hesitate to provide any information that may be relevant, even things that may seem obvious, as the person(s) who will be trying to help you may need this information.
## Show errors and logs
This is absolutely paramount if YunoHost or a command fails. It always explains why, through a single error code or a full wall of seemingly illegible text.
For the latter, YunoHost provides green "Share with YunoPaste" buttons when something fails or in the Services page of the webadmin. Click on it, it will open a new web page, and you can then share its URL.
We recommend that you share these logs in their entirety using the link generated by YunoPaste.
Avoid extracts from the logs, as decisive information may be elsewhere.
Also, avoid copying and pasting them into the forum, as it's unpleasant to go through them like that. Share the YunoPaste link.
![YunoPaste button](image://yunopaste.png)
![YunoPaste from install error](image://yunopaste_install.mp4?loop=1&controls=0&autoplay=1&muted)
![YunoPaste from service](image://yunopaste_service.mp4?loop=1&controls=0&autoplay=1&muted)
![Video showing that the YunoPaste button can be found in the bottom right-hand side of log pages on web admin](image://yunopaste_install.mp4?loop=1&controls=0&autoplay=1&muted)
![Video showing how to share a log from the web admin by going to Tools then Services then selecting the service whose logs you want to share](image://yunopaste_service.mp4?loop=1&controls=0&autoplay=1&muted)
If your issue is not related to an installation or upgrade process but instead is about an app failing load properly, ideally you can investigate with your browser console (opened with the F12 key): its Network tab can show you HTTP error codes (including the infamous 403, 404, 500...), and its Console can output errors too.
@ -39,14 +47,17 @@ Screenshots are most welcome.
# Don'ts
## Avoid the infamous [XY Problem](https://xyproblem.info/)
In a nutshell, explain the root cause of your issue. You may share your attempted solution, but explaining ***why*** you need that potential solution is more important.
## Do not be vague
Do not assume we understand what you are talking about, do not take shortcuts, do not rephrase, do not simplify, do not trim the error messages.
Do not write "it does not work", "it does not want", "it does not load", ["computer says no"](https://en.wikipedia.org/wiki/Computer_says_no).
Explain what is wrong, and how it is displayed onscreen. There is, for example, an important difference between a completely blank page and a blank page with a minimalistic error code.
Explain what is wrong, and how it is displayed onscreen.
There is, for example, an important difference between a completely blank page and a blank page with a minimalistic error code.
## Do not beat about the bush
@ -55,4 +66,5 @@ No need to ask if you can ask. It is a support chat/forum, therefore yes, you ca
Do not ask your question like a poll, as in "Did anyone managed to get app XY working?". If it is not working for you, then explain directly what issue you got, explain the context, share the logs.
## Do not be an asshole
Access to the forum or the chatrooms is a courtesy that can be revoked.