What should you do if you have a problem?
Read the error logs that appear in the console. When running a single server platform as daemon, you can view the logs with the
docker-compose logscommand. (see Logging below)
Check if your problem already has a solution right here in the Troubleshooting section.
Search for your problem in the open and closed Github issues.
If, despite all your efforts, you can’t solve the problem, decide if the issue is related to Open edX or if it’s specific to Tutor. In the latter case, you are most welcome to open an issue on Github. Please follow the instructions from the issue template!!! Your issue will be examined in all cases, but you can make my life much easier by giving me as much background information as possible.
To view the logs from all containers use the
tutor local logs command, which was modeled on the standard docker-compose logs command:
tutor local logs --follow
To view the logs from just one container, for instance the web server:
tutor local logs --follow nginx
The last commands produce the logs since the creation of the containers, which can be a lot. Similar to a
tail -f, you can run:
tutor local logs--tail=0 -f
If you’d rather use a graphical user interface for viewing logs, you are encouraged to try out Portainer.
“Cannot start service nginx: driver failed programming external connectivity”¶
The containerized Nginx needs to listen to ports 80 and 443 on the host. If there is already a webserver, such as Apache or Nginx, running on the host, the nginx container will not be able to start. To solve this issue, check the section on how to setup a web proxy.
Help! The Docker containers are eating all my RAM/CPU/CHEESE¶
You can identify which containers are consuming most resources by running:
“Running migrations… Killed!”¶
Older versions of Open edX required at least 4 GB RAM, in particular to run the Open edX SQL migrations. On Docker for Mac, by default, containers are allocated at most 2 GB of RAM. On Mac OS, if the
tutor local quickstart command dies after displaying “Running migrations”, you most probably need to increase the allocated RAM. Follow these instructions from the official Docker documentation.
“Build failed running pavelib.servers.lms: Subprocess return code: 1”¶
python manage.py lms print_setting STATIC_ROOT 2>/dev/null ... Build failed running pavelib.servers.lms: Subprocess return code: 1`"
This might occur when you run a
/dev/null eats the actual error, so you will have to run the command manually. Run
tutor dev shell lms (or
tutor dev shell cms) to open a bash session and then:
python manage.py lms print_setting STATIC_ROOT
The error produced should help you better understand what is happening.
“ValueError: Unable to configure handler ‘local’”¶
ValueError: Unable to configure handler 'local': [Errno 2] No such file or directory
This will occur if you try to run a development environment without patching the LOGGING configuration, as indicated in the development_ section. Maybe you correctly patched the development settings, but they are not taken into account? For instance, you might have correctly defined the
EDX_PLATFORM_SETTINGS environment variable, but
paver uses the
devstack settings (which does not patch the
LOGGING variable). This is because calling
paver lms --settings=development or
paver cms --settings=development ignores the
--settings argument. Yes, it might be considered an edx-platform bug… Instead, you should run the
runserver commands, as explained above.
“TypeError: get_logger_config() got an unexpected keyword argument ‘debug’”¶
This might occur when you try to run the latest version of
edx-platform, and not a version close to
ironwood.1. It is no longer necessary to patch the
LOGGING configuration in the latest
edx-platform releases, as indicated in the development_ section, so you should remove the call to
get_logger_config altogether from your development settings.
The chosen default language does not display properly¶
By default, Open edX comes with a limited set <https://github.com/edx/edx-platform/blob/master/conf/locale/config.yaml> of translation/localization files. To complement these languages, we add locales from the openedx-i18n project. But not all supported locales are downloaded. In some cases, the chosen default language will not display properly because if was not packaged in either edx-platform or openedx-i18n. If you feel like your language should be packaged, please open an issue on the openedx-i18n project.