Extension Subscribe


Extension Basics

Title
Subscribe
Name
ckanext-subscribe
Type
Public extension
Description
CKAN extension allowing users to subscribe to dataset, organization and group updates without requiring login, using email-based verification links.
CKAN versions

~2.10,~2.11

Show details
Download-Url (zip)
Last commit
a month ago (2026-02-04 10:12:55)
Url to repo
Category
Content Management


Background Infos

Description (long)
Show details

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

  1. Activate CKAN virtual environment
  2. pip install ckanext-subscribe
  3. Add subscribe to ckan.plugins
  4. Ensure ckan.site_url is set correctly
  5. Ensure smtp.mail_from is set correctly
  6. Configure SMTP server if needed
  7. Initialize database: ckan db upgrade -p subscribe
  8. Restart CKAN
  9. 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

Version
1.3.0
Version release date
2026-02-02
Contact name
David Read
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Requires SMTP configuration. Cron job needed for sending notifications. Supports reCAPTCHA. DB migration required.

Plugins to configure (ckan.ini)
subscribe
CKAN Settings (ckan.ini)
# ckan.email_notifications_since = 2 days
# ckanext.subscribe.daily_and_weekly_notification_time = 09:00
# ckanext.subscribe.weekly_notification_day = friday
# ckanext.subscribe.recaptcha.privatekey =
# ckanext.subscribe.recaptcha.publickey =
# ckanext.subscribe.recaptcha.api_url =
# ckanext.subscribe.apply_recaptcha = false
DB migration to be executed
ckan db upgrade -p subscribe
<< back to Extensions