README

Sulu bundle that integrates IndexNow API to instantly inform search engines and web crawlers about content changes. See https://www.indexnow.org/index for details.

Installation

This bundle requires PHP 8.2 and Sulu 2.6.

1. Open a command console, enter your project directory and run:

composer require linderp/sulu-index-now-bundle

If you're not using Symfony Flex, you'll also need to add the bundle in your config/bundles.php file:

return [
    //...
    Linderp\SuluIndexNowBundle\SuluIndexNowBundle::class => ['all' => true],
];

1. Register the new routes by adding the following to your routes_admin.yaml:

SuluIndexNowBundle:
    resource: "@SuluIndexNowBundle/Resources/config/routes_admin.yml"

1. If you don't have the IndexNow setup already, generate your key at https://www.bing.com/indexnow/getstarted. Then follow the instructions and put the key file in the public/ folder.
2. Add the file config/packages/sulu_index_now.yaml with the following configuration and replace #your key here with your actual key:

sulu_index_now:
    key: #your key here
    search_engines:
        IndexNow: 'https://api.indexnow.org/indexnow'
        Amazon: 'https://indexnow.amazonbot.amazon/indexnow'
        Bing: 'https://www.bing.com/indexnow'
        Naver: 'https://searchadvisor.naver.com/indexnow'
        Seznam: 'https://search.seznam.cz/indexnow'
        Yandex: 'https://yandex.com/indexnow'
        Yep: 'https://indexnow.yep.com/indexnow'

1. Reference the frontend code by adding the following to your assets/admin/package.json:

"dependencies": {
    "sulu-index-now-bundle": "file:../../vendor/linderp/sulu-index-now-bundle/Resources/js"
}

1. Import the frontend code by adding the following to your assets/admin/app.js:

import "sulu-index-now-bundle";

1. Build the admin UI:

cd assets/admin
npm run build

Usage

• The admin UI is available under Settings → Index Now.
• Publishing a page triggers IndexNow submission automatically (unless seo.noIndex is enabled).