Added documentation on configuration usage | refs #32373

global-conf.sh

@@ -10,6 +10,7 @@ ENVSETUP_BRANCH='stable'
 # Skyreach in which system looks for packages
 SKYREACH_HOST='mirismanager.ubicast.eu'
 SKYREACH_SSL_VERIFY='1'
+# ⚠ SKYREACH_API_KEY is used in ubicast-skyreach package at first installation
 SKYREACH_API_KEY=''
 SKYREACH_APT_TOKEN=''
 SKYREACH_ACTIVATION_KEY=''
@@ -17,6 +18,7 @@ SKYREACH_ACTIVATION_KEY=''
 NTP_SERVER='0.pool.ntp.org,1.pool.ntp.org,2.pool.ntp.org,3.pool.ntp.org'
 # SSH
 SSH_ALLOWED_KEYS=''
+# ⚠ SSH_MAINTENANCE_PORT is used in ubicast-monitor package postinst
 SSH_MAINTENANCE_PORT=''
 # SSL certificate
 SSL_CERTIFICATE='/etc/ssl/certs/ssl-cert-snakeoil.pem'
@@ -48,23 +50,36 @@ WOWZA_MANAGER_PWD='test'
 WOWZA_LICENSE=''
 
 # -- MediaServer --
+# ⚠ MS_SERVER_NAME is used in ubicast-mediaserver package when adding an instance
 MS_SERVER_NAME='mediaserver'
+# ⚠ MS_ID is used in ubicast-mediaserver package when adding an instance
 MS_ID='fX_msuser'
+# ⚠ MS_API_KEY is used in ubicast-mediaserver package when adding an instance
 # API key looks like: s00pN-aRseu-dnfMq-678CV-9nS9E
 MS_API_KEY=
+# ⚠ MS_SECRET is used in ubicast-mediaserver package when adding an instance
 MS_SECRET='secret'
+# ⚠ MS_SUPERUSER_PWD is used in ubicast-mediaserver package when adding an instance
 MS_SUPERUSER_PWD='test'
+# ⚠ MS_ADMIN_PWD is used in ubicast-mediaserver package when adding an instance
 MS_ADMIN_PWD='test'
 
 # -- Monitor --
+# ⚠ MONITOR_SERVER_NAME is used in ubicast-monitor package postinst
 MONITOR_SERVER_NAME='monitor'
-MONITOR_SUPERUSER_PWD='test'
-MONITOR_ADMIN_PWD='test'
+# ⚠ MONITOR_SUPERUSER_PWD is used in ubicast-monitor package postinst
+MONITOR_SUPERUSER_PWD=''
+# ⚠ MONITOR_ADMIN_PWD is used in ubicast-monitor package postinst
+MONITOR_ADMIN_PWD=''
+# ⚠ MONITOR_SHELL_PWD is used in ubicast-monitor package postinst
 MONITOR_SHELL_PWD=''
 
 # -- Miris Manager --
+# ⚠ CM_SERVER_NAME is used in ubicast-skyreach package postinst and in ubicast-mediaserver package when adding an instance
 CM_SERVER_NAME='mirismanager'
+# ⚠ CM_SUPERUSER_PWD is used in ubicast-skyreach package at first installation
 CM_SUPERUSER_PWD='test'
+# ⚠ CM_ADMIN_PWD is used in ubicast-skyreach package at first installation
 CM_ADMIN_PWD='test'
 
 # -- Cache server --
@@ -72,16 +87,22 @@ CACHE_SERVER_NAME=''
 CACHE_SOURCE=''
 
 # -- Database --
+# ⚠ DB_HOST is used in ubicast-mediaserver and ubicast-skyreach package postinst
 DB_HOST='127.0.0.1'
+# ⚠ DB_PORT is used in ubicast-mediaserver and ubicast-skyreach package postinst
 DB_PORT='5432'
+# ⚠ DB_PG_ROOT_PWD is used in ubicast-mediaserver and ubicast-skyreach package postinst
 # if no password is set, it will not be changed or set
 DB_PG_ROOT_PWD=''
 
 # -- Celerity --
+# ⚠ CELERITY_SIGNING_KEY is used in ubicast-mediaserver package when adding an instance
 CELERITY_SIGNING_KEY='test'
+# ⚠ CELERITY_SERVER is used in ubicast-mediaserver package when adding an instance
 CELERITY_SERVER='127.0.0.1'
+# ⚠ CELERITY_WORKER_IP is used in ubicast-mediaserver package when adding an instance
 # worker IP adresses, use commas to separate values
-CELERITY_WORKER_IP='127.0.1.1'
+CELERITY_WORKER_IP='127.0.0.1'
 
 # -- Network configuration --
 # applied with client configuration step