1. Download Kiwi from the OctoberCMS plugin store
2. Install it through the OctoberCMS backend
3. Done! It has no external dependencies

Initial Configuration

After installing, go to Settings > Kiwi SEO to set default values:

These values are used as fallback when you don't configure specific values on pages or models.

Usage: Static SEO (CMS Pages)

For a CMS page, access the editor and you'll see the "Kiwi SEO" button in the toolbar.

Available tabs:

1. Dynamic SEO (optional)

• Enable if you want this page to use dynamic data from a model
• Select the source model (e.g: Mozaik Item, Blog Category, Blog Article)

2. General Tags (ST)

• Author: Content author
• Generator: Tool that generates the content

3. Open Graph Tags (OG)

• Title: Title that appears when sharing on social networks
• Description: Description shown when sharing
• Type: Content type (website, article, product)
• Locale: Content language
• Image: Image shown when sharing
  • Absolute URL required
  • Recommended width: 1200px
  • Recommended height: 628px

4. X/Twitter Tags

• Card Type: Card type (Summary, Summary Large Image)
• Title: Specific title for X
• Description: Specific description for X
• Image: Specific image for X
  • Absolute URL required

Usage: Dynamic SEO (Models)

The true power of Kiwi emerges here. When working with dynamic models, Kiwi will manage everything in one single place.

Example: Items in Mozaik

1. Go to your page that lists Mozaik Items
2. Click on "Kiwi SEO" and enable "Use Dynamic SEO"
3. Select "Mozaik Item" as the source model
4. Now, each product automatically has:
   • Meta tags based on its data
   • Open Graph tags with its image
   • Configured Twitter cards

Configure SEO in a Model (E.g: Mozaik Item)

Open the item edit form and go to the "SEO & Social" tab:

Templates (the most powerful)

Here you define how to automatically generate meta tags using model data.

Meta Title Template: {name} - {category} | My Store
Meta Description Template: {description|truncate:150}. Buy now!

When the page renders:

• {name} is replaced with the item name
• {category} with the category
• {description|truncate:150} truncates the description to 150 characters

Open Graph & Social Media

Configure specific values for Open Graph:

• Title OG: Leave empty to use the automatically generated title or create one. Templates are supported too
• Description OG: Specific description (or use the template)
• Type OG: Type (website, article, product)
• Image OG: Product image

Twitter/X

Customize how it looks when sharing on X:

• Card Type: Summary Large Image is recommended
• Title X: Use different values than OG if you need (or create a template)
• Image X: Different image if desired

Available Filters for Templates

When using dynamic templates, you can apply filters to process data:

truncate:n

Truncates text to n characters.

{description|truncate:150}

Result: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad m..."

upper

Converts to uppercase.

{category|upper}

Result: "ELECTRONICS"

lower

Converts to lowercase.

{name|lower}

Result: "iphone 15 pro max"

default:value

Uses a default value if the field is empty.

{short_name|default:'Product'}

Result: If short_name is empty, shows "Product"

Combine filters

You can chain multiple filters:

{description|truncate:100|upper}

Practical Examples

E-commerce: Products

Meta Title Template: {name} | Shop Online
Meta Description Template: {description|truncate:120}. Free shipping on orders over $50.
OG Type: product
OG Image: {image_url}

Blog: Articles

Meta Title Template: {title} - {blog_name}
Meta Description Template: {excerpt|truncate:155}
OG Type: article
OG Image: {featured_image}

Catalog: Services

Meta Title Template: {service_name} - {company_name}
Meta Description Template: {description|truncate:150}
OG Type: website
OG Locale: {locale|default:'en_US'}

Render in Your Templates

Kiwi provides a seoTags component that renders all meta tags automatically.

In your base layout:

{% component 'seoTags' %}

This injects into the <head>:

• Dynamic meta tags (title, description)
• Open Graph tags
• Twitter Card tags
• Standard tags (author, generator)

Access SEO data in Twig (optional):

If you need to access SEO data directly:

{% component 'seoTags' as seoComponent %}

<h1>{{ seoComponent.title }}</h1>
<p>{{ seoComponent.description }}</p>

{# Complete SEO object #}
{% set seo = seoComponent.seo %}
<meta property="og:title" content="{{ seo.og.title }}">

Supported Plugins

Kiwi currently works with:

• Mozaik Items - Items/products management

As we advance, we'll add support for more plugins and models.

Roadmap

We're actively working on new features:

• Bulk Upload: Import SEO data for multiple items from CSV/Excel
• JSON Schema Generator: Automatically generate structured data (JSON-LD) that Google understands
• More Supported Models: Extend Kiwi to your favorite plugins

Golden Tips

1. Always use dynamic templates - They're more powerful than configuring each item individually
2. Define global default values - Saves time and maintains consistency
3. Use og:image correctly - It's what attracts the most clicks on social media
4. Combine filters intelligently - truncate is your friend for long descriptions
5. Validate before publishing - Use tools like Facebook Share Debugger and Twitter Card Validator

Support

We are happy to help!

• Review this documentation again (the answer is probably there)

• Send us an email to hello@polilla.studio and we'll reply you as soon as we can.

• Or you can visit GitHub Issues Page to report any issues with the plugin.

Made with ❤️ by Polilla Studio