Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/admin-panel-customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ import HotReloading from '/docs/snippets/hot-reloading-admin-panel.md'

# Admin panel customization

> The admin panel can be tailored to match your branding, by editing `src/admin/app` and using an `extensions` folder to swap logos, favicon, locales, translations, themes, bundlers, or editors.
<br/>

The **front-end part of Strapi** <Annotation>For a clarification on the distinction between:<ul><li>the Strapi admin panel (front end of Strapi),</li><li>the Strapi server (back end of Strapi),</li><li>and the end-user-facing front end of a Strapi-powered application,</li></ul> refer to the [development introduction](/cms/customization).</Annotation> is called the admin panel. The admin panel presents a graphical user interface to help you structure and manage the content that will be accessible through the Content API. To get an overview of the admin panel, please refer to the [Getting Started > Admin panel](/cms/features/admin-panel) page.

From a developer point of view, Strapi's admin panel is a React-based single-page application that encapsulates all the features and installed plugins of a Strapi application.
Expand Down
5 changes: 5 additions & 0 deletions docusaurus/docs/cms/admin-panel-customization/bundlers.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ tags:

import FeedbackCallout from '/docs/snippets/backend-customization-feedback-cta.md'

# Admin panel bundlers

> Supported JavaScript bundlers influence builds and development flow.
<br/>

Strapi's [admin panel](/cms/admin-panel-customization) is a React-based single-page application that encapsulates all the features and installed plugins of a Strapi application. 2 different bundlers can be used with your Strapi 5 application, [Vite](#vite) (the default one) and [webpack](#webpack). Both bundlers can be configured to suit your needs.

:::info
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/admin-panel-customization/homepage.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ tags:
# Homepage customization
<VersionBadge version="5.13.0"/>

> The admin panel homepage displays default content and profile widgets and supports custom additions through the `app.widgets.register` API.
<br/>

The <Icon name="house" /> Homepage is the landing page of the Strapi admin panel. By default, it provides an overview of your content with 5 default widgets:

- _Last edited entries_: Displays recently modified content entries, including their content type, status, and when they were updated.
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/backend-customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ tags:

<div className="custom-mermaid-layout">

> Strapi’s back end is a Koa-based server where requests pass through global middlewares, routes, controllers, services, and models before the Document Service returns responses.
<br/>

:::strapi Disambiguation: Strapi back end
As a headless CMS, the Strapi software as a whole can be considered as the "back end" of your website or application.
But the Strapi software itself includes 2 different parts:
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/configurations/admin-panel.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ tags:

# Admin panel configuration

> Options in `/config/admin` let you tweak admin panel behavior and server settings, including custom URLs, host, and port.
<br/>

The `/config/admin` file is used to define the [admin panel](/cms/features/admin-panel) configuration for the Strapi application.

The present page acts as a reference for all the configuration parameters and values that you can find in the `/config/admin` file, grouped by topic. For additional information on how each feature works, please refer to links given in the introduction of each sub-section.
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/configurations/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ tags:

# API configuration

> `/config/api` centralizes response privacy and REST defaults such as prefix, pagination limits, and max request size.
<br/>

General settings for API calls can be set in the `./config/api.js` file:

| Property | Description | Type | Default |
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/configurations/cron.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ tags:

# Cron jobs

> Cron jobs schedule custom functions at specific times via `node-schedule`, activated through server config and optional task files.
<br/>

:::prerequisites
The `cron.enabled` configuration option should be set to `true` in the `./config/server.js` (or `./config/server.ts` for TypeScript projects) [file](/cms/configurations/server).
:::
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/configurations/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ import SupportedDatabases from '/docs/snippets/supported-databases.md'

# Database configuration

> `/config/database` defines connections, clients, and pooling for supported databases like SQLite, MySQL, and PostgreSQL.
<br/>

The `/config/database.js|ts` file is used to define database connections that will be used to store the application content.

:::strapi Supported databases
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/configurations/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ import SampleEnv from '/docs/snippets/sample-env.md'

# Environment configuration and variables

> Strapi-specific environment variables and `.env usage` enable per-environment configs, with `env()` helpers for casting values.
<br/>

