Pour tout problème contactez-nous par mail : support@froggit.fr | La FAQ :grey_question: | Rejoignez-nous sur le Chat :speech_balloon:

Skip to content
Snippets Groups Projects
README-FR.md 5.06 KiB
Newer Older
  • Learn to ignore specific revisions
  • # Rôle Ansible : Yunohost Configuration
    
    [🇬🇧 English version](README.md)
    
    Configurez [Yunohost](https://yunohost.org/#/) avec Ansible !
    
    ## Prérequis
    
    Yunohost doit déjà être installé sur votre serveur.
    
    ## Variables du rôle
    
    Les variables par défaut sont disponibles dans `default/main.yml` cependant il est possible de les surcharger selon vos besoins.
    
    ### Configuration d'un relais SMTP
    
    ```yml
    # paramètres personnalisés du relais SMTP
    ynh_smtp_relay:
        host: smtp.domain.tld
        port: 25
        user: user1
        password: Pa$$w0rd
    ```
    
    Yunohost possède son propre serveur SMTP natif mais il est aussi possible de configurer Yunohost pour qu'il utilise un relais SMTP à la place.
    Pour faire cela, créez la variable `ynh_smtp_relay` et mettez vos propres valeurs. Vous pouvez en apprendre plus sur les relais SMTP [ici](https://yunohost.org/fr/administrate/specific_use_cases/email_relay).
    
    
    ### Configuration des mises à jour de Yunohost
    
    
    ```yml
    # Autoupdate Yunohost and its apps
    ynh_autoupdate:
      scheduled: True
      special_time: "daily" #Choices are [annually,daily,hourly,monthly,reboot,weekly,yearly]
      apps: True
      system: True
      dest_script: "/usr/bin/"
    ```
    
    Une tâche cron peut être mise en place pour automatiser la vérification des mises à jour système et applications suivant la périodicité de votre choix.
    
    - `ynh_autoupdate.scheduled` : activez la tâche cron en mettant la valeur à `True`.
    - `ynh_autoupdate.special_time`: est obligatoire. Elle permet de préciser quand vous souhaitez que cette tâche soit exécutée. Valeurs possibles : (`annually`,`daily`,`hourly`,`monthly`,`reboot`,`weekly`,`yearly`). Pour en savoir plus sur les _special times_, cliquez [ici](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/cron_module.html).
    - `ynh_autoupdate.apps` : est obligatoire. Activez la mise à jour automatique des applications Yunohost en mettant la valeur à `True`.
    - `ynh_autoupdate.system` : est obligatoire. Activez la mise à jour automatique du système Yunohost en mettant la valeur à `True`.
    - `ynh_autoupdate.dest_script` : c'est le chemin du répertoire où le script de mise à jour sera installé sur le serveur. La valeur par défaut est `/usr/local/bin`. Le script s'appelle `ynh_autoupdate.sh`.
    
    Si des mises à jour sont disponibles, elles sont faites automatiquement. En cas de problème suite à la mise à jour d'une application, vous pouvez lire les logs qui sont disponibles ici `/var/log/yunohost/categories/operation`. Vous avez aussi la possibilité de revenir à la version précédente car Yunohost fait toujours une sauvegarde automatique d'une application lorsqu'elle est mise à jour.
    
    Pour en savoir plus sur le fonctionnement des mises à jour dans Yunohost vous pouvez vous rendre [ici](https://yunohost.org/fr/update). Le changelog des versions de Yunohost est aussi disponible [ici](https://forum.yunohost.org/tag/ynh_release).
    
    
    ### Configuration des mises à jour du système Debian
    
    ```yml
    ynh_autoupdate_scheduled:                  true
    hifis_ansible_unattended_upgrades_version: v2.0.1
    unattended_mail:                           "{{ admin_mail }}"
    unattended_mail_only_on_error:             true
    unattended_automatic_reboot:               true
    unattended_automatic_reboot_time:          01:00
    ```
    
    - `ynh_autoupdate_scheduled` : Activer la gestion automatique des mises à jour Debian en mettant la valeur à `true`. Par défaut, la valeur est à `false`. Attention, vous êtes responsables de vos actions sur le serveur. Cette gestion automatisée peut créer des problèmes inattendus avec YunoHost.
    - `hifis_ansible_unattended_upgrades_version` : Vous permet de spécifier la version du rôle Ansible unattended upgrades à utiliser. La version par défaut du rôle est v2.0.1. Vous pouvez vérifier les versions du rôle [ici](https://github.com/hifis-net/ansible-role-unattended-upgrades/releases).
    - `unattended_mail` : Adresse mail à utiliser pour envoyer des informations sur les mises à jour qui ont eu lieues ou s'il y a eu des problèmes. La valeur par défaut est à `false`, ce qui n'envoie pas de mails.
    - `unattended_mail_only_on_error` : Envoie un mail uniquement en cas d'erreur (valeur par défaut, `true`) ou envoie un mail à chaque mise à jour système (valeur à `false`).
    - `unattended_automatic_reboot` : Redémarre le système si des paquets mis à jour en ont besoin.
    - `unattended_automatic_reboot_time` : Vous permet de spécifier l'heure à laquelle redémarrer le système si des paquets mis à jour en ont besoin. L'heure par défaut est réglée à 1h du matin.
    Pour en savoir plus sur le fonctionnement de ce rôle, rendez vous [ici](https://github.com/hifis-net/ansible-role-unattended-upgrades).
    
    
    ## Dépendances
    
    Aucune.
    
    ## Exemple de Playbook
    
    ```yml
    ---
    - name: Configure Yunohost on Debian Server
      hosts: all
      become: True
    
        - lydra.yunohost.ynh_config
    
    ```
    
    ## License
    
    [![ansible-yunohost Copyright 2021 Lydra](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](https://choosealicense.com/licenses/gpl-3.0/)
    
    **ansible-yunohost** est maintenu par [Lydra](https://lydra.fr/) et publié sous la licence GPL3.