Personal tools
Namespaces

Variants
Actions

Password Manager For WHMCS

From ModulesGarden Wiki
Revision as of 15:16, 16 March 2016 by Karolina (Talk | contribs)

Jump to: navigation, search


Contents

About Password Manager For WHMCS

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

The module offers various mechanisms allowing you to conveniently manage passwords, send email reminders, as well as integrate with your WHMCS client area.
Owing to implementation of advanced two way encryption, Password Manager For WHMCS provides a high security level for your and your customers' valuable 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 Access Details:
✔ 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
✔ 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
✔ Define Client Passwords Limit Per User
✔ 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
✔ Share Access Details With Administration
✔ Create Category
✔ Assign Categories To Access Details
  • General Info:
✔ High Level Security With Advanced Two Way Encryption
✔ Multi-Language Support
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V5 and V6

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

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

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

Configuration

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

Client Product Password

First of all, decide whether you wish to allow to display a full list of client's products and services login details by selecting option: 'Client Product 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 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

Client 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 them select 'Client Private Passwords' option and then move to 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

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 admins 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 must select templates for clients and admins separately. If you want to disable any of the notification, simply select 'Unassign' from dropdown menu.

PM2 11 1.png

Security Settings

Under '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 admins:

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

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

PM2 11 2.png

Other

In the very last section you may manage additional options that 'Password Manager For WHMCS ' has to offer.

1. Select to enable access to 'Password Manager' for your clients in their client area
2. Select this option to add 'Passwords' tab in the client's profile in admin area
3. If you select this option, Passwords' tab will be available on the supports tickets site.

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

PM2 11 21.png

Categories

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.
Move to 'Categories' → 'Admin Categories' where you van add new sets, press 'Add Category' to begin.

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

Assign desired clients and admins to the category and press 'Add'.

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

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 New' to begin.

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

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.
Move to 'Sharing' part to continue.

PM2 12.png
In this section choose 'Category' and select 'Admins', 'Admin Groups' and 'Clients' who should have access to this details.

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

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

'Send Password Change Notification' - message is sent upon password being changed.
'Password Reminder' - a notification is sent to remind about the necessity to change the password for security reasons.
You can inject passwords into each of them through marking adequate checkboxes.

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

PM2 14.png

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.
PM2 16.png
There is also information on the access details owner and admin groups allowed, number of clients allowed and category assigned
(press the category to see who exactly is in it). Finally you, check set up edit permissions.
PM2 17.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

Dashboard

On 'Dashboard' there is available a short summary on the Clients' and Administrators' access details and categories.
PM2 16 1.png
The last tab in the addon 'Documentation', when pressed, redirect you to this very site.
PM2 16 2.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 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 ticket.

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

PM2 17 2.png

Client Area

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

To allow integration with 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 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', 'Product Passwords' and 'Categories'.

PM2 19.png

Owned Passwords

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

Pleas note that 'Shared' column with information on whether the details are allowed for admins 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

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

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

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 dropdown menu or select 'Unassign' to leave it without any category. Depending on the category you select,
the access details will be available for those specified in its configuration.
PM2 24.png
Finally, in ' Notifications' section, set up conditions of delivering password notifications. Enable this option if you need it 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 'Add' to finish.

PM2 25.png

Shared Passwords

Under 'Shared Passwords' your clients can view and manage access details that admins 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 URL if it has been provided
2. See the details
3. Edit the details (General/Sharing/Notifications)

PM2 27.png

Product Passwords

'Product Passwords' section includes any access details on your client's products that they own.
Remember that as administration you must enable this option in the 'Addon' → 'Settings'→ 'Client Product Password'.
PM2 28.png

Categories

Move to 'Categories' tab. There is a list of created by the client categories.

To create a new one, press '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 admin area.

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

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 loose access to some of the module's functionalities.

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