3pp-mirror/penpot
1
0
Fork 0
mirror of https://github.com/penpot/penpot.git synced 2025-08-07 14:38:33 +02:00
Code Issues Projects Releases Packages Wiki Activity

📚 Update documentation about components-v2 migration script

Browse source
This commit is contained in:
Andrey Antukh 2025-01-27 13:13:21 +01:00
parent 15f7fac8f4
commit 6c0954aae9
1 changed files with 13 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/technical-guide/getting-started.md
View file

@ -233,23 +233,26 @@ This will fetch the latest images. When you do <code class="language-bash">docke
**Important: Upgrade from version 1.x to 2.0** **Important: Upgrade from version 1.x to 2.0**
The migration to version 2.0, due to the incorporation of the new v2 The migration to version 2.0, due to the incorporation of the new v2 components, includes
components, includes an additional process that runs automatically as an additional process that runs automatically as soon as the application starts. If your
soon as the application starts. If your on-premises Penpot instance on-premises Penpot instance contains a significant amount of data (such as hundreds of
contains a significant amount of data (such as hundreds of penpot penpot files, especially those utilizing SVG components and assets extensively), this
files, especially those utilizing SVG components and assets process may take a few minutes.
extensively), this process may take a few minutes.
In some cases, such as when the script encounters an error, it may be In some cases, such as when the script encounters an error, it may be convenient to run
convenient to run the process manually. To do this, you can disable the process manually. To do this, you can disable the automatic migration process using
the automatic migration process using the <code class="language-bash">disable-v2-migration</code> flag the <code class="language-bash">disable-v2-migration</code> flag in <code
in <code class="language-bash">PENPOT_FLAGS</code> environment variable. You can then execute the class="language-bash">PENPOT_FLAGS</code> environment variable. You can then execute the
migration process manually with the following command: migration process manually with the following command:
```bash ```bash
docker exec -ti <container-name-or-id> ./run.sh app.migrations.v2 docker exec -ti <container-name-or-id> ./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 ### Backup Penpot