Quick Start

Updated 10 April 2026

Watch Tutorial Strapi Market

Quick Start Guide

Get your first sitemap up and running in just a few steps.

Installation

Prerequisites

  • Node.js >= 18.0.0
  • npm >= 8.0.0
  • Strapi 5.x

Install via npm and via yarn

npm install @webbycrown/strapi-advanced-sitemap

Enable the Plugin

Update your Strapi configuration file to enable the plugin:

File: config/plugins.js

module.exports = {
  'strapi-advanced-sitemap': {
    enabled: true,
  },
};

Restart and Rebuild

After enabling the plugin, restart Strapi and rebuild the admin panel:

npm run build
npm run develop

Note: The admin panel rebuild is necessary to include the plugin’s admin interface.

Verify Installation

Once Strapi is running, you should see the plugin in the admin panel:

  • Log in to your Strapi admin panel
  • Navigate to Settings
  • Look for Strapi Advanced Sitemap in the settings menu

If you can see the plugin settings page, the installation was successful!

Step 1: Open the Admin Panel

Navigate to Settings → Strapi Advanced Sitemap in your Strapi admin panel.

Step 2: Configure Frontend Base URL

Set your site’s base URL (e.g., https://example.com). This will be used to resolve relative paths in your sitemaps.

Tip: This URL is used for previews and URL resolution. Make sure it matches your production domain.

Step 3: Create a Manual Sitemap

Add a manual sitemap to get started:

  • Click “Add Manual Sitemap”
  • Choose the sitemap type:
    • Single sitemap: For hand-curated URLs
    • Sitemap index: For aggregating multiple sitemap files
  • Configure the filename and base path
  • Add entries (URLs for single sitemap, or sitemap file links for index)
  • Click “Save changes”

Step 4: Create a Collection Sitemap (Optional)

Generate dynamic sitemaps from your collection types:

  • Click “Add Collection Sitemap”
  • Select a collection type
  • Define a URL pattern (e.g., /articles/[slug])
  • Configure metadata (frequency, priority, lastmod field)
  • Click “Save changes”

Note: Collection sitemaps only include published entries when Draft & Publish is enabled.

Step 5: Grant Permissions

Enable public access to your sitemaps:

  • Go to Settings → Users & Permissions → Roles
  • Select the Public role (or another role you want to grant access)
  • Find the Strapi Advanced Sitemap section
  • Enable the following actions:
    • serveRootSitemap
    • serveManualSitemapIndex
    • serveManualSitemapFile
    • serveCollectionSitemapFile
  • Click “Save”

Step 6: Access Your Sitemaps

Your sitemaps are now available at:

  • /sitemap.xml – Root sitemap index
  • /sitemaps/manual-sitemaps – Manual sitemap index (if configured)
  • /sitemaps/{filename}.xml – Individual manual sitemap files
  • /api/strapi-advanced-sitemap/collection-sitemaps/{id}.xml – Collection XML files

Success! Your sitemaps are now live and ready for search engines to crawl.

Next Steps