christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-05 04:48:00 +00:00
Code Issues Releases Activity
813a83b029
tutor/README.rst

85 lines
3.8 KiB
ReStructuredText
Raw Normal View History

Improve docs wording and de-duplicate from readme The sphinx `include` directive is great!
2019-04-25 07:30:48 +00:00
.. _readme_intro_start:
Improve docs - Add tutor logo - add "edit on github" links - modify theme colors - and various other things...
2019-10-17 15:20:22 +00:00
Tutor: the docker-based Open edX distribution designed for peace of mind
========================================================================
Improve documentation
2018-12-26 15:00:47 +00:00
Improve docs - Add tutor logo - add "edit on github" links - modify theme colors - and various other things...
2019-10-17 15:20:22 +00:00
|
Fix tutor logo link in docs
2020-01-10 14:23:05 +00:00
.. image:: https://overhang.io/static/img/tutor-logo.svg
Improve docs - Add tutor logo - add "edit on github" links - modify theme colors - and various other things...
2019-10-17 15:20:22 +00:00
:alt: Tutor logo
:width: 500px
:align: center
|
.. image:: https://img.shields.io/travis/overhangio/tutor.svg?label=Release%20build&style=flat-square
Add gitlab CI badge to readme
2019-06-24 11:06:40 +00:00
:alt: Release build status
Migrate github repo to overhangio organization
2019-06-23 17:56:15 +00:00
:target: https://travis-ci.org/overhangio/tutor
Improve documentation
2018-12-26 15:00:47 +00:00
Improve docs - Add tutor logo - add "edit on github" links - modify theme colors - and various other things...
2019-10-17 15:20:22 +00:00
.. image:: https://img.shields.io/badge/docs-current-blue.svg?style=flat-square
Docs are now hosted with https
2019-02-20 12:52:25 +00:00
:alt: Documentation
:target: https://docs.tutor.overhang.io
Add documentation status badge
2019-02-19 21:37:59 +00:00
Improve docs - Add tutor logo - add "edit on github" links - modify theme colors - and various other things...
2019-10-17 15:20:22 +00:00
.. image:: https://img.shields.io/github/issues/overhangio/tutor.svg?style=flat-square
Improve documentation
2018-12-26 15:00:47 +00:00
:alt: GitHub issues
Migrate github repo to overhangio organization
2019-06-23 17:56:15 +00:00
:target: https://github.com/overhangio/tutor/issues
Improve documentation
2018-12-26 15:00:47 +00:00
Improve docs - Add tutor logo - add "edit on github" links - modify theme colors - and various other things...
2019-10-17 15:20:22 +00:00
.. image:: https://img.shields.io/github/issues-closed/overhangio/tutor.svg?colorB=brightgreen&style=flat-square
Improve documentation
2018-12-26 15:00:47 +00:00
:alt: GitHub closed issues
Migrate github repo to overhangio organization
2019-06-23 17:56:15 +00:00
:target: https://github.com/overhangio/tutor/issues?q=is%3Aclosed
Improve documentation
2018-12-26 15:00:47 +00:00
Improve docs - Add tutor logo - add "edit on github" links - modify theme colors - and various other things...
2019-10-17 15:20:22 +00:00
.. image:: https://img.shields.io/github/license/overhangio/tutor.svg?style=flat-square
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
:alt: AGPL License
:target: https://www.gnu.org/licenses/agpl-3.0.en.html
Switch "do not fuck this up" message to section Admonitions are not supported by Github's rst parser.
2020-10-02 10:16:58 +00:00
**Tutor** is a docker-based `Open edX <https://openedx.org>`_ distribution, both for production and local development. The goal of Tutor is to make it easy to deploy, customize, upgrade and scale Open edX. Tutor is reliable, fast, extensible, and it is already used by dozens of Open edX platforms around the world.
Hey America! Please do not fuck this up.
2020-10-01 09:15:47 +00:00
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
Do you need professional assistance setting up or managing your Open edX platform? Overhang.IO provides online support as part of its `Long Term Support (LTS) offering <https://overhang.io/tutor/pricing>`__.
Hey America! Please do not fuck this up.
2020-10-01 09:15:47 +00:00
Coolify readme
2019-10-07 12:26:17 +00:00
Features
--------
* 100% `open source <https://github.com/overhangio/tutor>`__
* Runs entirely on Docker
Add scorm xblock to the openedx docker image
2020-04-25 12:20:13 +00:00
* World-famous 1-click `installation and upgrades <https://docs.tutor.overhang.io/install.html>`__
* Comes with batteries included: `theming <https://github.com/overhangio/indigo>`__, `SCORM <https://github.com/overhangio/openedx-scorm-xblock>`__, `HTTPS <https://docs.tutor.overhang.io/configuration.html#ssl-tls-certificates-for-https-access>`__, `web-based administration interface <https://docs.tutor.overhang.io/extra.html#web-ui>`__, `mobile app <https://docs.tutor.overhang.io/extra.html#mobile-android-application>`__, `custom translations <https://docs.tutor.overhang.io/configuration.html#adding-custom-translations>`__...
* Extensible architecture with `plugins <https://docs.tutor.overhang.io/plugins.html>`__
* Works with `Kubernetes <https://docs.tutor.overhang.io/k8s.html>`__
* No technical skill required with the `1-click Tutor AWS image <https://docs.tutor.overhang.io/install.html#cloud-deployment>`__
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
* Amazing plugins available with `Tutor Wizard Edition <https://overhang.io/tutor>`__
Improve docs wording and de-duplicate from readme The sphinx `include` directive is great!
2019-04-25 07:30:48 +00:00
.. _readme_intro_end:
Improve documentation
2018-12-26 15:00:47 +00:00
Gif animation for quickstart Animation created with Terminalizer: https://terminalizer.com/ Try it! It's awesome :)
2019-02-10 18:13:35 +00:00
.. image:: ./docs/img/quickstart.gif
:alt: Tutor local quickstart
:target: https://terminalizer.com/view/91b0bfdd557
Improve documentation
2018-12-26 15:00:47 +00:00
Quickstart
----------
Migrate github repo to overhangio organization
2019-06-23 17:56:15 +00:00
1. Install the `latest stable release <https://github.com/overhangio/tutor/releases>`_ of Tutor
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
Documentation
-------------
Docs are now hosted with https
2019-02-20 12:52:25 +00:00
Extensive documentation is available online: https://docs.tutor.overhang.io/
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
.. _readme_support_start:
Add links to tutor forums
2019-02-19 21:26:43 +00:00
Support
-------
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
To get community support, go to the official discussion forums: https://discuss.overhang.io. For official support, please subscribe to a Long Term Support (LTS) license at https://overhang.io/tutor/pricing.
Add links to tutor forums
2019-02-19 21:26:43 +00:00
Improve docs wording and de-duplicate from readme The sphinx `include` directive is great!
2019-04-25 07:30:48 +00:00
.. _readme_support_end:
.. _readme_contributing_start:
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
Contributing
------------
Improve documentation
2018-12-26 15:00:47 +00:00
Update "contributing" section of the readme
2020-12-12 23:43:55 +00:00
We welcome contributions to Tutor! To learn how you can contribute, please check the relevant section of the Tutor docs: `https://docs.tutor.overhang.io/tutor.html#contributing <https://docs.tutor.overhang.io/tutor.html#contributing>`__.
Improve docs wording and de-duplicate from readme The sphinx `include` directive is great!
2019-04-25 07:30:48 +00:00
.. _readme_contributing_end:
Copy Permalink