How to customize your favorite's list in WHM via the command line.

Introduction

The Favorites section of the WHM Home interface provides immediate access to the WHM features that you select. You can choose which features you prefer and the order in which they appear. While you can rearrange this through WHM directly, there may be times when you need to set this up via the command line.

Procedure

The information for the favorites list on the WHM Home interface is saved under the /var/cpanel/whm/nvdata/ directory. Specifically, in that directory, you will find a cache and yaml file for each user. To update the favorites list content or order, you would need to update the yaml file for that user. The following steps assume you are making changes to the favorites list of the root user:

1. Connect to the server via SSH and navigate to the /var/cpanel/whm/nvdata/ directory.
2. Locate and open the root.yaml file with your choice of text editor. It may already contain a list of favorites such as the following: 

   less /var/cpanel/whm/nvdata/root.yaml
   ---
   analytics: 'off'
   favorites:
   - account_information$list_accounts
   - system_health$process_manager
   - account_functions$create_a_new_account
   - dns_functions$whm_zone_manager
   - server_configuration$terminal
   - email$mail_queue_manager
   home:hide_important_next_steps: 0
   terminal_warning_accepted: 1
   whmcommand:navigation: 0

3. Next, you would need to update the favorites list section by moving or adding entries as needed. These entries are formatted as section_name$sub_menu. So for example, if you wished to add the Backup Configuration menu from the Backup section to your list, you would use backup$backup_configuration. The resulting file would look like this: 
   

   less /var/cpanel/whm/nvdata/root.yaml
   ---
   analytics: 'off'
   favorites:
   - account_information$list_accounts
   - system_health$process_manager
   - account_functions$create_a_new_account
   - dns_functions$whm_zone_manager
   - server_configuration$terminal
   - email$mail_queue_manager
   - backup$backup_configuration
   home:hide_important_next_steps: 0
   terminal_warning_accepted: 1
   whmcommand:navigation: 0

4. Once you are done with those changes, simply save the file. The next time you log into WHM, you should then see your favorites section on the home page updated.