Documentation/English (British)/user-chapter1-installscript.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">\r
   2 <html>\r
   3         <head>\r
   4                 <link href="style.css" REL="stylesheet" TYPE="text/css" MEDIA="screen">\r
   5                 <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">\r
   6                 <title>Xestia Scanner Server Documentation - User Documentation - 1.3 Installer Script</title>\r
   7         </head>\r
   8         <body>\r
   9                 <div class="menubarback">\r
  10                         <div class="menubar">\r
  11                                 <span class="apptitle">Xestia Scanner Server</span>\r
  12                                 <a href="index.html">Index</a> | <a href="user.html">User \r
  13 Documentation</a> | <a href="tutorial.html">Tutorial Documentation</a> | \r
  14 <a href="developer.html">Developer Documentation</a>\r
  15                         </div>\r
  16                 </div>\r
  17                 <div class="pageinformation">\r
  18                         <span class="pagetitle">1.3 Installer Script</span>\r
  19 <br><br>\r
  20 After pointing your browser to the installer script, a page appears which guides you through configuring the settings for Xestia Scanner Server.\r
  21 <br><br>\r
  22 At the top of the page a drop down box is available to change the language of the installer script to another language which is more easier to understand, simply select the language from the drop down box and click on the Switch button, the script will then switch to the selected language.\r
  23 <br><br>\r
  24 The installer script will preform three tests, the first being to check if all the needed modules are there, the second test is to check if the modules needed for the authentication modules are there and finally a test to check if the directories have their correct permissions set.\r
  25 <br><br>\r
  26 Before the settings can be configured, checks are made to make sure that all of the needed modules are installed properly. If any of the needed modules are missing an error message will appear saying that one or more of the required Perl modules is missing and will need to be installed which can be done from the CPAN interface.\r
  27 <br><br>\r
  28 The installer script then checks to see if at least of the Perl modules for the database modules are installed. If none of the Perl modules needed for the authentication modules are found then an error message will appear saying that none of the Perl modules needed for the authentication modules are installed and will need to be installed which can be done from the CPAN interface.\r
  29 <br><br>\r
  30 Finally, the installer script then checks to see if the directories have the minimum correct permissions set. If one or more of the directories has an error, then a message appears saying to make sure that the correct permissions are set.\r
  31 <br><br>\r
  32 <div class="messagebox">\r
  33 <div class="message hint"><b>Hint</b><br><br>\r
  34 More information on solving problems that occur while installing Xestia Scanner Server can be found in Chapter 5: Troubleshooting.\r
  35 </div>\r
  36 </div>\r
  37 <br><br>\r
  38 When the installer finds that everything is fine in regards to Perl modules and file permissions, a form appears allowing to configure the Xestia Scanner Server installation to specific needs. Some default values are given which will work with the file-based authentication modules.\r
  39 <br><br>\r
  40 The configuration settings in detail:\r
  41 <br><br>\r
  42 <table class="infotable">\r
  43  <tr>\r
  44   <td class="tableheading">Setting</td>\r
  45   <td class="tableheading">Description</td>\r
  46  </tr>\r
  47  <tr>\r
  48   <td class="tabledata">Images (URI path)</td>\r
  49   <td class="tabledata">Specifies the URI path for the images used in the page layout.</td>\r
  50  </tr>\r
  51  <tr>\r
  52   <td class="tabledata">Scans (URI path)</td>\r
  53   <td class="tabledata">Specifies the URI path for the scanned images.</td>\r
  54  </tr>\r
  55  <tr>\r
  56   <td class="tabledata">Scans (Filesystem path)</td>\r
  57   <td class="tabledata">Specifies the Filesystem path to store the scanned images when processed by an output module.</td>\r
  58  </tr>\r
  59  <tr>\r
  60   <td class="tabledata">Date Format</td>\r
  61   <td class="tabledata">Specifies the date format to use.</td>\r
  62  </tr>\r
  63  <tr>\r
  64   <td class="tabledata">System Language</td>\r
  65   <td class="tabledata">Specifies the language to use for Xestia Scanner Server.</td>\r
  66  </tr>\r
  67  <tr>\r
  68   <td class="tabledata">Presentation Module</td>\r
  69   <td class="tabledata">Specifies the presentation module.</td>\r
  70  </tr>\r
  71  <tr>\r
  72   <td class="tabledata">Output Module</td>\r
  73   <td class="tabledata">Specifies the default output module to use after a scan is made.</td>\r
  74  </tr>\r
  75  <tr>\r
  76   <td class="tabledata">Authentication Module</td>\r
  77   <td class="tabledata">Specifies the authentication module to use for the user management.</td>\r
  78  </tr>\r
  79  <tr>\r
  80   <td class="tabledata">Database Server</td>\r
  81   <td class="tabledata">Specifies the database server to use for the authentication module.</td>\r
  82  </tr>\r
  83  <tr>\r
  84   <td class="tabledata">Database Port</td>\r
  85   <td class="tabledata">Specifies the database server port to use for the authentication module.</td>\r
  86  </tr>\r
  87  <tr>\r
  88   <td class="tabledata">Database Protocol</td>\r
  89   <td class="tabledata">Specifies the database protocol to use for the authentication module.</td>\r
  90  </tr>\r
  91  <tr>\r
  92   <td class="tabledata">Database Name</td>\r
  93   <td class="tabledata">Specifies the database name to use for the authentication module.</td>\r
  94  </tr>\r
  95  <tr>\r
  96   <td class="tabledata">Database Username</td>\r
  97   <td class="tabledata">Specifies the database username to use for the authentication module.</td>\r
  98  </tr>\r
  99  <tr>\r
 100   <td class="tabledata">Database Password</td>\r
 101   <td class="tabledata">Specifies the database password to use for the authentication module.</td>\r
 102  </tr>\r
 103  <tr>\r
 104   <td class="tabledata">Database Table Prefix</td>\r
 105   <td class="tabledata">Specifies the database table prefix to use for the authentication module.</td>\r
 106  </tr>\r
 107 </table>\r
 108 <br><br>\r
 109 There are two options also available to delete the installer script when finished and also the multiuser script if it is not needed. \r
 110 <br><br>\r
 111 Click on the Save Settings button to write the configuration file or the Reset Settings button to restore the settings to their default values.\r
 112 <br><br>\r
 113 After clicking on the Save Settings button, some checks are made to make sure that data passed is correct, the configuration file is written (and the installer and multiuser installer scripts are deleted if requested) and a message appears saying that Xestia Scanner Server can now be used by clicking on the link at the bottom of the page.\r
 114 <br><br>\r
 115 If the authentication module selected is a module which needs to be setup for the user management (which is also known as a multiuser authentication module) then you'll be prompted to run the Multiuser Installer script.\r
 116                 </div>\r
 117         </body>\r
 118 </html>\r