mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-12-12 06:07:56 +00:00
70 lines
3.2 KiB
ReStructuredText
70 lines
3.2 KiB
ReStructuredText
.. _install:
|
|
|
|
Installation
|
|
============
|
|
|
|
Requirements
|
|
------------
|
|
|
|
The only prerequisite for running this is a working docker install. Both docker and docker-compose are required. Follow the instructions from the official documentation:
|
|
|
|
- `Docker <https://docs.docker.com/engine/installation/>`_
|
|
- `Docker compose <https://docs.docker.com/compose/install/>`_
|
|
|
|
⚠️ Warning: do not attempt to simply run ``apt-get install docker docker-compose`` on older Ubuntu platforms, such as 16.04 (Xenial), as you will get older versions of these utilities.
|
|
|
|
Note that the production web server container will bind to port 80 and 443, so if there a web server is running on the same server (Apache or Nginx, for instance), it should be stopped prior to running tutor. Check the section on :ref:`how to setup a web proxy <web_proxy>` for a workaround.
|
|
|
|
With Tutor, Open edX can run on any platform that supports Docker, including Mac OS and Windows. Tutor was tested under various versions of Ubuntu and Mac OS.
|
|
|
|
At a minimum, the server running the containers should have 4 Gb of RAM. With less memory, the deployment procedure might crash during migrations (see the :ref:`troubleshooting <migrations_killed>` section) and the platform will be unbearably slow.
|
|
|
|
At least 9Gb of disk space is required.
|
|
|
|
Also, the host running the containers should be a 64 bit platform. (images are not built for i386 systems)
|
|
|
|
Direct binary downloads
|
|
-----------------------
|
|
|
|
The latest binaries can be downloaded from https://github.com/regisb/tutor/releases. From the command line:
|
|
|
|
.. include:: cli_download.rst
|
|
|
|
This is the recommended installation method for most people.
|
|
|
|
Cloud deployment
|
|
----------------
|
|
|
|
Tutor can be launched on Amazon Web Services very quickly with the `official Tutor AMI <https://aws.amazon.com/marketplace/pp/B07PV3TB8X>`_. Shell access is not even required, as all configuration will happen through the Tutor web user interface. This is a commercial offer priced at $50/month ($500/year) that was created to support the development of Tutor.
|
|
|
|
Installing from source
|
|
----------------------
|
|
|
|
If you would like to inspect the Tutor source code, you are most welcome to install Tutor from `Pypi <https://pypi.org/project/tutor-openedx/>`_ or directly from `the Github repository <https://github.com/regisb/tutor>`_. You will need python >= 3.5 and the libyaml development headers. On Ubuntu, these requirements can be installed by running::
|
|
|
|
sudo apt install python3 libyaml-dev
|
|
|
|
Installing from pypi::
|
|
|
|
pip install tutor-openedx
|
|
|
|
Installing from a local clone of the repository::
|
|
|
|
git clone https://github.com/regisb/tutor
|
|
cd tutor
|
|
pip install -e .
|
|
|
|
Autocomplete
|
|
------------
|
|
|
|
Tutor is built on top of `Click <https://click.palletsprojects.com>`_, which is a great library for building command line interface (CLI) tools. As such, Tutor benefits from all Click features, including `auto-completion <https://click.palletsprojects.com/en/7.x/bashcomplete/>`_. After installing Tutor, auto-completion can be enabled by running::
|
|
|
|
_TUTOR_COMPLETE=source tutor >> ~/.bashrc
|
|
|
|
If you are running zsh, run instead::
|
|
|
|
_TUTOR_COMPLETE=source_zsh tutor >> ~/.zshrc
|
|
|
|
After opening a new shell, you can test auto-completion by typing::
|
|
|
|
tutor <tab><tab> |