Skip to content
Snippets Groups Projects
Commit f5da0064 authored by Feanil Patel's avatar Feanil Patel
Browse files

Update some really out of date docs for settings.

parent 1b1c6c75
No related branches found
Tags release-2020-12-18-12.59
No related merge requests found
......@@ -13,20 +13,16 @@ as shown in the diagram below.
.. image:: images/lms_settings.png
JSON Configuration Files
YAML Configuration Files
------------------------
In addition, there is a mechanism for reading and overriding configuration
settings from JSON files on-disk. The :file:`/lms/envs/production.py` module loads
settings from ``lms.env.json`` and ``lms.auth.json`` files. All
security-sensitive settings and data belong in the ``lms.auth.json`` file, while
the rest are configured via the ``lms.env.json`` file.
In addition, there is a mechanism for reading and overriding configuration settings from YAML files on-disk. The :file:`/lms/envs/production.py` module loads settings from a YAML file. The location of the YAML file is pulled from the value of the ``LMS_CFG`` environment variable. Except for a limited set of exceptions, if a key exists in the YAML file, it will be injected into the settings module as it is defined in the YAML file.
These JSON files allow open edX operators to configure the django runtime
The YAML file allow open edX operators to configure the Django runtime
without needing to make any changes to source-controlled python files in
edx-platform. Therefore, they are not checked into the edx-platform repo.
Rather, they are generated from the `edxapp playbook in the configuration
repo`_ and available in the ``/edx/app/edxapp/`` folder on edX servers.
repo`_ and available in the ``/edx/etc/`` folder on edX servers.
.. _edxapp playbook in the configuration repo: https://github.com/edx/configuration/tree/master/playbooks/roles/edxapp
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment