ckanext-gcnotify
CKAN Extension for GC Notify integration.
Requirements
Compatibility with core CKAN versions:
| CKAN version |
Compatible? |
| 2.6 and earlier |
Not tested |
| 2.7 |
Not tested |
| 2.8 |
No |
| 2.9 |
Yes |
| 3.0 and later |
Yes |
Installation
To install ckanext-gcnotify:
Activate your CKAN virtual environment, for example:
. /usr/lib/ckan/default/bin/activate
Clone the source and install it on the virtualenv:
git clone --branch master --single-branch https://github.com/open-data/ckanext-gcnotify.git
cd ckanext-gcnotify
pip install -e .
pip install -r requirements.txt
Add gcnotify to the ckan.plugins setting in your CKAN config file
Add ckanext.gcnotify.secret_key setting in your CKAN config file with the value of your GC Notify secret key (last 5 hex groups of your API key)
Add ckanext.gcnotify.base_url setting in your CKAN config file with the value of your GC Notify base URI
Add ckanext.gcnotify.template_ids setting in your CKAN config file with the values of your GC Notify template IDs in a dict (key is email action and value is template ID)
Restart CKAN
Config settings
# GC Notify Secret key (required, default: None)
ckanext.gcnotify.secret_key = my_secret_key
# GC Notify base URI (required, default: None)
ckanext.gcnotify.base_url = my_base_uri
# GC Notify template IDs (required, default: None)
ckanext.gcnotify.template_ids = {
"send_reset_link":"template_id",
"send_invite":"template_id",
"new_user_admin_note":"template_id",
"new_user_note":"template_id",
"send_username_recovery":"template_id"}
License
MIT