README

A comprehensive SEO Lite solution for Magento 2.4.7 that provides advanced meta tag templates, canonical URLs, structured data, XML sitemaps, and SEO-friendly URLs with an intuitive admin interface.

Features
About This Edition
Requirements
Installation
Configuration
Features Overview
Usage
Development
Contributing
Troubleshooting
Upgrading to Full Version
License
Support

Features

🏷️ Meta Tag Templates

Dynamic template system with variable support
Templates for title, description, keywords, and robots meta tags
Open Graph support (title, description, type, image)
Entity-specific templates (products, categories, CMS pages)
Template prioritization and conditional application
Variable processor with extensive placeholder support

🔗 Canonical URLs

Advanced canonical URL management
Product canonical URLs with multiple strategies
Category canonical URLs with pagination support
Filter parameter handling
Configurable exclusions for products and categories
High-performance caching system

📊 Structured Data (JSON-LD)

Schema.org compliant structured data generation
Support for Organization, WebSite, WebPage schemas
Product schema with pricing, reviews, and availability
Category, Article, and Review schemas
Product attribute mapping to schema properties
Built-in schema validation
Performance-optimized caching

🗺️ XML Sitemap

Enhanced XML sitemap generation
Support for products, categories, and CMS pages
Image inclusion in sitemap entries
Hreflang support for multilingual sites
Automatic search engine notifications
Analytics and statistics dashboard
XML validation and error reporting
Automated CRON scheduling

🌐 Friendly URLs

SEO-friendly URLs for category filters
Customizable URL patterns and separators
Attribute name mapping to friendly terms
Multi-value parameter support
URL rewriting and routing

⚡ Cache Management

Dedicated cache types for different features
Configurable cache backends
Automatic cache invalidation
Performance optimization
Lifetime management

🎛️ Admin Interface

Comprehensive admin panel
Meta tag template management
Sitemap dashboard with analytics
Sitemap generator and validator
Structured data preview
Detailed configuration options

About This Edition

Defox SEO Suite Lite is a streamlined version of our comprehensive SEO Suite platform, specifically curated to provide essential SEO functionality while maintaining the same high-quality codebase. This edition shares its foundation with the full enterprise version, which means:

Future-Ready Architecture: The module is built with extensibility in mind, allowing seamless upgrades to the full version
Enterprise-Grade Code Quality: All components follow the same strict coding standards and design patterns used in our commercial offering
Modular Design: Some classes and interfaces may appear unused in this Lite edition but serve as foundation components for advanced features in the full version
Professional Foundation: This approach ensures consistency, maintainability, and provides a clear upgrade path for growing businesses

While this Lite edition focuses on core SEO functionality, the underlying architecture supports advanced enterprise features like AI-powered content optimization, advanced analytics, multi-site management, and custom integrations available in the full version.

Requirements

Magento: 2.4.7+
PHP: 8.2+
Dependencies:
- Magento_Store
- Magento_Catalog
- Magento_Cms
- Magento_UrlRewrite
- Magento_Sitemap
- Magento_LayeredNavigation
- Magento_Swatches

Installation

Via Composer (Recommended)

composer require defox/module-seosuite
php bin/magento module:enable Defox_SEOSuite
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento cache:flush

Manual Installation

Download the module files
Extract to app/code/Defox/SEOSuite/
Run the installation commands:

php bin/magento module:enable Defox_SEOSuite
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento cache:flush

Configuration

Navigate to Stores → Configuration → Defox → SEO Suite in your Magento admin panel. Do not forget to create a folder for sitemap.xml on Your host.

Basic Setup

General Settings: Enable the module and configure debug mode
Meta Tags: Enable template system and configure override behavior
Canonical URLs: Enable canonical URL generation for different entity types
Structured Data: Enable JSON-LD generation and configure schema types
XML Sitemap: Configure sitemap generation settings and schedules

Advanced Configuration

Organization Information: Configure business details for structured data
Product Attribute Mapping: Map product attributes to schema.org properties
Cache Settings: Optimize performance with cache configuration
URL Patterns: Customize friendly URL generation

Features Overview

Meta Tag Templates

Create dynamic meta tag templates using variables:

Product Title: {{product.name}} - {{category.name}} | {{store.name}}
Meta Description: {{product.name}} - {{product.short_description}} Starting at {{product.price}}

Available Variables:

Products: {{product.name}}, {{product.sku}}, {{product.price}}, {{category.name}}, etc.
Categories: {{category.name}}, {{category.description}}, {{parent_category.name}}, etc.
CMS Pages: {{cms_page.title}}, {{cms_page.content}}, {{cms_page.identifier}}, etc.
Store: {{store.name}}, {{store.url}}, etc.

Structured Data Examples

The module automatically generates structured data for:

Product Schema:

{
  "@context": "https://schema.org",
  "@type": "Product",
  "name": "Product Name",
  "description": "Product Description",
  "brand": {
    "@type": "Brand",
    "name": "Brand Name"
  },
  "offers": {
    "@type": "Offer",
    "price": "99.99",
    "priceCurrency": "USD",
    "availability": "https://schema.org/InStock"
  }
}

