</ul>
</div>
-## <a name="TWiki Installation Guide"></a> TWiki Installation Guide
+# <a name="TWiki Installation Guide"></a> TWiki Installation Guide
_Clean install of the current public release (01-Sep-2001)_
-### <a name="Overview"></a> Overview
+## <a name="Overview"></a> 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>.)
Read <http://TWiki.org/cgi-bin/view/Codev/SourceForgeHowTo> in case you want to install TWiki on SourceForge.
-### <a name="Standard Installation"></a> Standard Installation
+## <a name="Standard Installation"></a> Standard Installation
Request and download the TWiki %VERSION% distribution in Unix ZIP format from <http://TWiki.org/download.html>.
-#### <a name="Step 1: Create Configure the Di"></a> Step 1: Create & Configure the Directories
+### <a name="Step 1: Create Configure the Di"></a> 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.
> Allow from all
> </Directory>
-#### <a name="Step 2: Check the Server Directo"></a> Step 2: Check the Server Directory Settings
+### <a name="Step 2: Check the Server Directo"></a> 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 <code>**twiki/bin/wikicfg.pm**</code> configuration file.
-#### <a name="Step 3: Enable Perl File Permiss"></a> Step 3: Enable Perl File Permissions
+### <a name="Step 3: Enable Perl File Permiss"></a> 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 <code>**twiki/bin**</code> directory must be changed (alternatively you can create a symbolic link from <code>**/usr/bin/perl**</code> ).
- **IMPORTANT:** On most ISP virtual domain accounts, Perl CGI scripts require a <code>**.cgi**</code> extension to run. Some systems need <code>**.pl**</code>, the regular Perl extension. Change all <code>**twiki/bin**</code> scripts appropriately if necssary.
- Set the permission of the <code>**twiki/data**</code> directory and its subdirectories so that files in there are writable by user <code>**nobody**</code>. A simple way is to chmod them to <code>**drwxrwxrwx**</code> (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 <code>**drwxrwxrwx**</code> (777).
-#### <a name="Step 4: Set the Main Configurati"></a> Step 4: Set the Main Configuration File
+### <a name="Step 4: Set the Main Configurati"></a> Step 4: Set the Main Configuration File
- Edit the file <code>**twiki/bin/wikicfg.pm**</code> and set the variables at the beginning of the file to your needs.
- Set the file extension in the `$scriptSuffix` variable to <code>**cgi**</code> or <code>**pl**</code> if required.
- Enable email notification of topic changes, [[Notification of Changes|Main/TWikiDocumentation#TWiki_Notification_of_Changes]] has more.
- Add the [TWiki:Main.PoweredByTWikiLogo](http://TWiki.org/cgi-bin/view/Main/PoweredByTWikiLogo) to your [[WebHome]] topic.
-#### <a name="Step 5: Finish Up from Your Brow"></a> Step 5: Finish Up from Your Browser
+### <a name="Step 5: Finish Up from Your Brow"></a> Step 5: Finish Up from Your Browser
- Point your Web browser at <code>**http://your.domain.com/twiki/bin/view**</code> 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.
That's it for the standard virgin installation of TWiki. Read on to learn how to customize TWiki.
-### <a name="Extra Server-Level Options"></a> Extra Server-Level Options
+## <a name="Extra Server-Level Options"></a> 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.
<a name="CreateWeb"></a>
-#### <a name="Creating a New Web"></a> Creating a New Web
+### <a name="Creating a New Web"></a> 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]].
- 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 %WIKITOOLNAME%.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 %WIKITOOLNAME%.Main web like `Main.UserName` or `%MAINWEB%.UserName`.
-#### <a name="Adding Variables Rendering Rule"></a> Adding Variables & Rendering Rules
+### <a name="Adding Variables Rendering Rule"></a> 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` .
-#### <a name="Enabling Basic Authentication (."></a> Enabling Basic Authentication (.htaccess)
+### <a name="Enabling Basic Authentication (."></a> 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]](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>/urlpath/to/TWiki/index.html</font> http://<font>your.domain.com/urlpath/to/TWiki/bin/</font>view</code><br /><code>AuthUserFile <font>/filepath/to/TWiki/data/</font>.htpasswd</code><br /><code>ErrorDocument 401 <font>/urlpath/to/TWiki/bin/</font>oops/TWiki/TWikiRegistration?template=oopsauth</code>
- **_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.
-### <a name="TWiki File System Snapshot"></a> TWiki File System Snapshot
+## <a name="TWiki File System Snapshot"></a> 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|TWiki/TWikiImplementationNotes]], with individual file descriptions, for the current TWiki release.
-rw-rw-r-- 1 twiki twiki 144 Mar 9 1999 dll.gif
-rw-rw-r-- 1 twiki twiki 152 Mar 9 1999 doc.gif
--- [[PeterThoeny]] - 16 Mar 2001 <br />
+-- [[MikeMannix]] - 07 Sep 2001 <br />
git://git.openafs.org / openafs-wiki.git / blobdiff