Strapi CMS

https://docs.strapi.io/cms/
Admin
Strapi CMS is an open-source headless content management system that allows developers to build,...
Tokens:313,237
Snippets:3,419
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Configure Windows start scripts

Source: https://docs.strapi.io/cms/deployment

Setup cross-env to handle production server startup on Windows systems.

```bash
npm install cross-env
```

```bash
"start:win": "cross-env NODE_ENV=production npm start",
```

```bash
npm run start:win
```

--------------------------------

### Start server with environment variables

Source: https://docs.strapi.io/cms/configurations/environment

Command line examples demonstrating how NODE_ENV and custom variables influence server startup.

```bash
yarn start                                   # uses host 127.0.0.1
NODE_ENV=production yarn start               # uses host defined in .env. If not defined, uses 0.0.0.0
HOST=10.0.0.1 NODE_ENV=production yarn start # uses host 10.0.0.1
```

--------------------------------

### Start the Strapi development server

Source: https://docs.strapi.io/cms/quick-start

Navigates into the project directory and launches the development server to finalize setup and access the admin panel.

```sh
cd my-strapi-project && npm run develop
```

--------------------------------

### Build and start the Strapi instance

Source: https://docs.strapi.io/cms/data-management/transfer

Compile and launch the Strapi server.

```bash
yarn build && yarn start
```

```bash
npm run build && npm run start
```

--------------------------------

### Install Strapi Client

Source: https://docs.strapi.io/cms/api/client

Install the library as a project dependency using common package managers.

```bash
yarn add @strapi/client
```

```bash
npm install @strapi/client
```

```bash
pnpm add @strapi/client
```

--------------------------------

### Define server configuration

Source: https://docs.strapi.io/cms/configurations/guides/access-configuration-values

Example configuration structure for the server file.

```js
  module.exports = {
    host: '0.0.0.0',
  };
```

```ts
  export default {
    host: '0.0.0.0',
  };
```

--------------------------------

### Install GraphQL Plugin

Source: https://docs.strapi.io/cms/api/graphql

Commands to install the GraphQL plugin via yarn or npm.

```sh
yarn add @strapi/plugin-graphql
```

```sh
npm install @strapi/plugin-graphql
```

--------------------------------

### Install Jest and Supertest

Source: https://docs.strapi.io/cms/testing

Install the necessary testing dependencies as development dependencies.

```bash
yarn add jest supertest --dev
```

```bash
npm install jest supertest --save-dev
```

--------------------------------

### Build and run containers

Source: https://docs.strapi.io/cms/installation/docker

Use this command to build and start the application containers in development.

```bash
docker compose up --build
```

--------------------------------

### Install Okta OAuth2 Strategy

Source: https://docs.strapi.io/cms/configurations/sso-providers/okta

Commands to install the required passport-okta-oauth20 dependency using yarn or npm.

```sh
yarn add passport-okta-oauth20
```

```sh
npm install --save passport-okta-oauth20
```

--------------------------------

### Install project dependencies

Source: https://docs.strapi.io/cms/data-management/transfer

Install dependencies for the cloned project using either yarn or npm.

```bash
cd <new-instance-name>
yarn install
```

```bash
cd <new-instance-name>
npm install
```

--------------------------------

### Set relation syntax examples

Source: https://docs.strapi.io/cms/api/rest/relations

Demonstrates the shorthand and longhand syntax for the set operation.

```text
set: ['z0y2x4w6v8u1t3s5r7q9onm', 'j9k8l7m6n5o4p3q2r1s0tuv']
```

```js
set: [{ documentId: 'z0y2x4w6v8u1t3s5r7q9onm' }, { documentId: 'j9k8l7m6n5o4p3q2r1s0tuv' }]
```

--------------------------------

### Install experimental Strapi version

Source: https://docs.strapi.io/cms/installation/cli

Use this command to install the latest experimental release of Strapi. Experimental builds are not recommended for production use.

```bash
npx create-strapi@experimental
```

--------------------------------

### Database environment variables

Source: https://docs.strapi.io/cms/configurations/database

Example environment variable configurations for different database types.

```bash
# Database
DATABASE_CLIENT=mysql
DATABASE_HOST=127.0.0.1
DATABASE_PORT=3306
DATABASE_NAME=strapi
DATABASE_USERNAME=strapi
DATABASE_PASSWORD=strap1
DATABASE_SSL=false
```

```bash
# Database
DATABASE_CLIENT=postgres
DATABASE_HOST=127.0.0.1
DATABASE_PORT=5432
DATABASE_NAME=strapi
DATABASE_USERNAME=strapi
DATABASE_PASSWORD=strapi
DATABASE_SSL=false
```

```bash
# Database
DATABASE_CLIENT=sqlite
DATABASE_FILENAME=.tmp/data.db
```

--------------------------------

### Launch the production server

Source: https://docs.strapi.io/cms/deployment

Commands to start the Strapi server in production mode.

```bash
NODE_ENV=production yarn start
```

```bash
NODE_ENV=production npm run start
```

--------------------------------

### Start Strapi Console

Source: https://docs.strapi.io/cms/cli

Launch the interactive REPL environment for the current Strapi application.

