Extension Emailasusername


Extension Basics

Title
Emailasusername
Name
ckanext-emailasusername
Type
Public extension
Description
CKAN extension allowing users to login and reset passwords with their email as well as their username.
CKAN versions
Download-Url (zip)
Last commit
2 years ago (2023-02-07 09:38:51)
Url to repo
Category
Authentication & Security


Background Infos

Description (long)
Show details

tests test coverage

ckanext-emailasusername

We have have found that many of our users quickly forget their CKAN username. We have also observed several users assume they should use their email to login. This fails with a bad login error message, which causes some confusion.

This CKAN extension allows users to login or reset their password with either their email address or their username. It doesn’t do away with the username but just offers the option to use email instead.

Out of the box, CKAN allows multiple accounts to be registered with the same email address. This causes a problem for using email to identify the user. This extension therefore adds a validator to the registration form to stop new accounts being created if there already exists an account with the same email.

If multiple accounts are registered to your email, then identifying the user by email fails - you must use your username to login/reset your password instead. It’s recommended, if feasible, to work with your userbase to phase out multiple accounts with the same email.

Requirements

This extension is tested with CKAN 2.9 for python3 only.

Installation

To install ckanext-emailasusername:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate
    
  2. Install the ckanext-emailasusername Python package into your virtual environment::

    pip install ckanext-emailasusername
    
  3. Add emailasusername to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/production.ini).

  4. Configure CKAN to use the authenticator provided in this plugin. Add ckanext.emailasusername.authenticator:EmailAsUsernameAuthenticator to the [authenticators] plugins configuration in CKAN

Version
1.2.1
Version release date
2023-02-07
Contact name
(not set)
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

To install ckanext-emailasusername:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate
    
  2. Install the ckanext-emailasusername Python package into your virtual environment::

    pip install ckanext-emailasusername
    
  3. Add emailasusername to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/production.ini).

  4. Configure CKAN to use the authe

Plugins to configure (ckan.ini)
emailasusername
CKAN Settings (ckan.ini)
# ckanext.emailasusername.search_by_username_and_email = True
# ckanext.emailasusername.auto_generate_username_from_email = False
# ckanext.emailasusername.auto_generate_username_from_fullname = False
# ckanext.emailasusername.require_user_email_input_confirmation = True
DB migration to be executed
(not set)
<< back to Extensions