1
0
Fork 0

docs: apply Christophe suggestions for README

This commit is contained in:
Arthur BOUDREAULT 2022-05-19 12:20:37 +02:00
parent 23f458517c
commit 25cf95e439
9 changed files with 13 additions and 75 deletions

View file

@ -8,7 +8,7 @@
[![GitHub Release Date](https://img.shields.io/github/release-date/LydraFr/ansible-yunohost)](https://github.com/LydraFr/ansible-yunohost) [![GitHub Release Date](https://img.shields.io/github/release-date/LydraFr/ansible-yunohost)](https://github.com/LydraFr/ansible-yunohost)
[![GitHub Repo stars](https://img.shields.io/github/stars/LydraFr/ansible-yunohost?style=social)](https://github.com/LydraFr/ansible-yunohost) [![GitHub Repo stars](https://img.shields.io/github/stars/LydraFr/ansible-yunohost?style=social)](https://github.com/LydraFr/ansible-yunohost)
Collection Ansible - lydra.yunohost Collection Ansible - `lydra.yunohost`
[🇬🇧 English version](README.md) [🇬🇧 English version](README.md)
@ -17,22 +17,18 @@ Comme il s'agit d'une collection indépendante, elle peut être publiée selon s
## Prérequis ## Prérequis
------------
Votre serveur doit être basé sur du Debian Buster et Yunohost ne doit pas déjà être installé. Votre serveur doit être basé sur du Debian Buster et Yunohost ne doit pas déjà être installé.
## Contenu de la collection ## Contenu de la collection
### Rôles ### Rôles
- [`lydra.yunohost.ynh_setup`](roles/ynh_setup/README-FR.md) : Ce rôle prépare les serveurs à base de Debian-Buster à exécuter Yunohost. Il configure Yunohost avec ses paramètres initiaux et les domaines, utilisateurs et applications de votre choix. - [`lydra.yunohost.ynh_setup`](roles/ynh_setup/README-FR.md) : Ce rôle prépare les serveurs à base de Debian-Buster à exécuter Yunohost. Il configure Yunohost avec ses paramètres initiaux, les domaines et les utilisateurs de votre choix.
- [`lydra.yunohost.ynh_apps`](roles/ynh_apps/README-FR.md): Ce rôle installe les applications Yunohost de votre choix et peut également lancer des tâches de post-installation. - [`lydra.yunohost.ynh_apps`](roles/ynh_apps/README-FR.md): Ce rôle installe les applications Yunohost de votre choix et peut également les configurer grâce aux tâches de post-installation.
- [`lydra.yunohost.ynh_config`](roles/ynh_config/README-FR.md) : Ce rôle gère la configuration de différents services de Yunohost (relais SMTP, mises à jour automatiques). - [`lydra.yunohost.ynh_config`](roles/ynh_config/README-FR.md) : Ce rôle gère la configuration de différents services de Yunohost (relais SMTP, mises à jour automatiques).
- [`lydra.yunohost.ynh_backup`](roles/ynh_backup/README-FR.md) : Ce rôle gère la configuration des sauvegardes. - [`lydra.yunohost.ynh_backup`](roles/ynh_backup/README-FR.md) : Ce rôle gère la configuration des sauvegardes.
### lydra.yunohost Tags du rôle ### Tags du rôle
------------
Ces tags sont applicables suivant les rôles. Ces tags sont applicables suivant les rôles.
@ -50,8 +46,6 @@ Ces tags sont applicables suivant les rôles.
## License ## 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 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. **ansible-yunohost** est maintenu par [Lydra](https://lydra.fr/) et publié sous la licence GPL3.

View file

@ -8,7 +8,7 @@
[![GitHub Release Date](https://img.shields.io/github/release-date/LydraFr/ansible-yunohost)](https://github.com/LydraFr/ansible-yunohost) [![GitHub Release Date](https://img.shields.io/github/release-date/LydraFr/ansible-yunohost)](https://github.com/LydraFr/ansible-yunohost)
[![GitHub Repo stars](https://img.shields.io/github/stars/LydraFr/ansible-yunohost?style=social)](https://github.com/LydraFr/ansible-yunohost) [![GitHub Repo stars](https://img.shields.io/github/stars/LydraFr/ansible-yunohost?style=social)](https://github.com/LydraFr/ansible-yunohost)
# Ansible Collection - lydra.yunohost # Ansible Collection - `lydra.yunohost`
[🇫🇷 French version](README-FR.md) [🇫🇷 French version](README-FR.md)
@ -17,8 +17,6 @@ As this is an independent collection, it can be released on its own release cade
# Prerequisites # Prerequisites
------------
Your server must be Debian-Buster based and Yunohost shouldn't be already installed. Your server must be Debian-Buster based and Yunohost shouldn't be already installed.
## Collection contents ## Collection contents
@ -30,9 +28,7 @@ Your server must be Debian-Buster based and Yunohost shouldn't be already instal
- [`lydra.yunohost.ynh_config`](roles/ynh_config/README.md): This role configures various Yunohost services (SMTP relay, auto updates). - [`lydra.yunohost.ynh_config`](roles/ynh_config/README.md): This role configures various Yunohost services (SMTP relay, auto updates).
- [`lydra.yunohost.ynh_backup`](roles/ynh_backup/README.md): This role manages the configuration of backups. - [`lydra.yunohost.ynh_backup`](roles/ynh_backup/README.md): This role manages the configuration of backups.
## lydra.yunohost Role Tags ## Role Tags
------------
These tags are applicable to roles. These tags are applicable to roles.
@ -50,8 +46,6 @@ These tags are applicable to roles.
## License ## 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 Copyright 2021 Lydra](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](https://choosealicense.com/licenses/gpl-3.0/)
**ansible-yunohost** is maintained by [Lydra](https://lydra.fr/) and released under the GPL3 license. **ansible-yunohost** is maintained by [Lydra](https://lydra.fr/) and released under the GPL3 license.

View file

@ -6,20 +6,14 @@ Sauvegardez [Yunohost](https://yunohost.org/#/) avec Ansible !
## Prérequis ## Prérequis
------------
Yunohost doit déjà être installé sur votre serveur. Yunohost doit déjà être installé sur votre serveur.
## Variables du rôle ## 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 en ... Les variables par défaut sont disponibles dans `default/main.yml` cependant il est possible de les surcharger selon vos besoins en ...
### Gestion des sauvegardes ### Gestion des sauvegardes
------------
```yml ```yml
ynh_backup: ynh_backup:
scheduled: True scheduled: True
@ -46,14 +40,10 @@ La tâche backup va permettre de sauvegarder les applications Yunohost ainsi que
## Dépendances ## Dépendances
------------
Aucune. Aucune.
## Exemple de Playbook ## Exemple de Playbook
------------
```yml ```yml
--- ---
- name: Configure Yunohost backups - name: Configure Yunohost backups
@ -67,8 +57,6 @@ Aucune.
## License ## 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 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. **ansible-yunohost** est maintenu par [Lydra](https://lydra.fr/) et publié sous la licence GPL3.

View file

@ -6,20 +6,14 @@ Deploy [Yunohost](https://yunohost.org/#/) with Ansible!
## Requirements ## Requirements
------------
Yunohost needs to be installed on your server. Yunohost needs to be installed on your server.
## Role Variables ## Role Variables
------------
Default variables are available in `default/main.yml` however it is necessary to override them according to your needs for ... Default variables are available in `default/main.yml` however it is necessary to override them according to your needs for ...
### Backups management ### Backups management
------------
```yml ```yml
ynh_backup: ynh_backup:
scheduled: True scheduled: True
@ -46,14 +40,10 @@ The backup task will allow to backup Yunohost applications and their data by set
## Dependencies ## Dependencies
------------
None. None.
## Example Playbook ## Example Playbook
------------
```yml ```yml
--- ---
- name: Configure Yunohost backups - name: Configure Yunohost backups
@ -67,8 +57,6 @@ None.
## License ## 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 Copyright 2021 Lydra](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](https://choosealicense.com/licenses/gpl-3.0/)
**ansible-yunohost** is maintained by [Lydra](https://lydra.fr/) and released under the GPL3 license. **ansible-yunohost** is maintained by [Lydra](https://lydra.fr/) and released under the GPL3 license.

View file

@ -37,7 +37,7 @@
- backup - backup
- cron - cron
- name: Create cron task to perform YNH backup - name: Create cron task to schedule YNH backup script
ansible.builtin.cron: ansible.builtin.cron:
name: "auto-backup to {{ ynh_backup.directory | default('/home/yunohost.backup/archives') }}" name: "auto-backup to {{ ynh_backup.directory | default('/home/yunohost.backup/archives') }}"
month: "{{ ynh_backup.scheduled_month | default('*') }}" month: "{{ ynh_backup.scheduled_month | default('*') }}"

View file

@ -10,14 +10,10 @@ Yunohost doit déjà être installé sur votre serveur.
## Variables du rôle ## 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. 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 ### Configuration d'un relais SMTP
------------
```yml ```yml
# paramètres personnalisés du relais SMTP # paramètres personnalisés du relais SMTP
ynh_smtp_relay: ynh_smtp_relay:
@ -30,9 +26,7 @@ ynh_smtp_relay:
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. 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). 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).
### Concernant les mises à jour ### Configuration des mises à jour
------------
```yml ```yml
# Autoupdate Yunohost and its apps # Autoupdate Yunohost and its apps
@ -58,14 +52,10 @@ Pour en savoir plus sur le fonctionnement des mises à jour dans Yunohost vous p
## Dépendances ## Dépendances
------------
Aucune. Aucune.
## Exemple de Playbook ## Exemple de Playbook
------------
```yml ```yml
--- ---
- name: Configure Yunohost on Debian Server - name: Configure Yunohost on Debian Server
@ -79,8 +69,6 @@ Aucune.
## License ## 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 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. **ansible-yunohost** est maintenu par [Lydra](https://lydra.fr/) et publié sous la licence GPL3.

View file

@ -6,20 +6,14 @@ Deploy [Yunohost](https://yunohost.org/#/) with Ansible!
## Requirements ## Requirements
------------
None. None.
## Role Variables ## Role Variables
------------
Default variables are available in `default/main.yml` however it is necessary to override them according to your needs for Yunohost domains, users and apps. Default variables are available in `default/main.yml` however it is necessary to override them according to your needs for Yunohost domains, users and apps.
### SMTP relay configuration ### SMTP relay configuration
------------
```yml ```yml
# SMTP custom settings # SMTP custom settings
ynh_smtp_relay: ynh_smtp_relay:
@ -32,9 +26,7 @@ ynh_smtp_relay:
There is a built-in SMTP server on Yunohost but you can also set up Yunohost to use a SMTP relay instead. There is a built-in SMTP server on Yunohost but you can also set up Yunohost to use a SMTP relay instead.
In order to do so, create the `ynh_smtp_relay` variable and provide your own values. You can learn more about SMTP relay [here](https://yunohost.org/en/administrate/specific_use_cases/email_relay). In order to do so, create the `ynh_smtp_relay` variable and provide your own values. You can learn more about SMTP relay [here](https://yunohost.org/en/administrate/specific_use_cases/email_relay).
### About the updates ### Updates configuration
------------
```yml ```yml
# Autoupdate Yunohost and its apps # Autoupdate Yunohost and its apps
@ -60,14 +52,10 @@ To learn more about how updates work in Yunohost you can go [here](https://yunoh
## Dependencies ## Dependencies
------------
None. None.
## Example Playbook ## Example Playbook
------------
```yml ```yml
--- ---
- name: Configure Yunohost on Debian Server - name: Configure Yunohost on Debian Server
@ -81,8 +69,6 @@ None.
## License ## 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 Copyright 2021 Lydra](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](https://choosealicense.com/licenses/gpl-3.0/)
**ansible-yunohost** is maintained by [Lydra](https://lydra.fr/) and released under the GPL3 license. **ansible-yunohost** is maintained by [Lydra](https://lydra.fr/) and released under the GPL3 license.

View file

@ -30,10 +30,10 @@ ynh_data_dirs:
ynh_data_dirs.enabled: True ynh_data_dirs.enabled: True
``` ```
- `ynh_install_script_url` est le script d'installation des packages Yunohost, par défaut c'est le script officiel. Yunohost ne s'installe que sur Debian 10. - `ynh_install_script_url` est l'url du script d'installation des packages Yunohost, par défaut c'est le script officiel. Yunohost ne s'installe que sur Debian 10.
- `ynh_admin_password` est le mot de passe permettant d'accéder à linterface dadministration du serveur. - `ynh_admin_password` est le mot de passe permettant d'accéder à linterface dadministration du serveur.
- `ynh_data_dirs.enabled`: active les liens symboliques et permet de déplacer les répertoires de configurations et de données de YunoHost où vous le desirez. Mettez la valeur à `True`. - `ynh_data_dirs.enabled`: active les liens symboliques et permet de déplacer les répertoires de configurations et de données de YunoHost où vous le desirez. Par défaut, cette valeur est à `True`. Nous utilisons les liens symboliques car le dossier `/data` nous sert à faire des sauvegardes de type _object storage_.
- `ynh_data_dirs.path`: il s'agit des répertoires où stocker les données de configuration de Yunohost ainsi que les applications. - `ynh_data_dirs.path`: il s'agit des répertoires où stocker les données de configuration de Yunohost ainsi que les applications.
- `ynh_data_dirs.link`: il s'agit des répertoire où seront fait les liens symboliques. - `ynh_data_dirs.link`: il s'agit des répertoire où seront fait les liens symboliques.

View file

@ -30,10 +30,10 @@ ynh_data_dirs:
ynh_data_dirs.enabled: True ynh_data_dirs.enabled: True
``` ```
- `ynh_install_script_url` downloads official Yunohost script for installing Yunohost packages. Yunohost is only available on Debian 10. - `ynh_install_script_url` The url provided downloads the official Yunohost script for installing Yunohost packages. Yunohost is only available on Debian 10.
- `ynh_admin_password` is the password used to access to the server's administration interface. - `ynh_admin_password` is the password used to access to the server's administration interface.
- `ynh_data_dirs.enabled`: Enables symbolic links and allows you to move YunoHost's configuration and data directories wherever you want. Set the value to `True`. - `ynh_data_dirs.enabled`: Enables symbolic links and allows you to move YunoHost's configuration and data directories wherever you want. By default, this value is set to `True`. We use symbolic links because the `/data` folder is used by us to make _object storage_ backups.
- `ynh_data_dirs.path`: these are the directories where Yunohost configuration data and applications are stored. - `ynh_data_dirs.path`: these are the directories where Yunohost configuration data and applications are stored.
- `ynh_data_dirs.link`: this is the directory where symbolic links will be made. - `ynh_data_dirs.link`: this is the directory where symbolic links will be made.