Personal tools
Namespaces

Variants
Actions

Password Manager For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Products Access Details)
(→‎About Password Manager For WHMCS)
 
(139 intermediate revisions by 10 users not shown)
Line 2: Line 2:
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Password Manager For WHMCS Module."></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Password Manager For WHMCS Module."></meta>
  
−
=About [http://www.modulesgarden.com/products/whmcs/password_manager/features Password Manager For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/password-manager Password Manager For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Password Manager For WHMCS''' gives you the possibility to store your passwords and share them safely with your staff and your clients.<br />
+
|style="padding: 10px 0px 10px 0px;"|'''Password Manager For WHMCS''' gives you the possibility to store fragile data and share them safely with your staff and clients.<br />
−
Module offers various mechanisms allowing you to conveniently manage passwords, access to them as well as integrate with your WHMCS client area.<br />
+
The module offers various mechanisms allowing you to smoothly manage sensitive data such as passwords or license keys, in the case of resellers, send email reminders or integrate with your WHMCS client area.<br />
−
By using advanced two-way encryption mechanisms Password Manager For WHMCS provides an appropriately high level of security for your valuable data.
+
Owing to the implementation of advanced two-way encryption, Password Manager For WHMCS provides a high-security level for your and your customers' critical data.
 
|}
 
|}
−
*'''Features:'''
+
<!-- fixed -->
 +
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Share Access Details With Multiple Clients
+
|style="padding: 10px 0px 0px 30px;"|✔ Create Private Access Details
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Share Access Details With Administrators With Specific Admin Roles
+
|style="padding: 0px 0px 0px 30px;"|✔ Share Access Details With Clients & Administrators
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Store Personal Access Details Which Are Only Visible To You
+
|style="padding: 0px 0px 0px 30px;"|✔ Display Clients Access Details In Clients Summary And Clients Tickets
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Stores Access Details In Encrypted Format
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Access To Clients Passwords:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Extended Permissions For Admin Role - Allow Access To All Non-Personal Passwords
+
|style="padding: 0px 0px 0px 45px;"|✔ Full Access - Any Administrator Can View Any Password
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Revoke Access (Visibility) Of The Password From Clients/Administrators - With One Click
+
|style="padding: 0px 0px 0px 45px;"|✔ Restricted Access - Allowed Administrators Can View Any Password
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Normal Administrators With 'Configure Addon Modules' Permission Are Unable To Change Extended Permissions
+
|style="padding: 0px 0px 0px 45px;"|✔ Shared Access - Allowed Administrators Can View Shared Passwords
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Adding Note To The Password
+
|style="padding: 0px 0px 0px 30px;"|✔ Store All Access Details In Encrypted Format
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Provides A Colorized Display Of Access Details Within The Admin Area
+
|style="padding: 0px 0px 0px 30px;"|✔ Add Notes To Password
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Links To The Website Or The Login Page Of The Password
+
|style="padding: 0px 0px 0px 30px;"|✔ Copy Usernames And Passwords Into Clipboard
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Displays Owner Of Password
+
|style="padding: 0px 0px 0px 30px;"|✔ Set Direct Links To Website Or Login Page With Password Used
 
|}
 
|}
−
*'''Additionally:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Easy Integration
+
|style="padding: 0px 0px 0px 30px;"|✔ Display Password Owner
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Availability Of Private Passwords And Product Passwords For Clients
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 and Later
+
|style="padding: 0px 0px 0px 30px;"|✔ Forbid Password Management For Chosen Clients/Client Groups
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Exclude Products/Product Groups From Being Displayed
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Allow Clients To Set Master Password For Owned Passwords
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Define Client Passwords Limit Per User
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Adjust Length And Characters For Random Password Generation
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Notify Upon Password Change
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Send Password Change Reminder
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Define Email Templates For Reminder And Notification
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Define Time Period For Password Change Reminder
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Customize Module Language Files With "Translations" Tool
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Control Staff Access Level To Specific Resources
 +
|}
 +
*'''Client Area Features:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ Display And Manage Access Details
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Display And Add Additional Access Details Of Owned Services
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Generate Random Passwords
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Copy Usernames And Passwords Into Clipboard
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Import And Export Access Details In CSV Format
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Share Access Details With Administrators And Clients
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Create Shared Categories
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Assign Categories To Access Details
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Restrict Access To Owned Passwords Using Master Password
 +
|}
 +
 
 +
*'''General Info:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ High-Level Security With Advanced Two-Way Encryption
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support With Custom Translations Tool
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six", "Twenty-One", "Lara" And "Lagom WHMCS Client Theme"
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.10 Back To WHMCS V8.6
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 Or Later
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/password-manager#open-source-version Open Source Version]
 
|}
 
|}
  
 
=Installation=
 
=Installation=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install Password Manager For WHMCS.''' <br />
+
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install [https://www.modulesgarden.com/products/whmcs/password-manager Password Manager For WHMCS.]''' <br />
 
We will guide you step by step through the whole installation and configuration process. <br />
 
We will guide you step by step through the whole installation and configuration process. <br />
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download Password Manager For WHMCS.'''
+
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:PM1.png]]
 
|style="padding: 0px 0px 20px 25px;"|[[File:PM1.png]]
 
|}
 
|}
 +
<!--
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
−
Files in your WHMCS directory should look like this.
+
In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.<br/>  If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support].
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PM2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP72_74.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Password Manager for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/>
−
File is located at '' 'modules/addons/PasswordManager/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
+
The first one supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.<br/>
 +
'''''Note:''' Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released anymore. Find more info [http://php.net/supported-versions.php here].''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_74.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"|  '' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/password-manager#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
 +
|}-->
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''2.  Extract the package and upload its content into the main WHMCS directory.<br/>
 +
The content of the package to upload should look like this.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:ftyrtr.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Password Manager For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
 +
File is located in '' 'modules/addons/PasswordManager/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 
|}
 
|}
 
{|
 
{|
Line 79: Line 179:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit a previously renamed '' 'license.php' file.' '' '''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
−
Enter your license key between quotation marks as presented on the following screen. You can find your license key at your client area → '' 'My Products' ''.
+
Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → '' 'My Products'. ''
 
|}
 
|}
 
