6
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-19 11:35:15 +00:00
tutor/docs/install.rst
Régis Behmo 4331bc5712 Tutor v3 complete rewrite
Replace all make commands by a single "tutor" binary. Environment and
data are all moved to ~/.tutor/local/share/tutor. We take the
opportunity to add a web UI and revamp the documentation.

This is a complete rewrite.

Close #121.
Close #147.
2019-02-09 20:30:01 +01:00

42 lines
1.4 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/>`_
Note that the production web server container will bind to port 80, so if you already have a web server running (Apache or Nginx, for instance), you should stop it.
You should be able to run Open edX 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 Open edX , the deployment procedure might crash during migrations (see the :ref:`troubleshooting` section) and the platform will be unbearably slow.
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.
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