Skip to content
Open
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
20 changes: 20 additions & 0 deletions docs/administration/social_auth.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
.. _social_auth:

Social Auth (OAuth2)
====================

The application supports login via social authentication providers using OAuth2.
This allows users to log in using their existing accounts from the appropriate providers,
such as Google, Facebook, or GitHub.

To enable social authentication follow these steps:

1. Register your application with the desired social authentication provider to
obtain the necessary credentials (client ID and client secret). You will also need
to configure the exact domain that you will be using. For google, this is done
in the cloud console https://console.cloud.google.com/auth/

2. Set ``USE_SOCIAL_AUTH`` to ``True`` in your settings to enable social authentication.

3. Configure the providers with the obtained credentials. For example, for Google:
``python manage.py setup_google_oauth --client_id "123456..." --client_secret "7890..."``
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,8 @@ Administration
Available commands to manage the application and sync exercises and ingredients
:doc:`administration/settings`
Available settings for the application
:doc:`administration/social_auth`
Social authentication (OAuth2) settings
:doc:`administration/auth_proxy`
Alternative authentication settings

Expand Down