From 6c0954aae97dc0245c42693cfc2f98e45bcde528 Mon Sep 17 00:00:00 2001 From: Andrey Antukh Date: Mon, 27 Jan 2025 13:13:21 +0100 Subject: [PATCH] :books: Update documentation about components-v2 migration script --- docs/technical-guide/getting-started.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/technical-guide/getting-started.md b/docs/technical-guide/getting-started.md index 2bfd96e05..88f0dbbdf 100644 --- a/docs/technical-guide/getting-started.md +++ b/docs/technical-guide/getting-started.md @@ -233,23 +233,26 @@ This will fetch the latest images. When you do docke **Important: Upgrade from version 1.x to 2.0** -The migration to version 2.0, due to the incorporation of the new v2 -components, includes an additional process that runs automatically as -soon as the application starts. If your on-premises Penpot instance -contains a significant amount of data (such as hundreds of penpot -files, especially those utilizing SVG components and assets -extensively), this process may take a few minutes. +The migration to version 2.0, due to the incorporation of the new v2 components, includes +an additional process that runs automatically as soon as the application starts. If your +on-premises Penpot instance contains a significant amount of data (such as hundreds of +penpot files, especially those utilizing SVG components and assets extensively), this +process may take a few minutes. -In some cases, such as when the script encounters an error, it may be -convenient to run the process manually. To do this, you can disable -the automatic migration process using the disable-v2-migration flag -in PENPOT_FLAGS environment variable. You can then execute the +In some cases, such as when the script encounters an error, it may be convenient to run +the process manually. To do this, you can disable the automatic migration process using +the disable-v2-migration flag in PENPOT_FLAGS environment variable. You can then execute the migration process manually with the following command: ```bash docker exec -ti ./run.sh app.migrations.v2 ``` +**IMPORTANT:** this script should be executed on passing from 1.19.x to 2.0.x. Executing +it on versions greater or equal to 2.1 of penpot will not work correctly. It is known that +this script is removed since 2.4.3 + ### Backup Penpot