Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master' into nightly
Browse files Browse the repository at this point in the history
  • Loading branch information
Overhang.IO committed Aug 3, 2023
2 parents 6988a0f + bb23afc commit 1e0f714
Show file tree
Hide file tree
Showing 12 changed files with 25 additions and 12 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,13 @@ instructions, because git commits are used to generate release notes:

<!-- scriv-insert-here -->

<a id='changelog-16.0.4'></a>
## v16.0.4 (2023-08-03)

- [Feature] Add support for HTTP/3, which considerably improves performance for Open edX. (by @regisb and @ghassanmas)
- [Bugfix] Do not display discussion units when the forum is not enabled. (by @regisb)
- [Improvement] Remove references to the wizard edition. (by @CodeWithEmad)

<a id='changelog-16.0.3'></a>
## v16.0.3 (2023-07-28)

Expand Down
1 change: 0 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ Features
* 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://github.com/overhangio/tutor-webui>`__, `mobile app <https://github.com/overhangio/tutor-android>`__, `custom translations <https://docs.tutor.overhang.io/configuration.html#adding-custom-translations>`__...
* Extensible architecture with `plugins <https://docs.tutor.overhang.io/plugins/index.html>`__
* Works with `Kubernetes <https://docs.tutor.overhang.io/k8s.html>`__
* Amazing premium plugins available in the `Tutor Wizard Edition <https://overhang.io/tutor/wizardedition>`__, including `Cairn <https://overhang.io/tutor/plugin/cairn>`__ the next-generation analytics solution for Open edX.
* No technical skill required with the `zero-click Tutor AWS image <https://docs.tutor.overhang.io/install.html#zero-click-aws-installation>`__

.. _readme_intro_end:
Expand Down
1 change: 0 additions & 1 deletion changelog.d/20230731_155418_regis_fix_discussion_units.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ What features are missing from Tutor?

Tutor tries very hard to support all major Open edX features, notably in the form of :ref:`plugins <existing_plugins>`. If you are interested in sponsoring the development of a new plugin, please `get in touch <mailto:[email protected]>`__!

It should be noted that the `Insights <https://github.com/openedx/edx-analytics-pipeline>`__ stack is currently unsupported, because of its complexity, lack of support, and extensibility. To replace it, Overhang.IO developed `Cairn <https://overhang.io/tutor/plugin/cairn>`__ the next-generation analytics solution for Open edX, part of the `Tutor Wizard Edition <https://overhang.io/tutor/wizardedition>`__. You should check it out 😉
It should be noted that the `Insights <https://github.com/openedx/edx-analytics-pipeline>`__ stack is currently unsupported, because of its complexity, lack of support, and extensibility. To replace it, Overhang.IO developed `Cairn <https://overhang.io/tutor/plugin/cairn>`__ the next-generation analytics solution for Open edX. You should check it out 😉

Are there people already running this in production?
----------------------------------------------------
Expand Down
5 changes: 2 additions & 3 deletions docs/plugins/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,12 @@ Many plugins are available from plugin indexes. These indexes are lists of plugi
tutor plugins update
tutor plugins search

More plugins can be downloaded from the "contrib" and "wizard" indexes::
More plugins can be downloaded from the "contrib" index::

tutor plugins index add contrib
tutor plugins index add wizard
tutor plugins search

The "main", "contrib" and "wizard" indexes include a curated list of plugins that are well maintained and introduce useful features to Open edX. These indexes are maintained by `Overhang.IO <https://overhang.io>`__. For more information about these indexes, refer to the official `overhangio/tpi <https://github.com/overhangio/tpi>`__ repository.
The "main" and "contrib" indexes include a curated list of plugins that are well maintained and introduce useful features to Open edX. These indexes are maintained by `Overhang.IO <https://overhang.io>`__. For more information about these indexes, refer to the official `overhangio/tpi <https://github.com/overhangio/tpi>`__ repository.

