1b7b4dce0f1c3c7e07c774cfe5c8f282d97305e6
[openafs-wiki.git] / TWiki / TWikiInstallationGuide.mdwn
1 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.
2
3 **_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.
4
5 - Request the TWiki distribution (in Unix ZIP format) from <http://TWiki.SourceForge.net/download.html> .
6 - Create directory `/home/httpd/twiki` and unzip the TWiki distribution to this directory.
7 - 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.
8 - 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).
9 - Now add `ScriptAlias` for `/twiki/bin` and `Alias` for `/twiki` to `/etc/httpd/conf/srm-conf` . Example: <br />`ScriptAlias /twiki/bin/ /home/httpd/twiki/bin/`<br />`Alias /twiki/ /home/httpd/twiki/`
10 - Restart Apache by `/etc/rc.d/rc5.d/S85httpd restart` .
11 - Test if the `twiki/bin` directory is cgi-enabled:
12   - 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."`
13   - Execute the `testenv` script from your browser ( `http://your.domain.com/twiki/bin/testenv` ). It should show a table of all CGI environment variables.
14 - 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` ).
15 - 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.
16 - 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` .
17 - Set the file permission of all files below `twiki/data` to 666 ( `-rw-rw-rw-` ).
18 - Set the file permission of the `twiki/data` directory and all its subdirectories to 777 ( `drwxrwxrwx` ).
19 - Set the file permission of the `twiki/pub` directory to 777 ( `drwxrwxrwx` ).
20 - Edit the file `twiki/bin/wikicfg.pm` and set the variables at the beginning of the file to your needs.
21 - 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` .
22 - Point your browser at <http://your.domain.com/twiki/bin/view> and start wiki-ing away!
23 - 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.
24 - 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)
25 - Enable email notification of topic changes, [(3)](TWikiDocumentation#notification) has more.
26 - Add the [PoweredByTWikiLogo](http://TWiki.SourceForge.net/cgi-bin/view/Main/PoweredByTWikiLogo) if TWiki is installed on a public web server.
27
28 - 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` .
29
30 - Optional: If you are on a public server and you would like to authenticate users:
31   - 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.
32   - 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.
33
34 - Optional: You can automatically generate usage statistics for all webs. To enable this:
35   - Make sure variable `$doLogTopicView, $doLogTopicSave and $doLogTopicUpload` in `wikicfg.pm` are set. This will generate log entries in file `twiki/data/log<date>.txt` .
36   - 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.
37   - Call the `twiki/bin/statistics` script from a cron job, once a day is recommended. This will update the [[WebStatistics]] topics in all webs.
38   - **_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)`
39   - 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)`
40   - The `twiki/bin/statistics` script can also be executed as a CGI script, just enter the URL in your browser. Examples:
41     - Update current month for all webs: <br />`http://mydomain.com/twiki/bin/statistics`
42     - Update current month for Main web only: <br />`http://mydomain.com/twiki/bin/statistics/Main`
43     - Update January 2000 for Main web: <br />`http://mydomain.com/twiki/bin/statistics/Main?logdate=200001`
44
45 - To create a new web:
46   - Use a name for the web consisting of characters `A..Z` , `a..z` but **not** in [[WikiNotation]].
47   - Create a new template directory under `twiki/templates` .
48   - Create a new data directory under `twiki/data` and check the file permission of the directory.
49   - 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.
50   - Add the new web to the web list (on top of each topic) by editing the site-level preferences [[TWikiPreferences]]:
51     - Add the new web to the WIKIWEBLIST variable.
52   - Add the new web to the web table (at the bottom of each [[WebHome]] topic) by editing the [[TWikiWebsTable]] topic.
53   - Change the web preferences by editing the WebPreferences topic of the new web:
54     - 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.)
55     - Customize the WEBTOPICLIST variable to contain the web specific links you prefer.
56     - Optional: Set the WEBCOPYRIGHT variable to have a web-specific copyright text (at the bottom of each topic).
57   - If needed, create customized templates in the new templates directory. (Non existing templates are inherited from `twiki/templates` )
58   - 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.
59   - 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.
60
61 Here are contents of directories with file permissions. Please note that this is for debugging reasons only and does not exactly reflect the distribution:
62
63 directory `twiki/bin` :
64
65     drwxr-xr-x  2 twiki twiki            1024 Feb 18 18:31 .
66     drwxr-xr-x  8 twiki twiki            1024 Feb 26 04:20 ..
67     -rw-rw-r--  1 twiki twiki             770 Feb 10 12:10 .htaccess
68     -rw-r-xr-x  1 twiki twiki            3968 Feb 18 00:26 attach
69     -rwxr-xr-x  1 twiki twiki            3033 Feb 17 23:57 changes
70     -rw-r-xr-x  1 twiki twiki            1377 Feb  8 18:18 delete
71     -rw-r-xr-x  1 twiki twiki            8785 Feb 17 23:58 edit
72     -rwxr--r--  1 twiki twiki            1811 Feb  4 14:31 geturl
73     -rwxr-xr-x  1 twiki twiki            5047 Feb  8 20:33 mailnotify
74     -rw-r-xr-x  1 twiki twiki            1825 Feb  8 18:29 oops
75     -rw-r-xr-x  1 twiki twiki            6932 Feb 11 02:06 preview
76     -rw-r-xr-x  1 twiki twiki            7804 Feb 17 23:59 rdiff
77     -rw-r-xr-x  1 twiki twiki            7010 Feb 18 00:03 register
78     -rw-r-xr-x  1 twiki twiki            2501 Jan 25 19:39 save
79     -rwxr-xr-x  1 twiki twiki            1778 Feb 18 00:04 search
80     -rw-r-xr-x  1 twiki twiki            9810 Feb  8 18:43 statistics
81     -rwxr-xr-x  1 twiki twiki             509 Feb  7 18:55 testenv
82     -rw-r-xr-x  1 twiki twiki            6856 Feb 18 00:11 upload
83     -rw-r-xr-x  1 twiki twiki            4922 Feb 17 23:54 view
84     -rw-r-xr-x  1 twiki twiki            1606 May 21  1999 viewfile
85     -rw-r-xr-x  1 twiki twiki           27794 Feb 26 06:03 wiki.pm
86     -rw-r-xr-x  1 twiki twiki           10143 Feb 27 04:03 wikicfg.pm
87     -rw-r-xr-x  1 twiki twiki            5440 Feb  7 04:36 wikisearch.pm
88
89 directory `twiki/templates/` :
90
91     drwxr-xr-x  7 twiki twiki            1024 Jan 16 19:39 .
92     drwxr-xr-x  8 twiki twiki            1024 Feb 26 04:20 ..
93     drwxr-xr-x  2 twiki twiki            1024 Jun  8  1999 Know
94     drwxr-xr-x  2 twiki twiki            1024 Dec  9  1998 Main
95     -rw-r--r--  1 twiki twiki            2286 Feb 24 21:50 attach.tmpl
96     -rw-r--r--  1 twiki twiki            1272 Feb  8 16:07 attachtable.tmpl
97     -rw-r--r--  1 twiki twiki            1884 Feb 24 21:54 changes.tmpl
98     -rw-r--r--  1 twiki twiki            2242 Feb 24 21:33 edit.tmpl
99     -rw-r--r--  1 twiki twiki             965 Feb  8 16:07 mailnotify.tmpl
100     -rw-r--r--  1 twiki twiki                   30 Jan 14  1999 notedited.tmpl
101     -rw-r--r--  1 twiki twiki             934 Feb  8 16:07 notext.tmpl
102     -rw-r--r--  1 twiki twiki             899 Feb  8 16:07 notwiki.tmpl
103     -rw-r--r--  1 twiki twiki             299 Feb 24 21:58 noweb.tmpl
104     -rw-r--r--  1 twiki twiki             957 Feb 24 22:17 oops.tmpl
105     -rw-r--r--  1 twiki twiki             871 Feb 24 22:17 oopsdel.tmpl
106     -rw-r--r--  1 twiki twiki            1330 Feb 24 22:17 oopslocked.tmpl
107     -rw-r--r--  1 twiki twiki            1024 Feb 24 22:17 oopsregexist.tmpl
108     -rw-r--r--  1 twiki twiki             912 Feb 24 22:17 oopsregpasswd.tmpl
109     -rw-r--r--  1 twiki twiki             923 Feb 24 22:17 oopsregrequ.tmpl
110     -rw-r--r--  1 twiki twiki            1125 Feb 24 22:17 oopsregthanks.tmpl
111     -rw-r--r--  1 twiki twiki             942 Feb 24 22:17 oopsregwiki.tmpl
112     -rw-r--r--  1 twiki twiki            1564 Feb 24 22:17 oopsrev.tmpl
113     -rw-r--r--  1 twiki twiki             906 Feb 24 22:17 oopsupload.tmpl
114     -rw-r--r--  1 twiki twiki            1535 Feb 24 22:02 preview.tmpl
115     -rw-r--r--  1 twiki twiki            1661 Feb 24 22:04 rdiff.tmpl
116     -rw-r--r--  1 twiki twiki             263 Aug  3  1999 register.tmpl
117     -rw-r--r--  1 twiki twiki             936 Feb  8 16:08 registernotify.tmpl
118     -rw-r--r--  1 twiki twiki            1779 Feb 24 22:06 search.tmpl
119     -rw-r--r--  1 twiki twiki            1533 Feb 24 21:43 view.tmpl
120
121 directory `twiki/templates/Main` :
122
123     drwxr-xr-x  2 twiki twiki            1024 Dec  9  1998 .
124     drwxr-xr-x  7 twiki twiki            1024 Jan 16 19:39 ..
125     -rw-r--r--  1 twiki twiki            2732 Feb 24 21:34 edit.tmpl
126
127 directory `twiki/templates/Know` (has a TWiki Category Table) :
128
129     drwxr-xr-x  2 twiki twiki            1024 Jun  8  1999 .
130     drwxr-xr-x  7 twiki twiki            1024 Jan 16 19:39 ..
131     -rw-rw-r--  1 twiki twiki             446 Jun  8  1999 notedited.tmpl
132     -rw-rw-r--  1 twiki twiki             206 Jun  8  1999 twikicatedit.tmpl
133     -rw-rw-r--  1 twiki twiki            1060 Jul 16  1999 twikicatitems.tmpl
134     -rw-rw-r--  1 twiki twiki             231 Jun  8  1999 twikicatview.tmpl
135
136 directory `twiki/data/` :
137
138     drwxrwxrwx  8 twiki twiki            1024 Feb 26 04:17 .
139     drwxr-xr-x  8 twiki twiki            1024 Feb 26 04:20 ..
140     -rw-r--r--  1 nobody  nobody                2241 Feb 25 20:18 .htpasswd
141     drwxrwxrwx  2 twiki twiki            3072 Feb 27 01:15 Know
142     drwxrwxrwx  2 twiki twiki            9216 Feb 27 18:16 Main
143     -rw-rw-rw-  1 twiki twiki                    1 Feb 26 06:01 debug.txt
144     -rw-r--r--  1 nobody  nobody        1263064 Jan 31 23:13 log200001.txt
145     -rw-r--r--  1 nobody  nobody        1063398 Feb 27 18:33 log200002.txt
146
147 part of directory `twiki/data/Main` :
148
149     drwxrwxrwx  2 twiki twiki            9216 Feb 27 18:16 .
150     drwxrwxrwx  8 twiki twiki            1024 Feb 26 04:17 ..
151     -rw-rw-rw-  1 twiki twiki            5722 Feb 27 18:13 .changes
152     -rw-rw-rw-  1 twiki twiki                    9 Feb 27 18:15 .mailnotify
153     -rw-r--r--  1 nobody  nobody          26163 Feb 24 12:22 TWikiDocumentation.txt
154     -r--r--r--  1 nobody  nobody          44133 Feb 24 12:22 TWikiDocumentation.txt,v
155     -rw-r--r--  1 nobody  nobody          11661 Feb 27 18:13 TWikiHistory.txt
156     -r--r--r--  1 nobody  nobody          18877 Feb 27 18:13 TWikiHistory.txt,v
157     -rw-r--r--  1 nobody  nobody                3029 Feb 26 04:46 TWikiPreferences.txt
158     -r--r--r--  1 nobody  nobody                3219 Feb 26 04:46 TWikiPreferences.txt,v
159     -rw-r--r--  1 nobody  nobody                7188 Feb 11 21:39 TWikiRegistration.txt
160     -r--r--r--  1 nobody  nobody                7375 Feb 11 21:39 TWikiRegistration.txt,v
161     -rw-r--r--  1 nobody  nobody                3180 Feb 25 20:19 TWikiUsers.txt
162     -r--r--r--  1 nobody  nobody          16537 Feb 25 20:19 TWikiUsers.txt,v
163     -rw-r--r--  1 nobody  nobody                2613 Feb  7 04:47 TWikiVariables.txt
164     -r--r--r--  1 nobody  nobody                3125 Feb  7 04:47 TWikiVariables.txt,v
165     -rw-r--r--  1 nobody  nobody                2068 Feb 10 11:34 TWikiWeb.txt
166     -r--r--r--  1 nobody  nobody                3610 Feb 10 11:34 TWikiWeb.txt,v
167     -rw-r--r--  1 nobody  nobody                1677 Feb 26 05:11 TWikiWebsTable.txt
168     -r--r--r--  1 nobody  nobody                1866 Feb 26 05:11 TWikiWebsTable.txt,v
169     -rw-r--r--  1 nobody  nobody                2294 Feb 27 17:54 WebHome.txt
170     -r--r--r--  1 nobody  nobody                5282 Feb 27 17:54 WebHome.txt,v
171     -rw-r--r--  1 nobody  nobody                 586 Jan 17 01:05 WebNotify.txt
172     -r--r--r--  1 nobody  nobody                1629 Jan 17 01:05 WebNotify.txt,v
173     -rw-r--r--  1 nobody  nobody                1834 Feb 25 14:13 WebPreferences.txt
174     -r--r--r--  1 nobody  nobody                2023 Feb 25 14:13 WebPreferences.txt,v
175     -rw-r--r--  1 nobody  nobody                4407 Feb 11 21:08 WebSearch.txt
176     -r--r--r--  1 nobody  nobody          10822 Feb 11 21:08 WebSearch.txt,v
177     -rw-r--r--  1 nobody  nobody                4416 Feb 27 00:00 WebStatistics.txt
178     -r--r--r--  1 nobody  nobody          27759 Feb 27 00:00 WebStatistics.txt,v
179
180 directory `twiki/pub/` :
181
182     drwxrwxrwx  11 twiki        twiki            1024 Feb  8 18:10 .
183     drwxr-xr-x  8 twiki twiki            1024 Feb 26 04:20 ..
184     drwxrwxrwx  4 nobody  nobody                1024 Aug 28  1999 Know
185     drwxrwxrwx  19 nobody  nobody               1024 Feb 27 09:56 Main
186     -rw-r--r--  1 twiki twiki            1078 Jan 14 20:24 favicon.ico
187     drwxr-xr-x  2 twiki twiki            1024 Mar 27  1999 icn
188     -rw-r--r--  1 twiki twiki            3016 Sep 10 04:27 twikilogo.gif
189     -rw-r--r--  1 twiki twiki            5320 Sep 10 04:27 twikilogo1.gif
190     -rw-r--r--  1 twiki twiki            6125 Sep 10 04:27 twikilogo2.gif
191     -rw-r--r--  1 twiki twiki            7218 Sep 10 04:27 twikilogo3.gif
192     -rw-r--r--  1 twiki twiki            6710 Sep 11 02:21 twikilogo4.gif
193     -rw-r--r--  1 twiki twiki            2877 Jun 15  1999 wikiHome.gif
194
195 directory `twiki/pub/icn/` :
196
197     drwxr-xr-x  2 twiki twiki            1024 Mar 27  1999 .
198     drwxrwxrwx  11 twiki        twiki            1024 Feb  8 18:10 ..
199     -rw-r--r--  1 twiki twiki             801 Mar 27  1999 _filetypes.txt
200     -rw-r--r--  1 twiki twiki             143 Mar 27  1999 bat.gif
201     -rw-r--r--  1 twiki twiki             926 Mar 27  1999 bmp.gif
202     -rw-r--r--  1 twiki twiki             141 Mar 27  1999 c.gif
203     -rw-r--r--  1 twiki twiki             144 Mar 27  1999 dll.gif
204     -rw-r--r--  1 twiki twiki             152 Mar 27  1999 doc.gif
205     -rw-r--r--  1 twiki twiki             130 Mar 27  1999 else.gif
206     -rw-r--r--  1 twiki twiki             876 Mar 27  1999 exe.gif
207     -rw-r--r--  1 twiki twiki             147 Mar 27  1999 fon.gif
208     -rw-r--r--  1 twiki twiki             142 Mar 27  1999 h.gif
209     -rw-r--r--  1 twiki twiki             156 Mar 27  1999 hlp.gif
210     -rw-r--r--  1 twiki twiki             186 Mar 27  1999 html.gif
211     -rw-r--r--  1 twiki twiki             144 Mar 27  1999 java.gif
212     -rw-r--r--  1 twiki twiki             148 Mar 27  1999 mov.gif
213     -rw-r--r--  1 twiki twiki             150 Mar 27  1999 pdf.gif
214     -rw-r--r--  1 twiki twiki             146 Mar 27  1999 pl.gif
215     -rw-r--r--  1 twiki twiki             150 Mar 27  1999 ppt.gif
216     -rw-r--r--  1 twiki twiki             148 Mar 27  1999 ps.gif
217     -rw-r--r--  1 twiki twiki             148 Mar 27  1999 py.gif
218     -rw-r--r--  1 twiki twiki             130 Mar 27  1999 ram.gif
219     -rw-r--r--  1 twiki twiki             154 Mar 27  1999 reg.gif
220     -rw-r--r--  1 twiki twiki             147 Mar 27  1999 sh.gif
221     -rw-r--r--  1 twiki twiki             155 Mar 27  1999 sniff.gif
222     -rw-r--r--  1 twiki twiki             149 Mar 27  1999 ttf.gif
223     -rw-r--r--  1 twiki twiki             134 Mar 27  1999 txt.gif
224     -rw-r--r--  1 twiki twiki             154 Mar 27  1999 wav.gif
225     -rw-r--r--  1 twiki twiki             152 Mar 27  1999 wri.gif
226     -rw-r--r--  1 twiki twiki             152 Mar 27  1999 xls.gif
227     -rw-r--r--  1 twiki twiki             144 Mar 27  1999 zip.gif
228
229 -- [[PeterThoeny]] - 24 May 2000 <br />