...
By default in Tutor, the name of the edx-platform service database is
openedx
while it’s callededxapp
in the native installation. You have two options: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:Add
DROP DATABASE openedx;
to the SQL file above theCREATE DATABASE
line.Change
CREATE DATABASE /*!32312 IF NOT EXISTS*/
edxapp/*!40100 DEFAULT CHARACTER SET utf8 */;
toCREATE DATABASE /*!32312 IF NOT EXISTS*/
openedx/*!40100 DEFAULT CHARACTER SET utf8 */;
Change
USE
edxapp;
toUSE
openedx;
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_DATABASE: edxapp
OPENEDX_MYSQL_PASSWORD: <mysql_password>
OPENEDX_MYSQL_USERNAME: edxapp001 |
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
Discovery
...
Note |
---|
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.
Discovery
Install and enable the discovery plugin.
Skip the initialisation step and start the discovery service with
tutor local start discovery -d
.Navigate to the discovery admin panel, and delete (in that order) any partners (Core > Partners) and then your site (Sites > sites).
Navigate to the LMS admin panel and delete the existing OAuth clients related to discovery.
Turn off the discovery service with
tutor local stop discovery
.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.
...
Theme
Custom YAML Plugin
Code Block | ||
---|---|---|
| ||
name: myplugin version: 0.1.0 patches: openedx-common-settings: | LOGO_URL = "<URL_TO_LOGO>" LOGO_URL_PNG = "<URL_TO_LOGO_PNG>" openedx-lms-production-settings: | PROFILE_IMAGE_SECRET_KEY = '<KEY>' |
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
...
patch.
Maintain your tutor instance
...