tutor

mirror of https://github.com/ChristianLight/tutor.git synced 2024-12-12 14:17:46 +00:00

History

Régis Behmo afc4b15253 Get rid of ugly "notes.openedx" network alias We achieve this thanks to a patch to edx-oauth2-provider: https://github.com/edx/edx-oauth2-provider/pull/59 The network alias was required to circumvent url validation by the oauth2 client creation tool. But the network alias was not compatible with k8s deployment.		2019-07-09 17:59:11 +08:00
..
tutornotes	Get rid of ugly "notes.openedx" network alias	2019-07-09 17:59:11 +08:00
MANIFEST.in	Add missing plugin manifest files	2019-07-04 18:01:27 +08:00
README.rst	Migrate notes to a dedicated plugin	2019-07-04 09:31:12 +08:00
setup.py	Fix insecure asset loading with web proxy enabled	2019-07-07 17:14:31 +08:00

README.rst

Students notes plugin for `Tutor <https://docs.tutor.overhang.io>`_
===================================================================

This is a plugin for `Tutor <https://docs.tutor.overhang.io>`_ to easily add the `Open edX note-taking app <https://github.com/edx/edx-notes-api>`_ to an Open edX platform. This app allows students to annotate portions of the courseware (see `the official documentation <https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-ironwood.master/exercises_tools/notes.html?highlight=notes>`_).

.. image:: https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-ironwood.master/_images/SFD_SN_bodyexample.png
    :alt: Notes in action

Installation
------------

The plugin is currently bundled with the `binary releases of Tutor <https://github.com/overhangio/tutor/releases>`_. If you have installed Tutor from source, you will have to install this plugin from source, too::
  
    pip install tutor-notes

Then, to enable this plugin, run::
  
    tutor plugins enable notes

		
You should beware that the ``notes.<LMS_HOST>`` domain name should exist and point to your server. For instance, if your LMS is hosted at http://myopenedx.com, the notes service should be found at http://notes.myopenedx.com.

If you would like to host the notes service at a different domain name, you can set the ``NOTES_HOST`` configuration variable (see below). In particular, in development you should set this configuration variable to ``notes.localhost`` in order to be able to access the notes service from the LMS. Otherwise you will get a "Sorry, we could not search the store for annotations" error.


Configuration
-------------

- ``NOTES_MYSQL_PASSWORD`` (default: ``"{{ 8|random_string }}"``)
- ``NOTES_SECRET_KEY`` (default: ``"{{ 24|random_string }}"``)
- ``NOTES_OAUTH2_SECRET`` (default: ``"{{ 24|random_string }}"``)
- ``NOTES_DOCKER_IMAGE`` (default: ``"overhangio/openedx-notes:{{ TUTOR_VERSION }}"``)
- ``NOTES_HOST`` (default: ``"notes.{{ LMS_HOST }}"``)
- ``NOTES_MYSQL_DATABASE`` (default: ``"notes"``)
- ``NOTES_MYSQL_USERNAME`` (default: ``"notes"``)

These values can be modified with ``tutor config save --set PARAM_NAME=VALUE`` commands.