```bash
strapi console
```

--------------------------------

### Define environment variables

Source: https://docs.strapi.io/cms/deployment

Example of setting host and port variables in a .env file.

```text
HOST=10.0.0.1
PORT=1338
```

--------------------------------

### Database record example

Source: https://docs.strapi.io/cms/api/rest/relations

Initial state of the categories relation in the database.

```js
categories: [
  { documentId: 'j9k8l7m6n5o4p3q2r1s0tuv' }
  { documentId: 'z0y2x4w6v8u1t3s5r7q9onm' }
]
```

--------------------------------

### Using the Strapi-Response-Format Header

Source: https://docs.strapi.io/cms/migration/v4-to-v5/breaking-changes/new-response-format

Examples of how to include the compatibility header in various HTTP clients.

```bash
curl \
  -H 'Authorization: Bearer <token>' \
  -H 'Strapi-Response-Format: v4' \
  'https://api.example.com/api/articles?populate=category'
```

```js
await fetch('https://api.example.com/api/articles', {
  headers: {
    Authorization: `Bearer ${token}`,
    'Strapi-Response-Format': 'v4',
  },
});
```

```js
const client = axios.create({
  baseURL: 'https://api.example.com/api',
  headers: {
    Authorization: `Bearer ${token}`,
    'Strapi-Response-Format': 'v4',
  },
});

const articles = await client.get('/articles', { params: { populate: '*'} });
```

--------------------------------

### Install SQLite dependency

Source: https://docs.strapi.io/cms/configurations/database

Commands to manually add the better-sqlite3 package to an existing project.

```bash
yarn add better-sqlite3
```

```bash
npm install better-sqlite3
```

--------------------------------

### Get document response examples

Source: https://docs.strapi.io/cms/api/rest

Example JSON responses for successful document retrieval and 404 error cases.

```json
{
  "data": {
    "id": 6,
    "documentId": "znrlzntu9ei5onjvwfaalu2v",
    "Name": "Biscotte Restaurant",
    "Description": [
      {
        "type": "paragraph",
        "children": [{ "type": "text", "text": "Welcome to Biscotte restaurant! Restaurant Biscotte offers a cuisine based on fresh, quality products." }]
      }
    ],
    "createdAt": "2024-02-27T10:19:04.953Z",
    "updatedAt": "2024-03-05T15:52:05.591Z",
    "publishedAt": "2024-03-05T15:52:05.600Z",
    "locale": "en"
  },
  "meta": {}
}
```

```json
{
  "data": null,
  "error": {
    "status": 404,
    "name": "NotFoundError",
    "message": "Document not found"
  }
}
```

--------------------------------

### Define a custom route

Source: https://docs.strapi.io/cms/backend-customization/controllers

Example of a route configuration file mapping a GET request to a custom controller action.

```js
  routes: [
    {
      method: 'GET',
      path: '/hello',
      handler: 'api::hello.hello.index',
    }
  ]
}
```

--------------------------------

### Create a new Strapi project

Source: https://docs.strapi.io/cms/data-management/transfer

Initialize a new Strapi project using the quickstart template.

```bash
npx create-strapi-app@latest <project-name> --quickstart
```

--------------------------------

### GET /api/articles (Pagination by offset)

Source: https://docs.strapi.io/cms/api/rest/sort-pagination

Retrieve a subset of results by specifying the starting index and the number of entries to return.

```APIDOC
## GET /api/articles

### Description
Return a subset of entries using offset-based pagination.

### Method
GET

### Endpoint
/api/articles

### Parameters
#### Query Parameters
- **pagination[start]** (Integer) - Optional - Start value (Default: 0)
- **pagination[limit]** (Integer) - Optional - Number of entries to return (Default: 25)
- **pagination[withCount]** (Boolean) - Optional - Toggles displaying total number of entries (Default: True)

### Response
#### Success Response (200)
- **data** (Array) - List of entries
- **meta** (Object) - Pagination metadata including start, limit, and total
```

--------------------------------

### Create custom server entry point

Source: https://docs.strapi.io/cms/deployment

Use a custom server.js file to start the application directly with node.

```javascript
const strapi = require('@strapi/strapi');
strapi.createStrapi(/* {...} */).start();
```

--------------------------------

### Create Strapi project with SQLite

Source: https://docs.strapi.io/cms/configurations/database

Commands to initialize a new Strapi project using the quickstart SQLite configuration.

```bash
yarn create strapi-app my-project --quickstart
```

```bash
npx create-strapi-app@latest my-project --quickstart
```

--------------------------------

### Paginate by offset using cURL and JavaScript

Source: https://docs.strapi.io/cms/api/rest/sort-pagination

Examples for requesting entries using start and limit parameters with cURL and the qs library.

```bash
curl 'http://localhost:1337/api/articles?pagination[start]=0&pagination[limit]=10' \
  -H 'Authorization: Bearer <token>'
```

```js
const qs = require('qs');
const query = qs.stringify({
  pagination: {
    start: 0,
    limit: 10,
  },
}, {
  encodeValuesOnly: true, // prettify URL
});

await request(`/api/articles?${query}`);
```

--------------------------------

### Initialize a new plugin

