Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs #35

Merged
merged 4 commits into from
Jan 17, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,54 @@ Indices and tables

quickstart


Installation
------------

Native Authenticator is a plugin Authenticator for the
`JupyterHub <https://github.com/jupyterhub/>`_. Be sure you have JupyterHub
already running on your machine before installing this authenticator.

You must install this authenticator throught the project's repository. This is
a temporary solution until we have the package on the `Pypi <https://pypi.org/>`_:

.. code-block:: bash

$ git clone https://github.com/jupyterhub/nativeauthenticator.git
$ pip install -e .


Then, you must create the configuration file for JupyterHub:

.. code-block:: bash

$ jupyterhub --generate-config -f /etc/jupyterhub/jupyterhub_config.py


And change the default Authenticator class for our Native Authenticator class:

`c.JupyterHub.authenticator_class = 'nativeauthenticator.NativeAuthenticator'`


Run your JupyterHub normally, and the authenticator will be running with it.


User creation
-------------

To access the system you must go to `/hub/signup` and create a username and a password. Be default, all users that sings up to the system need an Admin authorization to access the system.

If you are and admin, be sure that your username is listed on the `admin_users` on the config file such as:

.. code-block:: python

c.Authenticator.admin_users = {'username'}

If you create a new user that is listed as an admin on the config file, it will automatically have access to the system just after the signup.


Authorize new users
-------------------

To authorize new users to enter the system or to manage those that already have access to the system you can go to `<ip:port>/hub/authorize`.

20 changes: 20 additions & 0 deletions docs/options.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Feature Options
===============

Password Strength
----------------

By default, when a user signs up through Native Authenticator there is no password strength verification. If you need this, you can add a verification for password strength by adding the following parameter to your config file:

.. code-block:: python

c.Authenticator.check_password_strength = True

The Authenticator will verify if the password has at least 8 characters and if it not a common password. The list of the common passwords it checks is available `on this link <https://github.com/danielmiessler/SecLists/blob/master/Passwords/Common-Credentials/10-million-password-list-top-10000.txt>`_ >._


By default the Authenticator will verify if the password is at least 8 characters long. If you, however, need something different, you can change the minimum size adding this parameter to the config file:

.. code-block:: python

c.Authenticator.password_length = 10
4 changes: 4 additions & 0 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
Quickstart
==========


Installation
------------

Native Authenticator is a plugin Authenticator for the
`JupyterHub <https://github.com/jupyterhub/>`_. Be sure you have JupyterHub
already running on your machine before installing this authenticator.
Expand Down