christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-10-02 22:29:01 +00:00
Code Issues Releases Activity
915551268c
tutor/docs/quickstart.rst

25 lines
1.3 KiB
ReStructuredText
Raw Normal View History

Improve documentation
2018-12-26 15:00:47 +00:00
.. _quickstart:
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
Various docs improvements 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.
2020-03-16 21:27:04 +00:00
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:
Add instructions to download the "latest" binaries
2019-02-18 08:42:44 +00:00
Get rid of the "latest" release tag The "latest" tag is a pain to maintain: it's a tag that we delete and re-create at every release. Whenever we delete it, the binaries become unavailable on Github until they are re-generated. Thus, from now on, we conform to good practices (as examplified by the github.com/docker/compose) project and distribute only pinned release. The "nightly" tag remains, for now, as it allows us to distribute beta features. It may disappear in the future.
2019-04-22 11:29:53 +00:00
.. include:: cli_download.rst
Add instructions to download the "latest" binaries
2019-02-18 08:42:44 +00:00
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. 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
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.
v11.0.0 (2020-12-09) - 💥[Improvement] Upgrade Open edX to Koa - 💥 Setting changes: - The ``ACTIVATE_HTTPS`` setting was renamed to ``ENABLE_HTTPS``. - Other ``ACTIVATE_*`` variables were all renamed to ``RUN_*``. - The ``WEB_PROXY`` setting was removed and ``RUN_CADDY`` was added. - The ``NGINX_HTTPS_PORT`` setting is deprecated. - Architectural changes: - Use Caddy as a web proxy for automated SSL/TLS certificate generation: - Nginx no longer listens to port 443 for https traffic - The Caddy configuration file comes with a new ``caddyfile`` patch for much simpler SSL/TLS management. - Configuration files for web proxies are no longer provided. - Kubernetes deployment no longer requires setting up a custom Ingress resource or custom manager. - Gunicorn and Whitenoise are replaced by uwsgi: this increases boostrap performance and makes it no longer necessary to mount media folders in the Nginx container. - Replace memcached and rabbitmq by redis. - Additional features: - Make it possible to disable all plugins at once with ``plugins disable all``. - Add ``tutor k8s wait`` command to wait for a pod to become ready - Faster, more reliable static assets with local memory caching - Deprecation: proxy files for Apache and Nginx are no longer provided out of the box. - Removed plugin `{{ patch (...) }}` statements: - "https-create", "k8s-ingress-rules", "k8s-ingress-tls-hosts": these are no longer necessary. Instead, declare your app in the "caddyfile" patch. - "local-docker-compose-nginx-volumes": this patch was primarily used to serve media assets. The recommended is now to serve assets with uwsgi.
2020-09-17 10:53:14 +00:00
5. A full, production-ready Open edX platform (`Koa <https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/open-release-koa.master/platform_releases/koa.html>`__ release) is run with docker-compose.
Improve documentation
2018-12-26 15:00:47 +00:00
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.
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
Better installation docs
2020-03-16 21:14:36 +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 quickstart installation method above somehow didn't work for you, check out the :ref:`troubleshooting` guide.
Copy Permalink