Example Open edX lms.env.json

This is a sample configuration file for a hypothetical organization named Surf School. And no, there is not an Xblock to simulate surfing!

This sample demonstrates which URLs you should, and should not modify when setting your fully-qualified domain name. You can also use this file as a reference to better understand which parameters should be set for an ordinary installation.

{
    "ACE_CHANNEL_SAILTHRU_DEBUG": true,
    "ACE_CHANNEL_SAILTHRU_TEMPLATE_NAME": null,
    "ACE_ENABLED_CHANNELS": [],
    "ACE_ENABLED_POLICIES": [],
    "ACE_ROUTING_KEY": "edx.lms.core.low",
    "ACTIVATION_EMAIL_SUPPORT_LINK": "",
    "AFFILIATE_COOKIE_NAME": "dev_affiliate_id",
    "ALTERNATE_WORKER_QUEUES": "cms",
    "ANALYTICS_DASHBOARD_NAME": "Surf School",
    "ANALYTICS_DASHBOARD_URL": "https://www.surfschool.edu:18110/courses",
    "API_ACCESS_FROM_EMAIL": "surfschool@gmail.com",
    "API_ACCESS_MANAGER_EMAIL": "surfschool@gmail.com",
    "API_DOCUMENTATION_URL": "http://course-catalog-api-guide.readthedocs.io/en/latest/",
    "AUDIT_CERT_CUTOFF_DATE": null,
    "AUTH_DOCUMENTATION_URL": "http://course-catalog-api-guide.readthedocs.io/en/latest/authentication/index.html",
    "AWS_SES_REGION_ENDPOINT": "email.us-east-1.amazonaws.com",
    "AWS_SES_REGION_NAME": "us-east-1",
    "BASE_COOKIE_DOMAIN": "www.surfschool.edu",
    "BLOCK_STRUCTURES_SETTINGS": {
        "COURSE_PUBLISH_TASK_DELAY": 30,
        "TASK_DEFAULT_RETRY_DELAY": 30,
        "TASK_MAX_RETRIES": 5
    },
    "BUGS_EMAIL": "surfschool@gmail.com",
    "BULK_EMAIL_DEFAULT_FROM_EMAIL": "surfschool@gmail.com",
    "BULK_EMAIL_EMAILS_PER_TASK": 500,
    "BULK_EMAIL_LOG_SENT_EMAILS": false,
    "BULK_EMAIL_ROUTING_KEY_SMALL_JOBS": "edx.lms.core.low",
    "CACHES": {
        "celery": {
            "BACKEND": "django.core.cache.backends.memcached.MemcachedCache",
            "KEY_FUNCTION": "util.memcache.safe_key",
            "KEY_PREFIX": "celery",
            "LOCATION": [
                "localhost:11211"
            ],
            "TIMEOUT": "7200"
        },
        "configuration": {
            "BACKEND": "django.core.cache.backends.memcached.MemcachedCache",
            "KEY_FUNCTION": "util.memcache.safe_key",
            "KEY_PREFIX": "ip-172-31-88-100",
            "LOCATION": [
                "localhost:11211"
            ]
        },
        "course_structure_cache": {
            "BACKEND": "django.core.cache.backends.memcached.MemcachedCache",
            "KEY_FUNCTION": "util.memcache.safe_key",
            "KEY_PREFIX": "course_structure",
            "LOCATION": [
                "localhost:11211"
            ],
            "TIMEOUT": "7200"
        },
        "default": {
            "BACKEND": "django.core.cache.backends.memcached.MemcachedCache",
            "KEY_FUNCTION": "util.memcache.safe_key",
            "KEY_PREFIX": "default",
            "LOCATION": [
                "localhost:11211"
            ],
            "VERSION": "1"
        },
        "general": {
            "BACKEND": "django.core.cache.backends.memcached.MemcachedCache",
            "KEY_FUNCTION": "util.memcache.safe_key",
            "KEY_PREFIX": "general",
            "LOCATION": [
                "localhost:11211"
            ]
        },
        "mongo_metadata_inheritance": {
            "BACKEND": "django.core.cache.backends.memcached.MemcachedCache",
            "KEY_FUNCTION": "util.memcache.safe_key",
            "KEY_PREFIX": "mongo_metadata_inheritance",
            "LOCATION": [
                "localhost:11211"
            ],
            "TIMEOUT": 300
        },
        "staticfiles": {
            "BACKEND": "django.core.cache.backends.memcached.MemcachedCache",
            "KEY_FUNCTION": "util.memcache.safe_key",
            "KEY_PREFIX": "ip-172-31-88-100_general",
            "LOCATION": [
                "localhost:11211"
            ]
        }
    },
    "CAS_ATTRIBUTE_CALLBACK": "",
    "CAS_EXTRA_LOGIN_PARAMS": "",
    "CAS_SERVER_URL": "",
    "CDN_VIDEO_URLS": {},
    "CELERY_BROKER_HOSTNAME": "localhost",
    "CELERY_BROKER_TRANSPORT": "amqp",
    "CELERY_BROKER_USE_SSL": false,
    "CELERY_BROKER_VHOST": "",
    "CELERY_EVENT_QUEUE_TTL": null,
    "CELERY_QUEUES": [
        "edx.lms.core.low",
        "edx.lms.core.default",
        "edx.lms.core.high",
        "edx.lms.core.high_mem"
    ],
    "CERTIFICATE_TEMPLATE_LANGUAGES": {
        "en": "English",
        "es": "Espa\u00f1ol"
    },
    "CERT_QUEUE": "certificates",
    "CMS_BASE": "studio.surfschool",
    "CODE_JAIL": {
        "limits": {
            "CPU": 1,
            "FSIZE": 1048576,
            "PROXY": 0,
            "REALTIME": 3,
            "VMEM": 536870912
        },
        "python_bin": "/edx/app/edxapp/venvs/edxapp-sandbox/bin/python",
        "user": "sandbox"
    },
    "COMMENTS_SERVICE_KEY": "xrs9lSMqFiOaITw8TDi3sKmU1SYmUQVjr16",
    "COMMENTS_SERVICE_URL": "https://www.surfschool.edu:18080",
    "COMPREHENSIVE_THEME_DIR": "",
    "COMPREHENSIVE_THEME_DIRS": [
        "/home/ubuntu/edx.config-atentamente/themes"
    ],
    "COMPREHENSIVE_THEME_LOCALE_PATHS": [],
    "CONTACT_EMAIL": "surfschool@gmail.com",
    "CONTACT_MAILING_ADDRESS": "SET-ME-PLEASE",
    "CORS_ORIGIN_ALLOW_ALL": false,
    "CORS_ORIGIN_WHITELIST": [],
    "COURSES_WITH_UNSAFE_CODE": [],
    "COURSE_ABOUT_VISIBILITY_PERMISSION": "see_exists",
    "COURSE_CATALOG_API_URL": "https://www.surfschool.edu:8008/api/v1",
    "COURSE_CATALOG_VISIBILITY_PERMISSION": "see_exists",
    "CREDENTIALS_INTERNAL_SERVICE_URL": "https://www.surfschool.edu:8005",
    "CREDENTIALS_PUBLIC_SERVICE_URL": "https://www.surfschool.edu:8005",
    "CREDIT_HELP_LINK_URL": "",
    "CROSS_DOMAIN_CSRF_COOKIE_DOMAIN": "",
    "CROSS_DOMAIN_CSRF_COOKIE_NAME": "",
    "CSRF_COOKIE_SECURE": false,
    "DEFAULT_FEEDBACK_EMAIL": "surfschool@gmail.com",
    "DEFAULT_FILE_STORAGE": "django.core.files.storage.FileSystemStorage",
    "DEFAULT_FROM_EMAIL": "surfschool@gmail.com",
    "DEFAULT_MOBILE_AVAILABLE": false,
    "DEFAULT_SITE_THEME": "red-theme",
    "DEPRECATED_ADVANCED_COMPONENT_TYPES": [],
    "ECOMMERCE_API_URL": "https://www.surfschool.edu:8002/api/v2",
    "ECOMMERCE_PUBLIC_URL_ROOT": "https://www.surfschool.edu:8002",
    "EDXMKTG_USER_INFO_COOKIE_NAME": "edx-user-info",
    "EDXNOTES_INTERNAL_API": "https://www.surfschool.edu:18120/api/v1",
    "EDXNOTES_PUBLIC_API": "https://www.surfschool.edu:18120/api/v1",
    "ELASTIC_SEARCH_CONFIG": [
        {
            "host": "localhost",
            "port": 9200,
            "use_ssl": false
        }
    ],
    "EMAIL_BACKEND": "django.core.mail.backends.smtp.EmailBackend",
    "EMAIL_HOST": "smtp.gmail.com",
    "EMAIL_PORT": 587,
    "EMAIL_USE_TLS": true,
    "ENABLE_COMPREHENSIVE_THEMING": true,
    "ENTERPRISE_API_URL": "https://www.surfschool.edu/enterprise/api/v1",
    "ENTERPRISE_COURSE_ENROLLMENT_AUDIT_MODES": [
        "audit",
        "honor"
    ],
    "ENTERPRISE_ENROLLMENT_API_URL": "https://www.surfschool.edu/api/enrollment/v1/",
    "ENTERPRISE_SUPPORT_URL": "",
    "ENTERPRISE_TAGLINE": "",
    "EXTRA_MIDDLEWARE_CLASSES": [],
    "FEATURES": {
        "AUTH_USE_OPENID_PROVIDER": true,
        "AUTOMATIC_AUTH_FOR_TESTING": false,
        "CUSTOM_COURSES_EDX": false,
        "ENABLE_COMBINED_LOGIN_REGISTRATION": true,
        "ENABLE_CORS_HEADERS": true,
        "ENABLE_COUNTRY_ACCESS": false,
        "ENABLE_CREDIT_API": false,
        "ENABLE_CREDIT_ELIGIBILITY": false,
        "ENABLE_CROSS_DOMAIN_CSRF_COOKIE": false,
        "ENABLE_CSMH_EXTENDED": true,
        "ENABLE_DISCUSSION_HOME_PANEL": true,
        "ENABLE_DISCUSSION_SERVICE": true,
        "ENABLE_EDXNOTES": true,
        "ENABLE_GRADE_DOWNLOADS": true,
        "ENABLE_INSTRUCTOR_ANALYTICS": true,
        "ENABLE_MKTG_SITE": false,
        "ENABLE_MOBILE_REST_API": true,
        "ENABLE_OAUTH2_PROVIDER": true,
        "ENABLE_ONLOAD_BEACON": false,
        "ENABLE_READING_FROM_MULTIPLE_HISTORY_TABLES": true,
        "ENABLE_SPECIAL_EXAMS": false,
        "ENABLE_SYSADMIN_DASHBOARD": true,
        "ENABLE_THIRD_PARTY_AUTH": true,
        "ENABLE_VIDEO_BEACON": false,
        "ENABLE_VIDEO_UPLOAD_PIPELINE": false,
        "PREVIEW_LMS_BASE": "preview.surfschool.edu",
        "SHOW_FOOTER_LANGUAGE_SELECTOR": false,
        "SHOW_HEADER_LANGUAGE_SELECTOR": false
    },
    "FEEDBACK_SUBMISSION_EMAIL": "",
    "FILE_UPLOAD_STORAGE_BUCKET_NAME": "SET-ME-PLEASE (ex. bucket-name)",
    "FILE_UPLOAD_STORAGE_PREFIX": "submissions_attachments",
    "FINANCIAL_REPORTS": {
        "BUCKET": null,
        "ROOT_PATH": "sandbox",
        "STORAGE_TYPE": "localfs"
    },
    "FOOTER_ORGANIZATION_IMAGE": "images/logo.png",
    "GITHUB_REPO_ROOT": "/edx/var/edxapp/data",
    "GIT_REPO_DIR": "/edx/var/edxapp/course_repos",
    "GRADES_DOWNLOAD": {
        "BUCKET": "",
        "ROOT_PATH": "",
        "STORAGE_CLASS": "django.core.files.storage.FileSystemStorage",
        "STORAGE_KWARGS": {
            "location": "/tmp/edx-s3/grades"
        },
        "STORAGE_TYPE": ""
    },
    "HELP_TOKENS_BOOKS": {
        "course_author": "http://edx.readthedocs.io/projects/open-edx-building-and-running-a-course",
        "learner": "http://edx.readthedocs.io/projects/open-edx-learner-guide"
    },
    "ICP_LICENSE": null,
    "JWT_AUTH": {
        "JWT_AUDIENCE": "SET-ME-PLEASE",
        "JWT_ISSUER": "https://www.surfschool.edu/oauth2",
        "JWT_SECRET_KEY": "SET-ME-PLEASE"
    },
    "JWT_EXPIRATION": 30,
    "JWT_EXPIRED_PRIVATE_SIGNING_KEYS": [],
    "JWT_ISSUER": "https://www.surfschool.edu/oauth2",
    "JWT_PRIVATE_SIGNING_KEY": null,
    "LANGUAGE_CODE": "es-419",
    "LANGUAGE_COOKIE": "openedx-language-preference",
    "LMS_BASE": "www.surfschool.edu",
    "LMS_INTERNAL_ROOT_URL": "https://www.surfschool.edu",
    "LMS_ROOT_URL": "https://www.surfschool.edu",
    "LOCAL_LOGLEVEL": "INFO",
    "LOGGING_ENV": "sandbox",
    "LOG_DIR": "/edx/var/logs/edx",
    "LTI_AGGREGATE_SCORE_PASSBACK_DELAY": 900,
    "LTI_USER_EMAIL_DOMAIN": "lti.example.com",
    "MAILCHIMP_NEW_USER_LIST_ID": null,
    "MEDIA_ROOT": "/edx/var/edxapp/media/",
    "MEDIA_URL": "/media/",
    "MICROSITE_CONFIGURATION": {},
    "MICROSITE_ROOT_DIR": "/edx/app/edxapp/edx-microsite",
    "MKTG_URLS": {},
    "MKTG_URL_LINK_MAP": {
      "HUMANS.TXT" : "humans.txt",
      "google6cbb6205949078af.html" : "google6cbb6205949078af.html",
      "sitemap.xml" : "sitemap.xml"
    },
    "MOBILE_STORE_URLS": {},
    "OAUTH_DELETE_EXPIRED": true,
    "OAUTH_ENFORCE_SECURE": false,
    "OAUTH_EXPIRE_CONFIDENTIAL_CLIENT_DAYS": 365,
    "OAUTH_EXPIRE_PUBLIC_CLIENT_DAYS": 30,
    "OAUTH_OIDC_ISSUER": "",
    "ONLOAD_BEACON_SAMPLE_RATE": 0.0,
    "ORA2_FILE_PREFIX": "default_env-default_deployment/ora2",
    "PAID_COURSE_REGISTRATION_CURRENCY": [
        "usd",
        "$"
    ],
    "PARENTAL_CONSENT_AGE_LIMIT": 13,
    "PARTNER_SUPPORT_EMAIL": "",
    "PASSWORD_MAX_LENGTH": 75,
    "PASSWORD_MIN_LENGTH": 2,
    "PASSWORD_RESET_SUPPORT_LINK": "",
    "PAYMENT_SUPPORT_EMAIL": "surfschool@gmail.com",
    "PDF_RECEIPT_BILLING_ADDRESS": "Enter your receipt billing\naddress here.\n",
    "PDF_RECEIPT_COBRAND_LOGO_PATH": "",
    "PDF_RECEIPT_DISCLAIMER_TEXT": "ENTER YOUR RECEIPT DISCLAIMER TEXT HERE.\n",
    "PDF_RECEIPT_FOOTER_TEXT": "Enter your receipt footer text here.\n",
    "PDF_RECEIPT_LOGO_PATH": "",
    "PDF_RECEIPT_TAX_ID": "00-0000000",
    "PDF_RECEIPT_TAX_ID_LABEL": "fake Tax ID",
    "PDF_RECEIPT_TERMS_AND_CONDITIONS": "Enter your receipt terms and conditions here.\n",
    "PERFORMANCE_GRAPHITE_URL": "SetPerformanceGraphiteHostName",
    "PLATFORM_DESCRIPTION": "Surf School",
    "PLATFORM_FACEBOOK_ACCOUNT": "http://www.facebook.com/YourPlatformFacebookAccount",
    "PLATFORM_NAME": "Surf School",
    "PLATFORM_TWITTER_ACCOUNT": "@YourPlatformTwitterAccount",
    "POLICY_CHANGE_GRADES_ROUTING_KEY": "edx.lms.core.default",
    "PRESS_EMAIL": "surfschool@gmail.com",
    "PROCTORING_SETTINGS": {},
    "PROFILE_IMAGE_BACKEND": {
        "class": "storages.backends.overwrite.OverwriteStorage",
        "options": {
            "base_url": "/media/profile-images/",
            "location": "/edx/var/edxapp/media/profile-images/"
        }
    },
    "PROFILE_IMAGE_MAX_BYTES": 1048576,
    "PROFILE_IMAGE_MIN_BYTES": 100,
    "PROFILE_IMAGE_SIZES_MAP": {
        "full": 500,
        "large": 120,
        "medium": 50,
        "small": 30
    },
    "RECALCULATE_GRADES_ROUTING_KEY": "edx.lms.core.default",
    "REGISTRATION_EXTRA_FIELDS": {
        "city": "hidden",
        "confirm_email": "hidden",
        "country": "required",
        "gender": "optional",
        "goals": "optional",
        "honor_code": "required",
        "level_of_education": "optional",
        "mailing_address": "hidden",
        "terms_of_service": "hidden",
        "year_of_birth": "optional"
    },
    "SERVER_EMAIL": "surfschool@gmail.com",
    "SESSION_COOKIE_DOMAIN": "",
    "SESSION_COOKIE_NAME": "sessionid",
    "SESSION_COOKIE_SECURE": false,
    "SESSION_SAVE_EVERY_REQUEST": false,
    "SITE_NAME": "www.surfschool.edu",
    "SOCIAL_MEDIA_FOOTER_URLS": {},
    "SOCIAL_SHARING_SETTINGS": {
        "CERTIFICATE_FACEBOOK": false,
        "CERTIFICATE_TWITTER": false,
        "CUSTOM_COURSE_URLS": false,
        "DASHBOARD_FACEBOOK": false,
        "DASHBOARD_TWITTER": false
    },
    "STATIC_ROOT_BASE": "/edx/var/edxapp/staticfiles",
    "STATIC_URL_BASE": "/static/",
    "STUDIO_NAME": "Studio",
    "STUDIO_SHORT_NAME": "Studio",
    "SUPPORT_SITE_LINK": "",
    "SYSLOG_SERVER": "",
    "TECH_SUPPORT_EMAIL": "surfschool@gmail.com",
    "TIME_ZONE": "America/New_York",
    "UNIVERSITY_EMAIL": "surfschool@gmail.com",
    "VIDEO_CDN_URL": {
        "EXAMPLE_COUNTRY_CODE": "http://example.com/edx/video?s3_url="
    },
    "VIDEO_IMAGE_MAX_AGE": 31536000,
    "VIDEO_IMAGE_SETTINGS": {
        "DIRECTORY_PREFIX": "video-images/",
        "STORAGE_KWARGS": {
            "base_url": "/media/",
            "location": "/edx/var/edxapp/media/"
        },
        "VIDEO_IMAGE_MAX_BYTES": 2097152,
        "VIDEO_IMAGE_MIN_BYTES": 2048
    },
    "VIDEO_TRANSCRIPTS_MAX_AGE": 31536000,
    "VIDEO_TRANSCRIPTS_SETTINGS": {
        "DIRECTORY_PREFIX": "video-transcripts/",
        "STORAGE_KWARGS": {
            "base_url": "/media/",
            "location": "/edx/var/edxapp/media/"
        },
        "VIDEO_TRANSCRIPTS_MAX_BYTES": 3145728
    },
    "VIDEO_UPLOAD_PIPELINE": {
        "BUCKET": "",
        "ROOT_PATH": ""
    },
    "VIRTUAL_UNIVERSITIES": [],
    "WIKI_ENABLED": true,
    "XBLOCK_FS_STORAGE_BUCKET": null,
    "XBLOCK_FS_STORAGE_PREFIX": null,
    "XBLOCK_SETTINGS": {},
    "ZENDESK_CUSTOM_FIELDS": {},
    "ZENDESK_URL": "",
    "THIRD_PARTY_AUTH_BACKENDS": [
      "third_party_auth.saml.SAMLAuthBackend"
    ]
}

By |2018-10-19T17:18:11-06:00October 15th, 2017|Categories: Open edX|0 Comments

About the Author:

Lawrence is a full stack developer specializing in the Open edX platform, Django, Angular, Ionic, Wordpress and Amazon Web Services. He lives in Puerto Escondido, Oaxaca, Mexico.

Leave A Comment

This site uses Akismet to reduce spam. Learn how your comment data is processed.