Source: https://docs.strapi.io/cms/plugins-development/create-a-plugin

Run these commands in the parent directory to scaffold a new plugin project.

```bash
yarn dlx @strapi/sdk-plugin init my-strapi-plugin
```

```bash
npx @strapi/sdk-plugin init my-strapi-plugin
```

--------------------------------

### GET /api/articles Response with Populated Dynamic Zone

Source: https://docs.strapi.io/cms/api/rest/guides/understanding-populate

Example JSON response showing a populated dynamic zone containing related articles and CTA components.

```json
{
  "data": [
    {
      "id": 1,
      "documentId": "c14dwiff3b4os6gs4yyrag",
      "title": "Here's why you have to try basque cuisine, according to a basque chef",
      "slug": "here-s-why-you-have-to-try-basque-cuisine-according-to-a-basque-chef",
      "createdAt": "2021-11-09T13:33:19.948Z",
      "updatedAt": "2023-06-02T10:57:19.584Z",
      "publishedAt": "2022-09-22T09:30:00.208Z",
      "locale": "en",
      "ckeditor_content": "…",
      "blocks": [
        {
          "id": 2,
          "documentId": "lu16w9g4jri8ppiukg542j",
          "__component": "blocks.related-articles",
          "header": {
            "id": 2,
            "documentId": "c2imt19iywk27hl2ftph7s",
            "theme": "primary",
            "label": "More, I want more!",
            "title": "Similar articles"
          },
          "articles": {
            "data": [
              {
                "id": 2,
                "documentId": "isn91s2bxk3jib97evvjni",
                "title": "What are chinese hamburgers and why aren't you eating them?",
                "slug": "what-are-chinese-hamburgers-and-why-aren-t-you-eating-them",
                "createdAt": "2021-11-11T13:33:19.948Z",
                "updatedAt": "2023-06-01T14:32:50.984Z",
                "publishedAt": "2022-09-22T12:36:48.312Z",
                "locale": "en",
                "ckeditor_content": "…"
              },
              {
                "id": 3,
                "documentId": "yz6lg7tp5ph8dr79gidoyl",
                "title": "7 Places worth visiting for the food alone",
                "slug": "7-places-worth-visiting-for-the-food-alone",
                "createdAt": "2021-11-12T13:33:19.948Z",
                "updatedAt": "2023-06-02T11:30:00.075Z",
                "publishedAt": "2023-06-02T11:30:00.075Z",
                "locale": "en",
                "ckeditor_content": "…"
              },
              {
                "id": 4,
                "documentId": "z5jnfvyuj07fogzh1kcbd3",
                "title": "If you don't finish your plate in these countries, you might offend someone",
                "slug": "if-you-don-t-finish-your-plate-in-these-countries-you-might-offend-someone",
                "createdAt": "2021-11-15T13:33:19.948Z",
                "updatedAt": "2023-06-02T10:59:35.148Z",
                "publishedAt": "2022-09-22T12:35:53.899Z",
                "locale": "en",
                "ckeditor_content": "…"
              }
            ]
          }
        },
        {
          "id": 2,
          "documentId": "vpihrdqj5984k8ynrc39p0",
          "__component": "blocks.cta-command-line",
          "theme": "primary",
          "title": "Want to give a try to a Strapi starter?",
          "text": "❤️",
          "commandLine": "git clone https://github.com/strapi/nextjs-corporate-starter.git"
        }
      ]
    },
    {
      "id": 2,
      "// …": true
    },
    {
      "id": 3,
      "// …": true
    },
    {
      "id": 4,
      "// …": true
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pageSize": 25,
      "pageCount": 1,
      "total": 4
    }
  }
}
```

--------------------------------

### Test a basic API endpoint with Jest

Source: https://docs.strapi.io/cms/testing

Uses supertest to verify a GET request to a Strapi API endpoint. Requires setup and cleanup helpers to manage the Strapi instance lifecycle.

```js
const { setupStrapi, cleanupStrapi } = require('./strapi');
const request = require('supertest');

beforeAll(async () => {
  await setupStrapi();
});

afterAll(async () => {
  await cleanupStrapi();
});

it('should return hello world', async () => {
  await request(strapi.server.httpServer)
    .get('/api/hello')
    .expect(200)
    .then((data) => {
      expect(data.text).toBe('Hello World!');
    });
});
```

--------------------------------

### Create a basic migration file template

Source: https://docs.strapi.io/cms/database-migrations

Use this template as the starting point for any new migration file in the ./database/migrations directory.

```jsx
'use strict'

async function up(knex) {}

module.exports = { up };
```

--------------------------------

### Example .env file configuration

Source: https://docs.strapi.io/cms/configurations/environment

Standard configuration file containing active server, secret, and database environment variables.

```env
# Server
HOST=0.0.0.0
PORT=1337

# Secrets
APP_KEYS=appkeyvalue1,appkeyvalue2,appkeyvalue3,appkeyvalue4
API_TOKEN_SALT=anapitokensalt
ADMIN_JWT_SECRET=youradminjwtsecret
TRANSFER_TOKEN_SALT=transfertokensaltvalue
ENCRYPTION_KEY=yourencryptionkey

# Database
DATABASE_CLIENT=sqlite
DATABASE_HOST=
DATABASE_PORT=
DATABASE_NAME=
DATABASE_USERNAME=
DATABASE_PASSWORD=
DATABASE_SSL=false
DATABASE_FILENAME=.tmp/data.db
```

