doc/INSTALL rewritten, var/conf.php reformatted

livesupport/modules/archiveServer/doc/INSTALL

@@ -1,9 +1,6 @@
 
-The HTTP_GROUP variable in Makefile haveto be set to group running apache.
-
 Install steps for file uploading (do it with appropriate changes):
 (PUT method for uploading from behind firewall with resume feature)
-
 1) mkdir cgi-bin-put in apache2 dir
 2) move put.cgi there from var subdir
 3) add to apache2 config (i.g. commonapache2.conf):
@@ -25,4 +22,14 @@ ScriptAlias /cgi-bin-put/ "/usr/local/apache2/cgi-bin-put/"
 
 Tested with apache 2.0.49 and (without Directory tag) with apache 1.3.28.
 
-TODO: check more put.cgi for security problems!
+----
+
+For devel environment follow steps in storageServer/doc/INSTALL.
+For running archiveServer on different HW then storageServer:
+ - required packages: apache, php, mod_php, postgreSQL, PEAR_DB
+ - check if PEAR DB installed: 'pear list' or install it: 'pear install DB'
+ - check if include_path in php.ini points to PEAR too
+   (/usr/lib/php or /usr/local/lib/php)
+ - setup var/conf.php - at least "basic configuration" part
+ - run 'make check' to: setup directories, create db tables and run test scripts
+   OR 'make all' without tests

livesupport/modules/archiveServer/var/conf.php

@@ -23,23 +23,59 @@
  
  
     Author   : $Author: tomas $
-    Version  : $Revision: 1.2 $
+    Version  : $Revision: 1.3 $
     Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/archiveServer/var/conf.php,v $
 
 ------------------------------------------------------------------------------*/
+
+/**
+ *  configuration structure:
+ *  <dl>
+ *   <dt>dsn<dd> datasource setting
+ *   <dt>tblNamePrefix <dd>prefix for table names in the database
+ *   <dt>authCookieName <dd>secret token cookie name
+ *   <dt>storageDir <dd>main directory for storing binary media files
+ *   <dt>bufferDir <dd>directory for temporary files
+ *   <dt>transDir <dd>directory for incomplete transferred files
+ *   <dt>accessDir <dd>directory for symlinks to accessed files
+ *   <dt>storageUrlPath<dd>path-URL-part of storageServer base dir
+ *      (on central archive side: storage=archive)
+ *   <dt>storageXMLRPC<dd>XMLRPC server script address relative to storageUrlPath
+ *   <dt>storageUrlHost, storageUrlPort<dd>host and port of storageServer
+ *   <dt>archiveUrlPath<dd>path-URL-part of archiveServer base dir
+ *   <dt>archiveXMLRPC<dd>XMLRPC server script address relative to archiveUrlPath
+ *   <dt>archiveUrlHost, archiveUrlPort<dd>host and port of archiveServer
+ *  </dl>
+ */
 $config = array(
+    /* ================================================== basic configuration */
     'dsn'           => array(
         'username'      => 'test',
         'password'      => 'test',
         'hostspec'      => 'localhost',
-#        'hostspec'     => '127.0.0.1',         // for bad resolver
         'phptype'       => 'pgsql',
         'database'      => 'LiveSupport-test',
     ),
     'tblNamePrefix' => 'as_',
     'authCookieName'=> 'assid',
-    'RootNode'      => 'RootNode',
+    'storageDir'    =>  dirname(getcwd()).'/stor',
-    'tmpRootPass'   => 'q',
+    'bufferDir'     =>  dirname(getcwd()).'/stor/buffer',
+    'transDir'      =>  dirname(getcwd()).'/trans',
+    'accessDir'     =>  dirname(getcwd()).'/access',
+
+    /* ==================================================== URL configuration */
+    // on central archive side: storage=archive !
+    'storageUrlPath'        => '/livesupport/modules/archiveServer/var',
+    'storageXMLRPC'         => 'xmlrpc/xrArchive.php',
+    'storageUrlHost'        => 'localhost',
+    'storageUrlPort'        => 80,
+    // only for returning right URLs:
+    'archiveUrlPath'        => '/livesupport/modules/archiveServer/var',
+    'archiveXMLRPC'         => 'xmlrpc/xrArchive.php',
+    'archiveUrlHost'        => 'localhost',
+    'archiveUrlPort'        => 80,
+
+    /* ==================================== aplication-specific configuration */
     'objtypes'      => array(
         'RootNode'      => array('Folder'),
         'Storage'       => array('Folder', 'File', 'Replica'),
@@ -57,21 +93,9 @@ $config = array(
     'allActions'    =>  array(
         'editPrivs', 'write', 'read', 'classes', 'subjects'
     ),
-    'storageDir'    =>  dirname(getcwd()).'/stor',
-    'bufferDir'     =>  dirname(getcwd()).'/stor/buffer',
-    'transDir'      =>  dirname(getcwd()).'/trans',
-    'accessDir'     =>  dirname(getcwd()).'/access',
-
-// on central archive side storage=archive
-    'storageUrlPath'        => '/livesupport/modules/archiveServer/var',
-    'storageXMLRPC'         => 'xmlrpc/xrArchive.php',
-    'storageUrlHost'        => 'localhost',
-    'storageUrlPort'        => 80,
-// only for returning right URLs:
-    'archiveUrlPath'        => '/livesupport/modules/archiveServer/var',
-    'archiveXMLRPC'         => 'xmlrpc/xrArchive.php',
-    'archiveUrlHost'        => 'localhost',
-    'archiveUrlPort'        => 80,
 
+    /* ============================================== auxiliary configuration */
+    'RootNode'      => 'RootNode',
+    'tmpRootPass'   => 'q',
 );
 ?>