These CKAN Versions are exactely matched:

• 2.10.0
• 2.10.1
• 2.10.2
• 2.10.3
• 2.10.4
• 2.10.5
• 2.10.6
• 2.10.7
• 2.10.8
• 2.10.9
• 2.11.0
• 2.11.1
• 2.11.2
• 2.11.3
• 2.11.4
• 2.12.0
• 2.8.0
• 2.8.1
• 2.8.10
• 2.8.11
• 2.8.12
• 2.8.2
• 2.8.3
• 2.8.4
• 2.8.5
• 2.8.6
• 2.8.7
• 2.8.8
• 2.8.9
• 2.9.0
• 2.9.0a
• 2.9.1
• 2.9.10
• 2.9.11
• 2.9.13
• 2.9.2
• 2.9.3
• 2.9.4
• 2.9.5
• 2.9.6
• 2.9.7
• 2.9.8
• 2.9.9

ckanext-emailauth

CKAN Authentication using Email as primary identifier including username.

Features

ckanext-emailauth allows you to:

1. Enable registration / login via email or username
2. Do email verification based on any SMTP server as per configuration you provide
3. Ability to store extra user information as key-value pair in user_extra table
4. Reset password via email verification link with link expiry

Requirements

Supports Python 2.7 and Python 3.8, tested with CKAN 2.8.4 / CKAN 2.9.1

Installation

To install ckanext-emailauth:

1. Activate your CKAN virtual environment:

   . /usr/lib/ckan/default/bin/activate
   

2. Clone repository and install the requirements first:

   pip install -r requirements.txt
   

3. Install extension into your virtual environment:

   python setup.py install
   

4. Add emailauth to the ckan.plugins setting in your CKAN config file.

5. Follow configuration step below to add necessary details and then do Database Initialization.

6. Restart CKAN.

Configuration

ckanext-emailauth has few custom configuration which is required before running:

ckan.mail.key=email_id@domain.com
ckan.mail.secret=password
ckan.mail.sent_from=email_id@domain.com

# Optional
password.reset_key.expiry_hours=4

Database Initialization

ckanext-emailauth requires two custom tables which need to be initialized.

For CKAN 2.8 or less:

paster user_validation initdb -c /path/to/development.ini
paster user_extra initdb -c /path/to/development.ini

For CKAN 2.9 or greater:

ckan -c /path/to/ckan.ini user_validation initdb
ckan -c /path/to/ckan.ini user_extra initdb

Modifying Authenticator

In your who.ini file add custom authenticator as:

[authenticators]
plugins =
    auth_tkt
    ckanext.emailauth.authenticator:EmailAuthenticator

This will enable EmailAuthenticator during all authenticator process, allowing authentication via both username and email.

Note

This plugin was primarily built for the JusticeHub theme and may require some modifications for general usage. Future improvements planned include configurable schema and templates.

License

AGPL-3.0 license