Split SETTINGS to interface and implementation

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

diff --git a/projects/convertor/convertor.conf b/projects/convertor/convertor.conf
index d2405adf11df924f7a31e362c217bec45677a35b..41e18b6823f087e3b7755b08822b997703f8b882 100644 (file)
--- a/projects/convertor/convertor.conf
+++ b/projects/convertor/convertor.conf
@@ -1,66 +1,124 @@
 ################################################################################
 ################################################################################

-#                        æÁÊÌ ÎÁÓÔÒÏÅË ËÏÎ×ÅÒÔÏÒÁ stargazer                    #
+#                   Stargazer Convertor Configuration file                     #

 ################################################################################
 
 ################################################################################
 

-# ðÕÔØ Ë ÄÉÒÅËÔÏÒÉÉ, × ËÏÔÏÒÏÊ ÎÁÈÏÄÑÔÓÑ ÍÏÄÕÌÉ ÓÅÒ×ÅÒÁ
-ModulesPath = ../stargazer/modules
+# The path to directory with server modules
+# Parameter: required
+# Value: directory path
+# Default: /usr/lib/stg
+ModulesPath = /usr/lib/stg

 
 

-################################################################################
-# Store module
-# îÁÓÔÒÏÊËÉ ÐÌÁÇÉÎÁ ÒÁÂÏÔÁÀÝÅÇÏ Ó âä ÓÅÒ×ÅÒÁ
-
-# ÷ÔÏÒÏÊ ÐÁÒÁÍÅÔÒ - ÜÔÏ ÉÍÑ ÍÏÄÕÌÑ ÂÅÚ mod_ × ÎÁÞÁÌÅ É .so × ËÏÎÃÅ
-# ô.Å. ÐÏÌÎÏÅ ÉÍÑ ÍÏÄÕÌÑ mod_store_files.so
+#################################################################################
+Store module
+# Configure the module that works with the database server
+# Option - the name of the module without 'mod_' at the beginning and '.so'
+# in the end ie full name of the module mod_store_files.so

 <SourceStoreModule store_files>
 
 <SourceStoreModule store_files>
 

-    # òÁÂÏÞÁÑ ÄÉÒÅËÔÏÒÉÑ ÓÅÒ×ÅÒÁ, ÔÕÔ ÓÏÄÅÒÖÁÔÓÑ ÄÁÎÎÙÅ Ï ÔÁÒÉÆÁÈ, ÐÏÌØÚÏ×ÁÔÅÌÑÈ,
-    # ÁÄÍÉÎÉÓÔÒÁÔÏÒÁÈ É Ô.Ä.
+    # Working server directory, provides data on tariffs, users, administrators.
+    # Parameter: required
+    # Value: directory path

     WorkDir = /var/stargazer
 
     WorkDir = /var/stargazer
 

-
-    # ÷ÌÁÄÅÌÅÃ, ÇÒÕÐÐÁ É ÐÒÁ×Á ÄÏÓÔÕÐÁ ÎÁ ÆÁÊÌÙ ÓÔÁÔÉÓÔÉËÉ (stat) ÐÏÌØÚÏ×ÁÔÅÌÑ
+    # Owner, group and permissions of the files of user statistics (stat)
+    # Parameter: required
+    # Values: any, supported by OS

     ConfOwner = root
     ConfOwner = root

-    ConfGroup = wheel
+    ConfGroup = root

     ConfMode = 600
 
     ConfMode = 600
 

-
-    # ÷ÌÁÄÅÌÅÃ, ÇÒÕÐÐÁ É ÐÒÁ×Á ÄÏÓÔÕÐÁ ÎÁ ÆÁÊÌÙ ËÏÎÆÉÇÕÒÁÃÉÉ (conf) ÐÏÌØÚÏ×ÁÔÅÌÑ
+    # Owner, group and permissions on user configuration files (conf)
+    # Parameter: required
+    # Values: any, supported by OS

     StatOwner = root
     StatOwner = root

-    StatGroup = wheel
+    StatGroup = root

     StatMode = 640
 
     StatMode = 640
 

-    # ÷ÌÁÄÅÌÅÃ, ÇÒÕÐÐÁ É ÐÒÁ×Á ÄÏÓÔÕÐÁ ÎÁ ÌÏÇ-ÆÁÊÌÙ (log) ÐÏÌØÚÏ×ÁÔÅÌÑ
+    # Owner, group and permissions for user log files (log)
+    # Parameter: required
+    # Values: any, supported by OS

     UserLogOwner = root
     UserLogOwner = root

-    UserLogGroup = wheel
+    UserLogGroup = root

     UserLogMode = 640
 
 </SourceStoreModule>
 
 #<DestStoreModule store_firebird>
     UserLogMode = 640
 
 </SourceStoreModule>
 
 #<DestStoreModule store_firebird>

-#    server = localhost
-#    database = /var/stargazer/stargazer.fdb
-#    user = stg
-#    password = 123456
+    # Database server address
+    # Parameter: required
+    # Value: IP address or DNS name
+    # Default: localhost
+    # server = localhost
+
+    # Path to the database on the server or its alias
+    # Parameter: required
+    # Value: file path
+    # Default: /var/stg/stargazer.fdb
+    # database = /var/stg/stargazer.fdb
+
+    # Database username
+    # Parameter: required
+    # Value: any, supported by database
+    # Default: stg
+    # user = stg
+
+    # Database password
+    # Parameter: required
+    # Value: any, supported by database
+    # Default: 123456
+    # password = 123456

 #</DestStoreModule>
 
 <DestStoreModule store_postgresql>
 #</DestStoreModule>
 
 <DestStoreModule store_postgresql>

+    # Database server address
+    # Parameter: required
+    # Value: IP address or DNS name
+    # Default: localhost

     server = localhost
     server = localhost

+
+    # Database name
+    # Parameter: required
+    # Value: any, supported by database
+    # Default: stargazer

     database = stargazer
     database = stargazer

+
+    # Database username
+    # Parameter: mandatory
+    # Value: any, supported by database
+    # Default: stg

     user = stg
     user = stg

+
+    # Database password
+    # Parameter: required
+    # Value: any, supported by database
+    # Default: 123456

     password = 123456
     password = 123456

+

 </DestStoreModule>
 
 #<DestStoreModule store_mysql>
 </DestStoreModule>
 
 #<DestStoreModule store_mysql>

-#    # éÍÑ ÐÏÌØÚÏ×ÁÔÅÌÑ âä
-#    dbuser = stg
-#
-#    # ðÁÒÏÌØ ÐÏÌØÚÏ×ÁÔÅÌÑ âä
-#    rootdbpass = 123456
-#
-#    # éÍÑ âä ÎÁ ÓÅÒ×ÅÒÅ
-#    dbname = stg
-#
-#    # áÄÒÅÓ ÓÅÒ×ÅÒÁ âä
-#    dbhost = localhost
-#</DestStoreModule>
+    # Database server address
+    # Parameter: required
+    # Value: IP address or DNS name
+    # Default: localhost
+    # dbhost = localhost

 
 

+    # Database name
+    # Parameter: required
+    # Value: any, supported by database
+    # Default: stg
+    # dbname = stg
+
+    # Database username
+    # Parameter: required
+    # Value: any, supported by database
+    # Default: stg
+    # dbuser = stg
+
+    # Database password
+    # Parameter: required
+    # Value: any, supported by database
+    # Default: 123456
+    # rootdbpass = 123456
+
+#</DestStoreModule>