Installation

Quick Start

Step 1: Install the Plugin

Download

After your purchase, you will receive a download link for the plugin. Download the ZIP file and extract it to your site/plugins folder. It should look like this:

site/plugins/
├─ kirby-seo-audit/
│  └─ … All plugin files

Composer v1.5.1+

The recommended way to install the plugin is via Composer. Since it's not available through Packagist, you will need to connect to our private repository repo.kirby.tools and authenticate your package download. Authentication is done via a license code that you can get from the Kirby Tools Hub after your purchase.

To get access to the private repository and enable Composer installs, follow these steps:

1. Go to hub.kirby.tools. Log in with the email you used for the purchase and the order number.
2. After successful login, a license code will be displayed next to the Composer repository configuration and a CLI command.
3. Copy and paste the Composer configuration into your composer.json file. This will enable Composer to resolve our plugins. Your composer.json file should include this repository item:
   composer.json

   {
     "repositories": [
       {
         "type": "composer",
         "url": "https://repo.kirby.tools"
       }
     ]
   }
   

4. Copy and run the Composer CLI command, which will generate an auth.json file for you, a Composer standard for authenticating against private repositories. Composer will send your license key (or license keys if you have purchased multiple plugins) as a bearer token with each request to repo.kirby.tools. As an alternative to running the command, you can create the file yourself. An auth.json file should look like this:
   auth.json

   {
     "bearer": {
       "repo.kirby.tools": "KT1-gd9Ymx30rM-ylZ3h6yF3l"
     }
   }
   

To install multiple plugins in one Kirby project, add all required license codes to your local auth.json file. Separate each license code with a comma, e.g:

{
  "bearer": {
    "repo.kirby.tools": "KT1-A, KT1-B"
  }
}

The Kirby Tools Composer repository is now set up. You can install the plugin by running the following command in your terminal:

composer require johannschopplich/kirby-seo-audit

Last but not least, you can manage Kirby SEO Audit like any other plugin, for example, download updates:

composer update

Step 2: Blueprint Setup

To display the SEO audit section in the Kirby Panel, add a section of type seo-audit to any page blueprint:

sections:
  seoAudit:
    type: seo-audit

You don't have to configure anything else! Open your Kirby Panel and you should see the new SEO audit section:

Click the Analyze button to perform SEO checks on the current page. The report will evaluate the SEO quality of the page and provide actionable insights to improve it.