From 09424eac74e401b1fc495a0dfdfd636f3ae4944e Mon Sep 17 00:00:00 2001
From: Arthur BOUDREAULT <arthur@lydra.fr>
Date: Tue, 14 Mar 2023 14:55:18 +0100
Subject: [PATCH] refactor: add Christophe suggestions
---
README-FR.md | 2 +-
README.md | 2 +-
roles/ynh_config/README-FR.md | 10 +++++++---
roles/ynh_config/README.md | 9 +++++++--
roles/ynh_config/defaults/main.yml | 2 +-
roles/ynh_config/tasks/main.yml | 6 +++---
6 files changed, 20 insertions(+), 11 deletions(-)
diff --git a/README-FR.md b/README-FR.md
index dfde820..f5d06e1 100644
--- a/README-FR.md
+++ b/README-FR.md
@@ -40,7 +40,7 @@ Ces tags sont applicables suivant les rôles.
|apps|Tâches spécifiques aux applications de Yunohost.|
|update|Tâches liées aux paramètres de mise à jour de Yunohost.|
|smtp|Tâches liées aux paramètres de relais smtp de Yunohost.|
-|ssh|Tâches liées aux paramètres SSH de Yunohost.|
+|settings|Tâches liées aux paramètres de Yunohost.|
|backup|Tâches liées aux sauvegardes de Yunohost en local.|
|borg|Tâches liées aux sauvegardes avec BorgBackup.|
|restic|Tâches liées aux sauvegardes avec Restic.|
diff --git a/README.md b/README.md
index 6f120b4..15223cf 100644
--- a/README.md
+++ b/README.md
@@ -40,7 +40,7 @@ These tags are applicable to roles.
|apps|Tasks specific to Yunohost apps.|
|update|Tasks related to Yunohost update settings.|
|smtp|Tasks related to Yunohost smtp relay settings.|
-|ssh|Tasks related to Yunohost SSH settings.|
+|settings|Tasks related to Yunohost settings.|
|backup|Tasks related to local Yunohost backups.|
|borg|Tasks related to backups with BorgBackup.|
|restic|Tasks related to backups with Restic.|
diff --git a/roles/ynh_config/README-FR.md b/roles/ynh_config/README-FR.md
index 0958478..5dd6051 100644
--- a/roles/ynh_config/README-FR.md
+++ b/roles/ynh_config/README-FR.md
@@ -49,10 +49,10 @@ Si des mises à jour sont disponibles, elles sont faites automatiquement. En cas
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).
-### Options SSH
+### Options de YunoHost
```yml
-ynh_ssh_options:
+ynh_settings:
security.ssh.port: "22"
security.password.passwordless_sudo: "true"
```
@@ -64,9 +64,13 @@ Si votre instance YunoHost est derrière un firewall applicatif ou propre à vot
### Utilisation de sudo sans mot de passe
-A partir de Yunohost 11.1, un nouveau groupe d'administrateurs est créé sur l'instance. Il s'agit d'un groupe Unix qui est intégré à YunoHost et son LDAP. Tous les utilisateurs dans ce groupe auront accès à la console d'administration en ligne YunoHost mais pourront également se connecter en SSH et utiliser la commande sudo (pour prendre temporairement les droits root).
+À partir de Yunohost 11.1, un nouveau groupe d'administrateurs est créé sur l'instance. Il s'agit d'un groupe Unix qui est intégré à YunoHost et son LDAP. Tous les utilisateurs dans ce groupe auront accès à la console d'administration en ligne YunoHost mais pourront aussi se connecter en SSH et utiliser la commande sudo (pour prendre temporairement les droits root).
Par défaut, l'utilisateur doit taper son mot de passe pour utiliser la commande sudo mais il est possible de désactiver cette vérification depuis l'interface web (`outils` > `Paramètres de YunoHost` > `Permettre aux administrateurs d'utiliser 'sudo' sans retaper leur mot de passe`) ou en modifiant la variable `security.password.passwordless_sudo` à `true` dans votre fichier de variables Ansible. Plus d'informations disponibles [ici](https://forum.yunohost.org/t/yunohost-11-1-release-sortie-de-yunohost-11-1/23378#sudo-sans-mot-de-passe-16).
+#### Paramètres supplémentaires
+
+Vous pouvez fournir des paramètres supplémentaires à la variable `ynh_settings`. Pour en savoir plus, utilisez la commande `yunohost settings list`.
+
## Dépendances
Aucune.
diff --git a/roles/ynh_config/README.md b/roles/ynh_config/README.md
index e464e59..b7c3ad7 100644
--- a/roles/ynh_config/README.md
+++ b/roles/ynh_config/README.md
@@ -49,10 +49,10 @@ If available, updates are done automatically. In case of problems following an a
To learn more about how updates work in Yunohost you can go [here](https://yunohost.org/fr/update). The changelog of Yunohost versions is also available [here](https://forum.yunohost.org/tag/ynh_release).
-### SSH options
+### YunoHost options
```yml
-ynh_ssh_options:
+ynh_settings:
security.ssh.port: "22"
security.password.passwordless_sudo: "true"
```
@@ -67,6 +67,11 @@ If your YunoHost instance is behind an application or cloud provider specific fi
Starting with Yunohost 11.1, a new administrator group is created on the instance. This is a Unix group that is integrated with YunoHost and its LDAP. All users in this group will have access to the YunoHost online administration console but will also be able to connect via SSH and use the sudo command (to temporarily take root rights).
By default, the user must type their password to use the sudo command but it is possible to disable this check from the web interface (`tools` > `YunoHost settings` > `Allow admins to use ‘sudo’ without re-typing their passwords`) or by changing the `security.password.passwordless_sudo` variable to `true` in your Ansible variables file. More information available [here](https://forum.yunohost.org/t/yunohost-11-1-release-sortie-de-yunohost-11-1/23378#passwordless-sudo-4).
+
+#### Extra settings
+
+You can provide extra parameters to the variable `ynh_settings`. To know more, use the command `yunohost settings list`.
+
## Dependencies
None.
diff --git a/roles/ynh_config/defaults/main.yml b/roles/ynh_config/defaults/main.yml
index 57f6707..a1d1d09 100644
--- a/roles/ynh_config/defaults/main.yml
+++ b/roles/ynh_config/defaults/main.yml
@@ -39,6 +39,6 @@ ynh_autoupdate:
# system: True
# dest_script: "/usr/local/bin/"
-ynh_ssh_options:
+ynh_settings:
security.ssh.port: "22"
security.password.passwordless_sudo: "true"
diff --git a/roles/ynh_config/tasks/main.yml b/roles/ynh_config/tasks/main.yml
index cab13f1..cef24b1 100644
--- a/roles/ynh_config/tasks/main.yml
+++ b/roles/ynh_config/tasks/main.yml
@@ -41,10 +41,10 @@
- yunohost
- update
-- name: Configure YunoHost SSH options
+- name: Configure YunoHost settings
ansible.builtin.command:
"yunohost settings set {{ item.key }} -v {{ item.value }}"
- loop: "{{ ynh_ssh_options | dict2items }}"
+ loop: "{{ ynh_settings | dict2items }}"
tags:
- yunohost
- - ssh
+ - settings
--
GitLab