TWiki Implementation Notes


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.

Required Environment by Platform
Package(s): Unix: Windows:
Perl 5.x 5.x
Non-standard Perl modules    
Optional Perl modules Net::SMTP (or sendmail) Net::SMTP
RCS 5.7 5.7
Other external programs ls, fgrep, egrep ?
Web server Apache ?

Directory Structure

Directory: Used for:
twiki/bin TWiki Perl scripts
twiki/lib/TWiki TWiki Perl modules
twiki/lib/TWiki/Plugins Plugins modules
twiki/pub Public files (FileAttachments, images)
twiki/data source text
twiki/templates HTML templates, used by TWiki scripts

Files in twiki/bin

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

Files in twiki/lib

File: Used for: Main TWiki library
TWiki.cfg For initialization and configuration, used by

Files in twiki/lib/TWiki

File: Used for: Access control SMTP mail handling Plugin handling Preferences handling Search engine, used by Back-end storage, *.txt text file and *.txt,v RCS repository file handling

Files in twiki/lib/TWiki/Plugins

File: Used for: Default plugin Empty plugin, use to create your own

-- MikeMannix - 26 Aug 2001

This topic: TWiki > TWikiSystemRequirements
Topic revision: r6 - 2001-08-27 - MikeMannix
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2021 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 at TWiki:TWiki.TWikiSystemRequirements.