README

Experimental package: this plugin is in active development and its configuration, checks, storage format, UI, and extension points may change before a stable release.

softspring/cms-seo-plugin adds SEO analysis tools to Softspring CMS administration.

It analyzes published CMS URLs and reports deterministic checks for HTTP status, HTML content type, title, meta description, canonical URL, alternate language URLs, H1 usage, heading structure, image alt text, robots meta tag, and approximate body word count.

It also supports site-level checks for robots.txt, sitemap indexes, configured sitemaps, and root slash redirects.

Installation

composer require softspring/cms-seo-plugin:^6.0@dev

The plugin requires softspring/cms-bundle and Symfony HttpClient.

Register the bundle if Symfony Flex does not do it automatically:

// config/bundles.php
return [
    Softspring\CmsSeoPlugin\SfsCmsSeoPlugin::class => ['all' => true],
];

Configuration

Site analysis is enabled by default. Disable it or individual checks when a project does not expose the related public resources:

# config/packages/sfs_cms_seo.yaml
sfs_cms_seo:
    site_analysis:
        enabled: true
        checks:
            robots_reachable: true
            robots_sitemap_index: true
            sitemap_index_reachable: true
            sitemap_index_contains_configured_sitemaps: true
            sitemap_reachable: true
            slash_route_redirect: true

Usage

The plugin adds SEO screens to the CMS admin:

• A global SEO dashboard.
• A SEO tab for CMS content administration.
• A SEO tab for CMS site administration.

Run all configured analysis from the command line:

php bin/console sfs:cms:seo:analyze

Analyze only sites or content:

php bin/console sfs:cms:seo:analyze --sites
php bin/console sfs:cms:seo:analyze --contents

The --async option is reserved for projects that replace the default dispatcher with a Messenger-backed implementation.

Extension Points

Add content SEO checks by implementing Softspring\CmsSeoPlugin\Content\Check\CheckInterface. Services are autoconfigured with the sfs_cms_seo.check tag.

Add site SEO checks by implementing Softspring\CmsSeoPlugin\Site\Check\SiteCheckInterface. Services are autoconfigured with the sfs_cms_seo.site_check tag.

Replace Softspring\CmsSeoPlugin\Seo\SeoAnalysisDispatcherInterface when a project needs asynchronous analysis or an external provider.

Features

See FEATURES.md for the functional scope of this package.

Contributing

See CONTRIBUTING.md.

Report issues and send Pull Requests

Security

See SECURITY.md.

License

This package is free and released under the AGPL-3.0 license.