diff --git a/docusaurus/docs/cloud/projects/settings.md b/docusaurus/docs/cloud/projects/settings.md index d8da5b4eec..282bb9d1a5 100644 --- a/docusaurus/docs/cloud/projects/settings.md +++ b/docusaurus/docs/cloud/projects/settings.md @@ -309,6 +309,7 @@ The *Configuration* tab for the environment-level setting - the Node version of the environment: to change the Node version of the project (see [Modifying Node version](#modifying-node-version)). - the app's internal name for the environment, which can be useful for debug & support purposes. - *Connected branch*: to change the branch of the GitHub repository used for your environment (see [Editing Git branch](#editing-git-branch)). Also allows to enable/disable the "deploy on push" option. +- *Environment data*: to transfer data from another environment within the same project (see [Transferring data between environments](#transferring-data-between-environments)). - *Danger zone*: to reset or permanently delete your Strapi Cloud project's environment (see [Resetting & Deleting environment](#resetting--deleting-environment)). + +The data transfer feature allows you to transfer the entire CMS content (database and assets) from one environment to another within the same Strapi Cloud project. This is useful for testing changes in a secondary environment with up-to-date production data, or for preparing and staging content in a secondary environment before taking it to production. + +Transferring data between environments currently comes with the following limitations: + +- You can only transfer toward a secondary environment (not the production environment). +- Only project owners can initiate and manage ongoing transfers. +- Transfers cannot be initiated on projects that are suspended. + +:::caution Data transfers are destructive +Transferring data to an environment will permanently overwrite all existing data and assets in the target environment. The source environment's data remains unaffected, and its CMS can be accessed during the transfer. Environment settings (such as variables and domains) are not affected by the transfer. +::: + +To transfer data to a secondary environment: + +1. Create and deploy both the source and target [environments](#environments). +1. In the *Environment data* section of the *Configuration* tab, click on the **Import data** button. +2. In the modal that opens, select the source environment from the dropdown list. Only fully created and deployed environments are available as sources. +3. Click on **Import data** to proceed, and follow the steps to confirm the transfer. +4. Once initiated, you will be redirected to the environment's dashboard where you can monitor the transfer's progress. Once the transfer is completed, the dashboard will refresh, showing both the ongoing and historic deployments. + +:::note +The CMS of the target environment will be inaccessible whilst the transfer is ongoing. You can cancel an ongoing transfer, but this will leave the target environment empty. If an error occurs during the transfer, you will have the option to retry or cancel. +::: + #### Resetting & Deleting environment You can reset or delete any additional environment of your Strapi Cloud project, but it will be permanent and irreversible. The default, production environment, can however not be neither reset nor deleted. diff --git a/docusaurus/static/img/assets/cloud/settings_env.png b/docusaurus/static/img/assets/cloud/settings_env.png index 333261dcb2..b7d802894d 100644 Binary files a/docusaurus/static/img/assets/cloud/settings_env.png and b/docusaurus/static/img/assets/cloud/settings_env.png differ diff --git a/docusaurus/static/img/assets/cloud/settings_env_DARK.png b/docusaurus/static/img/assets/cloud/settings_env_DARK.png index 01a0b32381..3244a3b44d 100644 Binary files a/docusaurus/static/img/assets/cloud/settings_env_DARK.png and b/docusaurus/static/img/assets/cloud/settings_env_DARK.png differ diff --git a/docusaurus/static/llms-full.txt b/docusaurus/static/llms-full.txt index 11666285ef..9223c79d1c 100644 --- a/docusaurus/static/llms-full.txt +++ b/docusaurus/static/llms-full.txt @@ -1155,6 +1155,7 @@ The *Configuration* tab for the environment-level settings enables you to check - the Node version of the environment: to change the Node version of the project (see [Modifying Node version](#modifying-node-version)). - the app's internal name for the environment, which can be useful for debug & support purposes. - *Connected branch*: to change the branch of the GitHub repository used for your environment (see [Editing Git branch](#editing-git-branch)). Also allows to enable/disable the "deploy on push" option. +- *Environment data*: to transfer data from another environment within the same project (see [Transferring data between environments](#transferring-data-between-environments)). - *Danger zone*: to reset or permanently delete your Strapi Cloud project's environment (see [Resetting & Deleting environment](#resetting--deleting-environment)). #### Modifying Node version @@ -1178,6 +1179,33 @@ The environment's Node version is based on the one chosen at the creation of the 3. Click on the **Save & deploy** button for the changes to take effect. +#### Transferring data between environments {#transferring-data-between-environments} + +The data transfer feature allows you to transfer the entire CMS content (database and assets) from one environment to another within the same project. This is useful for testing changes in a secondary environment with up-to-date production data, or for preparing and staging content in a secondary environment before taking it to production. + +This feature currently comes with the following limitations: + +- The feature is only available for transfers toward a secondary environment (not the production environment). +- Only project owners can initiate and manage ongoing transfers. +- Transfers cannot be initiated on projects that are suspended. + +:::caution Data transfers are destructive +Transferring data to an environment will permanently overwrite all existing data and assets in the target environment. The source environment's data remains unaffected, and its CMS can be accessed during the transfer. Environment settings (such as variables and domains) are not affected by the transfer. +::: + +:::prerequisites +- The source and target environments must be fully created and deployed. +::: + +1. In the *Environment data* section of the *Configuration* tab, click on the **Import data** button. +2. In the modal that opens, select the source environment from the dropdown list. Only fully created and deployed environments are available as sources. +3. Click on **Import data** to proceed, and follow the steps to confirm the transfer. +4. Once initiated, you will be redirected to the environment's dashboard where you can monitor the transfer's progress. Once the transfer is completed, the dashboard will refresh, showing both the ongoing and historic deployments. + +:::note +The CMS of the target environment will be inaccessible whilst the transfer is ongoing. You can cancel an ongoing transfer, but this will leave the target environment empty. If an error occurs during the transfer, you will have the option to retry or cancel. +::: + #### Resetting & Deleting environment You can reset or delete any additional environment of your Strapi Cloud project, but it will be permanent and irreversible. The default, production environment, can however not be neither reset nor deleted.