Welcome, Registration, and other StartingPoints; TWiki history & Wiki style; All the docs...	View r38 > r37 > r36 > r35 > r34 > r33 ...
Main AmLegalHist CompPrivConst EngLegalHist LawContempSoc LawNetSoc TWiki

TWikiInstallationGuide 38 - 23 Nov 2001 - Main.PeterThoeny

Line: 1 to 1
	TWiki Installation Guide TWiki Installation Guide
Line: 128 to 128
	To create a new web: Create a new web data directory under `twiki/data` and check the file permission of the directory.
Changed:
< <	Use a name consisting of characters `A..Z` , `a..z` but *not* in WikiNotation.
> >	Use a name starting with characters `A..Z`, followed by `a..z` and/or `0..9` characters, but *not* a WikiWord.
	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`). *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. Add the new web to the web list (visible in the upper right corner of each topic) by editing the site-level preferences, TWikiPreferences:

TWikiInstallationGuide 37 - 18 Sep 2001 - Main.PeterThoeny

Line: 1 to 1
	TWiki Installation Guide TWiki Installation Guide
Line: 73 to 73
	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`).
Added:
> >	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
Changed:
< <	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`.
Added:
> >	*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: `for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done`
	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.
Deleted:
< <	*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: `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)
Changed:
< <	Enable email notification of topic changes, MonitoringSiteActivity? has more. Add the TWiki:Main/PoweredByTWikiLogo to your Main 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.
	Step 4: Finish Up from Your Browser Point your Web browser at `http://yourdomain.com/twiki/bin/view` and start TWiki-ing away!
Changed:
< <	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.
Added:
> >	Add the TWiki:Main/PoweredByTWikiLogo to your Main 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.
Line: 105 to 105
	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.
Added:
> >	Enabling Authentication of Users If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users: 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], [2]). In particular, the following red part needs to be configured correctly: `Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view` `AuthUserFile /filepath/to/TWiki/data/.htpasswd` `ErrorDocument 401 /urlpath/to/TWiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth` *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 Edit 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. 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.
	Adding a New Web
Line: 130 to 148
	*NOTE:* User home topics are located in the TWiki.Main web - don't try to move them or create them in other webs. From any other web, user signatures have to point to TWiki.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!
Deleted:
< <	Enabling Basic Authentication (.htaccess) If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users: 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], [2]). In particular, the following red part needs to be configured correctly: `Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view` `AuthUserFile /filepath/to/TWiki/data/.htpasswd` `ErrorDocument 401 /urlpath/to/TWiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth` *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 Edit 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. 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.
	TWiki File System Info See Appendix A: TWiki File System? for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.

TWikiInstallationGuide 36 - 16 Sep 2001 - Main.MikeMannix

   TWiki Installation Guide
 


 TWiki Installation Guide
 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.)
-<
<
+ 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).
  replace user twiki with your own username
  Step 1: Create & Configure the Directories 

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 instead.
  </Directory>
->
>
+ Restart Apache by /etc/rc.d/rc5.d/S85httpd restart .
  Test that the twiki/bin directory is CGI-enabled by trying visiting it in your browser: 
 Enter the URL for the bin directory, http://yourdomain.com/twiki/bin/.
  Your settings are OK if you get a message like "Forbidden. You don't have permission to access /twiki/bin/ on this server".
  Settings are NOT correct if you get something like "Index of /twiki/bin" - recheck your httpd.conf file.
  Go directly to Step 2...
-<
<
+ Step 2: Check the Server Directory Settings
->
>
+ Step 2: Set File Permissions
-<
<
+ Restart Apache by /etc/rc.d/rc5.d/S85httpd restart .
  Test if the twiki/bin directory is CGI-enabled: 
 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."
  Execute the testenv script from your browser ( http://your.domain.com/twiki/bin/testenv ). It shows a table with all CGI environment variables. It also tests the settings in your twiki/lib/TWiki.cfg configuration file, which you will set later on.
 
 

 Step 3: Enable Perl File Permissions 
 

 Make sure Perl 5 and the Perl CGI library are installed on your system. The default location of Perl is /usr/bin/perl. If Perl is installed elsewhere, change the first line of all scripts in the twiki/bin directory (or create a symbolic link from /usr/bin/perl). 
 IMPORTANT: On most ISP virtual domain accounts, Perl CGI scripts require a .cgi extension to run. Some systems need .pl, the regular Perl extension. Change all twiki/bin scripts appropriately if necessary.
->
>
+ 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. 
 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.
  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).
  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 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.
