From 39e667f7035ce8951921369ec7db6d231ddcc664 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Lesimple?= Date: Fri, 1 Jul 2022 10:09:13 +0000 Subject: [PATCH] doc: amend groupModify documentation --- .../plugins/group-owner/groupModify.rst | 20 +++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/doc/sphinx/plugins/group-owner/groupModify.rst b/doc/sphinx/plugins/group-owner/groupModify.rst index f253be2..d67c01f 100644 --- a/doc/sphinx/plugins/group-owner/groupModify.rst +++ b/doc/sphinx/plugins/group-owner/groupModify.rst @@ -14,16 +14,28 @@ Modify the configuration of a group .. program:: groupModify -.. option:: --group GROUP +.. option:: --group GROUP Name of the group to modify -.. option:: --mfa-required password|totp|any|none +.. option:: --mfa-required password|totp|any|none Enforce UNIX password requirement, or TOTP requirement, or any MFA requirement, when connecting to a server of the group -.. option:: --guest-ttl-limit DURATION + --idle-lock-timeout DURATION|0|-1 Overrides the global setting (`idleLockTimeout`), to the specified duration. If set to 0, disables `idleLockTimeout` for + this group. If set to -1, remove this group override and use the global setting instead. + --idle-kill-timeout DURATION|0|-1 Overrides the global setting (`idleKillTimeout`), to the specified duration. If set to 0, disables `idleKillTimeout` for + this group. If set to -1, remove this group override and use the global setting instead. +.. option:: --guest-ttl-limit DURATION This group will enforce TTL setting, on guest access creation, to be set, and not to a higher value than DURATION, - set to zero to allow guest accesses creation without any TTL set (default) + set to zero to allow guest accesses creation without any TTL set (default) + +Note that `--idle-lock-timeout` and `--idle-kill-timeout` will NOT be applied for catch-all groups (having 0.0.0.0/0 in their server list). + +If a server is in exactly one group an account is a member of, then its values of `--idle-lock-timeout` and `--idle-kill-timeout`, if set, +will prevail over the global setting. The global setting can be seen with `--osh info`. + +Otherwise, the most restrictive setting (i.e. the one with the lower strictly positive duration) between +all the considered groups and the global setting, will be used.