{|
 
{|
Line 86: Line 186:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. Now you have to activate the module in your WHMCS system. '''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''5. Now, set up the  '' 'storage' '' folder as recursively writable.'''<br />
−
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Password Manager' '' and press '' 'Activate' '' button.
+
This folder is available at '' '/yourWHMCS/modules/addons/PasswordManager/'. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PM_4_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
 +
Log in to your WHMCS administrator area. Go to '' 'System Settings' '' → '' 'Addon Modules'. ''<br />
 +
Afterwards, find '' 'Password Manager' '' and press '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
Line 93: Line 201:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. In the next step you need to permit access to this module.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step, you need to permit access to the module.'''<br />
−
To do so, click on '' 'Configure' '' button, select administrator groups which should have access to this addon and press '' 'Save Changes' ''.
+
To do so, click on the'' 'Configure' '' button, select administrator groups that should have access to this addon, and press '' 'Save Changes'. ''
 
|}
 
|}
 
{|
 
{|
Line 100: Line 208:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. You have just successfully installed Password Manager For WHMCS!'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Password Manager For WHMCS!'''<br />
−
You can access your module at '' 'Addons' '' → '' 'Password Manager' ''.
+
You can access your module under '' 'Addons' '' → '' 'Password Manager'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PM7.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_7.png]]
 
|}
 
|}
  
 
=Configuration and Management=
 
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Password Manager For WHMCS allows to share passwords in your WHMCS.'''<br />
+
|style="padding: 10px 0px 30px 15px;"|'''Password Manager For WHMCS allows to safely store and share fragile data within your WHMCS.'''<br />
−
In this short guide we will present you the possibilities of our module.  
+
In this short guide, we will present you all the possibilities of our module.  
 
|}
 
|}
−
 
+
<!--
 
==Integration Code==
 
==Integration Code==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''Integration described below is not obligatory.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''Integration described below is not required for WHMCS V6 with Six template, where it is integrated automatically.'''<br />
−
Module allows your customers to view passwords shared to them and manage their own passwords.<br />
+
The module allows your customers to view passwords shared with them and manage their own passwords.<br />
−
We implemented easy integration which will add button leading to password management at the client area.<br />
+
We implemented easy integration which will add a button leading to password management in the client area.<br />
−
You can find integration code at '' 'Addons' '' → '' 'Password Manager' '' → '' 'Integration Code' ''.
+
You can find the integration code under '' 'Addons' '' → '' 'Password Manager' '' → '' 'Integration Code'. ''
 
|}
 
|}
 
{|
 
{|
Line 124: Line 232:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|In the client area you will find button marked on the following screen.
+
|style="padding: 0px 0px 20px 15px;"|In the client area you will find a button marked on the following screen.
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:PM9.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:PM9.png]]
 
|}
 
|}
−
 
+
-->
 
==Configuration==
 
==Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|At '' 'Configuration' '' tab you can define if your clients can see their products access details while excluding specific products, clients or client groups.<br />
+
|style="padding: 10px 0px 30px 15px;"|Before you start your work with our ''Password Manager For WHMCS,'' please move to  '' 'Settings' '' tab, where you will configure access restrictions to product passwords, define email notifications and manage security settings.
−
You can also decide, if your clients can manage their private access details while excluding right for selected clients or client groups.<br />
+
−
Additionally, you are able to set limits to number of  access details created by your clients.
+
 
|}
 
|}
−
===Products Access Details===
+
===Products/Services Password===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|1.'' 'Display Products Access Details' '' - If enabled, access details to clients products and services will be displayed at the client area → '' 'Password Manager' ''.<br />
+
|style="padding: 10px 0px 15px 15px;"|First of all, decide whether you wish to allow to display a full list of the client's products and services' login details by selecting the option: '' 'Client Products/Services Password'. ''<br/> If enabled, access details to client's products and services will be displayed in the client area → '' 'Password Manager'. ''<br />
−
2. '' 'Exclude Client Groups' '' - Disable display of products access details for client groups which IDs are entered  in '' 'Exclude Client Groups' '' field.<br />
+
'' 'Exclude Client Groups' '' - enter any client group name to disable the product's access details from being displayed for clients in these groups.<br />
−
3. '' 'Exclude Products' '' - Disable display of access details to products which IDs are entered in '' 'Exclude Products' '' field.<br />
+
'' 'Exclude Clients' '' - disable product access details for pointed here clients.<br/>
−
4. '' 'Exclude Clients' '' - Disable product access details at the client area → '' 'Password Manager' '' for selected clients.
+
'' 'Exclude Product Groups' '' - enter any product group names, to which access details will not be shown.<br/>
 +
'' 'Exclude Products' '' - access details for products, which are entered here, will be disabled.<br />
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PM10.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_10.png]]
 
|}
 
|}
  
−
===Private Access Details===
+
===Client's Private Passwords===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|1. '' 'Manage Private Access Details' '' - Allows to manage private passwords by clients.<br />
+
|style="padding: 10px 0px 15px 15px;"|The next section is dedicated to the management of private passwords of clients.<br/> If you wish to allow your clients to manage their personal access details, select the '' 'Client's Private Passwords' '' option.<br />Your clients can be also permitted to set their own '' 'Master Password' '' to provide additional protection for their stored passwords. Next, move to the specific configuration:<br />
−
2. '' 'Exclude Client Groups' '' - Disable private access details management for selected client groups.<br />
+
1. '' 'Exclude Client Groups' '' - disable private access details management for selected here client groups.<br />
−
3. '' 'Exclude Client' '' - Disable management of private access details for typed clients.<br />
+
2. '' 'Exclude Client' '' - disable management of private access details for pointed here clients.<br />
−
4. '' 'Access Details Limit Per User In Group' '' - Allows to limit private access details quantity per client. You have to enter it in format 'client group ID=access details limit'.<br />
+
3. '' 'Passwords Limit Per User' '' - set up the limit of private access details for one client.<br />
−
5. '' 'Exclude Client From Limit' '' - Disable access details limit for selected clients.<br />
+
4. '' 'Exclude Client From Limit' '' - enter clients for which the set up above limit will not be effective.<br />
−
6. '' 'Extended Permissions' '' - Allows to view clients access details with checked '' 'Visibility For Admins:' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PM11.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_11.png]]
 
|}
 
|}
  
−
==Add Access Details==
+
===Email Notifications===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'' 'Add Access Details' '' tab allows you to create new access details and decide who can view it.<br />
+
|style="padding: 10px 0px 15px 15px;"|This section allows you to define email notification templates that will be sent by the module on specific actions to clients and administrators.<br />
−
Into '' 'Name' '' textbox enter name of password you are creating and enter access details into '' 'Username' '' and '' 'Password' ''.
+
1. '' 'Password Change Reminder' '' - select an email template that will be used to remind clients or administrators about the need to change the password.<br />
 +
