Personal tools
Namespaces

Variants
Actions

Password Manager For WHMCS

From ModulesGarden Wiki
Revision as of 19:24, 11 February 2015 by Gregor (Talk | contribs)

Jump to: navigation, search

Contents

About Password Manager For WHMCS

Article update is ongoing on this page, watch out for broken links and unclear descriptions!
We are sorry for the inconvenience caused.

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

Module offers various mechanisms allowing you to conveniently manage passwords, access to them as well as integrate with your WHMCS client area.
By using advanced two-way encryption mechanisms Password Manager For WHMCS provides an appropriately high level of security for your valuable data.

  • Admin Area Features:
✔ Share Access Details With Clients
✔ Share Access Details With Administrators
✔ Share Access Details With Administrators Depending On Their Admin Roles
✔ Define Access Details As Private
✔ Display Clients Access Details In Clients Summary And Clients Tickets
✔ Store All Access Details In Encrypted Format
✔ Adjust Visibility Of Password For Clients/Administrators/Category Members - One Click Only
✔ Extended Permissions For Administrators Allow Access To All Non-Private Passwords
✔ Add Notes To Password
✔ Colorized Display Of Access Details In Admin Area
✔ Links To Website Or Log In Page With Password Used
✔ Password Owner Displayed
✔ Notify Upon Password Change
✔ Send Password Change Reminder
✔ Define Email Templates For Reminder And Notification
✔ Define Time Period For Password Change Reminder
  • Client Area Features:
✔ Display And Manage Access Details
✔ Display Access Details Of Owned Services
✔ Create Category
✔ Assign Categories To Access Details
  • General Info:
✔ High Level Security With Advanced Two Way Encryption
✔ Multi-Language Support
✔ Supports WHMCS V5 and Later

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 your client area and download Password Manager For WHMCS.
PM1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like this.

PM2.png
3. When you install Password Manager 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 your client area → 'My Products' .

PM4.png
5. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'Setup' 'Addon Modules' .
Afterwards, find 'Password Manager' and press 'Activate' button.

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

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

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

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

PM7.png

Configuration and Management

Password Manager For WHMCS allows to share passwords in your WHMCS.

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

Integration Code

Integration described below is not obligatory.

Module allows your customers to view passwords shared to them and manage their own passwords.
We implemented easy integration which will add button leading to password management in the client area.
You can find integration code under 'Addons' 'Password Manager' 'Integration Code' .

PM8.png
In the client area you will find button marked on the following screen.
PM9.png

Configuration

'Configuration' tab allows you to define if your clients can see their products access details while excluding specific products, clients or client groups.

You can also decide, if your clients can manage their private access details while excluding right for selected clients or client groups.
Additionally, you are able to set limits to number of access details created by your clients.

Products Access Details

1. 'Display Products Access Details' - If enabled, access details to clients products and services will be displayed in the client area → 'Password Manager' .

2. 'Exclude Client Groups' - Disable display of products access details for client groups which IDs are entered in 'Exclude Client Groups' field.
3. 'Exclude Products' - Disable display of access details for products which IDs are entered.
4. 'Exclude Clients' - Disable product access details for selected clients.

PM10.png

Private Access Details

1. 'Manage Private Access Details' - Allows to manage private passwords by clients.

2. 'Exclude Client Groups' - Disable private access details management for selected client groups.
3. 'Exclude Client' - Disable management of private access details for typed clients.
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'.
5. 'Exclude Client From Limit' - Disable access details limit for selected clients.
6. 'Extended Permissions' - Allows to view clients access details when 'Visibility For Admins:' is checked.

PM11.png

Email Notifications

This section allows you to define templates sent by the module.
  1. . 'Password Change Reminder For Client' - Email template used to remind clients about changing the password.
  2. . 'Password Change Notification For Client' - Email template used to notify clients about password being changed.
  3. . 'Password Change Reminder For Admin' - Email template used to remind admins about changing the password.
  4. . 'Password Change Notification For Admin' - Email template used to notify admins about password being changed.
PM11 1.png

Category

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

Through assigning a category to a password, clients and administrators from that category are granted with permission to view the password.
Let us create a new category, press 'Add Category' .

PM11 2.png
Now, fill out the form with category name and description.