--------------------------------

### Example .env.example file

Source: https://docs.strapi.io/cms/configurations/environment

Template file generated by the Strapi CLI containing placeholders for security keys and server settings.

```env
HOST=0.0.0.0
PORT=1337
APP_KEYS="toBeModified1,toBeModified2"
API_TOKEN_SALT=tobemodified
ADMIN_JWT_SECRET=tobemodified
TRANSFER_TOKEN_SALT=tobemodified
JWT_SECRET=tobemodified
ENCRYPTION_KEY=tobemodified
```

--------------------------------

### Install passport-discord dependency

Source: https://docs.strapi.io/cms/configurations/sso-providers/discord

Commands to install the required passport-discord package using yarn or npm.

```sh
yarn add passport-discord
```

```sh
npm install --save passport-discord
```

--------------------------------

### Initialize a new Strapi project

Source: https://docs.strapi.io/cms/quick-start

Executes the installation script to scaffold a new project directory and initiate the Strapi Cloud account linking process.

```bash
npx create-strapi@latest my-strapi-project
```

--------------------------------

### Install Google SSO dependency

Source: https://docs.strapi.io/cms/configurations/sso-providers/google

Install the required passport-google-oauth2 package using yarn or npm.

```bash
yarn add passport-google-oauth2
```

```bash
npm install --save passport-google-oauth2
```

--------------------------------

### Full Server Configuration

Source: https://docs.strapi.io/cms/configurations/server

An example of a comprehensive configuration file including optional settings for sockets, proxies, cron jobs, and logging.

```js
module.exports = ({ env }) => ({
  host: env('HOST', '0.0.0.0'),
  port: env.int('PORT', 1337),
  app: {
    keys: env.array('APP_KEYS'),
  },
  socket: '/tmp/nginx.socket', // only use if absolutely required
  emitErrors: false,
  url: env('PUBLIC_URL', 'https://api.example.com'),
  proxy: { koa: env.bool('IS_PROXIED', true) },
  cron: {
    enabled: env.bool('CRON_ENABLED', false),
  },
  transfer: {
    remote: {
      enabled: false,
    },
  },
  webhooks: {
    populateRelations: false,
  },
  logger: {
    updates: {
      enabled: false,
    },
    startup: {
      enabled: false,
    },
  },
  // highlight-start
  openapi: {
    'content-api': {
      access: 'public',
    },
  },
  // highlight-end
});
```

```ts

  host: env('HOST', '0.0.0.0'),
  port: env.int('PORT', 1337),
  app: {
    keys: env.array('APP_KEYS'),
  },
  socket: '/tmp/nginx.socket', // only use if absolutely required
  emitErrors: false,
  url: env('PUBLIC_URL', 'https://api.example.com'),
  proxy: { koa: env.bool('IS_PROXIED', true) },
  cron: {
    enabled: env.bool('CRON_ENABLED', false),
  },
  transfer: {
    remote: {
      enabled: false,
    },
  },
  webhooks: {
    populateRelations: false,
  },
  logger: {
    updates: {
      enabled: false,
    },
    startup: {
      enabled: false,
    },
  },
  // highlight-start
  openapi: {
    'content-api': {
      access: 'public',
    },
  },
  // highlight-end
});
```

--------------------------------

### Install passport-github2 dependency

Source: https://docs.strapi.io/cms/configurations/sso-providers/github

Install the required passport-github2 package using either yarn or npm.

```sh
yarn add passport-github2
```

```sh
npm install --save passport-github2
```

--------------------------------

### Display Help Information

Source: https://docs.strapi.io/cms/upgrade-tool

Lists available commands and options for the upgrade tool.

```sh
$ npx @strapi/upgrade -h
Usage: upgrade <command> [options]

Options:
 -V, --version    output the version number
 -h, --help       Print command line options

Commands:
 latest [options]  Upgrade to the latest available version of Strapi
 major [options]   Upgrade to the next available major version of Strapi
 minor [options]   Upgrade to ...
 patch [options]   Upgrade to ...
to [options] <target> Upgrade to a specific version of Strapi
 help [command]    Print options for a specific command
```

```sh
$ npx @strapi/upgrade major -h
Usage: upgrade major [options]

Upgrade to the next available major version of Strapi

Options:
  -p, --project-path <project-path>  Path to the Strapi project
  -n, --dry                          Simulate the upgrade without updating any files (default: false)
  -d, --debug                        Get more logs in debug mode (default: false)
  -s, --silent                       Don't log anything (default: false)
  -h, --help                         Display help for command
  -y, --yes                          Automatically answer yes to every prompt
```

--------------------------------

### Install Cloudinary Provider

Source: https://docs.strapi.io/cms/configurations/media-library-providers/cloudinary

Commands to install the Cloudinary provider package using yarn or npm.

```bash
yarn add @strapi/provider-upload-cloudinary
```