2. '' 'Password Change Notification' '' - select an email template that will be used to notify clients and about a password being changed.<br />
 +
Please note that you have to select templates for clients and administrators separately. If you want to disable any of the notifications, simply select '' 'Unassign' '' from dropdown menu.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PM12.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_11_1.png]]
 
|}
 
|}
 +
 +
===Security Settings===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Afterwards select '' 'Admins' '', '' 'Admin Groups' '' and '' 'Clients' '' which should see these access details (Ctrl + click to mark more than one entry).<br />
+
|style="padding: 10px 0px 15px 15px;"|Under the'' 'Security Settings' '' tab, you have to define the level of access to clients' passwords for administrators and grant them extended permissions.<br />
−
''Note: There is [http://en.wikipedia.org/wiki/Logical_disjunction disjunction] relation between 'Admins' and 'Admin Groups'.''<br />
+
You may grant your administrators:<br/>
−
''For example, if you assign admins X and Z and admin group Y in which admin X is, then all admins assigned to group X will see these access details as well as admin Z.''
+
*Full access to clients' passwords -  any administrator will be allowed to view clients' passwords
 +
*Restricted access - only administrators with chosen roles will get access to the passwords
 +
*Shared access - only passwords marked as '' 'Shared' '' will be visible for chosen administrator roles.<br/>
 +
You may also select here administrators group which will be granted '' 'Extended Permissions'.'' <br/>It means that administrators from this group will be allowed to view clients' access details when '' 'Visibility For Administrators:' '' is checked.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PM13.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_11_2.png]]
 
|}
 
|}
 +
===Other===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You can also make your logging in easier through entering website URL and website logging in URL consecutively into '' 'Website' '' and '' 'Login URL' ''.<br />
+
|style="padding: 10px 0px 15px 15px;"|In the very last section you may manage additional options that '' 'Password Manager For WHMCS'' ' has to offer.<br/>
−
To leave a note associated to access details you are creating, type it into '' 'Note' '' textbox.
+
* '''Password Manager Button''' - select to enable access to '' 'Password Manager' '' for your clients in their client area.<br/>
 +
* '''Profile Tab''' - select this option to add '' 'Passwords' '' tab in the client's profile in the administrator area.<br/>
 +
* '''Support Tickets Tab''' - if you select this option, '' Passwords' '' tab will be available on the support tickets site.<br/>
 +
* '''Password Random Characters''' - define a set of characters to be used for random password generation.
 +
* '''Password Strength''' - define the length of randomly generated passwords.
 +
* '''Hide Guide''' - toggle to turn on the option to hide the guide shown at '' 'Dashboard'. ''
 +
<br/>
 +
Do not forget to save the changes when you finish the settings configuration.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PM14.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_11_21.png]]
 
|}
 
|}
 +
 +
==Categories==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|At '' 'Visibility' '' you can define which functionalities are available.<br />
+
|style="padding: 10px 0px 15px 15px;"|Categories allow you to prepare predefined sets of clients and administrators.<br />
−
Press '' 'Save Changes' '' button to confirm creation of access details.<br />
+
By assigning a category to a password, clients and administrators from that category are granted permission to view this password.<br />
−
''Note: If you leave 'Clients' checkbox unmarked, your client will not see this access details even if he is assigned at 'Clients' option.''
+
Move to '' 'Categories' → 'Administrator Categories' '' where you can add new sets, press '' 'Add Category' '' to begin.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PM15.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_11_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Now, fill out the form with the category name and description.<br />
 +
Assign desired clients and administrators to the category and press '' 'Confirm'. ''<br />
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_11_4.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|The list of administrator categories with any details such as listed clients and administrators allowed to access the details is now visible.<br/> You may always edit the category or delete it if needed. Use the action buttons to do so.<br />
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_11_5.png]]
 
|}
 
|}
  
−
==Access Details List==
+
==Access Details==
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|'' 'Access Details' '' section includes a list of provided access details. Here you can create new access details and decide who can view them.<br />
 +
Press '' 'Add Details' '' to begin.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_11_6.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Fill in '' 'Name', '' enter access details into '' 'Username' '' and '' 'Password'. ''<br />
 +
You can also make your logging in easier by entering the website URL and website login URL consecutively into '' 'Website URL' '' and '' 'Login URL'. ''<br />
 +
To leave a note associated with access details you are creating, type it into '' 'Additional Notes' '' textbox. <br/>
 +
Move to the'' 'Sharing' '' part to continue.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_12.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|In this section choose '' 'Category' '' and select '' 'Administrators', 'Administrator Roles' '' and '' 'Clients' '' who should have access to this details.<br />
 +
''Note: There is [https://en.wikipedia.org/wiki/Logical_disjunction disjunction] relation between 'Administrators' and 'Administrator Roles'.''<br />
 +
''For example, if you assign administrators X and Z and administrator role Y in which administrator X is, then all administrators assigned to group Y will see these access details together with administrator Z.''<br/>
 +
Here, you may also allow clients to edit or delete these details, simple mark the'' 'Permissions' '' checkbox. '' 'Permissions' '' allows you to define clients/administrators/category members privileges.<br />
 +
''Note: If you leave the 'Clients' checkbox unmarked, your client will not see these access details even if they are chosen in 'Clients' option.''<br/>
 +
When ready, proceed to the'' 'Notifications' '' section.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_13.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Finally, you can set up notifications rules.<br />
 +
'' 'Allow To Change Password' '' - message is sent upon password being changed.<br />
 +
'' 'Change Password Reminder' '' - a notification is sent to remind about the necessity to change the password for security reasons.<br/>
 +
You can inject the passwords into each of them (depending on the selected email template).<br/><br/>
 +
Press the'' 'Confirm' '' button to finish the process and confirm the creation of access details.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_14.png]]
 +
|}
 +
