From b4c53a29a95359989363423843ecc89f903bf1a0 Mon Sep 17 00:00:00 2001 From: Matthias Bussonnier Date: Thu, 21 Feb 2019 21:48:08 -0800 Subject: [PATCH] document admin_group --- .../getting-started/authenticators-users-basics.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/source/getting-started/authenticators-users-basics.md b/docs/source/getting-started/authenticators-users-basics.md index 5064d769..b954f88d 100644 --- a/docs/source/getting-started/authenticators-users-basics.md +++ b/docs/source/getting-started/authenticators-users-basics.md @@ -31,6 +31,15 @@ c.Authenticator.admin_users = {'mal', 'zoe'} Users in the admin list are automatically added to the user `whitelist`, if they are not already present. +Each authenticator may have different ways of determining whether a user is an +administrator. By default JupyterHub use the PAMAuthenticator which provide the +`admin_groups` option and can determine administrator status base on a user +groups. For example we can let any users in the `wheel` group be admin: + +```python +c.PAMAuthenticator.admin_groups = {'wheel'} +``` + ## Give admin access to other users' notebook servers (`admin_access`) Since the default `JupyterHub.admin_access` setting is False, the admins