mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-06-01 05:40:48 +00:00
c15eec53dc
The package maintainer of the "tutor" package was kind enough to transfer ownership of the project to us. This is great, because we no longer have to use the "openedx" suffix, which is trademarked. For the time being, we keep maintaining the "tutor-openedx" package which has a 1-to-1 dependency on the "tutor" package. In the future, we expect that we will no longer push upgrades to tutor-openedx.
29 lines
1.4 KiB
ReStructuredText
29 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:: download/binary.rst
|
|
|
|
Or:
|
|
|
|
.. include:: download/pip.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 (`Lilac <https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/open-release-lilac.master/platform_releases/koa.html>`__ 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. |