===Access Details List===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|You can find your access details and those shared with you at '' 'Access Details List' '' tab.<br />
+
|style="padding: 10px 0px 20px 15px;"|On the list of access details you will see some basic info, such as ID and name, username and password with the possibility to view the password (press the hidden password to make it visible).<br/> Press the "Copy" icon and the password or username will be copied to the clipboard.<br/> There is also information on the access details owner and administrator groups allowed, list of clients allowed and category assigned.
−
As you can see, password visibility is bounded with color.<br />
+
−
Next to access details you can find information about its owner, shared admins and clients.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PM16.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_16.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You can also switch access details visibility with one click and manage them through '' 'Edit' '' and '' 'Delete' '' buttons.<br />
+
|style="padding: 0px 0px 15px 15px;"|Use action buttons to manage the entered access details.
−
If you entered website URL and URL to login page, you can easily jump to them.<br />
+
1. Log into your website (if URL has been provided) <br/>
−
You can jump to these places through pressing on access details name (jump to website URL) or '' 'Login Page' '' button (jump to login page).
+
2. See access details <br/>
 +
3. Edit access details <br/>
 +
4. Delete access details
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PM17.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_15.png]]
 +
|}
 +
 
 +
<!--
 +
==Contacts==
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|In '' 'Contacts' '', you can see and manage the permissions of clients' contacts/sub-accounts with regard to the access they shall have to the clients' passwords.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_33.png]]
 +
|}
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|If you want to change any permission, simply click the 'Edit' action.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_34.png]]
 +
|}
 +
-->
 +
 
 +
==Dashboard==
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|A short summary of the clients' and administrators' access details and categories is available on the dashboard.<br/>  The last tab in the addon is '' 'Documentation'. '' When pressed, it redirects you to this very site.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_16_1.png]]
 +
|}
 +
==[https://www.docs.modulesgarden.com/Translations_Tool Translations]==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Customizing language files is now extremely easy with the '' "Translations" '' tool that is now available directly in the addon.<br.> Its user-friendly design makes managing various language file tweaks a smooth and efficient process. <br/>
 +
Prepare translations for the original English files with this handy built-in tool. For specific instruction on how to use this tool please refer to its dedicated article, you will find it [https://www.docs.modulesgarden.com/Translations_Tool here].
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_16_0.png]]
 +
|}
 +
==Access Control==
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|'' 'Access Control' '' allows you to specify and control exactly which sections of the module can be accessed by your administrators. <br/>
 +
The way it works is that you create access control rules in which you decide if a specific admin, or admin role has full access, or is restricted to only specific sections.
 +
|}
 +
 
 +
===Rules===
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|Start with creating a new rule, click on the 'Create Rule' button and a dedicated form will appear. Below you will find a description of every field required in the form.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_16_0_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Fill out the following fields to create resources access rule:
 +
*'''Rule Name''' - Pick a name for your rule.
 +
*'''Grant Full Access''' - Enable to grant full access to all sections of the module to the specified personnel. Disable to specify in two additional fields below, to which resources access will be granted, and to which it will be denied.
 +
*'''Allow Access To''' - Designate the resources that the specified personnel will have access to.
 +
*'''Restrict Access To''' - Specify the resources that the specified personnel will not have access to.
 +
*'''Administrators''' - Specify which singular administrators will be subject to the new rule. If the specific administrator is already included in the group you have picked, you do not need to add him separately. <br/> '''''Note:''' All restrictions for specific administrators are summed with the restrictions on their role groups, across all rules.''
 +
*'''Administrator Roles''' - Specify which administrator role groups will be subject to the new rule.<br/>
 +
'''Important:''' When picking specific sections, keep in mind that allowing a parent section '''will also allow all of its children.''' <br/>
 +
For example by allowing 'Discounts' you allow 'Discounts → Create,' 'Discounts → Edit' and 'Discounts → Delete.'<br/>
 +
If you would like to give access to everything about discounts, but the ability to delete them, you can pick 'Discounts' in 'Allow Access To' and then 'Discounts → Delete' in 'Restrict Access To.'<br/> '''Restrict''' takes precedence over '''Allow,''' so if a specific section is included in both, it will be restricted.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_16_0_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|To edit or delete existing rules, use the icons to the right.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_16_0_3.png]]
 +
|}
 +
 
 +
===Resources===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Use the toggles in the 'Resources' section to specify which of them should be subject to logging, found in the 'Logs' section. <br/> Every time an administrator requests a toggled resource, it will be recorded.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_16_0_4.png]]
 +
|}
 +
 
 +
===Access Control Logs===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|The logs section includes:
 +
*Log ID
 +
*Name of the administrator
 +
*Requested resource
 +
*Applied Resource
 +
*Rule Name
 +
*Date
 +
Use the trash bin icons to delete specific logs, or utilize the mass action function to delete multiple logs at once.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_16_0_5.png]]
 +
|}
 +
 
 +
==Administrator Area Integration==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Our module integrates with your administrator area as well as the client area.<br />
 +
Passwords of any client can be viewed on the summary page as it is shown below, but only if you enable this option in '' 'Settings' '' section in the addon. <br/> You may add new passwords directly from this site, simply press '' 'Add New' '' and you will be moved to the '' 'New Access Details' '' form.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_17_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Your support operators are also able to access clients' passwords from within the ticket.<br />
 +
As you may have noticed, these places allow them not only to see passwords but also to create new ones.<br/>
 +
Note: this tab is available only if the dedicated option has been enabled in the addon.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_17_2.png]]
 
|}
 
|}
  
Line 213: Line 493:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Your clients can access client area password management page through '' 'Password Manager' '' button in navigation bar.<br />
 
|style="padding: 10px 0px 15px 15px;"|Your clients can access client area password management page through '' 'Password Manager' '' button in navigation bar.<br />
−
If you did not enter integration code, your clients have to add '' '/index.php?m=PasswordManager' '' to WHMCS URL in order to access '' 'Password Manager' ''.
+
To allow integration with the client area, a proper option must be enabled in '' 'Addon' → 'Settings' → 'Other'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PM18.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_18.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|At '' 'Password Manager' '', your clients can view access details shared with them.<br />
+
|style="padding: 0px 0px 15px 15px;"|In '' 'Password Manager', '' your clients can view access details depending on the settings configured by the administrator and the level of access allowed for the client.<br/> Underneath you can see a client's area with full access to any option given.<br/>
−
They can also go to access details login page (through pressing '' 'Login Page' '' button) or view a note assigned to access details.<br />
+
As you can see, there are four sections available: '' 'Owned Passwords', 'Shared Passwords', 'Products/Services Passwords' '' and '' 'Categories'.''
−
If you marked '' 'Display Products Access Details' '', your clients can also view access details to all of their active products.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PM19.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_19.png]]
 
|}
 
|}
 +
