From 58bc480b6c25427142459a3a2d0b67b5c1c6bf2a Mon Sep 17 00:00:00 2001 From: GeorgianaElena Date: Fri, 21 Jun 2019 14:10:28 +0300 Subject: [PATCH] Extra user groups documentation --- docs/topic/tljh-config.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/topic/tljh-config.rst b/docs/topic/tljh-config.rst index bfc827b..5561fba 100644 --- a/docs/topic/tljh-config.rst +++ b/docs/topic/tljh-config.rst @@ -132,6 +132,34 @@ User Environment sudo tljh-config set user_environment.default_app jupyterlab +.. _tljh-set-extra-user-groups: + +Extra User Groups +================= + + +``users.extra_user_groups`` is a configuration option that can be used +to automatically add a user to a specific group. By default, there are +no extra groups defined. + +Users can be "paired" with the desired, **existing** groups using: + +* ``tljh-config set``, if only one user is to be added to the + desired group: + +.. code-block:: bash + + tljh-config set users.extra_user_groups.group1 user1 + +* ``tljh-config add-item``, if multiple users are to be added to + the group: + +.. code-block:: bash + + tljh-config add-item users.extra_user_groups.group1 user1 + tljh-config add-item users.extra_user_groups.group1 user2 + + .. _tljh-view-conf: View current configuration