Difference: TWikiInstallationGuide (1 vs. 65)

Revision 6527 Mar 2005 - Main.TWikiContributor

Line: 1 to 1
 

TWiki Installation Guide

Installation instructions for the TWiki 4.0 production release.

Added:
>
>
If you are upgrading from a previous version of TWiki, you probably want to read TWikiUpgradeGuide instead.
 TWiki should be fine with any web server and OS that meet the system requirements. The following installation instructions are written for experienced system administrators; please review the AdminSkillsAssumptions before you install TWiki. If you need help, ask a question in the TWiki:Support web or on TWiki:Codev.TWikiIRC (irc.freenode.net, channel #twiki)

HELP Hint: TWiki:TWiki.InstallingTWiki on TWiki.org has supplemental documentation that help you install TWiki on different platforms, environments and web hosting sites.

Revision 6427 Mar 2005 - Main.TWikiContributor

Line: 1 to 1
 

TWiki Installation Guide

Line: 35 to 35
 

Next Steps

Once you have your TWiki running, you can move on to customise it for your users.
  • Review TWikiPreferences settings - read through it and set any additional settings you think you might need (you can click the 'Edit' button near the top to edit the settings in place)
Changed:
<
<
>
>
 
  • Customize user home pages - read and change NewUserTemplate.
  • Enable authentication - read TWikiUserAuthentication.
  • Clear admin notes - some pages are meant to be customized after choice of authentication - check and update these topics (remove notice):
Changed:
<
<
>
>
 

Revision 6327 Mar 2005 - Main.TWikiContributor

Line: 1 to 1
 

TWiki Installation Guide

Changed:
<
<
Installation instructions for the TWiki 01-Sep-2004 production release.
>
>
Installation instructions for the TWiki 4.0 production release.
 
Changed:
<
<
If you are reading this on your own TWiki installation, please get the latest installation guide (TWiki:TWiki.TWikiInstallationGuide), as this often has important updates to resolve installation issues.
>
>
TWiki should be fine with any web server and OS that meet the system requirements. The following installation instructions are written for experienced system administrators; please review the AdminSkillsAssumptions before you install TWiki. If you need help, ask a question in the TWiki:Support web or on TWiki:Codev.TWikiIRC (irc.freenode.net, channel #twiki)
 
Changed:
<
<
These installation steps are based on the Apache web server on Linux. TWiki runs on other web servers and Unix systems, and should be fine with any web server and OS that meet the system requirements. Official documentation for platforms other than Linux is somewhat limited, so please check the topics listed below, they include some important tips for HP-UX, Solaris, OS/390, and many other platforms.

>
>
HELP Hint: TWiki:TWiki.InstallingTWiki on TWiki.org has supplemental documentation that help you install TWiki on different platforms, environments and web hosting sites.
 
Changed:
<
<

Standard Installation

Download the TWiki 01-Sep-2004 distribution in Unix ZIP format from http://TWiki.org/download.html. Please review the AdminSkillsAssumptions before you install TWiki.

Step 1: Create & Configure the Directories

ALERT! NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account, or you don't have administrator privileges on your intranet server - use the alternative Step 1 instead.

  • Create directory /home/httpd/twiki and unzip the TWiki distribution into this directory.
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file httpd.conf (typcially located in /etc/httpd/) with only ExecCGI option.
  • The twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki to file httpd.conf with normal access options (copy from /home/httpd/html ).
  • Now add ScriptAlias for /twiki/bin and Alias for /twiki to file httpd.conf .
    ALERT! NOTE: The ScriptAlias must come before the Alias, otherwise, Apache will fail to correctly set up /twiki/bin/, by treating it as just another subdirectory of the /twiki/ alias.
  • The twiki/data and twiki/templates directories should be set so that they are not visible as URLs. Add them to httpd.conf with deny from all.

Example httpd.conf entries:
 ScriptAlias /twiki/bin/ "/home/httpd/twiki/bin/"
 Alias /twiki/ "/home/httpd/twiki/"
 <Directory "/home/httpd/twiki/bin">
	 Options +ExecCGI
	 SetHandler cgi-script
	 Allow from all
 </Directory>
 <Directory "/home/httpd/twiki/pub">
	 Options FollowSymLinks +Includes
	 AllowOverride None
	 Allow from all
 </Directory>
 <Directory "/home/httpd/twiki/data">
	 deny from all
 </Directory>
 <Directory "/home/httpd/twiki/templates">
	 deny from all
 </Directory>

  • Restart Apache by service httpd restart (or as appropriate to your flavor of UNIX or Linux).
  • Test that the twiki/bin directory is CGI-enabled by trying visiting it in your browser:
    • Enter the URL for the bin directory, http://yourdomain.com/twiki/bin/
    • Your settings are OK if you get a message like "Forbidden. You don't have permission to access /twiki/bin/ on this server".
    • Settings are NOT correct if you get something like "Index of /twiki/bin" - recheck your httpd.conf file.

Aletrnative Step 1: Create & Configure the Directories for Non-Root Accounts

To install TWiki on a system where you don't have Unix/Linux root (administrator) privileges, for example, on a hosted Web account or an intranet server administered by someone else:

  • Download and unzip TWiki on your local PC
  • Using the table below, create a directory structure on your host server
  • Upload the TWiki files by FTP (transfer as text except for the image files in pub)
TWiki dir: What it is: Where to copy: Example:
twiki start-up pages root TWiki dir /home/smith/twiki/
twiki/bin CGI bin CGI-enabled dir /home/smith/twiki/bin
twiki/lib library files same level as twiki/bin /home/smith/twiki/lib
twiki/pub public files htdoc enabled dir /home/smith/twiki/pub
twiki/data topic data dir secure from public access /home/smith/twiki/data
twiki/templates web templates dir secure from public access /home/smith/twiki/templates

Note: Don't worry if you are not able to put the twiki/lib directory at the same level as the twiki/bin directory (e.g. because CGI bin directories can't be under your home directory and you don't have root access). You can create this directory elsewhere and configure the /twiki/bin/setlib.cfg file (done in Step 3)

Step 2: Set File Permissions

  • Make sure Perl 5 and the Perl CGI library are installed on your system. The default location of Perl is /usr/bin/perl. If it's elsewhere, change the path to Perl in the first line of each script in the twiki/bin directory, or create a symbolic link from /usr/bin/perl.
    • IMPORTANT:
      • On ISP-hosted accounts (and some intranet servers), Perl CGI scripts may require a .cgi extension to run. Some systems need .pl, the regular Perl extension. Rename all twiki/bin scripts if necessary.
      • Alternatively, you might try creating a file twiki/bin/.htaccess that contains the single line SetHandler cgi-script, which tells Apache to treat all files in this directory as CGI scripts.
  • Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x (755).
  • To be able to edit the Perl scripts and .tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
  • HELP This Guide assumes user nobody ownership for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. You can:
    • replace nobody with another user if your server executes scripts under a different name (ex: default for Debian is www-data).
      • TIP HINT: Run the testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. It will show you the user name of the CGI scripts, a table listing all CGI environment variables, and a test of your twiki/lib/TWiki.cfg configuration file (you'll configure that in a minute).
    • replace user twiki with your own username
  • Set permissions manually.
    • Set the permission of all files below twiki/data so that they are writable by user nobody. A simple way is to chmod them to -rw-rw-r-- (664) and to chown them to nobody.
    • Set the permission of the twiki/data directory and its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
    • Set the permission of the twiki/pub directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
    • HELP The twiki/data/*/*.txt,v RCS repository files in the installation package are locked by user nobody. If your CGI scripts are not running as user nobody, it's not possible to check in files (you'll see that the revision number won't increase after saving a topic). In this case, you need to unlock all repository files (check the RCS man pages) and lock them with a different user, such as www-data, or delete them all - new files will be automatically created the first time each topic is edited. You have two options to change ownership of the RCS lock user:
      • Run the testenv script from your browser; in the Fix line you can relock all the rcs files (recommended)
      • Alternatively, run this in your shell:
        cd twiki/data
        find . -name ,v -exec perl -pi~ -e '$. <= 10 && s/nobody:/www-data:/ ' {} \;
        This will create
        ,v~ backup files which you should remove after verification:
        find . -name *,v~ -exec rm -f {} \;

Step 3: Edit the Configuration Files

  • Edit the file /twiki/bin/setlib.cfg
    • Set $twikiLibPath to the absolute file path of your /twiki/lib as seen by the web server.
    • ALERT! Attention: Do not leave it as a relative "../lib" path or Plugins might fail to initialize properly
    • You can also edit $localPerlLibPath if you are not root and need to install additional CPAN modules, but can't update the main Perl installation files on the server. Just set this variable to the full pathname to your local lib directory, typically under your home directory.
    • ALERT! Attention: If you are running TWiki on Apache 2.0 on Unix you might experience cgi scripts to hang forever. This is a known Apache 2.0 bug. See details and woraround in the setlib.cfg file.
  • Edit the file twiki/lib/TWiki.cfg, setting the variables to your needs.
    • Set the file extension in the $scriptSuffix variable to cgi or pl if required.
    • RCS - revision control system to store revision of topics and attachments. You can use RCS executables or a version of RCS written in Perl, note that as the time of writing (Apr 2002) the Perl version has not been widely tested, so if you want to put up a live site the RCS executables are recommended.
      • Set $storeTopicImpl = "RcsWrap"; for the RCS executables and make sure RCS is installed. Set $rcsDir in twiki/lib/TWiki.cfg to match the location of your RCS binaries. You can check this by issuing the command rcs at the prompt, it should result in something like "rcs: no input file".
        • Check that you have GNU diff, by typing diff -v - an error indicates you have a non-GNU diff, so install the GNU diffutils package and make sure that diff is on the PATH used by TWiki (see $safeEnvPath in the TWiki.cfg file).
      • Set $storeTopicImpl = "RcsLite"; for the Perl based RCS
  • Security issue: Directories twiki/data , twiki/templates and all their subdirectories should be set so that they are not visible through URLs. (Alternatively, move the directories to a place where they are not visible, and change the variables in twiki/lib/TWiki.cfg accordingly)
  • Test your settings by running the testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. Check if your twiki/lib/TWiki.cfg configuration file settings are correct.

Step 4: Internationalisation Setup (Optional)

By default, TWiki is configured to support US ASCII letters (no accents) in WikiWords, and ISO-8859-1 (Western European) characters in page contents. If that's OK for you, skip this step.

If your Wiki will be used by non-English speakers, TWiki can be configured for Internationalisation ('I' followed by 18 letters, then 'N', or I18N). Specifically, TWiki will support suitable accented characters in WikiWords (as well as languages such as Japanese or Chinese in which WikiWords do not apply), and will support virtually any character set in the contents of pages. NOTE: TWiki does not currently support UTF-8, so you are advised not to use this - however, improved UTF-8 support is under development, see TWiki:Codev/ProposedUTF8SupportForI18N.

To configure internationalisation suppport:

  1. Edit the TWiki.cfg file's Internationalisation section to set the $useLocale parameter to 1. TWiki will now use the I18N parameters set in the rest of this section.
  2. Type the Unix/Linux command locale -a to find a suitable 'locale' for your use of TWiki. A locale that includes a dot followed by a character set is recommended, e.g. pl_PL.ISO-8859-2 for Poland. Consult your system administrator if you are not sure which locale to use.
  3. In TWiki.cfg, set the $siteLocale parameter to your chosen locale, e.g. pl_PL.ISO-8859-2 for Poland.
  4. Check your setup using testenv (download the latest testenv from TWiki:Support/SupportGuidelines if possible) - this provides some diagnostics for I18N setup, and in particular checks that your locale can be used successfully.
  5. (For upgrade of TWiki I18N sites only:) If you were using TWiki:Codev.TWikiRelease01Feb2003 support for I18N, and are using Internet Explorer or Opera, you should re-configure your browser so that it sends URLs encoded with UTF-8 (supported since TWiki:Codev.TWikiRelease01Sep2004). If you are doing a new installation of TWiki, you can ignore this step - no browser reconfiguration is needed for TWiki Release 01-Sep-2004).
    • Internet Explorer 5.0 or higher: in Tools | Options | Advanced, check 'always send URLs as UTF-8', then close all IE windows and restart IE.
    • Opera 6.x or higher: in Preferences | Network | International Web Addresses, check 'encode all addresses with UTF-8'.
    • NOTE: This does not mean that TWiki supports UTF-8 as a site character set.
  6. Try out your TWiki by creating pages in the Sandbox web that use international characters in WikiWords and checking that searching, WebIndex, Ref-By and other features are working OK.

Trouble with I18N?

If international characters in WikiWords do not seem to work, and you are on Perl 5.6 or higher, you may need to set the TWiki.cfg parameter $localeRegexes to 0 - this disables some features but enables TWiki to work even if your system has locales that do not work. Then, set the $upperNational and $lowerNational parameters to the valid upper and lower case accented letters for your locale.

  • NOTE: You will need to do the above workaround for Windows based servers (whether using Cygwin or ActiveState Perl), since Perl locales are not working on Windows as of Feb 2004.

If international characters in WikiWords aren't working, and you are on Perl 5.005 with working locales, keep $useLocale set to 1 and set $localeRegexes to 0, then set $upperNational and $lowerNational - if testenv generates the lists of characters for you, your locales are working so there is no need to set $localeRegexes to 0 in this case. See the comments in TWiki.cfg for more information.

Step 5: Configure Site-Wide Email Preferences

  • Edit the TWikiPreferences topic in the TWiki web (by pointing your browser to http://yourdomain.com/twiki/bin/view/TWiki/TWikiPreferences) to set the WIKIWEBMASTER email address, and other email settings required for registration and WebChangesAlert to work:
    • WIKIWEBMASTER should be set to the email address of the TWiki administrator
    • SMTPMAILHOST is typically set on Windows or other non-Unix/Linux systems, where sendmail or similar is not available. When this is set and the Perl module Net::SMTP is installed, TWiki will connect to this SMTP server (e.g. mail.yourdomain.com) to send email for user registration and WebChangesAlerts. If you do have a sendmail-type program, leave SMTPMAILHOST unset so that the external sendmail program is used instead (defined by $mailProgram in TWiki.cfg).
    • SMTPSENDERHOST is optional, and set to the domain name sending the email (e.g. twiki.yourdomain.com). For use where the SMTP server requires that you identify the TWiki server sending mail. If not set, Net::SMTP will guess it for you.
  • You may want to set up other TWikiPreferences later on.
  • To enable the WebChangesAlerts (email notifications) you need to read about cron in the topic TWikiSiteTools.

Step 6: Finish Up from Your Browser

  • Point your Web browser at http://yourdomain.com/twiki/bin/view and start TWiki-ing away!
    • TIP Or, point to http://yourdomain.com/twiki/ to get the pre-TWiki index.html page, with a link to the view script. Customize this page if you want a public intro screen with a login link, instead of immediately calling up the .htaccess login dialog by going directly to view.
  • Edit the WebPreferences topic in each web, if necessary: set individual WEBCOPYRIGHT messages, and other preferences.
  • Enable email notification of topic changes - TWikiSiteTools has more.
  • Edit the WebNotify topic in all webs and add the users you want to notify.
  • Add the TWiki:Main/PoweredByTWikiLogo to your Main.WebHome topic.
  • You can add new %VARIABLES%. Define site-level variables in the TWikiPreferences topic. See also: TWikiVariables.

That's it for the standard installation of TWiki. Read on for server-level customization options.

>
>

Basic Installation

 
Changed:
<
<

Additional Server-Level Options

With your new TWiki installation up and running, you can manage most aspects of your site from the browser interface. Only a few functions require access to the server file system, via Telnet or FTP. You can make these server-level changes during installation, and at any time afterwards.

>
>
  1. Download the TWiki distribution from http://TWiki.org/download.html.
  2. Make a directory for the installation and unpack the distribution in it.
  3. Make sure the user that runs CGI scripts on your system can read and write all files in the distribution.
    Detailed instructions on file permissions are beyond the scope of this guide, but in general:
    • During installation and configuration, the CGI user needs to be able to read and write everything in the distribution,
    • Once installation and configuration is complete, the CGI user needs write access to everything under the data and pub directories and to lib/LocalSite.cfg. Everything else should be read-only.
    • Everybody else should be denied access to everything, always.
  4. Make sure Perl 5 and the Perl CGI library are installed on your system.
    The default location of Perl is /usr/bin/perl. If it's somewhere else, change the path to Perl in the first line of each script in the twiki/bin directory.
    HELP Some systems require a special extension on perl scripts (e.g. .cgi or .pl). If necessary, rename all files in twiki/bin (i.e. rename view to view.pl etc). If you do this, make sure you set the ScriptSuffix option in configure (Step 6).
  5. Create the file /twiki/bin/LocalLib.cfg.
    There is a template for this file in /twiki/bin/LocalLib.cfg.txt.
    The file must contain a setting for $twikiLibPath, which must point to the absolute file path of your twiki/lib e.g. /home/httpd/twiki/lib.
    HELP If you need to install additional CPAN modules, but can't update the main Perl installation files on the server, you can set $CPANBASE to point to your personal CPAN install. Don't forget that the webserver user has to be able to read those files as well.
  6. Configure the webserver so you can execute the bin/configure script from your browser.
    • Explicit instructions for doing this are beyond the scope of this document, though there is a lot of advice on TWiki.org covering different configurations of webserver. To help you out, there's an example Apache httpd.conf file in twiki_httpd_conf.txt at the root of the package. This file also contains advice on securing your installation. There's also a script called tools/rewriteshebang.pl to help you in fixing up the shebang lines in your CGI scripts.
  7. Run the configure script from your browser, and resolve any errors or warnings it tells you about.
You now have a basic, unauthenticated installation running. At this point you can just point your Web browser at http://yourdomain.com/twiki/bin/view and start TWiki-ing away!
 
Changed:
<
<

Enabling Authentication of Users

  • If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users:
    1. Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. The comment at the top of the file explains what need to be done, basically replace !FILE_path_to_TWiki! and !URL_path_to_TWiki! with paths specific to your installation. For the details of how this file works, consult the HTTP server documentation (for Apache server: [1], [2]).
      • ALERT! NOTE: If you had to add a .cgi or .pl file extension to the bin scripts, make sure to do the same for edit, view, preview, and all the other script names in .htaccess.
      • HELP The browser should ask for login name and password when you click on the Edit link. In case .htaccess does not have the desired effect, you need to enable it: Add "AllowOverride All" to the Directory [3] section of access.conf for your twiki/bin directory.
        • This applies only if you have root access: on hosted accounts, you shouldn't have this problem - otherwise, email tech support.
      • ALERT! NOTE: In the TWiki distribution package, the twiki/data/.htpasswd.txt file contains several TWiki core team user accounts and a guest user account. You probably want to remove those accounts by deleting the entries in .htpasswd. Do not remove the guest user if you want to allow guest logins.
    2. TWiki now supports several Password file format/encoding methods for Apache. Once you know what method is used by your Appache server, you can configure TWiki to create compatible .htpasswd entries by editing the $htpasswdFormatFamily, $htpasswdEncoding and $htpasswdFilename in the TWiki.cfg file. The supported options are htpasswd:plain, htpasswd:crypt, htpasswd:sha1, htdigest:md5
    3. Copy the TWikiRegistrationPub? topic to TWikiRegistration, overwriting old version of TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the .txt and .txt,v files in the twiki/data/TWiki directory.
  • Customization:
    • You can customize the registration form by deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This ensures that the fields are carried over into the user home page correctly.
    • You can customize the default user home page in NewUserTemplate. The same variables get expanded as in the template topics
  • Register yourself in the TWikiRegistration topic.
    • ALERT! NOTE: When a user registers, a new line with the username and encrypted password is added to the data/.htpasswd file. The .htpasswd file that comes with the TWiki installation includes user accounts for TWiki core team members that are used for testing on TWiki.org. You can edit the file and delete those lines.
  • Create a new topic to check if authentication works.
  • Edit the TWikiAdminGroup topic in the TWiki:Main web to include users with system administrator status.
  • Edit the TWikiPreferences topic in the TWiki:TWiki web to set access privileges.
  • Edit the WebPreferences topic in each web, if necessary: set access priviliges.

WYSIWYG Editor

At this time, TWiki does not ship with an "what you see is what you get" editor. TWiki:Codev/IntegrateHtmlAreaEditor describes how to integrate an HTML editor.

ALERT! NOTE: User home topics are located in the Proyecto META.Main web - don't try to move them or create them in other webs. From any other web, user signatures have to point to Proyecto META.Main web, using a Main.UserName or %MAINWEB%.UserName format. (The %MAINWEB% variable is an advantage if you ever change the Main web name, but the standard Main.UserName is easier for users to enter, which is the bottom line!)

TWiki File System Info

See Appendix A: TWiki File System? for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2004 distribution.

>
>

Next Steps

Once you have your TWiki running, you can move on to customise it for your users.

Troubleshooting

  • The first step is to re-run the configure script and make sure you have resolved all errors, and are happy that you understand any warnings.
  • TWiki:TWiki.InstallingTWiki on TWiki.org has supplemental documentation that help you install TWiki on different platforms, environments and web hosting sites.
  • If you need help, ask a question in the TWiki:Support web or on TWiki:Codev.TWikiIRC (irc.freenode.net, channel #twiki)
 
Deleted:
<
<
-- TWiki:Main/PeterThoeny - 29 Aug 2004
-- TWiki:Main/MikeMannix - 16 May 2002
 
Changed:
<
<
META TOPICMOVED by="MikeMannix" date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide"
>
>
Related Topics: AdminDocumentationCategory, TWiki:TWiki.InstallingTWiki

Revision 6231 Aug 2004 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Line: 56 to 56
 
  • Restart Apache by service httpd restart (or as appropriate to your flavor of UNIX or Linux).
  • Test that the twiki/bin directory is CGI-enabled by trying visiting it in your browser:
Changed:
<
<
    • Enter the URL for the bin directory, http://yourdomain.com/twiki/bin/.
>
>
    • Enter the URL for the bin directory, http://yourdomain.com/twiki/bin/
 
    • Your settings are OK if you get a message like "Forbidden. You don't have permission to access /twiki/bin/ on this server".
    • Settings are NOT correct if you get something like "Index of /twiki/bin" - recheck your httpd.conf file.
Line: 199 to 199
 At this time, TWiki does not ship with an "what you see is what you get" editor. TWiki:Codev/IntegrateHtmlAreaEditor describes how to integrate an HTML editor.
Changed:
<
<
ALERT! NOTE: User home topics are located in the Proyecto META.Main web - don't try to move them or create them in other webs. From any other web, user signatures have to point to Proyecto META.Main web, using a Main.UserName or %MAINWEB%.UserName format. (The %MAINWEB% variable is an advantage if you ever change the Main web name, but the standard Main.UserName is easier for users to enter, which is the bottom line!
>
>
ALERT! NOTE: User home topics are located in the Proyecto META.Main web - don't try to move them or create them in other webs. From any other web, user signatures have to point to Proyecto META.Main web, using a Main.UserName or %MAINWEB%.UserName format. (The %MAINWEB% variable is an advantage if you ever change the Main web name, but the standard Main.UserName is easier for users to enter, which is the bottom line!)
 

TWiki File System Info

Revision 6129 Aug 2004 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Line: 63 to 63
 

Changed:
<
<

Step 1 for Non-Root Accounts

>
>

Aletrnative Step 1: Create & Configure the Directories for Non-Root Accounts

 To install TWiki on a system where you don't have Unix/Linux root (administrator) privileges, for example, on a hosted Web account or an intranet server administered by someone else:
Line: 100 to 100
 
    • Set the permission of the twiki/data directory and its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
    • Set the permission of the twiki/pub directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
    • HELP The twiki/data/*/*.txt,v RCS repository files in the installation package are locked by user nobody. If your CGI scripts are not running as user nobody, it's not possible to check in files (you'll see that the revision number won't increase after saving a topic). In this case, you need to unlock all repository files (check the RCS man pages) and lock them with a different user, such as www-data, or delete them all - new files will be automatically created the first time each topic is edited. You have two options to change ownership of the RCS lock user:
Changed:
<
<
      • Run the testenv script from your browser; in the Fix line you can relock all the rcs files
>
>
      • Run the testenv script from your browser; in the Fix line you can relock all the rcs files (recommended)
 
      • Alternatively, run this in your shell:
        cd twiki/data
Changed:
<
<
find . -name *.v~ -exec perl -pi~ -e '$. <= 10 && s/nobody:/www-data:/ ' {} ;
>
>
find . -name *,v -exec perl -pi~ -e '$. <= 10 && s/nobody:/www-data:/ ' {} \;
This will create *,v~ backup files which you should remove after verification:
find . -name *,v~ -exec rm -f {} \;
 

Step 3: Edit the Configuration Files

Line: 176 to 178
 

Enabling Authentication of Users

  • If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users:
Changed:
<
<
    1. Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details, consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
      Redirect /urlpathto/twiki/index.html http://yourdomain.com/urlpathto/twiki/bin/view
      AuthUserFile /filepathto/twiki/data/.htpasswd
      ErrorDocument 401 /urlpathto/twiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
>
>
    1. Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. The comment at the top of the file explains what need to be done, basically replace !FILE_path_to_TWiki! and !URL_path_to_TWiki! with paths specific to your installation. For the details of how this file works, consult the HTTP server documentation (for Apache server: [1], [2]).
 
      • ALERT! NOTE: If you had to add a .cgi or .pl file extension to the bin scripts, make sure to do the same for edit, view, preview, and all the other script names in .htaccess.
      • HELP The browser should ask for login name and password when you click on the Edit link. In case .htaccess does not have the desired effect, you need to enable it: Add "AllowOverride All" to the Directory [3] section of access.conf for your twiki/bin directory.
        • This applies only if you have root access: on hosted accounts, you shouldn't have this problem - otherwise, email tech support.
Line: 206 to 205
 See Appendix A: TWiki File System? for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2004 distribution.
Changed:
<
<
-- TWiki:Main/PeterThoeny - 15 Aug 2004
>
>
-- TWiki:Main/PeterThoeny - 29 Aug 2004
 -- TWiki:Main/MikeMannix - 16 May 2002

Revision 6017 Aug 2004 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Line: 127 to 127
 By default, TWiki is configured to support US ASCII letters (no accents) in WikiWords, and ISO-8859-1 (Western European) characters in page contents. If that's OK for you, skip this step.
Changed:
<
<
If your Wiki will be used by non-English speakers, TWiki can be configured for Internationalisation ('I' followed by 18 letters, then 'N', or I18N). Specifically, TWiki will support suitable accented characters in WikiWords (as well as languages such as Japanese or Chinese in which WikiWords do not apply), and to support virtually any character set in the contents of pages. NOTE: TWiki does not currently support UTF-8, so you are advised not to use this - however, improved UTF-8 support is under development.
>
>
If your Wiki will be used by non-English speakers, TWiki can be configured for Internationalisation ('I' followed by 18 letters, then 'N', or I18N). Specifically, TWiki will support suitable accented characters in WikiWords (as well as languages such as Japanese or Chinese in which WikiWords do not apply), and will support virtually any character set in the contents of pages. NOTE: TWiki does not currently support UTF-8, so you are advised not to use this - however, improved UTF-8 support is under development, see TWiki:Codev/ProposedUTF8SupportForI18N.
 To configure internationalisation suppport:
  1. Edit the TWiki.cfg file's Internationalisation section to set the $useLocale parameter to 1. TWiki will now use the I18N parameters set in the rest of this section.
  2. Type the Unix/Linux command locale -a to find a suitable 'locale' for your use of TWiki. A locale that includes a dot followed by a character set is recommended, e.g. pl_PL.ISO-8859-2 for Poland. Consult your system administrator if you are not sure which locale to use.
  3. In TWiki.cfg, set the $siteLocale parameter to your chosen locale, e.g. pl_PL.ISO-8859-2 for Poland.
  4. Check your setup using testenv (download the latest testenv from TWiki:Support/SupportGuidelines if possible) - this provides some diagnostics for I18N setup, and in particular checks that your locale can be used successfully.
Changed:
<
<
  1. If you are using Internet Explorer or Opera, configure your browser to not send URLs encoded with UTF-8
    • Internet Explorer 5.0 or higher: in Tools | Options | Advanced, uncheck 'always send URLs as UTF-8', then close all IE windows and restart IE.
    • Opera 6.x or higher: in Preferences | Network | International Web Addresses, uncheck 'encode all addresses with UTF-8'.
    • NOTE: If this configuration change is not acceptable, consider installing a TWiki beta release (19 Jan 2004 or later), which fully supports UTF-8 URLs.
>
>
  1. (For upgrade of TWiki I18N sites only:) If you were using TWiki:Codev.TWikiRelease01Feb2003 support for I18N, and are using Internet Explorer or Opera, you should re-configure your browser so that it sends URLs encoded with UTF-8 (supported since TWiki:Codev.TWikiRelease01Sep2004). If you are doing a new installation of TWiki, you can ignore this step - no browser reconfiguration is needed for TWiki Release 01-Sep-2004).
    • Internet Explorer 5.0 or higher: in Tools | Options | Advanced, check 'always send URLs as UTF-8', then close all IE windows and restart IE.
    • Opera 6.x or higher: in Preferences | Network | International Web Addresses, check 'encode all addresses with UTF-8'.
    • NOTE: This does not mean that TWiki supports UTF-8 as a site character set.
 
  1. Try out your TWiki by creating pages in the Sandbox web that use international characters in WikiWords and checking that searching, WebIndex, Ref-By and other features are working OK.
Added:
>
>

Trouble with I18N?

 If international characters in WikiWords do not seem to work, and you are on Perl 5.6 or higher, you may need to set the TWiki.cfg parameter $localeRegexes to 0 - this disables some features but enables TWiki to work even if your system has locales that do not work. Then, set the $upperNational and $lowerNational parameters to the valid upper and lower case accented letters for your locale.
Changed:
<
<
  • NOTE: You will need to do the above workaround for Windows based servers (whether using Cygwin or ActiveState Perl), since Perl locales are not working on Windows as of Feb 2004.
>
>
  • NOTE: You will need to do the above workaround for Windows based servers (whether using Cygwin or ActiveState Perl), since Perl locales are not working on Windows as of Feb 2004.
 If international characters in WikiWords aren't working, and you are on Perl 5.005 with working locales, keep $useLocale set to 1 and set $localeRegexes to 0, then set $upperNational and $lowerNational - if testenv generates the lists of characters for you, your locales are working so there is no need to set $localeRegexes to 0 in this case. See the comments in TWiki.cfg for more information.

Revision 5916 Aug 2004 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Changed:
<
<
Installation instructions for the TWiki 01-Feb-2003 production release.
>
>
Installation instructions for the TWiki 01-Sep-2004 production release.
 If you are reading this on your own TWiki installation, please get the latest installation guide (TWiki:TWiki.TWikiInstallationGuide), as this often has important updates to resolve installation issues.
Line: 14 to 14
 
Changed:
<
<
>
>
 

Standard Installation

Changed:
<
<
Request and download the TWiki 01-Feb-2003 distribution in Unix ZIP format from http://TWiki.org/download.html. Please review the AdminSkillsAssumptions before you install TWiki.
>
>
Download the TWiki 01-Sep-2004 distribution in Unix ZIP format from http://TWiki.org/download.html. Please review the AdminSkillsAssumptions before you install TWiki.
 

Step 1: Create & Configure the Directories

Line: 54 to 54
  </Directory>
Changed:
<
<
  • Restart Apache by /etc/rc.d/rc5.d/S85httpd restart .
>
>
  • Restart Apache by service httpd restart (or as appropriate to your flavor of UNIX or Linux).
 
  • Test that the twiki/bin directory is CGI-enabled by trying visiting it in your browser:
    • Enter the URL for the bin directory, http://yourdomain.com/twiki/bin/.
    • Your settings are OK if you get a message like "Forbidden. You don't have permission to access /twiki/bin/ on this server".
Line: 80 to 80
 
twiki/templates web templates dir secure from public access /home/smith/twiki/templates
Changed:
<
<
If you are not able to create the twiki/lib directory at the same level as the twiki/bin directory (e.g. because CGI bin directories can't be under your home directory and you don't have root access), you can create this directory elsewhere and edit the setlib.cfg file in the bin directory:

	 # -------------- Change these settings if required

	 $twikiLibPath = '/some/other/path/lib';	# Path to lib directory containing TWiki.pm

You can also edit $localPerlLibPath in the setlib.cfg file if you are not root and need to install additional CPAN modules, but can't update the main Perl installation files on the server. Just set this variable to the full pathname to your local lib directory, typically under your home directory.

>
>
Note: Don't worry if you are not able to put the twiki/lib directory at the same level as the twiki/bin directory (e.g. because CGI bin directories can't be under your home directory and you don't have root access). You can create this directory elsewhere and configure the /twiki/bin/setlib.cfg file (done in Step 3)
 

Step 2: Set File Permissions

  • Make sure Perl 5 and the Perl CGI library are installed on your system. The default location of Perl is /usr/bin/perl. If it's elsewhere, change the path to Perl in the first line of each script in the twiki/bin directory, or create a symbolic link from /usr/bin/perl.
Changed:
<
<
    • IMPORTANT: On ISP-hosted accounts (and some intranet servers), Perl CGI scripts may require a .cgi extension to run. Some systems need .pl, the regular Perl extension. Rename all twiki/bin scripts if necessary.
>
>
    • IMPORTANT:
      • On ISP-hosted accounts (and some intranet servers), Perl CGI scripts may require a .cgi extension to run. Some systems need .pl, the regular Perl extension. Rename all twiki/bin scripts if necessary.
      • Alternatively, you might try creating a file twiki/bin/.htaccess that contains the single line SetHandler cgi-script, which tells Apache to treat all files in this directory as CGI scripts.
 
  • Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x (755).
  • To be able to edit the Perl scripts and .tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
  • HELP This Guide assumes user nobody ownership for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. You can:
    • replace nobody with another user if your server executes scripts under a different name (ex: default for Debian is www-data).
      • TIP HINT: Run the testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. It will show you the user name of the CGI scripts, a table listing all CGI environment variables, and a test of your twiki/lib/TWiki.cfg configuration file (you'll configure that in a minute).
    • replace user twiki with your own username
Changed:
<
<
  • Set the permission of all files below twiki/data so that they are writable by user nobody. A simple way is to chmod them to -rw-rw-r-- (664) and to chown them to nobody.
  • Set the permission of the twiki/data directory and its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
>
>
  • Set permissions manually.
    • Set the permission of all files below twiki/data so that they are writable by user nobody. A simple way is to chmod them to -rw-rw-r-- (664) and to chown them to nobody.
    • Set the permission of the twiki/data directory and its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
 
  • Set the permission of the twiki/pub directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
Changed:
<
<
  • HELP The twiki/data/*/*.txt,v RCS repository files in the installation package are locked by user nobody. If your CGI scripts are not running as user nobody, it's not possible to check in files (you'll see that the revision number won't increase after saving a topic). In this case, you need to unlock all repository files (check the RCS man pages) and lock them with a different user, such as www-data, or delete them all - new files will be automatically created the first time each topic is edited. A simple way to change ownership is with a search-and-replace in all files; for example, using Perl (type this carefully!):
cd twiki/data
perl -pi~ -e 'NR <= 10 && s/nobody:/www-data:/ ' */*,v

>
>
    • HELP The twiki/data/*/*.txt,v RCS repository files in the installation package are locked by user nobody. If your CGI scripts are not running as user nobody, it's not possible to check in files (you'll see that the revision number won't increase after saving a topic). In this case, you need to unlock all repository files (check the RCS man pages) and lock them with a different user, such as www-data, or delete them all - new files will be automatically created the first time each topic is edited. You have two options to change ownership of the RCS lock user:
      • Run the testenv script from your browser; in the Fix line you can relock all the rcs files
      • Alternatively, run this in your shell:
        cd twiki/data
        find . -name *.v~ -exec perl -pi~ -e '$. <= 10 && s/nobody:/www-data:/ ' {} ;
 
Deleted:
<
<

Step 3: Set the Main Configuration File

 
Added:
>
>

Step 3: Edit the Configuration Files

  • Edit the file /twiki/bin/setlib.cfg
    • Set $twikiLibPath to the absolute file path of your /twiki/lib as seen by the web server.
    • ALERT! Attention: Do not leave it as a relative "../lib" path or Plugins might fail to initialize properly
    • You can also edit $localPerlLibPath if you are not root and need to install additional CPAN modules, but can't update the main Perl installation files on the server. Just set this variable to the full pathname to your local lib directory, typically under your home directory.
    • ALERT! Attention: If you are running TWiki on Apache 2.0 on Unix you might experience cgi scripts to hang forever. This is a known Apache 2.0 bug. See details and woraround in the setlib.cfg file.
 
  • Edit the file twiki/lib/TWiki.cfg, setting the variables to your needs.
    • Set the file extension in the $scriptSuffix variable to cgi or pl if required.
    • RCS - revision control system to store revision of topics and attachments. You can use RCS executables or a version of RCS written in Perl, note that as the time of writing (Apr 2002) the Perl version has not been widely tested, so if you want to put up a live site the RCS executables are recommended.
Line: 126 to 123
 
  • Test your settings by running the testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. Check if your twiki/lib/TWiki.cfg configuration file settings are correct.
Changed:
<
<

Step 4: Configure Site-Wide Email Preferences

>
>

Step 4: Internationalisation Setup (Optional)

By default, TWiki is configured to support US ASCII letters (no accents) in WikiWords, and ISO-8859-1 (Western European) characters in page contents. If that's OK for you, skip this step.

If your Wiki will be used by non-English speakers, TWiki can be configured for Internationalisation ('I' followed by 18 letters, then 'N', or I18N). Specifically, TWiki will support suitable accented characters in WikiWords (as well as languages such as Japanese or Chinese in which WikiWords do not apply), and to support virtually any character set in the contents of pages. NOTE: TWiki does not currently support UTF-8, so you are advised not to use this - however, improved UTF-8 support is under development.

To configure internationalisation suppport:

  1. Edit the TWiki.cfg file's Internationalisation section to set the $useLocale parameter to 1. TWiki will now use the I18N parameters set in the rest of this section.
  2. Type the Unix/Linux command locale -a to find a suitable 'locale' for your use of TWiki. A locale that includes a dot followed by a character set is recommended, e.g. pl_PL.ISO-8859-2 for Poland. Consult your system administrator if you are not sure which locale to use.
  3. In TWiki.cfg, set the $siteLocale parameter to your chosen locale, e.g. pl_PL.ISO-8859-2 for Poland.
  4. Check your setup using testenv (download the latest testenv from TWiki:Support/SupportGuidelines if possible) - this provides some diagnostics for I18N setup, and in particular checks that your locale can be used successfully.
  5. If you are using Internet Explorer or Opera, configure your browser to not send URLs encoded with UTF-8
    • Internet Explorer 5.0 or higher: in Tools | Options | Advanced, uncheck 'always send URLs as UTF-8', then close all IE windows and restart IE.
    • Opera 6.x or higher: in Preferences | Network | International Web Addresses, uncheck 'encode all addresses with UTF-8'.
    • NOTE: If this configuration change is not acceptable, consider installing a TWiki beta release (19 Jan 2004 or later), which fully supports UTF-8 URLs.
  6. Try out your TWiki by creating pages in the Sandbox web that use international characters in WikiWords and checking that searching, WebIndex, Ref-By and other features are working OK.

If international characters in WikiWords do not seem to work, and you are on Perl 5.6 or higher, you may need to set the TWiki.cfg parameter $localeRegexes to 0 - this disables some features but enables TWiki to work even if your system has locales that do not work. Then, set the $upperNational and $lowerNational parameters to the valid upper and lower case accented letters for your locale.

  • NOTE: You will need to do the above workaround for Windows based servers (whether using Cygwin or ActiveState Perl), since Perl locales are not working on Windows as of Feb 2004.

If international characters in WikiWords aren't working, and you are on Perl 5.005 with working locales, keep $useLocale set to 1 and set $localeRegexes to 0, then set $upperNational and $lowerNational - if testenv generates the lists of characters for you, your locales are working so there is no need to set $localeRegexes to 0 in this case. See the comments in TWiki.cfg for more information.

Step 5: Configure Site-Wide Email Preferences

 
  • Edit the TWikiPreferences topic in the TWiki web (by pointing your browser to http://yourdomain.com/twiki/bin/view/TWiki/TWikiPreferences) to set the WIKIWEBMASTER email address, and other email settings required for registration and WebChangesAlert to work:
    • WIKIWEBMASTER should be set to the email address of the TWiki administrator
Line: 135 to 154
 
Changed:
<
<

Step 5: Finish Up from Your Browser

>
>

Step 6: Finish Up from Your Browser

 
  • Point your Web browser at http://yourdomain.com/twiki/bin/view and start TWiki-ing away!
    • TIP Or, point to http://yourdomain.com/twiki/ to get the pre-TWiki index.html page, with a link to the view script. Customize this page if you want a public intro screen with a login link, instead of immediately calling up the .htaccess login dialog by going directly to view.
  • Edit the WebPreferences topic in each web, if necessary: set individual WEBCOPYRIGHT messages, and other preferences.
Changed:
<
<
  • Enable email notification of topic changes, TWikiSiteTools has more.
>
>
  • Enable email notification of topic changes - TWikiSiteTools has more.
 
Changed:
<
<
That's it for the standard virgin installation of TWiki. Read on for server-level customization options.
>
>
That's it for the standard installation of TWiki. Read on for server-level customization options.
 

Additional Server-Level Options

Line: 163 to 182
 
      • HELP The browser should ask for login name and password when you click on the Edit link. In case .htaccess does not have the desired effect, you need to enable it: Add "AllowOverride All" to the Directory [3] section of access.conf for your twiki/bin directory.
        • This applies only if you have root access: on hosted accounts, you shouldn't have this problem - otherwise, email tech support.
      • ALERT! NOTE: In the TWiki distribution package, the twiki/data/.htpasswd.txt file contains several TWiki core team user accounts and a guest user account. You probably want to remove those accounts by deleting the entries in .htpasswd. Do not remove the guest user if you want to allow guest logins.
Added:
>
>
    1. TWiki now supports several Password file format/encoding methods for Apache. Once you know what method is used by your Appache server, you can configure TWiki to create compatible .htpasswd entries by editing the $htpasswdFormatFamily, $htpasswdEncoding and $htpasswdFilename in the TWiki.cfg file. The supported options are htpasswd:plain, htpasswd:crypt, htpasswd:sha1, htdigest:md5
 
    1. Copy the TWikiRegistrationPub? topic to TWikiRegistration, overwriting old version of TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the .txt and .txt,v files in the twiki/data/TWiki directory.
  • Customization:
    • You can customize the registration form by deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This ensures that the fields are carried over into the user home page correctly.
Changed:
<
<
>
>
 
  • Register yourself in the TWikiRegistration topic.
    • ALERT! NOTE: When a user registers, a new line with the username and encrypted password is added to the data/.htpasswd file. The .htpasswd file that comes with the TWiki installation includes user accounts for TWiki core team members that are used for testing on TWiki.org. You can edit the file and delete those lines.
  • Create a new topic to check if authentication works.
Line: 174 to 194
 
Changed:
<
<
That's it for a basic new web set-up!
>
>

WYSIWYG Editor

 
Changed:
<
<
Optionally, you can also:
  • Create custom web-specific templates in a new twiki/templates/Someweb directory (otherwise, templates are inherited from twiki/templates).
  • Add TWikiForms for form-based page input that's stored separately from the main free-form topic text.
>
>
At this time, TWiki does not ship with an "what you see is what you get" editor. TWiki:Codev/IntegrateHtmlAreaEditor describes how to integrate an HTML editor.
 ALERT! NOTE: User home topics are located in the Proyecto META.Main web - don't try to move them or create them in other webs. From any other web, user signatures have to point to Proyecto META.Main web, using a Main.UserName or %MAINWEB%.UserName format. (The %MAINWEB% variable is an advantage if you ever change the Main web name, but the standard Main.UserName is easier for users to enter, which is the bottom line!

TWiki File System Info

Changed:
<
<
See Appendix A: TWiki File System? for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
>
>
See Appendix A: TWiki File System? for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2004 distribution.
 
Changed:
<
<
-- PeterThoeny - 03 Jun 2003
-- MikeMannix? - 16 May 2002
>
>
-- TWiki:Main/PeterThoeny - 15 Aug 2004
-- TWiki:Main/MikeMannix - 16 May 2002
 
Added:
>
>
 
META TOPICMOVED by="MikeMannix" date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide"

Revision 5812 Dec 2003 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Changed:
<
<
Installation instructions for the TWiki 01-Feb-2003 production release. Update notes for the new RCS configuration are marked Dataframework.
>
>
Installation instructions for the TWiki 01-Feb-2003 production release.
 
Changed:
<
<
These installation steps are based on the Apache web server on Linux. TWiki runs on other web servers and Unix systems, and should be fine with any web server and OS that meet the system requirements. Documentation for other platforms is somewhat limited:
>
>
If you are reading this on your own TWiki installation, please get the latest installation guide (TWiki:TWiki.TWikiInstallationGuide), as this often has important updates to resolve installation issues.
 
Changed:
<
<
>
>
These installation steps are based on the Apache web server on Linux. TWiki runs on other web servers and Unix systems, and should be fine with any web server and OS that meet the system requirements. Official documentation for platforms other than Linux is somewhat limited, so please check the topics listed below, they include some important tips for HP-UX, Solaris, OS/390, and many other platforms.

 
Changed:
<
<
>
>
 

Standard Installation

Line: 24 to 26
 ALERT! NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account, or you don't have administrator privileges on your intranet server - use the alternative Step 1 instead.

  • Create directory /home/httpd/twiki and unzip the TWiki distribution into this directory.
Changed:
<
<
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.
>
>
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file httpd.conf (typcially located in /etc/httpd/) with only ExecCGI option.
 
  • The twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki to file httpd.conf with normal access options (copy from /home/httpd/html ).
  • Now add ScriptAlias for /twiki/bin and Alias for /twiki to file httpd.conf .
    ALERT! NOTE: The ScriptAlias must come before the Alias, otherwise, Apache will fail to correctly set up /twiki/bin/, by treating it as just another subdirectory of the /twiki/ alias.
Line: 93 to 95
 

Step 2: Set File Permissions

  • Make sure Perl 5 and the Perl CGI library are installed on your system. The default location of Perl is /usr/bin/perl. If it's elsewhere, change the path to Perl in the first line of each script in the twiki/bin directory, or create a symbolic link from /usr/bin/perl.
Changed:
<
<
    • IMPORTANT: On ISP-hosted accounts, Perl CGI scripts usually require a .cgi extension to run. Some systems need .pl, the regular Perl extension. Modify all twiki/bin script filenames if necessary.
>
>
    • IMPORTANT: On ISP-hosted accounts (and some intranet servers), Perl CGI scripts may require a .cgi extension to run. Some systems need .pl, the regular Perl extension. Rename all twiki/bin scripts if necessary.
 
  • Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x (755).
  • To be able to edit the Perl scripts and .tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
  • HELP This Guide assumes user nobody ownership for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. You can:

Revision 5726 Jul 2003 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Line: 140 to 140
 
  • Edit the WebPreferences topic in each web, if necessary: set individual WEBCOPYRIGHT messages, and other preferences.
  • Enable email notification of topic changes, TWikiSiteTools has more.
  • Edit the WebNotify topic in all webs and add the users you want to notify.
Changed:
<
<
>
>
 

That's it for the standard virgin installation of TWiki. Read on for server-level customization options.

Revision 5604 Jun 2003 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Line: 13 to 13
 
Added:
>
>
 

Standard Installation

Line: 102 to 103
 
  • Set the permission of all files below twiki/data so that they are writable by user nobody. A simple way is to chmod them to -rw-rw-r-- (664) and to chown them to nobody.
  • Set the permission of the twiki/data directory and its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
  • Set the permission of the twiki/pub directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
Changed:
<
<
  • HELP The twiki/data/*/*.txt,v RCS repository files in the installation package are locked by user nobody. If your CGI scripts are not running as user nobody, it's not possible to check in files (you'll see that the revision number won't increase after saving a topic). In this case, you need to unlock all repository files (check the RCS man pages) and lock them with a different user, ex www-data, or delete them all - new files will be automatically created the first time each topic is edited. A simple way to change ownership is with a search-and-replace in all files; for example, using perl:
>
>
  • HELP The twiki/data/*/*.txt,v RCS repository files in the installation package are locked by user nobody. If your CGI scripts are not running as user nobody, it's not possible to check in files (you'll see that the revision number won't increase after saving a topic). In this case, you need to unlock all repository files (check the RCS man pages) and lock them with a different user, such as www-data, or delete them all - new files will be automatically created the first time each topic is edited. A simple way to change ownership is with a search-and-replace in all files; for example, using Perl (type this carefully!):
 
cd twiki/data

Changed:
<
<
perl -pi~ -e 's/nobody(\:[0-9\.]+[\;\s]+strict\;)/www-data$1/' /,v
>
>
perl -pi~ -e 'NR <= 10 && s/nobody:/www-data:/ ' /,v
 
Line: 124 to 126
 

Step 4: Configure Site-Wide Email Preferences

Changed:
<
<
>
>
  • Edit the TWikiPreferences topic in the TWiki web (by pointing your browser to http://yourdomain.com/twiki/bin/view/TWiki/TWikiPreferences) to set the WIKIWEBMASTER email address, and other email settings required for registration and WebChangesAlert to work:
 
    • WIKIWEBMASTER should be set to the email address of the TWiki administrator
    • SMTPMAILHOST is typically set on Windows or other non-Unix/Linux systems, where sendmail or similar is not available. When this is set and the Perl module Net::SMTP is installed, TWiki will connect to this SMTP server (e.g. mail.yourdomain.com) to send email for user registration and WebChangesAlerts. If you do have a sendmail-type program, leave SMTPMAILHOST unset so that the external sendmail program is used instead (defined by $mailProgram in TWiki.cfg).
    • SMTPSENDERHOST is optional, and set to the domain name sending the email (e.g. twiki.yourdomain.com). For use where the SMTP server requires that you identify the TWiki server sending mail. If not set, Net::SMTP will guess it for you.
  • You may want to set up other TWikiPreferences later on.
Added:
>
>
 

Step 5: Finish Up from Your Browser

Line: 181 to 184
 See Appendix A: TWiki File System? for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
Changed:
<
<
-- PeterThoeny - 28 Dec 2002
>
>
-- PeterThoeny - 03 Jun 2003
 -- MikeMannix? - 16 May 2002

META TOPICMOVED by="MikeMannix" date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide"

Revision 5515 Apr 2003 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Line: 106 to 106
 
cd twiki/data

Changed:
<
<
perl -pi~ -e 's/nobody:/www-data:/' /,v
>
>
perl -pi~ -e 's/nobody(\:[0-9\.]+[\;\s]+strict\;)/www-data$1/' /,v
 

Revision 5415 Feb 2003 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Line: 150 to 150
 

Enabling Authentication of Users

  • If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users:
Changed:
<
<
    1. Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details, consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
>
>
    1. Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details, consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
  Redirect /urlpathto/twiki/index.html http://yourdomain.com/urlpathto/twiki/bin/view
AuthUserFile /filepathto/twiki/data/.htpasswd
ErrorDocument 401 /urlpathto/twiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth

Revision 5302 Feb 2003 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Changed:
<
<
Installation instructions for the TWiki 01-Dec-2001 production release. Update notes for the new RCS configuration are marked Dataframework.
>
>
Installation instructions for the TWiki 01-Feb-2003 production release. Update notes for the new RCS configuration are marked Dataframework.
 These installation steps are based on the Apache web server on Linux. TWiki runs on other web servers and Unix systems, and should be fine with any web server and OS that meet the system requirements. Documentation for other platforms is somewhat limited:
Line: 16 to 16
 

Standard Installation

Changed:
<
<
Request and download the TWiki 01-Dec-2001 distribution in Unix ZIP format from http://TWiki.org/download.html. Please review the AdminSkillsAssumptions before you install TWiki.
>
>
Request and download the TWiki 01-Feb-2003 distribution in Unix ZIP format from http://TWiki.org/download.html. Please review the AdminSkillsAssumptions before you install TWiki.
 

Step 1: Create & Configure the Directories

Revision 5201 Feb 2003 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Line: 169 to 169
 
Deleted:
<
<

Adding a New Web

To create a new web:

  1. Create a new web data directory under twiki/data and check the file permission of the directory.
    • Use a name consisting of characters A..Z , a..z but not in WikiNotation. (The name should start with one (or more) uppercase letters, but have no uppercase letters after the first group -- if it starts with a lowercase letter or is a WikiWord, some features of TWiki will not work as expected.)
  2. Copy all files from the twiki/data/_default directory to the new data directory, preserving the original files' owner, group and permissions (on Unix, use cp -p). The data files must be writable by the owner the CGI scripts are running on (usually, nobody).
    • TIP HINT: You can set permissions of .txt and .txt,v files to -rw-rw-rw- (666) and then edit the topic using your browser; RCS will restore the file permissions correctly when saving the topic.
  3. Add the new web to the web list (visible in the upper right corner of each topic) by editing the site-level preferences, TWikiPreferences:
    • Add the new web to the %WIKIWEBLIST% variable.
  4. Update the web settings by editing the WebPreferences topic of the new web:
    • Customize the %WEBTOPICLIST% variable to contain the web-specific links you prefer.
    • Set the WEBBGCOLOR variable to a color. The number represents the unique color for the web.
    • Set Plugins, access privileges, custom variables, other web-level options (ex: %WEBCOPYRIGHT% can be set for an individual web).
  5. Test the new web: view pages, create a new page.
 That's it for a basic new web set-up!

Optionally, you can also:

Revision 5116 Jan 2003 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Installation instructions for the TWiki 01-Dec-2001 production release. Update notes for the new RCS configuration are marked Dataframework.

Changed:
<
<
These installation steps are based on the Apache web server on Linux. TWiki runs on other web servers and Unix systems, and should be fine with any web server and OS that meet the system requirements?. Documentation for other platforms is somewhat limited:
>
>
These installation steps are based on the Apache web server on Linux. TWiki runs on other web servers and Unix systems, and should be fine with any web server and OS that meet the system requirements. Documentation for other platforms is somewhat limited:
 

Revision 5012 Jan 2003 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Line: 10 to 10
 
Added:
>
>
 

Standard Installation

Changed:
<
<
Request and download the TWiki 01-Dec-2001 distribution in Unix ZIP format from http://TWiki.org/download.html. (To install TWiki on SourceForge, for use on a software development project, read TWiki:Codev/SourceForgeHowTo .)
>
>
Request and download the TWiki 01-Dec-2001 distribution in Unix ZIP format from http://TWiki.org/download.html. Please review the AdminSkillsAssumptions before you install TWiki.
 

Step 1: Create & Configure the Directories

Revision 4929 Dec 2002 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Installation instructions for the TWiki 01-Dec-2001 production release. Update notes for the new RCS configuration are marked Dataframework.

Changed:
<
<
These installation steps are based on the Apache Web server on Linux. TWiki runs on other Web servers and Unix systems, and should be fine with any OS and server that meet the system requirements?. Documentation for other platforms is currently limited. For Windows, check TWiki:Codev/TWikiOnWindows. Search the TWiki:Codev web for other intallation notes.
>
>
These installation steps are based on the Apache web server on Linux. TWiki runs on other web servers and Unix systems, and should be fine with any web server and OS that meet the system requirements?. Documentation for other platforms is somewhat limited:

 

Standard Installation

Line: 14 to 19
 

Step 1: Create & Configure the Directories

Changed:
<
<
ALERT! NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the alternative Step 1 instead.
>
>
ALERT! NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account, or you don't have administrator privileges on your intranet server - use the alternative Step 1 instead.
 
  • Create directory /home/httpd/twiki and unzip the TWiki distribution into this directory.
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.
Line: 56 to 61
 

Step 1 for Non-Root Accounts

Changed:
<
<
To install TWiki on a system where you don't have server administrator privileges, for example, on a hosted Web account:
>
>
To install TWiki on a system where you don't have Unix/Linux root (administrator) privileges, for example, on a hosted Web account or an intranet server administered by someone else:
 
  • Download and unzip TWiki on your local PC
  • Using the table below, create a directory structure on your host server
Line: 71 to 76
 
twiki/templates web templates dir secure from public access /home/smith/twiki/templates
Added:
>
>
If you are not able to create the twiki/lib directory at the same level as the twiki/bin directory (e.g. because CGI bin directories can't be under your home directory and you don't have root access), you can create this directory elsewhere and edit the setlib.cfg file in the bin directory:

	 # -------------- Change these settings if required

	 $twikiLibPath = '/some/other/path/lib';	# Path to lib directory containing TWiki.pm

You can also edit $localPerlLibPath in the setlib.cfg file if you are not root and need to install additional CPAN modules, but can't update the main Perl installation files on the server. Just set this variable to the full pathname to your local lib directory, typically under your home directory.

 

Step 2: Set File Permissions

Line: 89 to 105
 
cd twiki/data

Changed:
<
<
perl -pi -e 's/nobody:/www-data:/' /,v
>
>
perl -pi~ -e 's/nobody:/www-data:/' /,v
 
Line: 97 to 113
 
  • Edit the file twiki/lib/TWiki.cfg, setting the variables to your needs.
    • Set the file extension in the $scriptSuffix variable to cgi or pl if required.
Changed:
<
<
    • RCS - revision control system to store revsion of topics and attachments. You can use RCS executables or a version of RCS written in Perl, note that as the time of writing (Apr 2002) the Perl version has not been widely tested, so if you want to put up a live site the RCS executables are recommended. (Dateframework - prior version of TWiki only support the RCS executables and do not have the config setting $storeTopicImpl)
>
>
    • RCS - revision control system to store revision of topics and attachments. You can use RCS executables or a version of RCS written in Perl, note that as the time of writing (Apr 2002) the Perl version has not been widely tested, so if you want to put up a live site the RCS executables are recommended.
      • Set $storeTopicImpl = "RcsWrap"; for the RCS executables and make sure RCS is installed. Set $rcsDir in twiki/lib/TWiki.cfg to match the location of your RCS binaries. You can check this by issuing the command rcs at the prompt, it should result in something like "rcs: no input file".
        • Check that you have GNU diff, by typing diff -v - an error indicates you have a non-GNU diff, so install the GNU diffutils package and make sure that diff is on the PATH used by TWiki (see $safeEnvPath in the TWiki.cfg file).
 
      • Set $storeTopicImpl = "RcsLite"; for the Perl based RCS
Changed:
<
<
      • Set $storeTopicImpl = "RcsWrap"; for the RCS execuatbles and make sure RCS is installed. Set $rcsDir in twiki/lib/TWiki.cfg to mach the location of your RCS binaries. You can check this by issuing the comand rcs at the prompt, it should result in something like "rcs: no input file".
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directories to a place where they are not visible, and change the variables in twiki/lib/TWiki.cfg accordingly)
>
>
  • Security issue: Directories twiki/data , twiki/templates and all their subdirectories should be set so that they are not visible through URLs. (Alternatively, move the directories to a place where they are not visible, and change the variables in twiki/lib/TWiki.cfg accordingly)
 
  • Test your settings by running the testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. Check if your twiki/lib/TWiki.cfg configuration file settings are correct.
Changed:
<
<

Step 4: Finish Up from Your Browser

>
>

Step 4: Configure Site-Wide Email Preferences

  • From your web browser, edit the TWikiPreferences topic in the TWiki:TWiki web to set the WIKIWEBMASTER email address, and other email settings required for registration and WebChangesAlert to work:
    • WIKIWEBMASTER should be set to the email address of the TWiki administrator
    • SMTPMAILHOST is typically set on Windows or other non-Unix/Linux systems, where sendmail or similar is not available. When this is set and the Perl module Net::SMTP is installed, TWiki will connect to this SMTP server (e.g. mail.yourdomain.com) to send email for user registration and WebChangesAlerts. If you do have a sendmail-type program, leave SMTPMAILHOST unset so that the external sendmail program is used instead (defined by $mailProgram in TWiki.cfg).
    • SMTPSENDERHOST is optional, and set to the domain name sending the email (e.g. twiki.yourdomain.com). For use where the SMTP server requires that you identify the TWiki server sending mail. If not set, Net::SMTP will guess it for you.
  • You may want to set up other TWikiPreferences later on.

Step 5: Finish Up from Your Browser

 
  • Point your Web browser at http://yourdomain.com/twiki/bin/view and start TWiki-ing away!
    • TIP Or, point to http://yourdomain.com/twiki/ to get the pre-TWiki index.html page, with a link to the view script. Customize this page if you want a public intro screen with a login link, instead of immediately calling up the .htaccess login dialog by going directly to view.
Deleted:
<
<
 
  • Edit the WebPreferences topic in each web, if necessary: set individual WEBCOPYRIGHT messages, and other preferences.
  • Enable email notification of topic changes, TWikiSiteTools has more.
  • Edit the WebNotify topic in all webs and add the users you want to notify.
Line: 120 to 145
 With your new TWiki installation up and running, you can manage most aspects of your site from the browser interface. Only a few functions require access to the server file system, via Telnet or FTP. You can make these server-level changes during installation, and at any time afterwards.
Added:
>
>
 

Enabling Authentication of Users

  • If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users:
Line: 132 to 158
 
        • This applies only if you have root access: on hosted accounts, you shouldn't have this problem - otherwise, email tech support.
      • ALERT! NOTE: In the TWiki distribution package, the twiki/data/.htpasswd.txt file contains several TWiki core team user accounts and a guest user account. You probably want to remove those accounts by deleting the entries in .htpasswd. Do not remove the guest user if you want to allow guest logins.
    1. Copy the TWikiRegistrationPub? topic to TWikiRegistration, overwriting old version of TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the .txt and .txt,v files in the twiki/data/TWiki directory.
Changed:
<
<
      • TIP HINT: You can customize the registration form by deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This ensures that the fields are processed correctly.
>
>
  • Customization:
    • You can customize the registration form by deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This ensures that the fields are carried over into the user home page correctly.
    • You can customize the default user home page in NewUserTemplate.
 
  • Register yourself in the TWikiRegistration topic.
    • ALERT! NOTE: When a user registers, a new line with the username and encrypted password is added to the data/.htpasswd file. The .htpasswd file that comes with the TWiki installation includes user accounts for TWiki core team members that are used for testing on TWiki.org. You can edit the file and delete those lines.
  • Create a new topic to check if authentication works.
Line: 166 to 194
 

TWiki File System Info

Changed:
<
<
See Appendix A: TWiki File System? for an installed system snapshot and descriptions of all files in the TWiki 01-Dec-2001 distribution.
>
>
See Appendix A: TWiki File System? for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
 
Changed:
<
<
-- PeterThoeny - 13 Sep 2001
>
>
-- PeterThoeny - 28 Dec 2002
 -- MikeMannix? - 16 May 2002

META TOPICMOVED by="MikeMannix" date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide"

Revision 4821 Sep 2002 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Line: 16 to 16
 ALERT! NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the alternative Step 1 instead.
Changed:
<
<
  • Create directory /home/httpd/twiki and unzip the TWiki distribution into this directory.
>
>
  • Create directory /home/httpd/twiki and unzip the TWiki distribution into this directory.
 
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.
  • The twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki to file httpd.conf with normal access options (copy from /home/httpd/html ).
  • Now add ScriptAlias for /twiki/bin and Alias for /twiki to file httpd.conf .

Revision 4702 Aug 2002 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Line: 85 to 85
 
  • Set the permission of all files below twiki/data so that they are writable by user nobody. A simple way is to chmod them to -rw-rw-r-- (664) and to chown them to nobody.
  • Set the permission of the twiki/data directory and its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
  • Set the permission of the twiki/pub directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
Changed:
<
<
  • HELP The twiki/data/*/*.txt,v RCS repository files in the installation package are locked by user nobody. If your CGI scripts are not running as user nobody, it's not possible to check in files (you'll see that the revision number won't increase after saving a topic). In this case, you need to unlock all repository files (check the RCS man pages) and lock them with a different user, ex www-data, or delete them all - new files will be automatically created the first time each topic is edited. A simple way to change ownership is with a search-and-replace in all files; for example, using sed:
>
>
  • HELP The twiki/data/*/*.txt,v RCS repository files in the installation package are locked by user nobody. If your CGI scripts are not running as user nobody, it's not possible to check in files (you'll see that the revision number won't increase after saving a topic). In this case, you need to unlock all repository files (check the RCS man pages) and lock them with a different user, ex www-data, or delete them all - new files will be automatically created the first time each topic is edited. A simple way to change ownership is with a search-and-replace in all files; for example, using perl:
 
cd twiki/data

Changed:
<
<
for f in /,v; do sed 's/nobody\:/www-data\:/' $f > x; mv -f x $f; done
>
>
perl -pi -e 's/nobody:/www-data:/' /,v
 
Deleted:
<
<
Note that this is not required if you use the Perl based RCS implementation - see Dataframework.
 

Step 3: Set the Main Configuration File

Revision 4607 Jul 2002 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Line: 132 to 132
 
      • HELP The browser should ask for login name and password when you click on the Edit link. In case .htaccess does not have the desired effect, you need to enable it: Add "AllowOverride All" to the Directory [3] section of access.conf for your twiki/bin directory.
        • This applies only if you have root access: on hosted accounts, you shouldn't have this problem - otherwise, email tech support.
      • ALERT! NOTE: In the TWiki distribution package, the twiki/data/.htpasswd.txt file contains several TWiki core team user accounts and a guest user account. You probably want to remove those accounts by deleting the entries in .htpasswd. Do not remove the guest user if you want to allow guest logins.
Changed:
<
<
    1. Copy the TWikiRegistrationPub? topic to TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the .txt and .txt,v files in the twiki/data/TWiki directory.
>
>
    1. Copy the TWikiRegistrationPub? topic to TWikiRegistration, overwriting old version of TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the .txt and .txt,v files in the twiki/data/TWiki directory.
 
      • TIP HINT: You can customize the registration form by deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This ensures that the fields are processed correctly.
  • Register yourself in the TWikiRegistration topic.
    • ALERT! NOTE: When a user registers, a new line with the username and encrypted password is added to the data/.htpasswd file. The .htpasswd file that comes with the TWiki installation includes user accounts for TWiki core team members that are used for testing on TWiki.org. You can edit the file and delete those lines.

Revision 4516 May 2002 - Main.MikeMannix

Line: 1 to 1
 

TWiki Installation Guide

Changed:
<
<
Installation instructions for the TWiki 01-Sep-2001 production release
>
>
Installation instructions for the TWiki 01-Dec-2001 production release. Update notes for the new RCS configuration are marked Dataframework.
 These installation steps are based on the Apache Web server on Linux. TWiki runs on other Web servers and Unix systems, and should be fine with any OS and server that meet the system requirements?. Documentation for other platforms is currently limited. For Windows, check TWiki:Codev/TWikiOnWindows. Search the TWiki:Codev web for other intallation notes.

Standard Installation

Changed:
<
<
Request and download the TWiki 01-Sep-2001 distribution in Unix ZIP format from http://TWiki.org/download.html. (To install TWiki on SourceForge, for use on a software development project, read TWiki:Codev/SourceForgeHowTo .)
>
>
Request and download the TWiki 01-Dec-2001 distribution in Unix ZIP format from http://TWiki.org/download.html. (To install TWiki on SourceForge, for use on a software development project, read TWiki:Codev/SourceForgeHowTo .)
 

Step 1: Create & Configure the Directories

Line: 92 to 92
 for f in /,v; do sed 's/nobody\:/www-data\:/' $f > x; mv -f x $f; done
Added:
>
>
Note that this is not required if you use the Perl based RCS implementation - see Dataframework.
 

Step 3: Set the Main Configuration File

  • Edit the file twiki/lib/TWiki.cfg, setting the variables to your needs.
    • Set the file extension in the $scriptSuffix variable to cgi or pl if required.
Changed:
<
<
    • Make sure RCS is installed. Set $rcsDir in twiki/lib/TWiki.cfg to mach the location of your RCS binaries. You can check this by issuing the comand rcs at the prompt, it should result in something like "rcs: no input file".
>
>
    • RCS - revision control system to store revsion of topics and attachments. You can use RCS executables or a version of RCS written in Perl, note that as the time of writing (Apr 2002) the Perl version has not been widely tested, so if you want to put up a live site the RCS executables are recommended. (Dateframework - prior version of TWiki only support the RCS executables and do not have the config setting $storeTopicImpl)
      • Set $storeTopicImpl = "RcsLite"; for the Perl based RCS
      • Set $storeTopicImpl = "RcsWrap"; for the RCS execuatbles and make sure RCS is installed. Set $rcsDir in twiki/lib/TWiki.cfg to mach the location of your RCS binaries. You can check this by issuing the comand rcs at the prompt, it should result in something like "rcs: no input file".
 
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directories to a place where they are not visible, and change the variables in twiki/lib/TWiki.cfg accordingly)
  • Test your settings by running the testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. Check if your twiki/lib/TWiki.cfg configuration file settings are correct.
Line: 128 to 131
 
      • ALERT! NOTE: If you had to add a .cgi or .pl file extension to the bin scripts, make sure to do the same for edit, view, preview, and all the other script names in .htaccess.
      • HELP The browser should ask for login name and password when you click on the Edit link. In case .htaccess does not have the desired effect, you need to enable it: Add "AllowOverride All" to the Directory [3] section of access.conf for your twiki/bin directory.
        • This applies only if you have root access: on hosted accounts, you shouldn't have this problem - otherwise, email tech support.
Changed:
<
<
      • ALERT! NOTE: In the TWiki distribution package, tje twiki/data/.htpasswd.txt file contains several TWiki core team user accounts and a guest user account. You probably want to remove those accounts by deleting the entries in .htpasswd. Do not remove the guest user if you want to allow guest logins.
>
>
      • ALERT! NOTE: In the TWiki distribution package, the twiki/data/.htpasswd.txt file contains several TWiki core team user accounts and a guest user account. You probably want to remove those accounts by deleting the entries in .htpasswd. Do not remove the guest user if you want to allow guest logins.
 
    1. Copy the TWikiRegistrationPub? topic to TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the .txt and .txt,v files in the twiki/data/TWiki directory.
      • TIP HINT: You can customize the registration form by deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This ensures that the fields are processed correctly.
Line: 164 to 167
 

TWiki File System Info

Changed:
<
<
See Appendix A: TWiki File System? for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
>
>
See Appendix A: TWiki File System? for an installed system snapshot and descriptions of all files in the TWiki 01-Dec-2001 distribution.
 -- PeterThoeny - 13 Sep 2001
Changed:
<
<
-- MikeMannix? - 27 Jan 2002
>
>
-- MikeMannix? - 16 May 2002
 
META TOPICMOVED by="MikeMannix" date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide"

Revision 4407 Apr 2002 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Line: 152 to 152
 
    • Customize the %WEBTOPICLIST% variable to contain the web-specific links you prefer.
    • Set the WEBBGCOLOR variable to a color. The number represents the unique color for the web.
    • Set Plugins, access privileges, custom variables, other web-level options (ex: %WEBCOPYRIGHT% can be set for an individual web).
Deleted:
<
<
  1. Add the new web to the color-coded web directory table by editing the TWikiWebsTable topic.
 
  1. Test the new web: view pages, create a new page.

That's it for a basic new web set-up!

Revision 4327 Jan 2002 - Main.MikeMannix

Line: 1 to 1
 

TWiki Installation Guide

Installation instructions for the TWiki 01-Sep-2001 production release

Deleted:
<
<

Overview

 These installation steps are based on the Apache Web server on Linux. TWiki runs on other Web servers and Unix systems, and should be fine with any OS and server that meet the system requirements?. Documentation for other platforms is currently limited. For Windows, check TWiki:Codev/TWikiOnWindows. Search the TWiki:Codev web for other intallation notes.

Line: 16 to 14
 

Step 1: Create & Configure the Directories

Changed:
<
<
NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the alternative Step 1 instead.
>
>
ALERT! NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the alternative Step 1 instead.
 
  • Create directory /home/httpd/twiki and unzip the TWiki distribution into this directory.
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.
  • The twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki to file httpd.conf with normal access options (copy from /home/httpd/html ).
  • Now add ScriptAlias for /twiki/bin and Alias for /twiki to file httpd.conf .
Changed:
<
<

NOTE: The ScriptAlias must come before the Alias, otherwise, Apache will fail to correctly set up /twiki/bin/, by treating it as just another subdirectory of the /twiki/ alias.
>
>

ALERT! NOTE: The ScriptAlias must come before the Alias, otherwise, Apache will fail to correctly set up /twiki/bin/, by treating it as just another subdirectory of the /twiki/ alias.
  • The twiki/data and twiki/templates directories should be set so that they are not visible as URLs. Add them to httpd.conf with deny from all.
 
Example httpd.conf entries:
Line: 31 to 30
  <Directory "/home/httpd/twiki/bin"> Options +ExecCGI SetHandler cgi-script
Deleted:
<
<
AllowOverride? all
  Allow from all </Directory> <Directory "/home/httpd/twiki/pub"> Options FollowSymLinks +Includes AllowOverride None Allow from all
Added:
>
>
</Directory> <Directory "/home/httpd/twiki/data"> deny from all </Directory> <Directory "/home/httpd/twiki/templates"> deny from all
  </Directory>
Line: 59 to 63
 
  • Upload the TWiki files by FTP (transfer as text except for the image files in pub)
TWiki dir: What it is: Where to copy: Example:
Changed:
<
<
twiki/bin CGI bin cgi-enabled dir /home/smith/public_html/cgi-bin
twiki/lib library files same level as twiki/bin /home/smith/public_html/lib
twiki/pub public files htdoc enabled dir /home/smith/public_html/pub
twiki/data topic data outside of htdoc tree (for security) /home/smith/twiki/data
twiki/templates web templates outside of htdoc tree (for security) /home/smith/twiki/templates
>
>
twiki start-up pages root TWiki dir /home/smith/twiki/
twiki/bin CGI bin CGI-enabled dir /home/smith/twiki/bin
twiki/lib library files same level as twiki/bin /home/smith/twiki/lib
twiki/pub public files htdoc enabled dir /home/smith/twiki/pub
twiki/data topic data dir secure from public access /home/smith/twiki/data
twiki/templates web templates dir secure from public access /home/smith/twiki/templates
 

Line: 73 to 78
 
    • IMPORTANT: On ISP-hosted accounts, Perl CGI scripts usually require a .cgi extension to run. Some systems need .pl, the regular Perl extension. Modify all twiki/bin script filenames if necessary.
  • Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x (755).
  • To be able to edit the Perl scripts and .tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
Changed:
<
<
  • NOTE: This Guide assumes user nobody ownership for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. You can:
>
>
  • HELP This Guide assumes user nobody ownership for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. You can:
 
    • replace nobody with another user if your server executes scripts under a different name (ex: default for Debian is www-data).
Changed:
<
<
      • HINT: Run the testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. It will show you the user name of the CGI scripts, a table listing all CGI environment variables, and a test of your twiki/lib/TWiki.cfg configuration file (you'll configure that in a minute).
>
>
      • TIP HINT: Run the testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. It will show you the user name of the CGI scripts, a table listing all CGI environment variables, and a test of your twiki/lib/TWiki.cfg configuration file (you'll configure that in a minute).
 
    • replace user twiki with your own username
  • Set the permission of all files below twiki/data so that they are writable by user nobody. A simple way is to chmod them to -rw-rw-r-- (664) and to chown them to nobody.
  • Set the permission of the twiki/data directory and its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
  • Set the permission of the twiki/pub directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
Changed:
<
<
  • NOTE: The twiki/data/*/*.txt,v RCS repository files in the installation package are locked by user nobody. If your CGI scripts are not running as user nobody, it's not possible to check in files (you'll see that the revision number won't increase after saving a topic). In this case, you need to unlock all repository files (check the RCS man pages) and lock them with a different user, ex www-data, or delete them all - new files will be automatically created the first time each topic is edited. A simple way to change ownership is with a search-and-replace in all files; for example, using sed:
    for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
>
>
  • HELP The twiki/data/*/*.txt,v RCS repository files in the installation package are locked by user nobody. If your CGI scripts are not running as user nobody, it's not possible to check in files (you'll see that the revision number won't increase after saving a topic). In this case, you need to unlock all repository files (check the RCS man pages) and lock them with a different user, ex www-data, or delete them all - new files will be automatically created the first time each topic is edited. A simple way to change ownership is with a search-and-replace in all files; for example, using sed:
cd twiki/data
for f in */*,v; do sed 's/nobody\:/www-data\:/' $f > x; mv -f x $f; done
 

Step 3: Set the Main Configuration File

  • Edit the file twiki/lib/TWiki.cfg, setting the variables to your needs.
    • Set the file extension in the $scriptSuffix variable to cgi or pl if required.
Changed:
<
<
    • Make sure RCS is installed. Set $rcsDir in twiki/lib/TWiki.cfg to mach the location of your RCS binaries.
>
>
    • Make sure RCS is installed. Set $rcsDir in twiki/lib/TWiki.cfg to mach the location of your RCS binaries. You can check this by issuing the comand rcs at the prompt, it should result in something like "rcs: no input file".
 
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directories to a place where they are not visible, and change the variables in twiki/lib/TWiki.cfg accordingly)
  • Test your settings by running the testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. Check if your twiki/lib/TWiki.cfg configuration file settings are correct.

Step 4: Finish Up from Your Browser

  • Point your Web browser at http://yourdomain.com/twiki/bin/view and start TWiki-ing away!
Added:
>
>
    • TIP Or, point to http://yourdomain.com/twiki/ to get the pre-TWiki index.html page, with a link to the view script. Customize this page if you want a public intro screen with a login link, instead of immediately calling up the .htaccess login dialog by going directly to view.
 
  • Edit the TWikiPreferences topic in the TWiki:TWiki web to set the WIKIWEBMASTER email address, and other preferences.
  • Edit the WebPreferences topic in each web, if necessary: set individual WEBCOPYRIGHT messages, and other preferences.
  • Enable email notification of topic changes, TWikiSiteTools has more.
Line: 109 to 121
 

Enabling Authentication of Users

  • If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users:
Changed:
<
<
    1. Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details, consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
      Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
      AuthUserFile /filepath/to/TWiki/data/.htpasswd
      ErrorDocument 401 /urlpath/to/TWiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
      • NOTE: In case you renamed the CGI script files to have a file extension you need to reflect that in the edit, view, preview, etc entries in .htaccess.
      • NOTE: The browser should ask for login name and password when you click on the Edit link. In case .htaccess does not have the desired effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
      • NOTE: The distribution package has a twiki/data/.htpasswd file which contains some TWiki core team user accounts and a guest user account. You probably want to remove those accounts by deleting the entries in .htpasswd. Do not remove the guest user in case you want to allow guest logins.
>
>
    1. Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details, consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
      Redirect /urlpathto/twiki/index.html http://yourdomain.com/urlpathto/twiki/bin/view
      AuthUserFile /filepathto/twiki/data/.htpasswd
      ErrorDocument 401 /urlpathto/twiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
      • ALERT! NOTE: If you had to add a .cgi or .pl file extension to the bin scripts, make sure to do the same for edit, view, preview, and all the other script names in .htaccess.
      • HELP The browser should ask for login name and password when you click on the Edit link. In case .htaccess does not have the desired effect, you need to enable it: Add "AllowOverride All" to the Directory [3] section of access.conf for your twiki/bin directory.
        • This applies only if you have root access: on hosted accounts, you shouldn't have this problem - otherwise, email tech support.
      • ALERT! NOTE: In the TWiki distribution package, tje twiki/data/.htpasswd.txt file contains several TWiki core team user accounts and a guest user account. You probably want to remove those accounts by deleting the entries in .htpasswd. Do not remove the guest user if you want to allow guest logins.
 
    1. Copy the TWikiRegistrationPub? topic to TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the .txt and .txt,v files in the twiki/data/TWiki directory.
Changed:
<
<
      • HINT: You can customize the registration form by deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This ensures that the fields are processed correctly.
>
>
      • TIP HINT: You can customize the registration form by deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This ensures that the fields are processed correctly.
 
Changed:
<
<
    • NOTE: When a user registers, a new line with the username and encrypted password is added to the data/.htpasswd file. The .htpasswd file that comes with the TWiki installation includes user accounts for TWiki core team members that are used for testing on TWiki.org. You can edit the file and delete those lines.
>
>
    • ALERT! NOTE: When a user registers, a new line with the username and encrypted password is added to the data/.htpasswd file. The .htpasswd file that comes with the TWiki installation includes user accounts for TWiki core team members that are used for testing on TWiki.org. You can edit the file and delete those lines.
 
Line: 130 to 143
 To create a new web:
  1. Create a new web data directory under twiki/data and check the file permission of the directory.
Changed:
<
<
    • Use a name starting with characters A..Z, followed by a..z and/or 0..9 characters, but not a WikiWord.
>
>
    • Use a name consisting of characters A..Z , a..z but not in WikiNotation. (The name should start with one (or more) uppercase letters, but have no uppercase letters after the first group -- if it starts with a lowercase letter or is a WikiWord, some features of TWiki will not work as expected.)
 
  1. Copy all files from the twiki/data/_default directory to the new data directory, preserving the original files' owner, group and permissions (on Unix, use cp -p). The data files must be writable by the owner the CGI scripts are running on (usually, nobody).
Changed:
<
<
    • HINT: You can set permissions of .txt and .txt,v files to -rw-rw-rw- (666) and then edit the topic using your browser; RCS will restore the file permissions correctly when saving the topic.
>
>
    • TIP HINT: You can set permissions of .txt and .txt,v files to -rw-rw-rw- (666) and then edit the topic using your browser; RCS will restore the file permissions correctly when saving the topic.
 
  1. Add the new web to the web list (visible in the upper right corner of each topic) by editing the site-level preferences, TWikiPreferences:
    • Add the new web to the %WIKIWEBLIST% variable.
  2. Update the web settings by editing the WebPreferences topic of the new web:
Line: 148 to 161
 
  • Create custom web-specific templates in a new twiki/templates/Someweb directory (otherwise, templates are inherited from twiki/templates).
  • Add TWikiForms for form-based page input that's stored separately from the main free-form topic text.
Changed:
<
<
NOTE: User home topics are located in the Proyecto META.Main web - don't try to move them or create them in other webs. From any other web, user signatures have to point to Proyecto META.Main web, using a Main.UserName or %MAINWEB%.UserName format. (The %MAINWEB% variable is an advantage if you ever change the Main web name, but the standard Main.UserName is easier for users to enter, which is the bottom line!
>
>
ALERT! NOTE: User home topics are located in the Proyecto META.Main web - don't try to move them or create them in other webs. From any other web, user signatures have to point to Proyecto META.Main web, using a Main.UserName or %MAINWEB%.UserName format. (The %MAINWEB% variable is an advantage if you ever change the Main web name, but the standard Main.UserName is easier for users to enter, which is the bottom line!
 

TWiki File System Info

See Appendix A: TWiki File System? for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.

-- PeterThoeny - 13 Sep 2001

Changed:
<
<
-- MikeMannix? - 03 Dec 2001
>
>
-- MikeMannix? - 27 Jan 2002
 
META TOPICMOVED by="MikeMannix" date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide"

Revision 4209 Dec 2001 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Line: 115 to 115
  ErrorDocument 401 /urlpath/to/TWiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
      • NOTE: In case you renamed the CGI script files to have a file extension you need to reflect that in the edit, view, preview, etc entries in .htaccess.
      • NOTE: The browser should ask for login name and password when you click on the Edit link. In case .htaccess does not have the desired effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
Added:
>
>
      • NOTE: The distribution package has a twiki/data/.htpasswd file which contains some TWiki core team user accounts and a guest user account. You probably want to remove those accounts by deleting the entries in .htpasswd. Do not remove the guest user in case you want to allow guest logins.
 
    1. Copy the TWikiRegistrationPub? topic to TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the .txt and .txt,v files in the twiki/data/TWiki directory.
      • HINT: You can customize the registration form by deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This ensures that the fields are processed correctly.

Revision 4105 Dec 2001 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Line: 31 to 31
  <Directory "/home/httpd/twiki/bin"> Options +ExecCGI SetHandler cgi-script
Added:
>
>
AllowOverride? all
  Allow from all </Directory> <Directory "/home/httpd/twiki/pub">

Revision 4004 Dec 2001 - Main.MikeMannix

Line: 1 to 1
 

TWiki Installation Guide

Line: 94 to 94
 
  • Point your Web browser at http://yourdomain.com/twiki/bin/view and start TWiki-ing away!
  • Edit the TWikiPreferences topic in the TWiki:TWiki web to set the WIKIWEBMASTER email address, and other preferences.
  • Edit the WebPreferences topic in each web, if necessary: set individual WEBCOPYRIGHT messages, and other preferences.
Changed:
<
<
  • Enable email notification of topic changes, MonitoringSiteActivity? has more.
>
>
  • Enable email notification of topic changes, TWikiSiteTools has more.
 
Line: 153 to 153
 See Appendix A: TWiki File System? for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.

-- PeterThoeny - 13 Sep 2001

Changed:
<
<
-- MikeMannix? - 14 Sep 2001
>
>
-- MikeMannix? - 03 Dec 2001
 
META TOPICMOVED by="MikeMannix" date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide"

Revision 3902 Dec 2001 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Line: 70 to 70
 
  • Make sure Perl 5 and the Perl CGI library are installed on your system. The default location of Perl is /usr/bin/perl. If it's elsewhere, change the path to Perl in the first line of each script in the twiki/bin directory, or create a symbolic link from /usr/bin/perl.
    • IMPORTANT: On ISP-hosted accounts, Perl CGI scripts usually require a .cgi extension to run. Some systems need .pl, the regular Perl extension. Modify all twiki/bin script filenames if necessary.
Added:
>
>
  • Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x (755).
 
  • To be able to edit the Perl scripts and .tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
  • NOTE: This Guide assumes user nobody ownership for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. You can:
    • replace nobody with another user if your server executes scripts under a different name (ex: default for Debian is www-data).
      • HINT: Run the testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. It will show you the user name of the CGI scripts, a table listing all CGI environment variables, and a test of your twiki/lib/TWiki.cfg configuration file (you'll configure that in a minute).
    • replace user twiki with your own username
Deleted:
<
<
  • Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x (755).
 
  • Set the permission of all files below twiki/data so that they are writable by user nobody. A simple way is to chmod them to -rw-rw-r-- (664) and to chown them to nobody.
  • Set the permission of the twiki/data directory and its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
  • Set the permission of the twiki/pub directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.

Revision 3823 Nov 2001 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Line: 128 to 128
 To create a new web:
  1. Create a new web data directory under twiki/data and check the file permission of the directory.
Changed:
<
<
    • Use a name consisting of characters A..Z , a..z but not in WikiNotation.
>
>
    • Use a name starting with characters A..Z, followed by a..z and/or 0..9 characters, but not a WikiWord.
 
  1. Copy all files from the twiki/data/_default directory to the new data directory, preserving the original files' owner, group and permissions (on Unix, use cp -p). The data files must be writable by the owner the CGI scripts are running on (usually, nobody).
    • HINT: You can set permissions of .txt and .txt,v files to -rw-rw-rw- (666) and then edit the topic using your browser; RCS will restore the file permissions correctly when saving the topic.
  2. Add the new web to the web list (visible in the upper right corner of each topic) by editing the site-level preferences, TWikiPreferences:

Revision 3718 Sep 2001 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Line: 73 to 73
 
  • To be able to edit the Perl scripts and .tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
  • NOTE: This Guide assumes user nobody ownership for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. You can:
    • replace nobody with another user if your server executes scripts under a different name (ex: default for Debian is www-data).
Added:
>
>
      • HINT: Run the testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. It will show you the user name of the CGI scripts, a table listing all CGI environment variables, and a test of your twiki/lib/TWiki.cfg configuration file (you'll configure that in a minute).
 
    • replace user twiki with your own username
Changed:
<
<
  • The CGI scripts execute as nobody. Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x (755).
  • Test your settings by running the testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. You should get a table listing all CGI environment variables, and a test of your twiki/lib/TWiki.cfg configuration file (you'll configure that in a minute).
>
>
  • Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x (755).
 
  • Set the permission of all files below twiki/data so that they are writable by user nobody. A simple way is to chmod them to -rw-rw-r-- (664) and to chown them to nobody.
  • Set the permission of the twiki/data directory and its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
  • Set the permission of the twiki/pub directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
Added:
>
>
  • NOTE: The twiki/data/*/*.txt,v RCS repository files in the installation package are locked by user nobody. If your CGI scripts are not running as user nobody, it's not possible to check in files (you'll see that the revision number won't increase after saving a topic). In this case, you need to unlock all repository files (check the RCS man pages) and lock them with a different user, ex www-data, or delete them all - new files will be automatically created the first time each topic is edited. A simple way to change ownership is with a search-and-replace in all files; for example, using sed:
    for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
 

Step 3: Set the Main Configuration File

  • Edit the file twiki/lib/TWiki.cfg, setting the variables to your needs.
    • Set the file extension in the $scriptSuffix variable to cgi or pl if required.
    • Make sure RCS is installed. Set $rcsDir in twiki/lib/TWiki.cfg to mach the location of your RCS binaries.
Deleted:
<
<
  • NOTE: The *,v RCS repository files in the installation package are locked by user nobody. If your CGI scripts are not running as user nobody, it's not possible to check in files (you'll see that the revision number won't increase after saving a topic). In this case, you need to unlock all repository files and lock them as user www-data (check the RCS man pages), or delete them all - new files will be automatically created the first time each topic is edited. A simple way to change ownership is with a search-and-replace in all files; for example, using sed:
    for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
 
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directories to a place where they are not visible, and change the variables in twiki/lib/TWiki.cfg accordingly)
Changed:
<
<
>
>
  • Test your settings by running the testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. Check if your twiki/lib/TWiki.cfg configuration file settings are correct.
 

Step 4: Finish Up from Your Browser

  • Point your Web browser at http://yourdomain.com/twiki/bin/view and start TWiki-ing away!
Changed:
<
<
  • Edit the TWikiAdminGroup topic to include users with system administrator status.
  • Edit the TWikiPreferences topic in the TWiki:TWiki web to set the WIKIWEBMASTER email address, the WEBCOPYRIGHT message, access privileges, and other preferences.
  • Edit the WebPreferences topic in each web, if necessary: set access priviliges, individual WEBCOPYRIGHT messages, other preferences.
>
>
  • Edit the TWikiPreferences topic in the TWiki:TWiki web to set the WIKIWEBMASTER email address, and other preferences.
  • Edit the WebPreferences topic in each web, if necessary: set individual WEBCOPYRIGHT messages, and other preferences.
  • Enable email notification of topic changes, MonitoringSiteActivity? has more.
 
  • Edit the WebNotify topic in all webs and add the users you want to notify.
Added:
>
>
 

That's it for the standard virgin installation of TWiki. Read on for server-level customization options.

Line: 105 to 105
 With your new TWiki installation up and running, you can manage most aspects of your site from the browser interface. Only a few functions require access to the server file system, via Telnet or FTP. You can make these server-level changes during installation, and at any time afterwards.
Added:
>
>

Enabling Authentication of Users

  • If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users:
    1. Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details, consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
      Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
      AuthUserFile /filepath/to/TWiki/data/.htpasswd
      ErrorDocument 401 /urlpath/to/TWiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
      • NOTE: In case you renamed the CGI script files to have a file extension you need to reflect that in the edit, view, preview, etc entries in .htaccess.
      • NOTE: The browser should ask for login name and password when you click on the Edit link. In case .htaccess does not have the desired effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
    2. Copy the TWikiRegistrationPub? topic to TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the .txt and .txt,v files in the twiki/data/TWiki directory.
      • HINT: You can customize the registration form by deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This ensures that the fields are processed correctly.
  • Register yourself in the TWikiRegistration topic.
    • NOTE: When a user registers, a new line with the username and encrypted password is added to the data/.htpasswd file. The .htpasswd file that comes with the TWiki installation includes user accounts for TWiki core team members that are used for testing on TWiki.org. You can edit the file and delete those lines.
  • Create a new topic to check if authentication works.
  • Edit the TWikiAdminGroup topic in the TWiki:Main web to include users with system administrator status.
  • Edit the TWikiPreferences topic in the TWiki:TWiki web to set access privileges.
  • Edit the WebPreferences topic in each web, if necessary: set access priviliges.
 

Adding a New Web

Line: 130 to 148
 NOTE: User home topics are located in the Proyecto META.Main web - don't try to move them or create them in other webs. From any other web, user signatures have to point to Proyecto META.Main web, using a Main.UserName or %MAINWEB%.UserName format. (The %MAINWEB% variable is an advantage if you ever change the Main web name, but the standard Main.UserName is easier for users to enter, which is the bottom line!
Deleted:
<
<

Enabling Basic Authentication (.htaccess)

  • If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users:
    1. Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details, consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
      Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
      AuthUserFile /filepath/to/TWiki/data/.htpasswd
      ErrorDocument 401 /urlpath/to/TWiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
      • NOTE: In case you renamed the CGI script files to have a file extension you need to reflect that in the edit, view, preview, etc entries in .htaccess.
      • NOTE: The browser should ask for login name and password when you click on the Edit link. In case .htaccess does not have the desired effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
    2. Copy the TWikiRegistrationPub? topic to TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the .txt and .txt,v files in the twiki/data/TWiki directory.
      • You can customize the registration form by deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This ensures that the fields are processed correctly.

    • NOTE: When a user registers, a new line with the username and encrypted password is added to the data/.htpasswd file. The .htpasswd file that comes with the TWiki installation includes user accounts for TWiki core team members that are used for testing on TWiki.org. You can edit the file and delete those lines.
 

TWiki File System Info

See Appendix A: TWiki File System? for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.

Revision 3616 Sep 2001 - Main.MikeMannix

Line: 1 to 1
 

TWiki Installation Guide

Line: 14 to 14
 Request and download the TWiki 01-Sep-2001 distribution in Unix ZIP format from http://TWiki.org/download.html. (To install TWiki on SourceForge, for use on a software development project, read TWiki:Codev/SourceForgeHowTo.)
Deleted:
<
<
  • NOTE: This Guide assumes user nobody ownership for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. You can:
    • replace nobody with another user if your server executes scripts under a different name (ex: default for Debian is www-data).
    • replace user twiki with your own username
 

Step 1: Create & Configure the Directories

NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the alternative Step 1 instead.

Line: 44 to 40
  </Directory>
Added:
>
>
  • Restart Apache by /etc/rc.d/rc5.d/S85httpd restart .
  • Test that the twiki/bin directory is CGI-enabled by trying visiting it in your browser:
    • Enter the URL for the bin directory, http://yourdomain.com/twiki/bin/.
    • Your settings are OK if you get a message like "Forbidden. You don't have permission to access /twiki/bin/ on this server".
    • Settings are NOT correct if you get something like "Index of /twiki/bin" - recheck your httpd.conf file.
 

Line: 64 to 66
 

Changed:
<
<

Step 2: Check the Server Directory Settings

>
>

Step 2: Set File Permissions

 
Changed:
<
<
  • Restart Apache by /etc/rc.d/rc5.d/S85httpd restart .
  • Test if the twiki/bin directory is CGI-enabled:
    • Enter the URL of that directory into your browser ( http://your.domain.com/twiki/bin ). It is not set correctly as cgi-bin in case you get something like "Index of /twiki/bin" . It is OK if you get a message like "Forbidden. You don't have permission to access /twiki/bin/ on this server."
    • Execute the testenv script from your browser ( http://your.domain.com/twiki/bin/testenv ). It shows a table with all CGI environment variables. It also tests the settings in your twiki/lib/TWiki.cfg configuration file, which you will set later on.

Step 3: Enable Perl File Permissions

  • Make sure Perl 5 and the Perl CGI library are installed on your system. The default location of Perl is /usr/bin/perl. If Perl is installed elsewhere, change the first line of all scripts in the twiki/bin directory (or create a symbolic link from /usr/bin/perl).
    • IMPORTANT: On most ISP virtual domain accounts, Perl CGI scripts require a .cgi extension to run. Some systems need .pl, the regular Perl extension. Change all twiki/bin scripts appropriately if necessary.
>
>
  • Make sure Perl 5 and the Perl CGI library are installed on your system. The default location of Perl is /usr/bin/perl. If it's elsewhere, change the path to Perl in the first line of each script in the twiki/bin directory, or create a symbolic link from /usr/bin/perl.
    • IMPORTANT: On ISP-hosted accounts, Perl CGI scripts usually require a .cgi extension to run. Some systems need .pl, the regular Perl extension. Modify all twiki/bin script filenames if necessary.
 
  • To be able to edit the Perl scripts and .tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
Added:
>
>
  • NOTE: This Guide assumes user nobody ownership for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. You can:
    • replace nobody with another user if your server executes scripts under a different name (ex: default for Debian is www-data).
    • replace user twiki with your own username
 
  • The CGI scripts execute as nobody. Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x (755).
Added:
>
>
  • Test your settings by running the testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. You should get a table listing all CGI environment variables, and a test of your twiki/lib/TWiki.cfg configuration file (you'll configure that in a minute).
 
  • Set the permission of all files below twiki/data so that they are writable by user nobody. A simple way is to chmod them to -rw-rw-r-- (664) and to chown them to nobody.
  • Set the permission of the twiki/data directory and its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
  • Set the permission of the twiki/pub directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
Changed:
<
<

Step 4: Set the Main Configuration File

>
>

Step 3: Set the Main Configuration File

 
Changed:
<
<
  • Edit the file twiki/lib/TWiki.cfg and set the variables to your needs.
>
>
  • Edit the file twiki/lib/TWiki.cfg, setting the variables to your needs.
 
    • Set the file extension in the $scriptSuffix variable to cgi or pl if required.
    • Make sure RCS is installed. Set $rcsDir in twiki/lib/TWiki.cfg to mach the location of your RCS binaries.
Changed:
<
<
  • Note in case the CGI scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (ex: www-data ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user www-data (check the rcs man pages), or simply delete all the repository files. A simple way to switch the locker of the RCS files is to use sed:
    for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
>
>
  • NOTE: The *,v RCS repository files in the installation package are locked by user nobody. If your CGI scripts are not running as user nobody, it's not possible to check in files (you'll see that the revision number won't increase after saving a topic). In this case, you need to unlock all repository files and lock them as user www-data (check the RCS man pages), or delete them all - new files will be automatically created the first time each topic is edited. A simple way to change ownership is with a search-and-replace in all files; for example, using sed:
    for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
 
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directories to a place where they are not visible, and change the variables in twiki/lib/TWiki.cfg accordingly)
  • Enable email notification of topic changes, MonitoringSiteActivity? has more.
  • Add the TWiki:Main/PoweredByTWikiLogo to your Main topic.
Changed:
<
<

Step 5: Finish Up from Your Browser

>
>

Step 4: Finish Up from Your Browser

 
  • Point your Web browser at http://yourdomain.com/twiki/bin/view and start TWiki-ing away!
  • Edit the TWikiAdminGroup topic to include users with system administrator status.

Revision 3516 Sep 2001 - Main.MikeMannix

Line: 1 to 1
 

TWiki Installation Guide

Changed:
<
<
Installation instructions for the current public release (01-Sep-2001)
>
>
Installation instructions for the TWiki 01-Sep-2001 production release
 

Overview

These installation steps are based on the Apache Web server on Linux. TWiki runs on other Web servers and Unix systems, and should be fine with any OS and server that meet the system requirements?. Documentation for other platforms is currently limited. For Windows, check TWiki:Codev/TWikiOnWindows. Search the TWiki:Codev web for other intallation notes.

Added:
>
>

Standard Installation

Request and download the TWiki 01-Sep-2001 distribution in Unix ZIP format from http://TWiki.org/download.html. (To install TWiki on SourceForge, for use on a software development project, read TWiki:Codev/SourceForgeHowTo.)

 
  • NOTE: This Guide assumes user nobody ownership for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. You can:
    • replace nobody with another user if your server executes scripts under a different name (ex: default for Debian is www-data).
    • replace user twiki with your own username
Deleted:
<
<

Standard Installation

Request and download the TWiki 01-Sep-2001 distribution in Unix ZIP format from http://TWiki.org/download.html.

 

Step 1: Create & Configure the Directories

Changed:
<
<
  • NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the alternative Step 1 instead.
  • NOTE: To install TWiki on SourceForge, for use on a software development project, read TWiki:Codev/SourceForgeHowTo.
>
>
NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the alternative Step 1 instead.
 
  • Create directory /home/httpd/twiki and unzip the TWiki distribution into this directory.
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.

Revision 3415 Sep 2001 - Main.MikeMannix

Line: 1 to 1
 

TWiki Installation Guide

Line: 17 to 17
 

Standard Installation

Request and download the TWiki 01-Sep-2001 distribution in Unix ZIP format from http://TWiki.org/download.html.

Deleted:
<
<
 

Step 1: Create & Configure the Directories

Changed:
<
<
NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the alternative Step 1 instead.
>
>
  • NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the alternative Step 1 instead.
  • NOTE: To install TWiki on SourceForge, for use on a software development project, read TWiki:Codev/SourceForgeHowTo.
 
  • Create directory /home/httpd/twiki and unzip the TWiki distribution into this directory.
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.
  • The twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki to file httpd.conf with normal access options (copy from /home/httpd/html ).
  • Now add ScriptAlias for /twiki/bin and Alias for /twiki to file httpd.conf .
Changed:
<
<

Note: The ScriptAlias must come before the Alias in Apache, otherwise it will fail to correctly set up /twiki/bin/ , due to the fact that it sees that as being just another subdirectory of the /twiki/ alias.
>
>

NOTE: The ScriptAlias must come before the Alias, otherwise, Apache will fail to correctly set up /twiki/bin/, by treating it as just another subdirectory of the /twiki/ alias.
 
Changed:
<
<
>
>
 Example httpd.conf entries:
 ScriptAlias /twiki/bin/ "/home/httpd/twiki/bin/"
 Alias /twiki/ "/home/httpd/twiki/"

Line: 56 to 56
 
  • Upload the TWiki files by FTP (transfer as text except for the image files in pub)
TWiki dir:down What it is: Where to copy: Example:
Changed:
<
<
twiki/bin CGI bin cgi-bin enabled dir /home/smith/public_html/cgi-bin
twiki/lib library files same level like twiki/bin /home/smith/public_html/lib
>
>
twiki/bin CGI bin cgi-enabled dir /home/smith/public_html/cgi-bin
twiki/lib library files same level as twiki/bin /home/smith/public_html/lib
 
twiki/pub public files htdoc enabled dir /home/smith/public_html/pub
twiki/data topic data outside of htdoc tree (for security) /home/smith/twiki/data
twiki/templates web templates outside of htdoc tree (for security) /home/smith/twiki/templates
Deleted:
<
<
(Read TWiki:Codev/SourceForgeHowTo in case you want to install TWiki on SourceForge, to use on a software development project.)
 

Revision 3315 Sep 2001 - Main.MikeMannix

Line: 1 to 1
 

TWiki Installation Guide

Changed:
<
<
Clean install of the current public release (01-Sep-2001)
>
>
Installation instructions for the current public release (01-Sep-2001)
 

Overview

Changed:
<
<
These installation steps use the Apache web server on Linux as an example. TWiki runs on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been well-documented. More on that at TWiki:Codev/TWikiOnWindows.)
>
>
These installation steps are based on the Apache Web server on Linux. TWiki runs on other Web servers and Unix systems, and should be fine with any OS and server that meet the system requirements?. Documentation for other platforms is currently limited. For Windows, check TWiki:Codev/TWikiOnWindows. Search the TWiki:Codev web for other intallation notes.
 
Changed:
<
<
  • NOTE: This Installation Guide assumes the following:

    • User nobody is used for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. Replace user nobody with another user if your Web server executes scripts under a different name (default for Debian is www-data). Also, you can substitute user twiki with your own username.

    • You have control over the Web server configuration files. In case you don't - you may be installing on an ISP-hosted server - follow the steps but use these directories instead:

TWiki dir: What it is: Where to copy: Example:
twiki/bin CGI bin cgi-bin enabled dir /home/smith/public_html/cgi-bin
twiki/lib library files same level like twiki/bin /home/smith/public_html/lib
twiki/pub public files htdoc enabled dir /home/smith/public_html/pub
twiki/data topic data outside of htdoc tree (for security) /home/smith/twiki/data
twiki/templates web templates outside of htdoc tree (for security) /home/smith/twiki/templates

Read TWiki:Codev/SourceForgeHowTo in case you want to install TWiki on SourceForge.

>
>
  • NOTE: This Guide assumes user nobody ownership for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. You can:
    • replace nobody with another user if your server executes scripts under a different name (ex: default for Debian is www-data).
    • replace user twiki with your own username
 
Added:
>
>
 

Standard Installation

Request and download the TWiki 01-Sep-2001 distribution in Unix ZIP format from http://TWiki.org/download.html.

Step 1: Create & Configure the Directories

Added:
>
>
NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the alternative Step 1 instead.
 
  • Create directory /home/httpd/twiki and unzip the TWiki distribution into this directory.
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.
  • The twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki to file httpd.conf with normal access options (copy from /home/httpd/html ).
Line: 52 to 44
  </Directory>
Added:
>
>

Step 1 for Non-Root Accounts

To install TWiki on a system where you don't have server administrator privileges, for example, on a hosted Web account:

  • Download and unzip TWiki on your local PC
  • Using the table below, create a directory structure on your host server
  • Upload the TWiki files by FTP (transfer as text except for the image files in pub)
TWiki dir: What it is: Where to copy: Example:
twiki/bin CGI bin cgi-bin enabled dir /home/smith/public_html/cgi-bin
twiki/lib library files same level like twiki/bin /home/smith/public_html/lib
twiki/pub public files htdoc enabled dir /home/smith/public_html/pub
twiki/data topic data outside of htdoc tree (for security) /home/smith/twiki/data
twiki/templates web templates outside of htdoc tree (for security) /home/smith/twiki/templates

(Read TWiki:Codev/SourceForgeHowTo in case you want to install TWiki on SourceForge, to use on a software development project.)

 

Step 2: Check the Server Directory Settings

  • Restart Apache by /etc/rc.d/rc5.d/S85httpd restart .
  • Test if the twiki/bin directory is CGI-enabled:
    • Enter the URL of that directory into your browser ( http://your.domain.com/twiki/bin ). It is not set correctly as cgi-bin in case you get something like "Index of /twiki/bin" . It is OK if you get a message like "Forbidden. You don't have permission to access /twiki/bin/ on this server."
Changed:
<
<
    • Execute the testenv script from your browser ( http://your.domain.com/twiki/bin/testenv ). It shows a table with all CGI environment variables. It also tests the settings in your twiki/lib/TWiki.cfg configuration file, which you will set later on.
>
>
    • Execute the testenv script from your browser ( http://your.domain.com/twiki/bin/testenv ). It shows a table with all CGI environment variables. It also tests the settings in your twiki/lib/TWiki.cfg configuration file, which you will set later on.
 

Step 3: Enable Perl File Permissions

Changed:
<
<
  • Make sure Perl 5 and the Perl CGI library are installed on your system. Default location of Perl executable is /usr/bin/perl. In case Perl is installed in a different location, the first line of all Perl scripts in the twiki/bin directory must be changed (alternatively you can create a symbolic link from /usr/bin/perl ).
    • IMPORTANT: On most ISP virtual domain accounts, Perl CGI scripts require a .cgi extension to run. Some systems need .pl, the regular Perl extension. Change all twiki/bin scripts appropriately if necessary.
  • To be able to edit the Perl scripts and .tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
  • The CGI scripts execute as nobody. Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x (755).
  • Set the permission of all files below twiki/data so that they are writable by user nobody. A simple way is to chmod them to -rw-rw-r-- (664) and to chown them to nobody.
  • Set the permission of the twiki/data directory and its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
  • Set the permission of the twiki/pub directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
>
>
  • Make sure Perl 5 and the Perl CGI library are installed on your system. The default location of Perl is /usr/bin/perl. If Perl is installed elsewhere, change the first line of all scripts in the twiki/bin directory (or create a symbolic link from /usr/bin/perl).
    • IMPORTANT: On most ISP virtual domain accounts, Perl CGI scripts require a .cgi extension to run. Some systems need .pl, the regular Perl extension. Change all twiki/bin scripts appropriately if necessary.
  • To be able to edit the Perl scripts and .tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
  • The CGI scripts execute as nobody. Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x (755).
  • Set the permission of all files below twiki/data so that they are writable by user nobody. A simple way is to chmod them to -rw-rw-r-- (664) and to chown them to nobody.
  • Set the permission of the twiki/data directory and its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
  • Set the permission of the twiki/pub directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
 

Step 4: Set the Main Configuration File

Changed:
<
<
  • Edit the file twiki/lib/TWiki.cfg and set the variables to your needs.
    • Set the file extension in the $scriptSuffix variable to cgi or pl if required.
>
>
  • Edit the file twiki/lib/TWiki.cfg and set the variables to your needs.
    • Set the file extension in the $scriptSuffix variable to cgi or pl if required.
 
    • Make sure RCS is installed. Set $rcsDir in twiki/lib/TWiki.cfg to mach the location of your RCS binaries.
Changed:
<
<
  • Note in case the CGI scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (e.g. www-data ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user www-data (check the rcs man pages), or simply delete all the repository files. A simple way to switch the locker of the RCS files is to use sed:
    for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directories to a place where they are not visible, and change the variables in twiki/lib/TWiki.cfg accordingly)
>
>
  • Note in case the CGI scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (ex: www-data ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user www-data (check the rcs man pages), or simply delete all the repository files. A simple way to switch the locker of the RCS files is to use sed:
    for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directories to a place where they are not visible, and change the variables in twiki/lib/TWiki.cfg accordingly)
 

Step 5: Finish Up from Your Browser

Changed:
<
<
  • Point your Web browser at http://your.domain.com/twiki/bin/view and start TWiki-ing away!
  • Edit the TWikiPreferences topic in the TWiki:TWiki web to set the WIKIWEBMASTER email address, the WEBCOPYRIGHT message and other preferences.
  • Edit the WebNotify topic in all webs and set the users you want to notify.
>
>
  • Point your Web browser at http://yourdomain.com/twiki/bin/view and start TWiki-ing away!
  • Edit the TWikiAdminGroup topic to include users with system administrator status.
  • Edit the TWikiPreferences topic in the TWiki:TWiki web to set the WIKIWEBMASTER email address, the WEBCOPYRIGHT message, access privileges, and other preferences.
  • Edit the WebPreferences topic in each web, if necessary: set access priviliges, individual WEBCOPYRIGHT messages, other preferences.
  • Edit the WebNotify topic in all webs and add the users you want to notify.
  • You can add new %VARIABLES%. Define site-level variables in the TWikiPreferences topic. See also: TWikiVariables.
 
Changed:
<
<
That's it for the standard virgin installation of TWiki. Read on to learn how to customize TWiki.
>
>
That's it for the standard virgin installation of TWiki. Read on for server-level customization options.
 

Additional Server-Level Options

Changed:
<
<
Complete a Standard Installation and your new TWiki site should be up and running. You can develop and manage most aspects of your site from the browser interface. Core set-up functions require direct access to the server file system, via Telnet or FTP. You can make server-level site changes during installation, or at any time afterwards.
>
>
With your new TWiki installation up and running, you can manage most aspects of your site from the browser interface. Only a few functions require access to the server file system, via Telnet or FTP. You can make these server-level changes during installation, and at any time afterwards.
 
Changed:
<
<

Creating a New Web

>
>

Adding a New Web

 
Changed:
<
<
  • To create a new web:
>
>
To create a new web:
 
    1. Create a new web data directory under twiki/data and check the file permission of the directory.
      • Use a name consisting of characters A..Z , a..z but not in WikiNotation.
    2. Copy all files from the twiki/data/_default directory to the new data directory, preserving the original files' owner, group and permissions (on Unix, use cp -p). The data files must be writable by the owner the CGI scripts are running on (usually, nobody).
Changed:
<
<
      • Hint: You can set permissions of .txt and .txt,v files to -rw-rw-rw- (666) and then edit the topic using your browser; RCS will restore the file permissions correctly when saving the topic.
>
>
    • HINT: You can set permissions of .txt and .txt,v files to -rw-rw-rw- (666) and then edit the topic using your browser; RCS will restore the file permissions correctly when saving the topic.
 
    1. Add the new web to the web list (visible in the upper right corner of each topic) by editing the site-level preferences, TWikiPreferences:
      • Add the new web to the %WIKIWEBLIST% variable.
    2. Update the web settings by editing the WebPreferences topic of the new web:
Line: 108 to 125
 
    1. Add the new web to the color-coded web directory table by editing the TWikiWebsTable topic.
    2. Test the new web: view pages, create a new page.
Changed:
<
<
  • That's it for a basic new web set-up. You can also further customize the web:
    • Create customized templates in the new templates directory (otherwise, templates are inherited from twiki/templates).
      • NOTE: For web-specific templates in a templates subdirectory, ex: twiki/templates/someweb.
    • Create TWikiForms to add form-based page input that's stored separately from the main free-form topic text.

  • NOTE: User home topics are located in the Proyecto META.Main web - don't try to move them or create them in other webs. From any web you can refer to users located in the Proyecto META.Main web with Main.UserName or %MAINWEB%.UserName - using the %MAINWEB% variable is preferable, particularly if you might change the Main web name.
>
>
That's it for a basic new web set-up!
 
Changed:
<
<

Adding Variables & Rendering Rules

>
>
Optionally, you can also:
  • Create custom web-specific templates in a new twiki/templates/Someweb directory (otherwise, templates are inherited from twiki/templates).
  • Add TWikiForms for form-based page input that's stored separately from the main free-form topic text.
 
Changed:
<
<
  • You can add new %VARIABLES%. Define site-level variables in the TWikiPreferences topic. See also TWikiVariables.
  • You can add new rendering rules or add new functionality to TWiki. To insure an easy upgrade of TWiki, it is recommended to do this sort of customization with TWikiPlugins and the Plugins API.
>
>
NOTE: User home topics are located in the Proyecto META.Main web - don't try to move them or create them in other webs. From any other web, user signatures have to point to Proyecto META.Main web, using a Main.UserName or %MAINWEB%.UserName format. (The %MAINWEB% variable is an advantage if you ever change the Main web name, but the standard Main.UserName is easier for users to enter, which is the bottom line!
 

Enabling Basic Authentication (.htaccess)

Changed:
<
<
  • If you are on a non-authenticated server - not using SSL - and you would like to authenticate users:
>
>
  • If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users:
 
    1. Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details, consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
      Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
      AuthUserFile /filepath/to/TWiki/data/.htpasswd
Line: 130 to 143
 
      • NOTE: In case you renamed the CGI script files to have a file extension you need to reflect that in the edit, view, preview, etc entries in .htaccess.
      • NOTE: The browser should ask for login name and password when you click on the Edit link. In case .htaccess does not have the desired effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
    1. Copy the TWikiRegistrationPub? topic to TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the .txt and .txt,v files in the twiki/data/TWiki directory.
Changed:
<
<
      • NOTE: You can customize the registration form if needed, like deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This will ensure that the fields are processed correctly.
>
>
      • You can customize the registration form by deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This ensures that the fields are processed correctly.
 
Changed:
<
<
    • A new line containing user name and encrypted password gets added to the data/.htpasswd file when a users registers. The file that comes with the TWiki installation contains a few user accounts of TWiki core team members (needed for testing). You can edit the file and delete those lines.
>
>
    • NOTE: When a user registers, a new line with the username and encrypted password is added to the data/.htpasswd file. The .htpasswd file that comes with the TWiki installation includes user accounts for TWiki core team members that are used for testing on TWiki.org. You can edit the file and delete those lines.
 

TWiki File System Info

Changed:
<
<
See A: TWiki File System for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
>
>
See Appendix A: TWiki File System? for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
 
Added:
>
>
-- PeterThoeny - 13 Sep 2001
 -- MikeMannix? - 14 Sep 2001
Deleted:
<
<
-- PeterThoeny? - 13 Sep 2001
 
META TOPICMOVED by="MikeMannix" date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide"

Revision 3215 Sep 2001 - Main.MikeMannix

Line: 1 to 1
 

TWiki Installation Guide

Line: 13 to 13
 
    • User nobody is used for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. Replace user nobody with another user if your Web server executes scripts under a different name (default for Debian is www-data). Also, you can substitute user twiki with your own username.
Changed:
<
<
    • You have control over the Web server configuraton files. In case you don't - you may be installing on an ISP-hosted server - follow the steps but use these directories instead:
>
>
    • You have control over the Web server configuration files. In case you don't - you may be installing on an ISP-hosted server - follow the steps but use these directories instead:
 
TWiki dir: What it is: Where to copy: Example:
twiki/bin CGI bin cgi-bin enabled dir /home/smith/public_html/cgi-bin
Line: 55 to 55
 

Step 2: Check the Server Directory Settings

  • Restart Apache by /etc/rc.d/rc5.d/S85httpd restart .
Changed:
<
<
  • Test if the twiki/bin directory is cgi-enabled:
>
>
  • Test if the twiki/bin directory is CGI-enabled:
 
    • Enter the URL of that directory into your browser ( http://your.domain.com/twiki/bin ). It is not set correctly as cgi-bin in case you get something like "Index of /twiki/bin" . It is OK if you get a message like "Forbidden. You don't have permission to access /twiki/bin/ on this server."
    • Execute the testenv script from your browser ( http://your.domain.com/twiki/bin/testenv ). It shows a table with all CGI environment variables. It also tests the settings in your twiki/lib/TWiki.cfg configuration file, which you will set later on.

Step 3: Enable Perl File Permissions

  • Make sure Perl 5 and the Perl CGI library are installed on your system. Default location of Perl executable is /usr/bin/perl. In case Perl is installed in a different location, the first line of all Perl scripts in the twiki/bin directory must be changed (alternatively you can create a symbolic link from /usr/bin/perl ).
Changed:
<
<
    • IMPORTANT: On most ISP virtual domain accounts, Perl CGI scripts require a .cgi extension to run. Some systems need .pl, the regular Perl extension. Change all twiki/bin scripts appropriately if necssary.
>
>
    • IMPORTANT: On most ISP virtual domain accounts, Perl CGI scripts require a .cgi extension to run. Some systems need .pl, the regular Perl extension. Change all twiki/bin scripts appropriately if necessary.
 
  • To be able to edit the Perl scripts and .tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
  • The CGI scripts execute as nobody. Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x (755).
  • Set the permission of all files below twiki/data so that they are writable by user nobody. A simple way is to chmod them to -rw-rw-r-- (664) and to chown them to nobody.
Line: 75 to 75
 
    • Set the file extension in the $scriptSuffix variable to cgi or pl if required.
    • Make sure RCS is installed. Set $rcsDir in twiki/lib/TWiki.cfg to mach the location of your RCS binaries.
  • Note in case the CGI scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (e.g. www-data ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user www-data (check the rcs man pages), or simply delete all the repository files. A simple way to switch the locker of the RCS files is to use sed:
    for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
Changed:
<
<
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directries to a place where they are not visible, and change the variables in twiki/lib/TWiki.cfg accordingly)
>
>
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directories to a place where they are not visible, and change the variables in twiki/lib/TWiki.cfg accordingly)
 
Line: 138 to 138
 See A: TWiki File System for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
Changed:
<
<
-- MikeMannix? - 07 Sep 2001
>
>
-- MikeMannix? - 14 Sep 2001
 -- PeterThoeny? - 13 Sep 2001
META TOPICMOVED by="MikeMannix" date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide"

Revision 3114 Sep 2001 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Guide

Line: 7 to 7
 

Overview

Changed:
<
<
These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been well-documented. More on that at http://TWiki.org/cgi-bin/view/Codev/TWikiOnWindows.)
>
>
These installation steps use the Apache web server on Linux as an example. TWiki runs on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been well-documented. More on that at TWiki:Codev/TWikiOnWindows.)
 
  • NOTE: This Installation Guide assumes the following:
Changed:
<
<
    • User nobody= is used for all files manipulated by the CGI scripts (executed by the Web server), and user =twiki for all other files. Replace user nobody with another user if your Web server executes scripts under a different name (default for Debian is www-data). Also, you can substitute user twiki with your own username.
>
>
    • User nobody is used for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. Replace user nobody with another user if your Web server executes scripts under a different name (default for Debian is www-data). Also, you can substitute user twiki with your own username.
 
    • You have control over the Web server configuraton files. In case you don't - you may be installing on an ISP-hosted server - follow the steps but use these directories instead:

TWiki dir: What it is: Where to copy: Example:
Changed:
<
<
twiki/bin CGI bin cgi-bin enabled dir /home/smith/public_html/cgi-bin/twiki
>
>
twiki/bin CGI bin cgi-bin enabled dir /home/smith/public_html/cgi-bin
twiki/lib library files same level like twiki/bin /home/smith/public_html/lib
 
twiki/pub public files htdoc enabled dir /home/smith/public_html/pub
twiki/data topic data outside of htdoc tree (for security) /home/smith/twiki/data
twiki/templates web templates outside of htdoc tree (for security) /home/smith/twiki/templates
Changed:
<
<
Read http://TWiki.org/cgi-bin/view/Codev/SourceForgeHowTo in case you want to install TWiki on SourceForge.
>
>
Read TWiki:Codev/SourceForgeHowTo in case you want to install TWiki on SourceForge.
 

Standard Installation

Line: 56 to 57
 
  • Restart Apache by /etc/rc.d/rc5.d/S85httpd restart .
  • Test if the twiki/bin directory is cgi-enabled:
    • Enter the URL of that directory into your browser ( http://your.domain.com/twiki/bin ). It is not set correctly as cgi-bin in case you get something like "Index of /twiki/bin" . It is OK if you get a message like "Forbidden. You don't have permission to access /twiki/bin/ on this server."
Changed:
<
<
    • Execute the testenv script from your browser ( http://your.domain.com/twiki/bin/testenv ). It shows a table with all CGI environment variables and tests the settings in your twiki/bin/wikicfg.pm configuration file.
>
>
    • Execute the testenv script from your browser ( http://your.domain.com/twiki/bin/testenv ). It shows a table with all CGI environment variables. It also tests the settings in your twiki/lib/TWiki.cfg configuration file, which you will set later on.
 

Step 3: Enable Perl File Permissions

  • Make sure Perl 5 and the Perl CGI library are installed on your system. Default location of Perl executable is /usr/bin/perl. In case Perl is installed in a different location, the first line of all Perl scripts in the twiki/bin directory must be changed (alternatively you can create a symbolic link from /usr/bin/perl ).
    • IMPORTANT: On most ISP virtual domain accounts, Perl CGI scripts require a .cgi extension to run. Some systems need .pl, the regular Perl extension. Change all twiki/bin scripts appropriately if necssary.
  • To be able to edit the Perl scripts and .tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
Changed:
<
<
  • The scripts execute as nobody. Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x (755).
  • Set the permission of all files below twiki/data so that they are writable by user nobody. A simple way is to chmod them to -rw-rw-rw- (666).
  • Set the permission of the twiki/data directory and its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxrwx (777).
  • Set the permission of the twiki/pub directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxrwx (777).
>
>
  • The CGI scripts execute as nobody. Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x (755).
  • Set the permission of all files below twiki/data so that they are writable by user nobody. A simple way is to chmod them to -rw-rw-r-- (664) and to chown them to nobody.
  • Set the permission of the twiki/data directory and its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
  • Set the permission of the twiki/pub directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
 

Step 4: Set the Main Configuration File

Changed:
<
<
  • Edit the file twiki/bin/wikicfg.pm and set the variables at the beginning of the file to your needs.
>
>
  • Edit the file twiki/lib/TWiki.cfg and set the variables to your needs.
 
    • Set the file extension in the $scriptSuffix variable to cgi or pl if required.
Changed:
<
<
    • Make sure RCS is installed. Set $rcsDir in twiki/bin/wikicfg.pm to mach the location of your RCS binaries.
  • Note in case the cgi scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (e.g. www-data ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user www-data (check the rcs man pages), or simply delete all the repository files. A simple way to switch the locker of the RCS files is to use sed:
    for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directries to a place where they are not visible, and change the variables in twiki/bin/wikicfg.pm accordingly)
  • Enable email notification of topic changes, Notification of Changes has more.
  • Add the TWiki:Main.PoweredByTWikiLogo to your Main topic.
>
>
    • Make sure RCS is installed. Set $rcsDir in twiki/lib/TWiki.cfg to mach the location of your RCS binaries.
  • Note in case the CGI scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (e.g. www-data ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user www-data (check the rcs man pages), or simply delete all the repository files. A simple way to switch the locker of the RCS files is to use sed:
    for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directries to a place where they are not visible, and change the variables in twiki/lib/TWiki.cfg accordingly)
  • Enable email notification of topic changes, MonitoringSiteActivity? has more.
  • Add the TWiki:Main/PoweredByTWikiLogo to your Main topic.
 

Step 5: Finish Up from Your Browser

  • Point your Web browser at http://your.domain.com/twiki/bin/view and start TWiki-ing away!
  • Edit the TWikiPreferences topic in the TWiki:TWiki web to set the WIKIWEBMASTER email address, the WEBCOPYRIGHT message and other preferences.
Deleted:
<
<
  • If you use .htaccess, edit the file and add the file extension to edit, view, preview, etc.
 
  • Edit the WebNotify topic in all webs and set the users you want to notify.

That's it for the standard virgin installation of TWiki. Read on to learn how to customize TWiki.

Line: 111 to 111
 
  • That's it for a basic new web set-up. You can also further customize the web:
    • Create customized templates in the new templates directory (otherwise, templates are inherited from twiki/templates).
      • NOTE: For web-specific templates in a templates subdirectory, ex: twiki/templates/someweb.
Changed:
<
<
    • Create Form Templates to add form-based page input that's stored separately from the main free-form topic text.
>
>
    • Create TWikiForms to add form-based page input that's stored separately from the main free-form topic text.
 
  • NOTE: User home topics are located in the Proyecto META.Main web - don't try to move them or create them in other webs. From any web you can refer to users located in the Proyecto META.Main web with Main.UserName or %MAINWEB%.UserName - using the %MAINWEB% variable is preferable, particularly if you might change the Main web name.

Adding Variables & Rendering Rules

Changed:
<
<
  • You can add new rendering rules or new %VARIABLES%. To insure an easy upgrade of TWiki, it is recommended to do this sort of customization with TWiki Plugins and the Plugins API.
>
>
  • You can add new %VARIABLES%. Define site-level variables in the TWikiPreferences topic. See also TWikiVariables.
  • You can add new rendering rules or add new functionality to TWiki. To insure an easy upgrade of TWiki, it is recommended to do this sort of customization with TWikiPlugins and the Plugins API.
 

Enabling Basic Authentication (.htaccess)

Line: 126 to 127
  Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
AuthUserFile /filepath/to/TWiki/data/.htpasswd
ErrorDocument 401 /urlpath/to/TWiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
Added:
>
>
      • NOTE: In case you renamed the CGI script files to have a file extension you need to reflect that in the edit, view, preview, etc entries in .htaccess.
 
      • NOTE: The browser should ask for login name and password when you click on the Edit link. In case .htaccess does not have the desired effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
    1. Copy the TWikiRegistrationPub? topic to TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the .txt and .txt,v files in the twiki/data/TWiki directory.
      • NOTE: You can customize the registration form if needed, like deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This will ensure that the fields are processed correctly.
Line: 137 to 139
 See A: TWiki File System for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.

-- MikeMannix? - 07 Sep 2001

Added:
>
>
-- PeterThoeny? - 13 Sep 2001
 
META TOPICMOVED by="MikeMannix" date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide"

Revision 3010 Sep 2001 - Main.MikeMannix

Line: 1 to 1
 

TWiki Installation Guide

Line: 9 to 9
 These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been well-documented. More on that at http://TWiki.org/cgi-bin/view/Codev/TWikiOnWindows.)
Changed:
<
<
NOTE: Below installation steps assume user nobody for all files manupulated by the cgi scripts (executed by the web server), and user twiki for all other files. You need to replace user nobody with an other user in case the web server executes the script with a different user ( default for Debian is www-data ). Also, you can substitute user twiki with your own user name.
>
>
  • NOTE: This Installation Guide assumes the following:
 
Changed:
<
<
NOTE: Below installation steps assume that you have control over the web server configuraton files. In case you don't - you may be installing on an ISP-hosted server - follow the steps but use these directories instead:
>
>
    • User nobody= is used for all files manipulated by the CGI scripts (executed by the Web server), and user =twiki for all other files. Replace user nobody with another user if your Web server executes scripts under a different name (default for Debian is www-data). Also, you can substitute user twiki with your own username.

    • You have control over the Web server configuraton files. In case you don't - you may be installing on an ISP-hosted server - follow the steps but use these directories instead:
 
TWiki dir: What it is: Where to copy: Example:
twiki/bin CGI bin cgi-bin enabled dir /home/smith/public_html/cgi-bin/twiki
Line: 85 to 87
 That's it for the standard virgin installation of TWiki. Read on to learn how to customize TWiki.

Changed:
<
<

Extra Server-Level Options

>
>

Additional Server-Level Options

 Complete a Standard Installation and your new TWiki site should be up and running. You can develop and manage most aspects of your site from the browser interface. Core set-up functions require direct access to the server file system, via Telnet or FTP. You can make server-level site changes during installation, or at any time afterwards.
Line: 93 to 95
 

Creating a New Web

  • To create a new web:
Changed:
<
<
    • Use a name for the web consisting of characters A..Z , a..z but not in WikiNotation.
    • Create a new template directory under twiki/templates .
    • Create a new data directory under twiki/data and check the file permission of the directory.
    • Copy the Web*.txt files from the twiki/data/Main directory to the new data directory, preserving the original files' owner, group and permissions ( on Unix use cp -p ). The data files must be writable by the owner the CGI scripts are running on ( usually nobody ). Hint: You can set permissions of .txt and .txt,v files to -rw-rw-rw- and then edit the topic using your browser, RCS will restore the file permission correctly when saving the topic.
    • Add the new web to the web list (visible in the upper right corner of each topic) by editing the site-level preferences TWikiPreferences:
>
>
    1. Create a new web data directory under twiki/data and check the file permission of the directory.
      • Use a name consisting of characters A..Z , a..z but not in WikiNotation.
    2. Copy all files from the twiki/data/_default directory to the new data directory, preserving the original files' owner, group and permissions (on Unix, use cp -p). The data files must be writable by the owner the CGI scripts are running on (usually, nobody).
      • Hint: You can set permissions of .txt and .txt,v files to -rw-rw-rw- (666) and then edit the topic using your browser; RCS will restore the file permissions correctly when saving the topic.
    3. Add the new web to the web list (visible in the upper right corner of each topic) by editing the site-level preferences, TWikiPreferences:
 
      • Add the new web to the %WIKIWEBLIST% variable.
Changed:
<
<
    • Add the new web to the web table (at the bottom of each WebHome topic) by editing the TWikiWebsTable topic.
    • Change the web preferences by editing the WebPreferences topic of the new web:
      • Set the WEBBGCOLOR variable to a color of your taste. The number represents the unique color for the web (consult an HTML book for colors.)
      • Customize the %WEBTOPICLIST% variable to contain the web specific links you prefer.
      • Optional: Set the %WEBCOPYRIGHT% variable to have a web-specific copyright text (at the bottom of each topic).
    • If needed, create customized templates in the new templates directory. (Non existing templates are inherited from twiki/templates )
    • If you want to use Form Templates - see TWiki Form Template
    • In case you want usage statistics for this web: Copy file WebStatistics.txt from the twiki/data/Main directory to the new data directory. Edit topic WebStatistics in the new web and delete old usage entries.
    • Note that user home topics are only located in the Proyecto META.Main web, so don't try to move them or create them in other webs. From any web you can refer to users located in the Proyecto META.Main web like Main.UserName or %MAINWEB%.UserName.
>
>
    1. Update the web settings by editing the WebPreferences topic of the new web:
      • Customize the %WEBTOPICLIST% variable to contain the web-specific links you prefer.
      • Set the WEBBGCOLOR variable to a color. The number represents the unique color for the web.
      • Set Plugins, access privileges, custom variables, other web-level options (ex: %WEBCOPYRIGHT% can be set for an individual web).
    2. Add the new web to the color-coded web directory table by editing the TWikiWebsTable topic.
    3. Test the new web: view pages, create a new page.

  • That's it for a basic new web set-up. You can also further customize the web:
    • Create customized templates in the new templates directory (otherwise, templates are inherited from twiki/templates).
      • NOTE: For web-specific templates in a templates subdirectory, ex: twiki/templates/someweb.
    • Create Form Templates to add form-based page input that's stored separately from the main free-form topic text.

  • NOTE: User home topics are located in the Proyecto META.Main web - don't try to move them or create them in other webs. From any web you can refer to users located in the Proyecto META.Main web with Main.UserName or %MAINWEB%.UserName - using the %MAINWEB% variable is preferable, particularly if you might change the Main web name.
 

Adding Variables & Rendering Rules

Changed:
<
<
  • You can add new rendering rules or new %VARIABLES%. To insure an easy upgrade of TWiki it is recommended to do this customization in twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .
>
>
  • You can add new rendering rules or new %VARIABLES%. To insure an easy upgrade of TWiki, it is recommended to do this sort of customization with TWiki Plugins and the Plugins API.
 

Enabling Basic Authentication (.htaccess)

Changed:
<
<
  • If you are on a non authenticated server (i.e. not using SSL) and you would like to authenticate users:
    • Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
>
>
  • If you are on a non-authenticated server - not using SSL - and you would like to authenticate users:
    1. Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details, consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
  Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
AuthUserFile /filepath/to/TWiki/data/.htpasswd
ErrorDocument 401 /urlpath/to/TWiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
Changed:
<
<
      • Note: The browser should ask for login name and password when you click on the Edit link. In case .htaccess does not have the desired effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
    • Copy the TWikiRegistrationPub? topic to TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the .txt and .txt,v files in the twiki/data/TWiki directory.
      • Note: You can customize the registration form if needed, like deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This will ensure that the fields are processed correctly.
    • A new line containing user name and encrypted password gets added to the data/.htpasswd file when a users registers. The file that comes with the TWiki installation contains a few user accounts of TWiki core team members (needed for testing). You can edit the file and delete those lines.
>
>
      • NOTE: The browser should ask for login name and password when you click on the Edit link. In case .htaccess does not have the desired effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
    1. Copy the TWikiRegistrationPub? topic to TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the .txt and .txt,v files in the twiki/data/TWiki directory.
      • NOTE: You can customize the registration form if needed, like deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This will ensure that the fields are processed correctly.
 
Changed:
<
<

TWiki File System Snapshot

Here are partial directory listings showing typical file permissions and ownership. This is provided for general debugging use only and isn't an exact representation of the current distribution. There is also a file listing by directory?, with individual file descriptions, for the current TWiki release.

>
>
    • A new line containing user name and encrypted password gets added to the data/.htpasswd file when a users registers. The file that comes with the TWiki installation contains a few user accounts of TWiki core team members (needed for testing). You can edit the file and delete those lines.
 
Changed:
<
<
Directory twiki/bin :
>
>

TWiki File System Info

 
Changed:
<
<
drwxrwxr-x	2 twiki twiki	4096 Jun 17 16:34 .
drwxrwxr-x	3 twiki twiki	4096 Jun 17 16:34 ..
-rw-rw-r--	1 twiki twiki	 650 Feb 10  2000 .htaccess
-rwxrwxr-x	1 twiki twiki	4322 Mar 12 00:31 attach
-rwxrwxr-x	1 twiki twiki	1426 Jun 20 19:52 delete
-rwxrwxr-x	1 twiki twiki	9001 Jul 28 11:03 edit
-rwxrwxr-x	1 twiki twiki	1811 Mar 11 02:27 geturl
-rwxrwxr-x	1 twiki twiki	5006 Mar 11 02:41 mailnotify
-rwxrwxr-x	1 twiki twiki	1769 Mar 11 03:07 oops
-rwxrwxr-x	1 twiki twiki	6890 Jun 21 19:58 preview
-rwxrwxr-x	1 twiki twiki	7606 Mar 31 18:30 rdiff
-rwxrwxr-x	1 twiki twiki	8349 Jun 21 18:12 register
-rwxrwxr-x	1 twiki twiki	2693 Jul  5 14:32 save
-rwxrwxr-x	1 twiki twiki	3831 Jul 20 12:13 search
-rwxrwxr-x	1 twiki twiki	9835 Jun 20 19:03 statistics
-rwxrwxr-x	1 twiki twiki	 509 Feb  7  2000 testenv
-rwxrwxr-x	1 twiki twiki  14543 Jul 20 18:46 upload
-rwxrwxr-x	1 twiki twiki	4755 May 22 18:11 view
-rwxrwxr-x	1 twiki twiki	1689 Jun 20 20:10 viewfile

Directory twiki/templates/ :

drwxrwxr-x	4 twiki twiki	4096 Aug  3 01:17 .
drwxrwxr-x	4 twiki twiki	4096 Aug 19 18:38 ..
drwxrwxr-x	2 twiki twiki	4096 Jun 17 16:35 Know
drwxrwxr-x	2 twiki twiki	4096 May  1 01:24 Main
-rw-rw-r--	1 twiki twiki	2688 Aug 15 18:15 attach.tmpl
-rw-rw-r--	1 twiki twiki	1283 Jul 20 15:56 attachtable.tmpl
-rw-rw-r--	1 twiki twiki	1907 Jul 28 16:41 changes.tmpl
-rw-rw-r--	1 twiki twiki	2265 Aug 15 17:57 edit.tmpl
-rw-rw-r--	1 twiki twiki	 965 Feb  8  2000 mailnotify.tmpl
-rw-rw-r--	1 twiki twiki	  30 Jan 13  1999 notedited.tmpl
-rw-rw-r--	1 twiki twiki	 940 Jul 20 15:59 notext.tmpl
-rw-rw-r--	1 twiki twiki	 907 Jul 20 16:01 notwiki.tmpl
-rw-rw-r--	1 twiki twiki	 341 Mar  8 11:39 noweb.tmpl
-rw-rw-r--	1 twiki twiki	1000 Mar  8 11:40 oops.tmpl
-rw-rw-r--	1 twiki twiki	1043 Oct 23 19:17 oopsaccesschange.tmpl
-rw-rw-r--	1 twiki twiki	1036 Oct 23 19:17 oopsaccessview.tmpl
-rw-rw-r--	1 twiki twiki	 914 Mar  8 11:40 oopsdel.tmpl
-rw-rw-r--	1 twiki twiki	1423 May 29 01:23 oopslocked.tmpl
-rw-rw-r--	1 twiki twiki	1067 Mar  8 11:41 oopsregexist.tmpl
-rw-rw-r--	1 twiki twiki	 955 Mar  8 11:41 oopsregpasswd.tmpl

Directory twiki/data/ :

drwxrwxrwx	6 nobody  nobody  4096 Aug  3 01:09 .
drwxrwxr-x	4 twiki	twiki	4096 Aug 19 18:38 ..
-rw-rw-r--	1 nobody  nobody	 51 Apr 21 16:48 .htpasswd
drwxrwxrwx	2 nobody  nobody  4096 Aug 20 17:18 Know
drwxrwxrwx	2 nobody  nobody  4096 Aug 19 04:15 Main
drwxrwxrwx	2 nobody  nobody  4096 Aug 20 17:56 TWiki
-rw-rw-rw-	1 twiki	twiki		1 Mar 11 04:19 debug.txt
-rw-r--r--	1 nobody  nobody  1516 Aug 20 17:56 log200008.txt

Partial file list for twiki/data/Main :

drwxrwxrwx	2 nobody  nobody  4096 Aug 19 04:15 .
drwxrwxrwx	6 nobody  nobody  4096 Aug  3 01:09 ..
-rw-rw-rw-	1 twiki twiki	  3716 Aug 19 02:19 .changes
-rw-rw-rw-	1 twiki twiki		  9 Aug 19 02:45 .mailnotify
-rw-r--r--	1 nobody  nobody	358 Aug 18 17:22 OfficeLocations.txt
-r--r--r--	1 nobody  nobody	878 Aug 18 17:22 OfficeLocations.txt,v
-rw-r--r--	1 nobody  nobody	680 Aug 18 17:36 TWikiGuest.txt
-r--r--r--	1 nobody  nobody  1989 Aug 18 17:36 TWikiGuest.txt,v
-rw-r--r--	1 nobody  nobody	459 Aug 18 17:19 TWikiUsers.txt
-r--r--r--	1 nobody  nobody  3840 Aug 18 17:19 TWikiUsers.txt,v
-rw-r--r--	1 nobody  nobody	 95 Aug 19 03:06 WebChanges.txt
-r--r--r--	1 nobody  nobody	284 Aug 19 03:06 WebChanges.txt,v
-rw-r--r--	1 nobody  nobody  1853 Aug 18 18:08 WebHome.txt
-r--r--r--	1 nobody  nobody  6523 Aug 18 18:08 WebHome.txt,v

Directory twiki/pub/ :

drwxrwxrwx	6 nobody  nobody  4096 Aug  3 01:21 .
drwxrwxr-x	3 twiki	twiki	4096 Jun 17 16:35 ..
drwxrwxrwx	3 nobody  nobody  4096 Jun 17 16:35 Know
drwxrwxrwx	2 nobody  nobody  4096 Aug  3 01:21 Main
drwxrwxrwx	3 nobody  nobody  4096 Aug  3 01:21 TWiki
-rw-rw-r--	1 twiki	twiki	1078 Jan 14  2000 favicon.ico
drwxrwxr-x	2 twiki	twiki	4096 Jun 17 16:35 icn
-rw-rw-r--	1 twiki	twiki	3016 Oct  5  1999 twikilogo.gif
-rw-rw-r--	1 twiki	twiki	5320 Oct  5  1999 twikilogo1.gif
-rw-rw-r--	1 twiki	twiki	6125 Oct  5  1999 twikilogo2.gif
-rw-rw-r--	1 twiki	twiki	7218 Oct  5  1999 twikilogo3.gif
-rw-rw-r--	1 twiki	twiki	6710 Oct  5  1999 twikilogo4.gif
-rw-rw-r--	1 twiki	twiki	2877 Jun  7  1999 wikiHome.gif

Partial file list for twiki/pub/icn/ :

drwxrwxr-x	2 twiki	twiki	4096 Jun 17 16:35 .
drwxrwxrwx	6 nobody  nobody  4096 Aug  3 01:21 ..
-rw-rw-r--	1 twiki	twiki	 801 Mar 26  1999 _filetypes.txt
-rw-rw-r--	1 twiki	twiki	 143 Mar  9  1999 bat.gif
-rw-rw-r--	1 twiki	twiki	 926 Mar  9  1999 bmp.gif
-rw-rw-r--	1 twiki	twiki	 141 Mar 25  1999 c.gif
-rw-rw-r--	1 twiki	twiki	 144 Mar  9  1999 dll.gif
-rw-rw-r--	1 twiki	twiki	 152 Mar  9  1999 doc.gif
>
>
See A: TWiki File System for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
 -- MikeMannix? - 07 Sep 2001
META TOPICMOVED by="MikeMannix" date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide"

Revision 2909 Sep 2001 - Main.MikeMannix

Line: 1 to 1
 

TWiki Installation Guide

Line: 9 to 9
 These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been well-documented. More on that at http://TWiki.org/cgi-bin/view/Codev/TWikiOnWindows.)
Changed:
<
<
Note: Below installation steps assume user nobody for all files manupulated by the cgi scripts (executed by the web server), and user twiki for all other files. You need to replace user nobody with an other user in case the web server executes the script with a different user ( default for Debian is www-data ). Also, you can substitute user twiki with your own user name.
>
>
NOTE: Below installation steps assume user nobody for all files manupulated by the cgi scripts (executed by the web server), and user twiki for all other files. You need to replace user nobody with an other user in case the web server executes the script with a different user ( default for Debian is www-data ). Also, you can substitute user twiki with your own user name.
 
Changed:
<
<
Note: Below installation steps assume that you have control over the web server configuraton files. In case you don't - you may be installing on an ISP-hosted server - follow the steps but use these directories instead:
>
>
NOTE: Below installation steps assume that you have control over the web server configuraton files. In case you don't - you may be installing on an ISP-hosted server - follow the steps but use these directories instead:
 
TWiki dir: What it is: Where to copy: Example:
twiki/bin CGI bin cgi-bin enabled dir /home/smith/public_html/cgi-bin/twiki
Line: 23 to 23
 

Standard Installation

Changed:
<
<
Request and download the TWiki %VERSION% distribution in Unix ZIP format from http://TWiki.org/download.html.
>
>
Request and download the TWiki 01-Sep-2001 distribution in Unix ZIP format from http://TWiki.org/download.html.
 

Step 1: Create & Configure the Directories

Line: 98 to 98
 
    • Create a new data directory under twiki/data and check the file permission of the directory.
    • Copy the Web*.txt files from the twiki/data/Main directory to the new data directory, preserving the original files' owner, group and permissions ( on Unix use cp -p ). The data files must be writable by the owner the CGI scripts are running on ( usually nobody ). Hint: You can set permissions of .txt and .txt,v files to -rw-rw-rw- and then edit the topic using your browser, RCS will restore the file permission correctly when saving the topic.
    • Add the new web to the web list (visible in the upper right corner of each topic) by editing the site-level preferences TWikiPreferences:
Changed:
<
<
      • Add the new web to the WIKIWEBLIST variable.
>
>
      • Add the new web to the %WIKIWEBLIST% variable.
 
    • Add the new web to the web table (at the bottom of each WebHome topic) by editing the TWikiWebsTable topic.
    • Change the web preferences by editing the WebPreferences topic of the new web:
      • Set the WEBBGCOLOR variable to a color of your taste. The number represents the unique color for the web (consult an HTML book for colors.)
Changed:
<
<
      • Customize the WEBTOPICLIST variable to contain the web specific links you prefer.
      • Optional: Set the WEBCOPYRIGHT variable to have a web-specific copyright text (at the bottom of each topic).
>
>
      • Customize the %WEBTOPICLIST% variable to contain the web specific links you prefer.
      • Optional: Set the %WEBCOPYRIGHT% variable to have a web-specific copyright text (at the bottom of each topic).
 
    • If needed, create customized templates in the new templates directory. (Non existing templates are inherited from twiki/templates )
Changed:
<
<
    • If you want to use form templates - see FormTemplateSystem?
>
>
 
    • In case you want usage statistics for this web: Copy file WebStatistics.txt from the twiki/data/Main directory to the new data directory. Edit topic WebStatistics in the new web and delete old usage entries.
    • Note that user home topics are only located in the Proyecto META.Main web, so don't try to move them or create them in other webs. From any web you can refer to users located in the Proyecto META.Main web like Main.UserName or %MAINWEB%.UserName.

Adding Variables & Rendering Rules

Changed:
<
<
  • You can add new rendering rules or new %VARIABLES%. To insure an easy upgrade of TWiki it is recommended to do this customization in twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .
>
>
  • You can add new rendering rules or new %VARIABLES%. To insure an easy upgrade of TWiki it is recommended to do this customization in twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .
 

Enabling Basic Authentication (.htaccess)

Line: 127 to 127
 

TWiki File System Snapshot

Changed:
<
<
Here are partial directory listings showing typical file permissions and ownership. This is provided for general debugging use only and isn't an exact representation of the current distribution. There is also a complete file listing by directory?, with individual file descriptions, for the current TWiki release.
>
>
Here are partial directory listings showing typical file permissions and ownership. This is provided for general debugging use only and isn't an exact representation of the current distribution. There is also a file listing by directory?, with individual file descriptions, for the current TWiki release.
 Directory twiki/bin :

Revision 2807 Sep 2001 - Main.MikeMannix

Line: 1 to 1
 
Changed:
<
<

TWiki Installation Guide

>
>

TWiki Installation Guide

 Clean install of the current public release (01-Sep-2001)
Changed:
<
<

Overview

>
>

Overview

 These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been well-documented. More on that at http://TWiki.org/cgi-bin/view/Codev/TWikiOnWindows.)
Line: 21 to 21
 Read http://TWiki.org/cgi-bin/view/Codev/SourceForgeHowTo in case you want to install TWiki on SourceForge.
Changed:
<
<

Standard Installation

>
>

Standard Installation

 Request and download the TWiki %VERSION% distribution in Unix ZIP format from http://TWiki.org/download.html.
Changed:
<
<

Step 1: Create & Configure the Directories

>
>

Step 1: Create & Configure the Directories

 
  • Create directory /home/httpd/twiki and unzip the TWiki distribution into this directory.
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.
Line: 49 to 49
  </Directory>
Changed:
<
<

Step 2: Check the Server Directory Settings

>
>

Step 2: Check the Server Directory Settings

 
  • Restart Apache by /etc/rc.d/rc5.d/S85httpd restart .
  • Test if the twiki/bin directory is cgi-enabled:
    • Enter the URL of that directory into your browser ( http://your.domain.com/twiki/bin ). It is not set correctly as cgi-bin in case you get something like "Index of /twiki/bin" . It is OK if you get a message like "Forbidden. You don't have permission to access /twiki/bin/ on this server."
    • Execute the testenv script from your browser ( http://your.domain.com/twiki/bin/testenv ). It shows a table with all CGI environment variables and tests the settings in your twiki/bin/wikicfg.pm configuration file.
Changed:
<
<

Step 3: Enable Perl File Permissions

>
>

Step 3: Enable Perl File Permissions

 
  • Make sure Perl 5 and the Perl CGI library are installed on your system. Default location of Perl executable is /usr/bin/perl. In case Perl is installed in a different location, the first line of all Perl scripts in the twiki/bin directory must be changed (alternatively you can create a symbolic link from /usr/bin/perl ).
    • IMPORTANT: On most ISP virtual domain accounts, Perl CGI scripts require a .cgi extension to run. Some systems need .pl, the regular Perl extension. Change all twiki/bin scripts appropriately if necssary.
Line: 66 to 66
 
  • Set the permission of the twiki/data directory and its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxrwx (777).
  • Set the permission of the twiki/pub directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxrwx (777).
Changed:
<
<

Step 4: Set the Main Configuration File

>
>

Step 4: Set the Main Configuration File

 
  • Edit the file twiki/bin/wikicfg.pm and set the variables at the beginning of the file to your needs.
    • Set the file extension in the $scriptSuffix variable to cgi or pl if required.
Line: 76 to 76
 
Changed:
<
<

Step 5: Finish Up from Your Browser

>
>

Step 5: Finish Up from Your Browser

 
  • Point your Web browser at http://your.domain.com/twiki/bin/view and start TWiki-ing away!
  • Edit the TWikiPreferences topic in the TWiki:TWiki web to set the WIKIWEBMASTER email address, the WEBCOPYRIGHT message and other preferences.
Line: 85 to 85
 That's it for the standard virgin installation of TWiki. Read on to learn how to customize TWiki.

Changed:
<
<

Extra Server-Level Options

>
>

Extra Server-Level Options

 Complete a Standard Installation and your new TWiki site should be up and running. You can develop and manage most aspects of your site from the browser interface. Core set-up functions require direct access to the server file system, via Telnet or FTP. You can make server-level site changes during installation, or at any time afterwards.

Changed:
<
<

Creating a New Web

>
>

Creating a New Web

 
  • To create a new web:
    • Use a name for the web consisting of characters A..Z , a..z but not in WikiNotation.
Line: 109 to 109
 
    • In case you want usage statistics for this web: Copy file WebStatistics.txt from the twiki/data/Main directory to the new data directory. Edit topic WebStatistics in the new web and delete old usage entries.
    • Note that user home topics are only located in the Proyecto META.Main web, so don't try to move them or create them in other webs. From any web you can refer to users located in the Proyecto META.Main web like Main.UserName or %MAINWEB%.UserName.
Changed:
<
<

Adding Variables & Rendering Rules

>
>

Adding Variables & Rendering Rules

 
  • You can add new rendering rules or new %VARIABLES%. To insure an easy upgrade of TWiki it is recommended to do this customization in twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .
Changed:
<
<

Enabling Basic Authentication (.htaccess)

>
>

Enabling Basic Authentication (.htaccess)

 
  • If you are on a non authenticated server (i.e. not using SSL) and you would like to authenticate users:
    • Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
Line: 125 to 125
 
      • Note: You can customize the registration form if needed, like deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This will ensure that the fields are processed correctly.
    • A new line containing user name and encrypted password gets added to the data/.htpasswd file when a users registers. The file that comes with the TWiki installation contains a few user accounts of TWiki core team members (needed for testing). You can edit the file and delete those lines.
Changed:
<
<

TWiki File System Snapshot

>
>

TWiki File System Snapshot

 Here are partial directory listings showing typical file permissions and ownership. This is provided for general debugging use only and isn't an exact representation of the current distribution. There is also a complete file listing by directory?, with individual file descriptions, for the current TWiki release.
Line: 153 to 153
 -rwxrwxr-x 1 twiki twiki 1689 Jun 20 20:10 viewfile
Deleted:
<
<
 Directory twiki/templates/ :


Line: 179 to 178
 -rw-rw-r-- 1 twiki twiki 955 Mar 8 11:41 oopsregpasswd.tmpl
Deleted:
<
<
 Directory twiki/data/ :


Line: 193 to 191
 -rw-r--r-- 1 nobody nobody 1516 Aug 20 17:56 log200008.txt
Deleted:
<
<
 Partial file list for twiki/data/Main :


Line: 213 to 210
 -r--r--r-- 1 nobody nobody 6523 Aug 18 18:08 WebHome.txt,v
Deleted:
<
<
 Directory twiki/pub/ :


Line: 232 to 228
 -rw-rw-r-- 1 twiki twiki 2877 Jun 7 1999 wikiHome.gif
Deleted:
<
<
 Partial file list for twiki/pub/icn/ :


Line: 246 to 241
 -rw-rw-r-- 1 twiki twiki 152 Mar 9 1999 doc.gif
Changed:
<
<
-- PeterThoeny - 16 Mar 2001
>
>
-- MikeMannix? - 07 Sep 2001
 
META TOPICMOVED by="MikeMannix" date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide"

Revision 2704 Sep 2001 - Main.MikeMannix

Line: 1 to 1
 

TWiki Installation Guide

Changed:
<
<
These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been documented well. More on that at http://TWiki.org/cgi-bin/view/Codev/TWikiOnWindows )
>
>
Clean install of the current public release (01-Sep-2001)

Overview

These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been well-documented. More on that at http://TWiki.org/cgi-bin/view/Codev/TWikiOnWindows.)

 Note: Below installation steps assume user nobody for all files manupulated by the cgi scripts (executed by the web server), and user twiki for all other files. You need to replace user nobody with an other user in case the web server executes the script with a different user ( default for Debian is www-data ). Also, you can substitute user twiki with your own user name.
Line: 54 to 58
 

Step 3: Enable Perl File Permissions

Changed:
<
<
  • Make sure Perl 5 and the Perl CGI library is installed on your system. Default location of Perl executable is /usr/bin/perl . In case Perl is installed in a different location, the first line of all perl scripts in the twiki/bin directory need to be changed (alternatively you can create a symbolic link from /usr/bin/perl ).
>
>
  • Make sure Perl 5 and the Perl CGI library are installed on your system. Default location of Perl executable is /usr/bin/perl. In case Perl is installed in a different location, the first line of all Perl scripts in the twiki/bin directory must be changed (alternatively you can create a symbolic link from /usr/bin/perl ).
 
    • IMPORTANT: On most ISP virtual domain accounts, Perl CGI scripts require a .cgi extension to run. Some systems need .pl, the regular Perl extension. Change all twiki/bin scripts appropriately if necssary.
  • To be able to edit the Perl scripts and .tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
  • The scripts execute as nobody. Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x (755).

Revision 2601 Sep 2001 - Main.MikeMannix

Line: 1 to 1
 

TWiki Installation Guide

Line: 7 to 7
 Note: Below installation steps assume user nobody for all files manupulated by the cgi scripts (executed by the web server), and user twiki for all other files. You need to replace user nobody with an other user in case the web server executes the script with a different user ( default for Debian is www-data ). Also, you can substitute user twiki with your own user name.
Changed:
<
<
Note: Below installation steps assume that you have control over the web server configuraton files. In case you don't (i.e. if you are installing it on a hosted server) follow the steps but use these directories instead:
>
>
Note: Below installation steps assume that you have control over the web server configuraton files. In case you don't - you may be installing on an ISP-hosted server - follow the steps but use these directories instead:
 
TWiki dir: What it is: Where to copy: Example:
twiki/bin CGI bin cgi-bin enabled dir /home/smith/public_html/cgi-bin/twiki
twiki/pub public files htdoc enabled dir /home/smith/public_html/pub
twiki/data topic data outside of htdoc tree (for security) /home/smith/twiki/data
twiki/templates web templates outside of htdoc tree (for security) /home/smith/twiki/templates
Added:
>
>
 Read http://TWiki.org/cgi-bin/view/Codev/SourceForgeHowTo in case you want to install TWiki on SourceForge.
Changed:
<
<

Standard Installation Steps

>
>

Standard Installation

Request and download the TWiki %VERSION% distribution in Unix ZIP format from http://TWiki.org/download.html.

Step 1: Create & Configure the Directories

 
Deleted:
<
<
 
  • Create directory /home/httpd/twiki and unzip the TWiki distribution into this directory.
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.
  • The twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki to file httpd.conf with normal access options (copy from /home/httpd/html ).
  • Now add ScriptAlias for /twiki/bin and Alias for /twiki to file httpd.conf .
    Note: The ScriptAlias must come before the Alias in Apache, otherwise it will fail to correctly set up /twiki/bin/ , due to the fact that it sees that as being just another subdirectory of the /twiki/ alias.
Changed:
<
<
  • Here are example httpd.conf entries:
>
>
Example httpd.conf entries:
 
 ScriptAlias /twiki/bin/ "/home/httpd/twiki/bin/"
 Alias /twiki/ "/home/httpd/twiki/"
 <Directory "/home/httpd/twiki/bin">

Line: 36 to 43
  AllowOverride None Allow from all </Directory>
Added:
>
>

Step 2: Check the Server Directory Settings

 
  • Restart Apache by /etc/rc.d/rc5.d/S85httpd restart .
  • Test if the twiki/bin directory is cgi-enabled:
    • Enter the URL of that directory into your browser ( http://your.domain.com/twiki/bin ). It is not set correctly as cgi-bin in case you get something like "Index of /twiki/bin" . It is OK if you get a message like "Forbidden. You don't have permission to access /twiki/bin/ on this server."
Changed:
<
<
    • Execute the testenv script from your browser ( http://your.domain.com/twiki/bin/testenv ). It shows a table with all CGI environment variables and tests the settings in your twiki/bin/wikicfg.pm configuration file.
  • Make sure PERL 5 and the PERL CGI library is installed on your system. Default location of PERL executable is /usr/bin/perl . In case PERL is installed in a different location, the first line of all perl scripts in the twiki/bin directory need to be changed (alternatively you can create a symbolic link from /usr/bin/perl ).
  • To be able to edit the perl scripts and .tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
  • The scripts execute as nobody . Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x .
  • Set the permission of all files below twiki/data so that they are writable by user nobody. A simple way is to chmod them to 666 ( -rw-rw-rw- ).
  • Set the permission of the twiki/data directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to 777 ( drwxrwxrwx ).
  • Set the permission of the twiki/pub directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to 777 ( drwxrwxrwx ).
  • Edit the file twiki/bin/wikicfg.pm and set the variables at the beginning of the file to your needs.
>
>
    • Execute the testenv script from your browser ( http://your.domain.com/twiki/bin/testenv ). It shows a table with all CGI environment variables and tests the settings in your twiki/bin/wikicfg.pm configuration file.

Step 3: Enable Perl File Permissions

  • Make sure Perl 5 and the Perl CGI library is installed on your system. Default location of Perl executable is /usr/bin/perl . In case Perl is installed in a different location, the first line of all perl scripts in the twiki/bin directory need to be changed (alternatively you can create a symbolic link from /usr/bin/perl ).
    • IMPORTANT: On most ISP virtual domain accounts, Perl CGI scripts require a .cgi extension to run. Some systems need .pl, the regular Perl extension. Change all twiki/bin scripts appropriately if necssary.
  • To be able to edit the Perl scripts and .tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
  • The scripts execute as nobody. Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x (755).
  • Set the permission of all files below twiki/data so that they are writable by user nobody. A simple way is to chmod them to -rw-rw-rw- (666).
  • Set the permission of the twiki/data directory and its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxrwx (777).
  • Set the permission of the twiki/pub directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxrwx (777).

Step 4: Set the Main Configuration File

  • Edit the file twiki/bin/wikicfg.pm and set the variables at the beginning of the file to your needs.
    • Set the file extension in the $scriptSuffix variable to cgi or pl if required.
 
  • Make sure RCS is installed. Set $rcsDir in twiki/bin/wikicfg.pm to mach the location of your RCS binaries.
Deleted:
<
<
  • Point your browser at http://your.domain.com/twiki/bin/view and start TWiki-ing away!
  • Using your browser, edit the TWikiPreferences topic in the TWiki.TWiki web to set the WIKIWEBMASTER email address, the WEBCOPYRIGHT message and other preferences.
  • Note in case the cgi scripts must have a file extension like .pl or .cgi:
    • Add the extension to all the scripts (except for the .pm ones) in twiki/bin
    • Edit wikicfg.pm and set the file extension in the $scriptSuffix variable.
    • If you use .htaccess, edit the file and add the file extension to edit, view, preview, etc.
 
  • Note in case the cgi scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (e.g. www-data ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user www-data (check the rcs man pages), or simply delete all the repository files. A simple way to switch the locker of the RCS files is to use sed:
    for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
Changed:
<
<
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directries to a place where they are not visible, and change the variables in twiki/bin/wikicfg.pm accordingly)
  • Enable email notification of topic changes, Notification of Changes has more. Using your browser, edit also the WebNotify topic in all webs and set the users you want to notify.
>
>
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directries to a place where they are not visible, and change the variables in twiki/bin/wikicfg.pm accordingly)
  • Enable email notification of topic changes, Notification of Changes has more.
 
Changed:
<
<

Adding Variables & Rendering Rules

  • Optional: You can add new rendering rules or new %VARIABLES%. To insure an easy upgrade of TWiki it is recommended to do this customization in twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .
>
>

Step 5: Finish Up from Your Browser

 
Changed:
<
<

Enabling Basic Authentication (.htaccess)

>
>
  • Point your Web browser at http://your.domain.com/twiki/bin/view and start TWiki-ing away!
  • Edit the TWikiPreferences topic in the TWiki:TWiki web to set the WIKIWEBMASTER email address, the WEBCOPYRIGHT message and other preferences.
  • If you use .htaccess, edit the file and add the file extension to edit, view, preview, etc.
  • Edit the WebNotify topic in all webs and set the users you want to notify.
 
Changed:
<
<
  • Optional: If you are on a non authenticated server (i.e. not using SSL) and you would like to authenticate users:
    • Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
      Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
      AuthUserFile /filepath/to/TWiki/data/.htpasswd
      ErrorDocument 401 /urlpath/to/TWiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
      • Note: The browser should ask for login name and password when you click on the Edit link. In case .htaccess does not have the desired effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
    • Copy the TWikiRegistrationPub? topic to TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the .txt and .txt,v files in the twiki/data/TWiki directory.
      • Note: You can customize the registration form if needed, like deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This will ensure that the fields are processed correctly.
    • A new line containing user name and encrypted password gets added to the data/.htpasswd file when a users registers. The file that comes with the TWiki installation contains a few user accounts of TWiki core team members (needed for testing). You can edit the file and delete those lines.
>
>
That's it for the standard virgin installation of TWiki. Read on to learn how to customize TWiki.
 
Changed:
<
<

Generating Site Usage Statistics

>
>

Extra Server-Level Options

 
Changed:
<
<
  • Optional: You can automatically generate usage statistics for all webs. To enable this:
    • Make sure variable $doLogTopicView, $doLogTopicSave and $doLogTopicUpload in wikicfg.pm are set. This will generate log entries in file twiki/data/log<date>.txt .
    • Topic WebStatistics must be present in all webs where you want to have statistics. You can use the topic in the Main web as a template.
    • Call the twiki/bin/statistics script from a cron job, once a day is recommended. This will update the WebStatistics topics in all webs.
    • Attention: The script must run as the same user as the CGI scripts are running, which is user nobody on most systems. Example crontab entry:
      0 0 * * * (cd /path/to/TWiki/bin; ./statistics >/dev/null 2>&1)
    • There is a workaround in case you can't run the script as user nobody : Run the utility twiki/bin/geturl in your cron job and specify the URL of the twiki/bin/statistics script as a parameter. Example:
      0 0 * * * (cd /path/to/TWiki/bin; ./geturl mydomain.com /urlpath/to/TWiki/bin/statistics >/dev/null 2>&1)
    • The twiki/bin/statistics script can also be executed as a CGI script, just enter the URL in your browser. Examples:
      • Update current month for all webs:
        http://mydomain.com/twiki/bin/statistics
      • Update current month for Main web only:
        http://mydomain.com/twiki/bin/statistics/Main
      • Update January 2000 for Main web:
        http://mydomain.com/twiki/bin/statistics/Main?logdate=200001
>
>
Complete a Standard Installation and your new TWiki site should be up and running. You can develop and manage most aspects of your site from the browser interface. Core set-up functions require direct access to the server file system, via Telnet or FTP. You can make server-level site changes during installation, or at any time afterwards.
 
Changed:
<
<

Creating a New Web

>
>

Creating a New Web

 
  • To create a new web:
    • Use a name for the web consisting of characters A..Z , a..z but not in WikiNotation.
Line: 108 to 105
 
    • In case you want usage statistics for this web: Copy file WebStatistics.txt from the twiki/data/Main directory to the new data directory. Edit topic WebStatistics in the new web and delete old usage entries.
    • Note that user home topics are only located in the Proyecto META.Main web, so don't try to move them or create them in other webs. From any web you can refer to users located in the Proyecto META.Main web like Main.UserName or %MAINWEB%.UserName.
Added:
>
>

Adding Variables & Rendering Rules

  • You can add new rendering rules or new %VARIABLES%. To insure an easy upgrade of TWiki it is recommended to do this customization in twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .

Enabling Basic Authentication (.htaccess)

  • If you are on a non authenticated server (i.e. not using SSL) and you would like to authenticate users:
    • Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
      Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
      AuthUserFile /filepath/to/TWiki/data/.htpasswd
      ErrorDocument 401 /urlpath/to/TWiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
      • Note: The browser should ask for login name and password when you click on the Edit link. In case .htaccess does not have the desired effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
    • Copy the TWikiRegistrationPub? topic to TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the .txt and .txt,v files in the twiki/data/TWiki directory.
      • Note: You can customize the registration form if needed, like deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This will ensure that the fields are processed correctly.
    • A new line containing user name and encrypted password gets added to the data/.htpasswd file when a users registers. The file that comes with the TWiki installation contains a few user accounts of TWiki core team members (needed for testing). You can edit the file and delete those lines.
 

TWiki File System Snapshot

Here are partial directory listings showing typical file permissions and ownership. This is provided for general debugging use only and isn't an exact representation of the current distribution. There is also a complete file listing by directory?, with individual file descriptions, for the current TWiki release.

Revision 2501 Sep 2001 - Main.MikeMannix

Line: 1 to 1
 

TWiki Installation Guide

Line: 230 to 230
 

-- PeterThoeny - 16 Mar 2001

Added:
>
>
META TOPICMOVED by="MikeMannix" date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide"

Revision 2431 Aug 2001 - Main.MikeMannix

Line: 1 to 1
 
Changed:
<
<

TWiki Installation Notes

>
>

TWiki Installation Guide

 These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been documented well. More on that at http://TWiki.org/cgi-bin/view/Codev/TWikiOnWindows )
Line: 59 to 59
 
Changed:
<
<

Add New Rendering Rules & Variables

>
>

Adding Variables & Rendering Rules

 
  • Optional: You can add new rendering rules or new %VARIABLES%. To insure an easy upgrade of TWiki it is recommended to do this customization in twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .
Changed:
<
<

Enable Basic Authentication (.htaccess)

>
>

Enabling Basic Authentication (.htaccess)

 
  • Optional: If you are on a non authenticated server (i.e. not using SSL) and you would like to authenticate users:
    • Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
Line: 75 to 75
 
      • Note: You can customize the registration form if needed, like deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This will ensure that the fields are processed correctly.
    • A new line containing user name and encrypted password gets added to the data/.htpasswd file when a users registers. The file that comes with the TWiki installation contains a few user accounts of TWiki core team members (needed for testing). You can edit the file and delete those lines.
Changed:
<
<

Generate Site Usage Statistics

>
>

Generating Site Usage Statistics

 
  • Optional: You can automatically generate usage statistics for all webs. To enable this:
    • Make sure variable $doLogTopicView, $doLogTopicSave and $doLogTopicUpload in wikicfg.pm are set. This will generate log entries in file twiki/data/log<date>.txt .
Line: 89 to 89
 
      • Update January 2000 for Main web:
        http://mydomain.com/twiki/bin/statistics/Main?logdate=200001

Changed:
<
<

Create a New Web

>
>

Creating a New Web

 
  • To create a new web:
    • Use a name for the web consisting of characters A..Z , a..z but not in WikiNotation.
Line: 108 to 108
 
    • In case you want usage statistics for this web: Copy file WebStatistics.txt from the twiki/data/Main directory to the new data directory. Edit topic WebStatistics in the new web and delete old usage entries.
    • Note that user home topics are only located in the Proyecto META.Main web, so don't try to move them or create them in other webs. From any web you can refer to users located in the Proyecto META.Main web like Main.UserName or %MAINWEB%.UserName.
Changed:
<
<

Contents of Directories

>
>

TWiki File System Snapshot

 
Changed:
<
<
Here are contents of directories showing file permissions. Please note that this is for debugging reasons only and does not exactly reflect the distribution:
>
>
Here are partial directory listings showing typical file permissions and ownership. This is provided for general debugging use only and isn't an exact representation of the current distribution. There is also a complete file listing by directory?, with individual file descriptions, for the current TWiki release.
 Directory twiki/bin :
Line: 134 to 134
 -rwxrwxr-x 1 twiki twiki 14543 Jul 20 18:46 upload -rwxrwxr-x 1 twiki twiki 4755 May 22 18:11 view -rwxrwxr-x 1 twiki twiki 1689 Jun 20 20:10 viewfile
Deleted:
<
<
-rw-rw-r-- 1 twiki twiki 34123 Nov 1 15:43 wiki.pm -rw-rw-r-- 1 twiki twiki 7234 Oct 23 00:34 wikiaccess.pm -rw-rw-r-- 1 twiki twiki 11719 Oct 28 21:58 wikicfg.pm -rw-rw-r-- 1 twiki twiki 6441 Nov 1 23:13 wikiprefs.pm -rw-rw-r-- 1 twiki twiki 13160 Oct 27 14:53 wikisearch.pm -rw-rw-r-- 1 twiki twiki 10540 Oct 28 21:43 wikistore.pm
 
Line: 166 to 160
 -rw-rw-r-- 1 twiki twiki 1423 May 29 01:23 oopslocked.tmpl -rw-rw-r-- 1 twiki twiki 1067 Mar 8 11:41 oopsregexist.tmpl -rw-rw-r-- 1 twiki twiki 955 Mar 8 11:41 oopsregpasswd.tmpl
Deleted:
<
<
-rw-rw-r-- 1 twiki twiki 966 Mar 8 11:41 oopsregrequ.tmpl -rw-rw-r-- 1 twiki twiki 1244 Apr 28 17:11 oopsregthanks.tmpl -rw-rw-r-- 1 twiki twiki 1003 Jul 22 12:48 oopsregwiki.tmpl -rw-rw-r-- 1 twiki twiki 1607 Mar 8 11:42 oopsrev.tmpl -rw-rw-r-- 1 twiki twiki 949 Mar 8 11:43 oopsupload.tmpl -rw-rw-r-- 1 twiki twiki 1735 Aug 15 18:14 preview.tmpl -rw-rw-r-- 1 twiki twiki 1682 Aug 15 18:14 rdiff.tmpl -rw-rw-r-- 1 twiki twiki 530 Jul 22 12:10 register.tmpl -rw-rw-r-- 1 twiki twiki 690 Apr 28 16:53 registernotify.tmpl -rw-rw-r-- 1 twiki twiki 1900 Aug 15 18:15 search.tmpl -rw-rw-r-- 1 twiki twiki 1785 Aug 15 18:15 searchbookview.tmpl -rw-rw-r-- 1 twiki twiki 1559 Aug 19 02:53 view.tmpl
 
Line: 195 to 177
 
Changed:
<
<
Part of directory twiki/data/Main :
>
>
Partial file list for twiki/data/Main :
 
drwxrwxrwx	2 nobody  nobody  4096 Aug 19 04:15 .

Line: 212 to 194
 -r--r--r-- 1 nobody nobody 284 Aug 19 03:06 WebChanges.txt,v -rw-r--r-- 1 nobody nobody 1853 Aug 18 18:08 WebHome.txt -r--r--r-- 1 nobody nobody 6523 Aug 18 18:08 WebHome.txt,v
Deleted:
<
<
-rw-r--r-- 1 nobody nobody 56 Aug 18 17:21 WebIndex.txt -r--r--r-- 1 nobody nobody 245 Aug 18 17:21 WebIndex.txt,v -rw-r--r-- 1 nobody nobody 495 Aug 18 17:40 WebNotify.txt -r--r--r-- 1 nobody nobody 1896 Aug 18 17:40 WebNotify.txt,v -rw-r--r-- 1 nobody nobody 1904 Aug 19 01:01 WebPreferences.txt -r--r--r-- 1 nobody nobody 3108 Aug 19 01:01 WebPreferences.txt,v -rw-r--r-- 1 nobody nobody 5553 Aug 19 02:30 WebSearch.txt -r--r--r-- 1 nobody nobody 8406 Aug 19 02:30 WebSearch.txt,v -rw-r--r-- 1 nobody nobody 729 Aug 18 17:41 WebStatistics.txt -r--r--r-- 1 nobody nobody 1129 Aug 18 17:41 WebStatistics.txt,v
 
Line: 244 to 216
 
Changed:
<
<
Directory twiki/pub/icn/ :
>
>
Partial file list for twiki/pub/icn/ :
 
drwxrwxr-x	2 twiki	twiki	4096 Jun 17 16:35 .

Line: 255 to 227
 -rw-rw-r-- 1 twiki twiki 141 Mar 25 1999 c.gif -rw-rw-r-- 1 twiki twiki 144 Mar 9 1999 dll.gif -rw-rw-r-- 1 twiki twiki 152 Mar 9 1999 doc.gif
Deleted:
<
<
-rw-rw-r-- 1 twiki twiki 130 Mar 9 1999 else.gif -rw-rw-r-- 1 twiki twiki 876 Mar 26 1999 exe.gif -rw-rw-r-- 1 twiki twiki 147 Mar 9 1999 fon.gif -rw-rw-r-- 1 twiki twiki 142 Mar 25 1999 h.gif -rw-rw-r-- 1 twiki twiki 156 Mar 9 1999 hlp.gif -rw-rw-r-- 1 twiki twiki 186 Mar 9 1999 html.gif -rw-rw-r-- 1 twiki twiki 144 Mar 25 1999 java.gif -rw-rw-r-- 1 twiki twiki 148 Mar 9 1999 mov.gif -rw-rw-r-- 1 twiki twiki 150 Mar 9 1999 pdf.gif -rw-rw-r-- 1 twiki twiki 146 Mar 25 1999 pl.gif -rw-rw-r-- 1 twiki twiki 150 Mar 9 1999 ppt.gif -rw-rw-r-- 1 twiki twiki 148 Mar 25 1999 ps.gif -rw-rw-r-- 1 twiki twiki 148 Mar 25 1999 py.gif -rw-rw-r-- 1 twiki twiki 130 Mar 9 1999 ram.gif -rw-rw-r-- 1 twiki twiki 154 Mar 9 1999 reg.gif -rw-rw-r-- 1 twiki twiki 147 Mar 25 1999 sh.gif -rw-rw-r-- 1 twiki twiki 155 Mar 9 1999 sniff.gif -rw-rw-r-- 1 twiki twiki 149 Mar 9 1999 ttf.gif -rw-rw-r-- 1 twiki twiki 134 Mar 9 1999 txt.gif -rw-rw-r-- 1 twiki twiki 154 Mar 9 1999 wav.gif -rw-rw-r-- 1 twiki twiki 152 Mar 9 1999 wri.gif -rw-rw-r-- 1 twiki twiki 152 Mar 9 1999 xls.gif -rw-rw-r-- 1 twiki twiki 144 Mar 9 1999 zip.gif
 

-- PeterThoeny - 16 Mar 2001

Revision 2330 Aug 2001 - Main.MikeMannix

Line: 1 to 1
Added:
>
>
 

TWiki Installation Notes

These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been documented well. More on that at http://TWiki.org/cgi-bin/view/Codev/TWikiOnWindows )

Line: 13 to 15
 
twiki/templates web templates outside of htdoc tree (for security) /home/smith/twiki/templates
Read http://TWiki.org/cgi-bin/view/Codev/SourceForgeHowTo in case you want to install TWiki on SourceForge.
Changed:
<
<

Installation steps

>
>

Standard Installation Steps

 
  • Request the TWiki distribution (in Unix ZIP format) from http://TWiki.org/download.html .
  • Create directory /home/httpd/twiki and unzip the TWiki distribution into this directory.
Line: 57 to 59
 
Added:
>
>

Add New Rendering Rules & Variables

 
  • Optional: You can add new rendering rules or new %VARIABLES%. To insure an easy upgrade of TWiki it is recommended to do this customization in twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .
Added:
>
>

Enable Basic Authentication (.htaccess)

 
  • Optional: If you are on a non authenticated server (i.e. not using SSL) and you would like to authenticate users:
    • Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
      Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
Line: 69 to 75
 
      • Note: You can customize the registration form if needed, like deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This will ensure that the fields are processed correctly.
    • A new line containing user name and encrypted password gets added to the data/.htpasswd file when a users registers. The file that comes with the TWiki installation contains a few user accounts of TWiki core team members (needed for testing). You can edit the file and delete those lines.
Added:
>
>

Generate Site Usage Statistics

 
  • Optional: You can automatically generate usage statistics for all webs. To enable this:
    • Make sure variable $doLogTopicView, $doLogTopicSave and $doLogTopicUpload in wikicfg.pm are set. This will generate log entries in file twiki/data/log<date>.txt .
    • Topic WebStatistics must be present in all webs where you want to have statistics. You can use the topic in the Main web as a template.
Line: 80 to 88
 
      • Update current month for Main web only:
        http://mydomain.com/twiki/bin/statistics/Main
      • Update January 2000 for Main web:
        http://mydomain.com/twiki/bin/statistics/Main?logdate=200001
Added:
>
>

Create a New Web

 
  • To create a new web:
    • Use a name for the web consisting of characters A..Z , a..z but not in WikiNotation.
    • Create a new template directory under twiki/templates .

Revision 2230 Aug 2001 - Main.JohnTalintyre

Line: 1 to 1
 

TWiki Installation Notes

These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been documented well. More on that at http://TWiki.org/cgi-bin/view/Codev/TWikiOnWindows )

Line: 93 to 93
 
      • Customize the WEBTOPICLIST variable to contain the web specific links you prefer.
      • Optional: Set the WEBCOPYRIGHT variable to have a web-specific copyright text (at the bottom of each topic).
    • If needed, create customized templates in the new templates directory. (Non existing templates are inherited from twiki/templates )
Changed:
<
<
    • If you want to use a category table, copy the three files twikicatitems.tmpl , twikicatedit.tmpl and twikicatview.tmpl from the twiki/templates/Know directory to the new templates directory, and customize it. More on that in TWiki Category Table.
>
>
    • If you want to use form templates - see FormTemplateSystem?
 
    • In case you want usage statistics for this web: Copy file WebStatistics.txt from the twiki/data/Main directory to the new data directory. Edit topic WebStatistics in the new web and delete old usage entries.
    • Note that user home topics are only located in the Proyecto META.Main web, so don't try to move them or create them in other webs. From any web you can refer to users located in the Proyecto META.Main web like Main.UserName or %MAINWEB%.UserName.
Line: 170 to 170
 
Deleted:
<
<
Directory twiki/templates/Know (has a TWiki Category Table) :

drwxrwxr-x	2 twiki	twiki	4096 Jun 17 16:35 .
drwxrwxr-x	4 twiki	twiki	4096 Aug  3 01:17 ..
-rw-rw-r--	1 twiki	twiki	 446 Jun  7  1999 notedited.tmpl
-rw-rw-r--	1 twiki	twiki	 206 Jun  7  1999 twikicatedit.tmpl
-rw-rw-r--	1 twiki	twiki	1068 Aug 18 18:26 twikicatitems.tmpl
-rw-rw-r--	1 twiki	twiki	 231 Jun  7  1999 twikicatview.tmpl
 Directory twiki/data/ :


Revision 2112 Aug 2001 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Notes

These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been documented well. More on that at http://TWiki.org/cgi-bin/view/Codev/TWikiOnWindows )

Line: 63 to 63
 
    • Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
      Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
      AuthUserFile /filepath/to/TWiki/data/.htpasswd
Changed:
<
<
ErrorDocument 401 /urlpath/to/TWiki/bin/view/TWiki/TWikiRegistration
>
>
ErrorDocument 401 /urlpath/to/TWiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
 
      • Note: The browser should ask for login name and password when you click on the Edit link. In case .htaccess does not have the desired effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
    • Copy the TWikiRegistrationPub? topic to TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the .txt and .txt,v files in the twiki/data/TWiki directory.
      • Note: You can customize the registration form if needed, like deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This will ensure that the fields are processed correctly.
Added:
>
>
    • A new line containing user name and encrypted password gets added to the data/.htpasswd file when a users registers. The file that comes with the TWiki installation contains a few user accounts of TWiki core team members (needed for testing). You can edit the file and delete those lines.
 
  • Optional: You can automatically generate usage statistics for all webs. To enable this:
    • Make sure variable $doLogTopicView, $doLogTopicSave and $doLogTopicUpload in wikicfg.pm are set. This will generate log entries in file twiki/data/log<date>.txt .

Revision 2011 Jul 2001 - Main.PeterThoeny

Line: 1 to 1
 

TWiki Installation Notes

These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been documented well. More on that at http://TWiki.org/cgi-bin/view/Codev/TWikiOnWindows )

Line: 59 to 60
 
  • Optional: You can add new rendering rules or new %VARIABLES%. To insure an easy upgrade of TWiki it is recommended to do this customization in twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .

  • Optional: If you are on a non authenticated server (i.e. not using SSL) and you would like to authenticate users:
Changed:
<
<
    • Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details consult the HTTP server documentation (for Apache server: [1], [2]). Note: In case .htaccess does not have any effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
    • Copy the TWikiRegistrationPub? topic to TWikiRegistration. You can customize the topic if needed. Note: You can delete or add new input tags to the registration form. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This will ensure that the fields are processed correctly.
>
>
    • Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
      Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
      AuthUserFile /filepath/to/TWiki/data/.htpasswd
      ErrorDocument 401 /urlpath/to/TWiki/bin/view/TWiki/TWikiRegistration
      • Note: The browser should ask for login name and password when you click on the Edit link. In case .htaccess does not have the desired effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
    • Copy the TWikiRegistrationPub? topic to TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the .txt and .txt,v files in the twiki/data/TWiki directory.
      • Note: You can customize the registration form if needed, like deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This will ensure that the fields are processed correctly.
 
  • Optional: You can automatically generate usage statistics for all webs. To enable this:
    • Make sure variable $doLogTopicView, $doLogTopicSave and $doLogTopicUpload in wikicfg.pm are set. This will generate log entries in file twiki/data/log<date>.txt .

Revision 1916 Mar 2001 - Main.PeterThoeny

Line: 1 to 1
Added:
>
>

TWiki Installation Notes

 These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been documented well. More on that at http://TWiki.org/cgi-bin/view/Codev/TWikiOnWindows )

Note: Below installation steps assume user nobody for all files manupulated by the cgi scripts (executed by the web server), and user twiki for all other files. You need to replace user nobody with an other user in case the web server executes the script with a different user ( default for Debian is www-data ). Also, you can substitute user twiki with your own user name.

Line: 10 to 12
 
twiki/templates web templates outside of htdoc tree (for security) /home/smith/twiki/templates
Read http://TWiki.org/cgi-bin/view/Codev/SourceForgeHowTo in case you want to install TWiki on SourceForge.
Changed:
<
<
Installation steps:
>
>

Installation steps

 
  • Request the TWiki distribution (in Unix ZIP format) from http://TWiki.org/download.html .
  • Create directory /home/httpd/twiki and unzip the TWiki distribution into this directory.
Line: 51 to 53
 
    • If you use .htaccess, edit the file and add the file extension to edit, view, preview, etc.
  • Note in case the cgi scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (e.g. www-data ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user www-data (check the rcs man pages), or simply delete all the repository files. A simple way to switch the locker of the RCS files is to use sed:
    for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directries to a place where they are not visible, and change the variables in twiki/bin/wikicfg.pm accordingly)
Changed:
<
<
>
>
 
  • Optional: You can add new rendering rules or new %VARIABLES%. To insure an easy upgrade of TWiki it is recommended to do this customization in twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .
Line: 88 to 90
 
    • In case you want usage statistics for this web: Copy file WebStatistics.txt from the twiki/data/Main directory to the new data directory. Edit topic WebStatistics in the new web and delete old usage entries.
    • Note that user home topics are only located in the Proyecto META.Main web, so don't try to move them or create them in other webs. From any web you can refer to users located in the Proyecto META.Main web like Main.UserName or %MAINWEB%.UserName.
Added:
>
>

Contents of Directories

 Here are contents of directories showing file permissions. Please note that this is for debugging reasons only and does not exactly reflect the distribution:

Directory twiki/bin :

Line: 270 to 274
 -rw-rw-r-- 1 twiki twiki 144 Mar 9 1999 zip.gif
Changed:
<
<
-- PeterThoeny? - 29 Dec 2000
>
>
-- PeterThoeny - 16 Mar 2001

Revision 1826 Feb 2001 - Main.PeterThoeny

Line: 20 to 20
 
Note: The ScriptAlias must come before the Alias in Apache, otherwise it will fail to correctly set up /twiki/bin/ , due to the fact that it sees that as being just another subdirectory of the /twiki/ alias.
  • Here are example httpd.conf entries:
     ScriptAlias /twiki/bin/ "/home/httpd/twiki/bin/"
    
    
Changed:
<
<
Alias /twiki/ "/home/httpd/twiki"
>
>
Alias /twiki/ "/home/httpd/twiki/"
  <Directory "/home/httpd/twiki/bin"> Options +ExecCGI SetHandler cgi-script

Revision 1730 Dec 2000 - Main.PeterThoeny

Line: 86 to 86
 
    • If needed, create customized templates in the new templates directory. (Non existing templates are inherited from twiki/templates )
    • If you want to use a category table, copy the three files twikicatitems.tmpl , twikicatedit.tmpl and twikicatview.tmpl from the twiki/templates/Know directory to the new templates directory, and customize it. More on that in TWiki Category Table.
    • In case you want usage statistics for this web: Copy file WebStatistics.txt from the twiki/data/Main directory to the new data directory. Edit topic WebStatistics in the new web and delete old usage entries.
Changed:
<
<
>
>
    • Note that user home topics are only located in the Proyecto META.Main web, so don't try to move them or create them in other webs. From any web you can refer to users located in the Proyecto META.Main web like Main.UserName or %MAINWEB%.UserName.
 Here are contents of directories showing file permissions. Please note that this is for debugging reasons only and does not exactly reflect the distribution:
Line: 270 to 270
 -rw-rw-r-- 1 twiki twiki 144 Mar 9 1999 zip.gif
Changed:
<
<
-- PeterThoeny? - 24 Nov 2000
>
>
-- PeterThoeny? - 29 Dec 2000

Revision 1611 Dec 2000 - Main.PeterThoeny

Line: 38 to 38
 
  • Make sure PERL 5 and the PERL CGI library is installed on your system. Default location of PERL executable is /usr/bin/perl . In case PERL is installed in a different location, the first line of all perl scripts in the twiki/bin directory need to be changed (alternatively you can create a symbolic link from /usr/bin/perl ).
  • To be able to edit the perl scripts and .tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
  • The scripts execute as nobody . Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x .
Changed:
<
<
  • Set the file permission of all files below twiki/data to 666 ( -rw-rw-rw- ).
  • Set the file permission of the twiki/data directory and all its subdirectories to 777 ( drwxrwxrwx ).
  • Set the file permission of the twiki/pub directory to 777 ( drwxrwxrwx ).
>
>
  • Set the permission of all files below twiki/data so that they are writable by user nobody. A simple way is to chmod them to 666 ( -rw-rw-rw- ).
  • Set the permission of the twiki/data directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to 777 ( drwxrwxrwx ).
  • Set the permission of the twiki/pub directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to 777 ( drwxrwxrwx ).
 
  • Edit the file twiki/bin/wikicfg.pm and set the variables at the beginning of the file to your needs.
  • Make sure RCS is installed. Set $rcsDir in twiki/bin/wikicfg.pm to mach the location of your RCS binaries.
  • Point your browser at http://your.domain.com/twiki/bin/view and start TWiki-ing away!

Revision 1529 Nov 2000 - Main.PeterThoeny

Line: 44 to 44
 
  • Edit the file twiki/bin/wikicfg.pm and set the variables at the beginning of the file to your needs.
  • Make sure RCS is installed. Set $rcsDir in twiki/bin/wikicfg.pm to mach the location of your RCS binaries.
  • Point your browser at http://your.domain.com/twiki/bin/view and start TWiki-ing away!
Added:
>
>
  • Using your browser, edit the TWikiPreferences topic in the TWiki.TWiki web to set the WIKIWEBMASTER email address, the WEBCOPYRIGHT message and other preferences.
 
  • Note in case the cgi scripts must have a file extension like .pl or .cgi:
    • Add the extension to all the scripts (except for the .pm ones) in twiki/bin
    • Edit wikicfg.pm and set the file extension in the $scriptSuffix variable.
    • If you use .htaccess, edit the file and add the file extension to edit, view, preview, etc.
Changed:
<
<
  • Note in case the cgi scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (e.g. www-data ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user www-data (check the rcs man pages), or simply delete all the repository files. A simple way to switch the locker of the RCS files is to use sed:
    for f in *,v; do sed 's/nobody/www-data/' $f > x; mv x $f; done
>
>
  • Note in case the cgi scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (e.g. www-data ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user www-data (check the rcs man pages), or simply delete all the repository files. A simple way to switch the locker of the RCS files is to use sed:
    for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
 
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directries to a place where they are not visible, and change the variables in twiki/bin/wikicfg.pm accordingly)
Changed:
<
<
>
>
  • Enable email notification of topic changes, Notification of Changes has more. Using your browser, edit also the WebNotify topic in all webs and set the users you want to notify.
 

  • Optional: You can add new rendering rules or new %VARIABLES%. To insure an easy upgrade of TWiki it is recommended to do this customization in twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .

Revision 1425 Nov 2000 - Main.PeterThoeny

Line: 19 to 19
 
  • Now add ScriptAlias for /twiki/bin and Alias for /twiki to file httpd.conf .
    Note: The ScriptAlias must come before the Alias in Apache, otherwise it will fail to correctly set up /twiki/bin/ , due to the fact that it sees that as being just another subdirectory of the /twiki/ alias.
  • Here are example httpd.conf entries:
Changed:
<
<
 ScriptAlias /twiki/bin/ "/home/httpd/twiki/bin/"
 Alias /twiki/ "/home/httpd/twiki/pub/"

>
>
 ScriptAlias /twiki/bin/ "/home/httpd/twiki/bin/"
 Alias /twiki/ "/home/httpd/twiki"

  <Directory "/home/httpd/twiki/bin"> Options +ExecCGI
Changed:
<
<
SetHandler? cgi-script
>
>
SetHandler cgi-script
  Allow from all </Directory> <Directory "/home/httpd/twiki/pub">
Changed:
<
<
Options FollowSymLinks? +Includes AllowOverride? None
>
>
Options FollowSymLinks +Includes AllowOverride None
  Allow from all </Directory>
  • Restart Apache by /etc/rc.d/rc5.d/S85httpd restart .
Line: 269 to 269
 -rw-rw-r-- 1 twiki twiki 144 Mar 9 1999 zip.gif
Changed:
<
<
-- PeterThoeny? - 13 Nov 2000
>
>
-- PeterThoeny? - 24 Nov 2000

Revision 1314 Nov 2000 - Main.PeterThoeny

Line: 1 to 1
Changed:
<
<
These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been documented well. More on that at http://TWiki.org/Codev/TWikiOnWindows )
>
>
These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been documented well. More on that at http://TWiki.org/cgi-bin/view/Codev/TWikiOnWindows )
 Note: Below installation steps assume user nobody for all files manupulated by the cgi scripts (executed by the web server), and user twiki for all other files. You need to replace user nobody with an other user in case the web server executes the script with a different user ( default for Debian is www-data ). Also, you can substitute user twiki with your own user name.
Line: 8 to 8
 
twiki/pub public files htdoc enabled dir /home/smith/public_html/pub
twiki/data topic data outside of htdoc tree (for security) /home/smith/twiki/data
twiki/templates web templates outside of htdoc tree (for security) /home/smith/twiki/templates
Changed:
<
<
Read http://TWiki.org/Codev/SourceForgeHowTo in case you wnat to install TWiki on SourceForge.
>
>
Read http://TWiki.org/cgi-bin/view/Codev/SourceForgeHowTo in case you want to install TWiki on SourceForge.
 Installation steps:
Line: 34 to 34
 
  • Restart Apache by /etc/rc.d/rc5.d/S85httpd restart .
  • Test if the twiki/bin directory is cgi-enabled:
    • Enter the URL of that directory into your browser ( http://your.domain.com/twiki/bin ). It is not set correctly as cgi-bin in case you get something like "Index of /twiki/bin" . It is OK if you get a message like "Forbidden. You don't have permission to access /twiki/bin/ on this server."
Changed:
<
<
    • Execute the testenv script from your browser ( http://your.domain.com/twiki/bin/testenv ). It should show a table wit all CGI environment variables.
>
>
    • Execute the testenv script from your browser ( http://your.domain.com/twiki/bin/testenv ). It shows a table with all CGI environment variables and tests the settings in your twiki/bin/wikicfg.pm configuration file.
 
  • Make sure PERL 5 and the PERL CGI library is installed on your system. Default location of PERL executable is /usr/bin/perl . In case PERL is installed in a different location, the first line of all perl scripts in the twiki/bin directory need to be changed (alternatively you can create a symbolic link from /usr/bin/perl ).
  • To be able to edit the perl scripts and .tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
  • The scripts execute as nobody . Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x .
Line: 269 to 269
 -rw-rw-r-- 1 twiki twiki 144 Mar 9 1999 zip.gif
Changed:
<
<
-- PeterThoeny? - 02 Nov 2000
>
>
-- PeterThoeny? - 13 Nov 2000

Revision 1212 Nov 2000 - Main.PeterThoeny

Line: 1 to 1
 These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been documented well. More on that at http://TWiki.org/Codev/TWikiOnWindows )
Changed:
<
<
Note: These installation notes assume user nobody for all files manupulated by the cgi scripts (executed by the web server), and user twiki for all other files. You need to replace user nobody with an other user in case the web server executes the script with a different user ( default for Debian is www-data ). Also, you can substitute user twiki with your own user name.
>
>
Note: Below installation steps assume user nobody for all files manupulated by the cgi scripts (executed by the web server), and user twiki for all other files. You need to replace user nobody with an other user in case the web server executes the script with a different user ( default for Debian is www-data ). Also, you can substitute user twiki with your own user name.

Note: Below installation steps assume that you have control over the web server configuraton files. In case you don't (i.e. if you are installing it on a hosted server) follow the steps but use these directories instead:

TWiki dir: What it is: Where to copy: Example:
twiki/bin CGI bin cgi-bin enabled dir /home/smith/public_html/cgi-bin/twiki
twiki/pub public files htdoc enabled dir /home/smith/public_html/pub
twiki/data topic data outside of htdoc tree (for security) /home/smith/twiki/data
twiki/templates web templates outside of htdoc tree (for security) /home/smith/twiki/templates
Read http://TWiki.org/Codev/SourceForgeHowTo in case you wnat to install TWiki on SourceForge.

Installation steps:

 
  • Request the TWiki distribution (in Unix ZIP format) from http://TWiki.org/download.html .
  • Create directory /home/httpd/twiki and unzip the TWiki distribution into this directory.
Line: 34 to 44
 
  • Edit the file twiki/bin/wikicfg.pm and set the variables at the beginning of the file to your needs.
  • Make sure RCS is installed. Set $rcsDir in twiki/bin/wikicfg.pm to mach the location of your RCS binaries.
  • Point your browser at http://your.domain.com/twiki/bin/view and start TWiki-ing away!
Added:
>
>
  • Note in case the cgi scripts must have a file extension like .pl or .cgi:
    • Add the extension to all the scripts (except for the .pm ones) in twiki/bin
    • Edit wikicfg.pm and set the file extension in the $scriptSuffix variable.
    • If you use .htaccess, edit the file and add the file extension to edit, view, preview, etc.
 
  • Note in case the cgi scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (e.g. www-data ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user www-data (check the rcs man pages), or simply delete all the repository files. A simple way to switch the locker of the RCS files is to use sed:
    for f in *,v; do sed 's/nobody/www-data/' $f > x; mv x $f; done
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directries to a place where they are not visible, and change the variables in twiki/bin/wikicfg.pm accordingly)
  • Enable email notification of topic changes, Notification of Changes has more.

Revision 1109 Nov 2000 - Main.PeterThoeny

Line: 1 to 1
Changed:
<
<
These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been documented well. More on that at http://twiki.sourceforge.net/cgi-bin/view/Codev/TWikiOnWindows )
>
>
These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been documented well. More on that at http://TWiki.org/Codev/TWikiOnWindows )
 Note: These installation notes assume user nobody for all files manupulated by the cgi scripts (executed by the web server), and user twiki for all other files. You need to replace user nobody with an other user in case the web server executes the script with a different user ( default for Debian is www-data ). Also, you can substitute user twiki with your own user name.
Changed:
<
<
>
>
 
  • Create directory /home/httpd/twiki and unzip the TWiki distribution into this directory.
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.
  • The twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki to file httpd.conf with normal access options (copy from /home/httpd/html ).
Line: 37 to 37
 
  • Note in case the cgi scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (e.g. www-data ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user www-data (check the rcs man pages), or simply delete all the repository files. A simple way to switch the locker of the RCS files is to use sed:
    for f in *,v; do sed 's/nobody/www-data/' $f > x; mv x $f; done
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directries to a place where they are not visible, and change the variables in twiki/bin/wikicfg.pm accordingly)
  • Enable email notification of topic changes, Notification of Changes has more.
Changed:
<
<
>
>
 
  • Optional: You can add new rendering rules or new %VARIABLES%. To insure an easy upgrade of TWiki it is recommended to do this customization in twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .

Revision 1002 Nov 2000 - Main.PeterThoeny

Line: 36 to 36
 
  • Point your browser at http://your.domain.com/twiki/bin/view and start TWiki-ing away!
  • Note in case the cgi scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (e.g. www-data ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user www-data (check the rcs man pages), or simply delete all the repository files. A simple way to switch the locker of the RCS files is to use sed:
    for f in *,v; do sed 's/nobody/www-data/' $f > x; mv x $f; done
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directries to a place where they are not visible, and change the variables in twiki/bin/wikicfg.pm accordingly)
Changed:
<
<
  • Enable email notification of topic changes, (4) has more.
>
>
 

  • Optional: You can add new rendering rules or new %VARIABLES%. To insure an easy upgrade of TWiki it is recommended to do this customization in twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .
Line: 69 to 69
 
      • Customize the WEBTOPICLIST variable to contain the web specific links you prefer.
      • Optional: Set the WEBCOPYRIGHT variable to have a web-specific copyright text (at the bottom of each topic).
    • If needed, create customized templates in the new templates directory. (Non existing templates are inherited from twiki/templates )
Changed:
<
<
    • If you want to use a category table, copy the three files twikicatitems.tmpl , twikicatedit.tmpl and twikicatview.tmpl from the twiki/templates/Know directory to the new templates directory, and customize it. More on that in (5) TWiki Category Table.
>
>
    • If you want to use a category table, copy the three files twikicatitems.tmpl , twikicatedit.tmpl and twikicatview.tmpl from the twiki/templates/Know directory to the new templates directory, and customize it. More on that in TWiki Category Table.
 
    • In case you want usage statistics for this web: Copy file WebStatistics.txt from the twiki/data/Main directory to the new data directory. Edit topic WebStatistics in the new web and delete old usage entries.
Line: 97 to 97
 -rwxrwxr-x 1 twiki twiki 14543 Jul 20 18:46 upload -rwxrwxr-x 1 twiki twiki 4755 May 22 18:11 view -rwxrwxr-x 1 twiki twiki 1689 Jun 20 20:10 viewfile
Changed:
<
<
-rw-rw-r-- 1 twiki twiki 40103 Aug 18 13:00 wiki.pm -rw-rw-r-- 1 twiki twiki 11521 Aug 19 18:38 wikicfg.pm -rw-rw-r-- 1 twiki twiki 13969 Aug 19 00:30 wikisearch.pm
>
>
-rw-rw-r-- 1 twiki twiki 34123 Nov 1 15:43 wiki.pm -rw-rw-r-- 1 twiki twiki 7234 Oct 23 00:34 wikiaccess.pm -rw-rw-r-- 1 twiki twiki 11719 Oct 28 21:58 wikicfg.pm -rw-rw-r-- 1 twiki twiki 6441 Nov 1 23:13 wikiprefs.pm -rw-rw-r-- 1 twiki twiki 13160 Oct 27 14:53 wikisearch.pm -rw-rw-r-- 1 twiki twiki 10540 Oct 28 21:43 wikistore.pm
 
Line: 120 to 123
 -rw-rw-r-- 1 twiki twiki 907 Jul 20 16:01 notwiki.tmpl -rw-rw-r-- 1 twiki twiki 341 Mar 8 11:39 noweb.tmpl -rw-rw-r-- 1 twiki twiki 1000 Mar 8 11:40 oops.tmpl
Added:
>
>
-rw-rw-r-- 1 twiki twiki 1043 Oct 23 19:17 oopsaccesschange.tmpl -rw-rw-r-- 1 twiki twiki 1036 Oct 23 19:17 oopsaccessview.tmpl
 -rw-rw-r-- 1 twiki twiki 914 Mar 8 11:40 oopsdel.tmpl -rw-rw-r-- 1 twiki twiki 1423 May 29 01:23 oopslocked.tmpl -rw-rw-r-- 1 twiki twiki 1067 Mar 8 11:41 oopsregexist.tmpl
Line: 250 to 255
 -rw-rw-r-- 1 twiki twiki 144 Mar 9 1999 zip.gif
Changed:
<
<
-- PeterThoeny? - 23 Sep 2000
>
>
-- PeterThoeny? - 02 Nov 2000

Revision 928 Oct 2000 - Main.PeterThoeny

Line: 41 to 41
 
  • Optional: You can add new rendering rules or new %VARIABLES%. To insure an easy upgrade of TWiki it is recommended to do this customization in twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .
Changed:
<
<
  • Optional: If you are on a public server and you would like to authenticate users:
    • Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details consult the HTTP server documentation (for Apache server: [1], [2], [3]). Note: In case .htaccess does not have any effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
>
>
  • Optional: If you are on a non authenticated server (i.e. not using SSL) and you would like to authenticate users:
    • Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details consult the HTTP server documentation (for Apache server: [1], [2]). Note: In case .htaccess does not have any effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
 
    • Copy the TWikiRegistrationPub? topic to TWikiRegistration. You can customize the topic if needed. Note: You can delete or add new input tags to the registration form. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This will ensure that the fields are processed correctly.

  • Optional: You can automatically generate usage statistics for all webs. To enable this:

Revision 823 Sep 2000 - Main.PeterThoeny

Line: 34 to 34
 
  • Edit the file twiki/bin/wikicfg.pm and set the variables at the beginning of the file to your needs.
  • Make sure RCS is installed. Set $rcsDir in twiki/bin/wikicfg.pm to mach the location of your RCS binaries.
  • Point your browser at http://your.domain.com/twiki/bin/view and start TWiki-ing away!
Changed:
<
<
  • Note in case cgi user is not nobody : The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (e.g. www-data ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user www-data (check the rcs man pages), or simply delete all the repository files.
>
>
  • Note in case the cgi scripts are not running as user nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (e.g. www-data ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user www-data (check the rcs man pages), or simply delete all the repository files. A simple way to switch the locker of the RCS files is to use sed:
    for f in *,v; do sed 's/nobody/www-data/' $f > x; mv x $f; done
 
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directries to a place where they are not visible, and change the variables in twiki/bin/wikicfg.pm accordingly)
  • Enable email notification of topic changes, (4) has more.
  • Add the PoweredByTWikiLogo if TWiki is installed on a public web server.
Line: 250 to 250
 -rw-rw-r-- 1 twiki twiki 144 Mar 9 1999 zip.gif
Changed:
<
<
-- PeterThoeny? - 20 Aug 2000
>
>
-- PeterThoeny? - 23 Sep 2000

Revision 721 Aug 2000 - Main.PeterThoeny

Line: 1 to 1
Changed:
<
<
These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well.
>
>
These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been documented well. More on that at http://twiki.sourceforge.net/cgi-bin/view/Codev/TWikiOnWindows )
 Note: These installation notes assume user nobody for all files manupulated by the cgi scripts (executed by the web server), and user twiki for all other files. You need to replace user nobody with an other user in case the web server executes the script with a different user ( default for Debian is www-data ). Also, you can substitute user twiki with your own user name.

Changed:
<
<
  • Create directory /home/httpd/twiki and unzip the TWiki distribution to this directory.
>
>
  • Create directory /home/httpd/twiki and unzip the TWiki distribution into this directory.
 
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.
  • The twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki to file httpd.conf with normal access options (copy from /home/httpd/html ).
  • Now add ScriptAlias for /twiki/bin and Alias for /twiki to file httpd.conf .
Changed:
<
<

Note: The ScriptAlias must come before the Alias in Apache, otherwise it will fail to correctly set up /twiki/bin/ , due to the fact that it sees that as being just another subdirectory of the /twiki/ alias. (MichaelBrooks? 30 Jun 2000)
>
>

Note: The ScriptAlias must come before the Alias in Apache, otherwise it will fail to correctly set up /twiki/bin/ , due to the fact that it sees that as being just another subdirectory of the /twiki/ alias.
 
  • Here are example httpd.conf entries:
     ScriptAlias /twiki/bin/ "/home/httpd/twiki/bin/"
     Alias /twiki/ "/home/httpd/twiki/pub/"
    
    
Line: 24 to 24
 
  • Restart Apache by /etc/rc.d/rc5.d/S85httpd restart .
  • Test if the twiki/bin directory is cgi-enabled:
    • Enter the URL of that directory into your browser ( http://your.domain.com/twiki/bin ). It is not set correctly as cgi-bin in case you get something like "Index of /twiki/bin" . It is OK if you get a message like "Forbidden. You don't have permission to access /twiki/bin/ on this server."
Changed:
<
<
    • Execute the testenv script from your browser ( http://your.domain.com/twiki/bin/testenv ). It should show a table of all CGI environment variables.
  • Make sure PERL and the PERL CGI library is installed on your system. Default location of PERL executable is /usr/bin/perl . In case PERL is installed in a different location, the first line of all perl scripts in the twiki/bin directory need to be changed (alternatively you can create a symbolic link from /usr/bin/perl ).
>
>
    • Execute the testenv script from your browser ( http://your.domain.com/twiki/bin/testenv ). It should show a table wit all CGI environment variables.
  • Make sure PERL 5 and the PERL CGI library is installed on your system. Default location of PERL executable is /usr/bin/perl . In case PERL is installed in a different location, the first line of all perl scripts in the twiki/bin directory need to be changed (alternatively you can create a symbolic link from /usr/bin/perl ).
 
  • To be able to edit the perl scripts and .tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
Changed:
<
<
  • The scripts execute as nobody . Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rw-r-xr-x .
>
>
  • The scripts execute as nobody . Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x .
 
  • Set the file permission of all files below twiki/data to 666 ( -rw-rw-rw- ).
  • Set the file permission of the twiki/data directory and all its subdirectories to 777 ( drwxrwxrwx ).
  • Set the file permission of the twiki/pub directory to 777 ( drwxrwxrwx ).
  • Edit the file twiki/bin/wikicfg.pm and set the variables at the beginning of the file to your needs.
Changed:
<
<
  • Make sure RCS is installed. In case RCS is not in the path environment variable, add it to path . Alternatively, add the full path name to the rcs, ci, co, rlog, rcsdiff commands in the variables of twiki/bin/wikicfg.pm .
  • Point your browser at http://your.domain.com/twiki/bin/view and start wiki-ing away!
>
>
  • Make sure RCS is installed. Set $rcsDir in twiki/bin/wikicfg.pm to mach the location of your RCS binaries.
  • Point your browser at http://your.domain.com/twiki/bin/view and start TWiki-ing away!
 
  • Note in case cgi user is not nobody : The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (e.g. www-data ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user www-data (check the rcs man pages), or simply delete all the repository files.
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directries to a place where they are not visible, and change the variables in twiki/bin/wikicfg.pm accordingly)
Changed:
<
<
  • Enable email notification of topic changes, (3) has more.
>
>
  • Enable email notification of topic changes, (4) has more.
 
Changed:
<
<
  • Optional: You can add new rendering rules or new %variables%. To insure an easy upgrade of TWiki it is recommended to do this customization in twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .
>
>
  • Optional: You can add new rendering rules or new %VARIABLES%. To insure an easy upgrade of TWiki it is recommended to do this customization in twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .
 
  • Optional: If you are on a public server and you would like to authenticate users:
    • Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details consult the HTTP server documentation (for Apache server: [1], [2], [3]). Note: In case .htaccess does not have any effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
Changed:
<
<
    • Copy the TWikiRegistrationPub? topic to TWikiRegistration. You can customize the topic if needed. Note: You can delete or add new input variables to the registration form. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This will ensure that the fields are processed correctly.
>
>
    • Copy the TWikiRegistrationPub? topic to TWikiRegistration. You can customize the topic if needed. Note: You can delete or add new input tags to the registration form. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This will ensure that the fields are processed correctly.
 
  • Optional: You can automatically generate usage statistics for all webs. To enable this:
    • Make sure variable $doLogTopicView, $doLogTopicSave and $doLogTopicUpload in wikicfg.pm are set. This will generate log entries in file twiki/data/log<date>.txt .
Line: 60 to 60
 
    • Use a name for the web consisting of characters A..Z , a..z but not in WikiNotation.
    • Create a new template directory under twiki/templates .
    • Create a new data directory under twiki/data and check the file permission of the directory.
Changed:
<
<
    • Copy the files WebHome.txt , WebPreferences.txt , WebNotify.txt , WebSearch.txt and WebStatistics.txt from the twiki/data/Main directory to the new data directory, preserving the original files' owner, group and permissions ( on Unix use cp -p ). The data files must be writable by the owner the CGI scripts are running on ( usually nobody ). Hint: You can set permissions of .txt and .txt,v files to -rw-rw-rw- and then edit the topic using your browser, RCS will restore the file permission correctly when saving the topic.
    • Add the new web to the web list (on top of each topic) by editing the site-level preferences TWikiPreferences:
>
>
    • Copy the Web*.txt files from the twiki/data/Main directory to the new data directory, preserving the original files' owner, group and permissions ( on Unix use cp -p ). The data files must be writable by the owner the CGI scripts are running on ( usually nobody ). Hint: You can set permissions of .txt and .txt,v files to -rw-rw-rw- and then edit the topic using your browser, RCS will restore the file permission correctly when saving the topic.
    • Add the new web to the web list (visible in the upper right corner of each topic) by editing the site-level preferences TWikiPreferences:
 
      • Add the new web to the WIKIWEBLIST variable.
Changed:
<
<
    • Add the new web to the web table (at the bottom of each WebHome topic) by editing the TWikiWebsTable? topic.
>
>
    • Add the new web to the web table (at the bottom of each WebHome topic) by editing the TWikiWebsTable topic.
 
    • Change the web preferences by editing the WebPreferences topic of the new web:
      • Set the WEBBGCOLOR variable to a color of your taste. The number represents the unique color for the web (consult an HTML book for colors.)
      • Customize the WEBTOPICLIST variable to contain the web specific links you prefer.
      • Optional: Set the WEBCOPYRIGHT variable to have a web-specific copyright text (at the bottom of each topic).
    • If needed, create customized templates in the new templates directory. (Non existing templates are inherited from twiki/templates )
Changed:
<
<
    • If you want to use a category table, copy the three files twikicatitems.tmpl , twikicatedit.tmpl and twikicatview.tmpl from the twiki/templates/Know directory to the new templates directory, and customize it. The TWiki Category Table section has more.
>
>
    • If you want to use a category table, copy the three files twikicatitems.tmpl , twikicatedit.tmpl and twikicatview.tmpl from the twiki/templates/Know directory to the new templates directory, and customize it. More on that in (5) TWiki Category Table.
 
    • In case you want usage statistics for this web: Copy file WebStatistics.txt from the twiki/data/Main directory to the new data directory. Edit topic WebStatistics in the new web and delete old usage entries.
Changed:
<
<
Here are contents of directories with file permissions. Please note that this is for debugging reasons only and does not exactly reflect the distribution:
>
>
Here are contents of directories showing file permissions. Please note that this is for debugging reasons only and does not exactly reflect the distribution:
 
Changed:
<
<
directory twiki/bin :
>
>
Directory twiki/bin :
 

Changed:
<
<
drwxr-xr-x 2 twiki twiki 1024 Feb 18 18:31 . drwxr-xr-x 8 twiki twiki 1024 Feb 26 04:20 .. -rw-rw-r-- 1 twiki twiki 770 Feb 10 12:10 .htaccess -rw-r-xr-x 1 twiki twiki 3968 Feb 18 00:26 attach -rwxr-xr-x 1 twiki twiki 3033 Feb 17 23:57 changes -rw-r-xr-x 1 twiki twiki 1377 Feb 8 18:18 delete -rw-r-xr-x 1 twiki twiki 8785 Feb 17 23:58 edit -rwxr--r-- 1 twiki twiki 1811 Feb 4 14:31 geturl -rwxr-xr-x 1 twiki twiki 5047 Feb 8 20:33 mailnotify -rw-r-xr-x 1 twiki twiki 1825 Feb 8 18:29 oops -rw-r-xr-x 1 twiki twiki 6932 Feb 11 02:06 preview -rw-r-xr-x 1 twiki twiki 7804 Feb 17 23:59 rdiff -rw-r-xr-x 1 twiki twiki 7010 Feb 18 00:03 register -rw-r-xr-x 1 twiki twiki 2501 Jan 25 19:39 save -rwxr-xr-x 1 twiki twiki 1778 Feb 18 00:04 search -rw-r-xr-x 1 twiki twiki 9810 Feb 8 18:43 statistics -rwxr-xr-x 1 twiki twiki 509 Feb 7 18:55 testenv -rw-r-xr-x 1 twiki twiki 6856 Feb 18 00:11 upload -rw-r-xr-x 1 twiki twiki 4922 Feb 17 23:54 view -rw-r-xr-x 1 twiki twiki 1606 May 21 1999 viewfile -rw-r-xr-x 1 twiki twiki 27794 Feb 26 06:03 wiki.pm -rw-r-xr-x 1 twiki twiki 10143 Feb 27 04:03 wikicfg.pm -rw-r-xr-x 1 twiki twiki 5440 Feb 7 04:36 wikisearch.pm
>
>
drwxrwxr-x 2 twiki twiki 4096 Jun 17 16:34 . drwxrwxr-x 3 twiki twiki 4096 Jun 17 16:34 .. -rw-rw-r-- 1 twiki twiki 650 Feb 10 2000 .htaccess -rwxrwxr-x 1 twiki twiki 4322 Mar 12 00:31 attach -rwxrwxr-x 1 twiki twiki 1426 Jun 20 19:52 delete -rwxrwxr-x 1 twiki twiki 9001 Jul 28 11:03 edit -rwxrwxr-x 1 twiki twiki 1811 Mar 11 02:27 geturl -rwxrwxr-x 1 twiki twiki 5006 Mar 11 02:41 mailnotify -rwxrwxr-x 1 twiki twiki 1769 Mar 11 03:07 oops -rwxrwxr-x 1 twiki twiki 6890 Jun 21 19:58 preview -rwxrwxr-x 1 twiki twiki 7606 Mar 31 18:30 rdiff -rwxrwxr-x 1 twiki twiki 8349 Jun 21 18:12 register -rwxrwxr-x 1 twiki twiki 2693 Jul 5 14:32 save -rwxrwxr-x 1 twiki twiki 3831 Jul 20 12:13 search -rwxrwxr-x 1 twiki twiki 9835 Jun 20 19:03 statistics -rwxrwxr-x 1 twiki twiki 509 Feb 7 2000 testenv -rwxrwxr-x 1 twiki twiki 14543 Jul 20 18:46 upload -rwxrwxr-x 1 twiki twiki 4755 May 22 18:11 view -rwxrwxr-x 1 twiki twiki 1689 Jun 20 20:10 viewfile -rw-rw-r-- 1 twiki twiki 40103 Aug 18 13:00 wiki.pm -rw-rw-r-- 1 twiki twiki 11521 Aug 19 18:38 wikicfg.pm -rw-rw-r-- 1 twiki twiki 13969 Aug 19 00:30 wikisearch.pm

Directory twiki/templates/ :

drwxrwxr-x	4 twiki twiki	4096 Aug  3 01:17 .
drwxrwxr-x	4 twiki twiki	4096 Aug 19 18:38 ..
drwxrwxr-x	2 twiki twiki	4096 Jun 17 16:35 Know
drwxrwxr-x	2 twiki twiki	4096 May  1 01:24 Main
-rw-rw-r--	1 twiki twiki	2688 Aug 15 18:15 attach.tmpl
-rw-rw-r--	1 twiki twiki	1283 Jul 20 15:56 attachtable.tmpl
-rw-rw-r--	1 twiki twiki	1907 Jul 28 16:41 changes.tmpl
-rw-rw-r--	1 twiki twiki	2265 Aug 15 17:57 edit.tmpl
-rw-rw-r--	1 twiki twiki	 965 Feb  8  2000 mailnotify.tmpl
-rw-rw-r--	1 twiki twiki	  30 Jan 13  1999 notedited.tmpl
-rw-rw-r--	1 twiki twiki	 940 Jul 20 15:59 notext.tmpl
-rw-rw-r--	1 twiki twiki	 907 Jul 20 16:01 notwiki.tmpl
-rw-rw-r--	1 twiki twiki	 341 Mar  8 11:39 noweb.tmpl
-rw-rw-r--	1 twiki twiki	1000 Mar  8 11:40 oops.tmpl
-rw-rw-r--	1 twiki twiki	 914 Mar  8 11:40 oopsdel.tmpl
-rw-rw-r--	1 twiki twiki	1423 May 29 01:23 oopslocked.tmpl
-rw-rw-r--	1 twiki twiki	1067 Mar  8 11:41 oopsregexist.tmpl
-rw-rw-r--	1 twiki twiki	 955 Mar  8 11:41 oopsregpasswd.tmpl
-rw-rw-r--	1 twiki twiki	 966 Mar  8 11:41 oopsregrequ.tmpl
-rw-rw-r--	1 twiki twiki	1244 Apr 28 17:11 oopsregthanks.tmpl
-rw-rw-r--	1 twiki twiki	1003 Jul 22 12:48 oopsregwiki.tmpl
-rw-rw-r--	1 twiki twiki	1607 Mar  8 11:42 oopsrev.tmpl
-rw-rw-r--	1 twiki twiki	 949 Mar  8 11:43 oopsupload.tmpl
-rw-rw-r--	1 twiki twiki	1735 Aug 15 18:14 preview.tmpl
-rw-rw-r--	1 twiki twiki	1682 Aug 15 18:14 rdiff.tmpl
-rw-rw-r--	1 twiki twiki	 530 Jul 22 12:10 register.tmpl
-rw-rw-r--	1 twiki twiki	 690 Apr 28 16:53 registernotify.tmpl
-rw-rw-r--	1 twiki twiki	1900 Aug 15 18:15 search.tmpl
-rw-rw-r--	1 twiki twiki	1785 Aug 15 18:15 searchbookview.tmpl
-rw-rw-r--	1 twiki twiki	1559 Aug 19 02:53 view.tmpl

Directory twiki/templates/Know (has a TWiki Category Table) :

drwxrwxr-x	2 twiki	twiki	4096 Jun 17 16:35 .
drwxrwxr-x	4 twiki	twiki	4096 Aug  3 01:17 ..
-rw-rw-r--	1 twiki	twiki	 446 Jun  7  1999 notedited.tmpl
-rw-rw-r--	1 twiki	twiki	 206 Jun  7  1999 twikicatedit.tmpl
-rw-rw-r--	1 twiki	twiki	1068 Aug 18 18:26 twikicatitems.tmpl
-rw-rw-r--	1 twiki	twiki	 231 Jun  7  1999 twikicatview.tmpl

Directory twiki/data/ :

drwxrwxrwx	6 nobody  nobody  4096 Aug  3 01:09 .
drwxrwxr-x	4 twiki	twiki	4096 Aug 19 18:38 ..
-rw-rw-r--	1 nobody  nobody	 51 Apr 21 16:48 .htpasswd
drwxrwxrwx	2 nobody  nobody  4096 Aug 20 17:18 Know
drwxrwxrwx	2 nobody  nobody  4096 Aug 19 04:15 Main
drwxrwxrwx	2 nobody  nobody  4096 Aug 20 17:56 TWiki
-rw-rw-rw-	1 twiki	twiki		1 Mar 11 04:19 debug.txt
-rw-r--r--	1 nobody  nobody  1516 Aug 20 17:56 log200008.txt

Part of directory twiki/data/Main :

drwxrwxrwx	2 nobody  nobody  4096 Aug 19 04:15 .
drwxrwxrwx	6 nobody  nobody  4096 Aug  3 01:09 ..
-rw-rw-rw-	1 twiki twiki	  3716 Aug 19 02:19 .changes
-rw-rw-rw-	1 twiki twiki		  9 Aug 19 02:45 .mailnotify
-rw-r--r--	1 nobody  nobody	358 Aug 18 17:22 OfficeLocations.txt
-r--r--r--	1 nobody  nobody	878 Aug 18 17:22 OfficeLocations.txt,v
-rw-r--r--	1 nobody  nobody	680 Aug 18 17:36 TWikiGuest.txt
-r--r--r--	1 nobody  nobody  1989 Aug 18 17:36 TWikiGuest.txt,v
-rw-r--r--	1 nobody  nobody	459 Aug 18 17:19 TWikiUsers.txt
-r--r--r--	1 nobody  nobody  3840 Aug 18 17:19 TWikiUsers.txt,v
-rw-r--r--	1 nobody  nobody	 95 Aug 19 03:06 WebChanges.txt
-r--r--r--	1 nobody  nobody	284 Aug 19 03:06 WebChanges.txt,v
-rw-r--r--	1 nobody  nobody  1853 Aug 18 18:08 WebHome.txt
-r--r--r--	1 nobody  nobody  6523 Aug 18 18:08 WebHome.txt,v
-rw-r--r--	1 nobody  nobody	 56 Aug 18 17:21 WebIndex.txt
-r--r--r--	1 nobody  nobody	245 Aug 18 17:21 WebIndex.txt,v
-rw-r--r--	1 nobody  nobody	495 Aug 18 17:40 WebNotify.txt
-r--r--r--	1 nobody  nobody  1896 Aug 18 17:40 WebNotify.txt,v
-rw-r--r--	1 nobody  nobody  1904 Aug 19 01:01 WebPreferences.txt
-r--r--r--	1 nobody  nobody  3108 Aug 19 01:01 WebPreferences.txt,v
-rw-r--r--	1 nobody  nobody  5553 Aug 19 02:30 WebSearch.txt
-r--r--r--	1 nobody  nobody  8406 Aug 19 02:30 WebSearch.txt,v
-rw-r--r--	1 nobody  nobody	729 Aug 18 17:41 WebStatistics.txt
-r--r--r--	1 nobody  nobody  1129 Aug 18 17:41 WebStatistics.txt,v

Directory twiki/pub/ :

drwxrwxrwx	6 nobody  nobody  4096 Aug  3 01:21 .
drwxrwxr-x	3 twiki	twiki	4096 Jun 17 16:35 ..
drwxrwxrwx	3 nobody  nobody  4096 Jun 17 16:35 Know
drwxrwxrwx	2 nobody  nobody  4096 Aug  3 01:21 Main
drwxrwxrwx	3 nobody  nobody  4096 Aug  3 01:21 TWiki
-rw-rw-r--	1 twiki	twiki	1078 Jan 14  2000 favicon.ico
drwxrwxr-x	2 twiki	twiki	4096 Jun 17 16:35 icn
-rw-rw-r--	1 twiki	twiki	3016 Oct  5  1999 twikilogo.gif
-rw-rw-r--	1 twiki	twiki	5320 Oct  5  1999 twikilogo1.gif
-rw-rw-r--	1 twiki	twiki	6125 Oct  5  1999 twikilogo2.gif
-rw-rw-r--	1 twiki	twiki	7218 Oct  5  1999 twikilogo3.gif
-rw-rw-r--	1 twiki	twiki	6710 Oct  5  1999 twikilogo4.gif
-rw-rw-r--	1 twiki	twiki	2877 Jun  7  1999 wikiHome.gif

Directory twiki/pub/icn/ :

drwxrwxr-x	2 twiki	twiki	4096 Jun 17 16:35 .
drwxrwxrwx	6 nobody  nobody  4096 Aug  3 01:21 ..
-rw-rw-r--	1 twiki	twiki	 801 Mar 26  1999 _filetypes.txt
-rw-rw-r--	1 twiki	twiki	 143 Mar  9  1999 bat.gif
-rw-rw-r--	1 twiki	twiki	 926 Mar  9  1999 bmp.gif
-rw-rw-r--	1 twiki	twiki	 141 Mar 25  1999 c.gif
-rw-rw-r--	1 twiki	twiki	 144 Mar  9  1999 dll.gif
-rw-rw-r--	1 twiki	twiki	 152 Mar  9  1999 doc.gif
-rw-rw-r--	1 twiki	twiki	 130 Mar  9  1999 else.gif
-rw-rw-r--	1 twiki	twiki	 876 Mar 26  1999 exe.gif
-rw-rw-r--	1 twiki	twiki	 147 Mar  9  1999 fon.gif
-rw-rw-r--	1 twiki	twiki	 142 Mar 25  1999 h.gif
-rw-rw-r--	1 twiki	twiki	 156 Mar  9  1999 hlp.gif
-rw-rw-r--	1 twiki	twiki	 186 Mar  9  1999 html.gif
-rw-rw-r--	1 twiki	twiki	 144 Mar 25  1999 java.gif
-rw-rw-r--	1 twiki	twiki	 148 Mar  9  1999 mov.gif
-rw-rw-r--	1 twiki	twiki	 150 Mar  9  1999 pdf.gif
-rw-rw-r--	1 twiki	twiki	 146 Mar 25  1999 pl.gif
-rw-rw-r--	1 twiki	twiki	 150 Mar  9  1999 ppt.gif
-rw-rw-r--	1 twiki	twiki	 148 Mar 25  1999 ps.gif
-rw-rw-r--	1 twiki	twiki	 148 Mar 25  1999 py.gif
-rw-rw-r--	1 twiki	twiki	 130 Mar  9  1999 ram.gif
-rw-rw-r--	1 twiki	twiki	 154 Mar  9  1999 reg.gif
-rw-rw-r--	1 twiki	twiki	 147 Mar 25  1999 sh.gif
-rw-rw-r--	1 twiki	twiki	 155 Mar  9  1999 sniff.gif
-rw-rw-r--	1 twiki	twiki	 149 Mar  9  1999 ttf.gif
-rw-rw-r--	1 twiki	twiki	 134 Mar  9  1999 txt.gif
-rw-rw-r--	1 twiki	twiki	 154 Mar  9  1999 wav.gif
-rw-rw-r--	1 twiki	twiki	 152 Mar  9  1999 wri.gif
-rw-rw-r--	1 twiki	twiki	 152 Mar  9  1999 xls.gif
-rw-rw-r--	1 twiki	twiki	 144 Mar  9  1999 zip.gif

 
Changed:
<
<
directory twiki/templates/ :

drwxr-xr-x	7 twiki	twiki		 1024 Jan 16 19:39 .
drwxr-xr-x	8 twiki	twiki		 1024 Feb 26 04:20 ..
drwxr-xr-x	2 twiki	twiki		 1024 Jun  8  1999 Know
drwxr-xr-x	2 twiki	twiki		 1024 Dec  9  1998 Main
-rw-r--r--	1 twiki	twiki		 2286 Feb 24 21:50 attach.tmpl
-rw-r--r--	1 twiki	twiki		 1272 Feb  8 16:07 attachtable.tmpl
-rw-r--r--	1 twiki	twiki		 1884 Feb 24 21:54 changes.tmpl
-rw-r--r--	1 twiki	twiki		 2242 Feb 24 21:33 edit.tmpl
-rw-r--r--	1 twiki	twiki		  965 Feb  8 16:07 mailnotify.tmpl
-rw-r--r--	1 twiki	twiki			30 Jan 14  1999 notedited.tmpl
-rw-r--r--	1 twiki	twiki		  934 Feb  8 16:07 notext.tmpl
-rw-r--r--	1 twiki	twiki		  899 Feb  8 16:07 notwiki.tmpl
-rw-r--r--	1 twiki	twiki		  299 Feb 24 21:58 noweb.tmpl
-rw-r--r--	1 twiki	twiki		  957 Feb 24 22:17 oops.tmpl
-rw-r--r--	1 twiki	twiki		  871 Feb 24 22:17 oopsdel.tmpl
-rw-r--r--	1 twiki	twiki		 1330 Feb 24 22:17 oopslocked.tmpl
-rw-r--r--	1 twiki	twiki		 1024 Feb 24 22:17 oopsregexist.tmpl
-rw-r--r--	1 twiki	twiki		  912 Feb 24 22:17 oopsregpasswd.tmpl
-rw-r--r--	1 twiki	twiki		  923 Feb 24 22:17 oopsregrequ.tmpl
-rw-r--r--	1 twiki	twiki		 1125 Feb 24 22:17 oopsregthanks.tmpl
-rw-r--r--	1 twiki	twiki		  942 Feb 24 22:17 oopsregwiki.tmpl
-rw-r--r--	1 twiki	twiki		 1564 Feb 24 22:17 oopsrev.tmpl
-rw-r--r--	1 twiki	twiki		  906 Feb 24 22:17 oopsupload.tmpl
-rw-r--r--	1 twiki	twiki		 1535 Feb 24 22:02 preview.tmpl
-rw-r--r--	1 twiki	twiki		 1661 Feb 24 22:04 rdiff.tmpl
-rw-r--r--	1 twiki	twiki		  263 Aug  3  1999 register.tmpl
-rw-r--r--	1 twiki	twiki		  936 Feb  8 16:08 registernotify.tmpl
-rw-r--r--	1 twiki	twiki		 1779 Feb 24 22:06 search.tmpl
-rw-r--r--	1 twiki	twiki		 1533 Feb 24 21:43 view.tmpl

directory twiki/templates/Main :

drwxr-xr-x	2 twiki	twiki		 1024 Dec  9  1998 .
drwxr-xr-x	7 twiki	twiki		 1024 Jan 16 19:39 ..
-rw-r--r--	1 twiki	twiki		 2732 Feb 24 21:34 edit.tmpl

directory twiki/templates/Know (has a TWiki Category Table) :

drwxr-xr-x	2 twiki	twiki		 1024 Jun  8  1999 .
drwxr-xr-x	7 twiki	twiki		 1024 Jan 16 19:39 ..
-rw-rw-r--	1 twiki	twiki		  446 Jun  8  1999 notedited.tmpl
-rw-rw-r--	1 twiki	twiki		  206 Jun  8  1999 twikicatedit.tmpl
-rw-rw-r--	1 twiki	twiki		 1060 Jul 16  1999 twikicatitems.tmpl
-rw-rw-r--	1 twiki	twiki		  231 Jun  8  1999 twikicatview.tmpl

directory twiki/data/ :

drwxrwxrwx	8 twiki	twiki		 1024 Feb 26 04:17 .
drwxr-xr-x	8 twiki	twiki		 1024 Feb 26 04:20 ..
-rw-r--r--	1 nobody  nobody		2241 Feb 25 20:18 .htpasswd
drwxrwxrwx	2 twiki	twiki		 3072 Feb 27 01:15 Know
drwxrwxrwx	2 twiki	twiki		 9216 Feb 27 18:16 Main
-rw-rw-rw-	1 twiki	twiki			 1 Feb 26 06:01 debug.txt
-rw-r--r--	1 nobody  nobody	1263064 Jan 31 23:13 log200001.txt
-rw-r--r--	1 nobody  nobody	1063398 Feb 27 18:33 log200002.txt

part of directory twiki/data/Main :

drwxrwxrwx	2 twiki	twiki		 9216 Feb 27 18:16 .
drwxrwxrwx	8 twiki	twiki		 1024 Feb 26 04:17 ..
-rw-rw-rw-	1 twiki	twiki		 5722 Feb 27 18:13 .changes
-rw-rw-rw-	1 twiki	twiki			 9 Feb 27 18:15 .mailnotify
-rw-r--r--	1 nobody  nobody	  26163 Feb 24 12:22 TWikiDocumentation.txt
-r--r--r--	1 nobody  nobody	  44133 Feb 24 12:22 TWikiDocumentation.txt,v
-rw-r--r--	1 nobody  nobody	  11661 Feb 27 18:13 TWikiHistory.txt
-r--r--r--	1 nobody  nobody	  18877 Feb 27 18:13 TWikiHistory.txt,v
-rw-r--r--	1 nobody  nobody		3029 Feb 26 04:46 TWikiPreferences.txt
-r--r--r--	1 nobody  nobody		3219 Feb 26 04:46 TWikiPreferences.txt,v
-rw-r--r--	1 nobody  nobody		7188 Feb 11 21:39 TWikiRegistration.txt
-r--r--r--	1 nobody  nobody		7375 Feb 11 21:39 TWikiRegistration.txt,v
-rw-r--r--	1 nobody  nobody		3180 Feb 25 20:19 TWikiUsers.txt
-r--r--r--	1 nobody  nobody	  16537 Feb 25 20:19 TWikiUsers.txt,v
-rw-r--r--	1 nobody  nobody		2613 Feb  7 04:47 TWikiVariables.txt
-r--r--r--	1 nobody  nobody		3125 Feb  7 04:47 TWikiVariables.txt,v
-rw-r--r--	1 nobody  nobody		2068 Feb 10 11:34 TWikiWeb.txt
-r--r--r--	1 nobody  nobody		3610 Feb 10 11:34 TWikiWeb.txt,v
-rw-r--r--	1 nobody  nobody		1677 Feb 26 05:11 TWikiWebsTable.txt
-r--r--r--	1 nobody  nobody		1866 Feb 26 05:11 TWikiWebsTable.txt,v
-rw-r--r--	1 nobody  nobody		2294 Feb 27 17:54 WebHome.txt
-r--r--r--	1 nobody  nobody		5282 Feb 27 17:54 WebHome.txt,v
-rw-r--r--	1 nobody  nobody		 586 Jan 17 01:05 WebNotify.txt
-r--r--r--	1 nobody  nobody		1629 Jan 17 01:05 WebNotify.txt,v
-rw-r--r--	1 nobody  nobody		1834 Feb 25 14:13 WebPreferences.txt
-r--r--r--	1 nobody  nobody		2023 Feb 25 14:13 WebPreferences.txt,v
-rw-r--r--	1 nobody  nobody		4407 Feb 11 21:08 WebSearch.txt
-r--r--r--	1 nobody  nobody	  10822 Feb 11 21:08 WebSearch.txt,v
-rw-r--r--	1 nobody  nobody		4416 Feb 27 00:00 WebStatistics.txt
-r--r--r--	1 nobody  nobody	  27759 Feb 27 00:00 WebStatistics.txt,v

directory twiki/pub/ :

drwxrwxrwx  11 twiki	twiki		 1024 Feb  8 18:10 .
drwxr-xr-x	8 twiki	twiki		 1024 Feb 26 04:20 ..
drwxrwxrwx	4 nobody  nobody		1024 Aug 28  1999 Know
drwxrwxrwx  19 nobody  nobody		1024 Feb 27 09:56 Main
-rw-r--r--	1 twiki	twiki		 1078 Jan 14 20:24 favicon.ico
drwxr-xr-x	2 twiki	twiki		 1024 Mar 27  1999 icn
-rw-r--r--	1 twiki	twiki		 3016 Sep 10 04:27 twikilogo.gif
-rw-r--r--	1 twiki	twiki		 5320 Sep 10 04:27 twikilogo1.gif
-rw-r--r--	1 twiki	twiki		 6125 Sep 10 04:27 twikilogo2.gif
-rw-r--r--	1 twiki	twiki		 7218 Sep 10 04:27 twikilogo3.gif
-rw-r--r--	1 twiki	twiki		 6710 Sep 11 02:21 twikilogo4.gif
-rw-r--r--	1 twiki	twiki		 2877 Jun 15  1999 wikiHome.gif

directory twiki/pub/icn/ :

drwxr-xr-x	2 twiki	twiki		 1024 Mar 27  1999 .
drwxrwxrwx  11 twiki	twiki		 1024 Feb  8 18:10 ..
-rw-r--r--	1 twiki	twiki		  801 Mar 27  1999 _filetypes.txt
-rw-r--r--	1 twiki	twiki		  143 Mar 27  1999 bat.gif
-rw-r--r--	1 twiki	twiki		  926 Mar 27  1999 bmp.gif
-rw-r--r--	1 twiki	twiki		  141 Mar 27  1999 c.gif
-rw-r--r--	1 twiki	twiki		  144 Mar 27  1999 dll.gif
-rw-r--r--	1 twiki	twiki		  152 Mar 27  1999 doc.gif
-rw-r--r--	1 twiki	twiki		  130 Mar 27  1999 else.gif
-rw-r--r--	1 twiki	twiki		  876 Mar 27  1999 exe.gif
-rw-r--r--	1 twiki	twiki		  147 Mar 27  1999 fon.gif
-rw-r--r--	1 twiki	twiki		  142 Mar 27  1999 h.gif
-rw-r--r--	1 twiki	twiki		  156 Mar 27  1999 hlp.gif
-rw-r--r--	1 twiki	twiki		  186 Mar 27  1999 html.gif
-rw-r--r--	1 twiki	twiki		  144 Mar 27  1999 java.gif
-rw-r--r--	1 twiki	twiki		  148 Mar 27  1999 mov.gif
-rw-r--r--	1 twiki	twiki		  150 Mar 27  1999 pdf.gif
-rw-r--r--	1 twiki	twiki		  146 Mar 27  1999 pl.gif
-rw-r--r--	1 twiki	twiki		  150 Mar 27  1999 ppt.gif
-rw-r--r--	1 twiki	twiki		  148 Mar 27  1999 ps.gif
-rw-r--r--	1 twiki	twiki		  148 Mar 27  1999 py.gif
-rw-r--r--	1 twiki	twiki		  130 Mar 27  1999 ram.gif
-rw-r--r--	1 twiki	twiki		  154 Mar 27  1999 reg.gif
-rw-r--r--	1 twiki	twiki		  147 Mar 27  1999 sh.gif
-rw-r--r--	1 twiki	twiki		  155 Mar 27  1999 sniff.gif
-rw-r--r--	1 twiki	twiki		  149 Mar 27  1999 ttf.gif
-rw-r--r--	1 twiki	twiki		  134 Mar 27  1999 txt.gif
-rw-r--r--	1 twiki	twiki		  154 Mar 27  1999 wav.gif
-rw-r--r--	1 twiki	twiki		  152 Mar 27  1999 wri.gif
-rw-r--r--	1 twiki	twiki		  152 Mar 27  1999 xls.gif
-rw-r--r--	1 twiki	twiki		  144 Mar 27  1999 zip.gif

-- PeterThoeny? - 27 Jul 2000

>
>
-- PeterThoeny? - 20 Aug 2000

Revision 628 Jul 2000 - Main.PeterThoeny

Line: 4 to 4
 
Changed:
<
<
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/conf/http.conf with only ExecCGI option.
  • The twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki to file http.conf with normal access options (copy from /home/httpd/html ).
  • Now add ScriptAlias for /twiki/bin and Alias for /twiki to file http.conf .
    Note: The ScriptAlias must come before the Alias in Apache, otherwise it will fail to correctly set up /twiki/bin/ , due to the fact that it sees that as being just another subdirectory of the /twiki/ alias.
  • Here are example http.conf entries:
>
>
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.
  • The twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki to file httpd.conf with normal access options (copy from /home/httpd/html ).
  • Now add ScriptAlias for /twiki/bin and Alias for /twiki to file httpd.conf .
    Note: The ScriptAlias must come before the Alias in Apache, otherwise it will fail to correctly set up /twiki/bin/ , due to the fact that it sees that as being just another subdirectory of the /twiki/ alias. (MichaelBrooks? 30 Jun 2000)
  • Here are example httpd.conf entries:
 
 ScriptAlias /twiki/bin/ "/home/httpd/twiki/bin/"
 Alias /twiki/ "/home/httpd/twiki/pub/"
 <Directory "/home/httpd/twiki/bin">

Line: 257 to 257
 -rw-r--r-- 1 twiki twiki 144 Mar 27 1999 zip.gif
Changed:
<
<
-- PeterThoeny? - 17 Jul 2000
>
>
-- PeterThoeny? - 27 Jul 2000

Revision 518 Jul 2000 - Main.PeterThoeny

Line: 4 to 4
 
Changed:
<
<
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to /etc/httpd/conf/access.conf with only ExecCGI option.
  • The twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki to /etc/httpd/conf/access.conf with normal access options (copy from /home/httpd/html).
  • Now add ScriptAlias for /twiki/bin and Alias for /twiki to /etc/httpd/conf/srm-conf . Example:
    ScriptAlias /twiki/bin/ /home/httpd/twiki/bin/
    Alias /twiki/ /home/httpd/twiki/
    Note: The ScriptAlias must come before the Alias in Apache, otherwise it will fail to correctly set up /twiki/bin/ , due to the fact that it sees that as being just another subdirectory of the /twiki/ alias.
>
>
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/conf/http.conf with only ExecCGI option.
  • The twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki to file http.conf with normal access options (copy from /home/httpd/html ).
  • Now add ScriptAlias for /twiki/bin and Alias for /twiki to file http.conf .
    Note: The ScriptAlias must come before the Alias in Apache, otherwise it will fail to correctly set up /twiki/bin/ , due to the fact that it sees that as being just another subdirectory of the /twiki/ alias.
  • Here are example http.conf entries:
     ScriptAlias /twiki/bin/ "/home/httpd/twiki/bin/"
     Alias /twiki/ "/home/httpd/twiki/pub/"
     <Directory "/home/httpd/twiki/bin">
    	 Options +ExecCGI
    	 SetHandler cgi-script
    	 Allow from all
     </Directory>
     <Directory "/home/httpd/twiki/pub">
    	 Options FollowSymLinks +Includes
    	 AllowOverride None
    	 Allow from all
     </Directory>
 
  • Restart Apache by /etc/rc.d/rc5.d/S85httpd restart .
  • Test if the twiki/bin directory is cgi-enabled:
    • Enter the URL of that directory into your browser ( http://your.domain.com/twiki/bin ). It is not set correctly as cgi-bin in case you get something like "Index of /twiki/bin" . It is OK if you get a message like "Forbidden. You don't have permission to access /twiki/bin/ on this server."
Line: 243 to 257
 -rw-r--r-- 1 twiki twiki 144 Mar 27 1999 zip.gif
Changed:
<
<
-- PeterThoeny? - 24 May 2000
>
>
-- PeterThoeny? - 17 Jul 2000

Revision 430 Jun 2000 - Main.PeterThoeny

Line: 6 to 6
 
  • Create directory /home/httpd/twiki and unzip the TWiki distribution to this directory.
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to /etc/httpd/conf/access.conf with only ExecCGI option.
  • The twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki to /etc/httpd/conf/access.conf with normal access options (copy from /home/httpd/html).
Changed:
<
<
  • Now add ScriptAlias for /twiki/bin and Alias for /twiki to /etc/httpd/conf/srm-conf . Example:
    ScriptAlias /twiki/bin/ /home/httpd/twiki/bin/
    Alias /twiki/ /home/httpd/twiki/
>
>
  • Now add ScriptAlias for /twiki/bin and Alias for /twiki to /etc/httpd/conf/srm-conf . Example:
    ScriptAlias /twiki/bin/ /home/httpd/twiki/bin/
    Alias /twiki/ /home/httpd/twiki/
    Note: The ScriptAlias must come before the Alias in Apache, otherwise it will fail to correctly set up /twiki/bin/ , due to the fact that it sees that as being just another subdirectory of the /twiki/ alias.
 
  • Restart Apache by /etc/rc.d/rc5.d/S85httpd restart .
  • Test if the twiki/bin directory is cgi-enabled:
    • Enter the URL of that directory into your browser ( http://your.domain.com/twiki/bin ). It is not set correctly as cgi-bin in case you get something like "Index of /twiki/bin" . It is OK if you get a message like "Forbidden. You don't have permission to access /twiki/bin/ on this server."

Revision 325 May 2000 - Main.PeterThoeny

Line: 6 to 6
 
  • Create directory /home/httpd/twiki and unzip the TWiki distribution to this directory.
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to /etc/httpd/conf/access.conf with only ExecCGI option.
  • The twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki to /etc/httpd/conf/access.conf with normal access options (copy from /home/httpd/html).
Changed:
<
<
  • Now add Alias for /twiki and ScriptAlias for /twiki/bin to /etc/httpd/conf/srm-conf .
>
>
  • Now add ScriptAlias for /twiki/bin and Alias for /twiki to /etc/httpd/conf/srm-conf . Example:
    ScriptAlias /twiki/bin/ /home/httpd/twiki/bin/
    Alias /twiki/ /home/httpd/twiki/
 
  • Restart Apache by /etc/rc.d/rc5.d/S85httpd restart .
  • Test if the twiki/bin directory is cgi-enabled:
    • Enter the URL of that directory into your browser ( http://your.domain.com/twiki/bin ). It is not set correctly as cgi-bin in case you get something like "Index of /twiki/bin" . It is OK if you get a message like "Forbidden. You don't have permission to access /twiki/bin/ on this server."
Line: 243 to 243
 -rw-r--r-- 1 twiki twiki 144 Mar 27 1999 zip.gif
Changed:
<
<
-- PeterThoeny? - 21 Apr 2000
>
>
-- PeterThoeny? - 24 May 2000

Revision 225 Apr 2000 - Main.PeterThoeny

Line: 5 to 5
 
  • Request the TWiki distribution (in Unix ZIP format) from http://TWiki.SourceForge.net/download.html .
  • Create directory /home/httpd/twiki and unzip the TWiki distribution to this directory.
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to /etc/httpd/conf/access.conf with only ExecCGI option.
Changed:
<
<
  • The twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki/pub to /etc/httpd/conf/access.conf with normal access options (copy from /home/httpd/html).
  • Now add Alias for /twiki/pub and ScriptAlias for /twiki/bin to /etc/httpd/conf/srm-conf .
>
>
  • The twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki to /etc/httpd/conf/access.conf with normal access options (copy from /home/httpd/html).
  • Now add Alias for /twiki and ScriptAlias for /twiki/bin to /etc/httpd/conf/srm-conf .
 
  • Restart Apache by /etc/rc.d/rc5.d/S85httpd restart .
  • Test if the twiki/bin directory is cgi-enabled:
    • Enter the URL of that directory into your browser ( http://your.domain.com/twiki/bin ). It is not set correctly as cgi-bin in case you get something like "Index of /twiki/bin" . It is OK if you get a message like "Forbidden. You don't have permission to access /twiki/bin/ on this server."

Revision 122 Apr 2000 - Main.PeterThoeny

Line: 1 to 1
Added:
>
>
These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well.

Note: These installation notes assume user nobody for all files manupulated by the cgi scripts (executed by the web server), and user twiki for all other files. You need to replace user nobody with an other user in case the web server executes the script with a different user ( default for Debian is www-data ). Also, you can substitute user twiki with your own user name.

  • Request the TWiki distribution (in Unix ZIP format) from http://TWiki.SourceForge.net/download.html .
  • Create directory /home/httpd/twiki and unzip the TWiki distribution to this directory.
  • The twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to /etc/httpd/conf/access.conf with only ExecCGI option.
  • The twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki/pub to /etc/httpd/conf/access.conf with normal access options (copy from /home/httpd/html).
  • Now add Alias for /twiki/pub and ScriptAlias for /twiki/bin to /etc/httpd/conf/srm-conf .
  • Restart Apache by /etc/rc.d/rc5.d/S85httpd restart .
  • Test if the twiki/bin directory is cgi-enabled:
    • Enter the URL of that directory into your browser ( http://your.domain.com/twiki/bin ). It is not set correctly as cgi-bin in case you get something like "Index of /twiki/bin" . It is OK if you get a message like "Forbidden. You don't have permission to access /twiki/bin/ on this server."
    • Execute the testenv script from your browser ( http://your.domain.com/twiki/bin/testenv ). It should show a table of all CGI environment variables.
  • Make sure PERL and the PERL CGI library is installed on your system. Default location of PERL executable is /usr/bin/perl . In case PERL is installed in a different location, the first line of all perl scripts in the twiki/bin directory need to be changed (alternatively you can create a symbolic link from /usr/bin/perl ).
  • To be able to edit the perl scripts and .tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
  • The scripts execute as nobody . Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rw-r-xr-x .
  • Set the file permission of all files below twiki/data to 666 ( -rw-rw-rw- ).
  • Set the file permission of the twiki/data directory and all its subdirectories to 777 ( drwxrwxrwx ).
  • Set the file permission of the twiki/pub directory to 777 ( drwxrwxrwx ).
  • Edit the file twiki/bin/wikicfg.pm and set the variables at the beginning of the file to your needs.
  • Make sure RCS is installed. In case RCS is not in the path environment variable, add it to path . Alternatively, add the full path name to the rcs, ci, co, rlog, rcsdiff commands in the variables of twiki/bin/wikicfg.pm .
  • Point your browser at http://your.domain.com/twiki/bin/view and start wiki-ing away!
  • Note in case cgi user is not nobody : The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (e.g. www-data ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user www-data (check the rcs man pages), or simply delete all the repository files.
  • Security issue: Directories twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directries to a place where they are not visible, and change the variables in twiki/bin/wikicfg.pm accordingly)
  • Enable email notification of topic changes, (3) has more.
  • Add the PoweredByTWikiLogo if TWiki is installed on a public web server.

  • Optional: You can add new rendering rules or new %variables%. To insure an easy upgrade of TWiki it is recommended to do this customization in twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .

  • Optional: If you are on a public server and you would like to authenticate users:
    • Rename file .htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details consult the HTTP server documentation (for Apache server: [1], [2], [3]). Note: In case .htaccess does not have any effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
    • Copy the TWikiRegistrationPub? topic to TWikiRegistration. You can customize the topic if needed. Note: You can delete or add new input variables to the registration form. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This will ensure that the fields are processed correctly.

  • Optional: You can automatically generate usage statistics for all webs. To enable this:
    • Make sure variable $doLogTopicView, $doLogTopicSave and $doLogTopicUpload in wikicfg.pm are set. This will generate log entries in file twiki/data/log<date>.txt .
    • Topic WebStatistics must be present in all webs where you want to have statistics. You can use the topic in the Main web as a template.
    • Call the twiki/bin/statistics script from a cron job, once a day is recommended. This will update the WebStatistics topics in all webs.
    • Attention: The script must run as the same user as the CGI scripts are running, which is user nobody on most systems. Example crontab entry:
      0 0 * * * (cd /path/to/TWiki/bin; ./statistics >/dev/null 2>&1)
    • There is a workaround in case you can't run the script as user nobody : Run the utility twiki/bin/geturl in your cron job and specify the URL of the twiki/bin/statistics script as a parameter. Example:
      0 0 * * * (cd /path/to/TWiki/bin; ./geturl mydomain.com /urlpath/to/TWiki/bin/statistics >/dev/null 2>&1)
    • The twiki/bin/statistics script can also be executed as a CGI script, just enter the URL in your browser. Examples:
      • Update current month for all webs:
        http://mydomain.com/twiki/bin/statistics
      • Update current month for Main web only:
        http://mydomain.com/twiki/bin/statistics/Main
      • Update January 2000 for Main web:
        http://mydomain.com/twiki/bin/statistics/Main?logdate=200001

  • To create a new web:
    • Use a name for the web consisting of characters A..Z , a..z but not in WikiNotation.
    • Create a new template directory under twiki/templates .
    • Create a new data directory under twiki/data and check the file permission of the directory.
    • Copy the files WebHome.txt , WebPreferences.txt , WebNotify.txt , WebSearch.txt and WebStatistics.txt from the twiki/data/Main directory to the new data directory, preserving the original files' owner, group and permissions ( on Unix use cp -p ). The data files must be writable by the owner the CGI scripts are running on ( usually nobody ). Hint: You can set permissions of .txt and .txt,v files to -rw-rw-rw- and then edit the topic using your browser, RCS will restore the file permission correctly when saving the topic.
    • Add the new web to the web list (on top of each topic) by editing the site-level preferences TWikiPreferences:
      • Add the new web to the WIKIWEBLIST variable.
    • Add the new web to the web table (at the bottom of each WebHome topic) by editing the TWikiWebsTable? topic.
    • Change the web preferences by editing the WebPreferences topic of the new web:
      • Set the WEBBGCOLOR variable to a color of your taste. The number represents the unique color for the web (consult an HTML book for colors.)
      • Customize the WEBTOPICLIST variable to contain the web specific links you prefer.
      • Optional: Set the WEBCOPYRIGHT variable to have a web-specific copyright text (at the bottom of each topic).
    • If needed, create customized templates in the new templates directory. (Non existing templates are inherited from twiki/templates )
    • If you want to use a category table, copy the three files twikicatitems.tmpl , twikicatedit.tmpl and twikicatview.tmpl from the twiki/templates/Know directory to the new templates directory, and customize it. The TWiki Category Table section has more.
    • In case you want usage statistics for this web: Copy file WebStatistics.txt from the twiki/data/Main directory to the new data directory. Edit topic WebStatistics in the new web and delete old usage entries.

Here are contents of directories with file permissions. Please note that this is for debugging reasons only and does not exactly reflect the distribution:

directory twiki/bin :

drwxr-xr-x	2 twiki	twiki		 1024 Feb 18 18:31 .
drwxr-xr-x	8 twiki	twiki		 1024 Feb 26 04:20 ..
-rw-rw-r--	1 twiki	twiki		  770 Feb 10 12:10 .htaccess
-rw-r-xr-x	1 twiki	twiki		 3968 Feb 18 00:26 attach
-rwxr-xr-x	1 twiki	twiki		 3033 Feb 17 23:57 changes
-rw-r-xr-x	1 twiki	twiki		 1377 Feb  8 18:18 delete
-rw-r-xr-x	1 twiki	twiki		 8785 Feb 17 23:58 edit
-rwxr--r--	1 twiki	twiki		 1811 Feb  4 14:31 geturl
-rwxr-xr-x	1 twiki	twiki		 5047 Feb  8 20:33 mailnotify
-rw-r-xr-x	1 twiki	twiki		 1825 Feb  8 18:29 oops
-rw-r-xr-x	1 twiki	twiki		 6932 Feb 11 02:06 preview
-rw-r-xr-x	1 twiki	twiki		 7804 Feb 17 23:59 rdiff
-rw-r-xr-x	1 twiki	twiki		 7010 Feb 18 00:03 register
-rw-r-xr-x	1 twiki	twiki		 2501 Jan 25 19:39 save
-rwxr-xr-x	1 twiki	twiki		 1778 Feb 18 00:04 search
-rw-r-xr-x	1 twiki	twiki		 9810 Feb  8 18:43 statistics
-rwxr-xr-x	1 twiki	twiki		  509 Feb  7 18:55 testenv
-rw-r-xr-x	1 twiki	twiki		 6856 Feb 18 00:11 upload
-rw-r-xr-x	1 twiki	twiki		 4922 Feb 17 23:54 view
-rw-r-xr-x	1 twiki	twiki		 1606 May 21  1999 viewfile
-rw-r-xr-x	1 twiki	twiki		27794 Feb 26 06:03 wiki.pm
-rw-r-xr-x	1 twiki	twiki		10143 Feb 27 04:03 wikicfg.pm
-rw-r-xr-x	1 twiki	twiki		 5440 Feb  7 04:36 wikisearch.pm

directory twiki/templates/ :

drwxr-xr-x	7 twiki	twiki		 1024 Jan 16 19:39 .
drwxr-xr-x	8 twiki	twiki		 1024 Feb 26 04:20 ..
drwxr-xr-x	2 twiki	twiki		 1024 Jun  8  1999 Know
drwxr-xr-x	2 twiki	twiki		 1024 Dec  9  1998 Main
-rw-r--r--	1 twiki	twiki		 2286 Feb 24 21:50 attach.tmpl
-rw-r--r--	1 twiki	twiki		 1272 Feb  8 16:07 attachtable.tmpl
-rw-r--r--	1 twiki	twiki		 1884 Feb 24 21:54 changes.tmpl
-rw-r--r--	1 twiki	twiki		 2242 Feb 24 21:33 edit.tmpl
-rw-r--r--	1 twiki	twiki		  965 Feb  8 16:07 mailnotify.tmpl
-rw-r--r--	1 twiki	twiki			30 Jan 14  1999 notedited.tmpl
-rw-r--r--	1 twiki	twiki		  934 Feb  8 16:07 notext.tmpl
-rw-r--r--	1 twiki	twiki		  899 Feb  8 16:07 notwiki.tmpl
-rw-r--r--	1 twiki	twiki		  299 Feb 24 21:58 noweb.tmpl
-rw-r--r--	1 twiki	twiki		  957 Feb 24 22:17 oops.tmpl
-rw-r--r--	1 twiki	twiki		  871 Feb 24 22:17 oopsdel.tmpl
-rw-r--r--	1 twiki	twiki		 1330 Feb 24 22:17 oopslocked.tmpl
-rw-r--r--	1 twiki	twiki		 1024 Feb 24 22:17 oopsregexist.tmpl
-rw-r--r--	1 twiki	twiki		  912 Feb 24 22:17 oopsregpasswd.tmpl
-rw-r--r--	1 twiki	twiki		  923 Feb 24 22:17 oopsregrequ.tmpl
-rw-r--r--	1 twiki	twiki		 1125 Feb 24 22:17 oopsregthanks.tmpl
-rw-r--r--	1 twiki	twiki		  942 Feb 24 22:17 oopsregwiki.tmpl
-rw-r--r--	1 twiki	twiki		 1564 Feb 24 22:17 oopsrev.tmpl
-rw-r--r--	1 twiki	twiki		  906 Feb 24 22:17 oopsupload.tmpl
-rw-r--r--	1 twiki	twiki		 1535 Feb 24 22:02 preview.tmpl
-rw-r--r--	1 twiki	twiki		 1661 Feb 24 22:04 rdiff.tmpl
-rw-r--r--	1 twiki	twiki		  263 Aug  3  1999 register.tmpl
-rw-r--r--	1 twiki	twiki		  936 Feb  8 16:08 registernotify.tmpl
-rw-r--r--	1 twiki	twiki		 1779 Feb 24 22:06 search.tmpl
-rw-r--r--	1 twiki	twiki		 1533 Feb 24 21:43 view.tmpl

directory twiki/templates/Main :

drwxr-xr-x	2 twiki	twiki		 1024 Dec  9  1998 .
drwxr-xr-x	7 twiki	twiki		 1024 Jan 16 19:39 ..
-rw-r--r--	1 twiki	twiki		 2732 Feb 24 21:34 edit.tmpl

directory twiki/templates/Know (has a TWiki Category Table) :

drwxr-xr-x	2 twiki	twiki		 1024 Jun  8  1999 .
drwxr-xr-x	7 twiki	twiki		 1024 Jan 16 19:39 ..
-rw-rw-r--	1 twiki	twiki		  446 Jun  8  1999 notedited.tmpl
-rw-rw-r--	1 twiki	twiki		  206 Jun  8  1999 twikicatedit.tmpl
-rw-rw-r--	1 twiki	twiki		 1060 Jul 16  1999 twikicatitems.tmpl
-rw-rw-r--	1 twiki	twiki		  231 Jun  8  1999 twikicatview.tmpl

directory twiki/data/ :

drwxrwxrwx	8 twiki	twiki		 1024 Feb 26 04:17 .
drwxr-xr-x	8 twiki	twiki		 1024 Feb 26 04:20 ..
-rw-r--r--	1 nobody  nobody		2241 Feb 25 20:18 .htpasswd
drwxrwxrwx	2 twiki	twiki		 3072 Feb 27 01:15 Know
drwxrwxrwx	2 twiki	twiki		 9216 Feb 27 18:16 Main
-rw-rw-rw-	1 twiki	twiki			 1 Feb 26 06:01 debug.txt
-rw-r--r--	1 nobody  nobody	1263064 Jan 31 23:13 log200001.txt
-rw-r--r--	1 nobody  nobody	1063398 Feb 27 18:33 log200002.txt

part of directory twiki/data/Main :

drwxrwxrwx	2 twiki	twiki		 9216 Feb 27 18:16 .
drwxrwxrwx	8 twiki	twiki		 1024 Feb 26 04:17 ..
-rw-rw-rw-	1 twiki	twiki		 5722 Feb 27 18:13 .changes
-rw-rw-rw-	1 twiki	twiki			 9 Feb 27 18:15 .mailnotify
-rw-r--r--	1 nobody  nobody	  26163 Feb 24 12:22 TWikiDocumentation.txt
-r--r--r--	1 nobody  nobody	  44133 Feb 24 12:22 TWikiDocumentation.txt,v
-rw-r--r--	1 nobody  nobody	  11661 Feb 27 18:13 TWikiHistory.txt
-r--r--r--	1 nobody  nobody	  18877 Feb 27 18:13 TWikiHistory.txt,v
-rw-r--r--	1 nobody  nobody		3029 Feb 26 04:46 TWikiPreferences.txt
-r--r--r--	1 nobody  nobody		3219 Feb 26 04:46 TWikiPreferences.txt,v
-rw-r--r--	1 nobody  nobody		7188 Feb 11 21:39 TWikiRegistration.txt
-r--r--r--	1 nobody  nobody		7375 Feb 11 21:39 TWikiRegistration.txt,v
-rw-r--r--	1 nobody  nobody		3180 Feb 25 20:19 TWikiUsers.txt
-r--r--r--	1 nobody  nobody	  16537 Feb 25 20:19 TWikiUsers.txt,v
-rw-r--r--	1 nobody  nobody		2613 Feb  7 04:47 TWikiVariables.txt
-r--r--r--	1 nobody  nobody		3125 Feb  7 04:47 TWikiVariables.txt,v
-rw-r--r--	1 nobody  nobody		2068 Feb 10 11:34 TWikiWeb.txt
-r--r--r--	1 nobody  nobody		3610 Feb 10 11:34 TWikiWeb.txt,v
-rw-r--r--	1 nobody  nobody		1677 Feb 26 05:11 TWikiWebsTable.txt
-r--r--r--	1 nobody  nobody		1866 Feb 26 05:11 TWikiWebsTable.txt,v
-rw-r--r--	1 nobody  nobody		2294 Feb 27 17:54 WebHome.txt
-r--r--r--	1 nobody  nobody		5282 Feb 27 17:54 WebHome.txt,v
-rw-r--r--	1 nobody  nobody		 586 Jan 17 01:05 WebNotify.txt
-r--r--r--	1 nobody  nobody		1629 Jan 17 01:05 WebNotify.txt,v
-rw-r--r--	1 nobody  nobody		1834 Feb 25 14:13 WebPreferences.txt
-r--r--r--	1 nobody  nobody		2023 Feb 25 14:13 WebPreferences.txt,v
-rw-r--r--	1 nobody  nobody		4407 Feb 11 21:08 WebSearch.txt
-r--r--r--	1 nobody  nobody	  10822 Feb 11 21:08 WebSearch.txt,v
-rw-r--r--	1 nobody  nobody		4416 Feb 27 00:00 WebStatistics.txt
-r--r--r--	1 nobody  nobody	  27759 Feb 27 00:00 WebStatistics.txt,v

directory twiki/pub/ :

drwxrwxrwx  11 twiki	twiki		 1024 Feb  8 18:10 .
drwxr-xr-x	8 twiki	twiki		 1024 Feb 26 04:20 ..
drwxrwxrwx	4 nobody  nobody		1024 Aug 28  1999 Know
drwxrwxrwx  19 nobody  nobody		1024 Feb 27 09:56 Main
-rw-r--r--	1 twiki	twiki		 1078 Jan 14 20:24 favicon.ico
drwxr-xr-x	2 twiki	twiki		 1024 Mar 27  1999 icn
-rw-r--r--	1 twiki	twiki		 3016 Sep 10 04:27 twikilogo.gif
-rw-r--r--	1 twiki	twiki		 5320 Sep 10 04:27 twikilogo1.gif
-rw-r--r--	1 twiki	twiki		 6125 Sep 10 04:27 twikilogo2.gif
-rw-r--r--	1 twiki	twiki		 7218 Sep 10 04:27 twikilogo3.gif
-rw-r--r--	1 twiki	twiki		 6710 Sep 11 02:21 twikilogo4.gif
-rw-r--r--	1 twiki	twiki		 2877 Jun 15  1999 wikiHome.gif

directory twiki/pub/icn/ :

drwxr-xr-x	2 twiki	twiki		 1024 Mar 27  1999 .
drwxrwxrwx  11 twiki	twiki		 1024 Feb  8 18:10 ..
-rw-r--r--	1 twiki	twiki		  801 Mar 27  1999 _filetypes.txt
-rw-r--r--	1 twiki	twiki		  143 Mar 27  1999 bat.gif
-rw-r--r--	1 twiki	twiki		  926 Mar 27  1999 bmp.gif
-rw-r--r--	1 twiki	twiki		  141 Mar 27  1999 c.gif
-rw-r--r--	1 twiki	twiki		  144 Mar 27  1999 dll.gif
-rw-r--r--	1 twiki	twiki		  152 Mar 27  1999 doc.gif
-rw-r--r--	1 twiki	twiki		  130 Mar 27  1999 else.gif
-rw-r--r--	1 twiki	twiki		  876 Mar 27  1999 exe.gif
-rw-r--r--	1 twiki	twiki		  147 Mar 27  1999 fon.gif
-rw-r--r--	1 twiki	twiki		  142 Mar 27  1999 h.gif
-rw-r--r--	1 twiki	twiki		  156 Mar 27  1999 hlp.gif
-rw-r--r--	1 twiki	twiki		  186 Mar 27  1999 html.gif
-rw-r--r--	1 twiki	twiki		  144 Mar 27  1999 java.gif
-rw-r--r--	1 twiki	twiki		  148 Mar 27  1999 mov.gif
-rw-r--r--	1 twiki	twiki		  150 Mar 27  1999 pdf.gif
-rw-r--r--	1 twiki	twiki		  146 Mar 27  1999 pl.gif
-rw-r--r--	1 twiki	twiki		  150 Mar 27  1999 ppt.gif
-rw-r--r--	1 twiki	twiki		  148 Mar 27  1999 ps.gif
-rw-r--r--	1 twiki	twiki		  148 Mar 27  1999 py.gif
-rw-r--r--	1 twiki	twiki		  130 Mar 27  1999 ram.gif
-rw-r--r--	1 twiki	twiki		  154 Mar 27  1999 reg.gif
-rw-r--r--	1 twiki	twiki		  147 Mar 27  1999 sh.gif
-rw-r--r--	1 twiki	twiki		  155 Mar 27  1999 sniff.gif
-rw-r--r--	1 twiki	twiki		  149 Mar 27  1999 ttf.gif
-rw-r--r--	1 twiki	twiki		  134 Mar 27  1999 txt.gif
-rw-r--r--	1 twiki	twiki		  154 Mar 27  1999 wav.gif
-rw-r--r--	1 twiki	twiki		  152 Mar 27  1999 wri.gif
-rw-r--r--	1 twiki	twiki		  152 Mar 27  1999 xls.gif
-rw-r--r--	1 twiki	twiki		  144 Mar 27  1999 zip.gif

-- PeterThoeny? - 21 Apr 2000

 
Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Proyecto META? Send feedback