TWikiSystemRequirements < TWiki

%TOC%
%STARTINCLUDE%
---## TWiki Implementation Notes

---+++ Platforms and System Requirements 

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...__ ]

| *Required Environment by Platform* |||
| *Packages:* | *Linux/Unix:* | *Windows:* |
| Perl       |   5.x   |   5.x  |
| Non-standard Perl modules | | =MIME::Base64=, Digest::SHA1 (for password generation) |
| Optional Perl modules | =Net::SMTP= (or sendmail) |  =Net::SMTP=  | 
| RCS        |   5.7   |   5.7 (including =diff=  |
| Other external programs |   =ls=, =fgrep=, =egrep=  |  =ls=, =fgrep=, =egrep=  |
| Web server  |   Apache  |   Apache, IIS   |
| _OS versions_ |  __Linux, Unix...__  |  __every last Win?!__  |

---+++ Directory Structure

You can easily rename the root TWiki directory - ==twiki== - 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:

| *Directory:*        | *Files:*       | *Used for:* |
| ==twiki==           |  [[#TWikiFiles][list]]  | Start-up info |
| ==twiki/bin==       |  [[#BinFiles][list]]  | Perl scripts  |
| ==twiki/lib==       |  [[#LibFiles][list]]  | Configuration file &amp; main library |
| ==twiki/lib/TWiki== |  [[#LibTWiki][list]]  | Perl modules |
| ==twiki/lib/TWiki/Plugins== |  [[#libtwikiplugins][list]]  | TWikiPlugins Perl modules |
| ==twiki/pub==       |  [[#PubFiles][list]]  | Public support files (ex: FileAttachments, images) and RCS histories) |
| ==twiki/data==      |  [[#DataFiles][list]]  | Topic text (page content) and RCS histories; |
| ==twiki/templates== |  [[#TemplatesFiles][list]]  | HTML templates, used by TWiki scripts |

__Note: about the additional directories in data, elsewhere__

#TWikiFiles
---++++ Files in <code>twiki</code>

__to follow__

#BinFiles
---++++ Files in <code>twiki/bin</code>

| *File:*       | *Used for:* |
| ==.htaccess.txt== | Authentication. Rename to .htaccess and customize if used |
| ==attach==        | Script that shows the attach file page (FileAttachment) |
| ==delete==        | (not used yet) |
| ==edit==          | Script to edit a topic |
| ==geturl==        | Script to fetch URL data |
| ==mailnotify==    | Script called by cron job to notify users of changes |
| ==oops==          | Script that shows an OK or oops dialog |
| ==preview==       | Script to preview topic after edit |
| ==rdiff==         | Script to see differences of topics |
| ==rename==        | Script to rename/move topics and move attachments |
| ==register==      | Script to register new users |
| ==save==          | Script that saves a topic, called by preview |
| ==search==        | Script that displays search results |
| ==statistics==    | Script to create statistics topic |
| ==testenv==       | Script to test CGI environment variables |
| ==upload==        | Script that does file upload (FileAttachment) |
| ==view==          | Script to view a topic ( *the* script ) |
| ==viewfile==      | Script to view an file attachment |

#LibFiles
---++++ Files in <code>twiki/lib</code>

| *File:*           | *Used for:* |
| ==TWiki.pm==      | Main TWiki library |
| ==TWiki.cfg==     | For configuration, used by ==TWiki.pm== |

#LibTWiki
---++++ Files in <code>twiki/lib/TWiki</code>

| *File:*         | *Used for:* |
| ==Access.pm==   | Access control |
| ==Attach.pm==   | Attachment handling |
| ==Meta.pm==     | Meta data in topics |
| ==Net.pm==      | SMTP mail handling |
| ==Plugins.pm==  | Plugin handling |
| ==Prefs.pm==    | Preferences handling |
| ==Search.pm==   | Search engine, used by wiki.pm |
| ==Store.pm==    | Back-end storage, =*.txt= text file and =*.txt,v= RCS repository file handling |

#LibTWikiPlugins
---++++ Files in <code>twiki/lib/TWiki/Plugins</code>

| *File:*              | *Used for:* |
| ==DefaultPlugin.pm== | Default plugin |
| ==EmptyPlugin.pm==   | Empty plugin, use to create your own |
| ==InterwikiPlugin.pm== | Refer to external Wikis and other Web sites |

#PubFiles
---++++ Files in <code>twiki/pub</code>

__to follow__

#DataFiles
---++++ Files in <code>twiki/data</code>

__to follow__

#TemplatesFiles
---++++ Files in <code>twiki/templates</code>

__to follow__

-- MikeMannix - 28 Aug 2001
This topic: TWiki > TWikiSystemRequirements
Topic revision: r8 - 2001-08-29 - MikeMannix
Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiSystemRequirements.