65d3e031061a939712eb83a8192bdfdbaa8ddafc
[openafs-wiki.git] / TWiki / TWikiSystemRequirements.mdwn
1 <div>
2   <ul>
3     <li><a href="#TWiki Implementation Notes"> TWiki Implementation Notes</a><ul>
4         <li><a href="#Platforms and System Requirement"> Platforms and System Requirements </a></li>
5         <li><a href="#Directory Structure"> Directory Structure</a><ul>
6             <li><a href="#Files in twiki"> Files in <code>twiki</code></a></li>
7             <li><a href="#Files in twiki/bin"> Files in <code>twiki/bin</code></a></li>
8             <li><a href="#Files in twiki/lib"> Files in <code>twiki/lib</code></a></li>
9             <li><a href="#Files in twiki/lib/TWiki"> Files in <code>twiki/lib/TWiki</code></a></li>
10             <li><a href="#Files in twiki/lib/TWiki/Plugins"> Files in <code>twiki/lib/TWiki/Plugins</code></a></li>
11             <li><a href="#Files in twiki/pub"> Files in <code>twiki/pub</code></a></li>
12             <li><a href="#Files in twiki/data"> Files in <code>twiki/data</code></a></li>
13             <li><a href="#Files in twiki/templates"> Files in <code>twiki/templates</code></a></li>
14           </ul>
15         </li>
16       </ul>
17     </li>
18   </ul>
19 </div>
20
21 ## <a name="TWiki Implementation Notes"></a> TWiki Implementation Notes
22
23 ### <a name="Platforms and System Requirement"></a> Platforms and System Requirements
24
25 TWiki is written in **Perl 5** and also uses some **shell commands**. The current implementation runs best on a Unix machine, but it is also possible on Microsoft Windows. **RCS** (for revision control) must be installed on the system. [ **_MM: Locate elsewhere and/or include one-liner and link for RCS..._** ]
26
27 <table border="1" cellpadding="0" cellspacing="0">
28   <tr>
29     <th bgcolor="#99CCCC" colspan="3"><strong> Required Environment by Platform </strong></th>
30   </tr>
31   <tr>
32     <th bgcolor="#99CCCC"><strong> Packages: </strong></th>
33     <th bgcolor="#99CCCC"><strong> Linux/Unix: </strong></th>
34     <th bgcolor="#99CCCC"><strong> Windows: </strong></th>
35   </tr>
36   <tr>
37     <td> Perl </td>
38     <td align="center"> 5.x </td>
39     <td align="center"> 5.x </td>
40   </tr>
41   <tr>
42     <td> Non-standard Perl modules </td>
43     <td>   </td>
44     <td><code>MIME::Base64</code>, Digest::SHA1 (for password generation) </td>
45   </tr>
46   <tr>
47     <td> Optional Perl modules </td>
48     <td><code>Net::SMTP</code> (or sendmail) </td>
49     <td align="center"><code>Net::SMTP</code></td>
50   </tr>
51   <tr>
52     <td> RCS </td>
53     <td align="center"> 5.7 </td>
54     <td align="center"> 5.7 (including <code>diff</code></td>
55   </tr>
56   <tr>
57     <td> Other external programs </td>
58     <td align="center"><code>ls</code>, <code>fgrep</code>, <code>egrep</code></td>
59     <td align="center"><code>ls</code>, <code>fgrep</code>, <code>egrep</code></td>
60   </tr>
61   <tr>
62     <td> Web server </td>
63     <td align="center"> Apache </td>
64     <td align="center"> Apache, IIS </td>
65   </tr>
66   <tr>
67     <td><em>OS versions</em></td>
68     <td align="center"><strong><em>Linux, Unix...</em></strong></td>
69     <td align="center"><strong><em>every last Win?!</em></strong></td>
70   </tr>
71 </table>
72
73 ### <a name="Directory Structure"></a> Directory Structure
74
75 You can easily rename the root TWiki directory - <code>**twiki**</code> - to whatever you like by changing a configuration file value. For the simplest installation and future upgrades, you should leave the subdirectory structure exactly as is:
76
77 <table border="1" cellpadding="0" cellspacing="0">
78   <tr>
79     <th bgcolor="#99CCCC"><strong> Directory: </strong></th>
80     <th bgcolor="#99CCCC"><strong> Files: </strong></th>
81     <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
82   </tr>
83   <tr>
84     <td><code><b>twiki</b></code></td>
85     <td align="center">[[Main/WebHome#TWikiFiles]]</td>
86     <td> Start-up info </td>
87   </tr>
88   <tr>
89     <td><code><b>twiki/bin</b></code></td>
90     <td align="center">[[Main/WebHome#BinFiles]]</td>
91     <td> Perl scripts </td>
92   </tr>
93   <tr>
94     <td><code><b>twiki/lib</b></code></td>
95     <td align="center">[[Main/WebHome#LibFiles]]</td>
96     <td> Configuration file &amp; main library </td>
97   </tr>
98   <tr>
99     <td><code><b>twiki/lib/TWiki</b></code></td>
100     <td align="center">[[Main/WebHome#LibTWiki]]</td>
101     <td> Perl modules </td>
102   </tr>
103   <tr>
104     <td><code><b>twiki/lib/TWiki/Plugins</b></code></td>
105     <td align="center">[[Main/WebHome#libtwikiplugins]]</td>
106     <td>[[Main/TWikiPlugins]] Perl modules </td>
107   </tr>
108   <tr>
109     <td><code><b>twiki/pub</b></code></td>
110     <td align="center">[[Main/WebHome#PubFiles]]</td>
111     <td> Public support files (ex: [[Main/FileAttachments]], images) and RCS histories) </td>
112   </tr>
113   <tr>
114     <td><code><b>twiki/data</b></code></td>
115     <td align="center">[[Main/WebHome#DataFiles]]</td>
116     <td> Topic text (page content) and RCS histories; </td>
117   </tr>
118   <tr>
119     <td><code><b>twiki/templates</b></code></td>
120     <td align="center">[[Main/WebHome#TemplatesFiles]]</td>
121     <td> HTML templates, used by TWiki scripts </td>
122   </tr>
123 </table>
124
125 **_Note: about the additional directories in data, elsewhere_**
126
127 <a name="TWikiFiles"></a>
128
129 #### <a name="Files in twiki"></a> Files in `twiki`
130
131 **_to follow_**
132
133 <a name="BinFiles"></a>
134
135 #### <a name="Files in twiki/bin"></a> Files in `twiki/bin`
136
137 <table border="1" cellpadding="0" cellspacing="0">
138   <tr>
139     <th bgcolor="#99CCCC"><strong> File: </strong></th>
140     <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
141   </tr>
142   <tr>
143     <td><code><b>.htaccess.txt</b></code></td>
144     <td> Authentication. Rename to .htaccess and customize if used </td>
145   </tr>
146   <tr>
147     <td><code><b>attach</b></code></td>
148     <td> Script that shows the attach file page ([[Main/FileAttachment]]) </td>
149   </tr>
150   <tr>
151     <td><code><b>delete</b></code></td>
152     <td> (not used yet) </td>
153   </tr>
154   <tr>
155     <td><code><b>edit</b></code></td>
156     <td> Script to edit a topic </td>
157   </tr>
158   <tr>
159     <td><code><b>geturl</b></code></td>
160     <td> Script to fetch URL data </td>
161   </tr>
162   <tr>
163     <td><code><b>mailnotify</b></code></td>
164     <td> Script called by cron job to notify users of changes </td>
165   </tr>
166   <tr>
167     <td><code><b>oops</b></code></td>
168     <td> Script that shows an OK or oops dialog </td>
169   </tr>
170   <tr>
171     <td><code><b>preview</b></code></td>
172     <td> Script to preview topic after edit </td>
173   </tr>
174   <tr>
175     <td><code><b>rdiff</b></code></td>
176     <td> Script to see differences of topics </td>
177   </tr>
178   <tr>
179     <td><code><b>rename</b></code></td>
180     <td> Script to rename/move topics and move attachments </td>
181   </tr>
182   <tr>
183     <td><code><b>register</b></code></td>
184     <td> Script to register new users </td>
185   </tr>
186   <tr>
187     <td><code><b>save</b></code></td>
188     <td> Script that saves a topic, called by preview </td>
189   </tr>
190   <tr>
191     <td><code><b>search</b></code></td>
192     <td> Script that displays search results </td>
193   </tr>
194   <tr>
195     <td><code><b>statistics</b></code></td>
196     <td> Script to create statistics topic </td>
197   </tr>
198   <tr>
199     <td><code><b>testenv</b></code></td>
200     <td> Script to test CGI environment variables </td>
201   </tr>
202   <tr>
203     <td><code><b>upload</b></code></td>
204     <td> Script that does file upload ([[Main/FileAttachment]]) </td>
205   </tr>
206   <tr>
207     <td><code><b>view</b></code></td>
208     <td> Script to view a topic ( <strong>the</strong> script ) </td>
209   </tr>
210   <tr>
211     <td><code><b>viewfile</b></code></td>
212     <td> Script to view an file attachment </td>
213   </tr>
214 </table>
215
216 <a name="LibFiles"></a>
217
218 #### <a name="Files in twiki/lib"></a> Files in `twiki/lib`
219
220 <table border="1" cellpadding="0" cellspacing="0">
221   <tr>
222     <th bgcolor="#99CCCC"><strong> File: </strong></th>
223     <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
224   </tr>
225   <tr>
226     <td><code><b>TWiki.pm</b></code></td>
227     <td> Main TWiki library </td>
228   </tr>
229   <tr>
230     <td><code><b>TWiki.cfg</b></code></td>
231     <td> For configuration, used by <code><b>TWiki.pm</b></code></td>
232   </tr>
233 </table>
234
235 <a name="LibTWiki"></a>
236
237 #### <a name="Files in twiki/lib/TWiki"></a> Files in `twiki/lib/TWiki`
238
239 <table border="1" cellpadding="0" cellspacing="0">
240   <tr>
241     <th bgcolor="#99CCCC"><strong> File: </strong></th>
242     <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
243   </tr>
244   <tr>
245     <td><code><b>Access.pm</b></code></td>
246     <td> Access control </td>
247   </tr>
248   <tr>
249     <td><code><b>Attach.pm</b></code></td>
250     <td> Attachment handling </td>
251   </tr>
252   <tr>
253     <td><code><b>Meta.pm</b></code></td>
254     <td> Meta data in topics </td>
255   </tr>
256   <tr>
257     <td><code><b>Net.pm</b></code></td>
258     <td> SMTP mail handling </td>
259   </tr>
260   <tr>
261     <td><code><b>Plugins.pm</b></code></td>
262     <td> Plugin handling </td>
263   </tr>
264   <tr>
265     <td><code><b>Prefs.pm</b></code></td>
266     <td> Preferences handling </td>
267   </tr>
268   <tr>
269     <td><code><b>Search.pm</b></code></td>
270     <td> Search engine, used by wiki.pm </td>
271   </tr>
272   <tr>
273     <td><code><b>Store.pm</b></code></td>
274     <td> Back-end storage, <code>*.txt</code> text file and <code>*.txt,v</code> RCS repository file handling </td>
275   </tr>
276 </table>
277
278 <a name="LibTWikiPlugins"></a>
279
280 #### <a name="Files in twiki/lib/TWiki/Plugins"></a> Files in `twiki/lib/TWiki/Plugins`
281
282 <table border="1" cellpadding="0" cellspacing="0">
283   <tr>
284     <th bgcolor="#99CCCC"><strong> File: </strong></th>
285     <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
286   </tr>
287   <tr>
288     <td><code><b>DefaultPlugin.pm</b></code></td>
289     <td> Default plugin </td>
290   </tr>
291   <tr>
292     <td><code><b>EmptyPlugin.pm</b></code></td>
293     <td> Empty plugin, use to create your own </td>
294   </tr>
295   <tr>
296     <td><code><b>InterwikiPlugin.pm</b></code></td>
297     <td> Refer to external Wikis and other Web sites </td>
298   </tr>
299 </table>
300
301 <a name="PubFiles"></a>
302
303 #### <a name="Files in twiki/pub"></a> Files in `twiki/pub`
304
305 **_to follow_**
306
307 <a name="DataFiles"></a>
308
309 #### <a name="Files in twiki/data"></a> Files in `twiki/data`
310
311 **_to follow_**
312
313 <a name="TemplatesFiles"></a>
314
315 #### <a name="Files in twiki/templates"></a> Files in `twiki/templates`
316
317 **_to follow_**
318
319 -- [[MikeMannix]] - 28 Aug 2001