# Mage2 Module Ktpl LoginViaSms
``ktpl/module-loginviasms``
- [Main Functionalities](#markdown-header-main-functionalities)
- [Installation](#markdown-header-installation)
- [Configuration](#markdown-header-configuration)
- [Specifications](#markdown-header-specifications)
- [Attributes](#markdown-header-attributes)
## Main Functionalities
This module is created to support login via mobile sms otp or via whatsapp otp.
## Installation
\* = in production please use the `--keep-generated` option
### Type 1: Zip file
- Unzip the zip file in `app/code/Ktpl`
- Enable the module by running `php bin/magento module:enable Ktpl_LoginViaSms`
- Apply database updates by running `php bin/magento setup:upgrade`\*
- Flush the cache by running `php bin/magento cache:flush`
### Type 2: Composer
- Make the module available in a composer repository for example:
- private repository `repo.magento.com`
- public repository `packagist.org`
- public github repository as vcs
- Add the composer repository to the configuration by running `composer config repositories.repo.magento.com composer https://repo.magento.com/`
- Install the module composer by running `composer require ktpl/module-loginviasms`
- enable the module by running `php bin/magento module:enable Ktpl_LoginViaSms`
- apply database updates by running `php bin/magento setup:upgrade`\*
- Flush the cache by running `php bin/magento cache:flush`
## Configuration
- sms_gateway (login_sms/general/sms_gateway)
- priority (login_sms/general/priority)
- email_domain (login_sms/general/email_domain)
- message_format (login_sms/general/message_format)
- social_signup_error_message (login_sms/general/social_signup_error_message)
- enabled (login_sms/whatsapp/enabled)
- message_format (login_sms/whatsapp/message_format)
- url (login_sms/whatsapp/url)
- api_key (login_sms/whatsapp/api_key)
- can_allow_failed_attempts (login_sms/general/can_allow_failed_attempts)
- reset_failed_attempts_time (login_sms/whatsapp/reset_failed_attempts_time)
## Specifications
- Model
- Transaction
## Attributes
- Customer - Mobile Verified (mobile_verified)
``ktpl/module-loginviasms``
- [Main Functionalities](#markdown-header-main-functionalities)
- [Installation](#markdown-header-installation)
- [Configuration](#markdown-header-configuration)
- [Specifications](#markdown-header-specifications)
- [Attributes](#markdown-header-attributes)
## Main Functionalities
This module is created to support login via mobile sms otp or via whatsapp otp.
## Installation
\* = in production please use the `--keep-generated` option
### Type 1: Zip file
- Unzip the zip file in `app/code/Ktpl`
- Enable the module by running `php bin/magento module:enable Ktpl_LoginViaSms`
- Apply database updates by running `php bin/magento setup:upgrade`\*
- Flush the cache by running `php bin/magento cache:flush`
### Type 2: Composer
- Make the module available in a composer repository for example:
- private repository `repo.magento.com`
- public repository `packagist.org`
- public github repository as vcs
- Add the composer repository to the configuration by running `composer config repositories.repo.magento.com composer https://repo.magento.com/`
- Install the module composer by running `composer require ktpl/module-loginviasms`
- enable the module by running `php bin/magento module:enable Ktpl_LoginViaSms`
- apply database updates by running `php bin/magento setup:upgrade`\*
- Flush the cache by running `php bin/magento cache:flush`
## Configuration
- sms_gateway (login_sms/general/sms_gateway)
- priority (login_sms/general/priority)
- email_domain (login_sms/general/email_domain)
- message_format (login_sms/general/message_format)
- social_signup_error_message (login_sms/general/social_signup_error_message)
- enabled (login_sms/whatsapp/enabled)
- message_format (login_sms/whatsapp/message_format)
- url (login_sms/whatsapp/url)
- api_key (login_sms/whatsapp/api_key)
- can_allow_failed_attempts (login_sms/general/can_allow_failed_attempts)
- reset_failed_attempts_time (login_sms/whatsapp/reset_failed_attempts_time)
## Specifications
- Model
- Transaction
## Attributes
- Customer - Mobile Verified (mobile_verified)