https://github.com/mitodl/tutor-mitxpro-oauth
A simple Tutor plugin that sets up OAuth for our projects.
https://github.com/mitodl/tutor-mitxpro-oauth
Last synced: about 2 months ago
JSON representation
A simple Tutor plugin that sets up OAuth for our projects.
- Host: GitHub
- URL: https://github.com/mitodl/tutor-mitxpro-oauth
- Owner: mitodl
- License: bsd-3-clause
- Created: 2023-04-04T15:43:35.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-08T19:43:28.000Z (almost 2 years ago)
- Last Synced: 2025-02-17T20:50:07.105Z (3 months ago)
- Language: Python
- Size: 7.81 KB
- Stars: 0
- Watchers: 17
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
mitxpro-oauth plugin for `Tutor `__
===================================================================================
This is a simple plugin that contains the necessary configuration settings for integrating a Tutor instance with an OL application that uses OAuth2. This was written specifically for `MITx Online `_ but should reasonably work with other things too (such as xPro).
Specifically, this just adds a few things to the common settings but notably it will also disable the AuthN MFE.
Installation and Usage
----------------------
::
pip install [email protected]:mitodl/tutor-mitxpro-oauth.git
tutor plugins enable mitxpro-oauth
Once you've installed the plugin, you will additionally need to add a ``private.txt`` to the tutor requirements. This should contain the following two packages:
::
social-auth-mitxpro
mitxpro-openedx-extensions
This goes in ``env/build/openedx/requirements`` in the root of your Tutor install (``$TUTOR_ROOT``) - what this is specifically will depend on your environment. Rebuild your ``openedx`` image after adding this.
You'll also need to create third-party app configurations and access tokens and everything else that's necessary from within Django Admin/etc. on both sides of the system. An example of that is here: https://github.com/mitodl/mitxonline/blob/main/docs/source/configuration/open_edx.rst
License
-------
This software is licensed under the terms of the BSD 3-Clause license.