Difference between revisions of "Admin Area"
m (→Logging In) |
|||
| Line 1: | Line 1: | ||
==Logging In== | ==Logging In== | ||
| + | |||
[[File:Videotutorial.png|center|link=https://www.youtube.com/watch?v=M_Ak62s_L1k&list=PLfpgUwyOgC7C4wwPhB7jEqSp_esXB31Jb&index=3&t=0sJb&index=4&t=0s|Watch Video Tutorial]] | [[File:Videotutorial.png|center|link=https://www.youtube.com/watch?v=M_Ak62s_L1k&list=PLfpgUwyOgC7C4wwPhB7jEqSp_esXB31Jb&index=3&t=0sJb&index=4&t=0s|Watch Video Tutorial]] | ||
| − | |||
To login to the WHMCS admin area, navigate to the admin directory within your installation. | To login to the WHMCS admin area, navigate to the admin directory within your installation. | ||
| − | For example if you installed WHMCS | + | For example, if you installed WHMCS at https://billing.example.com/, 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 | + | If you have followed the [[Further Security Steps]] and renamed your admin directory, you will need to use the custom name you have set up. |
===IP Banning=== | ===IP Banning=== | ||
| − | If multiple failed login attempts | + | If multiple failed login attempts occur from the same IP address, the system will enforce an IP ban. |
| − | If you | + | If you are banned, you can 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 the ban in '''General Settings > Security'''. For more information on manually removing a banned IP address, see our [[FAQs]]. |
===Password Resets=== | ===Password Resets=== | ||
| Line 21: | Line 21: | ||
Upon requesting a password reset, you will receive an email containing a link that will allow you to set a new password. | 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 | + | If you fail to receive the email, or have disabled the forgotten password option, instructions for resetting the admin password are in our [[FAQs]]. |
==Templates== | ==Templates== | ||
| − | The admin area comes with | + | The admin area comes with two templates as standard: |
| − | *'''Blend''' | + | *'''Blend''' — The current default template, featuring a responsive design. This is compatible with laptops, tablets and mobile devices. |
| − | *'''V4''' | + | *'''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. | + | You can customise and create your own custom admin area templates. See [[Admin Area Template Files]] for more information. |
===Choosing your admin template=== | ===Choosing your admin template=== | ||
| − | Each administrator user has their own preference that controls the admin area theme | + | Each administrator user has their own preference that controls the admin area theme or template they see and use. |
| − | To see and customise the template that you use for your own admin user, | + | To see and customise the template that you use for your own admin user, navigate to '''My Account''' using the top navigation bar. |
| − | To see and change the template | + | To see and change the template for other administrator users, if you have permission, navigate to '''Setup > Staff Management > Administrator Users'''. |
==Search== | ==Search== | ||
| − | There are | + | There are two primary methods of search: '''Intelligent Search''' and '''Advanced Search'''. Both of these search options are available from any page. |
| − | * '''[[Intelligent Search]]''' is | + | * '''[[Intelligent Search]]''' is at the top right of every page. To use it, enter a search term and press enter. The system fetches them dynamically and displays them 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 | + | * '''Advanced Search''' is 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 it will take you to the exact match or list of possible matches. |
==Widgets== | ==Widgets== | ||
| − | The [[Admin_Dashboard|admin homepage dashboard]] is made up of a number of individual 'widgets'. | + | The [[Admin_Dashboard|admin homepage dashboard]] is made up of a number of individual 'widgets'. Each staff member can arrange, maximise, or minimize these widgets and enable or disable them entirely for different administrator roles. |
| − | + | For more information: | |
*[[Widgets]] | *[[Widgets]] | ||
*[[Creating_a_Widget]] | *[[Creating_a_Widget]] | ||
| Line 59: | Line 59: | ||
The WHMCS admin area has full multi-language support. | The WHMCS admin area has full multi-language support. | ||
| − | Each administrator user can set their own language preference via the '''My Account''' page | + | Each administrator user can set their own language preference via the '''My Account''' page, which you can access from the top navigation bar. |
| − | Language files for the admin area | + | Language files for the admin area are in the '''/admin/lang/''' directory. |
| − | + | To customise the translations for a given language, create an overrides file. You can learn more about overrides and how to use them in our [https://developers.whmcs.com/languages/overrides/ Developer Documentation]. | |
| − | <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 | + | <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 want to improve, 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 18:22, 30 April 2020
Contents
Logging In
To login to the WHMCS admin area, navigate to the admin directory within your installation.
For example, if you installed WHMCS at https://billing.example.com/, 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 set up.
IP Banning
If multiple failed login attempts occur from the same IP address, the system will enforce an IP ban.
If you are banned, you can 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 the ban in General Settings > Security. For more information on manually removing a banned IP address, see 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 are in our FAQs.
Templates
The admin area comes with two templates as standard:
- Blend — The current default template, featuring a responsive design. This is 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. See Admin Area Template Files for more information.
Choosing your admin template
Each administrator user has their own preference that controls the admin area theme or template they see and use.
To see and customise the template that you use for your own admin user, navigate to My Account using the top navigation bar.
To see and change the template for other administrator users, if you have permission, navigate to Setup > Staff Management > Administrator Users.
Search
There are two primary methods of search: Intelligent Search and Advanced Search. Both of these search options are available from any page.
- Intelligent Search is at the top right of every page. To use it, enter a search term and press enter. The system fetches them dynamically and displays them 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 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 it 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'. Each staff member can arrange, maximise, or minimize these widgets and enable or disable them entirely for different administrator roles.
For more information:
Languages
The WHMCS admin area has full multi-language support.
Each administrator user can set their own language preference via the My Account page, which you can access from the top navigation bar.
Language files for the admin area are in the /admin/lang/ directory.
To customise the translations for a given language, create an overrides file. You can learn more about overrides and how to use them in our Developer Documentation.