summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Thoeny <web-hurd@gnu.org>2000-11-12 08:54:34 +0000
committerPeter Thoeny <web-hurd@gnu.org>2000-11-12 08:54:34 +0000
commitae3b1a84dd63cd193d0e1f95f7ad3ca29c56edaa (patch)
tree871cd879629950752261a0479f9fbd1244af7998
parent4f63d864bdc2705b8946270b5c6fcce38d01f69e (diff)
none
-rw-r--r--TWiki/TWikiInstallationGuide.mdwn45
1 files changed, 44 insertions, 1 deletions
diff --git a/TWiki/TWikiInstallationGuide.mdwn b/TWiki/TWikiInstallationGuide.mdwn
index 728fa682..eb492bc4 100644
--- a/TWiki/TWikiInstallationGuide.mdwn
+++ b/TWiki/TWikiInstallationGuide.mdwn
@@ -1,6 +1,45 @@
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.
+**_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:
+
+<table border="1" cellpadding="1" 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/bin</code></td>
+ <td> CGI bin </td>
+ <td> cgi-bin enabled dir </td>
+ <td><code>/home/smith/public_html/cgi-bin/twiki</code></td>
+ </tr>
+ <tr>
+ <td><code>twiki/pub</code></td>
+ <td> public files </td>
+ <td> htdoc enabled dir </td>
+ <td><code>/home/smith/public_html/pub</code></td>
+ </tr>
+ <tr>
+ <td><code>twiki/data</code></td>
+ <td> topic data </td>
+ <td> outside of htdoc tree (for security) </td>
+ <td><code>/home/smith/twiki/data</code></td>
+ </tr>
+ <tr>
+ <td><code>twiki/templates</code></td>
+ <td> web templates </td>
+ <td> outside of htdoc tree (for security) </td>
+ <td><code>/home/smith/twiki/templates</code></td>
+ </tr>
+</table>
+
+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.
@@ -35,6 +74,10 @@ These installation steps use the Apache web server on Linux as an example. TWiki
* 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!
+* 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: <br />`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](TWikiDocumentation#notification) has more.