===Owned Passwords===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|If you enabled '' 'Manage Private Access Details' '' your clients can also create and share their own access details.<br />
+
|style="padding: 0px 0px 20px 15px;"|If you enabled '' 'Client Private Passwords' '' your clients will be allowed to view, manage and create their own access details.<br />
−
To create access details they need to press '' 'Add New Password' '' button as shown on the following screen.<br />
+
Please note that '' 'Shared' '' column with information on whether the details are allowed for administrators or not is available only if you select '' 'Shared Access' '' in the addon's settings.
−
Clients can manage their own access details through '' 'Edit' '' and '' 'Remove' '' buttons.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PM20.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_20.png]]
 
|}
 
|}
−
===Add Access Details===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Creating access details from the client area is simple.<br />
+
|style="padding: 0px 0px 15px 15px;"|Preview the password and use action buttons to manage the access details:
−
It starts from typing its name and entering access details into '' 'Username' '' and '' 'Password' ''.
+
1. Log into URL<br/>
 +
2. See the details<br/>
 +
3. Edit the details<br/>
 +
4. Remove the access details
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PM21.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_21.png]]
 
|}
 
|}
 +
====Add Access Details====
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Afterwards, you can type website URL and website login URL as well as leave a note.<br />
+
|style="padding: 10px 0px 20px 15px;"|To create access details, press '' 'Add New' '' button as shown on the following screen.<br />
−
If there is an admin group with '' 'Extended Permissions' '', your clients can make his access details visible for this admin group.<br />
+
−
It can be done through marking '' 'Visibility For Admins' '' checkbox.<br />
+
−
Setting up URLs, note and visibility for admins is optional.<br />
+
−
Clients confirm creation of access details through pressing '' 'Add New Password' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PM22.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_22.png]]
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Type the new password name and enter access details into '' 'Username' '' and '' 'Password'. ''You can also generate a random password.<br />
 +
Optionally, provide '' 'Website URL' '' and '' 'Login URL' '' to be allowed to log into your site directly from the'' 'Password Manager' '' page. <br/>
 +
Leave a note if you need it.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_23.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|You may now move to  '' 'Sharing' '' section. There, you can decide which category the new access details will be assigned to.<br/> Choose one from the dropdown menu or select '' 'Unassigned' '' to leave it without any category. Depending on the category you select, the access details will be available for those specified in its configuration.<br/>
 +
Additionally, define which actions can be made on shared passwords.<br/>
 +
Moreover, you can specify custom email addresses to share your credentials with other customers.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_24.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Finally, in '' ' Notifications' '' section, set up conditions of delivering password notifications. Enable this option if needed and define when the reminders should be sent.<br/> You can also define whether you wish to receive the new password in the message.<br/>
 +
Do not forget to press '' 'Save Changes' '' to finish.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_25.png]]
 +
|}
 +
====Addtional Actions====
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|If the administrator has enabled the '' 'Master Password' '' option in  '' [[#Client.27s_Private_Passwords|'Client's Private Passwords']] '', the clients will have the ability to set additional protection for their owned passwords.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_35.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Simply provide and confirm a new password that will protect the access to owned passwords.<br/>
 +
''Note - if you lose or forget this password, you will also lose access to your saved credentials in this section!''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_36.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|From now on, access to the '' 'Owned Passwords' '' section will require the master password.<br/>
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_37.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|You may change the password or disable this option at any time.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_37_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Among the additional actions you will also find a feature that allows you to export the passwords to a file. Press and the generated file will be saved on your disk.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_37_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|You may also import your private passwords. Press the button and find a ready file to upload the passwords to the group of '' 'Owned Passwords'. ''<br/>
 +
You may upload files in a CSV format only.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_37_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_37_4.png]]
 +
|}
 +
 +
===Shared Passwords===
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Under '' 'Shared Passwords' '' your clients can view and manage access details that administrators shared with them, gave permission to view.<br />
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_26.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Preview the password and use action buttons to manage the access details:
 +
1. Log into the URL if it has been provided<br/>
 +
2. See the details<br/>
 +
3. Edit the details ''(General/Sharing/Notifications)''<br/>
 +
4. Remove the details<br/>
 +
5. Copy the password/ username to the clipboard
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_27.png]]
 +
|}
 +
 +
===Product/Services Passwords===
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|'' 'Products/Services Passwords' '' section includes any access details to your client's products that they own.<br/>For convenience, clients can also assign additional passwords to selected services similarly like in '' 'Owned Passwords' ''section.<br/>
 +
Remember that as an administrator, you have to enable this option in the '' 'Addon' → 'Settings'→ 'Products/Services Passwords'. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_28.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Furthermore, you may export the passwords bundle into a file or, the other way round, import your passwords from a CSV file to the module.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_28_1.png]]
 +
|}
 +
 +
===Categories===
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|Move to '' 'Categories' '' tab. There is a list of the created by the client categories which are used to allocate passwords for sharing.<br/>
 +
To create a new one, press the'' 'Add Category' '' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_29.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Fill in category name and description and press '' 'Add'. ''<br />
 +
Created category can be seen by this client as well as administrators in the administrator area.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_30.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Clients may edit their categories, and delete and add new ones any time they wish.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_31.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Any categories created by clients will be automatically visible for administrators in the addon where you can manage them.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_32.png]]
 +
|}
 +
<!--
 +
===Contacts===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|If the clients have contacts/sub-accounts, their access can be restricted to the selected sections of Password Manager. <br/>
 +
To proceed, just select the contact and press Edit.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PM2_38.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|In the opened window, select which sections chosen contacts may have access to.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PM2_39.png]]
 +
|}
 +
-->
  
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Here are two tips for adding access details from the admin area.
+
|style="padding: 10px 0px 5px 15px;"|1. Any additional options under '' 'Addons' → 'Passwords Manager' → 'Settings' → 'Other' '' are by default enabled on the module activation.<br>
−
1. There is [http://en.wikipedia.org/wiki/Logical_disjunction disjunction] relation between 'Admins' and 'Admin Groups' options  .<br />
+
:If you change any of these settings you will lose access to some of the module's functionalities.  
−
For example, if you assign admins X and Z and admin group Y in which admin X is, then all admins assigned to group X will see these access details as well as admin Z.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PM23.png]]
+
|style="padding: 0px 0px 5px 15px;"|2. Password Manager For WHMCS ensures full protection of your access details using its own security tools and WHMCS internal two-way encryption system.
 +
