Skip to content

Commit

Permalink
[docs] Revisited social login and saml a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
nemesifier committed Aug 24, 2024
1 parent 626191b commit 0a411bb
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 5 deletions.
13 changes: 10 additions & 3 deletions docs/user/saml.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,16 +49,23 @@ Setup

Install required system dependencies:

.. code-block:: shell
::

sudo apt install xmlsec1

Install Python dependencies:
Install the SAML dependencies in the python environment used by OpenWISP:

.. code-block:: shell
::

# by default, in instances deployed
# via ansible-openwisp2, the python env
# is in /opt/openwisp2/env/
source /opt/openwisp2/env/bin/activate

pip install openwisp-radius[saml]

.. include:: /partials/settings-note.rst

Ensure your ``settings.py`` looks like the following:

.. code-block:: python
Expand Down
11 changes: 9 additions & 2 deletions docs/user/social_login.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ perform the submit action of the login form: ``username`` should obviously
used for the username field, while ``token`` should be used for the
password field.

The internal REST API of openwisp-radius will recognize the token and
The internal REST API of OpenWISP RADIUS will recognize the token and
authorize the user.

This kind of implementation allows to implement the social login with any
Expand All @@ -39,12 +39,19 @@ the user is signing-in with a social network.
Setup
-----

Install ``django-allauth``:
Install ``django-allauth`` in the python environment used by OpenWISP:

::

# by default, in instances deployed
# via ansible-openwisp2, the python env
# is in /opt/openwisp2/env/
source /opt/openwisp2/env/bin/activate

pip install django-allauth[socialaccount]

.. include:: /partials/settings-note.rst

Ensure your ``settings.py`` looks like the following (we will show how to
configure of the Facebook social provider):

Expand Down

0 comments on commit 0a411bb

Please sign in to comment.