none
authorPeterThoeny <PeterThoeny>
Tue, 18 Sep 2001 08:07:11 +0000 (08:07 +0000)
committerPeterThoeny <PeterThoeny>
Tue, 18 Sep 2001 08:07:11 +0000 (08:07 +0000)
TWiki/TWikiInstallationGuide.mdwn

index 38044c4..95ed35e 100644 (file)
@@ -13,8 +13,8 @@
           </ul>
         </li>
         <li><a href="#Additional Server-Level Options"> Additional Server-Level Options</a><ul>
+            <li><a href="#Enabling Authentication of Users"> Enabling Authentication of Users</a></li>
             <li><a href="#Adding a New Web"> Adding a New Web</a></li>
-            <li><a href="#Enabling Basic Authentication (."> Enabling Basic Authentication (.htaccess)</a></li>
           </ul>
         </li>
         <li><a href="#TWiki File System Info"> TWiki File System Info</a></li>
@@ -127,30 +127,30 @@ To install TWiki on a system where you don't have server administrator privilege
 - 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.
 - **_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:
   - replace `nobody` with another user if your server executes scripts under a different name (ex: default for Debian is `www-data`).
+    - **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).
   - replace user `twiki` with your own username
-- The CGI scripts execute as `nobody`. Set the file permission of all Perl scripts in the `twiki/bin` directory as executable to `-rwxr-xr-x` (755).
-- Test your settings by running the `testenv` script from your browser: `http://yourdomain.com/twiki/bin/testenv`. You should get 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).
+- Set the file permission of all Perl scripts in the `twiki/bin` directory as executable to `-rwxr-xr-x` (755).
 - 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`.
 - 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`.
 - 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`.
+- **_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`
 
 ### <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.
-- **_NOTE:_** The `*,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 and lock them as user `www-data` (check the RCS man pages), 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`
 - **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)
-- Enable email notification of topic changes, [[MonitoringSiteActivity]] has more.
-- Add the TWiki:Main/PoweredByTWikiLogo to your [[WebHome]] topic.
+- 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.
 
 ### <a name="Step 4: Finish Up from Your Brow"></a> Step 4: Finish Up from Your Browser
 
 - Point your Web browser at `http://yourdomain.com/twiki/bin/view` and start TWiki-ing away!
-- Edit the TWikiAdminGroup topic to include users with system administrator status.
-- Edit the [[TWikiPreferences]] topic in the TWiki:TWiki web to set the `WIKIWEBMASTER` email address, the `WEBCOPYRIGHT` message, access privileges, and other preferences.
-- Edit the [[WebPreferences]] topic in each web, if necessary: set access priviliges, individual `WEBCOPYRIGHT` messages, other preferences.
+- Edit the [[TWikiPreferences]] topic in the TWiki:TWiki web to set the `WIKIWEBMASTER` email address, and other preferences.
+- Edit the [[WebPreferences]] topic in each web, if necessary: set individual `WEBCOPYRIGHT` messages, and other preferences.
+- Enable email notification of topic changes, [[MonitoringSiteActivity]] has more.
 - Edit the [[WebNotify]] topic in all webs and add the users you want to notify.
+- Add the TWiki:Main/PoweredByTWikiLogo to your [[WebHome]] topic.
 - You can add new `%VARIABLES%`. Define site-level variables in the [[TWikiPreferences]] topic. See also: [[TWikiVariables]].
 
 That's it for the standard virgin installation of TWiki. Read on for server-level customization options.
@@ -159,6 +159,21 @@ That's it for the standard virgin installation of TWiki. Read on for server-leve
 
 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.
 
+### <a name="Enabling Authentication of Users"></a> Enabling Authentication of Users
+
+- If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users:
+  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>
+    - **_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`.
+    - **_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.
+  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.
+    - **_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.
+  - **_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.
+- Create a new topic to check if authentication works.
+- Edit the [[TWikiAdminGroup]] topic in the TWiki:Main web to include users with system administrator status.
+- Edit the [[TWikiPreferences]] topic in the TWiki:TWiki web to set access privileges.
+- Edit the [[WebPreferences]] topic in each web, if necessary: set access priviliges.
+
 <a name="CreateWeb"></a>
 
 ### <a name="Adding a New Web"></a> Adding a New Web
@@ -187,17 +202,6 @@ Optionally, you can also:
 
 **_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!
 
-### <a name="Enabling Basic Authentication (."></a> Enabling Basic Authentication (.htaccess)
-
-- If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users:
-  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>
-    - **_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`.
-    - **_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.
-  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.
-    - 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.
-
-- - **_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.
-
 ## <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.