```bash
npm install @strapi/provider-upload-cloudinary --save
```

--------------------------------

### View API Response Example

Source: https://docs.strapi.io/cms/getting-started

Example JSON response structure returned by the /api/restaurants endpoint.

```json
{
  "data": [  
    {  
      "id": 3,  
      "documentId": "wf7m1n3g8g22yr5k50hsryhk",  
      "Name": "Biscotte Restaurant",  
      "Description": [  
        {  
          "type": "paragraph",  
          "children": [  
            {  
              "type": "text",  
              "text": "Welcome to Biscotte restaurant! Restaurant Biscotte offers a cuisine based on fresh, quality products, often local, organic when possible, and always produced by passionate producers."
            }  
          ]  
        }  
      ],  
      "createdAt": "2024-09-10T12:49:32.350Z",  
      "updatedAt": "2024-09-10T13:14:18.275Z",  
      "publishedAt": "2024-09-10T13:14:18.280Z",  
      "locale": null  
    }  
  ],  
  "meta": {  
    "pagination": {  
      "page": 1,  
      "pageSize": 25,  
      "pageCount": 1,  
      "total": 1  
    }  
  }  
}
```

--------------------------------

### Full Admin Configuration

Source: https://docs.strapi.io/cms/configurations/admin-panel

An extended configuration example including AI settings, session lifespans, and custom URL paths.

```js
module.exports = ({ env }) => ({
  apiToken: {
    salt: env('API_TOKEN_SALT', 'someRandomLongString'),
    secrets: {
      encryptionKey: env('ENCRYPTION_KEY'),
    },
  },
  ai: {
    enabled: false, // use this to disable Strapi AI
  },
  auditLogs: { // only accessible with an Enterprise plan
    enabled: env.bool('AUDIT_LOGS_ENABLED', true),
    retentionDays: 120,
  },
  auth: {
    events: {
      onConnectionSuccess(e) {
        console.log(e.user, e.provider);
      },
      onConnectionError(e) {
        console.error(e.error, e.provider);
      },
    },
    options: {
      expiresIn: '7d',
    },
    secret: env('ADMIN_JWT_SECRET', 'someSecretKey'),
    sessions: {
      accessTokenLifespan: 1800, // 30 minutes
      maxRefreshTokenLifespan: 2592000, // 30 days
      idleRefreshTokenLifespan: 604800, // 7 days
      maxSessionLifespan: 604800, // 7 days
      idleSessionLifespan: 3600, // 1 hour
    },
    cookie: {
      domain: env('ADMIN_COOKIE_DOMAIN'),
      path: '/admin',
      sameSite: 'lax',
    },
  },
  url: env('PUBLIC_ADMIN_URL', '/dashboard'),
  autoOpen: false,
  watchIgnoreFiles: [
    './my-custom-folder', // Folder
    './scripts/someScript.sh', // File
  ],
  host: 'localhost',
  port: 8003,
  serveAdminPanel: env.bool('SERVE_ADMIN', true),
  forgotPassword: {
    from: 'no-reply@example.com',
    replyTo: 'no-reply@example.com',
  },
  rateLimit: {
    interval: { hour: 1, min: 30 },
    timeWait: 3*1000,
    max: 10,
  },
  transfer: { 
    token: { 
      salt: env('TRANSFER_TOKEN_SALT', 'anotherRandomLongString'),
    } 
  },
});
```

```ts

  apiToken: {
    salt: env('API_TOKEN_SALT', 'someRandomLongString'),
    secrets: {
      encryptionKey: env('ENCRYPTION_KEY'),
    },
  },
  ai: {
    enabled: false, // use this to disable Strapi AI
  },
  auditLogs: { // only accessible with an Enterprise plan
    enabled: env.bool('AUDIT_LOGS_ENABLED', true),
    retentionDays: 120,
  },
  auth: {
    events: {
      onConnectionSuccess(e) {
        console.log(e.user, e.provider);
      },
      onConnectionError(e) {
        console.error(e.error, e.provider);
      },
    },
    options: {
      expiresIn: '7d',
    },
    secret: env('ADMIN_JWT_SECRET', 'someSecretKey'),
    sessions: {
      accessTokenLifespan: 1800, // 30 minutes
      maxRefreshTokenLifespan: 2592000, // 30 days
      idleRefreshTokenLifespan: 604800, // 7 days
      maxSessionLifespan: 604800, // 7 days
      idleSessionLifespan: 3600, // 1 hour
    },
    cookie: {
      domain: env('ADMIN_COOKIE_DOMAIN'),
      path: '/admin',
      sameSite: 'lax',
    },
  },
  url: env('PUBLIC_ADMIN_URL', '/dashboard'),
  autoOpen: false,
  watchIgnoreFiles: [
    './my-custom-folder', // Folder
    './scripts/someScript.sh', // File
  ],
  host: 'localhost',
  port: 8003,
  serveAdminPanel: env.bool('SERVE_ADMIN', true),
  forgotPassword: {
    from: 'no-reply@example.com',
    replyTo: 'no-reply@example.com',
  },
  rateLimit: {
    interval: { hour: 1, min: 30 },
    timeWait: 3*1000,
    max: 10,
  },
  transfer: { 
    token: { 
      salt: env('TRANSFER_TOKEN_SALT', 'anotherRandomLongString'),
    } 
  },
});
```

