# magepsycho/magento2-seosuite

> Magento 2 FREE SEO Suite

`composer require magepsycho/magento2-seosuite`

Canonical URL: https://packagento.com/magepsycho/magento2-seosuite

## At a glance

- **Vendor**: magepsycho (https://packagento.com/magepsycho.md)
- **Latest version**: 1.0.0 — released 2023-02-12
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/magepsycho/magento2-seosuite and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require magepsycho/magento2-seosuite:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Magento 2 FREE SEO Suite

## README

<div align="center">

![Magento 2 FREE SEO Suite](https://i.imgur.com/d8QEHRb.png)
## Magento 2 FREE SEO Suite

</div>

<div align="center">

[![Packagist Version](https://img.shields.io/github/v/tag/MagePsycho/magento2-seo-suite?logo=packagist&sort=semver&label=packagist&style=for-the-badge)](https://packagist.org/packages/magepsycho/magento2-discountlimit)
[![Packagist Downloads](https://img.shields.io/packagist/dt/magepsycho/magento2-seosuite.svg?logo=packagist&style=for-the-badge)](https://packagist.org/packages/magepsycho/magento2-seosuite/stats)
![Supported Magento Versions](https://img.shields.io/badge/magento-%202.3_|_2.4-brightgreen.svg?logo=magento&longCache=true&style=for-the-badge)
![License](https://img.shields.io/badge/license-MIT-green?color=%23234&style=for-the-badge)

</div>

### Overview
[Magento 2 FREE SEO Suite](https://www.magepsycho.com/magento2-free-seo-suite.html) extension optimizes SEO strategies for your e-commerce store.

The default SEO settings in Magento 2 are not enough to improve your store's search visibility. With this extension, you can maximize your SEO strategies for better search engine rankings.

### Key Features
* Adds canonical URL to the homepage, CMS pages, and contact us page
* Eliminates non-canonical product URLs from `sitemap.xml`
* Offers HTML sitemap creation
* Enables SEO pagination using `rel="prev"` and `rel="next"` meta tags
* Adds "NOINDEX,NOFOLLOW" meta robots to `/customer`, `/checkout`, and `/catalogsearch` pages

### Feature Highlights

#### Manage Duplicate Content
This extension helps to avoid duplicate content problems on the homepage, CMS pages, and contact us pages.  
It uses the concept of "Canonical URL" to specify the preferred version of a web page, avoiding duplicity and improving search ranking by using a `rel="canonical"` link in HTML.

The extension also removes non-preferred product URLs from "sitemap.xml" by setting a canonical version.

For example: the "/" version of the homepage will be designated as the preferred one, even among multiple variations such as

* `/index.php`
* `/cms/`
* `/cms/index`
* `/cms/index/index`
* `/home`

#### HTML Sitemap

The extension offers an "HTML Sitemap" to help visitors find their way around your store. This feature will add a link to a page called "/sitemap" in the footer.

*An "HTML Sitemap" is a webpage that lists all the links on a website in an organized manner to help visitors navigate and improve the website's SEO by providing search engines with a clear structure.*

#### SEO Pagination

The extension enhances paginated pages, like category pages, by adding `rel="next"` and `rel="prev"` attributes for pagination.  
Just like `rel="canonical"` helps with duplicate content, `rel="next"` and `rel="prev"` HTML link elements help identify the relationship between different URLs in a paginated series.

***Important**: The "Prev/Next" recommendation from Google Webmaster Guide is no longer applicable as of Spring 2019. (Reference: https://support.google.com/webmasters/thread/2783047?hl=en)*

#### "No Index, No Follow" Meta Tag
The extension allows you to choose which pages should have the "NOINDEX,NOFOLLOW" meta robots tag.  
You can choose which pages should have the "NOINDEX,NOFOLLOW" meta robots tag.  

By default, these tags will be added to the following pages:  
* Customer pages (`/customer/*/*`)
* Cart/Checkout pages (`/checkout/*/*`)
* CMS 404 page (`/cms/noroute/index`)
* Product review page (`/review/product/list`)
* Search result pages (`/catalogsearch/*/*`)

*This can be useful for pages with duplicate or low-quality content, under construction or development, sensitive information, or thin or no content.*

### 🛠️ Installation

#### 1 Using Composer (Preferred)
```
composer require magepsycho/magento2-seosuite
```

#### 2 Using Modman
```
modman init
modman clone git@github.com:MagePsycho/magento2-seo-suite.git
```

#### 3 Using Zip File
* Download the [Extension Zip File](https://github.com/MagePsycho/magento2-seo-suite/archive/master.zip)
* Extract & upload the files to `/path/to/magento2/app/code/MagePsycho/SeoSuite/`

After installation by either means, activate the extension with following steps

1. Enable the module
```
php bin/magento module:enable MagePsycho_SeoSuite --clear-static-content
php bin/magento setup:upgrade
```
2. Flush the store cache
```
php bin/magento cache:flush
```
3. Deploy static content - *in Production mode only*
```
rm -rf pub/static/* var/view_preprocessed/*
php bin/magento setup:static-content:deploy
```
4. Go to Admin > MARKETING > SEO Suite > Manage Settings

### Live Demo:

* [Backend Demo](http://m2default.mage-expo.com/admin_m2demo/?module=seosuite)
* [Frontend Demo](http://m2default.mage-expo.com/)

### Changelog

**Version 1.0.0 (2023-02-07)**

* Initial Release.

### Authors
- Raj KB [![Twitter Follow](https://img.shields.io/twitter/follow/rajkbnp.svg?style=social)](https://twitter.com/rajkbnp)

### Contributors

![Contributors](https://contrib.rocks/image?repo=magepsycho/magento2-seo-suite)

### To Contribute
Any contribution to the development of `Magento 2 FREE SEO Suite` is highly welcome.  
The best possibility to provide any code is to open a [pull request on GitHub](https://github.com/MagePsycho/magento2-seo-suite/pulls).

### Need Support?
If you encounter any problems or bugs, please create an issue on [GitHub](https://github.com/MagePsycho/magento2-seo-suite/issues).

Please [visit our store](https://www.magepsycho.com/extensions/magento-2.html) for more FREE / paid extensions OR [contact us](https://magepsycho.com/contact) for customization / development services.

## Recent Versions

| Version | Released |
|---|---|
| 1.0.0 | 2023-02-12 |

## Quality

Latest release (1.0.0) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | 1 | – |
| 2.4.9 | – | – | 1 | 1 |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Warning | 69 | 69 warnings (ruleset: Magento2) — 66 auto-fixable with phpcbf |
| PHPMD | Warning | 7 | 7 rule violations (UnusedFormalParameter:3, MissingImport:3, IfStatementAssignment:1) |
| Cpd | Warning | 2 | 2 duplicated chunks spanning 77 total lines (min-lines=5, min-tokens=70) |
| Composer validate | Info | 1 | valid; 1 advisory note (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 28 | 28 | – | – |
| 2.4.8 | – | 29 | 31 | – |
| 2.4.9 | – | – | 31 | 31 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["magepsycho/magento2-seosuite"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

magepsycho is a Magento 2 vendor on Packagento. See https://packagento.com/magepsycho.md for their full catalogue.

