b1d46fb8b105e70781a234c8903b4111b8b674c2
[openafs-wiki.git] / TWiki / TWikiInstallationGuide.mdwn
1 <div>
2   <ul>
3     <li><a href="#TWiki Installation Guide"> TWiki Installation Guide</a><ul>
4         <li><a href="#Overview"> Overview</a></li>
5         <li><a href="#Standard Installation"> Standard Installation</a><ul>
6             <li><a href="#Step 1: Create  Configure the Di"> Step 1: Create &amp; Configure the Directories</a><ul>
7                 <li><a href="#Step 1 for Non-Root Accounts"> Step 1 for Non-Root Accounts</a></li>
8               </ul>
9             </li>
10             <li><a href="#Step 2: Set File Permissions"> Step 2: Set File Permissions</a></li>
11             <li><a href="#Step 3: Set the Main Configurati"> Step 3: Set the Main Configuration File</a></li>
12             <li><a href="#Step 4: Finish Up from Your Brow"> Step 4: Finish Up from Your Browser</a></li>
13           </ul>
14         </li>
15         <li><a href="#Additional Server-Level Options"> Additional Server-Level Options</a><ul>
16             <li><a href="#Enabling Authentication of Users"> Enabling Authentication of Users</a></li>
17             <li><a href="#Adding a New Web"> Adding a New Web</a></li>
18           </ul>
19         </li>
20         <li><a href="#TWiki File System Info"> TWiki File System Info</a></li>
21       </ul>
22     </li>
23   </ul>
24 </div>
25
26 # <a name="TWiki Installation Guide"></a> TWiki Installation Guide
27
28 _Installation instructions for the TWiki 01-Sep-2001 production release_
29
30 ## <a name="Overview"></a> Overview
31
32 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.
33
34 <a name="StandardInstallation"></a>
35
36 ## <a name="Standard Installation"></a> Standard Installation
37
38 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.)_
39
40 ### <a name="Step 1: Create  Configure the Di"></a> Step 1: Create &amp; Configure the Directories
41
42 **_NOTE:_** _If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the [[alternative Step 1|Main/WebHome#StepOneB]] instead._
43
44 - Create directory `/home/httpd/twiki` and unzip the TWiki distribution into this directory.
45 - 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.
46 - The `twiki/pub` directory of TWiki must be set so that it is visible as a URL. Add `/home/httpd/twiki` to file `httpd.conf` with normal access options (copy from `/home/httpd/html` ).
47 - Now add `ScriptAlias` for `/twiki/bin` and `Alias` for `/twiki` to file `httpd.conf` . <br />**_NOTE:_** The `ScriptAlias` **_must_** come before the `Alias`, otherwise, Apache will fail to correctly set up `/twiki/bin/`, by treating it as just another subdirectory of the `/twiki/` alias.
48
49 > **Example `httpd.conf` entries:**
50 >
51 >      ScriptAlias /twiki/bin/ "/home/httpd/twiki/bin/"
52 >      Alias /twiki/ "/home/httpd/twiki/"
53 >      <Directory "/home/httpd/twiki/bin">
54 >        Options +ExecCGI
55 >        SetHandler cgi-script
56 >        Allow from all
57 >      </Directory>
58 >      <Directory "/home/httpd/twiki/pub">
59 >        Options FollowSymLinks +Includes
60 >        AllowOverride None
61 >        Allow from all
62 >      </Directory>
63
64 - Restart Apache by `/etc/rc.d/rc5.d/S85httpd restart` .
65 - Test that the `twiki/bin` directory is CGI-enabled by trying visiting it in your browser:
66   - Enter the URL for the `bin` directory, `http://yourdomain.com/twiki/bin/`.
67   - Your settings are OK if you get a message like `"Forbidden. You don't have permission to access /twiki/bin/ on this server"`.
68   - Settings are NOT correct if you get something like `"Index of /twiki/bin"` - recheck your `httpd.conf` file.
69
70 - _Go directly to [[Step 2|Main/WebHome#StepTwo]]..._
71
72 <a name="StepOneB"></a>
73
74 #### <a name="Step 1 for Non-Root Accounts"></a> Step 1 for Non-Root Accounts
75
76 To install TWiki on a system where you don't have server administrator privileges, for example, on a hosted Web account:
77
78 - Download and unzip TWiki on your local PC
79 - Using the table below, create a directory structure on your host server
80 - Upload the TWiki files by FTP (transfer as _text_ except for the image files in `pub`)
81
82 > <table border="1" cellpadding="0" cellspacing="0">
83 >   <tr>
84 >     <th bgcolor="#99CCCC"><strong> TWiki dir: </strong></th>
85 >     <th bgcolor="#99CCCC"><strong> What it is: </strong></th>
86 >     <th bgcolor="#99CCCC"><strong> Where to copy: </strong></th>
87 >     <th bgcolor="#99CCCC"><strong> Example: </strong></th>
88 >   </tr>
89 >   <tr>
90 >     <td><code>twiki/bin</code></td>
91 >     <td> CGI bin </td>
92 >     <td> cgi-enabled dir </td>
93 >     <td><code>/home/smith/public_html/cgi-bin</code></td>
94 >   </tr>
95 >   <tr>
96 >     <td><code>twiki/lib</code></td>
97 >     <td> library files </td>
98 >     <td> same level as <code>twiki/bin</code></td>
99 >     <td><code>/home/smith/public_html/lib</code></td>
100 >   </tr>
101 >   <tr>
102 >     <td><code>twiki/pub</code></td>
103 >     <td> public files </td>
104 >     <td> htdoc enabled dir </td>
105 >     <td><code>/home/smith/public_html/pub</code></td>
106 >   </tr>
107 >   <tr>
108 >     <td><code>twiki/data</code></td>
109 >     <td> topic data </td>
110 >     <td> outside of htdoc tree (for security) </td>
111 >     <td><code>/home/smith/twiki/data</code></td>
112 >   </tr>
113 >   <tr>
114 >     <td><code>twiki/templates</code></td>
115 >     <td> web templates </td>
116 >     <td> outside of htdoc tree (for security) </td>
117 >     <td><code>/home/smith/twiki/templates</code></td>
118 >   </tr>
119 > </table>
120
121 <a name="StepTwo"></a>
122
123 ### <a name="Step 2: Set File Permissions"></a> Step 2: Set File Permissions
124
125 - Make sure Perl 5 and the Perl CGI library are installed on your system. The default location of Perl is `/usr/bin/perl`. If it's elsewhere, change the path to Perl in the first line of each script in the `twiki/bin` directory, or create a symbolic link from `/usr/bin/perl`.
126   - **IMPORTANT:** On ISP-hosted accounts, Perl CGI scripts usually require a `.cgi` extension to run. Some systems need `.pl`, the regular Perl extension. Modify all `twiki/bin` script filenames if necessary.
127 - Set the file permission of all Perl scripts in the `twiki/bin` directory as executable to `-rwxr-xr-x` (755).
128 - 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.
129 - **_NOTE:_** This Guide assumes user `nobody` ownership for all files manipulated by the CGI scripts (executed by the Web server), and user `twiki` for all other files. You can:
130   - replace `nobody` with another user if your server executes scripts under a different name (ex: default for Debian is `www-data`).
131     - **HINT:** Run the `testenv` script from your browser: `http://yourdomain.com/twiki/bin/testenv`. It will show you the user name of the CGI scripts, a table listing all CGI environment variables, and a test of your `twiki/lib/TWiki.cfg` configuration file (you'll configure that in a minute).
132   - replace user `twiki` with your own username
133 - Set the permission of all files below `twiki/data` so that they are writable by user `nobody`. A simple way is to `chmod` them to `-rw-rw-r--` (664) and to `chown` them to `nobody`.
134 - Set the permission of the `twiki/data` directory and its subdirectories so that files in there are writable by user `nobody`. A simple way is to chmod them to `drwxrwxr-x` (775) and to `chown` them to `nobody`.
135 - 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 `drwxrwxr-x` (775) and to `chown` them to `nobody`.
136 - **_NOTE:_** The `twiki/data/*/*.txt,v` RCS repository files in the installation package are locked by user `nobody`. If your CGI scripts are **_not_** running as user `nobody`, it's not possible to check in files (you'll see that the revision number won't increase after saving a topic). In this case, you need to unlock all repository files (check the RCS man pages) and lock them with a different user, ex `www-data`, or delete them all - new files will be automatically created the first time each topic is edited. A simple way to change ownership is with a search-and-replace in all files; for example, using sed: <br />`for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done`
137
138 ### <a name="Step 3: Set the Main Configurati"></a> Step 3: Set the Main Configuration File
139
140 - Edit the file `twiki/lib/TWiki.cfg`, setting the variables to your needs.
141   - Set the file extension in the `$scriptSuffix` variable to `cgi` or `pl` if required.
142   - Make sure RCS is installed. Set `$rcsDir` in `twiki/lib/TWiki.cfg` to mach the location of your RCS binaries.
143 - **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)
144 - 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.
145
146 ### <a name="Step 4: Finish Up from Your Brow"></a> Step 4: Finish Up from Your Browser
147
148 - Point your Web browser at `http://yourdomain.com/twiki/bin/view` and start TWiki-ing away!
149 - Edit the [[TWikiPreferences]] topic in the TWiki:TWiki web to set the `WIKIWEBMASTER` email address, and other preferences.
150 - Edit the [[WebPreferences]] topic in each web, if necessary: set individual `WEBCOPYRIGHT` messages, and other preferences.
151 - Enable email notification of topic changes, [[TWikiSiteTools]] has more.
152 - Edit the [[WebNotify]] topic in all webs and add the users you want to notify.
153 - Add the TWiki:Main/PoweredByTWikiLogo to your [[WebHome]] topic.
154 - You can add new `%VARIABLES%`. Define site-level variables in the [[TWikiPreferences]] topic. See also: [[TWikiVariables]].
155
156 That's it for the standard virgin installation of TWiki. Read on for server-level customization options.
157
158 ## <a name="Additional Server-Level Options"></a> Additional Server-Level Options
159
160 With your new TWiki installation up and running, you can manage most aspects of your site from the browser interface. Only a few functions require access to the server file system, via Telnet or FTP. You can make these server-level changes during installation, and at any time afterwards.
161
162 ### <a name="Enabling Authentication of Users"></a> Enabling Authentication of Users
163
164 - If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users:
165   1. **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>
166     - **_NOTE:_** In case you renamed the CGI script files to have a file extension you need to reflect that in the `edit`, `view`, `preview`, etc entries in `.htaccess`.
167     - **_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.
168   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.
169     - **_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.
170 - Register yourself in the [[TWikiRegistration]] topic.
171   - **_NOTE:_** When a user registers, a new line with the username and encrypted password is added to the `data/.htpasswd` file. The `.htpasswd` file that comes with the TWiki installation includes user accounts for TWiki core team members that are used for testing on TWiki.org. You can edit the file and delete those lines.
172 - Create a new topic to check if authentication works.
173 - Edit the [[TWikiAdminGroup]] topic in the TWiki:Main web to include users with system administrator status.
174 - Edit the [[TWikiPreferences]] topic in the TWiki:TWiki web to set access privileges.
175 - Edit the [[WebPreferences]] topic in each web, if necessary: set access priviliges.
176
177 <a name="CreateWeb"></a>
178
179 ### <a name="Adding a New Web"></a> Adding a New Web
180
181 To create a new web:
182
183 1. **Create** a new web data directory under `twiki/data` and check the file permission of the directory.
184   - Use a name starting with characters `A..Z`, followed by `a..z` and/or `0..9` characters, but **_not_** a [[WikiWord]].
185 2. **Copy** all files from the `twiki/data/_default` 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`).
186   - **_HINT:_** You can set permissions of `.txt` and `.txt,v` files to `-rw-rw-rw-` (666) and then edit the topic using your browser; RCS will restore the file permissions correctly when saving the topic.
187 3. **Add** the new web to the web list (visible in the upper right corner of each topic) by editing the site-level preferences, [[TWikiPreferences]]:
188   - Add the new web to the `%WIKIWEBLIST%` variable.
189 4. **Update** the web settings by editing the WebPreferences topic of the new web:
190   - Customize the `%WEBTOPICLIST%` variable to contain the web-specific links you prefer.
191   - Set the WEBBGCOLOR variable to a color. The number represents the unique color for the web.
192   - Set Plugins, access privileges, custom variables, other web-level options (ex: `%WEBCOPYRIGHT%` can be set for an individual web).
193 5. **Add** the new web to the color-coded web directory table by editing the [[TWikiWebsTable]] topic.
194 6. **Test** the new web: view pages, create a new page.
195
196 That's it for a basic new web set-up!
197
198 Optionally, you can also:
199
200 - Create custom web-specific templates in a new `twiki/templates/Someweb` directory (otherwise, templates are inherited from `twiki/templates`).
201 - Add [[TWikiForms]] for form-based page input that's stored separately from the main free-form topic text.
202
203 **_NOTE:_** User home topics are located in the %WIKITOOLNAME%.Main web - don't try to move them or create them in other webs. From any other web, user signatures have to point to %WIKITOOLNAME%.Main web, using a `Main.UserName` or `%MAINWEB%.UserName` format. (The `%MAINWEB%` variable is an advantage if you ever change the Main web name, but the standard `Main.UserName` is easier for users to enter, which is the bottom line!
204
205 ## <a name="TWiki File System Info"></a> TWiki File System Info
206
207 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.
208
209 -- [[PeterThoeny]] - 13 Sep 2001 <br /> -- [[MikeMannix]] - 03 Dec 2001