--------------------------------

### Initialize a new plugin

Source: https://docs.strapi.io/cms/plugins-development/plugin-sdk

Creates a new plugin structure at the specified path.

```bash
npx @strapi/sdk-plugin init
```

--------------------------------

### Initialize Strapi Client in Browser

Source: https://docs.strapi.io/cms/api/client

Include the library via CDN and initialize the client using the global strapi object.

```html
<script src="https://cdn.jsdelivr.net/npm/@strapi/client"></script>

<script>
  const client = strapi.strapi({ baseURL: 'http://localhost:1337/api' });
</script>
```

--------------------------------

### Deep filtering response example

Source: https://docs.strapi.io/cms/api/rest/filters

Example JSON response structure returned by the deep filtering query.

```json
{
  "data": [
    {
      "id": 1,
      "documentId": "cvsz61qg33rtyv1qljb1nrtg",
      "name": "GORDON RAMSAY STEAK",
      "stars": 5
    },
    {
      "id": 2,
      "documentId": "uh17h7ibw0g8thit6ivi71d8",
      "name": "GORDON RAMSAY BURGER",
      "stars": 5
    }
  ],
  "meta": {}
}
```

--------------------------------

### Bootstrap a new project from a template

Source: https://docs.strapi.io/cms/templates

Use the CLI to initialize a new Strapi project based on a specified template.

```sh
yarn create strapi-app my-project --template <template-name-or-url>
```

```sh
npx create-strapi-app@latest my-project --template <template-name-or-url>
```

--------------------------------

### Install Microsoft SSO dependencies

Source: https://docs.strapi.io/cms/configurations/sso-providers/microsoft

Install the necessary packages for Microsoft SSO integration using yarn or npm.

```sh
yarn add passport-azure-ad-oauth2 jsonwebtoken
```

```sh
npm install --save passport-azure-ad-oauth2 jsonwebtoken
```

--------------------------------

### Install AWS S3 Provider

Source: https://docs.strapi.io/cms/configurations/media-library-providers

Commands to install the AWS S3 upload provider using Yarn or NPM.

```bash
yarn add @strapi/provider-upload-aws-s3
```

```bash
npm install @strapi/provider-upload-aws-s3 --save
```

--------------------------------

### Start Strapi in development mode

Source: https://docs.strapi.io/cms/cli

Starts the application with auto-reloading and file watching enabled. Use this command only during development.

```shell
strapi develop
options: [--bundler | --open | --no-watch-admin | --no-build-admin | --polling | --debug | --silent]
```

--------------------------------

### Initialize a Strapi project

Source: https://docs.strapi.io/cms/installation/cli

Commands to scaffold a new Strapi project using different package managers.

```bash
npx create-strapi@latest
```

```bash
pnpm create strapi
```

--------------------------------

### Paginate results using findMany

Source: https://docs.strapi.io/cms/api/document-service/sort-pagination

Control the number of returned results and the starting offset using limit and start parameters.

```js
const documents = await strapi.documents("api::article.article").findMany({
  limit: 10,
  start: 0,
});
```

```json
[
  {
    "documentId": "cjld2cjxh0000qzrmn831i7rn",
    "title": "Test Article",
    "slug": "test-article",
    "body": "Test 1"
  },
  {
    "documentId": "cjld2cjxh0001qzrm5q1j5q7m",
    "title": "Test Article 2",
    "slug": "test-article-2",
    "body": "Test 2"
  }
]
```

--------------------------------

### Launch Strapi Development Server

Source: https://docs.strapi.io/cms/quick-start

Commands to navigate to the project directory and start the development server.

```bash
cd my-strapi-project
npm run develop
```

```bash
npm run build
```

--------------------------------

### OpenAPI specification structure example

Source: https://docs.strapi.io/cms/api/openapi

A shortened example of the JSON structure generated by the Strapi OpenAPI tool, following the 3.1.0 standard.

```json
{
  "openapi": "3.1.0",
  "x-powered-by": "strapi",
  "x-strapi-version": "5.21.0",
  "info": {
    "title": "My Strapi API",
    "description": "API documentation for My Strapi API",
    "version": "1.0.0"
  },
  "paths": {
    "/api/articles": {
      "get": {
        "operationId": "article/get/articles",
        "parameters": [
          {
            "name": "fields",
            "in": "query",
            "schema": {
              "type": "array",
              "items": { "type": "string" }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": { "$ref": "#/components/schemas/Article" }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Article": {
        "type": "object",
        "properties": {
          "id": { "type": "string" },
          "title": { "type": "string" },
          "content": { "type": "string" }
        }
      }
    }
  }
}
```

--------------------------------

### Define a cron job with start and end times

Source: https://docs.strapi.io/cms/configurations/cron

Restrict the execution window of a cron job using start and end date properties.

```js
module.exports = {
  myJob: {
    task: ({ strapi }) => {
      /* Add your own logic here */
    },
    options: {
      rule: "* * * * * *",
      // start 10 seconds from now
      start: new Date(Date.now() + 10000),
      // end 20 seconds from now
      end: new Date(Date.now() + 20000),
    },
  },
};
```

