-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.
+<div>
+ <ul>
+ <li><a href="#TWiki Installation Guide"> TWiki Installation Guide</a><ul>
+ <li><a href="#Standard Installation"> Standard Installation</a><ul>
+ <li><a href="#Step 1: Create Configure the Di"> Step 1: Create & Configure the Directories</a><ul>
+ <li><a href="#Step 1 for Non-Root Accounts"> Step 1 for Non-Root Accounts</a></li>
+ </ul>
+ </li>
+ <li><a href="#Step 2: Set File Permissions"> Step 2: Set File Permissions</a></li>
+ <li><a href="#Step 3: Set the Main Configurati"> Step 3: Set the Main Configuration File</a></li>
+ <li><a href="#Step 4: Configure Site-Wide Emai"> Step 4: Configure Site-Wide Email Preferences</a></li>
+ <li><a href="#Step 5: Finish Up from Your Brow"> Step 5: Finish Up from Your Browser</a></li>
+ </ul>
+ </li>
+ <li><a href="#Additional Server-Level Options"> Additional Server-Level Options</a><ul>
+ <li><a href="#Enabling Authentication of Users"> Enabling Authentication of Users</a></li>
+ </ul>
+ </li>
+ <li><a href="#TWiki File System Info"> TWiki File System Info</a></li>
+ </ul>
+ </li>
+ </ul>
+</div>
+
+# <a name="TWiki Installation Guide"></a> TWiki Installation Guide
+
+_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|Main/TWikiSystemRequirements]]. Documentation for other platforms is somewhat limited:
+
+- For Unix or Linux, check TWiki:Codev/TWikiOnUnix and TWiki:Codev/TWikiOnLinux.
+- For Windows, check the [[WindowsInstallCookbook]].
+- For MacOS X, check TWiki:Codev/TWikiOnMacOSX.
+- To install TWiki on SourceForge, for use on a software development project, read TWiki:Codev/TWikiOnSourceForge
+- For other platforms, see TWiki:Codev/TWikiOn, and search the TWiki:Codev and TWiki:Support webs for other installation notes.
+
+<a name="StandardInstallation"></a>
+
+## <a name="Standard Installation"></a> Standard Installation
+
+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.
+
+### <a name="Step 1: Create Configure the Di"></a> Step 1: Create & Configure the Directories
+
+%X% **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|Main/WebHome#StepOneB]] instead._
+
+- Create directory `/home/httpd/twiki` and [unzip](http://www.info-zip.org/pub/infozip/UnZip.html) 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` . <br /> %X% **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>
-**_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` 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."`
- - 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)](TWikiDocumentation#notification) has more.
-- Add the [PoweredByTWikiLogo](http://TWiki.SourceForge.net/cgi-bin/view/Main/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]](http://www.scs.nevada.edu/cs/documents/web/htaccess.html), [[2]](http://www.mcs.kent.edu/system/web_help/htaccess/introduction.html), [[3]](http://www.apache.org/docs/mod/directives.html)). **_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: <br />`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: <br />`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: <br />`http://mydomain.com/twiki/bin/statistics`
- - Update current month for Main web only: <br />`http://mydomain.com/twiki/bin/statistics/Main`
- - Update January 2000 for Main web: <br />`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 <br />
+- 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.
+
+- _Go directly to [[Step 2|Main/WebHome#StepTwo]]..._
+
+<a name="StepOneB"></a>
+
+#### <a name="Step 1 for Non-Root Accounts"></a> Step 1 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`)
+
+> <table border="1" cellpadding="0" cellspacing="0">
+> <tr>
+> <th bgcolor="#99CCCC"><strong> TWiki dir: </strong></th>
+> <th bgcolor="#99CCCC"><strong> What it is: </strong></th>
+> <th bgcolor="#99CCCC"><strong> Where to copy: </strong></th>
+> <th bgcolor="#99CCCC"><strong> Example: </strong></th>
+> </tr>
+> <tr>
+> <td><code>twiki</code></td>
+> <td> start-up pages </td>
+> <td> root TWiki dir </td>
+> <td><code>/home/smith/twiki/</code></td>
+> </tr>
+> <tr>
+> <td><code>twiki/bin</code></td>
+> <td> CGI bin </td>
+> <td> CGI-enabled dir </td>
+> <td><code>/home/smith/twiki/bin</code></td>
+> </tr>
+> <tr>
+> <td><code>twiki/lib</code></td>
+> <td> library files </td>
+> <td> same level as <code>twiki/bin</code></td>
+> <td><code>/home/smith/twiki/lib</code></td>
+> </tr>
+> <tr>
+> <td><code>twiki/pub</code></td>
+> <td> public files </td>
+> <td> htdoc enabled dir </td>
+> <td><code>/home/smith/twiki/pub</code></td>
+> </tr>
+> <tr>
+> <td><code>twiki/data</code></td>
+> <td> topic data </td>
+> <td> dir secure from public access </td>
+> <td><code>/home/smith/twiki/data</code></td>
+> </tr>
+> <tr>
+> <td><code>twiki/templates</code></td>
+> <td> web templates </td>
+> <td> dir secure from public access </td>
+> <td><code>/home/smith/twiki/templates</code></td>
+> </tr>
+> </table>
+
+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:
+
+<pre>
+ # -------------- Change these settings if required
+
+ $twikiLibPath = <font color="red">'/some/other/path/lib'</font>; # Path to lib directory containing TWiki.pm
+
+</pre>
+
+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.
+
+<a name="StepTwo"></a>
+
+### <a name="Step 2: Set File Permissions"></a> 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, 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.
+- %H% 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`).
+ - %T% **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`.
+- %H% 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
+> perl -pi~ -e 's/nobody:/www-data:/' */*,v
+
+### <a name="Step 3: Set the Main Configurati"></a> 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.
+ - 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.
+
+### <a name="Step 4: Configure Site-Wide Emai"></a> 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 <code>**Net::SMTP**</code> 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 <code>**$mailProgram**</code> in <code>**TWiki.cfg**</code>).
+ - `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, <code>**Net::SMTP**</code> will guess it for you.
+- You may want to set up other [[TWikiPreferences]] later on.
+
+### <a name="Step 5: Finish Up from Your Brow"></a> Step 5: Finish Up from Your Browser
+
+- Point your Web browser at `http://yourdomain.com/twiki/bin/view` and start TWiki-ing away!
+ - %T% 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 [[WebHome]] topic.
+- You can add new `%VARIABLES%`. Define site-level variables in the [[TWikiPreferences]] topic. See also: [[TWikiVariables]].
+
+That's it for the standard virgin installation of TWiki. Read on for server-level customization options.
+
+## <a name="Additional Server-Level Options"></a> 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.
+
+<a name="AuthenticationOfUsers"></a>
+
+### <a name="Enabling Authentication of Users"></a> 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]](http://www.apache.org/docs/mod/directives.html), [[2]](http://www.mcs.kent.edu/system/web_help/htaccess/introduction.html)). In particular, the following <font>red</font> part needs to be configured correctly: <br /><code>Redirect <font>/urlpathto/twiki/index.html</font> http://<font>yourdomain.com/urlpathto/twiki/bin/</font>view</code><br /><code>AuthUserFile <font>/filepathto/twiki/data/</font>.htpasswd</code><br /><code>ErrorDocument 401 <font>/urlpathto/twiki/bin/</font>oops/TWiki/TWikiRegistration?template=oopsauth</code>
+ - %X% **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`.
+ - %H% The browser should ask for login name and password when you click on the <u>Edit</u> link. In case `.htaccess` does not have the desired effect, you need to enable it: Add "AllowOverride All" to the Directory [[3]](http://httpd.apache.org/docs/mod/core.html#directory) 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.
+ - %X% **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. **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]].
+- Register yourself in the [[TWikiRegistration]] topic.
+ - %X% **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.
+
+That's it for a basic new web set-up!
+
+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.
+
+%X% **NOTE:** User home topics are located in the %WIKITOOLNAME%.Main web - don't try to move them or create them in other webs. From any other web, user signatures have to point to %WIKITOOLNAME%.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!
+
+## <a name="TWiki File System Info"></a> TWiki File System Info
+
+See [[Appendix A: TWiki File System|Main/AppendixFileSystem]] for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
+
+-- [[PeterThoeny]] - 28 Dec 2002 <br /> -- [[MikeMannix]] - 16 May 2002
git://git.openafs.org / openafs-wiki.git / blobdiff