tutor/docs/install.rst

.. _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/>`_

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. See the :ref:`troubleshooting <webserver>` section 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::

       sudo curl -L "https://github.com/regisb/tutor/releases/download/latest/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor
       sudo chmod +x /usr/local/bin/tutor

Installing from pip
-------------------

If, for some reason, you'd rather install from pypi instead of downloading a binary, run::

    pip install tutor-openedx

Installing from source
----------------------

::

    git clone https://github.com/regisb/tutor
    cd tutor
    python setup.py develop

Cloud deployment
----------------

Are you deploying Tutor to a Ubuntu cloud server? The `ubuntu.sh <https://github.com/regisb/tutor/blob/master/cloud/ubuntu.sh>`_ installs Tutor and creates a service under supervision that runs the Tutor :ref:`web UI <webui>`. To run this script, just connect to your server and run::

    curl -sSL https://raw.githubusercontent.com/regisb/tutor/master/cloud/ubuntu.sh | sudo bash -e

After the script finishes, you should be able to access the web UI at http://server_ip_address:3737. For security reasons, you should immediately set a password for accessing the UI by running ``webui configure`` from the web UI, or ``tutor webui configure`` from the server shell.