Skip to content
Merged
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
6 changes: 5 additions & 1 deletion docusaurus/docs/cloud/account/account-billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@ tags:

import InvoiceStatus from '/docs/snippets/invoices-statuses.md'

# Account billing & invoices
# Account billing & invoices

<Tldr>
Billing details and invoices are managed on the Profile page, where payment methods are updated and invoice history is available.
</Tldr>

Through the *Profile* page, accessible by clicking on your profile picture on the top right hand corner of the interface then clicking on **Profile**, you can access the [<Icon name="credit-card" /> *Billing*](#account-billing) and [<Icon name="invoice" /> *Invoices*](#account-invoices) tabs.

Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/cloud/account/account-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ pagination_next: cloud/account/account-billing

# Profile settings

<Tldr>
Settings of the Profile page include account details, connected accounts, and account deletion options.
</Tldr>

The *Profile* page enables you to manage your account details and preferences. It is accessible by clicking on your profile picture, on the top right hand corner of the interface, and **Profile**.

There are 3 tabs available in the *Profile* interface: <Icon name="faders" /> [*General*](#general), <Icon name="credit-card" /> *Billing* and <Icon name="invoice" /> Invoices (the last 2 are documented in the [Account billing details](/cloud/account/account-billing) section of this documentation).
Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/cloud/advanced/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ pagination_next: cloud/advanced/email

# Database

<Tldr>
Default PostgreSQL can be swapped for any supported SQL database by aligning configuration and environment variables.
</Tldr>

Strapi Cloud provides a pre-configured PostgreSQL database by default. However, you can also configure it to utilize an external SQL database, if needed.

:::prerequisites
Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/cloud/advanced/email.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ tags:

# Email Provider

<Tldr>
Third‑party email services integrate through plugins and environment variables to replace the default sender.
</Tldr>

Strapi Cloud comes with a basic email provider out of the box. However, it can also be configured to utilize another email provider, if needed.

:::caution
Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/cloud/advanced/upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ tags:

# Upload Provider

<Tldr>
External storage like S3 or Cloudinary requires plugin setup, security middleware, and Cloud variables.
</Tldr>

Strapi Cloud comes with a local upload provider out of the box. However, it can also be configured to utilize a third-party upload provider, if needed.

:::caution
Expand Down
6 changes: 5 additions & 1 deletion docusaurus/docs/cloud/cli/cloud-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@ tags:
pagination_next: cloud/advanced/database
---

# Command Line Interface (CLI) <NewBadge />
# Command Line Interface (CLI)

<Tldr>
CLI commands handle login, project deploy, linking, listing, and logout without needing a remote repository.
</Tldr>

Strapi Cloud comes with a Command Line Interface (CLI) which allows you to log in and out, and to deploy a local project without it having to be hosted on a remote git repository. The CLI works with both the `yarn` and `npm` package managers.

Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/cloud/getting-started/caching.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ tags:

# Caching & Performance

<Tldr>
Edge caching via Cache-Control headers reduces latency and server load for heavy static content.
</Tldr>

For Strapi Cloud applications with large amounts of cacheable content, such as images, videos, and other static assets, enabling CDN (Content Delivery Network) caching via the <ExternalLink to="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control" text="`Cache-control` header"/> can help improve application performance.

CDN caching can help improve application performance in a few ways:
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/cloud/projects/collaboration.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ tags:

# Collaboration on projects

<Tldr>
Project owners invite maintainers through the Share button, manage pending invitations, and revoke access.
</Tldr>

Projects are created by a user via their Strapi Cloud account. Strapi Cloud users can share their projects to anyone else, so these new users can have access to the project dashboard and collaborate on that project, without the project owner to ever have to share their credentials.

Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/cloud/projects/deploys-history.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ tags:

# Deployment history and logs {#deploy-history-and-logs}

<Tldr>
Deployments tab lists every build with status and allows deep inspection of build and runtime logs.
</Tldr>

For each Strapi Cloud project, you can access the history of all deployments that occurred and their details including build and deployment logs. This information is available in the *Deployments* tab.

## Viewing the deployment history {#viewing-deploy-history}
Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/cloud/projects/deploys.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ pagination_next: cloud/projects/deploys-history

# Deployments management

<Tldr>
Deployment triggers can be manual or automatic on git pushes, with the ability to cancel active builds from dashboard or CLI.
</Tldr>

The creation of a new Strapi Cloud project automatically trigger the deployment of that project. After that, deployments can be:

- manually triggered whenever needed, [from the Cloud dashboard](#triggering-a-new-deployment) or [from the CLI](/cloud/cli/cloud-cli#strapi-deploy),
Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/cloud/projects/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ tags:

# Notifications

<Tldr>
Bell icon opens a feed of recent deployment events, automatically purged after 30 days.
</Tldr>

The Notification center can be opened by clicking the bell icon <Icon name="bell" /> in the top navigation of the Cloud dashboard.

It displays a list of the latest notifications for all your existing projects. Clicking on a notification card from the list will redirect you to the *Log details* page of the corresponding deployment (more information in [Deploy history & logs](/cloud/projects/deploys-history#accessing-deployment-details--logs)).
Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/cloud/projects/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ import ScreenshotNumberReference from '/src/components/ScreenshotNumberReference

# Projects overview

<Tldr>
Projects page lists all apps with status and quick actions; selecting one opens a dashboard with metrics and controls.
</Tldr>

The *Projects* page displays a list of all your Strapi Cloud projects. From here you can manage your projects and access the corresponding applications.

<ThemedImage
Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/cloud/projects/runtime-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ tags:

# Runtime logs

<Tldr>
Runtime logs tab streams live server output, though Free plan logs reset when apps scale to zero.
</Tldr>

From a chosen project's dashboard, the *Runtime logs* tab displays the live logs of the project.

:::note
Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/cloud/projects/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ import InvoiceStatus from '/docs/snippets/invoices-statuses.md'

# Project settings

<Tldr>
Settings area spans project-level controls (general, billing, plans, invoices) and per-environment configuration.
</Tldr>

From a chosen project's dashboard, the <Icon name="gear-six" /> **Settings** button, located in the header, enables you to manage the configurations and settings for your Strapi Cloud project and its environments.

The settings' menu on the left side of the interface is separated into 2 categories: the settings for the entire project and the settings specific to any configured environment for the project.
Expand Down
4 changes: 4 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,10 @@ import HotReloading from '/docs/snippets/hot-reloading-admin-panel.md'

# Admin panel customization

<Tldr>
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.
</Tldr>

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
4 changes: 4 additions & 0 deletions docusaurus/docs/cms/admin-panel-customization/bundlers.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ import FeedbackCallout from '/docs/snippets/backend-customization-feedback-cta.m

# Admin panel bundlers

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

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
4 changes: 4 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,10 @@ tags:
# Homepage customization
<VersionBadge version="5.13.0+" tooltip="Adding custom widgets is available since Strapi 5.13.0. The newest widgets (profile, entries, statistics) are available from Strapi 5.23.0."/>

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

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 @@ -20,6 +20,9 @@ tags:
<div className="custom-mermaid-layout">

# Backend customization
<Tldr>
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.
</Tldr>

:::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.
Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/cms/backend-customization/controllers.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ tags:

# Controllers

<Tldr>
Controllers bundle actions that handle business logic for each route within Strapi’s MVC pattern. This documentation demonstrates generating controllers, extending core ones with `createCoreController`, and delegating heavy logic to services.
</Tldr>

Controllers are JavaScript files that contain a set of methods, called actions, reached by the client according to the requested [route](/cms/backend-customization/routes). Whenever a client requests the route, the action performs the business logic code and sends back the [response](/cms/backend-customization/requests-responses). Controllers represent the C in the model-view-controller (MVC) pattern.

In most cases, the controllers will contain the bulk of a project's business logic. But as a controller's logic becomes more and more complicated, it's a good practice to use [services](/cms/backend-customization/services) to organize the code into re-usable parts.
Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/cms/backend-customization/middlewares.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ import MiddlewareTypes from '/docs/snippets/middleware-types.md'

# Middlewares customization

<Tldr>
Middlewares alter the request or response flow at application or API levels. This documentation distinguishes global versus route middlewares and illustrates custom implementations with generation patterns.
</Tldr>

<MiddlewareTypes />

<figure style={{width: '100%', margin: '0'}}>
Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/cms/backend-customization/models.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ tags:

# Models

<Tldr>
Models define Strapi’s content structure via content-types and reusable components. This documentation walks through creating these models in the Content-type Builder or CLI and managing schema files with optional lifecycle hooks.
</Tldr>

As Strapi is a headless Content Management System (CMS), creating a content structure for the content is one of the most important aspects of using the software. Models define a representation of the content structure.

There are 2 different types of models in Strapi:
Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/cms/backend-customization/policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ tags:

# Policies

<Tldr>
Policies execute before controllers to enforce authorization or other checks on routes. Instructions in this documentation cover generating global or scoped policies and wiring them into router configs.
</Tldr>

Policies are functions that execute specific logic on each request before it reaches the [controller](/cms/backend-customization/controllers). They are mostly used for securing business logic.

Each [route](/cms/backend-customization/routes) of a Strapi project can be associated to an array of policies. For example, a policy named `is-admin` could check that the request is sent by an admin user, and restrict access to critical routes.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ tags:

# Requests and Responses

<Tldr>
Koa’s context (`ctx`) carries request info, state, and response data through every Strapi endpoint. This documentation details `ctx.request`, `ctx.state`, and `ctx.response`, plus a helper for accessing context anywhere.
</Tldr>

The Strapi back end server is based on <ExternalLink to="https://koajs.com/" text="Koa"/>. When you send requests through the [REST API](/cms/api/rest), a context object (`ctx`) is passed to every element of the Strapi back end (e.g., [policies](/cms/backend-customization/policies), [controllers](/cms/backend-customization/controllers), [services](/cms/backend-customization/services)).

`ctx` includes 3 main objects:
Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/cms/backend-customization/routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ tags:

# Routes

<Tldr>
Routes map incoming URLs to controllers and ship pre-generated for each content type. This documentation shows how to add or customize core and custom routers and attach policies or middlewares for extra control.
</Tldr>

Requests sent to Strapi on any URL are handled by routes. By default, Strapi generates routes for all the content-types (see [REST API documentation](/cms/api/rest)). Routes can be [added](#implementation) and configured:

- with [policies](#policies), which are a way to block access to a route,
Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/cms/backend-customization/services.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ tags:

# Services

<Tldr>
Services store reusable functions to keep controllers concise and follow DRY principles. This documentation explains generating or extending services with `createCoreService` and organizing them for APIs or plugins.
</Tldr>

Services are a set of reusable functions. They are particularly useful to respect the "don’t repeat yourself" (DRY) programming concept and to simplify [controllers](/cms/backend-customization/controllers.md) logic.

<figure style={{width: '100%', margin: '0'}}>
Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/cms/backend-customization/webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ tags:

# Webhooks

<Tldr>
Webhooks let Strapi notify external systems when content changes, while omitting the Users type for privacy. Configuration in `config/server` sets default headers and endpoints to trigger third-party processing.
</Tldr>

Webhook is a construct used by an application to notify other applications that an event occurred. More precisely, webhook is a user-defined HTTP callback. Using a webhook is a good way to tell third-party providers to start some processing (CI, build, deployment ...).

The way a webhook works is by delivering information to a receiving application through HTTP requests (typically POST requests).
Expand Down
4 changes: 4 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,10 @@ tags:

# Admin panel configuration

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

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
4 changes: 4 additions & 0 deletions docusaurus/docs/cms/configurations/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ tags:

# API configuration

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

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

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

# Cron jobs

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

:::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
4 changes: 4 additions & 0 deletions docusaurus/docs/cms/configurations/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ import SupportedDatabases from '/docs/snippets/supported-databases.md'

# Database configuration

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

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
4 changes: 4 additions & 0 deletions docusaurus/docs/cms/configurations/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ import SampleEnv from '/docs/snippets/sample-env.md'

# Environment configuration and variables

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

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
4 changes: 4 additions & 0 deletions docusaurus/docs/cms/configurations/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ tags:

# Features configuration

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

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
4 changes: 4 additions & 0 deletions docusaurus/docs/cms/configurations/functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ tags:

# Functions

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

<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
4 changes: 4 additions & 0 deletions docusaurus/docs/cms/configurations/middlewares.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ import MiddlewareTypes from '/docs/snippets/middleware-types.md'

# Middlewares configuration

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

<MiddlewareTypes />

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

# Plugins configuration

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

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
4 changes: 4 additions & 0 deletions docusaurus/docs/cms/configurations/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ tags:

# Server configuration

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

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

:::caution
Expand Down
Loading
Loading