```ts

  myJob: {
    task: ({ strapi }) => {
      /* Add your own logic here */
    },
    // only run once after 10 seconds
    options: {
      rule: "* * * * * *",
      // start 10 seconds from now
      start: new Date(Date.now() + 10000),
      // end 20 seconds from now
      end: new Date(Date.now() + 20000),
    },
  },
};
```

--------------------------------

### Initialize and push project to GitHub

Source: https://docs.strapi.io/cms/installation/cli

Commands to initialize a local Git repository and push the project code to a remote GitHub repository.

```bash
git init
```

```bash
git add .
```

```bash
git commit -m "Initial commit"
```

```bash
git remote add origin git@github.com:yourname/my-strapi-project.git
```

```bash
git push --set-upstream origin main
```

--------------------------------

### Start Strapi in development mode

Source: https://docs.strapi.io/cms/installation/cli

Executes the Strapi development server within the project directory.

```bash
npm run develop
```

--------------------------------

### Document Service middleware context examples

Source: https://docs.strapi.io/cms/api/document-service/middlewares

These examples illustrate the structure of the context object passed to a middleware, showing variations for different Document Service actions.

```javascript
{
  uid: "api::restaurant.restaurant",
  contentType: {
    kind: "collectionType",
    collectionName: "restaurants",
    info: {
      singularName: "restaurant",
      pluralName: "restaurants",
      displayName: "restaurant"
    },
    options: {
      draftAndPublish: true
    },
    pluginOptions: {},
    attributes: {
      name: { /*...*/ },
      description: { /*...*/ },
      createdAt: { /*...*/ },
      updatedAt: { /*...*/ },
      publishedAt: { /*...*/ },
      createdBy: { /*...*/ },
      updatedBy: { /*...*/ },
      locale: { /*...*/ },
    },
    apiName: "restaurant",
    globalId: "Restaurants",
    uid: "api::restaurant.restaurant",
    modelType: "contentType",
    modelName: "restaurant",
    actions: { /*...*/ },
    lifecycles: { /*...*/ },
  },
  action: "findOne",
  params: {
    documentId: 'hp7hjvrbt8rcgkmabntu0aoq',
    locale: undefined,
    status: "publish"
    populate: { /*...*/ },
  }
}
```

```javascript
{
  uid: "api::restaurant.restaurant",
  contentType: {
    kind: "collectionType",
    collectionName: "restaurants",
    info: {
      singularName: "restaurant",
      pluralName: "restaurants",
      displayName: "restaurant"
    },
    options: {
      draftAndPublish: true
    },
    pluginOptions: {},
    attributes: {
      name: { /*...*/ },
      description: { /*...*/ },
      createdAt: { /*...*/ },
      updatedAt: { /*...*/ },
      publishedAt: { /*...*/ },
      createdBy: { /*...*/ },
      updatedBy: { /*...*/ },
      locale: { /*...*/ },
    },
    apiName: "restaurant",
    globalId: "Restaurants",
    uid: "api::restaurant.restaurant",
    modelType: "contentType",
    modelName: "restaurant",
    actions: { /*...*/ },
    lifecycles: { /*...*/ },
  },
  action: "findMany",
  params: {
    filters: { /*...*/ },
    status: "draft",
    locale: null,
    fields: ['name', 'description'],
  }
}
```

--------------------------------

### Configure database with environment variables

Source: https://docs.strapi.io/cms/configurations/database

Example of a dynamic database configuration file that uses environment variables to switch between MySQL, Postgres, and SQLite.

```javascript
const path = require('path');

module.exports = ({ env }) => {
  const client = env('DATABASE_CLIENT', 'sqlite');

  const connections = {
    mysql: {
      connection: {
        connectionString: env('DATABASE_URL'),
        host: env('DATABASE_HOST', 'localhost'),
        port: env.int('DATABASE_PORT', 3306),
        database: env('DATABASE_NAME', 'strapi'),
        user: env('DATABASE_USERNAME', 'strapi'),
        password: env('DATABASE_PASSWORD', 'strapi'),
        ssl: env.bool('DATABASE_SSL', false) && {
          key: env('DATABASE_SSL_KEY', undefined),
          cert: env('DATABASE_SSL_CERT', undefined),
          ca: env('DATABASE_SSL_CA', undefined),
          capath: env('DATABASE_SSL_CAPATH', undefined),
          cipher: env('DATABASE_SSL_CIPHER', undefined),
          rejectUnauthorized: env.bool(
            'DATABASE_SSL_REJECT_UNAUTHORIZED',
            true
          ),
        },
      },
      pool: { min: env.int('DATABASE_POOL_MIN', 2), max: env.int('DATABASE_POOL_MAX', 10) },
    },
    postgres: {
      connection: {
        connectionString: env('DATABASE_URL'),
        host: env('DATABASE_HOST', 'localhost'),
        port: env.int('DATABASE_PORT', 3306),
        database: env('DATABASE_NAME', 'strapi'),
        user: env('DATABASE_USERNAME', 'strapi'),
        password: env('DATABASE_PASSWORD', 'strapi'),
        ssl: env.bool('DATABASE_SSL', false) && {
          key: env('DATABASE_SSL_KEY', undefined),
          cert: env('DATABASE_SSL_CERT', undefined),
          ca: env('DATABASE_SSL_CA', undefined),
          capath: env('DATABASE_SSL_CAPATH', undefined),
          cipher: env('DATABASE_SSL_CIPHER', undefined),
          rejectUnauthorized: env.bool(
            'DATABASE_SSL_REJECT_UNAUTHORIZED',
            true
          ),
        },
        schema: env('DATABASE_SCHEMA', 'public'),
      },
      pool: { min: env.int('DATABASE_POOL_MIN', 2), max: env.int('DATABASE_POOL_MAX', 10) },
    },
    sqlite: {
      connection: {
        filename: path.join(
          __dirname,
          '..',
          env('DATABASE_FILENAME', 'data.db')
        ),
      },
      useNullAsDefault: true,
    },
  };

  return {
    connection: {
      client,
      ...connections[client],
      acquireConnectionTimeout: env.int('DATABASE_CONNECTION_TIMEOUT', 60000),
    },
  };
};
```

