',
},
}
);
@@ -882,11 +921,11 @@ axios.post(
In production, make sure the `url` config property is set. Otherwise the validation link will redirect to `localhost`. More info on the config [here](/developer-docs/latest/setup-deployment-guides/configurations/required/server.md).
:::
-After having registered, if you have set **Enable email confirmation** to **ON**, the user will receive a confirmation link by email. The user has to click on it to validate his/her registration.
+After registering, if you have set **Enable email confirmation** to **ON**, the user will receive a confirmation link by email. The user has to click on it to validate their registration.
_Example of the confirmation link:_ `https://yourwebsite.com/api/auth/email-confirmation?confirmation=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MywiaWF0IjoxNTk0OTgxMTE3LCJleHAiOjE1OTc1NzMxMTd9.0WeB-mvuguMyr4eY8CypTZDkunR--vZYzZH6h6sChFg`
-If needed, you can re-send the confirmation email by making the following request.
+If needed you can re-send the confirmation email by making the following request:
```js
import axios from 'axios';
@@ -908,9 +947,7 @@ axios
The `user` object is available to successfully authenticated requests.
-#### Usage
-
-- The authenticated `user` object is a property of `ctx.state`.
+The authenticated `user` object is a property of `ctx.state`.
```js
create: async ctx => {
@@ -928,6 +965,8 @@ create: async ctx => {
};
```
+
+-->
## Templating emails
-By default, this plugin comes with only two templates (reset password and email address confirmation) at the moment. More templates will come later. The templates use Lodash's template() method to populate the variables.
+By default this plugin comes with two templates: reset password and email address confirmation. The templates use Lodash's `template()` method to populate the variables.
You can update these templates under **Plugins** > **Roles & Permissions** > **Email Templates** tab in the admin panel.
@@ -1075,7 +1113,9 @@ You can update these templates under **Plugins** > **Roles & Permissions** > **E
## Security configuration
-JWT tokens can be verified and trusted because the information is digitally signed. To sign a token a _secret_ is required. By default Strapi generates one that is stored in `./extensions/users-permissions/config/jwt.js`. This is useful during development but for security reasons it is **recommended** to set a custom token via an environment variable `JWT_SECRET` when deploying to production.
+JWTs can be verified and trusted because the information is digitally signed. To sign a token a _secret_ is required. By default Strapi generates and stores it in `./extensions/users-permissions/config/jwt.js`.
+
+This is useful during development but for security reasons it is **recommended** to set a custom token via an environment variable `JWT_SECRET` when deploying to production.
By default you can set a `JWT_SECRET` environment variable and it will be used as secret. If you want to use another variable you can update the configuration file.
@@ -1108,5 +1148,5 @@ export default {
::: tip
-You can learn more on configuration in the documentation [here](/developer-docs/latest/setup-deployment-guides/configurations.md).
+You can learn more about configuration [here](/developer-docs/latest/setup-deployment-guides/configurations.md).
:::
diff --git a/docs/developer-docs/latest/setup-deployment-guides/configurations/required/middlewares.md b/docs/developer-docs/latest/setup-deployment-guides/configurations/required/middlewares.md
index cde00eaaf6..95d5f7be50 100644
--- a/docs/developer-docs/latest/setup-deployment-guides/configurations/required/middlewares.md
+++ b/docs/developer-docs/latest/setup-deployment-guides/configurations/required/middlewares.md
@@ -177,7 +177,7 @@ For a full list of available options for `koa-body`, check the [koa-body documen
```js
// path: ./config/middlewares.js
-module.exports = {
+module.exports = [
// ...
{
name: 'strapi::body',
@@ -189,7 +189,7 @@ module.exports = {
},
},
// ...
-}
+]
```
:::
@@ -211,7 +211,7 @@ The `compression` middleware is based on [koa-compress](https://github.com/koajs
```js
// path: ./config/middlewares.js
-module.exports = {
+module.exports = [
// ...
{
name: 'strapi::compression',
@@ -220,7 +220,7 @@ module.exports = {
},
},
// ...
-}
+]
```
:::
@@ -243,7 +243,7 @@ This security middleware is about cross-origin resource sharing (CORS) and is ba
```js
// path: ./config/middlewares.js
-module.exports = {
+module.exports = [
// ...
{
name: 'strapi::cors',
@@ -255,7 +255,7 @@ module.exports = {
},
},
// ...
-}
+]
```
:::
@@ -280,7 +280,7 @@ The `favicon` middleware serves the favicon and is based on [koa-favicon](https:
```js
// path: ./config/middlewares.js
-module.exports = {
+module.exports = [
// ...
{
name: 'strapi::favicon',
@@ -289,7 +289,7 @@ module.exports = {
},
},
// ...
-}
+]
```
:::
@@ -312,7 +312,7 @@ The `whitelist` and `blacklist` options support wildcards (e.g. `whitelist: ['19
```js
// path: ./config/middlewares.js
-module.exports = {
+module.exports = [
// ...
{
name: 'strapi::ip',
@@ -322,7 +322,7 @@ module.exports = {
},
},
// ...
-}
+]
```
:::
@@ -345,7 +345,7 @@ const {
formats: { prettyPrint, levelFilter },
} = require('@strapi/logger');
-module.exports = {
+module.exports = [
transports: [
new winston.transports.Console({
level: 'http',
@@ -355,7 +355,7 @@ module.exports = {
),
}),
],
-};
+];
```
:::
@@ -373,7 +373,7 @@ The `poweredBy` middleware adds a `X-Powered-By` parameter to the response heade
```js
// path: ./config/middlewares.js
-module.exports = {
+module.exports = [
// ...
{
name: 'strapi::poweredBy',
@@ -382,7 +382,7 @@ module.exports = {
},
},
// ...
-}
+]
```
:::
@@ -402,7 +402,7 @@ The `query` middleware is a query parser based on [qs](https://github.com/ljharb
```js
// path: ./config/middlewares.js
-module.exports = {
+module.exports = [
// ...
{
name: 'strapi::query',
@@ -412,7 +412,7 @@ module.exports = {
},
},
// ...
-}
+]
```
:::
@@ -444,7 +444,7 @@ You can customize the path of the public folder by editing the [server configura
```js
// path: ./config/middlewares.js
-module.exports = {
+module.exports = [
// ...
{
name: 'strapi::public',
@@ -454,7 +454,7 @@ module.exports = {
},
},
// ...
-}
+]
```
:::
@@ -490,7 +490,7 @@ The default directives include a `dl.airtable.com` value. This value is set for
```js
// path: ./config/middlewares.js
-module.exports = {
+module.exports = [
// ...
{
name: 'strapi::security',
@@ -519,7 +519,7 @@ module.exports = {
},
},
// ...
-}
+]
```
:::
@@ -546,7 +546,7 @@ The `session` middleware allows the use of cookie-based sessions, based on [koa-
```js
// path: ./config/middlewares.js
-module.exports = {
+module.exports = [
// ...
{
name: 'strapi::session',
@@ -556,7 +556,7 @@ module.exports = {
},
},
// ...
-}
+]
```
:::
diff --git a/docs/developer-docs/latest/setup-deployment-guides/deployment.md b/docs/developer-docs/latest/setup-deployment-guides/deployment.md
index 376bb82761..290571b1f2 100644
--- a/docs/developer-docs/latest/setup-deployment-guides/deployment.md
+++ b/docs/developer-docs/latest/setup-deployment-guides/deployment.md
@@ -304,3 +304,16 @@ Additional guides for optional software additions that compliment or improve the
+
+
+
+
+
+ PM2
+
+ PM2 Process Manager
+
+ Overview of using the PM2 process manager with Strapi.
+
+
+
diff --git a/docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/process-manager.md b/docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/process-manager.md
new file mode 100644
index 0000000000..bef2c9ebe3
--- /dev/null
+++ b/docs/developer-docs/latest/setup-deployment-guides/deployment/optional-software/process-manager.md
@@ -0,0 +1,150 @@
+---
+title: Process Manager - Strapi Developer Docs
+description: How to install and start a Strapi application using a process manager.
+sidebarDepth: 2
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/guides/process-manager.html
+---
+
+# Process manager
+
+Process managers allow you to keep your Strapi application running and to reload it without downtime. The following documentation uses the [PM2](https://pm2.keymetrics.io/) process manager and describes:
+
+- installing PM2,
+- starting Strapi using a `server.js` file,
+- starting Strapi using the `strapi` command,
+- starting and managing Strapi using an `ecosystem.config.js` file.
+
+The appropriate procedure for starting PM2 depends on the hosting provider and your application configuration.
+
+## Install PM2
+
+Install PM2 globally:
+
+
+
+
+```sh
+yarn global add pm2
+```
+
+
+
+```sh
+npm install pm2 -g
+```
+
+
+
+
+## Start PM2 with a `server.js` file
+
+The basic usage to start an application with PM2 is to run a command such as `pm2 start server.js`. To configure and run your application:
+
+1. Create a `server.js` file at the application root.
+2. Add the following code snippet to the `server.js` file:
+
+
+
+
+ ```js
+ // path: `./server.js`
+
+ const strapi = require('@strapi/strapi');
+ strapi().start();
+ ```
+
+
+
+
+ ```js
+ // path: `./server.js`
+
+ const strapi = require('@strapi/strapi');
+ const app = strapi({ distDir: '' });
+ app.start();
+ ```
+
+
+
+
+3. Start the server by running `pm2 start server.js` in the project root directory.
+
+::: note
+TypeScript projects require additional code in the `server.js` file to identify the correct directory. See the previous TypeScript code example or the [TypeScript documentation](/developer-docs/latest/development/typescript.md#start-strapi-programmatically) for additional details.
+:::
+
+## Start PM2 with the `strapi` command
+
+To start PM2 and your application from a terminal you should start PM2 and pass the application name and start command as arguments:
+
+
+
+
+```sh
+pm2 start yarn --name app --start
+
+```
+
+
+
+
+
+```sh
+pm2 start npm --name app -- run start
+
+```
+
+
+
+
+## Start and configure PM2 with a `config.js` file
+
+A PM2 configuration file allows you to save the information necessary to start your server properly at any time. This is commonly used for cloud hosting providers, where you might not have access to a terminal window to start the server. To use a configuration file:
+
+1. Run `pm2 init` at the application root to create an `ecosystem.config.js` file.
+2. Replace the `ecosystem.config.js` file content with the following code example:
+
+
+
+
+
+ ```js
+ // path: ./ecosystem.config.js
+
+ module.exports = {
+ apps: [
+ {
+ name: 'app',
+ script: 'yarn',
+ args: 'start',
+ },
+ ],
+ };
+ ```
+
+
+
+
+
+ ```js
+ // path: ./ecosystem.config.js
+
+ module.exports = {
+ apps: [
+ {
+ name: 'app',
+ script: 'npm',
+ args: 'start',
+ },
+ ],
+ };
+ ```
+
+
+
+
+3. Run `pm2 start ecosystem.config.js` to start the PM2 process.
+
+::: note
+The `ecosystem.config.js` code example is the minimum configuration. The [PM2 ecosystem file documentation](https://pm2.keymetrics.io/docs/usage/application-declaration/) provides all of the configuration options.
+:::
diff --git a/docs/developer-docs/latest/update-migration-guides/migration-guides.md b/docs/developer-docs/latest/update-migration-guides/migration-guides.md
index 7696bf65de..d430e206a1 100644
--- a/docs/developer-docs/latest/update-migration-guides/migration-guides.md
+++ b/docs/developer-docs/latest/update-migration-guides/migration-guides.md
@@ -20,6 +20,7 @@ Migrations are necessary when upgrades to Strapi include breaking changes. The m
- [Migration guide from 4.1.8+ to 4.1.10](migration-guides/v4/migration-guide-4.1.8-to-4.1.10.md)
- [Migration guide from 4.2.x to 4.3.x](migration-guides/v4/migration-guide-4.2.x-to-4.3.x.md)
- [Migration guide from 4.3.6 to 4.3.8](migration-guides/v4/migration-guide-4.3.6-to-4.3.8.md)
+- [Migration guide from 4.4.3 to 4.4.5](migration-guides/v4/migration-guide-4.4.3-to-4.4.5.md)
## v3 to v4 migration guides
diff --git a/docs/developer-docs/latest/update-migration-guides/migration-guides/v4/code/frontend/theming.md b/docs/developer-docs/latest/update-migration-guides/migration-guides/v4/code/frontend/theming.md
index 3abbe22c02..1e30c900b8 100644
--- a/docs/developer-docs/latest/update-migration-guides/migration-guides/v4/code/frontend/theming.md
+++ b/docs/developer-docs/latest/update-migration-guides/migration-guides/v4/code/frontend/theming.md
@@ -18,7 +18,7 @@ Strapi v4 introduces the [Strapi Design System](https://design-system.strapi.io/
To customize the theme in Strapi v4:
1. Rename the `./src/admin/app.example.js` file to `./src/admin/app.js`.
-2. In `./src/admin/app.js`, declare new key/value pairs in the `config.theme` object, updating the design elements (e.g. colors, shadows, sizes) of the [default theme](https://github.com/strapi/design-system/blob/main/packages/strapi-design-system/src/themes/light-theme.js).
+2. In `./src/admin/app.js`, declare new key/value pairs in the `config.theme` object, updating the design elements (e.g. colors, shadows, sizes) of the [default theme](https://github.com/strapi/design-system/tree/main/packages/strapi-design-system/src/themes/lightTheme).
::: details Example of theme customization in Strapi v4:
@@ -37,6 +37,7 @@ export default {
:::
-::: tip Customization tip
-The [Strapi Design System](https://design-system.strapi.io/) is fully customizable.
+::: tip Customization tips
+* The [Strapi Design System](https://design-system.strapi.io/) is fully customizable.
+* Strapi v4 supports light and dark modes. See [admin customization](/developer-docs/latest/development/admin-customization.md#theme-extension) documentation for more details.
:::
diff --git a/docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.4.3-to-4.4.5.md b/docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.4.3-to-4.4.5.md
new file mode 100644
index 0000000000..161c92c1e8
--- /dev/null
+++ b/docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.4.3-to-4.4.5.md
@@ -0,0 +1,47 @@
+---
+title: Migrate from 4.4.3 to 4.3.5 - Strapi Developer Docs
+description: Learn how you can migrate your Strapi application from 4.4.3 to 4.4.5.
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.4.3-to-4.4.5.html
+---
+
+# v4.4.3 to v4.4.5 migration guide
+
+The Strapi v4.4.3 to v4.4.5 migration guide upgrades v4.4.3 to v4.4.5. The migration changes the name of the favicon from `favicon.ico` to `favicon.png`.
+
+:::caution
+This migration guide skips v4.4.4, which introduced a problem in `koa/cors` due to a missing dependency update.
+:::
+
+## Upgrading the application dependencies
+
+:::prerequisites
+Stop the server before starting the upgrade.
+:::
+
+1. Upgrade all of the Strapi packages in `package.json` to `4.4.5`:
+
+ ```json
+ // path: package.json
+
+ {
+ // ...
+ "dependencies": {
+ "@strapi/strapi": "4.4.5",
+ "@strapi/plugin-users-permissions": "4.4.5",
+ "@strapi/plugin-i18n": "4.4.5",
+ // ...
+ }
+ }
+ ```
+
+2. Save the edited `package.json` file.
+
+3. Replace the existing `favicon.ico` with [`favicon.png`](https://user-images.githubusercontent.com/8593673/198366643-7261700d-c8c4-4ebb-83c8-792a330ab4a5.png):
+
+4. Run either `yarn` or `npm install` to install the new version.
+
+::: tip
+If the operation doesn't work, try removing your `yarn.lock` or `package-lock.json`. If that doesn't help, remove the `node_modules` folder as well and try again.
+:::
+
+!!!include(developer-docs/latest/update-migration-guides/migration-guides/v4/snippets/Rebuild-and-start-snippet.md)!!!
diff --git a/docs/package.json b/docs/package.json
index 2c8302ff75..2e8b792a34 100644
--- a/docs/package.json
+++ b/docs/package.json
@@ -1,6 +1,6 @@
{
"name": "strapi-docs",
- "version": "4.4.4",
+ "version": "4.4.6",
"main": "index.js",
"scripts": {
"dev": "yarn create:config-file && vuepress dev",
diff --git a/docs/user-docs/latest/content-manager/saving-and-publishing-content.md b/docs/user-docs/latest/content-manager/saving-and-publishing-content.md
index 50041a724d..a072286219 100644
--- a/docs/user-docs/latest/content-manager/saving-and-publishing-content.md
+++ b/docs/user-docs/latest/content-manager/saving-and-publishing-content.md
@@ -32,6 +32,10 @@ When a content is not a draft anymore, but has been published, it is indicated o
+::: tip
+To schedule publication, i.e. convert a draft to a published entry at a given date and time, you can follow [this technical guide](https://forum.strapi.io/t/schedule-publications/23184) which requires adding custom code to the Strapi application.
+:::
+
### Unpublishing content
Published contents can be unpublished, switching back to being drafts again.
@@ -51,4 +55,4 @@ You can delete entries from the list view of a collection type, by clicking on t
::: caution
If the [Internationalization plugin](/user-docs/latest/plugins/strapi-plugins.md#internationalization-plugin) is installed, entries can only be deleted one locale at the time.
-:::
\ No newline at end of file
+:::
diff --git a/docs/user-docs/latest/content-types-builder/configuring-fields-content-type.md b/docs/user-docs/latest/content-types-builder/configuring-fields-content-type.md
index ff327ec9c6..0357edde79 100644
--- a/docs/user-docs/latest/content-types-builder/configuring-fields-content-type.md
+++ b/docs/user-docs/latest/content-types-builder/configuring-fields-content-type.md
@@ -395,12 +395,16 @@ The UID field displays a field that sets a unique identifier, optionally based o
::::
+::: tip
+The UID field can be used to create a slug based on the Attached field.
+:::
+
## Custom fields
Custom fields are a way to extend Strapi’s capabilities by adding new types of fields to content-types or components. Once installed (see [Marketplace](/user-docs/latest/plugins/installing-plugins-via-marketplace.md) documentation), custom fields are listed in the _Custom_ tab when selecting a field for a content-type.
-Each custom field type can have basic and advanced settings. The [Marketplace](https://market.strapi.io/) lists available custom fields, and hosts dedicated documentation for each custom field, including specific settings.
+Each custom field type can have basic and advanced settings. The [Marketplace](https://market.strapi.io/plugins?categories=Custom+fields) lists available custom fields, and hosts dedicated documentation for each custom field, including specific settings.
## 
Components
diff --git a/formatting_style_guide.pdf b/formatting_style_guide.pdf
new file mode 100644
index 0000000000..a60576ce84
Binary files /dev/null and b/formatting_style_guide.pdf differ