tutor/docs/quickstart.rst

.. _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 launch``
3. You're done!

**That's it?**

Yes :) This is what happens when you run ``tutor local launch``:

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-olive.master/platform_releases/olive.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 launch installation method above somehow didn't work for you, check out the :ref:`troubleshooting` guide.
feat: upgrade to olive 2022-11-22 12:53:29 +00:00			`.. _quickstart:`
Improve documentation 2018-12-26 15:00:47 +00:00
Improve docs wording and de-duplicate from readme The sphinx `include` directive is great! 2019-04-25 07:30:48 +00:00			`Quickstart (1-click install)`
Better docs organization With this reoreganization, we have a cleaner TOC and more intuitive content navigation. 2020-03-16 11:07:58 +00:00			`----------------------------`
Improve documentation 2018-12-26 15:00:47 +00:00
docs: encourage users to install from pip, and not from the binary 2022-01-08 17:56:37 +00:00			`1. Install the latest stable release of Tutor from pip:`
Add instructions to download the "latest" binaries 2019-02-18 08:42:44 +00:00
docs: encourage users to install from pip, and not from the binary 2022-01-08 17:56:37 +00:00			`.. include:: download/pip.rst`
feat: switch the package name from "tutor-openedx" to "tutor" 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. 2021-06-25 15:03:43 +00:00
docs: encourage users to install from pip, and not from the binary 2022-01-08 17:56:37 +00:00			Or `download <https://github.com/overhangio/tutor/releases>`_ the pre-compiled binary and place the ``tutor`` executable in your path:
feat: switch the package name from "tutor-openedx" to "tutor" 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. 2021-06-25 15:03:43 +00:00
docs: encourage users to install from pip, and not from the binary 2022-01-08 17:56:37 +00:00			`.. include:: download/binary.rst`
Add instructions to download the "latest" binaries 2019-02-18 08:42:44 +00:00
feat: deprecate "quickstart" and rename to "launch" `quickstart` is being renamed to `launch` and deprecated in favor of using `launch`. The `quickstart` function temporarily aliases to `launch`. Further mentions of `quickstart` have been changed to reference `launch` instead. We are indicating that this change is breaking 💥 to encourage people to migrate their scripts right away! 2022-09-30 10:00:24 +00:00			2. Run ``tutor local launch``
Tutor v3 complete rewrite Replace all make commands by a single "tutor" binary. Environment and data are all moved to ~/.tutor/local/share/tutor. We take the opportunity to add a web UI and revamp the documentation. This is a complete rewrite. Close #121. Close #147. 2019-01-22 20:25:04 +00:00			`3. You're done!`
Improve documentation 2018-12-26 15:00:47 +00:00
			`That's it?`

feat: deprecate "quickstart" and rename to "launch" `quickstart` is being renamed to `launch` and deprecated in favor of using `launch`. The `quickstart` function temporarily aliases to `launch`. Further mentions of `quickstart` have been changed to reference `launch` instead. We are indicating that this change is breaking 💥 to encourage people to migrate their scripts right away! 2022-09-30 10:00:24 +00:00			Yes :) This is what happens when you run ``tutor local launch``:
Improve documentation 2018-12-26 15:00:47 +00:00
Configurable docker images Docker images for each service can now be configured one by one. Close #122. 2019-03-06 16:21:47 +00:00			1. You answer a few questions about the :ref:`configuration` of your Open edX platform.
Tutor v3 complete rewrite Replace all make commands by a single "tutor" binary. Environment and data are all moved to ~/.tutor/local/share/tutor. We take the opportunity to add a web UI and revamp the documentation. This is a complete rewrite. Close #121. Close #147. 2019-01-22 20:25:04 +00:00			`2. Configuration files are generated from templates.`
Improve documentation 2018-12-26 15:00:47 +00:00			`3. Docker images are downloaded.`
			`4. Docker containers are provisioned.`
feat: upgrade to olive 2022-11-22 12:53:29 +00:00			5. A full, production-ready Open edX platform (`Nutmeg <https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/open-release-olive.master/platform_releases/olive.html>`__ release) is run with docker-compose.
Improve documentation 2018-12-26 15:00:47 +00:00
minor typos fixed 2022-03-27 10:36:55 +00:00			`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.`
Better documentation - More concise table of contents - New intro - Simpler make commands - Fix a couple typos here and there - Get rid of the default github issue template, and start using the template created online. 2019-05-13 14:33:26 +00:00
feat: deprecate "quickstart" and rename to "launch" `quickstart` is being renamed to `launch` and deprecated in favor of using `launch`. The `quickstart` function temporarily aliases to `launch`. Further mentions of `quickstart` have been changed to reference `launch` instead. We are indicating that this change is breaking 💥 to encourage people to migrate their scripts right away! 2022-09-30 10:00:24 +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 launch installation method above somehow didn't work for you, check out the :ref:`troubleshooting` guide.