SEO Suite

Technical SEO for Magento 2 on Luma and Hyvä. This guide covers installation, every setting and day-to-day use.

• Demo (Luma, view the page source): https://demo.softawarecommerce.com/montana-wind-jacket.html
• Demo (Hyvä, view the page source): https://demo.softawarecommerce.com/hyva/montana-wind-jacket.html
• Admin demo: https://demo.softawarecommerce.com/try-admin/seo-suite
• Changelog: Release notes · Questions: FAQ

1. Requirements

2. Installation

Install with Composer from repo.softawarecommerce.com. The access keys are in your account on softawarecommerce.com; see Composer access for details.

composer config repositories.softaware composer https://repo.softawarecommerce.com
composer config --auth http-basic.repo.softawarecommerce.com PUBLIC_KEY PRIVATE_KEY
composer require softaware/module-seo-suite
bin/magento setup:upgrade
bin/magento setup:di:compile            # production mode only
bin/magento setup:static-content:deploy # production mode only
bin/magento cache:flush

To update later: composer update softaware/module-seo-suite, then the same bin/magento commands.

After installation structured data, meta templates, canonical, robots, hreflang, Open Graph, redirects and the 404 log are on. Shipping, return policy and LocalBusiness markup are off until you fill them in.

The admin menu has Softaware > SEO Suite with Redirects, 404 Log, SEO Audit, Meta Generator, Structured Data Test and Settings.

3. Quick start

1. Open Stores > Configuration > Softaware > SEO Suite and check General > Enabled = Yes.
2. Under Structured Data: Product, choose your Brand Attribute and, if you have them, the GTIN and MPN attributes.
3. If you offer fixed shipping and returns, fill in Structured Data: Shipping and Structured Data: Return Policy and set them to Enabled.
4. Flush the full-page cache and open Softaware > SEO Suite > Structured Data Test to check sample pages in Google's Rich Results Test (the store must be reachable from the internet).
5. Open SEO Audit and click Run Audit Now to see where the catalogue needs work.

4. Settings

Stores > Configuration > Softaware > SEO Suite (also Softaware > SEO Suite > Settings). Most settings can be set per website and store view.

General

Structured Data (JSON-LD)

Structured Data: Organisation

Enabled, Output On (home page only, or every page), Type (OnlineStore by default, Store, Organization or Corporation), Name, Legal Name, Logo (empty = the theme logo), Description, Profiles (sameAs) (one URL per line), Customer Service Telephone and Email (empty = Store Information values), Contact Languages, and Include Address and VAT Number from Store Information.

Structured Data: Product

Structured Data: Shipping and Return Policy

Shipping adds shippingDetails to offers: Ship To Countries, Shipping Rate (0 = free), Free Shipping From, handling and transit times in working days. Return Policy adds hasMerchantReturnPolicy to the organisation and to offers: Applicable Countries, Policy, Return Window (Days), Return Method, Return Fees and Return Shipping Fee. Both are off by default.

Structured Data: Local Business

Off by default. Choose the CMS page (Output On CMS Page, for example contact-us), the Business Type, Name, Latitude and Longitude, Opening Hours (one rule per line, for example Mo-Fr 09:00-17:30) and Price Range.

Meta Templates

Variables: {{name}}, {{sku}}, {{price}}, {{category}}, {{categories}}, {{brand}}, {{short_description}}, {{description}}, {{excerpt}}, {{attribute:code}} (option labels are resolved), {{store}}, {{website}}; for categories also {{parent}}, {{top}}, {{filters}} and {{page}}; for CMS pages {{title}}, {{heading}} and {{content}}. Text in square brackets is dropped when a variable inside it is empty, so {{name}}[ by {{brand}}] never ends in "by". Magento's own title prefix and suffix are still added.

Product Image Alt and Title

Enabled, Apply (only when the image has no label, or always), Alt Text Template (default {{name}}[ - {{attribute:color}}]) and Title Template for product list images. Used for the product page gallery and product lists.

Meta Robots

A Meta Robots value on a product, category or CMS page wins over all rules.

Canonical URLs

Canonical links on home, CMS, category and product pages, replacing Magento's own. Product Canonical URL: without category path (default), shortest or longest category path. Paginated Category Pages: each page to itself (?p=2, default) or all pages to page 1. Filters and sort parameters are always removed.

Hreflang

Enabled, Include This Store View (No for a store view that duplicates another language, such as a second theme), Language Code (empty = from the store locale), x-default Store View, and Only Store Views of the Same Website. Only store views where the product is enabled and visible, or the category active, are listed.

Open Graph and Twitter Cards

