6
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-05 12:57:52 +00:00
tutor/docs/quickstart.rst
Régis Behmo e25982ed20 Improve docs wording and de-duplicate from readme
The sphinx `include` directive is great!
2019-04-25 09:36:18 +02:00

24 lines
949 B
ReStructuredText

.. _quickstart:
Quickstart (1-click install)
============================
1. `Download <https://github.com/regisb/tutor/releases>`_ the latest stable release of Tutor, uncompress the file and place the ``tutor`` executable in your path. From the command line:
.. include:: cli_download.rst
2. Run ``tutor local quickstart``
3. You're done!
**That's it?**
Yes :) This is what happens when you run ``tutor local quickstart``:
1. You answer a few questions about the :ref:`configuration` of your Open edX platform.
2. Configuration files are generated from templates.
3. Docker images are downloaded.
4. Docker containers are provisioned.
5. A full, production-ready platform is run with docker-compose.
The whole procedure should require less than 10 minutes, on a server with a good bandwidth. Note that your host environment will not be affected in any way, since everything runs inside docker containers. Root access is not even necessary.