Thanks to these indexes, it is very easy to download and upgrade plugins. For instance, to install the `notes plugin <https://github.com/overhangio/tutor-notes/>`__::

Expand Down
1 change: 1 addition & 0 deletions docs/tutorials/proxy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ It is then your responsibility to configure the web proxy on the host. There are
- Forward http traffic to https.
- Set the following headers appropriately: ``X-Forwarded-Proto``, ``X-Forwarded-Port``.
- Forward all traffic to ``localhost:81`` (or whatever port indicated by CADDY_HTTP_PORT, see above).
- If possible, add support for `HTTP/3 <https://en.wikipedia.org/wiki/HTTP/3>`__, which considerably improves performance for Open edX (see `this comment <https://github.com/overhangio/tutor/issues/845#issuecomment-1566964289>`__).

.. note::
If you want to run Open edX at ``https://...`` urls (as you probably do in production) it is *crucial* that the ``ENABLE_HTTPS`` flag is set to ``true``. If not, the web services will be configured to run at ``http://...`` URLs, and all sorts of trouble will happen. Therefore, make sure to continue answering ``y`` ("yes") to the quickstart dialogue question "Activate SSL/TLS certificates for HTTPS access?".
2 changes: 1 addition & 1 deletion requirements/dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ click-log==0.4.0
# via scriv
coverage==7.2.7
# via -r requirements/dev.in
cryptography==41.0.2
cryptography==41.0.3
# via secretstorage
dill==0.3.6
# via pylint
Expand Down
2 changes: 1 addition & 1 deletion tutor/__about__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Increment this version number to trigger a new release. See
# docs/tutor.html#versioning for information on the versioning scheme.
__version__ = "16.0.3"
__version__ = "16.0.4"

# The version suffix will be appended to the actual version, separated by a
# dash. Use this suffix to differentiate between the actual released version and
Expand Down
4 changes: 2 additions & 2 deletions tutor/commands/plugins.py
Original file line number Diff line number Diff line change
Expand Up @@ -382,8 +382,8 @@ def index_add(context: Context, url: str) -> None:
The index URL will be appended with '{version}/plugins.yml'. The index path can be
either an http(s) url or a local file path.
For official indexes, there is no need to pass a full URL. Instead, use "main",
"contrib" or "wizard".
For official indexes, there is no need to pass a full URL. Instead, use "main" or
"contrib".
"""
config = tutor_config.load_minimal(context.root)
if indexes.add(url, config):
Expand Down
1 change: 0 additions & 1 deletion tutor/plugins/indexes.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ def _get_index_url_from_alias(url: str) -> str:
known_aliases = {
"main": "https://overhang.io/tutor/main",
"contrib": "https://overhang.io/tutor/contrib",
"wizard": "https://overhang.io/tutor/wizard",
}
return known_aliases.get(url, url)

Expand Down
5 changes: 5 additions & 0 deletions tutor/templates/k8s/services.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,12 @@ spec:
name: http
{%- if ENABLE_HTTPS %}
- port: 443
protocol: TCP
name: https
# include support for http/3
- port: 443
protocol: UDP
name: http3
{%- endif %}
selector:
app.kubernetes.io/name: caddy
Expand Down
6 changes: 5 additions & 1 deletion tutor/templates/local/docker-compose.prod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@ services:
restart: unless-stopped
ports:
- "{{ CADDY_HTTP_PORT }}:80"
{% if ENABLE_HTTPS and ENABLE_WEB_PROXY %}- "443:443"{% endif %}
{% if ENABLE_HTTPS and ENABLE_WEB_PROXY %}
- "443:443"
# include support for http/3
- "443:443/udp"
{% endif %}
environment:
default_site_port: "{% if not ENABLE_HTTPS or not ENABLE_WEB_PROXY %}:80{% endif %}"
volumes:
Expand Down

0 comments on commit 1e0f714

Please sign in to comment.