Skip to main content

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.

Installing The Plugin

For detailed installation instructions, please refer to the plugin 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

Metadata

Release files for openedx-companion-auth 1.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openedx-companion-auth 1.3.0
File Size Uploaded Provenance Actions
openedx_companion_auth-1.3.0.tar.gz 4.3 kB Without provenance Details for openedx_companion_auth-1.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for openedx-companion-auth 1.3.0
File Interpreter ABI Platform Actions
openedx_companion_auth-1.3.0-py3-none-any.whl Python 3 none any Details for openedx_companion_auth-1.3.0-py3-none-any.whl

Total release size: 11.6 kB

Release files / openedx_companion_auth-1.3.0.tar.gz

Download URL openedx_companion_auth-1.3.0.tar.gz
Size 4.3 kB
Tags Source
SHA-256 checksum
How to use checksums
e3a9c8e253b9002447a7144fc103d38e8b7a6df4874d227250d7765ebe33a2eb
BLAKE2b-256 checksum
How to use checksums
fca94a5cf8484e432191f4ef4c01ad9ab0a719fd4306219ca162ab3d38760662
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release files / openedx_companion_auth-1.3.0-py3-none-any.whl

Download URL openedx_companion_auth-1.3.0-py3-none-any.whl
Size 7.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
85fdc980c1580767d2c93319c06126ce662ed2f875a3ca36981c7c678eaf0144
BLAKE2b-256 checksum
How to use checksums
83ddcb1e83d775fb7655e7d1db67bbe94bd5d3e8a6fabf78eaf9d3f544c59e98
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Security for openedx-companion-auth 1.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page