Organization Schema:

{
  "@context": "https://schema.org",
  "@type": "Organization",
  "name": "Your Company",
  "url": "https://yoursite.com",
  "logo": "https://yoursite.com/logo.png",
  "address": {
    "@type": "PostalAddress",
    "streetAddress": "123 Main St",
    "addressLocality": "City",
    "addressRegion": "State",
    "postalCode": "12345"
  }
}

XML Sitemap Features

Automatic Generation: Scheduled via CRON
Multi-entity Support: Products, categories, CMS pages
Image Sitemaps: Include product images
Hreflang: Multi-language support
Analytics: Track sitemap performance
Validation: Ensure XML compliance

Usage

Managing Meta Tag Templates

Navigate to SEO Suite → Meta Tag Templates
Create new templates for different entity types
Use variables to create dynamic content
Set priorities and conditions for template application

Generating Sitemaps

Go to SEO Suite Sitemap → Generation
Configure sitemap settings
Generate manually or set up automatic generation
Monitor progress in the Analytics dashboard

Previewing Structured Data

Visit SEO Suite → Structured Data Preview
Enter entity IDs to preview generated schema
Validate schema.org compliance
Test different configuration settings

Console Commands

Generate sitemap via command line:

php bin/magento defox:sitemap:generate

Development

File Structure

Defox/SEOSuite/
├── Api/                    # API interfaces
├── Block/                  # Block classes
├── Console/                # Console commands
├── Controller/             # Controllers
├── Cron/                   # Cron jobs
├── Helper/                 # Helper classes
├── Model/                  # Models and business logic
├── Observer/               # Event observers
├── Plugin/                 # Plugins/interceptors
├── Setup/                  # Installation/upgrade scripts
├── Template/               # Template processors
├── Ui/                     # UI components
├── view/                   # Frontend/admin templates
├── etc/                    # Configuration files
└── i18n/                   # Translations

Key Classes

Model/MetaTag/Manager: Core meta tag template processing
Model/StructuredData/AbstractGenerator: Base for structured data generators
Model/Sitemap/Generator/XmlGenerator: XML sitemap generation
Helper/StructuredDataManager: Structured data management
Template/VariableProcessorFactory: Variable processing system

Extending the Module

Adding Custom Variables

<?php
namespace YourNamespace\YourModule\Template\Processor;

use Defox\SEOSuite\Template\AbstractVariableProcessor;

class CustomProcessor extends AbstractVariableProcessor
{
    public function getAvailableVariables(): array
    {
        return [
            'custom.variable' => 'Custom Variable Description'
        ];
    }
    
    protected function processVariable(string $variable, $entity): string
    {
        switch ($variable) {
            case 'custom.variable':
                return $this->getCustomValue($entity);
            default:
                return parent::processVariable($variable, $entity);
        }
    }
}

Adding Custom Structured Data Generators

<?php
namespace YourNamespace\YourModule\Model\StructuredData\Generator;

use Defox\SEOSuite\Model\StructuredData\AbstractGenerator;

class CustomGenerator extends AbstractGenerator
{
    public function getSchemaType(): string
    {
        return 'CustomType';
    }
    
    public function canHandle($entity): bool
    {
        return $entity instanceof \Your\Custom\Entity;
    }
    
    protected function doGenerate($entity, array $context): array
    {
        return [
            '@type' => $this->getSchemaType(),
            'name' => $entity->getName(),
            // ... additional schema properties
        ];
    }
}

Contributing

We welcome contributions! Please follow these guidelines:

Development Workflow

Fork the repository
Create a feature branch: git checkout -b feature/your-feature-name
Make your changes following our coding standards
Write tests for new functionality
Ensure all tests pass: vendor/bin/phpunit
Submit a pull request

Coding Standards

Follow Magento 2 coding standards
Use PHP 8.2+ features and type declarations
Write comprehensive PHPDoc blocks
Follow SOLID principles
Implement proper error handling

Troubleshooting

Common Issues

Cache Issues:

php bin/magento cache:flush
php bin/magento cache:clean

Compilation Issues:

php bin/magento setup:di:compile

Permission Issues:

chmod -R 755 var/ pub/ generated/

Debug Mode

Enable debug mode in Stores → Configuration → Defox → SEO Suite → General Settings for detailed logging.

Performance Optimization

Enable all cache types in the module configuration
Use Redis or Varnish for better caching performance
Configure appropriate cache lifetimes
Monitor cache hit rates in the admin dashboard

Changelog

Version 1.0.0

Initial release
Meta tag template system
Canonical URL management
Structured data generation
XML sitemap enhancement
Friendly URL system
Comprehensive admin interface

License

This module is licensed under the GNU General Public License v3.0. See the LICENSE file for more information.

Professional Services

For custom development, enterprise support, or consultation services, please contact the development team.

Made with ❤️ by Marcin Lisiecki - Defox SEO Suite Lite Edition

defox / module-seosuite

Maintainers

Details