mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-05-29 20:30:48 +00:00
33e4f33afe
Now that the mypy bugs have been resolved, we are able to define more precisely and cleanly the types of Actions and Filters. Moreover, can now strongly type named actions and hooks (in consts.py). With such a strong typing, we get early alerts of hooks called with incorrect arguments, which is nothing short of awesome :) This change breaks the hooks API by removing the `context=...` argument. The reason for that is that we cannot insert arbitrary arguments between `P.args, P.kwargs`: https://peps.python.org/pep-0612/#the-components-of-a-paramspec > A function declared as def inner(a: A, b: B, *args: P.args, **kwargs: > P.kwargs) -> R has type Callable[Concatenate[A, B, P], R]. Placing > keyword-only parameters between the *args and **kwargs is forbidden. Getting the documentation to build in nitpicky mode is quite difficult... We need to add `nitpick_ignore` to the docs conf.py, otherwise sphinx complains about many missing class references. This, despite upgrading almost all doc requirements (except docutils).
176 lines
6.6 KiB
Python
176 lines
6.6 KiB
Python
####### Settings common to LMS and CMS
|
|
import json
|
|
import os
|
|
|
|
from xmodule.modulestore.modulestore_settings import update_module_store_settings
|
|
|
|
# Mongodb connection parameters: simply modify `mongodb_parameters` to affect all connections to MongoDb.
|
|
mongodb_parameters = {
|
|
"host": "{{ MONGODB_HOST }}",
|
|
"port": {{ MONGODB_PORT }},
|
|
{% if MONGODB_USERNAME and MONGODB_PASSWORD %}
|
|
"user": "{{ MONGODB_USERNAME }}",
|
|
"password": "{{ MONGODB_PASSWORD }}",
|
|
{% else %}
|
|
"user": None,
|
|
"password": None,
|
|
{% endif %}
|
|
"db": "{{ MONGODB_DATABASE }}",
|
|
"replicaSet": None,
|
|
}
|
|
DOC_STORE_CONFIG = mongodb_parameters
|
|
CONTENTSTORE = {
|
|
"ENGINE": "xmodule.contentstore.mongo.MongoContentStore",
|
|
"ADDITIONAL_OPTIONS": {},
|
|
"DOC_STORE_CONFIG": DOC_STORE_CONFIG
|
|
}
|
|
# Load module store settings from config files
|
|
update_module_store_settings(MODULESTORE, doc_store_settings=DOC_STORE_CONFIG)
|
|
DATA_DIR = "/openedx/data/modulestore"
|
|
|
|
for store in MODULESTORE["default"]["OPTIONS"]["stores"]:
|
|
store["OPTIONS"]["fs_root"] = DATA_DIR
|
|
|
|
# Behave like memcache when it comes to connection errors
|
|
DJANGO_REDIS_IGNORE_EXCEPTIONS = True
|
|
|
|
# Elasticsearch connection parameters
|
|
ELASTIC_SEARCH_CONFIG = [{
|
|
{% if ELASTICSEARCH_SCHEME == "https" %}"use_ssl": True,{% endif %}
|
|
"host": "{{ ELASTICSEARCH_HOST }}",
|
|
"port": {{ ELASTICSEARCH_PORT }},
|
|
}]
|
|
|
|
CONTACT_MAILING_ADDRESS = "{{ PLATFORM_NAME }} - {% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}"
|
|
|
|
DEFAULT_FROM_EMAIL = ENV_TOKENS.get("DEFAULT_FROM_EMAIL", ENV_TOKENS["CONTACT_EMAIL"])
|
|
DEFAULT_FEEDBACK_EMAIL = ENV_TOKENS.get("DEFAULT_FEEDBACK_EMAIL", ENV_TOKENS["CONTACT_EMAIL"])
|
|
SERVER_EMAIL = ENV_TOKENS.get("SERVER_EMAIL", ENV_TOKENS["CONTACT_EMAIL"])
|
|
TECH_SUPPORT_EMAIL = ENV_TOKENS.get("TECH_SUPPORT_EMAIL", ENV_TOKENS["CONTACT_EMAIL"])
|
|
CONTACT_EMAIL = ENV_TOKENS.get("CONTACT_EMAIL", ENV_TOKENS["CONTACT_EMAIL"])
|
|
BUGS_EMAIL = ENV_TOKENS.get("BUGS_EMAIL", ENV_TOKENS["CONTACT_EMAIL"])
|
|
UNIVERSITY_EMAIL = ENV_TOKENS.get("UNIVERSITY_EMAIL", ENV_TOKENS["CONTACT_EMAIL"])
|
|
PRESS_EMAIL = ENV_TOKENS.get("PRESS_EMAIL", ENV_TOKENS["CONTACT_EMAIL"])
|
|
PAYMENT_SUPPORT_EMAIL = ENV_TOKENS.get("PAYMENT_SUPPORT_EMAIL", ENV_TOKENS["CONTACT_EMAIL"])
|
|
BULK_EMAIL_DEFAULT_FROM_EMAIL = ENV_TOKENS.get("BULK_EMAIL_DEFAULT_FROM_EMAIL", ENV_TOKENS["CONTACT_EMAIL"])
|
|
API_ACCESS_MANAGER_EMAIL = ENV_TOKENS.get("API_ACCESS_MANAGER_EMAIL", ENV_TOKENS["CONTACT_EMAIL"])
|
|
API_ACCESS_FROM_EMAIL = ENV_TOKENS.get("API_ACCESS_FROM_EMAIL", ENV_TOKENS["CONTACT_EMAIL"])
|
|
|
|
# Get rid completely of coursewarehistoryextended, as we do not use the CSMH database
|
|
INSTALLED_APPS.remove("lms.djangoapps.coursewarehistoryextended")
|
|
DATABASE_ROUTERS.remove(
|
|
"openedx.core.lib.django_courseware_routers.StudentModuleHistoryExtendedRouter"
|
|
)
|
|
|
|
# Set uploaded media file path
|
|
MEDIA_ROOT = "/openedx/media/"
|
|
|
|
# Add your MFE and third-party app domains here
|
|
CORS_ORIGIN_WHITELIST = []
|
|
|
|
# Video settings
|
|
VIDEO_IMAGE_SETTINGS["STORAGE_KWARGS"]["location"] = MEDIA_ROOT
|
|
VIDEO_TRANSCRIPTS_SETTINGS["STORAGE_KWARGS"]["location"] = MEDIA_ROOT
|
|
|
|
GRADES_DOWNLOAD = {
|
|
"STORAGE_TYPE": "",
|
|
"STORAGE_KWARGS": {
|
|
"base_url": "/media/grades/",
|
|
"location": "/openedx/media/grades",
|
|
},
|
|
}
|
|
|
|
ORA2_FILEUPLOAD_BACKEND = "filesystem"
|
|
ORA2_FILEUPLOAD_ROOT = "/openedx/data/ora2"
|
|
ORA2_FILEUPLOAD_CACHE_NAME = "ora2-storage"
|
|
|
|
# Change syslog-based loggers which don't work inside docker containers
|
|
LOGGING["handlers"]["local"] = {
|
|
"class": "logging.handlers.WatchedFileHandler",
|
|
"filename": os.path.join(LOG_DIR, "all.log"),
|
|
"formatter": "standard",
|
|
}
|
|
LOGGING["handlers"]["tracking"] = {
|
|
"level": "DEBUG",
|
|
"class": "logging.handlers.WatchedFileHandler",
|
|
"filename": os.path.join(LOG_DIR, "tracking.log"),
|
|
"formatter": "standard",
|
|
}
|
|
LOGGING["loggers"]["tracking"]["handlers"] = ["console", "local", "tracking"]
|
|
# Silence some loggers (note: we must attempt to get rid of these when upgrading from one release to the next)
|
|
|
|
import warnings
|
|
from django.utils.deprecation import RemovedInDjango40Warning, RemovedInDjango41Warning
|
|
warnings.filterwarnings("ignore", category=RemovedInDjango40Warning)
|
|
warnings.filterwarnings("ignore", category=RemovedInDjango41Warning)
|
|
warnings.filterwarnings("ignore", category=DeprecationWarning, module="lms.djangoapps.course_wiki.plugins.markdownedx.wiki_plugin")
|
|
warnings.filterwarnings("ignore", category=DeprecationWarning, module="wiki.plugins.links.wiki_plugin")
|
|
|
|
# Email
|
|
EMAIL_USE_SSL = {{ SMTP_USE_SSL }}
|
|
# Forward all emails from edX's Automated Communication Engine (ACE) to django.
|
|
ACE_ENABLED_CHANNELS = ["django_email"]
|
|
ACE_CHANNEL_DEFAULT_EMAIL = "django_email"
|
|
ACE_CHANNEL_TRANSACTIONAL_EMAIL = "django_email"
|
|
EMAIL_FILE_PATH = "/tmp/openedx/emails"
|
|
|
|
# Language/locales
|
|
LOCALE_PATHS.append("/openedx/locale/contrib/locale")
|
|
LOCALE_PATHS.append("/openedx/locale/user/locale")
|
|
LANGUAGE_COOKIE_NAME = "openedx-language-preference"
|
|
|
|
# Allow the platform to include itself in an iframe
|
|
X_FRAME_OPTIONS = "SAMEORIGIN"
|
|
|
|
{% set jwt_rsa_key | rsa_import_key %}{{ JWT_RSA_PRIVATE_KEY }}{% endset %}
|
|
JWT_AUTH["JWT_ISSUER"] = "{{ JWT_COMMON_ISSUER }}"
|
|
JWT_AUTH["JWT_AUDIENCE"] = "{{ JWT_COMMON_AUDIENCE }}"
|
|
JWT_AUTH["JWT_SECRET_KEY"] = "{{ JWT_COMMON_SECRET_KEY }}"
|
|
JWT_AUTH["JWT_PRIVATE_SIGNING_JWK"] = json.dumps(
|
|
{
|
|
"kid": "openedx",
|
|
"kty": "RSA",
|
|
"e": "{{ jwt_rsa_key.e|long_to_base64 }}",
|
|
"d": "{{ jwt_rsa_key.d|long_to_base64 }}",
|
|
"n": "{{ jwt_rsa_key.n|long_to_base64 }}",
|
|
"p": "{{ jwt_rsa_key.p|long_to_base64 }}",
|
|
"q": "{{ jwt_rsa_key.q|long_to_base64 }}",
|
|
}
|
|
)
|
|
JWT_AUTH["JWT_PUBLIC_SIGNING_JWK_SET"] = json.dumps(
|
|
{
|
|
"keys": [
|
|
{
|
|
"kid": "openedx",
|
|
"kty": "RSA",
|
|
"e": "{{ jwt_rsa_key.e|long_to_base64 }}",
|
|
"n": "{{ jwt_rsa_key.n|long_to_base64 }}",
|
|
}
|
|
]
|
|
}
|
|
)
|
|
JWT_AUTH["JWT_ISSUERS"] = [
|
|
{
|
|
"ISSUER": "{{ JWT_COMMON_ISSUER }}",
|
|
"AUDIENCE": "{{ JWT_COMMON_AUDIENCE }}",
|
|
"SECRET_KEY": "{{ OPENEDX_SECRET_KEY }}"
|
|
}
|
|
]
|
|
|
|
# Enable/Disable some features globally
|
|
FEATURES["ENABLE_DISCUSSION_SERVICE"] = False
|
|
FEATURES["PREVENT_CONCURRENT_LOGINS"] = False
|
|
|
|
# Disable codejail support
|
|
# explicitely configuring python is necessary to prevent unsafe calls
|
|
import codejail.jail_code
|
|
codejail.jail_code.configure("python", "nonexistingpythonbinary", user=None)
|
|
# another configuration entry is required to override prod/dev settings
|
|
CODE_JAIL = {
|
|
"python_bin": "nonexistingpythonbinary",
|
|
"user": None,
|
|
}
|
|
|
|
{{ patch("openedx-common-settings") }}
|
|
######## End of settings common to LMS and CMS
|