From ecba16cd5c039df93422c1da084d00a898c15355 Mon Sep 17 00:00:00 2001
From: Mateusz <2871798+orhtej2@users.noreply.github.com>
Date: Sun, 28 Jan 2024 23:40:59 +0100
Subject: [PATCH] Explain change_url a little bit.

---
 scripts/change_url | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/scripts/change_url b/scripts/change_url
index 235a1f2..b2c6c33 100644
--- a/scripts/change_url
+++ b/scripts/change_url
@@ -1,5 +1,9 @@
 #!/bin/bash
 
+## this script is only run if actual change to domain/path is detected, if you're here either $domain or $path changed
+## new location is available via $domain and $path (or $new_domain and $new_path variables if you want to be explicit)
+## old values are available via, you guessed it, $old_domain and $old_path
+
 #=================================================
 # GENERIC STARTING
 #=================================================
@@ -23,6 +27,7 @@ ynh_systemd_action --service_name="$app" --action="stop" --log_path="/var/log/$a
 #=================================================
 ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1
 
+# this will most likely adjust NGINX config correctly
 ynh_change_url_nginx_config
 
 #=================================================
@@ -31,6 +36,8 @@ ynh_change_url_nginx_config
 # ...
 #=================================================
 
+## do any changes to files that reference specific installation domain/path, i.e. regenerate configs etc
+
 #=================================================
 # GENERIC FINALISATION
 #=================================================