-<
<
+ Step 4: Set the Main Configuration File
->
>
+ Step 3: Set the Main Configuration File
-<
<
+ Edit the file twiki/lib/TWiki.cfg and set the variables to your needs.
->
>
+ 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 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 (ex: 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: 
 for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
->
>
+ 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: 
 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 Main topic.
-<
<
+ Step 5: Finish Up from Your Browser
->
>
+ 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.

TWikiInstallationGuide 35 - 16 Sep 2001 - Main.MikeMannix

   TWiki Installation Guide
 


 TWiki Installation Guide
-<
<
+Installation instructions for the current public release (01-Sep-2001)
->
>
+Installation instructions for the TWiki 01-Sep-2001 production release
  Overview 

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? . Documentation for other platforms is currently limited. For Windows, check TWiki:Codev/TWikiOnWindows. Search the TWiki:Codev web for other intallation notes.
->
>
+ Standard Installation 

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.)
  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).
  replace user twiki with your own username
-<
<
+ Standard Installation 

Request and download the TWiki 01-Sep-2001 distribution in Unix ZIP format from http://TWiki.org/download.html.
  Step 1: Create & Configure the Directories
-<
<
+ 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 instead.
  NOTE: To install TWiki on SourceForge, for use on a software development project, read TWiki:Codev/SourceForgeHowTo.
->
>
+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 instead.
  Create directory /home/httpd/twiki and unzip the TWiki distribution into this directory.
  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.

TWikiInstallationGuide 34 - 15 Sep 2001 - Main.MikeMannix

Line: 1 to 1

TWiki Installation Guide

TWiki Installation Guide

Line: 17 to 17

Standard Installation

Request and download the TWiki 01-Sep-2001 distribution in Unix ZIP format from http://TWiki.org/download.html.

Deleted:

<
<

Step 1: Create & Configure the Directories

Changed:

<
< 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 instead.

>
>

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 instead.
NOTE: To install TWiki on SourceForge, for use on a software development project, read TWiki:Codev/SourceForgeHowTo.

Create directory /home/httpd/twiki and unzip the TWiki distribution into this directory.
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.
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 ).
Now add ScriptAlias for /twiki/bin and Alias for /twiki to file httpd.conf .

Changed:

<
< Note: The ScriptAlias must come before the Alias in Apache, otherwise it will fail to correctly set up /twiki/bin/ , due to the fact that it sees that as being just another subdirectory of the /twiki/ alias.

>
> 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.

Changed:

<
<

>
>

Example httpd.conf entries:

 ScriptAlias /twiki/bin/ "/home/httpd/twiki/bin/"
 Alias /twiki/ "/home/httpd/twiki/"

Line: 56 to 56

Upload the TWiki files by FTP (transfer as text except for the image files in pub)

TWiki dir: What it is: Where to copy: Example:

Changed:

<
<

`twiki/bin`	CGI bin	cgi-bin enabled dir	`/home/smith/public_html/cgi-bin`
`twiki/lib`	library files	same level like `twiki/bin`	`/home/smith/public_html/lib`

>
>

`twiki/bin`	CGI bin	cgi-enabled dir	`/home/smith/public_html/cgi-bin`
`twiki/lib`	library files	same level as `twiki/bin`	`/home/smith/public_html/lib`

`twiki/pub`	public files	htdoc enabled dir	`/home/smith/public_html/pub`
`twiki/data`	topic data	outside of htdoc tree (for security)	`/home/smith/twiki/data`
`twiki/templates`	web templates	outside of htdoc tree (for security)	`/home/smith/twiki/templates`

Deleted:

<
< (Read TWiki:Codev/SourceForgeHowTo in case you want to install TWiki on SourceForge, to use on a software development project.)

Revision 38	r38 - 23 Nov 2001 - 10:02:16 - PeterThoeny?
Revision 37	r37 - 18 Sep 2001 - 08:07:11 - PeterThoeny?
Revision 36	r36 - 16 Sep 2001 - 07:36:01 - MikeMannix?
Revision 35	r35 - 16 Sep 2001 - 05:24:31 - MikeMannix?
Revision 34	r34 - 15 Sep 2001 - 05:20:22 - MikeMannix?
Revision 33	r33 - 15 Sep 2001 - 04:17:15 - MikeMannix?

This site is powered by the TWiki collaboration platform.
All material on this collaboration platform is the property of the contributing authors.
All material marked as authored by Eben Moglen is available under the license terms CC-BY-SA version 4.

Syndicate this site RSS ATOM

TWiki Installation Guide

TWiki Installation Guide

Step 3: Set the Main Configuration File

Step 4: Finish Up from Your Browser

Enabling Authentication of Users

Adding a New Web

Enabling Basic Authentication (.htaccess)

TWiki File System Info

TWiki Installation Guide

Step 1: Create & Configure the Directories

Step 2: Check the Server Directory Settings

Step 2: Set File Permissions

Step 3: Enable Perl File Permissions

Step 4: Set the Main Configuration File

Step 3: Set the Main Configuration File

Step 5: Finish Up from Your Browser

Step 4: Finish Up from Your Browser

TWiki Installation Guide

Overview

Standard Installation

Standard Installation

Step 1: Create & Configure the Directories

TWiki Installation Guide

Standard Installation

Step 1: Create & Configure the Directories