Assign desired clients and admins to the category and press 'Add' .
Your category is ready to be assigned to passwords.

PM11 3.png

Add Access Details

'Add Access Details' tab allows you to create new access details and decide who can view them.

Fill in 'Name' , enter access details into 'Username' and 'Password' .
Additionally, you can assign password to a category, this way administrators and clients assigned to category are granted with access to the password.
Note: Assigning password with category is optional.

PM12.png
Afterwards, select 'Admins' , 'Admin Groups' and 'Clients' who should have access to this details (Ctrl + click to mark more than one entry).

Note: There is disjunction relation between 'Admins' and 'Admin Groups'.
For example, if you assign admins X and Z and admin group Y in which admin X is, then all admins assigned to group Y will see these access details together with admin Z.

PM13.png
You can also make your logging in easier through entering website URL and website log in URL consecutively into 'Website URL' and 'Log In URL' .

To leave a note associated with access details you are creating, type it into 'Note' textbox.

PM14.png
'Permissions' allows you to define clients/admins/category members privileges.

Press 'Save Changes' button to confirm creation of access details.
Note: If you leave 'Clients' checkbox unmarked, your client will not see these access details even if they are chosen in 'Clients' option.

PM15.png
On the bottom of the form you can set up messages.

One is send upon password being changed while another is a reminder about password changing for security reasons.
You can inject passwords into each of them through marking adequate checkboxes.

PM15 1.png

Access Details List

You can find your access details and those shared with you in 'Access Details List' tab.

As you can see, password visibility is bounded by color.
Next to access details you can find information about their owner, shared admins, clients and category members.

PM16.png
You can also switch access details visibility with one click and manage them through 'Edit' and 'Delete' buttons.

If you entered website URL and URL to login page, you can easily jump to them.
You can jump to these places through pressing access details name (jump to website URL) or 'Log In Page' button (jump to login page).

PM17.png

Admin Area Integration

Our module integrates with your admin area as well as client area.

Passwords of any client can be viewed in summary page as show below.

PM17 1.png
Your support operators are also able to access clients passwords from within ticket.

As you may have noticed, these places allow them not only to see passwords, but also create new ones.

PM17 2.png

Client Area

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

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' .

PM18.png
In 'Password Manager' , your clients can view access details shared with them.

They can also go to access details login page (through pressing 'Login Page' button) or view a note assigned to access details.
If you marked 'Display Products Access Details' , your clients can also view access details to all of their active products.

PM19.png
If you enabled 'Manage Private Access Details' your clients can also create and share their own access details.

To create access details they need to press 'Add New Password' button as shown on the following screen.
Clients can manage their own access details through 'Edit' and 'Remove' buttons.

PM20.png

Add Category

You can access category list through pressing 'Categories' button.
PM20 1.png
As you can see on the following screen, this is the place to view all categories to which client is assigned.

Additionally, here your client can add new category, press 'Add Category' to do so.

PM20 2.png
Fill in category name and description and press 'Add' .

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

PM20 3.png

Add Access Details

Creating access details from the client area is simple.

It starts from typing its name and entering access details into 'Username' and 'Password' .
Optionally, client can assign password to any category he/she has created or is assigned to.

PM21.png
Afterwards, you can type website URL and website login URL as well as leave a note.

If there is an admin group with 'Extended Permissions' , your clients can make their access details visible for this admin group.
It can be done through marking 'Visibility For Admins' checkbox.
Setting up URLs, note and visibility for admins is optional.
Clients confirm creation of access details through pressing 'Add New Password' button.

PM22.png

Tips

Here are two tips for adding access details from the admin area.

1. There is disjunction relation between 'Admins' and 'Admin Groups' options .
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.

PM23.png
2. There are two conjunction relations while setting access details sharing.

The first one is between 'Admins' and 'Admin Group' (which are bounded by disjunction relation) and 'Admins View' in 'Permissions' .
The second one is between 'Clients' and 'Clients View' in 'Permissions' .
The first relation is marked with blue, the second one is marked with orange on the screen shown below.
For example, if you assign admins X and Z and admin group Y in which admin X is, but leave 'Admins View' in 'Permissions' unmarked, then no admin will see these access details.

PM24.png

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Password Manager For WHMCS