Extension Emailauth


Extension Basics

Title
Emailauth
Name
ckanext-emailauth
Type
Public extension
Description
CKAN plugin for custom Authentication model including email and custom APIs
CKAN versions
Download-Url (zip)
Last commit
4 years ago (2021-06-21 06:38:19)
Url to repo
Category
Authentication & Security


Background Infos

Description (long)
Show details

======================

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:

  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

.. 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:

  1. Activate your CKAN virtual environment, for example::

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

  2. Clone repository and install the ckanext-emailauth requirements first by::

    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 (by default the config file is located at /etc/ckan/default/production.ini).

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

  6. 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

Version
Version release date
(not set)
Contact name
(not set)
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints
Plugins to configure (ckan.ini)
emailauth
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions