1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
\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
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
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 <b>Modules</b> – Modules for Kiriwrite are stored here.<br>
\r
23 <b>Database</b> – Database modules are stored here.<br>
\r
24 <b>Presentation</b> – Presentation modules are stored here.<br>
\r
25 <b>db</b> – Default database directory (for file based Database modules).<br>
\r
26 <b>lang</b> – The directory for language files in Kiriwrite.<br>
\r
27 <b>output</b> – The output directory when pages are compiled.<br>
\r
28 <b>misc</b> – Miscellaneous files (mainly for developers).<br>
\r
29 <b>non-cgi-files</b> – Non CGI files that need to be placed outside of the cgi-bin folder.<br><br>
\r
30 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
31 <span class="heading">1.2.2 Setting Permissions</span><br><br>
\r
32 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
34 <table class="infotable">
\r
36 <td class="tableheading">Filename</td>
\r
37 <td class="tableheading">Owner</td>
\r
38 <td class="tableheading">Group</td>
\r
39 <td class="tableheading">Others</td>
\r
42 <td class="tabledata"><i>(Top Directory)</i></td>
\r
43 <td class="tabledata">RWX</td>
\r
44 <td class="tabledata">RX</td>
\r
45 <td class="tabledata"><i>None</i></td>
\r
48 <td class="tabledata"><b>Modules</b></td>
\r
49 <td class="tabledata">RX</td>
\r
50 <td class="tabledata">RX</td>
\r
51 <td class="tabledata"><i>None</i></td>
\r
54 <td class="tabledata"><b>Modules/Database</b></td>
\r
55 <td class="tabledata">RX</td>
\r
56 <td class="tabledata">RX</td>
\r
57 <td class="tabledata"><i>None</i></td>
\r
60 <td class="tabledata">Modules/Database/MySQL.pm</td>
\r
61 <td class="tabledata">R</td>
\r
62 <td class="tabledata">R</td>
\r
63 <td class="tabledata"><i>None</i></td>
\r
66 <td class="tabledata">Modules/Database/SQLite.pm</td>
\r
67 <td class="tabledata">R</td>
\r
68 <td class="tabledata">R</td>
\r
69 <td class="tabledata"><i>None</i></td>
\r
72 <td class="tabledata"><b>Modules/Presentation</b></td>
\r
73 <td class="tabledata">RX</td>
\r
74 <td class="tabledata">RX</td>
\r
75 <td class="tabledata"><i>None</i></td>
\r
78 <td class="tabledata">Modules/Presentation/HTML4S.pm</td>
\r
79 <td class="tabledata">R</td>
\r
80 <td class="tabledata">R</td>
\r
81 <td class="tabledata"><i>None</i></td>
\r
84 <td class="tabledata"><b>db</b></td>
\r
85 <td class="tabledata">RWX</td>
\r
86 <td class="tabledata">RX</td>
\r
87 <td class="tabledata"><i>None</i></td>
\r
90 <td class="tabledata"><b>output</b></td>
\r
91 <td class="tabledata">RWX</td>
\r
92 <td class="tabledata">RX</td>
\r
93 <td class="tabledata"><i>None</i></td>
\r
96 <td class="tabledata"><b>lang</b></td>
\r
97 <td class="tabledata">RX</td>
\r
98 <td class="tabledata">RX</td>
\r
99 <td class="tabledata"><i>None</i></td>
\r
102 <td class="tabledata">lang/*.xml</td>
\r
103 <td class="tabledata">R</td>
\r
104 <td class="tabledata">R</td>
\r
105 <td class="tabledata"><i>None</i></td>
\r
108 <td class="tabledata">kiriwrite.cgi</td>
\r
109 <td class="tabledata">RWX</td>
\r
110 <td class="tabledata">R</td>
\r
111 <td class="tabledata"><i>None</i></td>
\r
114 <td class="tabledata">install.cgi</td>
\r
115 <td class="tabledata">RWX</td>
\r
116 <td class="tabledata">R</td>
\r
117 <td class="tabledata"><i>None</i></td>
\r
120 <td class="tabledata">page.html</td>
\r
121 <td class="tabledata">R</td>
\r
122 <td class="tabledata">R</td>
\r
123 <td class="tabledata"><i>None</i></td>
\r
129 R = Read, W = Write, X = Execute/Allow directory listing<br><br>
\r
130 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
131 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
132 <div class="footnote"></div>
\r
133 <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
134 <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