Documentation/English (British)/user-chapter1-install.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.2: Installing Xestia Scanner Server</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.2: Installing Xestia Scanner Server</span>\r
  19 <br><br><b>1.2.1: Copying files</b>\r
  20 <br><br>Before Xestia Scanner Server can be used, the files need to be copied to the correct place. After extracting the archive, the structure of the extracted archive should be like this:\r
  21 <br><br>\r
  22 <b>Documentation</b> – Documentation that is available in several languages.<br>\r
  23 <b>cgi-files</b> – The main Xestia Scanner Server script, associated modules, installer scripts and language files. <br>\r
  24 &nbsp;<b>Modules</b> – Modules for Xestia Scanner Server are stored here.<br>\r
  25 &nbsp;&nbsp;<b>Auth</b> – Authentication modules are stored here.<br>\r
  26 &nbsp;&nbsp;<b>Export</b> – Export modules are stored here.<br>\r
  27 &nbsp;&nbsp;<b>Presentation</b> – Presentation modules are stored here.<br>\r
  28 &nbsp;&nbsp;<b>Output</b> – Output modules are stored here.<br>\r
  29 &nbsp;&nbsp;<b>System</b> – System modules are stored here.<br>\r
  30 &nbsp;<b>lang</b> – The directory for language files in Xestia Scanner Server.<br>\r
  31 &nbsp;<b>scans</b> – The directory for scanned documents in Xestia Scanner Server.<br>\r
  32 <b>misc</b> – Miscellaneous files (mainly for developers).<br>\r
  33 <b>non-cgi-files</b> – Non CGI files that need to be placed outside of the cgi-bin directory (such as the images for the default layout).\r
  34 &nbsp;<b>images</b> – Images for the default layout.\r
  35 <br><br>\r
  36 The files in the cgi-files directory should be copied to the cgi-bin<sup>1</sup> directory<sup>2</sup> and the files in the non-cgi-files directory should be copied to a directory which can be accessed from the web server (so that it can be read). This must be copied to outside the cgi-files. \r
  37 <br><br>\r
  38 <b>1.2.2 Setting Permissions</b>\r
  39 <br><br>\r
  40 The following permissions should be set for the files that have been copied to the cgi-files directory based on the user/web server daemon set as owner of the files and the web server daemon set as the group (the following file list should apply to those running *nix/BSD systems): \r
  41 <table class="infotable">\r
  42  <tr>\r
  43   <td class="tableheading">Filename</td>\r
  44   <td class="tableheading">Owner</td>\r
  45   <td class="tableheading">Group</td>\r
  46   <td class="tableheading">Others</td>\r
  47  </tr>\r
  48  <tr>\r
  49    <td class="tabledata"><i>(Top Directory)</i><br>After installation it is advised to make this directory readonly to prevent settings changed.</td>\r
  50    <td class="tabledata">RWX</td>\r
  51    <td class="tabledata">RWX</td>\r
  52    <td class="tabledata">None</td>\r
  53 </tr>\r
  54  <tr>\r
  55    <td class="tabledata"><b>Modules</b></td>\r
  56    <td class="tabledata">RX</td>\r
  57    <td class="tabledata">RX</td>\r
  58    <td class="tabledata">None</td>\r
  59  </tr>\r
  60  <tr>\r
  61    <td class="tabledata"><b>Modules/Auth</b></td>\r
  62    <td class="tabledata">RX</td>\r
  63    <td class="tabledata">RX</td>\r
  64    <td class="tabledata">None</td>\r
  65  </tr>\r
  66  <tr>\r
  67    <td class="tabledata">Modules/Auth/*.pm</td>\r
  68    <td class="tabledata">RX</td>\r
  69    <td class="tabledata">RX</td>\r
  70    <td class="tabledata">None</td>\r
  71  </tr>\r
  72  <tr>   \r
  73    <td class="tabledata"><b>Modules/Export</b></td>\r
  74    <td class="tabledata">RX</td>\r
  75    <td class="tabledata">RX</td>\r
  76    <td class="tabledata">None</td>\r
  77  </tr>\r
  78  <tr>\r
  79    <td class="tabledata">Modules/Export/*.pm</td>\r
  80    <td class="tabledata">RX</td>\r
  81    <td class="tabledata">RX</td>\r
  82    <td class="tabledata">None</td>\r
  83  </tr>\r
  84  <tr>\r
  85    <td class="tabledata"><b>Modules/Presentation</b></td>\r
  86    <td class="tabledata">RX</td>\r
  87    <td class="tabledata">RX</td>\r
  88    <td class="tabledata">None</td>\r
  89  </tr>\r
  90  <tr>\r
  91    <td class="tabledata">Modules/Presentation/*.pm</td>\r
  92    <td class="tabledata">RX</td>\r
  93    <td class="tabledata">RX</td>\r
  94    <td class="tabledata">None</td>\r
  95  </tr>\r
  96  <tr>\r
  97    <td class="tabledata"><b>Modules/Output</b></td>\r
  98    <td class="tabledata">RX</td>\r
  99    <td class="tabledata">RX</td>\r
 100    <td class="tabledata">None</td>\r
 101  </tr>\r
 102  <tr>\r
 103    <td class="tabledata">Modules/Output/*.pm</td>\r
 104    <td class="tabledata">RX</td>\r
 105    <td class="tabledata">RX</td>\r
 106    <td class="tabledata">None</td>\r
 107  </tr>\r
 108  <tr>\r
 109    <td class="tabledata"><b>Modules/System</b></td>\r
 110    <td class="tabledata">RX</td>\r
 111    <td class="tabledata">RX</td>\r
 112    <td class="tabledata">None</td>\r
 113  </tr>\r
 114  <tr>\r
 115    <td class="tabledata">Modules/System/*.pm</td>\r
 116    <td class="tabledata">RX</td>\r
 117    <td class="tabledata">RX</td>\r
 118    <td class="tabledata">None</td>\r
 119  </tr>\r
 120  <tr>\r
 121    <td class="tabledata"><b>lang</b></td>\r
 122    <td class="tabledata">RX</td>\r
 123    <td class="tabledata">RX</td>\r
 124    <td class="tabledata">None</td>\r
 125  </tr>\r
 126  <tr>\r
 127    <td class="tabledata">lang/*.lang</td>\r
 128    <td class="tabledata">R</td>\r
 129    <td class="tabledata">R</td>\r
 130    <td class="tabledata">None</td>\r
 131  </tr>\r
 132  <tr>\r
 133    <td class="tabledata"><b>scans</b></td>\r
 134    <td class="tabledata">RWX</td>\r
 135    <td class="tabledata">RX</td>\r
 136    <td class="tabledata">None</td>\r
 137  </tr>\r
 138  <tr>\r
 139    <td class="tabledata">xsdss.cgi</td>\r
 140    <td class="tabledata">RX</td>\r
 141    <td class="tabledata">RX</td>\r
 142    <td class="tabledata">None</td>\r
 143  </tr>\r
 144  <tr>\r
 145    <td class="tabledata">install.cgi</td>\r
 146    <td class="tabledata">RX</td>\r
 147    <td class="tabledata">RX</td>\r
 148    <td class="tabledata">None</td>\r
 149  </tr>\r
 150  <tr>\r
 151    <td class="tabledata">install-multiuser.cgi</td>\r
 152    <td class="tabledata">RX</td>\r
 153    <td class="tabledata">RX</td>\r
 154    <td class="tabledata">None</td>\r
 155  </tr>\r
 156  <tr>\r
 157    <td class="tabledata">page.html</td>\r
 158    <td class="tabledata">R</td>\r
 159    <td class="tabledata">R</td>\r
 160    <td class="tabledata">None</td>\r
 161  </tr>\r
 162 </table>\r
 163 <br><br>\r
 164 \r
 165 R = Read, W = Write, X = Execute/Allow directory listing\r
 166 \r
 167 <br><br>\r
 168 For the non-cgi files directory, read only permissions should be set on all files (and read and allow directory listings for directories) as no writing should be needed. Once this is done, the installer script can be run by browsing to URI location of where the files in the cgi-files directory were in place and adding install.cgi to the end of it.\r
 169 <br><br>\r
 170 <div class="footnote"><sup>1</sup> The cgi-bin directory is used for storing scripts that use the Common Gateway Interface (CGI). CGI scripts are typically associated with Perl scripts but can also be C++, C, Python, shell script and many others.<br><br><sup>2</sup> Some servers are configured so that CGI scripts can run from any directory so in this case Xestia Scanner Server doesn't have to be placed in the cgi-bin directory. \r
 171 </div>\r
 172                 </div>\r
 173         </body>\r
 174 </html>\r