--------------------------------

### GET /api/users/count

Source: https://docs.strapi.io/cms/features/users-permissions/rest-api

Returns the total number of users.

```APIDOC
## GET /api/users/count

### Description
Returns the total number of users. Supports the filters query parameter.

### Method
GET

### Endpoint
/api/users/count
```

--------------------------------

### GET /api/users/me

Source: https://docs.strapi.io/cms/features/users-permissions/rest-api

Returns the user associated with the provided JWT.

```APIDOC
## GET /api/users/me

### Description
Returns the user associated with the provided JWT. Requires authentication.

### Method
GET

### Endpoint
/api/users/me
```

--------------------------------

### Initialize Docker configuration with CLI

Source: https://docs.strapi.io/cms/installation/docker

Run this command within an existing Strapi project directory to generate a Dockerfile and docker-compose.yml.

```bash
npx @strapi-community/dockerize@latest
```

--------------------------------

### GET /api/upload/files

Source: https://docs.strapi.io/cms/api/rest/upload

Retrieve a list of files from the Media Library.

```APIDOC
## GET /api/upload/files

### Description
Get a list of files from the Media Library.

### Method
GET

### Endpoint
/api/upload/files
```

--------------------------------

### Initialize and clone a git repository

Source: https://docs.strapi.io/cms/data-management/transfer

Commands to prepare a project for cloning and to perform the clone operation.

```bash
git init
git add .
git commit -m "first commit"
```

```bash
cd .. # move to the parent directory
git clone <path to created git repository>.git/ <new-instance-name>
```

--------------------------------

### Fetch Components

Source: https://docs.strapi.io/cms/api/graphql

Example for fetching component attributes from a content type.

```APIDOC
## GraphQL Query: Fetch Components

### Description
Fetches specific attributes from components added to a content type.

### Query Example
```graphql
{
  restaurants {
    closingPeriod {
      label
      start_date
      end_date
    }
  }
}
```
```

--------------------------------

### Configure Documentation Plugin

Source: https://docs.strapi.io/cms/plugins/documentation

Example configuration file for defining OpenAPI metadata, servers, and plugin settings in the Strapi project.

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "DOCUMENTATION",
    "description": "",
    "termsOfService": "YOUR_TERMS_OF_SERVICE_URL",
    "contact": {
      "name": "TEAM",
      "email": "contact-email@something.io",
      "url": "mywebsite.io"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    }
  },
  "x-strapi-config": {
    "plugins": ["upload", "users-permissions"],
    "path": "/documentation"
  },
  "servers": [
    {
      "url": "http://localhost:1337/api",
      "description": "Development server"
    }
  ],
  "externalDocs": {
    "description": "Find out more",
    "url": "https://docs.strapi.io/developer-docs/latest/getting-started/introduction.html"
  },
  "security": [
    {
      "bearerAuth": []
    }
  ]
}
```

--------------------------------

### npx @strapi/sdk-plugin init

Source: https://docs.strapi.io/cms/plugins-development/plugin-sdk

Initializes a new Strapi plugin at the specified path.

```APIDOC
## npx @strapi/sdk-plugin init

### Description
Creates a new plugin at a given path.

### Arguments
- **path** (string) - Optional - Path to the plugin (Default: ./src/plugins/my-plugin)

### Options
- **-d, --debug** (boolean) - Optional - Enable debugging mode with verbose logs
- **--silent** (boolean) - Optional - Do not log anything
```

--------------------------------

### Create a role

Source: https://docs.strapi.io/cms/features/users-permissions/rest-api

Create a new role by providing a name, description, and type.

```bash
curl -X POST http://localhost:1337/api/users-permissions/roles \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -d '{"name": "Editor", "description": "Can edit content", "type": "editor"}'
```

--------------------------------

### Get Current Version

Source: https://docs.strapi.io/cms/upgrade-tool

Displays the current version of the upgrade tool.

```sh
$ npx @strapi/upgrade -V
4.15.1
```
Tokens:
Raw