fghaas / tutor-contrib-webhook-receiver

This is an experimental Tutor plugin. You should not consider it ready for production use at this point.

Tutor plugin for Open edX Webhook Receiver

This is an experimental plugin for Tutor that deploys the Open edX Webhook Receiver application alongside Open edX.

Version compatibility matrix

You must install a supported release of this plugin to match the Open edX and Tutor version you are deploying. If you are installing this plugin from a branch in this Git repository, you must select the appropriate one:

Open edX release	Tutor version	Plugin branch	Plugin release
Lilac	>=12.0, <13	Not supported	Not supported
Maple	>=13.2, <141	maple	0.1.x
Nutmeg	>=14.0, <15	nutmeg	1.x.x
Olive	>=15.0, <16	main	2.x.x
Palm	>=16.0, <17	main	2.x.x
Quince	>=17.0, <18	main	2.x.x

Installation

pip install git+https://github.com/hastexo/tutor-contrib-webhook-receiver@v2.3.0

Then, to enable this plugin, run:

tutor plugins enable webhookreceiver

Before starting Tutor, build the docker image for the webhookreceiver service:

tutor images build webhookreceiver

Configuration

• WEBHOOKRECEIVER_HOST (default "webhooks.{{ LMS_HOST }}")
• WEBHOOKRECEIVER_DB_NAME (default "webhook_receiver")
• WEBHOOKRECEIVER_DB_USER (default "webhook_receiver01")
• WEBHOOKRECEIVER_DB_MIGRATION_OPTIONS (default {})
• WEBHOOKRECEIVER_DJANGO_LOG_LEVEL (default "DEBUG")
• WEBHOOKRECEIVER_EDX_OAUTH2_KEY (default "webhook_receiver")
• WEBHOOKRECEIVER_SHOPIFY_SHOP_DOMAIN (default "")
• WEBHOOKRECEIVER_SHOPIFY_API_KEY (default "")
• WEBHOOKRECEIVER_WOOCOMMERCE_SOURCE (default "")
• WEBHOOKRECEIVER_WOOCOMMERCE_SECRET (default "")

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

Footnotes

1. For Open edX Maple and Tutor 13, you must run version 13.2.0 or later. That is because this plugin uses the Tutor v1 plugin API, which was introduced with that release. ↩