Metadata-Version: 2.5
Name: openedx-companion-auth
Version: 1.3.0
Summary: A package to add login redirection from Open edX to MIT applications
Author: MIT Office of Digital Learning
License-Expression: BSD-3-Clause
License-File: LICENSE
Keywords: Python,edx
Requires-Python: >=3.11
Requires-Dist: django>=5.2
Requires-Dist: djangorestframework>=3.16.0
Requires-Dist: edx-django-utils>=8.0.0
Description-Content-Type: text/x-rst

Open edX Auth Companion
=======================

An Open edX plugin that redirects users from edx-platform to MIT applications

Version Compatibility
---------------------

Compatible with the Nutmeg release of the Open edX and onwards. May work with prior releases as well.

For this plugin's compatibility with Open edX, see the
`Open edX Release Compatibility table <../../docs#open-edx-release-compatibility>`_.

Installing The Plugin
---------------------

For detailed installation instructions, please refer to the `plugin installation guide <../../docs#installation-guide>`_.

Installation required in:

* LMS

Configurations
--------------
You have the following configuration properties to customize your plugin behavior:

* **MITX_REDIRECT_ENABLED:** The middleware checks this value and redirects only when it is set to ``True``.
* **MITX_REDIRECT_LOGIN_URL:** The URL where the user is redirected for login.
* **MITX_REDIRECT_ALLOW_RE_LIST:** A list of paths on which the middleware does not redirect to the ``MITX_REDIRECT_LOGIN_URL``.
* **MITX_REDIRECT_DENY_RE_LIST:** A list of paths on which the middleware redirects to the ``MITX_REDIRECT_LOGIN_URL``.

Working
--------
* Install the plugin in the lms following the installation steps above.
* Verify that you are not logged in on edx-platform.
* Go to `http://local.openedx.io:8000`. You should be redirected to the ``MITX_REDIRECT_LOGIN_URL``
