ckanext-subscribe
CKAN extension that allows users to subscribe to dataset/organization/group updates WITHOUT requiring them to login.
This feature is complementary to CKAN’s existing “Follow” feature, which allows logged in users to subscribe to get update emails. Log-in can be a barrier to casual interest in say a handful of datasets. Generating and storing a password is a burden on the user, and for casual use just using temporary email links, as in this extension, is more appropriate.
Requirements
Compatibility with CKAN versions:
- CKAN 2.10: yes
- CKAN 2.11: yes
Installation
- Activate CKAN virtual environment
pip install ckanext-subscribe
- Add
subscribe to ckan.plugins
- Ensure
ckan.site_url is set correctly
- Ensure
smtp.mail_from is set correctly
- Configure SMTP server if needed
- Initialize database:
ckan db upgrade -p subscribe
- Restart CKAN
- Set up cron job:
ckan subscribe send-any-notifications (every minute recommended)
Config Settings
ckan.email_notifications_since = 24:00:00
ckanext.subscribe.daily_and_weekly_notification_time = 09:00
ckanext.subscribe.weekly_notification_day = friday
- reCAPTCHA settings:
ckanext.subscribe.recaptcha.privatekey, .publickey, .api_url, .apply_recaptcha
Troubleshooting
Check cron schedule, create test activity with ckan subscribe create-test-activity, clean up with ckan subscribe delete-test-activity.
Tests
pytest --ckan-ini=test.ini --disable-warnings ckanext/subscribe/tests
License
AGPL-3.0