From 59b03654479c91aea091e9dae1bd3e4c57f11d08 Mon Sep 17 00:00:00 2001
From: PPawlowski <piotr@devopswizards.com>
Date: Sun, 24 Nov 2024 20:27:37 +0100
Subject: [PATCH] Adjust UPGRADE instruction

---
 UPGRADE.md | 24 +++++++++++++++++++-----
 1 file changed, 19 insertions(+), 5 deletions(-)

diff --git a/UPGRADE.md b/UPGRADE.md
index 45f7d00..77f4e83 100644
--- a/UPGRADE.md
+++ b/UPGRADE.md
@@ -45,6 +45,7 @@ This allows for easier management of the platform and better separation of conce
 3. **Move configurations to the new approach**
 
 * Copy content of `./etc/flowforge.yml` file to `docker-compose-new.yml` file, to `configs.flowfuse.content` section. Remove all commented lines. Maintain indentation.
+  * Make sure, that `broker.url` is seto fo `mqtt://broker:1883`. Update if needed.
 * Copy content of `./etc/flowforge-storage.yml` file to `docker-compose-new.yml` file, to `configs.flowfuse_storage.content` section. Remove all commented lines. Maintain indentation.
 * Set the `DOMAIN` variable in the `.env` file to the domain used by your instance of FlowFuse platform.
 * If custom certificates are used, copy their content to `.env` file, to `TLS_CERTIFICATE` and `TLS_KEY` variables. They should look like this:
@@ -90,19 +91,29 @@ This allows for easier management of the platform and better separation of conce
     docker run --rm -v flowfuse_db:/data -v $(pwd)/db:/backup alpine sh -c "cp -a /backup/. /data/"
     ```
 
-5. **Start FlowFuse**
+5. **Rename files**
+
+    In order to maintain the same file structurem, rename the compose files.
+
+    ```bash
+    mv docker-compose.yml docker-compose-old.yml
+    mv docker-compose-new.yml docker-compose.yml
+    mv docker-compose-tls.override.new.yml docker-compose-tls.override.yml
+    ```
+
+6. **Start FlowFuse**
 
     Start the new FlowFuse platform using the new Docker Compose file.
 
     * With automatic TLS certificate generation:
     ```bash
-    docker compose -f docker-compose-new.yml -f docker-compose-tls.new.override.yml --profile autossl -p flowfuse up -d
+    docker compose -f docker-compose.yml -f docker-compose-tls.override.yml --profile autossl -p flowfuse up -d
     ```
 
     * With custom TLS certificate:
 
     ```bash
-    docker compose -f docker-compose.new.yml -f docker-compose-tls..new.override.yml -p flowfuse up -d
+    docker compose -f docker-compose.yml -f docker-compose-tls.override.yml -p flowfuse up -d
     ```
 
     * In all other cases
@@ -110,12 +121,14 @@ This allows for easier management of the platform and better separation of conce
     ```bash
     docker compose -p flowfuse up -d
     ```
-6. **Verify the migration**
+
+7. **Verify the migration**
 
     Verify that the new FlowFuse platform is working correctly and it is accessible using the domain set in the `.env` file.
     Login credentials should remain the same as before the migration, as well as platform configuration.
+    Restart the Node-RED instances if they appear in `Starting` state.
 
-7. **Cleanup**
+8 **Cleanup**
   
     After verifying that the new FlowFuse platform is working correctly, you can remove the old configuration files.
 
@@ -123,5 +136,6 @@ This allows for easier management of the platform and better separation of conce
     rm ./etc/flowforge.yml ./etc/flowforge.yml.bak
     rm ./etc/flowforge-storage.yml.bak ./etc/flowforge-storage.yml
     rm -rf ./db ./db.bak
+    rm -f ./docker-compose-old.yml
     ```