mirror of
https://github.com/frappe/erpnext.git
synced 2026-05-27 08:54:45 +00:00
Removal of SMS Settings and SMS Parameters from ERPNext (#10033)
* Removal of SMS Settings and SMS Parameter from ERPNext. * [DOCS]Documentation for Two Factor Authentication * [Patch]Point SMS module to frappe core * Rearrange doc help index.txt to fit * [DOCS]Update Documentation for Two Factor Authentication
This commit is contained in:
ckosiegbu
@@ -9,4 +9,5 @@ managing-tree-structure-masters
|
||||
naming-series-current-value
|
||||
overwriting-data-from-data-import-tool
|
||||
rename-user
|
||||
using-custom-domain-on-erpnext
|
||||
using-custom-domain-on-erpnext
|
||||
setup-two-factor-authentication
|
||||
@@ -0,0 +1,41 @@
|
||||
#Setup Two Factor Authentication
|
||||
|
||||
##Enable Two Factor Authentication (2FA)
|
||||
|
||||
Activate two factor authentication by running the command.
|
||||
|
||||
`bench --site [sitename] enable_two_factor_auth true`
|
||||
|
||||
Specify the following in System Settings
|
||||
|
||||
* The method of OTP validation (OTP App = TOTP using Soft or Hard Token while Email/SMS = HOTP using Email or SMS
|
||||
* The expiry time for the QR Code on the server if OTP App is specified
|
||||
* The OTP Issuer Name.
|
||||
|
||||
<img alt="Enable Two Factor Auth" class="screenshot" src="/docs/assets/img/articles/twofactor/twofactor-1.png">
|
||||
|
||||
|
||||
On activation of 2FA from setup, it is also activated for the Role "All". In this way, all users including the Administrator have to perform a 2nd level authentication with a token. By unchecking the "Two Factor Authentication" checkbox in the "All" role and enabling it in other roles, the need to login with a token can be limited to specific roles. 2FA does not apply to login by Web Users and API login
|
||||
|
||||
<img alt="Role Enable Two Factor Auth" class="screenshot" src="/docs/assets/img/articles/twofactor/twofactor-2.png">
|
||||
|
||||
If using SMS authentication, please make sure that your SMS settings are updated
|
||||
|
||||
<img alt="SMS Settings" class="screenshot" src="/docs/assets/img/articles/twofactor/twofactor-3.png">
|
||||
|
||||
If using Email, make sure that your outgoing Email account settings are updated
|
||||
|
||||
<img alt="Email Settings" class="screenshot" src="/docs/assets/img/articles/twofactor/twofactor-4.png">
|
||||
|
||||
When the new user tries to log in for the first time in a system that has two-factor authentication enabled and which has the authentication option as OTP App, an email is sent containing a link to the QR Code.
|
||||
|
||||
<img alt="Email Notify Two Factor" class="screenshot" src="/docs/assets/img/articles/twofactor/twofactor-5.png">
|
||||
<img alt="QR Code Page" class="screenshot" src="/docs/assets/img/articles/twofactor/twofactor-6.png">
|
||||
|
||||
Scanning the QR Code with an authentication app like Google Authenticator registers the access for the user and automatically starts to generate tokens that can be used to login
|
||||
|
||||
<img alt="Two Factor Scan App" class="screenshot" src="/docs/assets/img/articles/twofactor/twofactor_app.jpeg">
|
||||
|
||||
If either of Email/SMS is used as the authentication method, you get notifications also
|
||||
|
||||
<img alt="Email and SMS" class="screenshot" src="/docs/assets/img/articles/twofactor/twofactor-8.png">
|
||||
@@ -10,4 +10,14 @@ To open System Settings, go to:
|
||||
|
||||
<img class="screenshot" alt="System Settings" src="/docs/assets/img/setup/settings/system-settings.png">
|
||||
|
||||
####Two Factor Authentication.
|
||||
Settings for Two Factor Authentication can be configured here.
|
||||
|
||||
* Select the authentication method to be used
|
||||
* Expiry time for QRCode image if "OTP App" is selected in method
|
||||
* Issuer name of the One Time Password
|
||||
|
||||
<img class="screenshot" alt="Two Factor Auth" src="/docs/assets/img/setup/settings/twofactor-settings.png">
|
||||
|
||||
|
||||
{next}
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
step-1-language
|
||||
step-2-currency-and-timezone
|
||||
step-3-user-details
|
||||
step-4-company-details
|
||||
step-5-letterhead-and-logo
|
||||
step-6-add-users
|
||||
step-7-tax-details
|
||||
step-8-customer-names
|
||||
step-9-suppliers
|
||||
step-10-item
|
||||
step-4-two-factor-authentication
|
||||
step-5-company-details
|
||||
step-6-letterhead-and-logo
|
||||
step-7-add-users
|
||||
step-8-tax-details
|
||||
step-9-customer-names
|
||||
step-10-suppliers
|
||||
step-11-item
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Step 8: Suppliers
|
||||
# Step 10: Suppliers
|
||||
|
||||
Enter a few of your Suppliers' names.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Step 9: Item Names
|
||||
# Step 11: Item Names
|
||||
|
||||
In this final step, please enter the names of the Items you buy or sell.
|
||||
|
||||
@@ -2,8 +2,7 @@
|
||||
|
||||
Enter Users Profile Details like Name, User ID and preferred password.
|
||||
|
||||
<img alt="User" class="screenshot"
|
||||
src="/docs/assets/img/setup-wizard/step-3.png">
|
||||
<img alt="User" class="screenshot" src="/docs/assets/img/setup-wizard/step-3.png">
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
# Step 4: Two Factor Authentication
|
||||
|
||||
Enable Two Factor Athentication
|
||||
|
||||
<img alt="TwoFactor" class="screenshot" src="/docs/assets/img/setup-wizard/twofactor.png">
|
||||
|
||||
---
|
||||
###Authentication Method
|
||||
Whenevever each user logs in, based on the role set for that user,
|
||||
they will be asked for a **One Time Password** after they input
|
||||
their login details.
|
||||
|
||||
{next}
|
||||
@@ -1,9 +1,8 @@
|
||||
# Step 4: Company Details
|
||||
# Step 5: Company Details
|
||||
|
||||
Enter Company Details like Name, Abbreviation and Financial Year Details.
|
||||
|
||||
<img alt="Company Details" class="screenshot"
|
||||
src="/docs/assets/img/setup-wizard/step-4.png">
|
||||
<img alt="Company Details" class="screenshot" src="/docs/assets/img/setup-wizard/step-4.png">
|
||||
|
||||
---
|
||||
|
||||
@@ -1,8 +0,0 @@
|
||||
# Step 6: Add Users
|
||||
|
||||
Add other users and assign them roles based on their job responsibilities.
|
||||
|
||||
<img alt="Users" class="screenshot"
|
||||
src="/docs/assets/img/setup-wizard/step-6.png">
|
||||
|
||||
{next}
|
||||
@@ -1,9 +1,8 @@
|
||||
# Step 5: Letterhead and Logo
|
||||
# Step 6: Letterhead and Logo
|
||||
|
||||
Attach Company Letterhead and Company Logo.
|
||||
|
||||
<img alt="Company Logo and Letterhead" class="screenshot"
|
||||
src="/docs/assets/img/setup-wizard/step-5.png">
|
||||
<img alt="Company Logo and Letterhead" class="screenshot" src="/docs/assets/img/setup-wizard/step-5.png">
|
||||
|
||||
---
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
# Step 7: Add Users
|
||||
|
||||
Add other users and assign them roles based on their job responsibilities.
|
||||
|
||||
<img alt="Users" class="screenshot" src="/docs/assets/img/setup-wizard/step-6.png">
|
||||
|
||||
{next}
|
||||
@@ -1,9 +1,8 @@
|
||||
# Step 6: Tax Details
|
||||
# Step 8: Tax Details
|
||||
|
||||
Enter any three types of taxes which you regularly pay. This wizard will create a tax master which will calculate the taxes as per the tax-type.
|
||||
|
||||
<img alt="Tax Details" class="screenshot"
|
||||
src="/docs/assets/img/setup-wizard/step-7.png">
|
||||
<img alt="Tax Details" class="screenshot" src="/docs/assets/img/setup-wizard/step-7.png">
|
||||
|
||||
Just set the tax name and the standard percentage levied.
|
||||
|
||||
@@ -1,10 +1,9 @@
|
||||
# Step 7: Customers
|
||||
# Step 9: Customers
|
||||
|
||||
Enter your Customer names and the contact person from that organisation.
|
||||
|
||||
|
||||
<img alt="Customers" class="screenshot"
|
||||
src="/docs/assets/img/setup-wizard/step-8.png">
|
||||
<img alt="Customers" class="screenshot" src="/docs/assets/img/setup-wizard/step-8.png">
|
||||
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user