MainWP Lighthouse add-on

Install and Set MainWP Lighthouse Add-on

1. Go to your MainWP Dashboard
2. Go to the MainWP > Add-ons page
3. Click the Install Add-ons button
4. Locate the Lighthouse add-on and select it
5. Click the Install button
6. Once the installation process is complete, click the Activate Add-ons button

• After successful installation, proceed to the Lighthouse settings
• Insert your Google PageSpeed Insights API key. If you don’t have it, see here how to get it.
  

  

• Save Settings, and you are ready to audit your sites.

Audit Child Sites

1. Go to the MainWP > Add-ons > Lighthouse > Dashboard page.
2. Locate the Audit All Sites button
3. Click it, and wait until the add-on completes the process.

Alternatively,  you can use the Bulk Actions menu to audit only certain sites, or if needed use the Audit Site action from the site Action Menu to audit just one site.

Schedule Automated Audits

1. Go to the MainWP > Add-ons > Lighthouse > Settings page.
2. Locate the Automatically audit sites option and Enable it.
3. Locate the Automated audit frequency option and set how often you want to check your sites.
4. Save Settings.

Get Lighthouse Report for a Site

1. Go to the Lighthouse > Dashboard page
2. Locate the site you want to check in the list and click use the Lighthouse Report action from the Actions Menu
   

   

3. Once redirected to the report page, you can review all details

Widgets and Manage Sites table information

You can enable Performance Score columns (Desktop and Mobile) for the Manage Sites table from the Page Settings menu.

Widgets are available on the main Overview page and on the Child Site’s Overview page. 

They can also be enabled in the Page Settings on the relevant page.

The widget on the main Overview page provides scores for the best and worst performing sites:

And the widget on the Child Site’s Overview page provides scores for Desktop and Mobile and how that score has changed since the preceding audit.

Lighthouse Settings

• Google PageSpeed Insights API key – In order to run audits, you need to enter your Google PageSpeed API key, if you don’t have it, see here how to get it.
• Language – Select language for Lighthouse reports.
• Strategy – Select if you want to get reports for Desktop, Mobile, or Both versions of sites.
• Notifications threshold – Set the threshold for notifications. If the score goes under the set value, the add-on will notify you.
• Automatically audit sites – If you want the add-on to automatically run audits, enable this feature.
• Automated audit frequency – If automated audits are enabled, here you can set how often you want them to run.
• Maximum execution time – Change the Max execution time if needed. If the Lighthouse reports are not being completed, increasing this value may help.
• Maximum script run time – Change the Max script run time if needed. If your scans do not finish completely and changing the Maximum Execution Time does not help, increase this value until you find the maximum allowed runtime.
• Throttling delay time – Change the Throttling delay time. Increasing this value may slow down Lighthouse reporting, but may help provide more accurate reports on poorly performing web servers.

Audit Sites via WP CLI

Scan one or multiple sites:

wp mainwp-lighthouse audit 125,126

or all

wp mainwp-lighthouse audit --all

Lighthouse REST API

All MainWP REST API calls, including full documentation, and examples, are now publicly available on Postman.

Please refer to our REST API document for more details on enabling REST API and managing Keys: https://kb.mainwp.com/docs/mainwp-rest-api/

Get the Google PageSpeed Insights API Key

1. Log into your Google account.
2. Navigate to https://developers.google.com/speed/docs/insights/v5/get-started and click Get a Key button
   
3. Select existing or Create a new project and click Next
   
4. Copy API Key to clipboard and click Done
   
5. Paste the Key to the add-on Settings.