christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-19 11:35:15 +00:00
Code Issues Releases Activity
4aad412b6a
tutor/docs/quickstart.rst

21 lines
893 B
ReStructuredText
Raw Normal View History

Improve documentation
2018-12-26 15:00:47 +00:00
.. _quickstart:
Quickstart
==========
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
1. `Download <https://github.com/regisb/tutor/releases>`_ the latest stable release of Tutor, uncompress the file and place the ``tutor`` executable in your path.
2. Run ``tutor local quickstart``
3. You're done!
Improve documentation
2018-12-26 15:00:47 +00:00
**That's it?**
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
Yes :) This is what happens when you run ``tutor local quickstart``:
Improve documentation
2018-12-26 15:00:47 +00:00
1. You answer a few questions about the configuration of your Open edX platform and your :ref:`selected options <options>`
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.
5. A full, production-ready platform 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.
Copy Permalink