Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


  1. By default in Tutor, the name of the edx-platform service database is openedx while it’s called edxapp in the native installation. You have two options:

    1. Add OPENEDX_MYSQL_DATABASE: edxapp to your $(tutor config printroot)/config.yml file. (This is probably ideal if you are using an external database provider.)(Recommended) Edit your MySQL dump file:

      1. Add DROP DATABASE openedx; to the SQL file above the CREATE DATABASE line.

      2. Change CREATE DATABASE /*!32312 IF NOT EXISTS*/ edxapp /*!40100 DEFAULT CHARACTER SET utf8 */; to CREATE DATABASE /*!32312 IF NOT EXISTS*/ openedx /*!40100 DEFAULT CHARACTER SET utf8 */;

      3. Change USE edxapp; to USE openedx;

    2. Set OPENEDX_MYSQL_DATABASE: edxapp in your $(tutor config printroot)/config.yml file. If you are using an external database provider, you should set the following

Code Block
OPENEDX_MYSQL_PASSWORD: <mysql_password>
  1. Run the following command to restore your data


Copy the content from /edx/var/edxapp/media to $TUTOR_ROOT/data/openedx-media.

Other services

  • OAuth Clients names

  • Site configurations




The following steps are for guidance only, make sure they are suitable for your use case.

Tutor takes care of the configuration of the different services. For a service like discovery, it includes configuring the site, the partners and the OAuth clients. Unless you have a particular use case, the easiest way forward is to let Tutor handle the initialisation of the services as this makes upgrading to different Open edX release versions easier.


  1. Install and enable the discovery plugin.

  2. Skip the initialisation step and start the discovery service with tutor local start discovery -d.

  3. Navigate to the discovery admin panel, and delete (in that order) any partners (Core > Partners) and then your site (Sites > sites).

  4. Navigate to the LMS admin panel and delete the existing OAuth clients related to discovery.

  5. Turn off the discovery service with tutor local stop discovery.

  6. Initialise the service tutor local init -l discovery.

4. Customise your tutor instance


  • Identify whether there is value in config.yml

  • Find the patch

    • it's better if settings are defined directly in the python modules, to avoid code indirections.



Custom YAML Plugin

Code Block
name: myplugin
version: 0.1.0
  openedx-common-settings: |
  openedx-lms-production-settings: |

To be able to use the profile images that you’ve copied from you media folder, you need to copy the PROFILE_IMAGE_SECRET_KEY setting from your native configuration in the openedx-lms-production-settings



Maintain your tutor instance