none
[openafs-wiki.git] / TWiki / TWikiInstallationGuide.mdwn
index dd40869..3c99e7e 100644 (file)
@@ -1,3 +1,17 @@
+<div>
+  <ul>
+    <li><a href="#TWiki Installation Notes"> TWiki Installation Notes</a><ul>
+        <li><a href="#Standard Installation Steps"> Standard Installation Steps</a></li>
+        <li><a href="#Add New Rendering Rules  Variabl"> Add New Rendering Rules &amp; Variables</a></li>
+        <li><a href="#Enable Basic Authentication (.ht"> Enable Basic Authentication (.htaccess)</a></li>
+        <li><a href="#Generate Site Usage Statistics"> Generate Site Usage Statistics</a></li>
+        <li><a href="#Create a New Web"> Create a New Web</a></li>
+        <li><a href="#Contents of Directories"> Contents of Directories</a></li>
+      </ul>
+    </li>
+  </ul>
+</div>
+
 ## <a name="TWiki Installation Notes"></a> 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> )
@@ -41,7 +55,7 @@ These installation steps use the Apache web server on Linux as an example. TWiki
 
 Read <http://TWiki.org/cgi-bin/view/Codev/SourceForgeHowTo> in case you want to install TWiki on SourceForge.
 
-### <a name="Installation steps"></a> Installation steps
+### <a name="Standard Installation Steps"></a> 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.
@@ -83,8 +97,12 @@ Read <http://TWiki.org/cgi-bin/view/Codev/SourceForgeHowTo> in case you want to
 - Enable email notification of topic changes, [[Notification of Changes|Main/TWikiDocumentation#TWiki_Notification_of_Changes]] has more. Using your browser, edit also the [[WebNotify]] topic in all webs and set the users you want to notify.
 - Add the [TWiki:Main.PoweredByTWikiLogo](http://TWiki.org/cgi-bin/view/Main/PoweredByTWikiLogo) to your [[WebHome]] topic.
 
+### <a name="Add New Rendering Rules  Variabl"></a> Add New Rendering Rules &amp; 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` .
 
+### <a name="Enable Basic Authentication (.ht"></a> 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]](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:_** 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 section of `access.conf` for your `twiki/bin` directory.
@@ -92,6 +110,8 @@ Read <http://TWiki.org/cgi-bin/view/Codev/SourceForgeHowTo> in case you want to
     - **_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="Generate Site Usage Statistics"></a> 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.
@@ -103,6 +123,10 @@ Read <http://TWiki.org/cgi-bin/view/Codev/SourceForgeHowTo> in case you want to
     - 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`
 
+<a name="CreateWeb"></a>
+
+### <a name="Create a New Web"></a> 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` .