Strapi provides specific environment variable names. Defining them in an environment file (e.g., `.env`) will make these variables and their values available in your code.

:::tip
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/configurations/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ tags:

# Features configuration

> Future flags in `/config/features` toggle experimental Strapi features, allowing early testing at your own risk.
<br/>

The `config/features.js|ts` file is used to enable feature flags. Currently this file only includes a `future` object used to enable experimental features through **future flags**.

Some incoming Strapi features are not yet ready to be shipped to all users, but Strapi still offers community users the opportunity to provide early feedback on these new features or changes. With these experimental features, developers have the flexibility to choose and integrate new features and changes into their Strapi applications as they become available in the current major version as well as assist us in shaping these new features.
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/configurations/functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ tags:

# Functions

> `src/index` hosts global register, bootstrap, and destroy functions to run logic during application lifecycle.
<br/>

<div className="dont_hide_secondary_bar">

The `./src/index.js` file (or `./src/index.ts` file in a [TypeScript-based](/cms/typescript) project) includes global [register](#register), [bootstrap](#bootstrap) and [destroy](#destroy) functions that can be used to add dynamic and logic-based configurations.
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/configurations/middlewares.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ import MiddlewareTypes from '/docs/snippets/middleware-types.md'

# Middlewares configuration

> `/config/middlewares` orders global middleware, enables custom names or resolves, and exposes built-in configuration options.
<br/>

<MiddlewareTypes />

The `./config/middlewares.js` file is used to define all the global middlewares that should be applied by the Strapi server.
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/configurations/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ tags:

# Plugins configuration

> `/config/plugins` enables or disables plugins and overrides their settings, with examples for local plugin development.
<br/>

Plugin configurations are stored in `/config/plugins.js|ts` (see [project structure](/cms/project-structure)). Each plugin can be configured with the following available parameters:

| Parameter | Description | Type |
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/configurations/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ tags:

# Server configuration

> `/config/server` manages host, port, URL, proxy, cron, and more; changes require rebuilding the admin panel.
<br/>

The `/config/server.js` file is used to define the server configuration for a Strapi application.

:::caution
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/configurations/typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ tags:

# TypeScript configuration

> TypeScript configuration explains the project’s tsconfig files, output directories, and an optional config/typescript.js|ts that auto-generates types on server restart. This documentation explains which folders store compiled code and how to toggle this experimental feature.
<br/>

[TypeScript](/cms/typescript)-enabled Strapi projects have a specific project structure and handle TypeScript project configuration through [`tsconfig.json` files](#project-structure-and-typescript-specific-configuration-files).

Strapi also has dedicated TypeScript features that are configured [in the `config/typescript.js|ts` file](#strapi-specific-configuration-for-typescript).
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/error-handling.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ tags:

# Error handling

> Strapi’s APIs return errors in a consistent structure and let backend code throw custom exceptions for controllers, services, policies, or lifecycles. This documentation lists error classes, context helpers, and examples for crafting meaningful responses.
<br/>

Strapi is natively handling errors with a standard format.

There are 2 use cases for error handling:
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/features/admin-panel.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ tags:

# Administration panel

> The admin panel acts as Strapi’s back office for managing content types, entries, and both administrator and end‑user accounts. This documentation gives an overview of the admin panel before focusing on profile settings that manage interface language and mode, login and personal information, and logo for branding.
<br/>

The admin panel is the back office of your Strapi application. From the admin panel, you will be able to manage content-types and write their actual content, but also manage users, both administrators and end users of your Strapi application.

<ThemedImage
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/features/api-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ tags:

# API Tokens

> API tokens provide scoped authentication for REST and GraphQL requests without exposing user credentials. This documentation explains token types, creation, expiration, and secure usage within the admin panel.
<br/>

API tokens allow users to authenticate REST and GraphQL API queries (see [APIs introduction](/cms/api/content-api)).

<IdentityCard>
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/features/audit-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ tags:

<VersionBadge version="4.6.0" />

> Audit Logs captures every administrative action in a searchable, filterable history to aid troubleshooting and compliance. In this documentation, examples show viewing payloads and filtering by user or date.
<br/>

The Audit Logs feature provides a searchable and filterable display of all activities performed by users of the Strapi application.

<IdentityCard>
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/features/content-history.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ tags:
# Content History
<GrowthBadge /> <EnterpriseBadge/> <VersionBadge version="5.0.0" />

> Content History stores previous document versions so editors can compare and restore earlier states from the Content Manager. This documentation explains how to browse and restore workflows for quick rollback of mistakes.
<br/>

The Content History feature, in the <Icon name="feather" /> Content Manager, gives you the ability to browse and restore previous versions of documents created with the [Content Manager](/cms/features/content-manager).

<IdentityCard>
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/features/content-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ import ScreenshotNumberReference from '/src/components/ScreenshotNumberReference

# Content Manager

> ...
<br/>

From the <Icon name="feather" /> Content Manager, accessible via the main navigation of the admin panel, users can write and manage their content.

<IdentityCard>
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/features/custom-fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ import CustomFieldRequiresPlugin from '/docs/snippets/custom-field-requires-plug

# Custom Fields

> Custom Fields extend Strapi with new field types that behave like native fields in the Content‑type Builder and Content Manager. Instructions in this documentation cover building or installing fields via plugins and registering them programmatically.
<br/>

Custom fields extend Strapi’s capabilities by adding new types of fields to content-types and components. Once created or added to Strapi via plugins, custom fields can be used in the Content-Type Builder and Content Manager just like built-in fields.

<IdentityCard>
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/features/data-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ tags:

# Data Management

> Data Management handles CLI-based import, export, and transfer of content between Strapi instances with partial configuration in the admin panel. Step-by-step commands and prerequisite settings explained in this documentation ensure safe migrations.
<br/>

The Data Management feature can be used to import, export, or transfer data. Data Management is CLI-based only, but is partly configured in the admin panel.

<IdentityCard>
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/features/draft-and-publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ tags:

# Draft & Publish

> Draft & Publish separates drafts from live entries, allowing editors to stage content before release. This documentation shows how to enable it per content type and manage publish or unpublish actions.
<br/>

The Draft & Publish feature allows to manage drafts for your content.

<IdentityCard>
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/features/email.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ tags:

# Email

> The Email feature sends transactional messages through local SMTP or external providers like SendGrid. Setup guidance in this documentation covers provider configuration and extending delivery via controllers or hooks.
<br/>

The Email feature enables Strapi applications to send emails from a server or an external provider.

<IdentityCard>
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/features/internationalization.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ tags:

# Internationalization (i18n)

> Internationalization manages content in multiple locales directly from the admin panel. This documentation explains how to add locales, translate entries, and control locale-specific permissions.
<br/>

The Internationalization feature allows to manage content in different languages, called "locales".

<IdentityCard>
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/features/media-library.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ import MediaLibraryProvidersList from '/docs/snippets/media-library-providers-li

# Media Library

> Media Library centralizes all uploaded assets with search, filters, and folder organization. This documentation includes provider options, upload workflows, and explanations on inserting media into content.
<br/>

The <Icon name="images" /> Media Library is the Strapi feature that displays all assets uploaded in the Strapi application and allows users to manage them.

<IdentityCard>
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/features/preview.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ tags:

# Preview

> Preview connects the Content Manager to your front end so editors can see changes before publishing. Configuration steps set preview URLs and explain Live Preview availability for higher plans.
<br/>

With the Preview feature, you can preview your front end application directly from Strapi's admin panel. This is helpful to see how updates to your content in the Edit View of the Content Manager will affect the final result.

<IdentityCard>
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/features/rbac.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ import ScreenshotNumberReference from '/src/components/ScreenshotNumberReference

# Role-Based Access Control (RBAC)

> Role-Based Access Control (RBAC) manages administrator roles and granular permissions in the admin panel. This documentation covers creating roles, assigning rights, and securing administrative workflows.
<br/>

The Role-Based Access Control (RBAC) feature allows the management of the administrators, who are the users of the admin panel. More specifically, RBAC manages the administrators' accounts and roles.

<IdentityCard>
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/features/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ tags:
# Releases
<GrowthBadge/>

> Releases group entries into publishable batches to trigger simultaneous publish or unpublish actions across content types and locales. Instructions in this documentation detail creating releases, adding entries, and understanding plan limitations.
<br/>

The Releases feature enables content managers to organize entries into containers that can perform publish and unpublish actions simultaneously. A release can contain entries from different content types and can mix locales.

<IdentityCard>
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/features/review-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ tags:
# Review Workflows
<EnterpriseBadge />

> Review Workflows define custom multi-stage pipelines for content review, facilitating collaboration from draft to publication. This documentation walks through creating workflows and assigning stages.
<br/>

The Review Workflows feature allows you to create and manage workflows for your various content-types. Each workflow can consist of any review stages for your content, enabling your team to collaborate in the content creation flow from draft to publication.

<IdentityCard>
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/features/sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ tags:
# Single Sign-On (SSO)
<EnterpriseBadge /> <SsoBadge />

> Single Sign-On (SSO) lets administrators authenticate via identity providers such as Azure AD instead of local passwords. Configuration steps in this documentation cover enabling SSO and mapping roles.
<br/>

The Single Sign-On (SSO) feature can be made available on a Strapi application to allow administrators to authenticate through an identity provider (e.g. Microsoft Azure Active Directory).

<IdentityCard>
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/features/users-permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ tags:

# Users & Permissions

> Users & Permissions manages end-user accounts, JWT-based authentication, and role-based access to APIs. This documentation explains how to create roles, configure permissions, and issue API tokens for secure access control.
<br/>

The Users & Permissions feature allows the management of the end-users <Annotation>💡 **What are end users?** <br/> End-users are the users who consume the content that is created and managed with a Strapi application and displayed on front-end applications (e.g. websites, mobile applications, connected devices etc.). Unlike the administrators, they do not have access to the admin panel.</Annotation> of a Strapi project. It provides a full authentication process based on JSON Web Tokens (JWT) to protect your API, and an access-control list (ACL) strategy that enables you to manage permissions between groups of users.

<IdentityCard>
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/plugins-development/admin-panel-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ tags:

# Admin Panel API for plugins

> The Admin Panel API exposes `register`, `bootstrap`, and `registerTrads` hooks to inject React components and translations into Strapi’s UI. Menu, settings, injection zone, reducer, and hook APIs let plugins add navigation, configuration panels, or custom actions.
<br/>

A Strapi plugin can interact with both the [back end](/cms/plugins-development/server-api) and the front end of a Strapi application. The Admin Panel API is about the front end part, i.e. it allows a plugin to customize Strapi's [admin panel](/cms/intro).

The admin panel is a <ExternalLink to="https://reactjs.org/" text="React"/> application that can embed other React applications. These other React applications are the admin parts of each Strapi plugin.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ tags:

# Content Manager APIs

> Content Manager APIs add panels and actions to list or edit views through `addEditViewSidePanel`, `addDocumentAction`, `addDocumentHeaderAction`, or `addBulkAction`. Each API accepts component functions with typed contexts, enabling precise control over document-aware UI injections.
<br/>

Content-Manager APIs are part of the [Admin Panel API](/cms/plugins-development/admin-panel-api). They are a way to add content or options from plugins to the [Content-Manager](/cms/features/content-manager), so you can extend the Content-Manager by adding functionality from your own plugin, just like you can do it with [Injection Zones](/cms/plugins-development/admin-panel-api#injection-zones-api).

Strapi 5 provides 4 Content-Manager APIs, all accessible through `app.getPlugin('content-manager').apis`:
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/plugins-development/create-a-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ tags:

# Plugin creation

> The Plugin SDK generates plugins without a Strapi project and links them to an existing app with `watch:link` and yalc. In this documentation: build and verify commands to bundle the plugin for npm or marketplace publishing, and information for monorepos and local setups.
<br/>

There are many ways to create a Strapi 5 plugin, but the fastest and recommended way is to use the Plugin SDK.

The Plugin SDK is a set of commands orientated around developing plugins to use them as local plugins or to publish them on NPM and/or submit them to the Marketplace.
Expand Down
Loading