6
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-12-13 06:37:46 +00:00
tutor/docs/quickstart.rst

25 lines
1.3 KiB
ReStructuredText
Raw Normal View History

2018-12-26 15:00:47 +00:00
.. _quickstart:
Quickstart (1-click install)
----------------------------
2018-12-26 15:00:47 +00:00
1. `Download <https://github.com/overhangio/tutor/releases>`_ the latest stable release of Tutor 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!
2018-12-26 15:00:47 +00:00
**That's it?**
Yes :) This is what happens when you run ``tutor local quickstart``:
2018-12-26 15:00:47 +00:00
1. You answer a few questions about the :ref:`configuration` of your Open edX platform.
2. Configuration files are generated from templates.
2018-12-26 15:00:47 +00:00
3. Docker images are downloaded.
4. Docker containers are provisioned.
5. A full, production-ready Open edX platform (`Juniper <https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/open-release-juniper.master/platform_releases/juniper.html>`__ release) is run with docker-compose.
2018-12-26 15:00:47 +00:00
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.
2020-03-16 21:14:36 +00:00
There's a lot more to Tutor than that! To learn more about what you can do with Tutor and Open edX, check out the :ref:`whatnext` section. If the quickstart installation method above somehow didn't work for you, check out the :ref:`troubleshooting` guide.