fa1ba3fc309f08cd1baef2c3b5280f4e5bc5440e
[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="#Standard Installation"> Standard Installation</a><ul>
5             <li><a href="#Step 1: Create  Configure the Di"> Step 1: Create &amp; Configure the Directories</a><ul>
6                 <li><a href="#Step 1 for Non-Root Accounts"> Step 1 for Non-Root Accounts</a></li>
7               </ul>
8             </li>
9             <li><a href="#Step 2: Set File Permissions"> Step 2: Set File Permissions</a></li>
10             <li><a href="#Step 3: Set the Main Configurati"> Step 3: Set the Main Configuration File</a></li>
11             <li><a href="#Step 4: Configure Site-Wide Emai"> Step 4: Configure Site-Wide Email Preferences</a></li>
12             <li><a href="#Step 5: Finish Up from Your Brow"> Step 5: 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-Dec-2001 production release. Update notes for the new RCS configuration are marked_ **_Dataframework_**.
29
30 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 web server and OS that meet the [[system requirements|Main/TWikiSystemRequirements]]. Documentation for other platforms is somewhat limited:
31
32 - For Unix or Linux, check TWiki:Codev/TWikiOnUnix and TWiki:Codev/TWikiOnLinux.
33 - For Windows, check the [[WindowsInstallCookbook]].
34 - For MacOS X, check TWiki:Codev/TWikiOnMacOSX.
35 - To install TWiki on SourceForge, for use on a software development project, read TWiki:Codev/TWikiOnSourceForge
36 - For other platforms, see TWiki:Codev/TWikiOn, and search the TWiki:Codev and TWiki:Support webs for other installation notes.
37
38 <a name="StandardInstallation"></a>
39
40 ## <a name="Standard Installation"></a> Standard Installation
41
42 Request and download the TWiki 01-Dec-2001 distribution in Unix ZIP format from <http://TWiki.org/download.html>. Please review the [[AdminSkillsAssumptions]] before you install TWiki.
43
44 ### <a name="Step 1: Create  Configure the Di"></a> Step 1: Create &amp; Configure the Directories
45
46 %X% **NOTE:** _If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account, or you don't have administrator privileges on your intranet server - use the [[alternative Step 1|Main/WebHome#StepOneB]] instead._
47
48 - Create directory `/home/httpd/twiki` and [unzip](http://www.info-zip.org/pub/infozip/UnZip.html) the TWiki distribution into this directory.
49 - 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.
50 - 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` ).
51 - Now add `ScriptAlias` for `/twiki/bin` and `Alias` for `/twiki` to file `httpd.conf` . <br /> %X% **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.
52 - The `twiki/data` and `twiki/templates` directories should be set so that they are **not** visible as URLs. Add them to `httpd.conf` with `deny from all`.
53
54 > **Example `httpd.conf` entries:**
55 >
56 >      ScriptAlias /twiki/bin/ "/home/httpd/twiki/bin/"
57 >      Alias /twiki/ "/home/httpd/twiki/"
58 >      <Directory "/home/httpd/twiki/bin">
59 >        Options +ExecCGI
60 >        SetHandler cgi-script
61 >        Allow from all
62 >      </Directory>
63 >      <Directory "/home/httpd/twiki/pub">
64 >        Options FollowSymLinks +Includes
65 >        AllowOverride None
66 >        Allow from all
67 >      </Directory>
68 >      <Directory "/home/httpd/twiki/data">
69 >        deny from all
70 >      </Directory>
71 >      <Directory "/home/httpd/twiki/templates">
72 >        deny from all
73 >      </Directory>
74
75 - Restart Apache by `/etc/rc.d/rc5.d/S85httpd restart` .
76 - Test that the `twiki/bin` directory is CGI-enabled by trying visiting it in your browser:
77   - Enter the URL for the `bin` directory, `http://yourdomain.com/twiki/bin/`.
78   - Your settings are OK if you get a message like `"Forbidden. You don't have permission to access /twiki/bin/ on this server"`.
79   - Settings are NOT correct if you get something like `"Index of /twiki/bin"` - recheck your `httpd.conf` file.
80
81 - _Go directly to [[Step 2|Main/WebHome#StepTwo]]..._
82
83 <a name="StepOneB"></a>
84
85 #### <a name="Step 1 for Non-Root Accounts"></a> Step 1 for Non-Root Accounts
86
87 To install TWiki on a system where you don't have Unix/Linux root (administrator) privileges, for example, on a hosted Web account or an intranet server administered by someone else:
88
89 - Download and unzip TWiki on your local PC
90 - Using the table below, create a directory structure on your host server
91 - Upload the TWiki files by FTP (transfer as _text_ except for the image files in `pub`)
92
93 > <table border="1" cellpadding="0" cellspacing="0">
94 >   <tr>
95 >     <th bgcolor="#99CCCC"><strong> TWiki dir: </strong></th>
96 >     <th bgcolor="#99CCCC"><strong> What it is: </strong></th>
97 >     <th bgcolor="#99CCCC"><strong> Where to copy: </strong></th>
98 >     <th bgcolor="#99CCCC"><strong> Example: </strong></th>
99 >   </tr>
100 >   <tr>
101 >     <td><code>twiki</code></td>
102 >     <td> start-up pages </td>
103 >     <td> root TWiki dir </td>
104 >     <td><code>/home/smith/twiki/</code></td>
105 >   </tr>
106 >   <tr>
107 >     <td><code>twiki/bin</code></td>
108 >     <td> CGI bin </td>
109 >     <td> CGI-enabled dir </td>
110 >     <td><code>/home/smith/twiki/bin</code></td>
111 >   </tr>
112 >   <tr>
113 >     <td><code>twiki/lib</code></td>
114 >     <td> library files </td>
115 >     <td> same level as <code>twiki/bin</code></td>
116 >     <td><code>/home/smith/twiki/lib</code></td>
117 >   </tr>
118 >   <tr>
119 >     <td><code>twiki/pub</code></td>
120 >     <td> public files </td>
121 >     <td> htdoc enabled dir </td>
122 >     <td><code>/home/smith/twiki/pub</code></td>
123 >   </tr>
124 >   <tr>
125 >     <td><code>twiki/data</code></td>
126 >     <td> topic data </td>
127 >     <td> dir secure from public access </td>
128 >     <td><code>/home/smith/twiki/data</code></td>
129 >   </tr>
130 >   <tr>
131 >     <td><code>twiki/templates</code></td>
132 >     <td> web templates </td>
133 >     <td> dir secure from public access </td>
134 >     <td><code>/home/smith/twiki/templates</code></td>
135 >   </tr>
136 > </table>
137
138 If you are not able to create the `twiki/lib` directory at the same level as the `twiki/bin` directory (e.g. because CGI `bin` directories can't be under your home directory and you don't have root access), you can create this directory elsewhere and edit the `setlib.cfg` file in the `bin` directory:
139
140 <pre>
141          # -------------- Change these settings if required
142
143          $twikiLibPath = <font color="red">'/some/other/path/lib'</font>;       # Path to lib directory containing TWiki.pm
144
145 </pre>
146
147 You can also edit `$localPerlLibPath` in the `setlib.cfg` file if you are not root and need to install additional CPAN modules, but can't update the main Perl installation files on the server. Just set this variable to the full pathname to your local lib directory, typically under your home directory.
148
149 <a name="StepTwo"></a>
150
151 ### <a name="Step 2: Set File Permissions"></a> Step 2: Set File Permissions
152
153 - 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`.
154   - **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.
155 - Set the file permission of all Perl scripts in the `twiki/bin` directory as executable to `-rwxr-xr-x` (755).
156 - 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.
157 - %H% 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:
158   - replace `nobody` with another user if your server executes scripts under a different name (ex: default for Debian is `www-data`).
159     - %T% **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).
160   - replace user `twiki` with your own username
161 - 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`.
162 - 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`.
163 - 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`.
164 - %H% 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 perl:
165
166 > cd twiki/data
167 >     perl -pi~ -e 's/nobody:/www-data:/' */*,v
168
169 ### <a name="Step 3: Set the Main Configurati"></a> Step 3: Set the Main Configuration File
170
171 - Edit the file `twiki/lib/TWiki.cfg`, setting the variables to your needs.
172   - Set the file extension in the `$scriptSuffix` variable to `cgi` or `pl` if required.
173   - RCS - revision control system to store revision 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.
174     - Set `$storeTopicImpl = "RcsWrap";` for the RCS executables and make sure RCS is installed. Set `$rcsDir` in `twiki/lib/TWiki.cfg` to match the location of your RCS binaries. You can check this by issuing the command `rcs` at the prompt, it should result in something like `"rcs: no input file"`.
175       - Check that you have GNU `diff`, by typing `diff -v` - an error indicates you have a non-GNU diff, so install the GNU `diffutils` package and make sure that `diff` is on the PATH used by TWiki (see `$safeEnvPath` in the `TWiki.cfg` file).
176     - Set `$storeTopicImpl = "RcsLite";` for the Perl based RCS
177 - **Security issue:** Directories `twiki/data` , `twiki/templates` and all their subdirectories should be set so that they are **_not_** visible through URLs. (Alternatively, move the directories to a place where they are not visible, and change the variables in `twiki/lib/TWiki.cfg` accordingly)
178 - 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.
179
180 ### <a name="Step 4: Configure Site-Wide Emai"></a> Step 4: Configure Site-Wide Email Preferences
181
182 - From your web browser, edit the [[TWikiPreferences]] topic in the TWiki:TWiki web to set the `WIKIWEBMASTER` email address, and other email settings required for registration and [[WebChangesAlert]] to work:
183   - `WIKIWEBMASTER` should be set to the email address of the TWiki administrator
184   - `SMTPMAILHOST` is typically set on Windows or other non-Unix/Linux systems, where `sendmail` or similar is not available. When this is set and the Perl module <code>**Net::SMTP**</code> is installed, TWiki will connect to this SMTP server (e.g. `mail.yourdomain.com`) to send email for user registration and [[WebChangesAlerts]]. If you do have a sendmail-type program, leave `SMTPMAILHOST` unset so that the external sendmail program is used instead (defined by <code>**$mailProgram**</code> in <code>**TWiki.cfg**</code>).
185   - `SMTPSENDERHOST` is optional, and set to the domain name sending the email (e.g. `twiki.yourdomain.com`). For use where the SMTP server requires that you identify the TWiki server sending mail. If not set, <code>**Net::SMTP**</code> will guess it for you.
186 - You may want to set up other [[TWikiPreferences]] later on.
187
188 ### <a name="Step 5: Finish Up from Your Brow"></a> Step 5: Finish Up from Your Browser
189
190 - Point your Web browser at `http://yourdomain.com/twiki/bin/view` and start TWiki-ing away!
191   - %T% Or, point to `http://yourdomain.com/twiki/` to get the pre-TWiki `index.html` page, with a link to the `view` script. Customize this page if you want a public intro screen with a login link, instead of immediately calling up the .htaccess login dialog by going directly to `view`.
192 - Edit the [[WebPreferences]] topic in each web, if necessary: set individual `WEBCOPYRIGHT` messages, and other preferences.
193 - Enable email notification of topic changes, [[TWikiSiteTools]] has more.
194 - Edit the [[WebNotify]] topic in all webs and add the users you want to notify.
195 - Add the TWiki:Main/PoweredByTWikiLogo to your [[WebHome]] topic.
196 - You can add new `%VARIABLES%`. Define site-level variables in the [[TWikiPreferences]] topic. See also: [[TWikiVariables]].
197
198 That's it for the standard virgin installation of TWiki. Read on for server-level customization options.
199
200 ## <a name="Additional Server-Level Options"></a> Additional Server-Level Options
201
202 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.
203
204 <a name="AuthenticationOfUsers"></a>
205
206 ### <a name="Enabling Authentication of Users"></a> Enabling Authentication of Users
207
208 - If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users:
209   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>/urlpathto/twiki/index.html</font> http://<font>yourdomain.com/urlpathto/twiki/bin/</font>view</code><br /><code>AuthUserFile <font>/filepathto/twiki/data/</font>.htpasswd</code><br /><code>ErrorDocument 401 <font>/urlpathto/twiki/bin/</font>oops/TWiki/TWikiRegistration?template=oopsauth</code>
210     - %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`.
211     - %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.
212       - **This applies only if you have root access:** on hosted accounts, you shouldn't have this problem - otherwise, email tech support.
213     - %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.
214   2. **Copy** the [[TWikiRegistrationPub]] topic to [[TWikiRegistration]], overwriting old version of 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.
215 - Customization:
216   - 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 carried over into the user home page correctly.
217   - You can customize the default user home page in [[NewUserTemplate]].
218 - Register yourself in the [[TWikiRegistration]] topic.
219   - %X% **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.
220 - Create a new topic to check if authentication works.
221 - Edit the [[TWikiAdminGroup]] topic in the TWiki:Main web to include users with system administrator status.
222 - Edit the [[TWikiPreferences]] topic in the TWiki:TWiki web to set access privileges.
223 - Edit the [[WebPreferences]] topic in each web, if necessary: set access priviliges.
224
225 <a name="CreateWeb"></a>
226
227 ### <a name="Adding a New Web"></a> Adding a New Web
228
229 To create a new web:
230
231 1. **Create** a new web data directory under `twiki/data` and check the file permission of the directory.
232   - Use a name consisting of characters `A..Z` , `a..z` but **_not_** in [[WikiNotation]]. (The name should start with one (or more) uppercase letters, but have no uppercase letters after the first group -- if it starts with a lowercase letter or is a [[WikiWord]], some features of TWiki will not work as expected.)
233 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`).
234   - %T% **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.
235 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]]:
236   - Add the new web to the `%WIKIWEBLIST%` variable.
237 4. **Update** the web settings by editing the WebPreferences topic of the new web:
238   - Customize the `%WEBTOPICLIST%` variable to contain the web-specific links you prefer.
239   - Set the WEBBGCOLOR variable to a color. The number represents the unique color for the web.
240   - Set Plugins, access privileges, custom variables, other web-level options (ex: `%WEBCOPYRIGHT%` can be set for an individual web).
241 5. **Test** the new web: view pages, create a new page.
242
243 That's it for a basic new web set-up!
244
245 Optionally, you can also:
246
247 - Create custom web-specific templates in a new `twiki/templates/Someweb` directory (otherwise, templates are inherited from `twiki/templates`).
248 - Add [[TWikiForms]] for form-based page input that's stored separately from the main free-form topic text.
249
250 %X% **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!
251
252 ## <a name="TWiki File System Info"></a> TWiki File System Info
253
254 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.
255
256 -- [[PeterThoeny]] - 28 Dec 2002 <br /> -- [[MikeMannix]] - 16 May 2002