Documentation/English (British)/user-chapter1-installingkiriwrite.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>Kiriwrite Documentation - User Documentation - 1.2: Installing Kiriwrite</title>\r
   7         </head>\r
   8         <body>\r
   9                 <div class="menubarback">\r
  10                         <div class="menubar">\r
  11                                 <span class="apptitle">Kiriwrite</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.1 Copying files</span><br><br>\r
  19 Before Kiriwrite 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:<br><br>\r
  20 <b>Documentation</b> – Documentation that is available in several languages.<br>\r
  21 <b>cgi-files</b> – The main Kiriwrite script, associated modules, installer script and language files.<br>\r
  22 &nbsp;<b>Modules</b> – Modules for Kiriwrite are stored here.<br>\r
  23 &nbsp;&nbsp;<b>Database</b> – Database modules are stored here.<br>\r
  24 &nbsp;&nbsp;<b>Presentation</b> – Presentation modules are stored here.<br>\r
  25 &nbsp;&nbsp;<b>Output</b> – Output modules are stored here.<br>\r
  26 &nbsp;<b>db</b> – Default database directory (for file based Database modules).<br>\r
  27 &nbsp;<b>lang</b> – The directory for language files in Kiriwrite.<br>\r
  28 &nbsp;<b>lib</b> - Library files that are used by Kiriwrite.<br>\r
  29 &nbsp;<b>output</b> – The output directory when pages are compiled.<br>\r
  30 <b>misc</b> – Miscellaneous files (mainly for developers).<br>\r
  31 <b>non-cgi-files</b> – Non CGI files that need to be placed outside of the cgi-bin folder.<br><br>\r
  32 The files in the cgi-files folder should be copied to the cgi-bin<sup>1</sup> folder<sup>2</sup> and the files in the non-cgi-files folder should be copied to a folder which can be accessed from the web server.<br><br>\r
  33 <span class="heading">1.2.2 Setting Permissions</span><br><br>\r
  34 The following permissions should be set for the files that have been copied to the cgi-files directory (the following file list should apply to those running *nix/BSD systems):<br><br>\r
  35 \r
  36 <table class="infotable">\r
  37     <tr>\r
  38         <td class="tableheading">Filename</td>\r
  39         <td class="tableheading">Owner</td>\r
  40         <td class="tableheading">Group</td>\r
  41         <td class="tableheading">Others</td>\r
  42     </tr>\r
  43     <tr>\r
  44         <td class="tabledata"><i>(Top Directory)</i></td>\r
  45         <td class="tabledata">RWX</td>\r
  46         <td class="tabledata">RX</td>\r
  47         <td class="tabledata"><i>None</i></td>\r
  48     </tr>\r
  49     <tr>\r
  50         <td class="tabledata"><b>Modules</b></td>\r
  51         <td class="tabledata">RX</td>\r
  52         <td class="tabledata">RX</td>\r
  53         <td class="tabledata"><i>None</i></td>\r
  54     </tr>\r
  55     <tr>\r
  56         <td class="tabledata"><b>Modules/Database</b></td>\r
  57         <td class="tabledata">RX</td>\r
  58         <td class="tabledata">RX</td>\r
  59         <td class="tabledata"><i>None</i></td>\r
  60     </tr>\r
  61     <tr>\r
  62         <td class="tabledata">Modules/Database/MySQL.pm</td>\r
  63         <td class="tabledata">R</td>\r
  64         <td class="tabledata">R</td>\r
  65         <td class="tabledata"><i>None</i></td>\r
  66     </tr>\r
  67     <tr>\r
  68         <td class="tabledata">Modules/Database/SQLite.pm</td>\r
  69         <td class="tabledata">R</td>\r
  70         <td class="tabledata">R</td>\r
  71         <td class="tabledata"><i>None</i></td>\r
  72     </tr>\r
  73     <tr>\r
  74         <td class="tabledata"><b>Modules/Presentation</b></td>\r
  75         <td class="tabledata">RX</td>\r
  76         <td class="tabledata">RX</td>\r
  77         <td class="tabledata"><i>None</i></td>\r
  78     </tr>\r
  79     <tr>\r
  80         <td class="tabledata">Modules/Presentation/HTML4S.pm</td>\r
  81         <td class="tabledata">R</td>\r
  82         <td class="tabledata">R</td>\r
  83         <td class="tabledata"><i>None</i></td>\r
  84     </tr>\r
  85     <tr>\r
  86         <td class="tabledata"><b>Modules/Output</b></td>\r
  87         <td class="tabledata">RX</td>\r
  88         <td class="tabledata">RX</td>\r
  89         <td class="tabledata"><i>None</i></td>\r
  90     </tr>\r
  91     <tr>\r
  92         <td class="tabledata">Modules/Output/Normal.pm</td>\r
  93         <td class="tabledata">R</td>\r
  94         <td class="tabledata">R</td>\r
  95         <td class="tabledata"><i>None</i></td>\r
  96     </tr>\r
  97     <tr>\r
  98         <td class="tabledata"><b>db</b></td>\r
  99         <td class="tabledata">RWX</td>\r
 100         <td class="tabledata">RX</td>\r
 101         <td class="tabledata"><i>None</i></td>\r
 102     </tr>\r
 103     <tr>\r
 104         <td class="tabledata"><b>output</b></td>\r
 105         <td class="tabledata">RWX</td>\r
 106         <td class="tabledata">RX</td>\r
 107         <td class="tabledata"><i>None</i></td>\r
 108     </tr>\r
 109     <tr>\r
 110         <td class="tabledata"><b>lang</b></td>\r
 111         <td class="tabledata">RX</td>\r
 112         <td class="tabledata">RX</td>\r
 113         <td class="tabledata"><i>None</i></td>\r
 114     </tr>\r
 115     <tr>\r
 116         <td class="tabledata">lang/*.lang</td>\r
 117         <td class="tabledata">R</td>\r
 118         <td class="tabledata">R</td>\r
 119         <td class="tabledata"><i>None</i></td>\r
 120     </tr>\r
 121     <tr>\r
 122         <td class="tabledata"><b>lib</b></td>\r
 123         <td class="tabledata">R</td>\r
 124         <td class="tabledata">R</td>\r
 125         <td class="tabledata"><i>None</i></td>\r
 126     </tr>\r
 127     <tr>\r
 128         <td class="tabledata">lib\*.lib</td>\r
 129         <td class="tabledata">R</td>\r
 130         <td class="tabledata">R</td>\r
 131         <td class="tabledata"><i>None</i></td>\r
 132     </tr>\r
 133     <tr>\r
 134         <td class="tabledata">kiriwrite.cgi</td>\r
 135         <td class="tabledata">RWX</td>\r
 136         <td class="tabledata">R</td>\r
 137         <td class="tabledata"><i>None</i></td>\r
 138     </tr>\r
 139     <tr>\r
 140         <td class="tabledata">install.cgi</td>\r
 141         <td class="tabledata">RWX</td>\r
 142         <td class="tabledata">R</td>\r
 143         <td class="tabledata"><i>None</i></td>\r
 144     </tr>\r
 145     <tr>\r
 146         <td class="tabledata">page.html</td>\r
 147         <td class="tabledata">R</td>\r
 148         <td class="tabledata">R</td>\r
 149         <td class="tabledata"><i>None</i></td>\r
 150     </tr>\r
 151 </table>\r
 152 \r
 153 <br><br>\r
 154 \r
 155 R = Read, W = Write, X = Execute/Allow directory listing<br><br>\r
 156 For the non-cgi files folder, read only permissions should be set on all files (and read and allow directory listings for directories) as no writing should be needed.<br><br>\r
 157 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.<br><br>\r
 158 <div class="footnote"></div>\r
 159 <sup>1</sup>The cgi-bin folder 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>\r
 160 <sup>2</sup>Some servers are configured so that CGI scripts can run from any directory so in this case Kiriwrite doesn't have to be placed in the cgi-bin directory.\r
 161                 </div>\r
 162         </body>\r
 163 </html>\r