Tutor Dev Olive Installation: A Quick and Easy Tutorial

CodeTrade
1413 Views

Are you eager to start with Tutor Dev Olive but unsure how to install it? Fear not! This comprehensive tutorial will guide you through the simple steps to install Tutor Dev Olive on your system. Whether you are a seasoned developer or a curious beginner, this article will equip you with everything you need to know. So, let's dive in and make the installation process a breeze!

What is Tutor Dev Olive?

A tutor is a tool that helps you build and deploy interactive learning experiences for your Open edX LMS. It simplifies the process of creating, managing, and delivering interactive educational content. Tutor Dev Olive is a development version of Tutor that includes features that are not yet available in the stable release.

With Tutor Dev Olive, you can build interactive coding exercises, quizzes, and various learning materials for your students or learners. Its versatility makes it an excellent choice for anyone involved in educational content creation.

Prerequisites

Before you begin, you will need to make sure that you have the following prerequisites installed on your system:

Note: We tested on these Docker versions to install Tutor Dev Olive

  • Docker version: v18.06.0+
  • Docker Compose version: v1.22.0+

Steps to Install Docker

  • If you have already installed Docker, need to remove it first and then install Docker using the given command

  • $ sudo apt-get remove -y docker docker-ce docker-ce-cli containerd.io

  • Execute the command to check Available Docker Versions

  • $ apt-cache madison docker-ce | awk '{ print $3 }'

  • Set available version of Docker using VERSION_STRING

  • $ VERSION_STRING={docker_version}

  • Run the command to Install Docker

  • $ sudo apt-get install -y docker-ce=$VERSION_STRING docker-ce-cli=$VERSION_STRING containerd.io docker-buildx-plugin docker-compose-plugin

  • Check status and version of the Docker

  • $ sudo systemctl status docker

    $ docker --version

Steps to install Docker-Compose

  • Remove installed docker-compose from your system

  • $ sudo apt-get remove docker-compose

  • Check the available docker-compose version

  • $ apt-cache madison docker-compose | awk '{ print $3 }'

  • Install the Docker-Compose

  • $ sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

  • Set execution permission to the file /usr/local/bin/docker-compose

  • $ sudo chmod +x /usr/local/bin/docker-compose

  • Check the docker compose version

  • $ docker-compose --version

With the provided instructions, you can effortlessly set up Docker and Docker-compose with the versions you need. Next, let's see how to install tutor dev olive step-by-step.

Steps to Install Tutor Dev Olive

Follow the given simple steps to set up Tutor Dev Olive on your system:

1. Make Tutor Directory

Create a new edX directory for tutor installations

$ mkdir olive_tutor

2. Go to That Directory

Navigate to the "olive_tutor" directory

$ cd olive_tutor

3. Run the Command to Install Tutor using pip

With the following command, you will find the tutor package v15.3.6 along with its optional dependencies labeled as "full." The program will then download the package and any required dependencies from the Python Package Index (PyPI) and install them.

$ pip install "tutor[full]==v15.3.6"

How-to-Install-Tutor-Dev-Olive-in-Easy-Steps-1

4. Check the Version of Tutor

Run the given command to check the installed tutor version

$ tutor --version

How-to-Install-Tutor-Dev-Olive-in-Easy-Steps-2

5. Install or Launch Tutor Development

After successfully installing Tutor, launch Tutor development environment.

$ tutor dev launch

Next, the process will ask for three details related to the Tutor platform to be saved in the config.yml file.

How-to-Install-Tutor-Dev-Olive-in-Easy-Steps-3

After the installations are completed, services will get started. The tutor is installed successfully.

How-to-Install-Tutor-Dev-Olive-in-Easy-Steps-4

6. Install Tutor Plugins

Tutor plugins are disabled in Tutor 15.3.6. In order to install Olive in Tutor, we must enable the tutor plugins. Before enable tutor plugins we need to check the list of available plugins:

$ tutor plugins list

How-to-Install-Tutor-Dev-Olive-in-Easy-Steps-5

7. Enable/Disable Plugin

Execute the given command to enable or disable plugins.

$ tutor plugins enable/disable (plugin-name)

How-to-Install-Tutor-Dev-Olive-in-Easy-Steps-9

8. Save Config File

Once plugins have been enabled or disabled, or any changes to the configuration have been made, it is important to save the config.yml file.

$ tutor config save

How-to-Install-Tutor-Dev-Olive-in-Easy-Steps-10

Relaunch tutor dev using the command “tutor dev launch”.

$ tutor dev launch

Note: When we relaunch Tutor Dev, we encountered a manifest error due to plugin version compatibility and did not receive the required file. How can manifest errors be resolved? To resolve these errors, we need to follow a comprehensive set of steps.

How to resolve Manifest Error in Tutor Dev Olive Installation

If you encounter manifest errors, search for the filename causing the issue in Docker and attempt to locate the closest available version. Below image can show an example of a Manifest error.

How-to-Install-Tutor-Dev-Olive-in-Easy-Steps-11

Using Docker hub you can find your required file from the given link: https://hub.docker.com/r/overhangio/openedx-payment-dev/tags

How-to-Install-Tutor-Dev-Olive-in-Easy-Steps-12-1

For Example, When we try to install Tutor Dev Olive and encounter a manifest error, we need to use a lower version of "tutor-mfe" in order to complete the installation. It is necessary to uninstall the existing plugins first before reinstalling them.

Change Installed Plugin Versions

Follow the given steps to change the installed version of Tutor Plugins

a. View the exact name of the plugin
$ pip freeze | grep tutor

How-to-Install-Tutor-Dev-Olive-in-Easy-Steps-6

b. Uninstall the existing plugin version
$ pip uninstall -y

How-to-Install-Tutor-Dev-Olive-in-Easy-Steps-7

Note: Here, we need to change the MFE plugin version so we put “tutor -mfe” in the command.

c. Install the desired version of the plugin you need
$ pip install (plugin-name)==(plugin-version)

How-to-Install-Tutor-Dev-Olive-in-Easy-Steps-8

d. Use the given command to reflect the changes of installed plugins.
$ tutor plugins update

Tutor-olive-installation-plugin-update-command-image

Save the config.yml file using the command “tutor config save” and run the command “tutor dev launch”.

$ tutor config save

And relaunch tutor dev using the given command

$ tutor dev launch

You can now use Tutor to create and manage your own Open edX platform at http://local.overhang.io:8000

How-to-Install-Tutor-Dev-Olive-in-Easy-Steps-13-1

Congratulations! You have successfully installed Tutor Dev Olive on your system.

Wrapping Up

By following the above given simple installation steps you can easily install Tutor Dev Olive without getting any error. Embrace its user-friendly interface, customizable environment, and powerful extensions to take your coding experience to new heights.

If you still face any issues with installation, hire open edX experts from CodeTrade to leverage the benefits of easy installation and a smooth process. CodeTrade is a well-respected open edX agency. Our team of highly experienced experts is dedicated to helping you solve any issues you may have with the platform, while also providing you with reliable, guaranteed services.

Happy coding with Tutor Dev Olive!
CodeTrade
CodeTrade, a Custom Software Development Company, provides end-to-end SME solutions in USA, Canada, Australia & Middle East. We are a team of experienced and skilled developers proficient in various programming languages and technologies. We specialize in custom software development, web, and mobile application development, and IT services.