none
authorMikeMannix <MikeMannix>
Thu, 16 May 2002 05:24:00 +0000 (05:24 +0000)
committerMikeMannix <MikeMannix>
Thu, 16 May 2002 05:24:00 +0000 (05:24 +0000)
TWiki/TWikiInstallationGuide.mdwn

index 86d919d..23dc66e 100644 (file)
@@ -24,7 +24,7 @@
 
 # <a name="TWiki Installation Guide"></a> TWiki Installation Guide
 
-_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|Main/TWikiImplementationNotes]]. Documentation for other platforms is currently limited. For Windows, check TWiki:Codev/TWikiOnWindows. Search the TWiki:Codev web for other intallation notes.
 
@@ -32,7 +32,7 @@ These installation steps are based on the Apache Web server on Linux. TWiki runs
 
 ## <a name="Standard Installation"></a> 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 .)_
+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 .)_
 
 ### <a name="Step 1: Create  Configure the Di"></a> Step 1: Create &amp; Configure the Directories
 
@@ -148,11 +148,15 @@ To install TWiki on a system where you don't have server administrator privilege
 > cd twiki/data
 >     for f in */*,v; do sed 's/nobody\:/www-data\:/' $f > x; mv -f x $f; done
 
+Note that this is not required if you use the Perl based RCS implementation - see _Dataframework_.
+
 ### <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.
-  - 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.
 
@@ -180,7 +184,7 @@ With your new TWiki installation up and running, you can manage most aspects of
     - %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, 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.
+    - %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]]. 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.
     - %T% **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.
@@ -219,6 +223,6 @@ Optionally, you can also:
 
 ## <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.
+See [[Appendix A: TWiki File System|Main/AppendixFileSystem]] for an installed system snapshot and descriptions of all files in the TWiki 01-Dec-2001 distribution.
 
--- [[PeterThoeny]] - 13 Sep 2001 <br /> -- [[MikeMannix]] - 27 Jan 2002
+-- [[PeterThoeny]] - 13 Sep 2001 <br /> -- [[MikeMannix]] - 16 May 2002