Difference between revisions of "Admin Area"
(→Search) |
|||
| Line 1: | Line 1: | ||
| − | == | + | ==Logging In== |
| − | To login to the admin area, | + | To login to the WHMCS admin area, navigate to the admin directory within your installation. |
| − | + | For example if you installed WHMCS @ https://billing.example.com/ then you would access the admin area by visiting https://billing.example.com/admin/ | |
| − | + | If you have followed the [[Further Security Steps]] and renamed your admin directory, you will need to use the custom name you have setup. | |
| − | == | + | ===IP Banning=== |
| − | + | If multiple failed login attempts are detected from the same IP, an IP ban will be enforced. | |
| − | If you fail to receive the email, or have disabled the | + | If you get banned, you can wait either wait for the ban to expire or manually remove the ban via the database. By default the ban lasts for 15 minutes. You can adjust the length of time the ban is enforced for in '''General Settings > Security'''. For more information on manually removing a banned IP, please refer to our [[FAQs]]. |
| + | |||
| + | ===Password Resets=== | ||
| + | |||
| + | If a password is lost or forgotten, you can request a password reset from the login page. | ||
| + | |||
| + | Upon requesting a password reset, you will receive an email containing a link that will allow you to set a new password. | ||
| + | |||
| + | If you fail to receive the email, or have disabled the forgotten password option, instructions for resetting the admin password can be found in our [[FAQs]]. | ||
==Templates== | ==Templates== | ||
| − | The admin area comes with 2 templates: | + | The admin area comes with 2 templates as standard: |
| + | |||
| + | *'''Blend''' - The current default template featuring a responsive design and compatible with laptops, tablets and mobile devices. | ||
| + | *'''V4''' - A web 2.0 styled interface that was the default until Version 5.0. | ||
| + | |||
| + | You can customise and create your own custom admin area templates. Please refer to [[Admin Area Template Files]] for more information. | ||
| + | |||
| + | ===Choosing your admin template=== | ||
| − | + | Each administrator user has their own preference that controls the admin area theme/template they see and use. | |
| − | |||
| − | + | To see and customise the template that you use for your own admin user, simply navigate to '''My Account''' using the top navigation bar. | |
| − | + | To see and change the template used by other administrator users, if you have permission, navigate to '''Setup > Staff Management > Administrator Users''' | |
==Search== | ==Search== | ||
| − | + | There are 2 primary methods of search - '''Intelligent Search''' & '''Advanced Search'''. Both of these search options are available from any page. | |
| − | '''Intelligent Search''' is located at the top right of | + | * '''Intelligent Search''' is located at the top right of every page. To use it, enter a search term and hit enter. Results are dynamically fetched and displayed instantly. Intelligent search makes a best guess attempt at what you are searching for and will display the most relevant matches it is able to find. |
| − | '''Advanced Search''' | + | '''Advanced Search''' is located in the bottom left of the sidebar on every page. With advanced search, you can choose exactly what entity type and field you wish to perform a search for. Entering a search term here and submitting will take you to the exact match or list of possible matches. |
==Widgets== | ==Widgets== | ||
| − | The admin | + | The admin homepage dashboard is made up of a number of individual 'widgets'. These widgets can be arranged and maximised/minimized by each individual member of staff and enabled/disabled entirely for different administrator roles. |
Further Reading: | Further Reading: | ||
| Line 39: | Line 53: | ||
*[[Creating_a_Widget]] | *[[Creating_a_Widget]] | ||
| − | == | + | ==Languages== |
| − | WHMCS | + | The WHMCS admin area has full multi-language support. |
| − | + | Each administrator user can set their own language preference via the '''My Account''' page accessed from the top navigation bar. | |
| − | + | Language files for the admin area can be found in the '''/admin/lang/''' directory. | |
| − | + | If you wish to customise the translations for a given language, an overrides file should be created. You can learn more about overrides and how to use them in our [https://developers.whmcs.com/languages/overrides/ Developer Documentation]. | |
| − | |||
| − | We rely on the | + | <div class="docs-alert-warning">We rely on the contributions of our users for language translations. If you notice any discrepancies or phrasings that you feel could be imported, we welcome you to submit your suggestions for change to our support team. We thank you for your help to ensure our users have the best experience possible, whatever their language.</div> |
Revision as of 14:56, 21 December 2017
Contents
Logging In
To login to the WHMCS admin area, navigate to the admin directory within your installation.
For example if you installed WHMCS @ https://billing.example.com/ then you would access the admin area by visiting https://billing.example.com/admin/
If you have followed the Further Security Steps and renamed your admin directory, you will need to use the custom name you have setup.
IP Banning
If multiple failed login attempts are detected from the same IP, an IP ban will be enforced.
If you get banned, you can wait either wait for the ban to expire or manually remove the ban via the database. By default the ban lasts for 15 minutes. You can adjust the length of time the ban is enforced for in General Settings > Security. For more information on manually removing a banned IP, please refer to our FAQs.
Password Resets
If a password is lost or forgotten, you can request a password reset from the login page.
Upon requesting a password reset, you will receive an email containing a link that will allow you to set a new password.
If you fail to receive the email, or have disabled the forgotten password option, instructions for resetting the admin password can be found in our FAQs.
Templates
The admin area comes with 2 templates as standard:
- Blend - The current default template featuring a responsive design and compatible with laptops, tablets and mobile devices.
- V4 - A web 2.0 styled interface that was the default until Version 5.0.
You can customise and create your own custom admin area templates. Please refer to Admin Area Template Files for more information.
Choosing your admin template
Each administrator user has their own preference that controls the admin area theme/template they see and use.
To see and customise the template that you use for your own admin user, simply navigate to My Account using the top navigation bar.
To see and change the template used by other administrator users, if you have permission, navigate to Setup > Staff Management > Administrator Users
Search
There are 2 primary methods of search - Intelligent Search & Advanced Search. Both of these search options are available from any page.
- Intelligent Search is located at the top right of every page. To use it, enter a search term and hit enter. Results are dynamically fetched and displayed instantly. Intelligent search makes a best guess attempt at what you are searching for and will display the most relevant matches it is able to find.
Advanced Search is located in the bottom left of the sidebar on every page. With advanced search, you can choose exactly what entity type and field you wish to perform a search for. Entering a search term here and submitting will take you to the exact match or list of possible matches.
Widgets
The admin homepage dashboard is made up of a number of individual 'widgets'. These widgets can be arranged and maximised/minimized by each individual member of staff and enabled/disabled entirely for different administrator roles.
Further Reading:
Languages
The WHMCS admin area has full multi-language support.
Each administrator user can set their own language preference via the My Account page accessed from the top navigation bar.
Language files for the admin area can be found in the /admin/lang/ directory.
If you wish to customise the translations for a given language, an overrides file should be created. You can learn more about overrides and how to use them in our Developer Documentation.