:Note: the custom encryption key is stored in the'' 'configuration.php' '' file.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|2. There are two [http://en.wikipedia.org/wiki/Logical_conjunction conjunction] relations while setting access details sharing.<br />
+
|style="padding: 0px 0px 10px 15px;"|3. As this module supports a templates system, any changes made in the module's templates files will be saved after the upgrade process.
−
First one is between '' 'Admins' '' and '' 'Admin Group' ''(with are bounded with disjunction relation) and  '' 'Admins' '' at '' 'Visibility' ''.<br />
+
−
Second one is between '' 'Clients' '' and '' 'Clients' '' at '' 'Visibility' ''.<br />
+
−
First relation is marked with blue, second one is marked with orange on the screen shown below.<br />
+
−
For example, if you assign admins X and Z and admin group Y in which admin X is, but leave '' 'Admins' '' at '' 'Visibility' '' unmarked, then no admin will see these access details.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PM24.png]]
+
|style="padding: 0px 0px 30px 15px;"|4. Password Manager For WHMCS module is a perfect solution for all resellers whose aim is to provide license keys to their clients in the most secure way possible.
 +
|}
 +
 
 +
=Update Instructions=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/>
 +
Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.<br/> Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.
 +
|}
 +
=Upgrade Guide=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.<br/>
 +
 
 +
Opt for the [https://www.modulesgarden.com/products/whmcs/password-manager#open-source-version Open Source version] of your Password Manager For WHMCS module to unlock these benefits.<br/> Simply click on either the '''Get Source Code''' or '''Upgrade To Lifetime''' button found on the product's page in our client area to complete the one-step upgrade process, with a '''dedicated discount''' already applied.<br/>
 +
 
 +
Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module comprehensive guide] covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.
 
|}
 
|}
  
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|1. When you have problems with connection, check whether your SELinux or firewall is not blocking ports.
+
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 
|}
 
|}

Latest revision as of 13:57, 26 April 2024

Contents

[edit] About Password Manager For WHMCS

Password Manager For WHMCS gives you the possibility to store fragile data and share them safely with your staff and clients.

The module offers various mechanisms allowing you to smoothly manage sensitive data such as passwords or license keys, in the case of resellers, send email reminders or integrate with your WHMCS client area.
Owing to the implementation of advanced two-way encryption, Password Manager For WHMCS provides a high-security level for your and your customers' critical data.

  • Admin Area Features:
✔ Create Private Access Details
✔ Share Access Details With Clients & Administrators
✔ Display Clients Access Details In Clients Summary And Clients Tickets
✔ Define Access To Clients Passwords:
✔ Full Access - Any Administrator Can View Any Password
✔ Restricted Access - Allowed Administrators Can View Any Password
✔ Shared Access - Allowed Administrators Can View Shared Passwords
✔ Store All Access Details In Encrypted Format
✔ Add Notes To Password
✔ Copy Usernames And Passwords Into Clipboard
✔ Set Direct Links To Website Or Login Page With Password Used
✔ Display Password Owner
✔ Toggle Availability Of Private Passwords And Product Passwords For Clients
✔ Forbid Password Management For Chosen Clients/Client Groups
✔ Exclude Products/Product Groups From Being Displayed
✔ Allow Clients To Set Master Password For Owned Passwords
✔ Define Client Passwords Limit Per User
✔ Adjust Length And Characters For Random Password Generation
✔ Notify Upon Password Change
✔ Send Password Change Reminder
✔ Define Email Templates For Reminder And Notification
✔ Define Time Period For Password Change Reminder
✔ Customize Module Language Files With "Translations" Tool
✔ Control Staff Access Level To Specific Resources
  • Client Area Features:
✔ Display And Manage Access Details
✔ Display And Add Additional Access Details Of Owned Services
✔ Generate Random Passwords
✔ Copy Usernames And Passwords Into Clipboard
✔ Import And Export Access Details In CSV Format
✔ Share Access Details With Administrators And Clients
✔ Create Shared Categories
✔ Assign Categories To Access Details
✔ Restrict Access To Owned Passwords Using Master Password
  • General Info:
✔ High-Level Security With Advanced Two-Way Encryption
✔ Multi-Language Support With Custom Translations Tool
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS Themes "Six", "Twenty-One", "Lara" And "Lagom WHMCS Client Theme"
✔ Supports WHMCS V8.10 Back To WHMCS V8.6
✔ Requires ionCube Loader V12 Or Later
✔ Easy Module Upgrade To Open Source Version

[edit] Installation

This tutorial will show you how to successfully install Password Manager For WHMCS.

We will guide you step by step through the whole installation and configuration process.

1. Log in to our client area and download the module.
PM1.png
2. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

Ftyrtr.png
3. When you install Password Manager For WHMCS for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/addons/PasswordManager/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

PM3.png
4. In order to configure your license key, you have to edit a previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.

PM4.png
5. Now, set up the 'storage' folder as recursively writable.

This folder is available at '/yourWHMCS/modules/addons/PasswordManager/'.

PM 4 1.png
6. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS administrator area. Go to 'System Settings' → 'Addon Modules'.
Afterwards, find 'Password Manager' and press 'Activate' button.

PM5.png
7. In the next step, you need to permit access to the module.

To do so, click on the 'Configure' button, select administrator groups that should have access to this addon, and press 'Save Changes'.

PM6.png
8. You have just successfully installed Password Manager For WHMCS!

You can access your module under 'Addons' → 'Password Manager'.

PM2 7.png

[edit] Configuration and Management

Password Manager For WHMCS allows to safely store and share fragile data within your WHMCS.

In this short guide, we will present you all the possibilities of our module.

[edit] Configuration

Before you start your work with our Password Manager For WHMCS, please move to 'Settings' tab, where you will configure access restrictions to product passwords, define email notifications and manage security settings.

[edit] Products/Services Password

First of all, decide whether you wish to allow to display a full list of the client's products and services' login details by selecting the option: 'Client Products/Services Password'.
If enabled, access details to client's products and services will be displayed in the client area → 'Password Manager'.

'Exclude Client Groups' - enter any client group name to disable the product's access details from being displayed for clients in these groups.
'Exclude Clients' - disable product access details for pointed here clients.
'Exclude Product Groups' - enter any product group names, to which access details will not be shown.
'Exclude Products' - access details for products, which are entered here, will be disabled.

PM2 10.png

[edit] Client's Private Passwords

The next section is dedicated to the management of private passwords of clients.
If you wish to allow your clients to manage their personal access details, select the 'Client's Private Passwords' option.
Your clients can be also permitted to set their own 'Master Password' to provide additional protection for their stored passwords. Next, move to the specific configuration:

