2FA Authenticator Module for Perfex CRM Documentation ☰

Introduction

This documentation covers the complete installation, configuration, and usage of the 2FA Authenticator Module for Perfex CRM. The module provides seamless two-factor authentication (2FA) integration to enhance the security of your Perfex CRM environment.


Designed as a plug-and-play add-on, this module enables TOTP-based 2FA using apps like Google Authenticator, Microsoft Authenticator, Authy, and others for both clients and staff users. With minimal setup, you can significantly improve login security across your CRM system.

System Requirements

  • Perfex CRM v3.1.0 or higher

Installation

Installing the module is quick and simple, It takes just a few minutes :

  • Extract the main .zip file and locate the authenticator_2fa.zip file.
  • Log in to the Perfex CRM admin panel as an administrator and go to Setup → Modules.
  • Click Choose File and select the authenticator_2fa.zip
  • Click Install to complete the process.
2FA Module Installation

Once the module is installed, it will appear in the list of available modules below. Simply click the Activate button to enable it.

2FA Module Activation

Configuration :

Once the module is installed and activated, you'll see two options, Deactivate and Settings. Click on the Settings button to quickly access the 2FA Authenticator Settings

2FA Module Activation

Alternatively, you can navigate to Setup → Settings → 2FA Authenticator to access its configuration options, which include :

  • App Name – This name will appear in the Authenticator app when users scan the QR code.
  • Enable for Customers – When disabled, customers will not be prompted for complete two-factor authentication.
  • Enable for Admins – When disabled, admin users will not be prompted for two-factor authentication during login.
2FA Module Activation

Usage

Once the module is installed and configured, two-factor authentication (2FA) will be seamlessly enforced for both clients and admin users, depending on your settings:

  • Customer Login
    • When a customer logs into their portal, they will be prompted to enroll in 2FA (if enabled).
    • The system will generate a QR code and secret key for use with the Authenticator app.
    • Once scanned, the customer enters the code to complete enrollment.
    • On future logins, they must enter the OTP generated by the app.
  • Admin Login
    • When an admin logs into the admin panel, they will also be prompted to enroll in 2FA (if enabled).
    • The enrollment process is the same. Scan the QR code, enter the generated OTP, and proceed.
    • Subsequent logins will require the OTP for access.
  • Verification Flow
    • 2FA prompts appear only once per login session unless the user logs out or the session expires.
    • Failed OTP attempts are handled gracefully, with retry options and error messages.
  • Resetting 2FA
    • If a user loses access to their Authenticator app, they will be prompted to re-scan the QR code and re-enroll right after logging in, ensuring continued access without admin intervention.

Frequently Asked Questions (FAQ)

  • Do I need anything else or external credentials to make this module work?
  • No. This module works out of the box and does not require any external API keys or credentials. Users only need a TOTP-based Authenticator app like Google Authenticator, Microsoft Authenticator, Authy, etc.
  • Do I need coding knowledge to use this module?
  • No. This module is fully plug-and-play. You just need to upload, activate, and configure it via the admin panel.
  • Do I need to modify any core files in Perfex CRM?
  • No. This module is self-contained and does not require any core file modifications.
  • Is this module compatible with all Perfex CRM versions?
  • Yes. This module works with all Perfex CRM versions starting from 3.1.0 and above.
  • What happens if a user loses access to their Authenticator app?
  • If a user loses access to their Authenticator app, they will be prompted to re-scan the QR code and re-enroll right after logging in, ensuring continued access without admin intervention.
  • Can I enable 2FA for only customers or only admins?
  • Yes. The module provides individual toggles to enable or disable 2FA separately for customers and admins.
  • Does this module support multiple languages?
  • The module is translation-ready and comes with an English language file by default. You can easily add other languages by copying and translating the provided language file.
  • Are updates included?
  • Yes. All future updates are included and will be available via your CodeCanyon account under downloads.

Support

For support, please reach out to us at codeonstring@gmail.com. We will respond as soon as possible, typically within one working day.

Changelog

VERSION 1.0.0 – Initial Release.