mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-12-12 22:27:47 +00:00
c4388e134c
- 💥 [Feature] Upgrade to Nutmeg: (by @regisb) - 💥 [Feature] Persistent grades are now enabled by default. - [Bugfix] Remove edX references from bulk emails ([issue](https://github.com/openedx/build-test-release-wg/issues/100)). - [Improvement] For Tutor Nightly (and only Nightly), official plugins are now installed from their nightly branches on GitHub instead of a version range on PyPI. This will allow Nightly users to install all official plugins by running ``pip install -e ".[full]"``. - [Bugfix] Start MongoDB when running migrations, because a new data migration fails if MongoDB is not running
30 lines
1.4 KiB
ReStructuredText
30 lines
1.4 KiB
ReStructuredText
.. _quickstart:
|
|
|
|
Quickstart (1-click install)
|
|
----------------------------
|
|
|
|
1. Install the latest stable release of Tutor from pip:
|
|
|
|
.. include:: download/pip.rst
|
|
|
|
Or `download <https://github.com/overhangio/tutor/releases>`_ the pre-compiled binary and place the ``tutor`` executable in your path:
|
|
|
|
.. include:: download/binary.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 (`Nutmeg <https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/open-release-nutmeg.master/platform_releases/nutmeg.html>`__ release) is run with docker-compose.
|
|
|
|
The whole procedure should require less than 10 minutes, on a server with 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.
|