======================
ckanext-emailauth
.. Put a description of your extension here:
What does it do? What features does it have?
Consider including some screenshots or embedding a video!
CKAN Authentication using Email as primary identifier including username
ckanext-emailauth allows you to:
- Enable registration / login via email or username
- Do email verification based on any SMTP server as per configuration you provide
- Ability to store extra user information as key value pair in user_extra table
- 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
.. Add any additional install steps to the list below.
For example installing any non-Python dependencies or adding any required
config settings.
To install ckanext-emailauth:
Activate your CKAN virtual environment, for example::
. /usr/lib/ckan/default/bin/activate
Clone repository and install the ckanext-emailauth requirements first by::
pip install -r requirements.txt
Install extension into your virtual environment::
python setup.py install
Add emailauth to the ckan.plugins setting in your CKAN
config file (by default the config file is located at
/etc/ckan/default/production.ini).
Follow configuration step below to add necessary details and then do Database Initialization
Restart CKAN. For example if you’ve deployed CKAN with Apache on Ubuntu::
sudo service apache2 reload
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