Strapi Documentation

repository·main·Indexed 23 days ago

https://github.com/strapi/documentation

Official documentation for Strapi, a free and open-source headless CMS. This repository includes the Inki Claude Code plugin for end-to-end documentation lifecycles, featuring tools for research (/inki:research), writing (/inki:write), reviewing (/inki:review), and submitting (/inki:submit) content. It provides comprehensive authoring guides, templates, and a specialized prompts collection to ensure technical integrity, style compliance, and UX quality across CMS and Cloud documentation.

Tokens
314.5K
Snippets
642
Records
1.3K
Agent score
76%

What's inside strapi-documentation

  1. Overview of the Email feature

    main

    The Email feature allows Strapi applications to send transactional messages. You can send emails using a local SMTP server or through external providers such as SendGrid.

    Key Details:

    • Plan: Free feature
    • Activation: Available by default
    • Environment: Available in both Development and Production environments
    • Permissions: To send emails via the backend server, the user must have the Email > "send" permission.
  2. Overview of the Strapi Admin Panel

    main

    The Admin Panel is Strapi's back office used for managing content types, content entries, and both administrator and end-user accounts.

    Key Capabilities:

    • Content Management: Define content structures and write content.
    • User Management: Manage administrators and application end-users.
    • Homepage Customization: You can create custom widgets to personalize the homepage. The layout can be managed by:
      • Resizing: Dragging the divider in a two-widget row.
      • Reordering: Using the vertical dots button.
      • Deleting: Using the trash icon.
      • Restoring: Using the 'Add widget' button at the top of the page.
  3. Overview of the Media Library

    main

    The Media Library is a centralized feature in Strapi used to display and manage all assets uploaded to the application. It provides capabilities for searching, filtering, and organizing assets into folders.

    Key Details:

    • Plan: Available as a free feature.
    • Activation: Enabled and activated by default.
    • Environment: Works in both Development and Production environments.
    • Permissions: To use the Media Library, users must have at least the Access the Media Library permission, which is configured under Roles > Plugins - Upload.
  4. Introduction to Strapi 5

    main

    Strapi 5 is an open-source headless CMS designed for building custom applications and managing content through an extensible admin panel. It features built-in role-based access control (RBAC) and a plugin-based architecture that allows for extensive customization of both the admin panel and the API.

    Key components of the Strapi CMS include:

    • Content Manager: Used for managing content.
    • Content-type Builder: Used for defining the structure of your content.
    • Plugin System: Allows for extending the functionality of the admin panel and API.
    • User System: Manages detailed access permissions for administrators and end users.
  5. Overview of Strapi application configuration

    main

    Strapi applications are configured using files located in the /config folder. These files manage everything from core system settings to specific feature behaviors.

    Base Configurations

    The following files are located in the /config folder and are essential for the application to run:

    • config/database: Database connection settings (Required).
    • config/server: Server settings (Required).
    • config/admin: Admin panel settings (Required).
    • config/middlewares: Middleware settings (Required).

    Optional and Feature-Specific Configurations

    • config/api: General settings for REST responses and parameters (Optional).
    • config/plugins: Used to enable, configure, or disable plugins, including the Upload plugin and GraphQL (Optional/Required depending on use case).
    • config/typescript: Dedicated Strapi-specific TypeScript features (Required for efficient TypeScript usage).
    • config/features: Used to enable future feature flags (Optional).
    • /src/index: Used to define lifecycle functions like register, bootstrap, and destroy (Optional).
    • /config/server & cron-tasks: Used to enable and declare Cron jobs (Required for Cron usage).
  6. Overview of the Strapi REST API

    main

    Strapi automatically generates REST API endpoints for every Content-Type you create. These endpoints allow you to perform CRUD (Create, Read, Update, Delete) operations on your documents using standard HTTP methods.

    Key Behaviors:

    • Automatic Generation: Endpoints are created as soon as a content-type is defined.
    • Default Privacy: All content types are private by default. You must either make them public via the Roles & Permissions settings or authenticate requests using API tokens.
    • Default Response Payload: By default, responses only include top-level fields. Relations, media fields, components, and dynamic zones are not included unless you explicitly use the populate parameter.
    • Components: Note that Components do not have their own independent API endpoints; they are accessed through the content-type that contains them.
  7. Overview of Role-Based Access Control (RBAC)

    main

    Role-Based Access Control (RBAC) is a feature used to manage administrators (users of the admin panel). It allows you to manage administrator accounts and roles, providing granular permissions to secure administrative workflows.

    Key Details:

    • Plan: Free feature
    • Role & permission: Managed via CRUD permissions in Settings > Users & Roles
    • Activation: Available and activated by default
    • Environment: Available in both Development and Production environments
  8. Overview of the Admin Panel API for plugins

    main

    The Admin Panel API allows Strapi plugins to customize the React-based admin panel UI. Plugins interact with the front-end by providing an entry file that exports lifecycle hooks and configuration.

    Key capabilities include:

    • Injecting React components into the UI via injection zones.
    • Adding navigation links and settings sections.
    • Registering custom reducers for the Redux store.
    • Extending existing plugins or adding actions to the Content Manager.

    For back-end interactions, use the Server API.

  9. Overview of the Strapi Documentation Prompts Collection

    main
    The Prompts collection is a set of specialized, LLM-agnostic prompts designed to assist in reviewing and creating Strapi documentation. These prompts target specific quality dimensions such as structure, style, UX, and technical integrity. They can be used as standalone tools or combined into structured workflows for either reviewing existing content or creating new documentation.
  10. Default Homepage widgets in Strapi

    main

    By default, the Strapi Admin Panel Homepage includes several widgets to provide content overviews:

    • Last edited entries: Shows recently modified content, including content type, status, and update timestamp.
    • Last published entries: Provides quick access to recently published content.
    • Profile: Displays your name, email address, and role.
    • Entries: Shows the total count of Draft & Published entries.
    • Project statistics: Displays metrics for entries, content-types, locales, assets, etc.
    • Deploy: Provides a Deploy Now button linking to Strapi Cloud. Note: This widget is only visible in local development and is hidden in production environments.
  11. Understand Strapi Cloud fundamentals

    main

    Strapi Cloud is a Platform-as-a-Service (PaaS) hosting platform designed for deploying existing Strapi CMS projects. It is not a SaaS version of the CMS, but rather a hosting environment for it.

    Key concepts include:

    • Pricing Plans: There are three plans: Starter, Pro, and Business. Features in the documentation are often marked with <CloudProBadge /> or <CloudBusinessBadge /> to indicate they require those specific plans.
    • User Roles:
      • Owners: The creators of the project with full access to all features and options.
      • Maintainers: Invited users who contribute to a project but have restricted access to certain dashboard features.
    • Support Levels: Support availability depends on your plan. Starter and Pro plans receive Basic support, while the Business plan includes Standard support.
  12. Compare Strapi Cloud pricing plans

    main

    Strapi Cloud offers three plans: Starter, Pro, and Business. Pricing is based on usage of API requests, asset storage, and bandwidth.

    FeatureStarterProBusiness
    Database EntriesUnlimited*Unlimited*Unlimited*
    Asset Storage50GB250GB1,000GB
    Asset Bandwidth (per month)50GB500GB1,000GB
    API Requests (per month)100,0001,000,00010,000,000
    BackupsN/AWeeklyDaily
    Custom domainsIncludedIncludedIncluded
    EnvironmentsN/A0 included (up to 99 extra)1 included (up to 99 extra)
    Emails (per month)Unlimited*Unlimited*Unlimited*

    Usage Definitions:

    • Database entries: Total number of entries in your database.
    • Asset storage: Total storage used by your assets.
    • Asset bandwidth: Total bandwidth used by your assets.
    • API requests: Total number of requests made to GraphQL and REST APIs. This excludes requests for file and media assets (which are counted via CDN bandwidth/storage). All API requests are counted regardless of response type.