Open Graph (replaces Magento's product Open Graph tags), Twitter Cards, X (Twitter) Account, Facebook App ID and a Fallback Image (1200 x 630 px works best) for pages without an image.

Redirects and 404 Log

XML Sitemap

Honour "Exclude from XML Sitemap", Leave Out Pages Set to NOINDEX, Add Category Images and Add Hreflang Links (off by default). These extend Magento's own sitemap generation.

SEO Audit

Run Weekly (Sunday night by cron), Title Longer Than (60), Meta Description Shorter Than (70) and Longer Than (160) characters, and Thin Content Below (50 words).

5. Product, category and CMS page fields

The edit forms get extra fields in the Search Engine Optimization section: Meta Robots and Exclude from XML Sitemap on products, categories and CMS pages, and Hreflang Key on CMS pages. Give CMS pages with different URLs in different languages the same Hreflang Key to link them.

6. Redirects

Softaware > SEO Suite > Redirects lists all rules with keyword search, filters and a column chooser. Add Redirect opens the form:

• Match: Exact (the path as typed, with or without query string), Wildcard (* matches anything and * or $1 in the target carries the matched part over) or Regular expression (PCRE without delimiters, for example ^old/(\d+)\.html$ to new/$1.html).
• Request Path is relative to the store URL. Target is a path in the same store view, a full URL, or empty for the home page.
• Redirect Type 301 or 302, Store View (one or all), Priority (pattern rules with a higher priority are tried first; exact rules always win) and a Note.

Hits are counted per rule; rules for deleted products and categories are marked Automatic. Chains (A to B to C) are answered with one redirect to C; loops are ignored and logged. Saving an exact rule for a URL that is still a cached page removes that page from the full-page cache (built-in and Varnish); after saving a wildcard or regex rule, refresh the page cache under System > Cache Management.

Import CSV and Export CSV: columns source,target,redirect_type,match_type,store,is_active,priority,note (store is a store view code or all; only source and target are required). The import has a check-only mode.

7. 404 Log

Softaware > SEO Suite > 404 Log lists storefront URLs that returned "page not found", per store view, with hits, first and last seen date, last referrer and user agent. Create Redirect opens the redirect form with the request path and store view filled in and Active set to Yes; choose the target and save. Clear Log, mass delete and CSV export are available. The log holds up to 50,000 entries.

8. SEO Audit

Softaware > SEO Suite > SEO Audit checks products, categories and CMS pages per store view for missing, too long or duplicate meta titles; missing, too short, too long or duplicate meta descriptions; missing images and image alt text; thin content; no URL rewrite (no canonical URL); and pages set to NOINDEX. Each issue is an error, a warning or a notice (a notice when a template fills the gap on the storefront). The Errors, Warnings and Notices tiles filter the list; Edit opens the page; Export downloads the filtered list as CSV.

Run Audit Now queues an audit that cron picks up within a minute. It also runs weekly and from the command line.

9. Meta Generator

Softaware > SEO Suite > Meta Generator writes the template results into products, categories or CMS pages (useful for feeds and other tools). Choose Generate For, Store View, the Fields, whether to overwrite existing values, and Preview only to see what would change. The job runs with the next cron run; results appear under Recent Jobs.

10. Structured Data Test

Sample URLs per store view (home, configurable product, simple product, category, CMS page) with the markup to expect and buttons for Google's Rich Results Test and the Schema.org validator. Both tools fetch the page from the internet, so they only work for store views that are publicly reachable.

11. Command line

bin/magento softaware:seo:audit [--store=<code>]...
bin/magento softaware:seo:meta:generate --entity=product|category|cms [--store=<code>|admin]
    [--fields=title,description,keywords] [--overwrite] [--dry-run] [--limit=N]
bin/magento softaware:seo:redirect:import <file.csv> [--dry-run]
bin/magento softaware:seo:redirect:export [<file.csv>]
bin/magento softaware:seo:redirect:test <path-or-url> [--store=<code>]
bin/magento softaware:seo:404:clean

Cron jobs: softaware_seo_process_jobs (every minute, audit and generator jobs from the admin), softaware_seo_weekly_audit (Sunday 02:23) and softaware_seo_clean_404_log (daily).

12. Permissions (ACL)

System > Permissions > User Roles > Role Resources > Softaware > SEO Suite: Redirects, 404 Log, SEO Audit, Meta Generator, Structured Data Test and SEO Suite Configuration can be granted separately.

13. Troubleshooting

14. Uninstall

bin/magento module:disable Softaware_Seo
composer remove softaware/module-seo-suite
bin/magento setup:upgrade

The module's tables and the product and category attributes seo_robots and seo_exclude_sitemap stay in the database; remove them yourself if you no longer need the data. Redirects you want to keep can be exported as CSV first.