1. 'Exclude Client Groups' - disable private access details management for selected here client groups.
2. 'Exclude Client' - disable management of private access details for pointed here clients.
3. 'Passwords Limit Per User' - set up the limit of private access details for one client.
4. 'Exclude Client From Limit' - enter clients for which the set up above limit will not be effective.

PM2 11.png

[edit] Email Notifications

This section allows you to define email notification templates that will be sent by the module on specific actions to clients and administrators.

1. 'Password Change Reminder' - select an email template that will be used to remind clients or administrators about the need to change the password.
2. 'Password Change Notification' - select an email template that will be used to notify clients and about a password being changed.
Please note that you have to select templates for clients and administrators separately. If you want to disable any of the notifications, simply select 'Unassign' from dropdown menu.

PM2 11 1.png

[edit] Security Settings

Under the 'Security Settings' tab, you have to define the level of access to clients' passwords for administrators and grant them extended permissions.

You may grant your administrators:

  • Full access to clients' passwords - any administrator will be allowed to view clients' passwords
  • Restricted access - only administrators with chosen roles will get access to the passwords
  • Shared access - only passwords marked as 'Shared' will be visible for chosen administrator roles.

You may also select here administrators group which will be granted 'Extended Permissions'.
It means that administrators from this group will be allowed to view clients' access details when 'Visibility For Administrators:' is checked.

PM2 11 2.png

[edit] Other

In the very last section you may manage additional options that 'Password Manager For WHMCS ' has to offer.
  • Password Manager Button - select to enable access to 'Password Manager' for your clients in their client area.
  • Profile Tab - select this option to add 'Passwords' tab in the client's profile in the administrator area.
  • Support Tickets Tab - if you select this option, Passwords' tab will be available on the support tickets site.
  • Password Random Characters - define a set of characters to be used for random password generation.
  • Password Strength - define the length of randomly generated passwords.
  • Hide Guide - toggle to turn on the option to hide the guide shown at 'Dashboard'.


Do not forget to save the changes when you finish the settings configuration.

PM2 11 21.png

[edit] Categories

Categories allow you to prepare predefined sets of clients and administrators.

By assigning a category to a password, clients and administrators from that category are granted permission to view this password.
Move to 'Categories' → 'Administrator Categories' where you can add new sets, press 'Add Category' to begin.

PM2 11 3.png
Now, fill out the form with the category name and description.

Assign desired clients and administrators to the category and press 'Confirm'.

PM2 11 4.png
The list of administrator categories with any details such as listed clients and administrators allowed to access the details is now visible.
You may always edit the category or delete it if needed. Use the action buttons to do so.
PM2 11 5.png

[edit] Access Details

'Access Details' section includes a list of provided access details. Here you can create new access details and decide who can view them.

Press 'Add Details' to begin.

PM2 11 6.png
Fill in 'Name', enter access details into 'Username' and 'Password'.

You can also make your logging in easier by entering the website URL and website login URL consecutively into 'Website URL' and 'Login URL'.
To leave a note associated with access details you are creating, type it into 'Additional Notes' textbox.
Move to the 'Sharing' part to continue.

PM2 12.png
In this section choose 'Category' and select 'Administrators', 'Administrator Roles' and 'Clients' who should have access to this details.

Note: There is disjunction relation between 'Administrators' and 'Administrator Roles'.
For example, if you assign administrators X and Z and administrator role Y in which administrator X is, then all administrators assigned to group Y will see these access details together with administrator Z.
Here, you may also allow clients to edit or delete these details, simple mark the 'Permissions' checkbox. 'Permissions' allows you to define clients/administrators/category members privileges.
Note: If you leave the 'Clients' checkbox unmarked, your client will not see these access details even if they are chosen in 'Clients' option.
When ready, proceed to the 'Notifications' section.

PM2 13.png
Finally, you can set up notifications rules.

'Allow To Change Password' - message is sent upon password being changed.
'Change Password Reminder' - a notification is sent to remind about the necessity to change the password for security reasons.
You can inject the passwords into each of them (depending on the selected email template).

Press the 'Confirm' button to finish the process and confirm the creation of access details.

PM2 14.png

[edit] Access Details List

On the list of access details you will see some basic info, such as ID and name, username and password with the possibility to view the password (press the hidden password to make it visible).
Press the "Copy" icon and the password or username will be copied to the clipboard.
There is also information on the access details owner and administrator groups allowed, list of clients allowed and category assigned.
PM2 16.png
Use action buttons to manage the entered access details.

1. Log into your website (if URL has been provided)
2. See access details
3. Edit access details
4. Delete access details

PM2 15.png


[edit] Dashboard

A short summary of the clients' and administrators' access details and categories is available on the dashboard.
The last tab in the addon is 'Documentation'. When pressed, it redirects you to this very site.
PM2 16 1.png

[edit] Translations

Customizing language files is now extremely easy with the "Translations" tool that is now available directly in the addon.
Its user-friendly design makes managing various language file tweaks a smooth and efficient process.

Prepare translations for the original English files with this handy built-in tool. For specific instruction on how to use this tool please refer to its dedicated article, you will find it here.

PM2 16 0.png

[edit] Access Control

'Access Control' allows you to specify and control exactly which sections of the module can be accessed by your administrators.

The way it works is that you create access control rules in which you decide if a specific admin, or admin role has full access, or is restricted to only specific sections.

[edit] Rules

Start with creating a new rule, click on the 'Create Rule' button and a dedicated form will appear. Below you will find a description of every field required in the form.
PM2 16 0 1.png
Fill out the following fields to create resources access rule:
  • Rule Name - Pick a name for your rule.
  • Grant Full Access - Enable to grant full access to all sections of the module to the specified personnel. Disable to specify in two additional fields below, to which resources access will be granted, and to which it will be denied.
  • Allow Access To - Designate the resources that the specified personnel will have access to.
  • Restrict Access To - Specify the resources that the specified personnel will not have access to.
  • Administrators - Specify which singular administrators will be subject to the new rule. If the specific administrator is already included in the group you have picked, you do not need to add him separately.
    Note: All restrictions for specific administrators are summed with the restrictions on their role groups, across all rules.
  • Administrator Roles - Specify which administrator role groups will be subject to the new rule.

