zhangyiss/the-littlest-jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/the-littlest-jupyterhub.git synced 2025-12-18 21:54:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add docs explaining truncation of username

Browse Source
This commit is contained in:
yuvipanda
2018-09-12 16:48:55 -07:00
parent 9b0248e0c3
commit 37ea7eaa6f
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/topic/security.rst
View File

@@ -18,7 +18,10 @@ permissions.
#. The unix user account created for a JupyterHub user named ``<username>`` is #. The unix user account created for a JupyterHub user named ``<username>`` is
``jupyter-<username>``. This prefix helps prevent clashes with users that ``jupyter-<username>``. This prefix helps prevent clashes with users that
already exist - otherwise a user named ``root`` can trivially gain full root already exist - otherwise a user named ``root`` can trivially gain full root
access to your server. access to your server. If the username (including the ``jupyter-`` prefix)
is longer than 26 characters, it is truncated at 26 characters & a 5 charcter
hash is appeneded to it. This keeps usernames under the linux username limit
of 32 characters while also reducing chances of collision.
#. A home directory is created for the user under ``/home/jupyter-<username>``. #. A home directory is created for the user under ``/home/jupyter-<username>``.