Webtools for Strapi

website·Indexed 32 days ago

https://docs.pluginpal.io/webtools

A plugin specifically designed for Strapi managed websites to handle URL aliases, dynamic URL patterns, and bulk URL generation. It includes a REST API for fetching content and premium addons for sitemap expansion, redirects, and dynamic link management.

Tokens
15.9K
Snippets
90
Records
156
Agent score
60%

What's inside Webtools

  1. Overview of Strapi Webtools Redirects Addon

    The Redirects plugin provides server-side redirect management for Strapi. It is an extension of the strapi-plugin-webtools and requires that the core Webtools plugin be installed and configured first. Key capabilities include:

    • Automatic Redirects: Automatically generates a redirect when a page's URL alias is changed.
    • Safety Checks: Built-in detection to prevent the creation of redirect chains and redirect loops.
    • Custom Redirects: Ability to create manual redirects independent of Webtools pages.
    • Frontend Integration: Provides a REST API to fetch redirect data for use in frontend applications.
  2. Overview of the Links add-on for Webtools Pro

    The Links add-on for Webtools Pro introduces a custom field type for Strapi CMS that enables content creators to easily create and manage internal links to other content entries, pages, or sections. Key capabilities include:

    • Internal Link Management: Simplified selection of internal content.
    • Custom Field Integration: The link field can be added to any content type.
    • CKEditor Integration: Dynamic links can be integrated directly into CKEditor.
    • Smart Search: Built-in search functionality to locate content quickly.
    • Broad Support: Compatible with all custom content types.
    • Strapi UI Integration: Uses a user-friendly interface consistent with Strapi's design system.
  3. Understand and use URL aliases for dynamic routing

    URL aliases allow each page within a specific collection type to be mapped to a unique URL path. These paths are configurable via the backend and are intended to be used in the website frontend to implement dynamic routing, ensuring that each collection item corresponds to a specific page on the site.
  4. Install and use the Breadcrumbs add-on for Webtools

    The Breadcrumbs add-on for Webtools generates a computed breadcrumbs trail in the API response based on the URL alias of a page. The trail is added as a relation and can be populated in the API response.

    Prerequisites: This plugin is an extension of strapi-plugin-webtools. You must install and configure the core strapi-plugin-webtools before installing the Breadcrumbs add-on.

    Key Capabilities:

    • Automatically generates breadcrumb trails based on URL aliases.
    • Allows breadcrumbs to be populated in API responses as a relation.
    • Supports configuration to overwrite the page title by selecting a specific title field.
  5. Manage large sitemaps with automatic splitting and indexing

    When a sitemap exceeds a specific threshold (default is 45,000 URLs), the plugin automatically splits it into separate sitemap chunks. To organize these, a sitemap index is created and made available at the default endpoint /api/sitemap/index.xml, which links to all individual sitemap chunks.
  6. Understand Webtools core functionality and addon architecture

    Webtools is a Strapi plugin designed to enhance website management workflows by maintaining a register of all URLs on a website to uniquely identify pages. This core registry serves as a foundation for other plugins (addons) to implement features such as sitemaps, menus, dynamic links, and redirects.

    Webtools addons are standalone Strapi plugins that require strapi-plugin-webtools as a peer dependency. They are installed using the standard Strapi plugin installation process.

  7. Recommended Webtools permission setups by role

    Depending on the user's responsibility, use these common permission combinations:

    • Content Editor: Enable 'URL Alias List' and 'Sidebar'. (Cannot modify patterns or access overview).
    • Senior Editor: Enable 'Overview', 'URL Alias List', and 'Sidebar'. (Cannot modify URL patterns).
    • Admin: Enable all permissions (Overview, URL Alias List, URL Patterns, and Sidebar).
    • Viewer: Enable 'URL Alias List' only (Read-only mode).
  8. Manage Redirects plugin permissions

    The Redirects addon provides the following granular permissions for admin roles:

    • Access the redirects plugin: Grants access to the redirects overview page at /plugins/webtools/redirects.
    • Create: Allows the creation of new redirect rules.
    • Read: Allows viewing existing redirect configurations.
    • Update: Allows editing existing redirect rules.
    • Delete: Allows removing redirect rules from the system.
  9. Handle peer dependency warnings during installation

    Multiple warnings about unmet peer dependencies may appear during the installation of Strapi Webtools. These warnings are normal and do not affect the functionality of the plugin; they can be safely ignored.
  10. Access public sitemap XML files

    The Sitemap addon exposes sitemap XML files publicly by default. These endpoints are automatically enabled for the Public role during bootstrap, so no manual permission configuration is required. The available endpoints are:

    • /sitemap.xml: The main sitemap or sitemap index.
    • /sitemap/[name].xml: Individual sitemaps (used when a sitemap index is configured).
  11. Sitemap plugin capabilities and features

    The Sitemap plugin for Strapi offers the following functionality:

    • Multilingual Support: Implements rel="alternate" using official Strapi i18n patterns.
    • Admin UI: Configuration of sitemaps directly via the Strapi admin interface.
    • URL Management: Support for URL bundles (grouping URLs by type), Custom URLs (for pages not managed in Strapi), and the ability to exclude specific URLs.
    • Sitemap Generation: Virtual sitemaps served from the database, paginated sitemap indexes for large datasets, and a CLI for manual generation.
    • Automation & Presentation: Scheduled cron jobs for automatic regeneration and XSL styling for human-readable XML output.
  12. Manage Webtools admin permission types

    The following permissions are available for the Webtools plugin in the Strapi admin panel:

    • Access the overview page: Grants access to the main Webtools overview page at /plugins/webtools.
    • Access the URL alias list: Allows viewing and managing all created URL aliases for content.
    • Access the URL alias patterns: Allows configuring URL pattern templates (listing, creating, and editing).
    • Access the URL alias sidebar: Displays the Webtools panel in the Content Manager sidebar during content editing.