Skip to content

Commit 06235e7

Browse files
committed
Merge branch 'compose-admonition' into 'master'
added a warning message about updating compose files See merge request CodeScoring/docs!658
2 parents f5e25e3 + 27ba6a1 commit 06235e7

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

docs/on-premise/update.en.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ hide:
1010
!!! warning "Backup"
1111
Before performing an update, make sure to create a full backup of the platform.
1212

13-
To update the system, you need the latest versions of the following files: `docker-compose.yml`, `external-db.override.yml`, `app.env`, and `.env`, which can be obtained from the vendor.
13+
!!! warning "Update the compose files before starting a new version"
14+
Changing only the `CODESCORING_VERSION` value in `.env` is not enough. Before the update, make sure to replace `docker-compose.yml`, `external-db.override.yml`, `app.env`, and `.env` with the latest versions provided by the vendor. If old compose files are left in place, the platform may start with an incomplete or incorrect configuration.
1415

1516
In the `.env` file, the variable `CODESCORING_VERSION` specifies the target platform version.
1617
The latest available version can be found in the [Changelog](/changelog/on-premise-changelog.en).
@@ -87,4 +88,4 @@ Before upgrading, you must ensure that the `.env` file specifies the correct (**
8788
- You must enter this value in the `.env` file with the key `COMPOSE_PROJECT_NAME=`
8889
- **IMPORTANT!** If you do not do this, the platform will not start. If you enter an incorrect value, volumes with a new prefix will be created, and the platform on the new version will start "from scratch"
8990
- After the value is added to the `.env` file, requests to `docker compose` can be made without the `-p PROJECT_NAME` option
90-
- You need to download the updated `docker-compose.yml` and `external-db.override.yml` files from the CodeScoring registry and place them in the directory with the compose file.
91+
- You need to download the updated `docker-compose.yml` and `external-db.override.yml` files from the CodeScoring registry and place them in the directory with the compose file.

docs/on-premise/update.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ hide:
1010
!!! warning "Резервное копирование"
1111
Перед обновлением обязательно выполните резервное копирование платформы.
1212

13-
Для обновления необходимо иметь актуальные версии файлов `docker-compose.yml`, `external-db.override.yml`, `app.env` и `.env`, которые можно получить у вендора.
13+
!!! warning "Обновите compose-файлы перед запуском новой версии"
14+
Недостаточно изменить только значение `CODESCORING_VERSION` в `.env`. Перед обновлением обязательно замените `docker-compose.yml`, `external-db.override.yml`, `app.env` и `.env` на актуальные версии, полученные у вендора. Если оставить старые compose-файлы, платформа может запуститься с неполной или некорректной конфигурацией.
1415

1516
В переменной `CODESCORING_VERSION` внутри файла `.env` указывается требуемая версия системы. Актуальную версию можно узнать в разделе [Changelog](/changelog/on-premise-changelog).
1617

0 commit comments

Comments
 (0)