mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-12-12 06:07:56 +00:00
328e70b8b5
There is still a lot of work to do. In particular, local.rst and configuration.rst are a mess. But that's a job for another time.
25 lines
1.4 KiB
ReStructuredText
25 lines
1.4 KiB
ReStructuredText
.. _quickstart:
|
|
|
|
Quickstart (1-click install)
|
|
----------------------------
|
|
|
|
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!
|
|
|
|
**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 Open edX platform (`Ironwood <https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/open-release-ironwood.master/platform_releases/ironwood.html#open-edx-ironwood-release>`__ release) 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.
|
|
|
|
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. |