2FA Authenticator Plugin for Rise CRM Documentation

Introduction

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


Designed as a plug-and-play add-on, this plugin 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

  • Rise CRM v3.5.0 or higher

Installation

Installing the plugin 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 Rise CRM admin panel as an administrator and go to Settings → Plugins.
  • Click Install Plugin and a model will popup
2FA Plugin Installation
  • Upload Authenticator_2fa.zip
  • Enter valid Purchase Code
  • Click Install
2FA Plugin Activation

After installation, click the action button to open the dropdown menu, then click Activate to enable the plugin.

2FA Plugin Activation

Configuration :

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

  • App Name – This name will appear in the Authenticator app when users scan the QR code.
  • Enable for Clients – When disabled, clients 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 Plugin Configuration

Usage

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

  • Client Login
    • When a client 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 client 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 (due to device loss, reset, or uninstallation), they won't be able to log in using two-factor authentication. In such cases, the user can submit a re-enrollment or reset request directly from the interface. This request will be reviewed and processed by an administrator, who can reset the 2FA status from the admin panel. Once reset, the user will be able to reconfigure their Authenticator app with QR code.

Frequently Asked Questions (FAQ)

  • Do I need anything else or external credentials to make this plugin work?
  • No. This plugin 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 plugin?
  • No. This plugin 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 Rise CRM?
  • No. This plugin is self-contained and does not require any core file modifications.
  • Is this plugin compatible with all Rise CRM versions?
  • Yes. This plugin works with all Rise CRM versions starting from 3.5.0 and above.
  • What happens if a user loses access to their Authenticator app?
  • If a user loses access to their Authenticator app (due to device loss, reset, or uninstallation), they won't be able to log in using two-factor authentication. In such cases, the user can submit a re-enrollment or reset request directly from the interface. This request will be reviewed and processed by an administrator, who can reset the 2FA status from the admin panel. Once reset, the user will be able to reconfigure their Authenticator app with QR code.
  • Can I enable 2FA for only clients or only admins?
  • Yes. The plugin provides individual toggles to enable or disable 2FA separately for clients and admins.
  • Does this plugin support multiple languages?
  • The plugin 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.

Change Log

VERSION 1.0.0 – Initial Release