Merge remote-tracking branch 'origin/ticket52' into stg-2.409

[stg.git] / projects / sgauth / sgauth.conf

diff --git a/projects/sgauth/sgauth.conf b/projects/sgauth/sgauth.conf
index 1b7d4356661063866a2e77f5abc826699719a3e1..bb5fca32d4472d6e1a4f47d564274d522c8f5929 100644 (file)
--- a/projects/sgauth/sgauth.conf
+++ b/projects/sgauth/sgauth.conf
@@ -1,37 +1,78 @@
-#Stargazer server ip
-ServerName=192.168.1.2
+################################################################################
+#                           Sgauth Configuration file                          #
+################################################################################
 
-#Stargazer server port
-#Default value 5555
-ServerPort=5555
+# Stargazer server
+# Parameter: required
+# Values: IP address or DNS name
+# Default:
+ServerName = 192.168.1.2
 
-#User's login
-Login=test
+# Port on which Stargazer interacts with sgauth
+# Parameter: optional
+# Value: 1 ... 65535
+# Default: 5555
+ServerPort = 5555
 
-#
-#
-LocalPort=12345
+# User's login in Stargazer
+# Parameter: required
+# Value: any
+# Default:
+Login = test
 
-#User's password
-Password=1234567
+# Local host to bind
+# Parameter: optional
+# Values: IP address or DNS name
+# Default: 0.0.0.0
+LocalName = localhost
 
-#
-#Default value yes
-#Reconnect=no
+# Port on which sgauth interacts with Stargazer
+# Parameter: optional
+# Value: 1 ... 65535
+# Default: 0
+LocalPort = 12345
 
-#
-#Default value yes
-#Daemon=yes
+# User's password in Stargazer
+# Parameter: required
+# Value: any
+# Default:
+Password = 123456
 
-#Refresh web page period
-#Default value 10
-#RefreshPeriod=10
+# Defines whether sgauth should try to reestablish connection to Stargazer
+# if it was lost
+# Parameter: optional
+# Value: yes, no
+# Default: yes
+Reconnect = yes
 
-#
-#Default value 127.0.0.1
-ListenWebIP=0.0.0.0
+# Defines whether sgauth should run as daemon
+# Parameter: optional
+# Value: yes, no
+# Default: yes
+Daemon = yes
 
-#Default value no
-DisableWeb=no
+# Web-page refresh period in built-in webserver
+# Parameter: optional
+# Value: any numeric (minutes)
+# Default: 10
+RefreshPeriod = 10
 
-#ShowPid=no
+# Defines whether sgauth should use built-in webserver
+# Parameter: optional
+# Value: yes, no
+# Default: no
+DisableWeb = no
+
+# Defines address on which sgauth's built-in webserver will listen
+# Parameter: optional
+# Value: IP address or DNS name
+# Default: 127.0.0.1
+ListenWebIP = 127.0.0.1
+
+# Defines whether sgauth should show its process ID
+# Parameter: optional
+# Value: yes, no
+# Default: no
+ShowPid = no
+
+################################################################################