Important: When picking specific sections, keep in mind that allowing a parent section will also allow all of its children.
For example by allowing 'Discounts' you allow 'Discounts → Create,' 'Discounts → Edit' and 'Discounts → Delete.'
If you would like to give access to everything about discounts, but the ability to delete them, you can pick 'Discounts' in 'Allow Access To' and then 'Discounts → Delete' in 'Restrict Access To.'
Restrict takes precedence over Allow, so if a specific section is included in both, it will be restricted.

PM2 16 0 2.png
To edit or delete existing rules, use the icons to the right.
PM2 16 0 3.png

[edit] Resources

Use the toggles in the 'Resources' section to specify which of them should be subject to logging, found in the 'Logs' section.
Every time an administrator requests a toggled resource, it will be recorded.
PM2 16 0 4.png

[edit] Access Control Logs

The logs section includes:
  • Log ID
  • Name of the administrator
  • Requested resource
  • Applied Resource
  • Rule Name
  • Date

Use the trash bin icons to delete specific logs, or utilize the mass action function to delete multiple logs at once.

PM2 16 0 5.png

[edit] Administrator Area Integration

Our module integrates with your administrator area as well as the client area.

Passwords of any client can be viewed on the summary page as it is shown below, but only if you enable this option in 'Settings' section in the addon.
You may add new passwords directly from this site, simply press 'Add New' and you will be moved to the 'New Access Details' form.

PM2 17 1.png
Your support operators are also able to access clients' passwords from within the ticket.

As you may have noticed, these places allow them not only to see passwords but also to create new ones.
Note: this tab is available only if the dedicated option has been enabled in the addon.

PM2 17 2.png

[edit] Client Area

Your clients can access client area password management page through 'Password Manager' button in navigation bar.

To allow integration with the client area, a proper option must be enabled in 'Addon' → 'Settings' → 'Other'.

PM2 18.png
In 'Password Manager', your clients can view access details depending on the settings configured by the administrator and the level of access allowed for the client.
Underneath you can see a client's area with full access to any option given.

As you can see, there are four sections available: 'Owned Passwords', 'Shared Passwords', 'Products/Services Passwords' and 'Categories'.

PM2 19.png

[edit] Owned Passwords

If you enabled 'Client Private Passwords' your clients will be allowed to view, manage and create their own access details.

Please note that 'Shared' column with information on whether the details are allowed for administrators or not is available only if you select 'Shared Access' in the addon's settings.

PM2 20.png
Preview the password and use action buttons to manage the access details:

1. Log into URL
2. See the details
3. Edit the details
4. Remove the access details

PM2 21.png

[edit] Add Access Details

To create access details, press 'Add New' button as shown on the following screen.
PM2 22.png
Type the new password name and enter access details into 'Username' and 'Password'. You can also generate a random password.

Optionally, provide 'Website URL' and 'Login URL' to be allowed to log into your site directly from the 'Password Manager' page.
Leave a note if you need it.

PM2 23.png
You may now move to 'Sharing' section. There, you can decide which category the new access details will be assigned to.
Choose one from the dropdown menu or select 'Unassigned' to leave it without any category. Depending on the category you select, the access details will be available for those specified in its configuration.

Additionally, define which actions can be made on shared passwords.
Moreover, you can specify custom email addresses to share your credentials with other customers.

PM2 24.png
Finally, in ' Notifications' section, set up conditions of delivering password notifications. Enable this option if needed and define when the reminders should be sent.
You can also define whether you wish to receive the new password in the message.

Do not forget to press 'Save Changes' to finish.

PM2 25.png

[edit] Addtional Actions

If the administrator has enabled the 'Master Password' option in 'Client's Private Passwords' , the clients will have the ability to set additional protection for their owned passwords.
PM2 35.png
Simply provide and confirm a new password that will protect the access to owned passwords.

Note - if you lose or forget this password, you will also lose access to your saved credentials in this section!

PM2 36.png
From now on, access to the 'Owned Passwords' section will require the master password.
PM2 37.png
You may change the password or disable this option at any time.
PM2 37 1.png
Among the additional actions you will also find a feature that allows you to export the passwords to a file. Press and the generated file will be saved on your disk.
PM2 37 2.png
You may also import your private passwords. Press the button and find a ready file to upload the passwords to the group of 'Owned Passwords'.

You may upload files in a CSV format only.

PM2 37 3.png
PM2 37 4.png

[edit] Shared Passwords

Under 'Shared Passwords' your clients can view and manage access details that administrators shared with them, gave permission to view.
PM2 26.png
Preview the password and use action buttons to manage the access details:

1. Log into the URL if it has been provided
2. See the details
3. Edit the details (General/Sharing/Notifications)
4. Remove the details
5. Copy the password/ username to the clipboard

PM2 27.png

[edit] Product/Services Passwords

'Products/Services Passwords' section includes any access details to your client's products that they own.
For convenience, clients can also assign additional passwords to selected services similarly like in 'Owned Passwords' section.

Remember that as an administrator, you have to enable this option in the 'Addon' → 'Settings'→ 'Products/Services Passwords'.

PM2 28.png
Furthermore, you may export the passwords bundle into a file or, the other way round, import your passwords from a CSV file to the module.
PM2 28 1.png

[edit] Categories

Move to 'Categories' tab. There is a list of the created by the client categories which are used to allocate passwords for sharing.

To create a new one, press the 'Add Category' button.

PM2 29.png
Fill in category name and description and press 'Add'.

Created category can be seen by this client as well as administrators in the administrator area.

PM2 30.png
Clients may edit their categories, and delete and add new ones any time they wish.
PM2 31.png
Any categories created by clients will be automatically visible for administrators in the addon where you can manage them.
PM2 32.png

[edit] Tips

1. Any additional options under 'Addons' → 'Passwords Manager' → 'Settings' → 'Other' are by default enabled on the module activation.
If you change any of these settings you will lose access to some of the module's functionalities.
2. Password Manager For WHMCS ensures full protection of your access details using its own security tools and WHMCS internal two-way encryption system.
Note: the custom encryption key is stored in the 'configuration.php' file.
3. As this module supports a templates system, any changes made in the module's templates files will be saved after the upgrade process.
4. Password Manager For WHMCS module is a perfect solution for all resellers whose aim is to provide license keys to their clients in the most secure way possible.

[edit] Update Instructions

An essential guidance through the process of updating the module is offered here.

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

[edit] Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?
There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.

Opt for the Open Source version of your Password Manager For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

[edit] Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Password_Manager_For_WHMCS&oldid=66724"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Password Manager For WHMCS