tutor/docs/requirements.rst

.. _requirements:

Requirements
============

The only prerequisite for running this is a working docker install. You will need both docker and docker-compose. Follow the instructions from the official documentation:

- `make <https://www.gnu.org/software/make/>`_
- `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; otherwise, the deployment procedure will crash during migrations (see the :ref:`troubleshooting` section).

Also, the host running the containers should be a 64 bit platform. (images are not built for i386 systems)
Improve documentation 2018-12-26 15:00:47 +00:00			`.. _requirements:`

Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated. 2018-12-03 18:59:09 +00:00			`Requirements`
			`============`

			`The only prerequisite for running this is a working docker install. You will need both docker and docker-compose. Follow the instructions from the official documentation:`

Add "make" to the tutor requirements 2019-01-17 09:42:15 +00:00			- `make <https://www.gnu.org/software/make/>`_
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated. 2018-12-03 18:59:09 +00:00			- `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.`

Improve documentation 2018-12-26 15:00:47 +00:00			`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.`
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated. 2018-12-03 18:59:09 +00:00
Open edX requires 4 Gb of RAM After testing on a 2Gb server, Open edX can be run, but it's unbearably slow. 2019-01-17 15:48:34 +00:00			At a minimum, the server running the containers should have 4 Gb of RAM; otherwise, the deployment procedure will crash during migrations (see the :ref:`troubleshooting` section).
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated. 2018-12-03 18:59:09 +00:00
			`Also, the host running the containers should be a 64 bit platform. (images are not built for i386 systems)`