2020-05-18 09:24:09 +00:00
|
|
|
.. _plugins_examples:
|
|
|
|
|
|
|
|
Examples of Tutor plugins
|
|
|
|
=========================
|
|
|
|
|
|
|
|
The following are simple examples of :ref:`Tutor plugins <plugins>` that can be used to modify the behaviour of Open edX.
|
|
|
|
|
|
|
|
Skip email validation for new users
|
|
|
|
-----------------------------------
|
|
|
|
|
|
|
|
::
|
|
|
|
|
|
|
|
name: skipemailvalidation
|
|
|
|
version: 0.1.0
|
|
|
|
patches:
|
|
|
|
common-env-features: |
|
|
|
|
"SKIP_EMAIL_VALIDATION": true
|
2020-10-06 07:56:51 +00:00
|
|
|
|
2020-05-18 09:24:09 +00:00
|
|
|
Enable bulk enrollment view in the LMS
|
|
|
|
--------------------------------------
|
|
|
|
|
|
|
|
::
|
|
|
|
|
|
|
|
name: enablebulkenrollmentview
|
|
|
|
version: 0.1.0
|
|
|
|
patches:
|
|
|
|
lms-env-features: |
|
|
|
|
"ENABLE_BULK_ENROLLMENT_VIEW": true
|
|
|
|
|
|
|
|
Enable Google Analytics
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
::
|
|
|
|
|
|
|
|
name: googleanalytics
|
|
|
|
version: 0.1.0
|
|
|
|
patches:
|
|
|
|
openedx-common-settings: |
|
|
|
|
# googleanalytics special settings
|
|
|
|
GOOGLE_ANALYTICS_ACCOUNT = "UA-your-account"
|
|
|
|
GOOGLE_ANALYTICS_TRACKING_ID = "UA-your-tracking-id"
|
|
|
|
|
|
|
|
Enable SAML authentication
|
|
|
|
--------------------------
|
|
|
|
|
|
|
|
::
|
|
|
|
|
|
|
|
name: saml
|
|
|
|
version: 0.1.0
|
|
|
|
patches:
|
2021-08-19 18:31:35 +00:00
|
|
|
common-env-features: |
|
|
|
|
"ENABLE_THIRD_PARTY_AUTH": true
|
2020-05-18 09:24:09 +00:00
|
|
|
|
2021-08-19 18:31:35 +00:00
|
|
|
openedx-lms-common-settings: |
|
2020-05-18 09:24:09 +00:00
|
|
|
# saml special settings
|
2022-03-17 09:45:40 +00:00
|
|
|
AUTHENTICATION_BACKENDS += ["common.djangoapps.third_party_auth.saml.SAMLAuthBackend", "django.contrib.auth.backends.ModelBackend"]
|
2020-05-18 09:24:09 +00:00
|
|
|
|
|
|
|
openedx-auth: |
|
2020-10-06 07:56:51 +00:00
|
|
|
"SOCIAL_AUTH_SAML_SP_PRIVATE_KEY": "yoursecretkey",
|
|
|
|
"SOCIAL_AUTH_SAML_SP_PUBLIC_CERT": "yourpubliccert"
|
2020-05-18 09:24:09 +00:00
|
|
|
|
|
|
|
Do not forget to replace "yoursecretkey" and "yourpubliccert" with your own values.
|