head	1.71;
access;
symbols;
locks; strict;
comment	@# @;


1.71
date	2008.12.06.09.02.26;	author TWikiContributor;	state Exp;
branches;
next	1.70;

1.70
date	2008.08.03.22.17.42;	author TWikiContributor;	state Exp;
branches;
next	1.69;

1.69
date	2008.01.22.03.21.25;	author TWikiContributor;	state Exp;
branches;
next	1.68;

1.68
date	2007.03.03.14.51.54;	author TWikiContributor;	state Exp;
branches;
next	1.67;

1.67
date	2007.02.05.00.18.44;	author TWikiContributor;	state Exp;
branches;
next	1.66;

1.66
date	2007.01.16.04.12.06;	author TWikiContributor;	state Exp;
branches;
next	1.65;

1.65
date	2006.06.25.16.26.27;	author TWikiContributor;	state Exp;
branches;
next	1.64;

1.64
date	2006.04.01.05.55.13;	author TWikiContributor;	state Exp;
branches;
next	1.63;

1.63
date	2006.02.01.12.01.19;	author TWikiContributor;	state Exp;
branches;
next	1.62;

1.62
date	2004.08.31.15.49.34;	author PeterThoeny;	state Exp;
branches;
next	1.61;

1.61
date	2004.08.29.20.09.04;	author PeterThoeny;	state Exp;
branches;
next	1.60;

1.60
date	2004.08.17.05.21.06;	author PeterThoeny;	state Exp;
branches;
next	1.59;

1.59
date	2004.08.16.04.57.45;	author PeterThoeny;	state Exp;
branches;
next	1.58;

1.58
date	2003.12.12.06.57.00;	author PeterThoeny;	state Exp;
branches;
next	1.57;

1.57
date	2003.07.26.20.48.00;	author PeterThoeny;	state Exp;
branches;
next	1.56;

1.56
date	2003.06.04.06.28.50;	author PeterThoeny;	state Exp;
branches;
next	1.55;

1.55
date	2003.04.15.05.49.13;	author PeterThoeny;	state Exp;
branches;
next	1.54;

1.54
date	2003.02.15.04.57.01;	author PeterThoeny;	state Exp;
branches;
next	1.53;

1.53
date	2003.02.02.01.29.29;	author PeterThoeny;	state Exp;
branches;
next	1.52;

1.52
date	2003.02.01.12.20.19;	author PeterThoeny;	state Exp;
branches;
next	1.51;

1.51
date	2003.01.16.07.21.08;	author PeterThoeny;	state Exp;
branches;
next	1.50;

1.50
date	2003.01.12.05.55.03;	author PeterThoeny;	state Exp;
branches;
next	1.49;

1.49
date	2002.12.29.01.23.00;	author PeterThoeny;	state Exp;
branches;
next	1.48;

1.48
date	2002.09.21.16.03.21;	author PeterThoeny;	state Exp;
branches;
next	1.47;

1.47
date	2002.08.02.20.50.46;	author PeterThoeny;	state Exp;
branches;
next	1.46;

1.46
date	2002.07.07.06.43.55;	author PeterThoeny;	state Exp;
branches;
next	1.45;

1.45
date	2002.05.16.05.24.00;	author MikeMannix;	state Exp;
branches;
next	1.44;

1.44
date	2002.04.07.10.27.00;	author PeterThoeny;	state Exp;
branches;
next	1.43;

1.43
date	2002.01.27.13.04.00;	author MikeMannix;	state Exp;
branches;
next	1.42;

1.42
date	2001.12.09.00.44.44;	author PeterThoeny;	state Exp;
branches;
next	1.41;

1.41
date	2001.12.05.02.00.30;	author PeterThoeny;	state Exp;
branches;
next	1.40;

1.40
date	2001.12.04.07.27.00;	author MikeMannix;	state Exp;
branches;
next	1.39;

1.39
date	2001.12.02.10.21.38;	author PeterThoeny;	state Exp;
branches;
next	1.38;

1.38
date	2001.11.23.10.02.16;	author PeterThoeny;	state Exp;
branches;
next	1.37;

1.37
date	2001.09.18.08.07.11;	author PeterThoeny;	state Exp;
branches;
next	1.36;

1.36
date	2001.09.16.07.23.53;	author MikeMannix;	state Exp;
branches;
next	1.35;

1.35
date	2001.09.16.05.24.31;	author MikeMannix;	state Exp;
branches;
next	1.34;

1.34
date	2001.09.15.05.20.22;	author MikeMannix;	state Exp;
branches;
next	1.33;

1.33
date	2001.09.15.03.13.12;	author MikeMannix;	state Exp;
branches;
next	1.32;

1.32
date	2001.09.15.00.17.23;	author MikeMannix;	state Exp;
branches;
next	1.31;

1.31
date	2001.09.14.07.27.42;	author PeterThoeny;	state Exp;
branches;
next	1.30;

1.30
date	2001.09.09.23.03.57;	author MikeMannix;	state Exp;
branches;
next	1.29;

1.29
date	2001.09.08.22.33.11;	author MikeMannix;	state Exp;
branches;
next	1.28;

1.28
date	2001.09.07.10.03.22;	author MikeMannix;	state Exp;
branches;
next	1.27;

1.27
date	2001.09.04.01.25.06;	author MikeMannix;	state Exp;
branches;
next	1.26;

1.26
date	2001.09.01.06.51.47;	author MikeMannix;	state Exp;
branches;
next	1.25;

1.25
date	2001.09.01.04.47.30;	author MikeMannix;	state Exp;
branches;
next	1.24;

1.24
date	2001.08.31.10.55.02;	author MikeMannix;	state Exp;
branches;
next	1.23;

1.23
date	2001.08.30.17.46.04;	author MikeMannix;	state Exp;
branches;
next	1.22;

1.22
date	2001.08.30.10.34.15;	author JohnTalintyre;	state Exp;
branches;
next	1.21;

1.21
date	2001.08.12.01.03.28;	author PeterThoeny;	state Exp;
branches;
next	1.20;

1.20
date	2001.07.11.07.25.54;	author PeterThoeny;	state Exp;
branches;
next	1.19;

1.19
date	2001.03.16.08.46.08;	author PeterThoeny;	state Exp;
branches;
next	1.18;

1.18
date	2001.02.26.17.53.31;	author PeterThoeny;	state Exp;
branches;
next	1.17;

1.17
date	2000.12.30.07.58.31;	author PeterThoeny;	state Exp;
branches;
next	1.16;

1.16
date	2000.12.11.00.56.49;	author PeterThoeny;	state Exp;
branches;
next	1.15;

1.15
date	2000.11.29.02.39.21;	author PeterThoeny;	state Exp;
branches;
next	1.14;

1.14
date	2000.11.25.08.11.28;	author PeterThoeny;	state Exp;
branches;
next	1.13;

1.13
date	2000.11.14.02.19.16;	author PeterThoeny;	state Exp;
branches;
next	1.12;

1.12
date	2000.11.12.08.54.34;	author PeterThoeny;	state Exp;
branches;
next	1.11;

1.11
date	2000.11.09.02.47.01;	author PeterThoeny;	state Exp;
branches;
next	1.10;

1.10
date	2000.11.02.08.07.58;	author PeterThoeny;	state Exp;
branches;
next	1.9;

1.9
date	2000.10.27.22.05.11;	author PeterThoeny;	state Exp;
branches;
next	1.8;

1.8
date	2000.09.23.17.30.09;	author PeterThoeny;	state Exp;
branches;
next	1.7;

1.7
date	2000.08.21.00.56.28;	author PeterThoeny;	state Exp;
branches;
next	1.6;

1.6
date	2000.07.28.03.09.53;	author PeterThoeny;	state Exp;
branches;
next	1.5;

1.5
date	2000.07.18.05.40.14;	author PeterThoeny;	state Exp;
branches;
next	1.4;

1.4
date	2000.06.30.18.16.42;	author PeterThoeny;	state Exp;
branches;
next	1.3;

1.3
date	2000.05.25.01.08.56;	author PeterThoeny;	state Exp;
branches;
next	1.2;

1.2
date	2000.04.25.17.44.48;	author PeterThoeny;	state Exp;
branches;
next	1.1;

1.1
date	2000.04.22.00.42.09;	author PeterThoeny;	state Exp;
branches;
next	;


desc
@none
@


1.71
log
@buildrelease
@
text
@%META:TOPICINFO{author="TWikiContributor" date="1187845362" format="1.1" version="71"}%
%STARTINCLUDE%
---+ TWiki Installation Guide

*The following is installation instructions for the TWiki 4.2 production release on an Apache web server on Linux.* Visit TWiki:TWiki.InstallingTWiki for the latest updates to this guide and supplemental information for installing or upgrading TWiki, including notes on installing TWiki on different platforms, environments and web hosting sites.

If you are upgrading from a previous version of TWiki, you probably want to read =TWikiUpgradeGuide= instead.

Both this document and the !TWikiUpgradeGuide are also available in the root of the distribution as HTML files. For this reason links to pages inside your own TWiki are written like =TWiki.WebHome= and not like live web links.

%TOC%

---++ Preparing to install TWiki

Before attempting to install TWiki, you are encouraged to review the TWiki:TWiki.AdminSkillsAssumptions. This guide assumes the person installing TWiki has, at a minimum, basic knowledge of server administration on the system on which TWiki is to be installed. While it is possible to install TWiki with FTP access alone (for example, on a hosted site), it is tricky and may require additional support from your hosting service (for example, in setting file ownership and installing missing perl CPAN libraries).

To help setup a correct Apache configuration, you are very much encouraged to use the automatic tool TWiki:TWiki.ApacheConfigGenerator which generates the contents for an Apache config file for TWiki based on your inputs.

While this installation guide specifically describes installation on an Apache web server on Linux, TWiki should be fine with any web server and OS that meet the system requirements (see below). For additional notes on installing TWiki on other systems, see TWiki:TWiki.InstallingTWiki#OtherPlatforms.

If you are installing TWiki without Unix/Linux root (administrator) priviledges (for example, on a hosted domain), see "Notes on Installing TWiki on Non-Root Account" below for supplemental instructions to the basic steps presented below.

If you are upgrading from an earlier major version of TWiki such as Cairo (TWiki 3) you will need the information found in TWiki:TWiki.TWikiUpgradeGuide.  There is also a static HTML =TWikiUpgradeGuide.html= included in the root of your TWiki distribution.

Upgrading from a recent TWiki4 release is much simpler. Upgraders from earlier TWiki4 versions can follow the steps described in TWiki:TWiki.UpgradingTWiki04x00PatchReleases to ensure a safe upgrade without accidently overwriting customizations.

One of the more difficult tasks is installation of addition !CPAN libraries. See TWiki:TWiki.HowToInstallCpanModules for detailed information on how to install !CPAN libraries.

If you need help, ask a question in the TWiki:Support web or on TWiki:Codev.TWikiIRC (irc.freenode.net, channel #twiki) 

#StandardInstallation
---++ Basic Installation

   1 *Download* the TWiki distribution from http://TWiki.org/download.html.
   1 *Make a directory* for the installation and *unpack the distribution* in it. In the rest of this document we assume this directory is called =twiki=.
      * *Note!* that TWiki does not allow spaces in the directory names. Especially on Windows make sure to use a directory path without spaces.
   1 *Setup access file and directory rights* to enable the webserver user (the user Apache runs the CGI scripts as) to read and write inside the twiki directory.
      * *Warning!* Do not just just run a =chmod -R 770 twiki=. The access rules have different meaning for files and directories. This is the most common mistake installers make.
      * The distribution tgz has the file and directory access rights setup to work with a reasonable security level that will work for all types of installations including shared hosting.
      * The ownership of the twiki directory tree is normally set to the user that unpacked the tgz and will have to be changed to the webserver user using the command =chown -R user:group /path/to/twiki=. The webserver username varies from Distributions. Examples for some major distributions:
         * !RedHat, Fedora, !CentOS, Gentoo, Mandriva : =chown -R apache:apache /path/to/twiki=
         * debian/Ubuntu/Kubunto : =chown -R www-data:www-data /path/to/twiki=
         * Suse : =chown -R wwwrun:www /path/to/twiki=
      * If you mistakenly change the access rights in a way that makes TWiki stop working, simply run the script found at TWiki:TWiki.SettingFileAccessRightsLinuxUnix to set the access right of the entire TWiki tree back to the distributed defaults.
      * It is possible to define tighter access rules than the ones given by default after the installation is complete. But how tight they should be depends on your distribution and local needs. Typically you may want to limit all access from world if the webserver machine has login access for other users than root and the web server administrator. For a dedicated web server made just for running TWiki with limited login access the default access rights have a good safety level.
   1 *Check the Perl installation*. Ensure that Perl 5 and the Perl CGI library are installed on your system.
      * The default location of Perl is =/usr/bin/perl=. *If it's somewhere else*, change the path to Perl in the first line of each script in the =twiki/bin= directory.
      * Some systems require a special extension on perl scripts (e.g. =.cgi= or =.pl=). This is normally only needed under Windows and only where perl scripts are only recognized by file extension. Linux and Unix users should normally never need to do this. If necessary, rename all files in =twiki/bin=  (i.e. rename =view= to =view.pl= etc). If you do this, make sure you set the =ScriptSuffix= option in =configure= (Step 6).
   1 *Create the file !LocalLib.cfg* located as =twiki/bin/LocalLib.cfg=
      * There is a template for this file in =twiki/bin/LocalLib.cfg.txt=. Simply copy LocalLib.cfg.txt to LocalLib.cfg. Make sure the ownership and access rights of the copy are the same as LocalLib.cfg.txt
      * The file =twiki/bin/LocalLib.cfg= must contain a setting for =$twikiLibPath=, which must point to the absolute file path of your =twiki/lib= e.g. =/var/www/twiki/lib=.<br />
      * If you need to install additional [[http://cpan.perl.org/][CPAN]] modules, but can't update the main Perl installation files on the server, you can set =$CPANBASE= to point to your personal [[http://cpan.perl.org/][CPAN]] install. Don't forget that the webserver user has to be able to read those files as well.
   1 *Choose best configuration method* for your webserver. There are two ways to configure Apache: config file included from httpd.conf or .htaccess files
      * Apache config file: The recommended method is using a config file. With a config file you can put the entire TWiki configuration in ONE file (typically named =twiki.conf=). Performance is much better with a config file, and one file gives the best overview and ensures that you get a safe installation . However using a config file requires that you can restart Apache which again means that you need root or sudo access to stop and start Apache. The TWiki apache config file is included from the main Apache config file http.conf. Most distributions have a directory from which any file that ends with =.conf= gets included when you restart Apache (Example !RedHat/Fedora/Centos: /etc/httpd/conf.d). If you use a virtual host setup in Apache you should include the twiki.conf file from inside the desired virtual host config in your Apache configuration.
      * .htaccess file: This should only be used when you cannot use a config file. Performance is slowed down because Apache has to look through _all_ directories in search for possible .htaccess files each time someone views a page in TWiki. Normally this is the only way to control Apache in a shared host environment where you have no root or sudo priviledges.
   1 *Configure the webserver*
      * Unless you are an Apache expert setting up the webserver can be quite difficult. But TWiki has three resources that make setting up Apache easier.
         * The best and easiest way is to use webpage TWiki:TWiki.ApacheConfigGenerator which contains a tool that can generate a safe and working config file for TWiki on Apache.
         * In the root of the twiki installation you find an example config file =twiki_httpd_conf.txt=
         * In the root of the twiki installation and in the =twiki/bin= directory you find example =.htaccess= files you can copy and modify. The files contains help text explaining how to set them up. In =twiki/bin= you find =.htaccess.txt= which can be copied to =.htaccess= and defined access to the CGI scripts. In the root of TWiki you find =pub-htaccess.txt= which you can copy to =pub/.htaccess=, =subdir-htaccess.txt= which you can copy to all directories as =.htaccess= except bin and pub, and you find =root-htaccess.txt= which you can copy to =.htaccess= in the twiki root directory. But again only use .htaccess files if you do not have root priviledges.
      * If you are unsure about how to do this on your system, see TWiki:TWiki.InstallingTWiki#OtherPlatforms for links to information about various server setups.
      * *Note!* When you use config files you need to restart Apache each time you change a setting to make the new setting active.
   1 *Protect the configure script*
      * You should never leave the =configure= script open to the public. Limit access to the =twiki/bin/configure= script to either localhost, an IP address or a specific user using basic Apache authentication. The TWiki:TWiki.ApacheConfigGenerator lets you setup who has access to the configure script. Also the example twiki-httpd-conf.txt and bin/.htaccess.txt files includes the needed setting to protect the configure script.
      * If you limit the access to a particular user then you need to setup a .htpasswd file that contains the user name and password that Apache will authenticate against. Per default both TWiki:TWiki.ApacheConfigGenerator and the example config files and .htaccess files uses =twiki/data/.htpasswd= but this file does not exist until you have TWiki running and have registered the first user. You therefore have two options. Either limit the access to localhost or an IP address, or make a .htpasswd file. To make a .htpasswd file change directory to =twiki/data= and issue the command =htpasswd -c .htpasswd username= and enter your password when asked. The username must match the =Require user username= directive in the Apache config file or .htaccess file. Do not use a username you will later use to register in TWiki because TWiki will then claim that you are already registered.
   1 *Run the =configure= script* from your browser (enter =http://yourdomain/twiki/bin/configure= into your browser address bar)
      * Resolve any errors or warnings it tells you about.
      * *Note!* When you run =configure= for the first time, you can only edit the section =General Path Settings=. Save these settings, and then return to =configure= to continue configuration.
      * If your webserver can be accessed by more than one domain name make sure to add the additional alternative URLs to ={PermittedRedirectHostUrls}=
      * When you return to configure you now need to setup _Mail and Proxies_. Especially the ={WebMasterEmail}=, and ={SMTP}{MAILHOST}= must be defined to enable TWiki to send registration emails. Many ISPs have introduced authentication when sending emails to fight spam so you may also have to set ={SMTP}{Username}= and ={SMTP}{Password}=. If you do not want to enable mailing or want to enable it later you can uncheck ={EnableEmail}=.

You now have a basic, unauthenticated installation running. At this point you can just point your Web browser at =http://yourdomain.com/twiki/bin/view= and start TWiki-ing away!

---++ Important Server Security Settings
Before you continue any further there are some basic and very important security settings you have to make sure are set correctly.

   * As already described above you should protect the configure script from general access. The configure script is designed for use by administrators only and should be restricted to invocation by them only, by using the basic Apache authentication. Because of this there has not been put much effort into hardening the script. The configure script cannot save any settings once the password has been saved the first time, but the script could still be vulnerable to specially crafted field values and the script reveals many details about the webserver that you should not display in public.
   * You absolutely must turn off any kind of PHP, Perl, Python, Server Side Includes etc in the =pub= directory. TWiki has some built-in protection which renames files with dangerous filenames by appending .txt to the filename. But this is a secondary security measure. The essential action that you must take is to turn off any possible execution of any of the attached files.<br /> Most Linux distributions have a default Apache installation which has PHP and server side include (SSI) enabled.
   * Make sure that you deny access to all other twiki directories than the =bin= and =pub= directories. When you have access to the Apache config files the =twiki_httpd_conf.txt= file mentioned above also contains protection of these directories.<br />
     For those that do not have access to the Apache config files a sample =subdir-htaccess.txt= file can be copied as =.htaccess= to the data, lib, locale, templates, tools and working directories.

The TWiki:TWiki.ApacheConfigGenerator as well as the example =twiki_httpd_conf.txt= and example =htaccess.txt= files include the needed settings that protect against all 3 security elements.

---++ Next Steps

Once you have TWiki installed and running, you might consider the following optional steps for setting up and customizing your TWiki site. Many of the references below refer to topics within your TWiki installation. For example, =TWiki.TWikiSkins= refers to the =TWikiSkins= topic in your TWiki web. Easy way to jump directly to view the pages is to open your own TWiki in your browser and write =TWiki.TWikiSkins= in the Jump test box to the right in the top bar and hit Enter. You can find these topics in the on-line reference copy at the official TWiki website: [[TWiki:TWiki04x02.WebHome][TWiki Release 4.2]]

#AuthenticationOfUsers
---++ Enable Authentication of Users

This step provides for site access control and user activity tracking on your TWiki site. __This is particularly important for sites that are publicly accessible on the web.__ This guide describes only the most common of several possible authentication setups for TWiki and is suitable for public web sites. For information about other setups, see =TWiki.TWikiUserAuthentication=, and TWiki:TWiki.TWikiUserAuthenticationSupplement.

These are the steps for enabling "Template Login" which asks for a username and password in a web page, and processes them using the Apache 'htpasswd' password manager. Users can log in and log out.

   1 Under the =Security Settings= pane of =configure= :
      1 Select =TWiki::LoginManager::TemplateLogin= for ={LoginManager}=.
      1 Select =TWiki::Users::HtPasswdUser= for ={PasswordManager}=.
      1 Save your =configure= settings.
      1 Register yourself using the =TWiki.TWikiRegistration= topic.<br />
     %H% Check that the password manager recognizes the new user. Check that a new line with the username and encrypted password is added to the =data/.htpasswd= file. If not, you probably got a path wrong, or the permissions may not allow the webserver user to write to that file.
   1 Edit a topic (by clicking on the =Edit= link at beginning or end of topic) to check if authentication works.

You are strongly encouraged to read =TWiki.TWikiUserAuthentication=, TWiki:TWiki.TWikiUserAuthenticationSupplement, and TWiki:TWiki.SecuringTWikiSite for further information about managing users and security of your TWiki site.

*Note!* The other =LoginManager= option =TWiki::LoginManager::ApacheLogin= uses a basic Apache type authentication where the browser itself prompts you for username and password. Most will find the !TemplateLogin looking nicer. But !ApacheLogin is required when you use Apache authentication methods like mod_ldap where all authentication is handled by an Apache module and not by the TWiki perl code. When you use !ApacheLogin the apache configuration must be set up to require authentication of the some but not all the scripts in the bin directory. This section in the Apache config (or .htaccess) controls this

<verbatim>
<FilesMatch "(attach|edit|manage|rename|save|upload|mail|logon|rest|.*auth).*">
	require valid-user
</FilesMatch>
</verbatim>

The TWiki:TWiki.ApacheConfigGenerator includes this section when you choose _ApacheLogin_. In the example =twiki_httpd_conf.txt= and =bin/.htaccess.txt= files this section is commented out with #. Uncomment the section when you use _ApacheLogin_. It is important that this section is commented out or removed when you use _TemplateLogin_.

#DefineAdminUser   
---++ Define the Administrator User(s)

Administrators have read and write access to any topic in TWiki, irrespectively of TWiki access controls. When you install TWiki one of the first things you will want to do is define yourself as an administrator. You become an administrator simply by adding yourself to the =TWikiAdminGroup=. It is the WikiName and not the login name you add to the group. Editing the =Main.TWikiAdminGroup= topic requires that you are an administrator. So to add the first administrator you need to login using the internal TWiki admin user login and the password you defined in configure.

   * Navigate to the =Main.TWikiAdminGroup= topic
   * Follow carefully the steps =Main.TWikiAdminGroup= of how to become an admin
   * Note that if you use _ApacheLogin_ you have to be registered and logged in before you use the _internal admin login_

#SetPreferences
---++ Set TWiki Preferences

Preferences for customizing many aspects of TWiki are set simply by editing a special topic with TWiki.

   * =TWiki.TWikiPreferences=. Read through it and identify any additional settings or changes you think you might need. You can edit the settings in =TWiki.TWikiPreferences= but these will be overwritten when you later upgrade to a newer TWiki version. Instead copy any settings or variables that you want to customize from =TWiki.TWikiPreferences= and paste them into =Main.TWikiPreferences=.  When you later upgrade TWiki simply avoid overwriting the =data/Main/TWikiPreferences.txt= file and all your settings will be kept. Settings in =Main.TWikiPreferences= overrides settings in both =TWiki.TWikiPreferences= and any settings defined in Plugin topics. See notes at top of =TWiki.TWikiPreferences= for more information.

---++ Enable Email Notification

Each TWiki web has an automatic email notification service that sends you an email with links to all of the topics modified since the last alert. To enable this service:
   1 Confirm the Mail and Proxies settings in the Configure interface.
   1 Setup a cron job (or equivalent) to call the =tools/mailnotify= script as described in the =TWiki.MailerContrib= topic.

---++ Enable !WebStatistics

You can generate a listing manually, or on an automated schedule, of visits to individual pages, on a per web basis. For information on setting up this feature, see the =TWiki.TWikiSiteTools= topic.

---++ Automate removal of expired sessions and lease files

Per default TWiki cleans out expired session and lease files each time any topic is viewed. This however cost performance. It is an advantage to define a negative value in =configure= for {Sessions}{ExpireAfter} and install let cron run the =tools/tick_twiki.pl= script. Read The topic =TWikiScripts#tick_twiki_pl= for details how to do this.

---++ Enable Localisation

TWiki now supports displaying of national (non-ascii) characters and presentation of basic interface elements in different languages. To enable these features, see the =Localisation= section of =configure=. For more information about these features, see TWiki:TWiki.InternationalizationSupplement.

#TailorUsersTopic
---++ Tailor New Users Home Topic

When a new users registers on your TWiki, a home topic is created for them based on the =TWiki.NewUserTemplate= topic (and its =TWiki.UserForm=). It contains additional resources you can use to:
   * Localise the user topic.
   * Add a default ALLOWTOPICCHANGE so only the user can edit their own home topic. We do not encourage this for Intranet sites as it sends a wrong signal to new users, but it can be necessary on a public TWiki to prevent spam.
   * Add and remove fields defined in the =TWiki.UserForm=

If you choose to tailor anything you are strongly adviced to copy =NewUserTemplate= and =UserForm= to the Main web and tailor the Main web copies. TWiki will look for the =NewUserTemplate= in the Main web first and if it does not exist it uses the default from the TWiki web. By creating a =Main.NewUserTemplate= and its =Main.UserForm= you will not loose your tailorings next time you upgrade TWiki.

If you added or removed fields from the user form you may also need to tailor =TWiki.TWikiRegistration=.

---++ Install Plugins
TWiki:Plugins is an extensive library of Plugins for TWiki, that enhance functionality in a huge number of ways. A few plugins are pre-installed in the TWiki distribution. For more information on these, see =TWiki.InstalledPlugins=.

You activate installed plugin in the _Plugins_ section of =configure=. In this section you also find a _Find More Extensions_ button which opens an application which can install additional plugins from the TWiki.org website. If you are behind a firewall or your server has no access to the Internet it is also possible to install plugins manually. Manual installation instructions for the plugins can be found in the plugin topics on TWiki.org. Additional documenation on TWiki plugins can be found at TWiki:TWiki.TWikiPluginsSupplement.

Some plugins require that you define their settings in =configure=. You fill find these under the _Extensions_ section of configure.

---++ Customize Your TWiki!

The real power of TWiki lies in it's flexibility to be customized to meet your needs. You can with small means change the looks of the default skin (called !PatternSkin) by reading the =TWiki.PatternSkinCustomization=

At the official TWiki website you can find more resources. A good place to start for exploring what's possible is <a href="http://twiki.org/cgi-bin/view/TWiki/TWikiAdminCookBook" title="'TWiki/TWikiAdminCookBook' on TWiki.org">TWiki:TWiki.TWikiAdminCookBook</a> which offers tips and tricks for customizing your TWiki site. Many of these are appropriate to implement immediately after installing TWiki and before adding content so now's a good time to look at these.

---++ Customization of Special Pages

Some pages are meant to be customized after choice of authentication. If you do not use the internal TWiki password manager the topics that contains the features for changing and resetting passwords and changing the email address should be changed to a note describing how to perform these tasks in your organization. The topics are:

   * =TWiki.ChangePassword=
   * =TWiki.ResetPassword=
   * =TWiki.ChangeEmailAddress=
   
---++ WYSIWYG vs Raw Edit

From TWiki release 4.2.0 the WYSIWYG editor has been replaced by a much better and more powerful editor and it was decided that WYSIWYG would be the default edit mode. An Edit Raw link is available for those that have a need or preference for this mode.

However you may prefer to have the same user interface as in TWiki 4.1 where _Edit_ was the raw text editor and you had a WYSIWYG button. You can modify the templates that define the buttons by following the description on TWiki:Codev.TWikiRawEditDefault04x02.
   
---++ Copyright, License and Classification Statements

In the bottom of each topic you will find a default copyright messages saying "Copyright &&copy; by the contributing authors. All material on this collaboration platform is the property of the contributing authors." It is a setting WEBCOPYRIGHT that defines this. This is often not adequate.

   * If your TWiki is used in a commercial application without public access you should replace this by your normal copyright notice. You should also consider adding classifications (e.g. For Internal Use Only) so people do not have to add this manually to every new topic.
   * If your TWiki is public with public access you need to decide which copyright and license the contributions should be covered by. For open source type applications licenses such as <a href="http://www.gnu.org/licenses/fdl.html">the GNU Free Documentation License</a>, <a href="http://www.freebsd.org/copyright/freebsd-doc-license.html">FreeBSD Documentation License</a>, and <a href="http://creativecommons.org/licenses/">Creative Commons license</a> are possible licenses to consider. Remember that once people have started contributing it is difficult and not correct to change or impose licenses on existing contributions.

You change the copy right statement globally by taking these steps.

   * Copy the setting WEBCOPYRIGHT from =TWiki.TWikiPreferences= to =Main.TWikiPreferences= and alter the copied text to your need.
   * You can create a unique message for each web by adding the WEBCOPYRIGHT setting to =WebPreferences= in each web. E.g. adding a confidencial classification to a very restricted web.
   * The WEBCOPYRIGHT in =TWiki.WebPreferences= covers the documentation that comes with TWiki and is covered by the original TWiki Copyright and GPL License. You will normally leave this unchanged.

---++ Troubleshooting

The first step is to re-run the =configure= script and make sure you have resolved all errors, and are satisfied that you understand any warnings.

Failing that, please check <b><a href="http://twiki.org/cgi-bin/view/TWiki.InstallingTWiki" title="'TWiki.InstallingTWiki' on TWiki.org">TWiki:TWiki.InstallingTWiki</a></b> on TWiki.org, the supplemental documentation that help you <b>install TWiki on different platforms, environments and web hosting sites</b>. For example:
   * For Unix or Linux, check <a href="http://twiki.org/cgi-bin/view/Codev/TWikiOnUnix" title="'Codev/TWikiOnUnix' on TWiki.org">TWiki:Codev.TWikiOnUnix</a> and <a href="http://twiki.org/cgi-bin/view/Codev/TWikiOnLinux" title="'Codev/TWikiOnLinux' on TWiki.org">TWiki:Codev.TWikiOnLinux</a>.
   * For Windows, check the <a href="http://twiki.org/cgi-bin/view/Codev/WindowsInstallCookbook" title="'Codev/WindowsInstallCookbook' on TWiki.org">TWiki:Codev.WindowsInstallCookbook</a>. 
   * For !MacOS X, check TWiki:Codev.TWikiOnMacOSX.

It is also advisable to review TWiki:Codev.KnownIssuesOfTWiki04x02.

If you need help, ask a question in the TWiki:Support web or on TWiki:Codev/TWikiIRC (irc.freenode.net, channel #twiki)

---++ Appendices


#SystemRequirements
---++ TWiki System Requirements

Low client and server base requirements are core features that keep TWiki widely deployable, particularly across a range of browser platforms and versions. 

---+++ Server Requirements

TWiki is written in Perl 5, uses a number of shell commands, and requires <a href="http://www.gnu.org/software/rcs/rcs.html" rel="nofollow" target="_top">RCS (Revision Control System)</a>, a GNU Free Software package. TWiki is developed in a basic Linux/Apache environment. It also works with Microsoft Windows, and should have no problem on any other platform that meets the requirements.


| *Resource* | *Required Server Environment* |
| Perl | 5.8.4 or higher is recommended. TWiki will run in perl 5.6.1 but only with Wysiwyg editor disabled. Wysiwyg requires unicode support which is provided by perl 5.8.1 and forward. |
| RCS | 5.7 or higher (including GNU =diff=) <br /> Optional, TWiki includes a pure perl implementation of RCS that can be used instead (although it's slower) |
| GNU =diff= | GNU =diff= 2.7 or higher is required when not using the all-Perl RcsLite.  <br /> Install on PATH if not included with RCS (check version with =diff -v=)  <br /> Must be the version used by RCS, to avoid problems with binary attachments - RCS may have hard-coded path to =diff= |
| Other external programs | =fgrep, egrep= |
| Cron/scheduler | &#8226; Unix: =cron= <br />&#8226; Windows: =cron= equivalents <!-- SMELL: Macintosh version? --> |
| Web server | Apache is well supported; for information on other servers, see <a href="http://twiki.org/cgi-bin/view/TWiki.InstallingTWiki#OtherWebServers" title="'TWiki.InstallingTWiki#OtherWebServers' on TWiki.org">TWiki:TWiki.InstallingTWiki#OtherWebServers</a>. |

---+++ Required CPAN Modules

Most of the !CPAN libraries listesd below are part of a standard Perl installation so you most likely have them all!

See <a href="http://twiki.org/cgi-bin/view/TWiki/HowToInstallCpanModules" title="'TWiki/HowToInstallCpanModules' on TWiki.org">TWiki:TWiki.HowToInstallCpanModules</a> for detailed information on how to install !CPAN libraries



The following Perl <a href="http://cpan.perl.org/" rel="nofollow" target="_top">CPAN</a> modules are used by TWiki:

| *Module* | *Preferred version* |
| Algorithm::Diff (included) | &nbsp; |
| CGI | Versions 2.89 and 3.37 must be avoided. Most version from 3.15 and onwards should work. |
| CGI::Carp | &gt;=1.26 |
| Config | &gt;=0 |
| Cwd | &gt;=3.05 |
| Data::Dumper | &gt;=2.121 |
| Error (included) | &nbsp; |
| File::Copy | &gt;=2.06 |
| File::Find | &gt;=1.05 |
| File::Spec | &gt;=3.05 |
| !FileHandle | &gt;=2.01 |
| IO::File | &gt;=1.10 |
| Text::Diff (included) | &nbsp; |
| Time::Local | &gt;=1.11 |

---+++ Optional CPAN Modules

The following Perl modules may be used by TWiki:

See <a href="http://twiki.org/cgi-bin/view/TWiki/HowToInstallCpanModules" title="'TWiki/HowToInstallCpanModules' on TWiki.org">TWiki:TWiki.HowToInstallCpanModules</a> for detailed information on how to install !CPAN libraries

| *Module* | *Preferred version* | *Description* |
| Archive::Tar | &nbsp; | May be required by the Extensions Installer in configure if command line tar or unzip is not available |
| CGI::Cookie | &gt;=1.24 | Used for session support |
| CGI::Session | &gt;=3.95 | Highly recommended! Used for session support |
| Digest::base | &nbsp; | &nbsp; |
| Digest::SHA1 | &nbsp; | &nbsp; |
| Jcode | &nbsp; | Used for !I18N support with perl 5.6 |
| Locale::Maketext::Lexicon | &gt;=0 | Used for !I18N support |
| Net::SMTP | &gt;=2.29 | Used for sending mail |
| Unicode::Map | &nbsp; | Used for !I18N support with perl 5.6 |
| Unicode::Map8 | &nbsp; | Used for !I18N support with perl 5.6 |
| Unicode::MapUTF8 | &nbsp; | Used for !I18N support with perl 5.6 |
| Unicode::String | &nbsp; | Used for !I18N support with perl 5.6 |
| URI | &nbsp; | Used for configure |

Most of them will probably already be available in your installation. You can check version numbers with the =configure= script, or if you're still trying to get to that point, check from the command line like this:

<pre>
perl -e 'use FileHandle; print $FileHandle::VERSION."\n"'
</pre>

#ClientRequirements
---+++ Client Requirements

The TWiki standard installation has relatively low browser requirements:

   * HTML 3.2 compliant
   * Cookies, if persistent sessions are required

CSS and Javascript are used in most skins, although there is a low-fat skin (Classic skin) available that minimises these requirements. Some skins will require more recent releases of browsers. The default skin (Pattern) is tested on IE 6, Safari, and Mozilla 5.0 based browsers (such as Firefox).

You can easily select a balance of browser capability versus look and feel. Try the installed skins at =TWiki/TWikiSkinBrowser= and more at TWiki:Plugins.SkinPackage.

---+++ Important note about TWiki Plugins

   * Plugins can require just about anything -  browser-specific functions, stylesheets (CSS), Java applets, cookies, specific Perl modules,... - check the individual Plugin specs.
      * __%T% Note:__ Plugins included in the TWiki distribution do not add requirements, except for the CommentPlugin which requires Perl 5.6.1.

#NonRootInstallNotes
---++ Notes on Installing TWiki on Non-Root Account

The following supplemental notes to the <a href="#StandardInstallation" class="twikiAnchorLink">Basic Installation</a> instructions apply to installing 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.

Referring to the <a href="#StandardInstallation" class="twikiAnchorLink">Basic Installation</a> steps presented above:

   * *Step 2:* If you cannot unpack the TWiki distribution directly in your installation directory, you can unpack the distribution on your local PC and then manually create the directory structure on your host server and upload the files as follows:
      * Using the table below, create a directory structure on your host server
      * Upload the TWiki files by FTP (transfer as text except for the image files in =pub= directory.)
      * __Note:__ Don't worry if you are not able to put 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 configure the =twiki/bin/setlib.cfg= file (done in Step 2).

<blockquote>

| *TWiki dir:* | *What it is:* | *Where to copy:* | *Example:* |
| =twiki= | start-up pages | root TWiki dir | =/home/smith/twiki/= |
| =twiki/bin= | CGI bin | CGI-enabled dir | =/home/smith/twiki/bin= |
| =twiki/lib= | library files | same level as =twiki/bin= | =/home/smith/twiki/lib= |
| =twiki/locale= | language files | dir secure from public access | =/home/smith/twiki/locale= |
| =twiki/pub= | public files | htdoc enabled dir | =/home/smith/twiki/pub= |
| =twiki/data= | topic data | dir secure from public access | =/home/smith/twiki/data= |
| =twiki/templates= | web templates | dir secure from public access | =/home/smith/twiki/templates= |
| =twiki/tools= | TWiki utlilities | dir secure from public access | =/home/smith/twiki/tools= |
| =twiki/working= | Temporary and internal files | dir secure from public access | =/home/smith/twiki/working= |

</blockquote>

   * *Step 3:* Files in the pub directory must be readable as a url. This means that directory permissions should be set to =755= (or =775= ) and file permissions should be set to =644= (or =664=). If you can run a =chmod= command, you can accomplish this in two quick steps by running these commands from the root direct:
      * =chmod -R 755 pub=
      * =chmod 644 `find pub -type f -print`=
      * In addition, you should create a =.htaccess= file in the pub directory, using the template included in the root level of the distribution entitled =pub-htaccess.txt=.
      * Note: This setup does not provide for absolute security for TWiki attachments. For more information, see TWiki:Codev.SecuringYourTWiki.

   * *Step 6:* In order to run the configure script, create a file called =.htaccess= in the bin directory that includes the following single line: =SetHandler cgi-script= . This informs the server to treat all the perl scripts in the bin directory as scripts.

For additional information about installing TWiki on a hosted accounts, see TWiki:TWiki.InstallingTWiki#WebHostingSites

---++ Installing Manually Without Configure

It is highly recommended to use run configure from the browser when setting up TWiki. Configure does a lot of the hard work for you.

But there may be instances where you do not want to use configure or where configure simply won't run because of a missing dependency.

The manual steps you have to take are:

   * Copy the file =lib/TWiki.spec= to =lib/LocalSite.cfg=
   * Remove the comment # in front of =$TWiki::cfg{DefaultUrlHost}=, =$TWiki::cfg{ScriptUrlPath}=, =$TWiki::cfg{PubUrlPath}=, =$TWiki::cfg{PubDir}=, =$TWiki::cfg{TemplateDir}=, =$TWiki::cfg{DataDir}=, =$TWiki::cfg{LocalesDir}=, and =$TWiki::cfg{OS}= and make sure these settings have the correct values.
   * Make sure to define at least these settings: =$TWiki::cfg{LoginManager}=, =$TWiki::cfg{WebMasterEmail}=, =$TWiki::cfg{SMTP}{MAILHOST}=, =$TWiki::cfg{SMTP}{SENDERHOST}=. 

%STOPINCLUDE%

__Related Topics:__ AdminDocumentationCategory, TWiki:TWiki.InstallingTWiki

@


1.70
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1187845362" format="1.1" version="70"}%
d96 1
a96 1
      1 Select =TWiki::Client::TemplateLogin= for ={LoginManager}=.
d105 1
a105 1
*Note!* The other =LoginManager= option =TWiki::Client::ApacheLogin= uses a basic Apache type authentication where the browser itself prompts you for username and password. Most will find the !TemplateLogin looking nicer. But !ApacheLogin is required when you use Apache authentication methods like mod_ldap where all authentication is handled by an Apache module and not by the TWiki perl code. When you use !ApacheLogin the apache configuration must be set up to require authentication of the some but not all the scripts in the bin directory. This section in the Apache config (or .htaccess) controls this
@


1.69
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1187845362" format="1.1" version="69"}%
d228 1
a228 1
| Perl | 5.8.4 or higher is recommended |
d247 1
@


1.68
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1170183233" format="1.1" version="68"}%
d3 1
a3 1
---+!! TWiki Installation Guide
d5 1
a5 1
*The following is installation instructions for the TWiki 4.1 production release on an Apache web server on Linux.* Visit TWiki:TWiki.InstallingTWiki for the latest updates to this guide and supplemental information for installing or upgrading TWiki, including notes on installing TWiki on different platforms, environments and web hosting sites.
d7 3
a9 1
If you are upgrading from a previous version of TWiki, you probably want to read TWikiUpgradeGuide instead (both this document and the !TWikiUpgradeGuide are also available in the root of the distribution as HTML files)
d15 1
a15 1
Before attempting to install TWiki, you are encouraged to review the TWiki:TWiki.AdminSkillsAssumptions. This guide assumes the person installing TWiki has, at a minimum, basic knowledge of server administration and cgi script management on the system on which TWiki is to be installed. While it is possible to install TWiki with FTP access alone (for example, on a hosted site), it is tricky and may require additional support from your hosting service (for example, in setting file ownership).
d17 1
a17 1
To help setup a correct Apache configuration, you can use the automatic TWiki:TWiki.ApacheConfigGenerator which generates the contents for an Apache config file for TWiki based on your inputs.
d21 3
a23 1
If you are installing TWiki without Unix/Linux root (administrator) privileges (for example, on a hosted domain), see "Notes on Installing TWiki on Non-Root Account" below for supplemental instructions to the basic steps presented below.
d25 1
a25 1
If you are upgrading from an earlier major version of TWiki such a Cairo (TWiki 3) you will need the information found in TWiki:TWiki.TWikiUpgradeGuide which includes a description of both an automated and a manual procedure. The manual procedure is probably the safest to follow but takes more time. The upgrade guide describes essential steps needed to avoid problems with locked topics. 
d27 1
a27 1
Upgrading from a recent TWiki4 release is much simpler. Upgraders from earlier TWiki4 versions can with advantage follow the steps described in TWiki:TWiki.UpgradingTWiki04x00PatchReleases to ensure a safe upgrade without accidently overwriting customizations.
d36 35
a70 18
   1 *Make sure* the user that runs CGI scripts on your system can read and write all files in the distribution. <br />
     Detailed instructions on file permissions are beyond the scope of this guide, and the best and safest set of file and directory permissions depend on the actual server environment. For Unix/Linux see TWiki:TWiki.SettingFileAccessRightsLinuxUnix which contains scripts to setup the right file and directory access rights.<br />
     The general rules for access rights are:
      * During installation and configuration, the CGI user needs to be able to read and write _everything_ in the distribution.
      * Once installation and configuration is complete, the CGI user needs write access to everything under the =data= and =pub= directories and to =twiki/lib/LocalSite.cfg=. _Everything else_ should be read-only.
      * Everybody else should be denied access to everything, always.
   1 *Make sure* Perl 5 and the Perl CGI library are installed on your system.<br />
     The default location of Perl is =/usr/bin/perl=. *If it's somewhere else*, change the path to Perl in the first line of each script in the =twiki/bin= directory.<br />
     %H% Some systems require a special extension on perl scripts (e.g. =.cgi= or =.pl=). If necessary, rename all files in =twiki/bin=  (i.e. rename =view= to =view.pl= etc). If you do this, make sure you set the =ScriptSuffix= option in =configure= (Step 6).
   1 *Create the file* =twiki/bin/LocalLib.cfg=.<br />
     There is a template for this file in =twiki/bin/LocalLib.cfg.txt=.<br />
     The file =twiki/bin/LocalLib.cfg.txt= must contain a setting for =$twikiLibPath=, which must point to the absolute file path of your =twiki/lib= e.g. =/home/httpd/twiki/lib=.<br />
     %H% If you need to install additional [[http://cpan.perl.org/][CPAN]] modules, but can't update the main Perl installation files on the server, you can set =$CPANBASE= to point to your personal [[http://cpan.perl.org/][CPAN]] install. Don't forget that the webserver user has to be able to read those files as well.
   1 *Configure the webserver* so you can execute the =bin/configure= script from your browser. But limit the access to either localhost, an IP address or a specific user using basic Apache authentication. You should never leave the =configure= script open to the public. See TWiki:TWiki.ApacheConfigGenerator which contains a tool that can generate a safe and working config file for TWiki on Apache.
      * If you are unsure about how to do this on your system, see TWiki:TWiki.InstallingTWiki#OtherPlatforms for links to information about various server setups. There is an example Apache =httpd.conf= file in =twiki_httpd_conf.txt= at the root of the package. This file also contains advice on securing your installation. There's also a script called =tools/rewriteshebang.pl= to help you in fixing up the shebang lines in your CGI scripts.
   1 *Run the =configure= script* from your browser (i.e. enter =http://yourdomain/twiki/bin/configure= into your browser address bar) and resolve any errors or warnings it tells you about.<br />
     %X% When you run =configure= for the first time, you can only edit the section =General Path Settings=. Save these settings, and then return to =configure= to continue configuration.<br />
     When you return to configure you now need to setup _Mail and Proxies_. Especially the ={WebMasterEmail}=, and ={SMTP}{MAILHOST}= must be defined to enable TWiki to send registration emails. Many ISPs have introduced authentication when sending emails to fight spam so you may also have to set ={SMTP}{Username}= and ={SMTP}{Password}=. 
d77 2
a78 3
   * You should protect the configure script from general access. The configure script the tool is designed for use by administrators only and should be restricted to invocation by them only, by using the basic Apache authentication. Because of this there has not been put much effort into hardening the script. The configure script cannot save any settings once the password has been saved the first time, but the script could still be vulnerable to specially crafted field values and the script reveals many details about the webserver that you should not display in public.
   * You absolutely must turn off any kind of PHP, Perl, Python, Server Side Includes etc in the =pub= directory. TWiki has some builtin protection which renames files with dangerous filenames by appending .txt to the filename. But this is a secondary security measure. The essential action that you must take is to turn off any possible execution of any of the attached files.<br /> Most Linux distributions have a default Apache installation which has PHP and server side include (SSI) enabled. The =twiki_httpd_conf.txt= file provided in the root of the twiki directory is an example of an Apache config file which you would normally include from httpd.conf. In many distributions this happens automatically if the file is copied to a specific directory (Example !RedHat/Fedora/Centos: /etc/httpd/conf.d) and has suffix =.conf=. This example file shows how to protect the =pub= directory from executing both PHP scripts and server side includes.<br />
     If you do not have access to the apache config files you can normally control control access by placing a file called =.htaccess= in the directory you want to protect. The =pub-htaccess.txt= file provided in the root of the twiki directory is an example of an Apache =.htaccess= file which protects against execusion of PHP and SSI scripts.
d80 1
a80 1
     For those that do not have access to the Apache config files a sample =subdir-htaccess.txt= file can be copied as =.htaccess= to the data, lib, locale, templates and tools directories.
d82 1
a82 1
The TWIki:TWiki.ApacheConfigGenerator will help you address all 3 security elements.
d86 1
a86 1
Once you have TWiki installed and running, you might consider the following optional steps for setting up and customizing your TWiki site. Many of the references below refer to topics within your TWiki installation. For example, =TWiki.TWikiSkins= refers to the =TWikiSkins= topic in your TWiki web. If not available locally, you can find these topics in the on-line reference copy of [[TWiki:TWiki04x01.WebHome][TWiki Release 4.1]].
a101 3
   1 Edit the =Main/TWikiAdminGroup= topic to include users with system administrator status. Additional instructions are provided in that topic.<br />
   %X% This is a very important step, as users in this group can access all topics, independent of TWiki access controls.
   1 Clear admin notes: Some pages are meant to be customized after choice of authentication - check and update these topics (remove notice): =Main.TWikiAdminGroup=, =TWiki.ChangePassword=, =TWiki.ResetPassword=, and =TWiki.ChangeEmailAddress=.
d103 20
a122 1
You are strongly encouraged to read =TWiki.TWikiUserAuthentication=, TWiki:TWiki.TWikiUserAuthenticationSupplement, and TWiki:TWiki.SecuringTWikiSite for further information about managing users and security of your TWiki site. 
d129 1
a129 2
   * Edit =TWiki.TWikiPreferences=. Read through it and set any additional settings you think you might need. (You can click the 'Edit' button near the top to edit the settings in place).
   * %T% Alternately, you can copy any settings or variables that you want to customize from =TWiki.TWikiPreferences= and paste them into =Main.TWikiPreferences=. This will protect your local customizations from being overwritten in later upgrades. See notes at top of =TWiki.TWikiPreferences= for more information.
d135 1
a135 1
   1 Setup a cron job (or equivalent) to call the =bin/mailnotify= script as described in the =TWiki.MailerContrib= topic.
d143 1
a143 1
Per default TWiki cleans out expired session and lease files each time any topic is viewed. This however cost performance. It is an advantage to define a negative value in =configure= for {Sessions}{ExpireAfter} and install let cron run the =tools/tick_twiki.pl= script. Read The topic TWikiScripts#tick_twiki_pl for details how to do this.
d147 1
a147 1
TWiki now supports displaying of national (non-ascii) characters and presentation of basic interface elements in different languages. To enable these features, see the =Localisation= section of =configure=. For more information about these features, see <a href="http://twiki.org/cgi-bin/view/TWiki.InternationalizationSupplement" title="'TWiki.InternationalizationSupplement' on TWiki.org">TWiki:TWiki.InternationalizationSupplement</a>.
d149 1
d152 1
a152 1
When a new users registers on your TWiki a home topic is created for him based on the =TWiki/NewUserTemplate= template topic. This can be tailored. It contains additional resources you can use to:
d154 6
a159 1
   * Add a default ALLOWTOPICCHANGE so only the user can edit his own home topic. We do not encourage this for Intranet sites as it sends a wrong signal to new users, but it can be necessary on a public TWiki to avoid that the user topics get spammed.
a166 1
---++ Customize your TWiki!
d168 32
a199 1
The real power of TWiki lies in it's flexibility to be customized to meet your needs. A good place to start for exploring what's possible is <a href="http://twiki.org/cgi-bin/view/TWiki/TWikiAdminCookBook" title="'TWiki/TWikiAdminCookBook' on TWiki.org">TWiki:TWiki.TWikiAdminCookBook</a> which offers tips and tricks for customizing your TWiki site. Many of these are appropriate to implement immediately after installing TWiki and before adding content so now's a good time to look at these. If you would like to customize the look of your TWiki, see <a href="http://twiki.org/cgi-bin/view/TWiki.TWikiSkinsSupplement" title="'TWiki.TWikiSkinsSupplement' on TWiki.org">TWiki:TWiki.TWikiSkinsSupplement</a>.
d210 1
a210 1
It is also advisable to review TWiki:Codev.KnownIssuesOfTWiki04x01.
d214 1
a214 1
---++ Appendixes
d237 6
d255 1
a255 1
| FileHandle | &gt;=2.01 |
d264 2
d327 1
@


1.67
log
@buildrelease
@
text
@d1 8
a8 1
%META:TOPICINFO{author="TWikiContributor" date="1170183233" format="1.1" version="67"}%
a9 2
%STARTINCLUDE%
---# TWiki Installation Guide
d11 9
a19 1
_Installation instructions for the TWiki 4.1 production release._
d21 1
a21 1
If you are upgrading from a previous version of TWiki, you probably want to read TWikiUpgradeGuide instead.
d23 1
a23 1
TWiki should be fine with any web server and OS that meet the [[TWikiSystemRequirements][system requirements]]. The following installation instructions are written for experienced system administrators; please review the AdminSkillsAssumptions before you install TWiki. If you need help, ask a question in the TWiki:Support web or on TWiki:Codev.TWikiIRC (irc.freenode.net, channel #twiki) 
d25 1
a25 1
__%H% Hint:__ TWiki:TWiki.InstallingTWiki on TWiki.org has supplemental documentation that help you install TWiki on different platforms, environments and web hosting sites.
d31 6
a36 5
   1 *Make a directory* for the installation and *unpack the distribution* in it.
   1 *Make sure* the user that runs CGI scripts on your system can read and write all files in the distribution.
     %BR% Detailed instructions on file permissions are beyond the scope of this guide, but in general:
      * During installation and configuration, the CGI user needs to be able to read and write _everything_ in the distribution,
      * Once installation and configuration is complete, the CGI user needs write access to everything under the =data= and =pub= directories and to =lib/LocalSite.cfg=. _Everything else_ should be read-only.
d38 13
a50 10
   1 *Make sure* Perl 5 and the Perl CGI library are installed on your system. 
     %BR% The default location of Perl is =/usr/bin/perl=. *If it's somewhere else*, change the path to Perl in the first line of each script in the =twiki/bin= directory.
     %BR% %H% Some systems require a special extension on perl scripts (e.g. =.cgi= or =.pl=). If necessary, rename all files in =twiki/bin=  (i.e. rename =view= to =view.pl= etc). If you do this, make sure you set the =ScriptSuffix= option in [[%SCRIPTURLPATH{"configure"}%][configure]] (Step 6).
   1 *Create the file* =/twiki/bin/LocalLib.cfg=.
     %BR% There is a template for this file in =/twiki/bin/LocalLib.cfg.txt=.
     %BR% The file must contain a setting for =$twikiLibPath=, which must point to the absolute file path of your =twiki/lib= e.g. =/home/httpd/twiki/lib=.
     %BR% %H% If you need to install additional CPAN modules, but can't update the main Perl installation files on the server, you can set =$CPANBASE= to point to your personal CPAN install. Don't forget that the webserver user has to be able to read those files as well.
   1 *Configure the webserver* so you can execute the =bin/configure= script from your browser.
      * Explicit instructions for doing this are beyond the scope of this document, though there is a lot of advice on TWiki.org covering different configurations of webserver. To help you out, there's an example Apache =httpd.conf= file in =twiki_httpd_conf.txt= at the root of the package. This file also contains advice on securing your installation. Additionally, see TWiki:TWiki.ApacheConfigGenerator. There's also a script called =tools/rewriteshebang.pl= to help you in fixing up the shebang lines in your CGI scripts.
   1 Run the =configure= script from your browser, and resolve any errors or warnings it tells you about.
d53 15
d69 60
a128 18
---++ Next Steps
Once you have your TWiki running, you can move on to customise it for your users.
   * *Review TWikiPreferences settings* - read through it and set any additional settings you think you might need (you can click the 'Edit' button near the top to edit the settings in place)
      * %I% It is recommended to *copy* any settings or variables that you want to customize from [[%TWIKIWEB%.TWikiPreferences]] and *paste* them into [[%LOCALSITEPREFS%]]. This will protect your local customizations from being overwritten in later upgrades. See notes at top of [[%TWIKIWEB%.TWikiPreferences]] for more information.
   * *Customize user home pages* - read and change NewUserTemplate.
   * *Enable authentication* - read TWikiUserAuthentication.
   * *Clear admin notes* - some pages are meant to be customized after choice of authentication - check and update these topics (remove notice):
      * ChangePassword
      * ResetPassword
      * ChangeEmailAddress
      * TWikiRegistration fields can be customzied to the needs of your organization
      * %MAINWEB%.TWikiAdminGroup
   * *Enable e-mail notification* - read TWikiSiteTools#WebNotify to get WebChangesAlerts.
   * *Automate update of site statistics* - read TWikiSiteTools#WebStatistics
   * *Automate removal of expired sessions and lease files* - read TWikiScripts#tick_twiki_pl.
   * *Enable internationalization* if needed - read TWiki:TWiki/InstallationWithI18N (supplemental documentation on TWiki.org)
   * *Install Plugins* if needed - TWiki:Plugins is an extensive library of Plugins for TWiki, that enhance functionality in a huge number of ways. A few Plugins are pre-installed in the TWiki distribution. Installation instructions are included in Plugins you download from TWiki:Plugins.PluginPackage on TWiki.org.
   * *Review known issues* - visit TWiki:Codev.KnownIssuesOfTWiki04x01 and fix issues that apply to you.
d131 141
a271 3
   * The first step is to re-run the =configure= script and make sure you have resolved all errors, and are happy that you understand any warnings.
   * TWiki:TWiki.InstallingTWiki on TWiki.org has supplemental documentation that help you install TWiki on different platforms, environments and web hosting sites.
   * If you need help, ask a question in the TWiki:Support web or on TWiki:Codev.TWikiIRC (irc.freenode.net, channel #twiki)
d276 1
@


1.66
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="66"}%
d6 1
a6 1
_Installation instructions for the TWiki 4.0 production release._
d52 1
d54 1
a54 1
   * *Review known issues* - visit TWiki:Codev.KnownIssuesOfTWiki04x00x00 and fix issues that apply to you.
@


1.65
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="65"}%
d26 1
a26 1
     %BR% %H% Some systems require a special extension on perl scripts (e.g. =.cgi= or =.pl=). If necessary, rename all files in =twiki/bin=  (i.e. rename =view= to =view.pl= etc). If you do this, make sure you set the =ScriptSuffix= option in =configure= (Step 6).
d32 1
a32 1
      * Explicit instructions for doing this are beyond the scope of this document, though there is a lot of advice on TWiki.org covering different configurations of webserver. To help you out, there's an example Apache =httpd.conf= file in =twiki_httpd_conf.txt= at the root of the package. This file also contains advice on securing your installation. There's also a script called =tools/rewriteshebang.pl= to help you in fixing up the shebang lines in your CGI scripts.
@


1.64
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="64"}%
d8 2
@


1.63
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="63"}%
d15 17
a31 17
	1 *Download* the TWiki distribution from http://TWiki.org/download.html.
	1 *Make a directory* for the installation and *unpack the distribution* in it.
	1 *Make sure* the user that runs CGI scripts on your system can read and write all files in the distribution.
	  %BR% Detailed instructions on file permissions are beyond the scope of this guide, but in general:
		* During installation and configuration, the CGI user needs to be able to read and write _everything_ in the distribution,
		* Once installation and configuration is complete, the CGI user needs write access to everything under the =data= and =pub= directories and to =lib/LocalSite.cfg=. _Everything else_ should be read-only.
		* Everybody else should be denied access to everything, always.
	1 *Make sure* Perl 5 and the Perl CGI library are installed on your system. 
	  %BR% The default location of Perl is =/usr/bin/perl=. *If it's somewhere else*, change the path to Perl in the first line of each script in the =twiki/bin= directory.
	  %BR% %H% Some systems require a special extension on perl scripts (e.g. =.cgi= or =.pl=). If necessary, rename all files in =twiki/bin=  (i.e. rename =view= to =view.pl= etc). If you do this, make sure you set the =ScriptSuffix= option in =configure= (Step 6).
	1 *Create the file* =/twiki/bin/LocalLib.cfg=.
	  %BR% There is a template for this file in =/twiki/bin/LocalLib.cfg.txt=.
	  %BR% The file must contain a setting for =$twikiLibPath=, which must point to the absolute file path of your =twiki/lib= e.g. =/home/httpd/twiki/lib=.
	  %BR% %H% If you need to install additional CPAN modules, but can't update the main Perl installation files on the server, you can set =$CPANBASE= to point to your personal CPAN install. Don't forget that the webserver user has to be able to read those files as well.
	1 *Configure the webserver* so you can execute the =bin/configure= script from your browser.
		* Explicit instructions for doing this are beyond the scope of this document, though there is a lot of advice on TWiki.org covering different configurations of webserver. To help you out, there's an example Apache =httpd.conf= file in =twiki_httpd_conf.txt= at the root of the package. This file also contains advice on securing your installation. There's also a script called =tools/rewriteshebang.pl= to help you in fixing up the shebang lines in your CGI scripts.
	1 Run the =configure= script from your browser, and resolve any errors or warnings it tells you about.
d37 15
a51 15
	* *Review TWikiPreferences settings* - read through it and set any additional settings you think you might need (you can click the 'Edit' button near the top to edit the settings in place)
		* %I% It is recommended to *copy* any settings or variables that you want to customize from [[%TWIKIWEB%.TWikiPreferences]] and *paste* them into [[%MAINWEB%.TWikiPreferences]]. This will protect your local customizations from being overwritten in later upgrades. See notes at top of [[%TWIKIWEB%.TWikiPreferences]] for more information.
	* *Customize user home pages* - read and change NewUserTemplate.
	* *Enable authentication* - read TWikiUserAuthentication.
	* *Clear admin notes* - some pages are meant to be customized after choice of authentication - check and update these topics (remove notice):
		* %TWIKIWEB%.ChangePassword
		* %TWIKIWEB%.ResetPassword
		* %TWIKIWEB%.ChangeEmailAddress
		* %TWIKIWEB%.TWikiRegistration fields can be customzied to the needs of your organization
		* %MAINWEB%.TWikiAdminGroup
	* *Enable e-mail notification* - read TWikiSiteTools#WebNotify to get WebChangesAlerts.
	* *Automate update of site statistics* - read TWikiSiteTools#WebStatistics
	* *Automate removal of expired sessions and lease files* - read TWikiScripts#tick_twiki_pl.
	* *Install Plugins* if needed - TWiki:Plugins is an extensive library of Plugins for TWiki, that enhance functionality in a huge number of ways. A few Plugins are pre-installed in the TWiki distribution. Installation instructions are included in Plugins you download from TWiki:Plugins.PluginPackage on TWiki.org.
	* *Review known issues* - visit TWiki:Codev.KnownIssuesOfTWiki04x00x00 and fix issues that apply to you.
d54 3
a56 3
	* The first step is to re-run the =configure= script and make sure you have resolved all errors, and are happy that you understand any warnings.
	* TWiki:TWiki.InstallingTWiki on TWiki.org has supplemental documentation that help you install TWiki on different platforms, environments and web hosting sites.
	* If you need help, ask a question in the TWiki:Support web or on TWiki:Codev.TWikiIRC (irc.freenode.net, channel #twiki)
@


1.62
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1093967374" format="1.0" version="1.62"}%
d6 1
a6 1
_Installation instructions for the TWiki 01-Sep-2004 production release._
d8 1
a8 1
_If you are reading this on your own TWiki installation, please get the latest installation guide (TWiki:TWiki.TWikiInstallationGuide), as this often has important updates to resolve installation issues._
d10 1
a10 8
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 [[TWikiSystemRequirements][system requirements]].  Official documentation for platforms other than Linux is somewhat limited, so _please check_ the topics listed below, they include some important tips for HP-UX, Solaris, OS/390, and many other platforms.

	* For Unix or Linux, check TWiki:Codev/TWikiOnUnix (install your own RCS, =diff= and =grep= tools if in doubt!) and TWiki:Codev/TWikiOnLinux.
	* For Windows, check the WindowsInstallCookbook. 
	* For <nop>MacOS X, check TWiki:Codev/TWikiOnMacOSX. 
	* To install TWiki on <nop>SourceForge, for use on a software development project, read TWiki:Codev/TWikiOnSourceForge
	* For other platforms, see TWiki:Codev/TWikiOn, and search the TWiki:Codev and TWiki:Support webs for other installation notes.
	* If you need help, ask a question in the TWiki:Support web
d13 1
a13 152
---++ Standard Installation

Download the TWiki 01-Sep-2004 distribution in Unix ZIP format from http://TWiki.org/download.html. Please review the AdminSkillsAssumptions before you install TWiki.

---+++ Step 1: Create &amp; Configure the Directories

%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 [[#StepOneB][alternative Step 1]] instead._

	* Create directory =/home/httpd/twiki= and [[http://www.info-zip.org/pub/infozip/UnZip.html][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 =httpd.conf= (typcially located in =/etc/httpd/=) 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= .
	  <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.
	* 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=.

<blockquote style="background-color:#F5F5F5">
*Example =httpd.conf= entries:*
 <pre> Script<nop>Alias /twiki/bin/ "/home/httpd/twiki/bin/"
 Alias /twiki/ "/home/httpd/twiki/"
 &lt;Directory "/home/httpd/twiki/bin"&gt;
	 Options +ExecCGI
	 Set<nop>Handler cgi-script
	 Allow from all
 &lt;/Directory&gt;
 &lt;Directory "/home/httpd/twiki/pub"&gt;
	 Options Follow<nop>Sym<nop>Links +Includes
	 Allow<nop>Override None
	 Allow from all
 &lt;/Directory&gt;
 &lt;Directory "/home/httpd/twiki/data"&gt;
	 deny from all
 &lt;/Directory&gt;
 &lt;Directory "/home/httpd/twiki/templates"&gt;
	 deny from all
 &lt;/Directory&gt;</pre>
</blockquote>

	* Restart Apache by =service httpd restart= (or as appropriate to your flavor of UNIX or Linux).
	* 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 [[#StepTwo][Step 2]]..._

#StepOneB		  
---++++ Aletrnative Step 1: Create &amp; Configure the Directories for Non-Root Accounts

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: 

	* Download and unzip TWiki on your local PC
	* Using the table below, create a directory structure on your host server
	* Upload the TWiki files by FTP (transfer as _text_ except for the image files in =pub=)
<blockquote>
| *TWiki dir:* | *What it is:* | *Where to copy:* | *Example:* |
| =twiki= | start-up pages | root TWiki dir | =/home/smith/twiki/= |
| =twiki/bin= | CGI bin | CGI-enabled dir | =/home/smith/twiki/bin= |
| =twiki/lib= | library files | same level as =twiki/bin= | =/home/smith/twiki/lib= |
| =twiki/pub= | public files | htdoc enabled dir | =/home/smith/twiki/pub= |
| =twiki/data= | topic data | dir secure from public access | =/home/smith/twiki/data= |
| =twiki/templates= | web templates | dir secure from public access | =/home/smith/twiki/templates= |
</blockquote>

__Note:__ Don't worry if you are not able to put 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 configure the =/twiki/bin/setlib.cfg= file (done in Step 3)

#StepTwo
---+++ Step 2: Set 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 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 (and some intranet servers), Perl CGI scripts may require a =.cgi= extension to run. Some systems need =.pl=, the regular Perl extension. Rename all =twiki/bin= scripts if necessary.
			* Alternatively, you might try creating a file =twiki/bin/.htaccess= that contains the single line =SetHandler cgi-script=, which tells Apache to treat all files in this directory as CGI scripts.
	* Set the file permission of all Perl scripts in the =twiki/bin= directory as executable to =-rwxr-xr-x= (755).
	* 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.
	* %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: 
		* replace =nobody= with another user if your server executes scripts under a different name (ex: default for Debian is =www-data=).
			* %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).
		* replace user =twiki= with your own username
	* Set permissions manually.
		* 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=.
		* %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, such as =www-data=, or delete them all - new files will be automatically created the first time each topic is edited. You have two options to change ownership of the RCS lock user:
			* Run the =testenv= script from your browser; in the %BROWN% *Fix* %ENDCOLOR% line you can <u>relock</u> all the rcs files *(recommended)*
			* Alternatively, run this in your shell: %BR%
			  =cd twiki/data= %BR%
			  =find . -name *,v -exec perl -pi~ -e '$. &lt;=<nop> 10 && s/nobody:/www-data:/ ' {} \;= %BR%
			  This will create =*,v~= backup files which you should remove after verification: %BR%
			  =find . -name *,v~ -exec rm -f {} \;=


---+++ Step 3: Edit the Configuration Files

	* Edit the file =/twiki/bin/setlib.cfg=
		* Set =$twikiLibPath= to the absolute file path of your =/twiki/lib= as seen by the web server.
		* %X% __Attention:__ Do *not* leave it as a relative ="../lib"= path or Plugins might fail to initialize properly
		* You can also edit =$localPerlLibPath= 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. 
		* %X% __Attention:__ If you are running TWiki on Apache 2.0 on Unix you might experience cgi scripts to hang forever. This is a known Apache 2.0 bug. See details and woraround in the =setlib.cfg= 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.
		* 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. 
			* Set <code>$storeTopicImpl = "RcsWrap";</code> 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"=.  
				* 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).
			* Set <code>$storeTopicImpl = "RcsLite";</code> for the Perl based RCS
	* *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)
	* 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: Internationalisation Setup (Optional)

By default, TWiki is configured to support US ASCII letters (no accents) in WikiWords, and ISO-8859-1 (Western European) characters in page contents.  If that's OK for you, skip this step.

If your Wiki will be used by non-English speakers, TWiki can be configured for Internationalisation ('I' followed by 18 letters, then 'N', or _I18N_).  Specifically, TWiki will support suitable accented characters in WikiWords (as well as languages such as Japanese or Chinese in which WikiWords do not apply), and will support virtually any character set in the contents of pages.  __NOTE:__ TWiki does not currently support UTF-8, so you are advised *not* to use this - however, improved UTF-8 support is under development, see TWiki:Codev/ProposedUTF8SupportForI18N.

To configure internationalisation suppport:
	1 Edit the =TWiki.cfg= file's Internationalisation section to set the =$useLocale= parameter to =1=.  TWiki will now use the I18N parameters set in the rest of this section.
	1 Type the Unix/Linux command =locale -a= to find a suitable 'locale' for your use of TWiki.  A locale that includes a dot followed by a character set is recommended, e.g. =pl_PL.ISO-8859-2= for Poland.  Consult your system administrator if you are not sure which locale to use.
	1 In =TWiki.cfg=, set the =$siteLocale= parameter to your chosen locale, e.g. =pl_PL.ISO-8859-2= for Poland. 
	1 Check your setup using =testenv= (download the latest =testenv= from TWiki:Support/SupportGuidelines if possible) - this provides some diagnostics for I18N setup, and in particular checks that your locale can be used successfully.
	1 _(For upgrade of TWiki I18N sites only:)_ If you were using TWiki:Codev.TWikiRelease01Feb2003 support for I18N, and are using Internet Explorer or Opera, you should re-configure your browser so that it sends URLs encoded with UTF-8 (supported since TWiki:Codev.TWikiRelease01Sep2004).  If you are doing a new installation of TWiki, you can ignore this step - no browser reconfiguration is needed for TWiki Release 01-Sep-2004).
		* Internet Explorer 5.0 or higher: in  _Tools | Options | Advanced_, check 'always send URLs as UTF-8', then close all IE windows and restart IE. 
		* Opera 6.x or higher: in _Preferences | Network | International Web Addresses_, check 'encode all addresses with UTF-8'.
		* __NOTE:__ This does not mean that TWiki supports UTF-8 as a site character set.
	1 Try out your TWiki by creating pages in the Sandbox web that use international characters in WikiWords and checking that searching, WebIndex, Ref-By and other features are working OK.

---++++ Trouble with I18N? 

If international characters in WikiWords do not seem to work, and you are on Perl 5.6 or higher, you may need to set the =TWiki.cfg= parameter =$localeRegexes= to 0 - this disables some features but enables TWiki to work even if your system has locales that do not work.  Then, set the =$upperNational= and =$lowerNational= parameters to the valid upper and lower case accented letters for your locale. 
	* __NOTE:__ You will need to do the above workaround for Windows based servers (whether using Cygwin or <nop>ActiveState Perl), since Perl locales are not working on Windows as of Feb 2004.

If international characters in WikiWords aren't working, and you are on Perl 5.005 with working locales, keep =$useLocale= set to 1 and set =$localeRegexes= to 0, then set =$upperNational= and =$lowerNational= - if =testenv= generates the lists of characters for you, your locales are working so there is no need to set =$localeRegexes= to 0 in this case.  See the comments in =TWiki.cfg= for more information.

---+++ Step 5: Configure Site-Wide Email Preferences

	* Edit the TWikiPreferences topic in the %TWIKIWEB% web (by pointing your browser to <nop>http://yourdomain.com/twiki/bin/view/%TWIKIWEB%/TWikiPreferences) to set the =WIKIWEBMASTER= email address, and other email settings required for registration and WebChangesAlert to work:
		* =WIKIWEBMASTER= should be set to the email address of the TWiki administrator
		* =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 ==Net::SMTP== 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 ==$mailProgram== in ==TWiki.cfg==).
		* =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, ==Net::SMTP== will guess it for you. 
	* You may want to set up other TWikiPreferences later on.
	* To enable the WebChangesAlerts (email notifications) you need to read about cron in the topic TWiki.TWikiSiteTools.

---+++ Step 6: Finish Up from Your Browser

	* Point your Web browser at =http://yourdomain.com/twiki/bin/view= and start TWiki-ing away!
		* %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=.
	* Edit the WebPreferences topic in each web, if necessary: set individual =WEBCOPYRIGHT= messages, and other preferences.
	* Enable email notification of topic changes - TWikiSiteTools has more. 
	* Edit the WebNotify topic in all webs and add the users you want to notify.
	* Add the TWiki:Main/PoweredByTWikiLogo to your [[%MAINWEB%.%HOMETOPIC%]] topic.
	* You can add new =%<nop>VARIABLES%=. Define site-level variables in the TWikiPreferences topic. See also: TWikiVariables.

That's it for the standard installation of TWiki. Read on for server-level customization options.
d15 18
a32 3
---++ Additional Server-Level Options

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.
d35 22
a56 29
---+++ 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. The comment at the top of the file explains what need to be done, basically replace =!FILE_path_to_TWiki!= and =!URL_path_to_TWiki!= with paths specific to your installation. _For the details of how this file works, consult the HTTP server documentation (for Apache server: <a href="http://www.apache.org/docs/mod/directives.html">[1]</a>, <a href="http://systems.mcs.kent.edu/info/web_help/htaccess/">[2]</a>)_.
			* %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=. 
			* %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 <a href=http://httpd.apache.org/docs/mod/core.html#directory>[3]</a> section of =access.conf= for your =twiki/bin= directory. 
				* *This applies only if you have root access:* on hosted accounts, you shouldn't have this problem - otherwise, email tech support.
			* %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.
		1. TWiki now supports several Password file format/encoding methods for Apache. Once you know what method is used by your Appache server, you can configure TWiki to create compatible .htpasswd entries by editing the =$htpasswdFormatFamily=, =$htpasswdEncoding= and =$htpasswdFilename= in the TWiki.cfg file. The supported options are htpasswd:plain, htpasswd:crypt, htpasswd:sha1, htdigest:md5
		1. *Copy* the TWikiRegistrationPub topic to TWikiRegistration, overwriting old version of <nop>TWikiRegistration. Do that by either editing the topics in the%TWIKIWEB% web, or by renaming the =.txt= and =.txt,v= files in the =twiki/data/%TWIKIWEB%= directory.
	* Customization:
		* 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.
		* You can customize the default user home page in NewUserTemplate. The same variables get expanded as in the [[TWikiTemplates#Template_Topics][template topics]]
	* Register yourself in the TWikiRegistration topic.
		* %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.
	* Create a new topic to check if authentication works.
	* Edit the %MAINWEB%.TWikiAdminGroup topic in the TWiki:%MAINWEB% web to include users with system administrator status.
	* Edit the TWikiPreferences topic in the TWiki:%TWIKIWEB% web to set access privileges.
	* Edit the WebPreferences topic in each web, if necessary: set access priviliges.

---+++ WYSIWYG Editor

At this time, TWiki does not ship with an "what you see is what you get" editor. TWiki:Codev/IntegrateHtmlAreaEditor describes how to integrate an HTML editor.

%X% *NOTE:* User home topics are located in the %WIKITOOLNAME%.%MAINWEB% web - don't try to move them or create them in other webs. From any other web, user signatures have to point to %WIKITOOLNAME%.%MAINWEB% web, using a =%MAINWEB%.<nop>UserName= or =%<nop>MAINWEB%.<nop>UserName= format. (The =%<nop>MAINWEB%= variable is an advantage if you ever change the %MAINWEB% web name, but the standard =%MAINWEB%.<nop>UserName= is easier for users to enter, which is the bottom line!)

---++ TWiki File System Info

See [[AppendixFileSystem][Appendix A: TWiki File System]] for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2004 distribution.
a57 2
-- TWiki:Main/PeterThoeny - 29 Aug 2004 %BR%
-- TWiki:Main/MikeMannix - 16 May 2002
d60 1
a60 1
%META:TOPICMOVED{by="MikeMannix" date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide"}%
@


1.61
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1093810144" format="1.0" version="1.61"}%
d59 1
a59 1
		* Enter the URL for the =bin= directory, =http://yourdomain.com/twiki/bin/=.
d202 1
a202 1
%X% *NOTE:* User home topics are located in the %WIKITOOLNAME%.%MAINWEB% web - don't try to move them or create them in other webs. From any other web, user signatures have to point to %WIKITOOLNAME%.%MAINWEB% web, using a =%MAINWEB%.<nop>UserName= or =%<nop>MAINWEB%.<nop>UserName= format. (The =%<nop>MAINWEB%= variable is an advantage if you ever change the %MAINWEB% web name, but the standard =%MAINWEB%.<nop>UserName= is easier for users to enter, which is the bottom line! 
@


1.60
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1092720066" format="1.0" version="1.60"}%
d66 1
a66 1
---++++ Step 1 for Non-Root Accounts
d103 1
a103 1
			* Run the =testenv= script from your browser; in the %BROWN% *Fix* %ENDCOLOR% line you can <u>relock</u> all the rcs files
d106 3
a108 1
			  =find . -name *.v~ -exec perl -pi~ -e '$. &lt;=<nop> 10 && s/nobody:/www-data:/ ' {} ;=
d181 1
a181 4
		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: <a href="http://www.apache.org/docs/mod/directives.html">[1]</a>, <a href="http://systems.mcs.kent.edu/info/web_help/htaccess/">[2]</a>). In particular, the following <font color="red">red</font> part needs to be configured correctly: <br />
		 =Redirect <font color="red">/urlpathto/twiki/index.html</font> http<nop>://<font color="red">yourdomain.com/urlpathto/twiki/bin/</font>view= <br>
		  =AuthUserFile <font color="red">/filepathto/twiki/data/</font>.htpasswd= <br />
		  =ErrorDocument 401 <font color="red">/urlpathto/twiki/bin/</font>oops/TWiki/TWikiRegistration?template=oopsauth=
d208 1
a208 1
-- TWiki:Main/PeterThoeny - 15 Aug 2004 %BR%
@


1.59
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1092632265" format="1.0" version="1.59"}%
d130 1
a130 1
If your Wiki will be used by non-English speakers, TWiki can be configured for Internationalisation ('I' followed by 18 letters, then 'N', or _I18N_).  Specifically, TWiki will support suitable accented characters in WikiWords (as well as languages such as Japanese or Chinese in which WikiWords do not apply), and to support virtually any character set in the contents of pages.  __NOTE:__ _TWiki does not currently support UTF-8, so you are advised *not* to use this - however, improved UTF-8 support is [[http://twiki.org/cgi-bin/view/Codev/ProposedUTF8SupportForI18N under development]]._
d137 4
a140 4
	1 If you are using Internet Explorer or Opera, configure your browser to not send URLs encoded with UTF-8
		* Internet Explorer 5.0 or higher: in  _Tools | Options | Advanced_, uncheck 'always send URLs as UTF-8', then close all IE windows and restart IE. 
		* Opera 6.x or higher: in _Preferences | Network | International Web Addresses_, uncheck 'encode all addresses with UTF-8'.
		* __NOTE:__ _If this configuration change is not acceptable, consider installing a TWiki beta release (19 Jan 2004 or later), which fully supports UTF-8 URLs._
d143 2
d146 1
a146 1
	* __NOTE:__ _You will need to do the above workaround for Windows based servers (whether using Cygwin or <nop>ActiveState Perl), since Perl locales are not working on Windows as of Feb 2004._
@


1.58
log
@none
@
text
@d1 210
a210 191
%META:TOPICINFO{author="PeterThoeny" date="1071212220" format="1.0" version="1.58"}%
%TOC%
%STARTINCLUDE%
---# TWiki Installation Guide

_Installation instructions for the TWiki 01-Feb-2003 production release._

_If you are reading this on your own TWiki installation, please get the latest installation guide (TWiki:TWiki.TWikiInstallationGuide), as this often has important updates to resolve installation issues._

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 [[TWikiSystemRequirements][system requirements]].  Official documentation for platforms other than Linux is somewhat limited, so _please check_ the topics listed below, they include some important tips for HP-UX, Solaris, OS/390, and many other platforms.

	* For Unix or Linux, check TWiki:Codev/TWikiOnUnix (install your own RCS, =diff= and =grep= tools if in doubt!) and TWiki:Codev/TWikiOnLinux.
	* For Windows, check the WindowsInstallCookbook. 
	* For <nop>MacOS X, check TWiki:Codev/TWikiOnMacOSX. 
	* To install TWiki on <nop>SourceForge, for use on a software development project, read TWiki:Codev/TWikiOnSourceForge
	* For other platforms, see TWiki:Codev/TWikiOn, and search the TWiki:Codev and TWiki:Support webs for other installation notes.
	* If you need __really urgent__ help, try the TWiki:Codev/TWikiIRC channel.

#StandardInstallation
---++ Standard Installation

Request and download the TWiki 01-Feb-2003 distribution in Unix ZIP format from http://TWiki.org/download.html. Please review the AdminSkillsAssumptions before you install TWiki.

---+++ Step 1: Create &amp; Configure the Directories

%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 [[#StepOneB][alternative Step 1]] instead._

	* Create directory =/home/httpd/twiki= and [[http://www.info-zip.org/pub/infozip/UnZip.html][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 =httpd.conf= (typcially located in =/etc/httpd/=) 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= .
	  <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.
	* 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=.

<blockquote style="background-color:#F5F5F5">
*Example =httpd.conf= entries:*
 <pre> Script<nop>Alias /twiki/bin/ "/home/httpd/twiki/bin/"
 Alias /twiki/ "/home/httpd/twiki/"
 &lt;Directory "/home/httpd/twiki/bin"&gt;
	 Options +ExecCGI
	 Set<nop>Handler cgi-script
	 Allow from all
 &lt;/Directory&gt;
 &lt;Directory "/home/httpd/twiki/pub"&gt;
	 Options Follow<nop>Sym<nop>Links +Includes
	 Allow<nop>Override None
	 Allow from all
 &lt;/Directory&gt;
 &lt;Directory "/home/httpd/twiki/data"&gt;
	 deny from all
 &lt;/Directory&gt;
 &lt;Directory "/home/httpd/twiki/templates"&gt;
	 deny from all
 &lt;/Directory&gt;</pre>
</blockquote>

	* 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 [[#StepTwo][Step 2]]..._

#StepOneB		  
---++++ Step 1 for Non-Root Accounts

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: 

	* Download and unzip TWiki on your local PC
	* Using the table below, create a directory structure on your host server
	* Upload the TWiki files by FTP (transfer as _text_ except for the image files in =pub=)
<blockquote>
| *TWiki dir:* | *What it is:* | *Where to copy:* | *Example:* |
| =twiki= | start-up pages | root TWiki dir | =/home/smith/twiki/= |
| =twiki/bin= | CGI bin | CGI-enabled dir | =/home/smith/twiki/bin= |
| =twiki/lib= | library files | same level as =twiki/bin= | =/home/smith/twiki/lib= |
| =twiki/pub= | public files | htdoc enabled dir | =/home/smith/twiki/pub= |
| =twiki/data= | topic data | dir secure from public access | =/home/smith/twiki/data= |
| =twiki/templates= | web templates | dir secure from public access | =/home/smith/twiki/templates= |
</blockquote>

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:

<pre>
	 # -------------- Change these settings if required

	 $twikiLibPath = <font color="red">'/some/other/path/lib'</font>;	# Path to lib directory containing TWiki.pm

</pre>

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. 

#StepTwo
---+++ Step 2: Set 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 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 (and some intranet servers), Perl CGI scripts may require a =.cgi= extension to run. Some systems need =.pl=, the regular Perl extension. Rename all =twiki/bin= scripts if necessary.
	* Set the file permission of all Perl scripts in the =twiki/bin= directory as executable to =-rwxr-xr-x= (755).
	* 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.
	* %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: 
		* replace =nobody= with another user if your server executes scripts under a different name (ex: default for Debian is =www-data=).
			* %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).
		* replace user =twiki= with your own username
	* 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=.
	* %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, such as =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 (type this carefully!):
<blockquote style="background-color:#F5F5F5">
<pre>
cd twiki/data
perl -pi~ -e 'NR <= 10 && s/nobody:/www-data:/ ' */*,v

</pre>
</blockquote>

---+++ 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.
		* 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. 
			* Set <code>$storeTopicImpl = "RcsWrap";</code> 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"=.  
				* 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).
			* Set <code>$storeTopicImpl = "RcsLite";</code> for the Perl based RCS
	* *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)
	* 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: Configure Site-Wide Email Preferences

	* Edit the TWikiPreferences topic in the %TWIKIWEB% web (by pointing your browser to <nop>http://yourdomain.com/twiki/bin/view/%TWIKIWEB%/TWikiPreferences) to set the =WIKIWEBMASTER= email address, and other email settings required for registration and WebChangesAlert to work:
		* =WIKIWEBMASTER= should be set to the email address of the TWiki administrator
		* =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 ==Net::SMTP== 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 ==$mailProgram== in ==TWiki.cfg==).
		* =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, ==Net::SMTP== will guess it for you. 
	* You may want to set up other TWikiPreferences later on.
	* To enable the WebChangesAlerts (email notifications) you need to read about cron in the topic TWiki.TWikiSiteTools.

---+++ Step 5: Finish Up from Your Browser

	* Point your Web browser at =http://yourdomain.com/twiki/bin/view= and start TWiki-ing away!
		* %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=.
	* Edit the WebPreferences topic in each web, if necessary: set individual =WEBCOPYRIGHT= messages, and other preferences.
	* Enable email notification of topic changes, TWikiSiteTools has more. 
	* Edit the WebNotify topic in all webs and add the users you want to notify.
	* Add the TWiki:Main/PoweredByTWikiLogo to your [[%MAINWEB%.%HOMETOPIC%]] topic.
	* You can add new =%<nop>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.

---++ Additional Server-Level Options

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.

#AuthenticationOfUsers
---+++ 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: <a href="http://www.apache.org/docs/mod/directives.html">[1]</a>, <a href="http://systems.mcs.kent.edu/info/web_help/htaccess/">[2]</a>). In particular, the following <font color="red">red</font> part needs to be configured correctly: <br />
		 =Redirect <font color="red">/urlpathto/twiki/index.html</font> http<nop>://<font color="red">yourdomain.com/urlpathto/twiki/bin/</font>view= <br>
		  =AuthUserFile <font color="red">/filepathto/twiki/data/</font>.htpasswd= <br />
		  =ErrorDocument 401 <font color="red">/urlpathto/twiki/bin/</font>oops/TWiki/TWikiRegistration?template=oopsauth=
			* %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=. 
			* %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 <a href=http://httpd.apache.org/docs/mod/core.html#directory>[3]</a> section of =access.conf= for your =twiki/bin= directory. 
				* *This applies only if you have root access:* on hosted accounts, you shouldn't have this problem - otherwise, email tech support.
			* %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.
		1. *Copy* the TWikiRegistrationPub topic to TWikiRegistration, overwriting old version of <nop>TWikiRegistration. Do that by either editing the topics in the%TWIKIWEB% web, or by renaming the =.txt= and =.txt,v= files in the =twiki/data/%TWIKIWEB%= directory.
	* Customization:
		* 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.
		* You can customize the default user home page in NewUserTemplate.
	* Register yourself in the TWikiRegistration topic.
		* %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.
	* Create a new topic to check if authentication works.
	* Edit the %MAINWEB%.TWikiAdminGroup topic in the TWiki:%MAINWEB% web to include users with system administrator status.
	* Edit the TWikiPreferences topic in the TWiki:%TWIKIWEB% web to set access privileges.
	* Edit the WebPreferences topic in each web, if necessary: set access priviliges.

That's it for a basic new web set-up!

Optionally, you can also:
	* Create custom web-specific templates in a new =twiki/templates/Someweb= directory (otherwise, templates are inherited from =twiki/templates=).
	* Add TWikiForms for form-based page input that's stored separately from the main free-form topic text.

%X% *NOTE:* User home topics are located in the %WIKITOOLNAME%.%MAINWEB% web - don't try to move them or create them in other webs. From any other web, user signatures have to point to %WIKITOOLNAME%.%MAINWEB% web, using a =%MAINWEB%.<nop>UserName= or =%<nop>MAINWEB%.<nop>UserName= format. (The =%<nop>MAINWEB%= variable is an advantage if you ever change the %MAINWEB% web name, but the standard =%MAINWEB%.<nop>UserName= is easier for users to enter, which is the bottom line! 

---++ TWiki File System Info

See [[AppendixFileSystem][Appendix A: TWiki File System]] for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.

-- PeterThoeny - 03 Jun 2003 <br />
-- Main.MikeMannix - 16 May 2002	
%STOPINCLUDE%
@


1.57
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1059252480" format="1.0" version="1.57"}%
d6 1
a6 1
_Installation instructions for the TWiki 01-Feb-2003 production release. Update notes for the new RCS configuration are marked_ __Dataframework__.
d8 1
a8 1
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 [[TWikiSystemRequirements][system requirements]]. Documentation for other platforms is somewhat limited:
d10 3
a12 1
	* For Unix or Linux, check TWiki:Codev/TWikiOnUnix and TWiki:Codev/TWikiOnLinux.
d17 1
a17 1

d29 1
a29 1
	* 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.
d98 1
a98 1
		* *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.
@


1.56
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1054708130" format="1.0" version="1.56"}%
d143 1
a143 1
	* Add the TWiki:Main/PoweredByTWikiLogo to your %MAINWEB%.WebHome topic.
d147 1
a147 1
		
@


1.55
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1050385753" format="1.0" version="1.55"}%
d16 1
d106 1
a106 1
	* %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:
d110 2
a111 1
perl -pi~ -e 's/nobody(\:[0-9\.]+[\;\s]+strict\;)/www-data$1/' */*,v
d129 1
a129 1
	* From your web browser, edit the TWikiPreferences topic in the TWiki:%TWIKIWEB% web to set the =WIKIWEBMASTER= email address, and other email settings required for registration and WebChangesAlert to work:
d134 1
d187 1
a187 1
-- PeterThoeny - 28 Dec 2002 <br />
@


1.54
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1045285021" format="1.0" version="1.54"}%
d109 1
a109 1
perl -pi~ -e 's/nobody:/www-data:/' */*,v
@


1.53
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1044149369" format="1.0" version="1.53"}%
d153 1
a153 1
		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: <a href="http://www.apache.org/docs/mod/directives.html">[1]</a>, <a href="http://www.mcs.kent.edu/system/web_help/htaccess/introduction.html">[2]</a>). In particular, the following <font color="red">red</font> part needs to be configured correctly: <br />
@


1.52
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1044102019" format="1.0" version="1.52"}%
d6 1
a6 1
_Installation instructions for the TWiki 01-Dec-2001 production release. Update notes for the new RCS configuration are marked_ __Dataframework__.
d19 1
a19 1
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.
@


1.51
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1042701668" format="1.0" version="1.51"}%
a170 16

#CreateWeb
---+++ Adding a New Web

To create a new web:
	1. *Create* a new web data directory under =twiki/data= and check the file permission of the directory.
		* 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.)
	1. *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=). 
		* %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.
	1. *Add* the new web to the web list (visible in the upper right corner of each topic) by editing the site-level preferences, %TWIKIWEB%.%WIKIPREFSTOPIC%:
		* Add the new web to the =%<nop>WIKIWEBLIST%= variable.
	1. *Update* the web settings by editing the <nop>WebPreferences topic of the new web:
		* Customize the =%<nop>WEBTOPICLIST%= variable to contain the web-specific links you prefer.
		* Set the WEBBGCOLOR variable to a color. The number represents the unique color for the web.
		* Set Plugins, access privileges, custom variables, other web-level options (ex: =%<nop>WEBCOPYRIGHT%= can be set for an individual web).
	1. *Test* the new web: view pages, create a new page.
@


1.50
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1042350903" format="1.0" version="1.50"}%
d8 1
a8 1
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 [[TWikiImplementationNotes][system requirements]]. Documentation for other platforms is somewhat limited:
@


1.49
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1041124980" format="1.0" version="1.49"}%
d13 1
d19 1
a19 1
Request and download the TWiki 01-Dec-2001 distribution in Unix ZIP format from http://TWiki.org/download.html. _(To install TWiki on <nop>SourceForge, for use on a software development project, read TWiki:Codev/SourceForgeHowTo .)_ 
@


1.48
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1032624201" format="1.0" version="1.48"}%
d8 6
a13 1
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 [[TWikiImplementationNotes][system requirements]]. Documentation for other platforms is currently limited. For Windows, check TWiki:Codev/TWikiOnWindows. Search the TWiki:Codev web for other intallation notes.
d22 1
a22 1
%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 - use the [[#StepOneB][alternative Step 1]] instead._
d64 1
a64 1
To install TWiki on a system where you don't have server administrator privileges, for example, on a hosted Web account: 
d79 11
d108 1
a108 1
perl -pi -e 's/nobody:/www-data:/' */*,v
d116 5
a120 4
		* RCS - revision control system to store revsion 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. (Dateframework - prior version of TWiki only support the RCS executables and do not have the config setting =$storeTopicImpl=)
			* Set <code>$storeTopicImpl = "RcsLite";</code> for the Perl based RCS 
			* Set <code>$storeTopicImpl = "RcsWrap";</code> for the RCS execuatbles and make sure RCS is installed. Set =$rcsDir= in =twiki/lib/TWiki.cfg= to mach the location of your RCS binaries. You can check this by issuing the comand =rcs= at the prompt, it should result in something like ="rcs: no input file"=.
	* *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)
d123 10
a132 1
---+++ Step 4: Finish Up from Your Browser
a135 1
	* Edit the TWikiPreferences topic in the TWiki:%TWIKIWEB% web to set the =WIKIWEBMASTER= email address, and other preferences.
d148 1
d161 3
a163 1
			* %T% *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.
d197 1
a197 1
See [[AppendixFileSystem][Appendix A: TWiki File System]] for an installed system snapshot and descriptions of all files in the TWiki 01-Dec-2001 distribution.
d199 2
a200 2
-- PeterThoeny - 13 Sep 2001 <br />
-- Main.MikeMannix - 16 May 2002
@


1.47
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1028321446" format="1.0" version="1.47"}%
d19 1
a19 1
	* Create directory =/home/httpd/twiki= and unzip the TWiki distribution into this directory.
@


1.46
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1026024235" format="1.0" version="1.46"}%
d88 1
a88 1
	* %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 sed:
d92 1
a92 1
for f in */*,v; do sed 's/nobody\:/www-data\:/' $f &gt; x; mv -f x $f; done
a94 1
Note that this is not required if you use the Perl based RCS implementation - see _Dataframework_.
@


1.45
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1021526640" format="1.0" version="1.45"}%
d135 1
a135 1
		1. *Copy* the TWikiRegistrationPub topic to TWikiRegistration. Do that by either editing the topics in the%TWIKIWEB% web, or by renaming the =.txt= and =.txt,v= files in the =twiki/data/%TWIKIWEB%= directory.
@


1.44
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1018175220" format="1.0" version="1.44"}%
d6 1
a6 1
_Installation instructions for the TWiki 01-Sep-2001 production release_
d13 1
a13 1
Request and download the TWiki 01-Sep-2001 distribution in Unix ZIP format from http://TWiki.org/download.html. _(To install TWiki on <nop>SourceForge, for use on a software development project, read TWiki:Codev/SourceForgeHowTo .)_ 
d95 1
d101 3
a103 1
		* Make sure RCS is installed. Set =$rcsDir= in =twiki/lib/TWiki.cfg= to mach the location of your RCS binaries. You can check this by issuing the comand =rcs= at the prompt, it should result in something like ="rcs: no input file"=.
d134 1
a134 1
			* %X% *NOTE:* In the TWiki distribution package, tje =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.
d170 1
a170 1
See [[AppendixFileSystem][Appendix A: TWiki File System]] for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
d173 2
a174 1
-- MikeMannix - 27 Jan 2002
@


1.43
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1012136640" format="1.0" version="1.43"}%
a154 1
	1. *Add* the new web to the color-coded web directory table by editing the %TWIKIWEB%.TWikiWebsTable topic.
@


1.42
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1007858684" format="1.0" version="1.42"}%
a7 2
---++ Overview

d13 1
a13 1
Request and download the TWiki 01-Sep-2001 distribution in Unix ZIP format from http://TWiki.org/download.html. _(To install TWiki on <nop>SourceForge, for use on a software development project, read TWiki:Codev/SourceForgeHowTo.)_ 
d17 1
a17 1
__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 [[#StepOneB][alternative Step 1]] instead._
d23 2
a24 1
	  <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.
a32 1
	 AllowOverride all
d39 6
d66 6
a71 5
| =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= |
d81 1
a81 1
	* __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: 
d83 1
a83 1
			* *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).
d88 7
a94 1
	* __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 &gt; x; mv x $f; done=
d100 1
a100 1
		* Make sure RCS is installed. Set =$rcsDir= in =twiki/lib/TWiki.cfg= to mach the location of your RCS binaries.
d107 1
d124 8
a131 7
		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: <a href="http://www.apache.org/docs/mod/directives.html">[1]</a>, <a href="http://www.mcs.kent.edu/system/web_help/htaccess/introduction.html">[2]</a>). In particular, the following <font color="red">red</font> part needs to be configured correctly: <br>
		  =Redirect <font color="red">/urlpath/to/TWiki/index.html</font> http<nop>://<font color="red">your.domain.com/urlpath/to/TWiki/bin/</font>view= <br>
		  =AuthUserFile <font color="red">/filepath/to/TWiki/data/</font>.htpasswd= <br>
		  =ErrorDocument 401 <font color="red">/urlpath/to/TWiki/bin/</font>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 <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.
			* __NOTE:__ The distribution package has a =twiki/data/.htpasswd= file which contains some 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 in case you want to allow guest logins.
d133 1
a133 1
			* __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.
d135 1
a135 1
		* __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.
d146 1
a146 1
		* Use a name starting with characters =A..Z=, followed by =a..z= and/or =0..9= characters, but __not__ a WikiWord.
d148 1
a148 1
		* __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.
d164 1
a164 1
__NOTE:__ User home topics are located in the %WIKITOOLNAME%.%MAINWEB% web - don't try to move them or create them in other webs. From any other web, user signatures have to point to %WIKITOOLNAME%.%MAINWEB% web, using a =%MAINWEB%.<nop>UserName= or =%<nop>MAINWEB%.<nop>UserName= format. (The =%<nop>MAINWEB%= variable is an advantage if you ever change the %MAINWEB% web name, but the standard =%MAINWEB%.<nop>UserName= is easier for users to enter, which is the bottom line! 
d171 1
a171 2
-- MikeMannix - 03 Dec 2001	

@


1.41
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1007517630" format="1.0" version="1.41"}%
d118 1
@


1.40
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1007450820" format="1.0" version="1.40"}%
d34 1
d157 2
a158 2
-- MikeMannix - 03 Dec 2001	

@


1.39
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1007288498" format="1.0" version="1.39"}%
d97 1
a97 1
	* Enable email notification of topic changes, MonitoringSiteActivity has more. 
d156 2
a157 1
-- MikeMannix - 14 Sep 2001 <br />
@


1.38
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1006509736" format="1.0" version="1.38"}%
d73 1
a78 1
	* Set the file permission of all Perl scripts in the =twiki/bin= directory as executable to =-rwxr-xr-x= (755).
@


1.37
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1000800431" format="1.0" version="1.37"}%
d131 1
a131 1
		* Use a name consisting of characters =A..Z= , =a..z= but __not__ in WikiNotation.
@


1.36
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1000625761" format="1.0" version="1.36"}%
d76 1
d78 1
a78 2
	* 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).
d82 1
a88 1
	* __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 &gt; x; mv x $f; done=
d90 1
a90 2
	* Enable email notification of topic changes, MonitoringSiteActivity has more. 
	* Add the TWiki:Main/PoweredByTWikiLogo to your %MAINWEB%.WebHome topic.
d95 3
a97 3
	* Edit the <nop>TWikiAdminGroup topic to include users with system administrator status.
	* Edit the TWikiPreferences topic in the TWiki:%TWIKIWEB% 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.
d99 1
d108 18
a149 14

---+++ 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: <a href="http://www.apache.org/docs/mod/directives.html">[1]</a>, <a href="http://www.mcs.kent.edu/system/web_help/htaccess/introduction.html">[2]</a>). In particular, the following <font color="red">red</font> part needs to be configured correctly: <br>
		  =Redirect <font color="red">/urlpath/to/TWiki/index.html</font> http<nop>://<font color="red">your.domain.com/urlpath/to/TWiki/bin/</font>view= <br>
		  =AuthUserFile <font color="red">/filepath/to/TWiki/data/</font>.htpasswd= <br>
		  =ErrorDocument 401 <font color="red">/urlpath/to/TWiki/bin/</font>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 <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.
		1. *Copy* the TWikiRegistrationPub topic to TWikiRegistration. Do that by either editing the topics in the%TWIKIWEB% web, or by renaming the =.txt= and =.txt,v= files in the =twiki/data/%TWIKIWEB%= 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.
@


1.35
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1000617871" format="1.0" version="1.35"}%
a16 4
	* __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

d43 6
d69 1
a69 1
---+++ Step 2: Check the Server Directory Settings
d71 2
a72 9
	* 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.
d74 3
d78 1
d83 1
a83 1
---+++ Step 4: Set the Main Configuration File
d85 1
a85 1
	* Edit the file =twiki/lib/TWiki.cfg= and set the variables to your needs.
d88 1
a88 1
	* 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: <br> =for f in *,v; do sed 's/nobody\:/www-data\:/' $f &gt; x; mv x $f; done=
d93 1
a93 1
---+++ Step 5: Finish Up from Your Browser
d152 1
a152 1
-- MikeMannix - 14 Sep 2001 <br />
@


1.34
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1000531222" format="1.0" version="1.34"}%
d6 1
a6 1
_Installation instructions for the current public release (01-Sep-2001)_
d12 5
a20 4
#StandardInstallation
---++ Standard Installation

Request and download the TWiki 01-Sep-2001 distribution in Unix ZIP format from http://TWiki.org/download.html.
d23 1
a23 2
	* __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 [[#StepOneB][alternative Step 1]] instead._
	* __NOTE:__ To install TWiki on <nop>SourceForge, for use on a software development project, read TWiki:Codev/SourceForgeHowTo.
d153 1
a153 1
-- MikeMannix - 14 Sep 2001 <br />
@


1.33
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1000527435" format="1.0" version="1.33"}%
a19 1

d22 2
a23 1
__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 [[#StepOneB][alternative Step 1]] instead._
d29 1
a29 1
	  <br> __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. <br>
d31 1
a31 1
<blockquote style="background-color:#f0f0f0">
d59 2
a60 2
| =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= |
a63 2

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


1.32
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1000513043" format="1.0" version="1.32"}%
d6 1
a6 1
_Clean install of the current public release (01-Sep-2001)_
d10 1
a10 1
These installation steps use the Apache web server on Linux as an example. TWiki runs on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been well-documented. More on that at TWiki:Codev/TWikiOnWindows.)
d12 3
a14 14
	* __NOTE:__ This Installation Guide assumes the following:

		* *User =nobody= <nop>* is used for all files manipulated by the CGI scripts (executed by the Web server), and user =twiki= for all other files. Replace user =nobody= with another user if your Web server executes scripts under a different name (default for Debian is =www-data=). Also, you can substitute user =twiki= with your own username.

		* *You have control* over the Web server configuration files. In case you don't - you may be installing on an ISP-hosted server - follow the steps but use these directories instead: 

| *TWiki dir:* | *What it is:* | *Where to copy:* | *Example:* |
| =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/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= |

Read TWiki:Codev/SourceForgeHowTo in case you want to install TWiki on <nop>SourceForge.
d16 1
d23 2
d47 22
d74 1
a74 1
		* 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.
d78 7
a84 7
	* Make sure Perl 5 and the Perl CGI library are 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 must be changed (alternatively you can 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.
	* 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.
	* 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).
	* 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==.
d88 2
a89 2
	* Edit the file ==twiki/lib/TWiki.cfg== and set the variables to your needs.
		* Set the file extension in the =$scriptSuffix= variable to ==cgi== or ==pl== if required.
d91 2
a92 2
	* 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 (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. A simple way to switch the locker of the RCS files is to use sed: <br> =for f in *,v; do sed 's/nobody\:/www-data\:/' $f &gt; 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)
d98 6
a103 3
	* Point your Web browser at ==http://your.domain.com/twiki/bin/view== and start TWiki-ing away!
	* Edit the TWikiPreferences topic in the TWiki:%TWIKIWEB% web to set the WIKIWEBMASTER email address, the WEBCOPYRIGHT message and other preferences.
	* Edit the WebNotify topic in all webs and set the users you want to notify.
d105 1
a105 1
That's it for the standard virgin installation of TWiki. Read on to learn how to customize TWiki.
d109 1
a109 1
Complete a Standard Installation and your new TWiki site should be up and running. You can develop and manage most aspects of your site from the browser interface. Core set-up functions require direct access to the server file system, via Telnet or FTP. You can make server-level site changes during installation, or at any time afterwards.
d112 1
a112 22
---+++ Creating a New Web

	* To create a new web:
		1. *Create* a new web data directory under =twiki/data= and check the file permission of the directory.
			* Use a name consisting of characters =A..Z= , =a..z= but __not__ in WikiNotation.
		1. *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.
		1. *Add* the new web to the web list (visible in the upper right corner of each topic) by editing the site-level preferences, %TWIKIWEB%.%WIKIPREFSTOPIC%:
			* Add the new web to the =%<nop>WIKIWEBLIST%= variable.
		1. *Update* the web settings by editing the <nop>WebPreferences topic of the new web:
			* Customize the =%<nop>WEBTOPICLIST%= variable to contain the web-specific links you prefer.
			* Set the WEBBGCOLOR variable to a color. The number represents the unique color for the web.
			* Set Plugins, access privileges, custom variables, other web-level options (ex: =%<nop>WEBCOPYRIGHT%= can be set for an individual web).
		1. *Add* the new web to the color-coded web directory table by editing the %TWIKIWEB%.TWikiWebsTable topic.
		1. *Test* the new web: view pages, create a new page.

	* That's it for a basic new web set-up. You can also further customize the web:
		* Create customized templates in the new templates directory (otherwise, templates are inherited from =twiki/templates=).
			* __NOTE:__ For web-specific templates in a =templates= subdirectory, ex: =twiki/templates/someweb=.
		* Create TWikiForms to add form-based page input that's stored separately from the main free-form topic text.

	* __NOTE:__ User home topics are located in the %WIKITOOLNAME%.%MAINWEB% web - don't try to move them or create them in other webs. From any web you can refer to users located in the %WIKITOOLNAME%.%MAINWEB% web with =%MAINWEB%.<nop>UserName= or =%<nop>MAINWEB%.<nop>UserName= - using the =%<nop>MAINWEB%= variable is preferable, particularly if you might change the %MAINWEB% web name.
d114 19
a132 1
---+++ Adding Variables &amp; Rendering Rules 
d134 1
a134 2
	* You can add new =%<nop>VARIABLES%=. Define site-level variables in the TWikiPreferences topic. See also TWikiVariables.
	* You can add new rendering rules or add new functionality to TWiki. To insure an easy upgrade of TWiki, it is recommended to do this sort of customization with TWikiPlugins and the Plugins API.
d138 1
a138 1
	* If you are on a non-authenticated server - not using SSL - and you would like to authenticate users:
d146 1
a146 1
			* __NOTE:__ You can customize the registration form if needed, like 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 will ensure that the fields are processed correctly.
d148 1
a148 1
		* A new line containing user name and encrypted password gets added to the =data/.htpasswd= file when a users registers. The file that comes with the TWiki installation contains a few user accounts of TWiki core team members (needed for testing). You can edit the file and delete those lines.
d152 1
a152 1
See [[TWikiDocumentation#FileSystem][A: TWiki File System]] for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
d154 1
a155 1
-- Main.PeterThoeny - 13 Sep 2001 <br />
@


1.31
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1000452462" format="1.0" version="1.31"}%
d16 1
a16 1
		* *You have control* over the Web server configuraton files. In case you don't - you may be installing on an ISP-hosted server - follow the steps but use these directories instead: 
d58 1
a58 1
	* Test if the =twiki/bin= directory is cgi-enabled:
d65 1
a65 1
		* *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 necssary.
d78 1
a78 1
	* *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/lib/TWiki.cfg= accordingly)
d141 1
a141 1
-- MikeMannix - 07 Sep 2001 <br />
@


1.30
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1000079118" format="1.0" version="1.30"}%
d10 1
a10 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. (TWiki on Windows is possible, but has not been well-documented. More on that at http://TWiki.org/cgi-bin/view/Codev/TWikiOnWindows.)
d14 1
a14 1
		* *User =nobody=* is used for all files manipulated by the CGI scripts (executed by the Web server), and user =twiki= for all other files. Replace user =nobody= with another user if your Web server executes scripts under a different name (default for Debian is =www-data=). Also, you can substitute user =twiki= with your own username.
d19 2
a20 1
| =twiki/bin= | CGI bin | cgi-bin enabled dir | =/home/smith/public_html/cgi-bin/twiki= |
d25 1
a25 1
Read http://TWiki.org/cgi-bin/view/Codev/SourceForgeHowTo in case you want to install TWiki on <nop>SourceForge.
d60 1
a60 1
		* Execute the =testenv= script from your browser ( =http://your.domain.com/twiki/bin/testenv= ). It shows a table with all CGI environment variables and tests the settings in your ==twiki/bin/wikicfg.pm== configuration file.
d67 4
a70 4
	* The scripts execute as ==nobody==. 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-rw-== (666).
	* 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 ==drwxrwxrwx== (777).
	* 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 ==drwxrwxrwx== (777).
d74 1
a74 1
	* Edit the file ==twiki/bin/wikicfg.pm== and set the variables at the beginning of the file to your needs.
d76 5
a80 5
		* Make sure RCS is installed. Set =$rcsDir= in =twiki/bin/wikicfg.pm= 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 (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. A simple way to switch the locker of the RCS files is to use sed: <br> =for f in *,v; do sed 's/nobody\:/www-data\:/' $f &gt; 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 directries to a place where they are not visible, and change the variables in =twiki/bin/wikicfg.pm= accordingly)
	* Enable email notification of topic changes, [[TWikiDocumentation#TWiki_Notification_of_Changes][Notification of Changes]] has more. 
	* Add the [[http://TWiki.org/cgi-bin/view/Main/PoweredByTWikiLogo][TWiki:Main.PoweredByTWikiLogo]] to your %MAINWEB%.WebHome topic.
a85 1
	* If you use =.htaccess=, edit the file and add the file extension to =edit=, =view=, =preview=, etc.
d114 1
a114 1
		* Create [[TWikiDocumentation#TWiki_Form_Templates][Form Templates]] to add form-based page input that's stored separately from the main free-form topic text.
d120 2
a121 1
	* You can add new rendering rules or new =%<nop>VARIABLES%=. To insure an easy upgrade of TWiki, it is recommended to do this sort of customization with [[TWikiDocumentation#TWiki_Plugins][TWiki Plugins]] and the Plugins API.
d130 1
d142 1
@


1.29
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999988391" format="1.0" version="1.29"}%
d12 1
a12 1
__NOTE:__ Below installation steps 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.
d14 3
a16 1
__NOTE:__ Below installation steps assume that you have control over the web server configuraton files. In case you don't - you may be installing on an ISP-hosted server - follow the steps but use these directories instead:
d90 1
a90 1
---++ Extra Server-Level Options
d98 5
a102 5
		* Use a name for the web consisting of characters =A..Z= , =a..z= but *not* in WikiNotation.
		* Create a new template directory under =twiki/templates= .
		* Create a new data directory under =twiki/data= and check the file permission of the directory.
		* Copy the =Web*.txt= files 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.
		* Add the new web to the web list (visible in the upper right corner of each topic) by editing the site-level preferences %TWIKIWEB%.%WIKIPREFSTOPIC%:
d104 13
a116 9
		* Add the new web to the web table (at the bottom of each WebHome topic) by editing the %TWIKIWEB%.TWikiWebsTable topic.
		* Change the web preferences by editing the <nop>WebPreferences topic of the new web:
			* 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.)
			* Customize the =%<nop>WEBTOPICLIST%= variable to contain the web specific links you prefer.
			* Optional: Set the =%<nop>WEBCOPYRIGHT%= variable to have a web-specific copyright text (at the bottom of each topic).
		* If needed, create customized templates in the new templates directory. (Non existing templates are inherited from =twiki/templates= )
		* If you want to use Form Templates - see [[TWikiDocumentation#TWiki_Form_Templates][TWiki Form Template]]
		* 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 <nop>WebStatistics in the new web and delete old usage entries.
		* Note that user home topics are only located in the %WIKITOOLNAME%.%MAINWEB% web, so don't try to move them or create them in other webs. From any web you can refer to users located in the %WIKITOOLNAME%.%MAINWEB% web like =%MAINWEB%.<nop>UserName= or =%<nop>MAINWEB%.<nop>UserName=.
d120 1
a120 1
	* You can add new rendering rules or new =%<nop>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= .
d124 2
a125 2
	* If you are on a non authenticated server (i.e. not using SSL) and you would 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: <a href="http://www.apache.org/docs/mod/directives.html">[1]</a>, <a href="http://www.mcs.kent.edu/system/web_help/htaccess/introduction.html">[2]</a>). In particular, the following <font color="red">red</font> part needs to be configured correctly: <br>
d129 4
a132 3
			* __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.
		* Copy the TWikiRegistrationPub topic to TWikiRegistration. Do that by either editing the topics in the%TWIKIWEB% web, or by renaming the =.txt= and =.txt,v= files in the =twiki/data/%TWIKIWEB%= directory.
			* __Note:__ You can customize the registration form if needed, like 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 will ensure that the fields are processed correctly.
d135 1
a135 5
---++ TWiki File System Snapshot

Here are partial directory listings showing typical file permissions and ownership. This is provided for general debugging use only and isn't an exact representation of the current distribution. There is also a file [[TWikiDocumentatin#DocsATWikiFileSystem][listing by directory]], with individual file descriptions, for the current TWiki release.

Directory =twiki/bin= :
d137 1
a137 109
<pre>
drwxrwxr-x	2 twiki twiki	4096 Jun 17 16:34 .
drwxrwxr-x	3 twiki twiki	4096 Jun 17 16:34 ..
-rw-rw-r--	1 twiki twiki	 650 Feb 10  2000 .htaccess
-rwxrwxr-x	1 twiki twiki	4322 Mar 12 00:31 attach
-rwxrwxr-x	1 twiki twiki	1426 Jun 20 19:52 delete
-rwxrwxr-x	1 twiki twiki	9001 Jul 28 11:03 edit
-rwxrwxr-x	1 twiki twiki	1811 Mar 11 02:27 geturl
-rwxrwxr-x	1 twiki twiki	5006 Mar 11 02:41 mailnotify
-rwxrwxr-x	1 twiki twiki	1769 Mar 11 03:07 oops
-rwxrwxr-x	1 twiki twiki	6890 Jun 21 19:58 preview
-rwxrwxr-x	1 twiki twiki	7606 Mar 31 18:30 rdiff
-rwxrwxr-x	1 twiki twiki	8349 Jun 21 18:12 register
-rwxrwxr-x	1 twiki twiki	2693 Jul  5 14:32 save
-rwxrwxr-x	1 twiki twiki	3831 Jul 20 12:13 search
-rwxrwxr-x	1 twiki twiki	9835 Jun 20 19:03 statistics
-rwxrwxr-x	1 twiki twiki	 509 Feb  7  2000 testenv
-rwxrwxr-x	1 twiki twiki  14543 Jul 20 18:46 upload
-rwxrwxr-x	1 twiki twiki	4755 May 22 18:11 view
-rwxrwxr-x	1 twiki twiki	1689 Jun 20 20:10 viewfile
</pre>

Directory =twiki/templates/= :

<pre>
drwxrwxr-x	4 twiki twiki	4096 Aug  3 01:17 .
drwxrwxr-x	4 twiki twiki	4096 Aug 19 18:38 ..
drwxrwxr-x	2 twiki twiki	4096 Jun 17 16:35 Know
drwxrwxr-x	2 twiki twiki	4096 May  1 01:24 Main
-rw-rw-r--	1 twiki twiki	2688 Aug 15 18:15 attach.tmpl
-rw-rw-r--	1 twiki twiki	1283 Jul 20 15:56 attachtable.tmpl
-rw-rw-r--	1 twiki twiki	1907 Jul 28 16:41 changes.tmpl
-rw-rw-r--	1 twiki twiki	2265 Aug 15 17:57 edit.tmpl
-rw-rw-r--	1 twiki twiki	 965 Feb  8  2000 mailnotify.tmpl
-rw-rw-r--	1 twiki twiki	  30 Jan 13  1999 notedited.tmpl
-rw-rw-r--	1 twiki twiki	 940 Jul 20 15:59 notext.tmpl
-rw-rw-r--	1 twiki twiki	 907 Jul 20 16:01 notwiki.tmpl
-rw-rw-r--	1 twiki twiki	 341 Mar  8 11:39 noweb.tmpl
-rw-rw-r--	1 twiki twiki	1000 Mar  8 11:40 oops.tmpl
-rw-rw-r--	1 twiki twiki	1043 Oct 23 19:17 oopsaccesschange.tmpl
-rw-rw-r--	1 twiki twiki	1036 Oct 23 19:17 oopsaccessview.tmpl
-rw-rw-r--	1 twiki twiki	 914 Mar  8 11:40 oopsdel.tmpl
-rw-rw-r--	1 twiki twiki	1423 May 29 01:23 oopslocked.tmpl
-rw-rw-r--	1 twiki twiki	1067 Mar  8 11:41 oopsregexist.tmpl
-rw-rw-r--	1 twiki twiki	 955 Mar  8 11:41 oopsregpasswd.tmpl
</pre>

Directory =twiki/data/= :

<pre>
drwxrwxrwx	6 nobody  nobody  4096 Aug  3 01:09 .
drwxrwxr-x	4 twiki	twiki	4096 Aug 19 18:38 ..
-rw-rw-r--	1 nobody  nobody	 51 Apr 21 16:48 .htpasswd
drwxrwxrwx	2 nobody  nobody  4096 Aug 20 17:18 Know
drwxrwxrwx	2 nobody  nobody  4096 Aug 19 04:15 Main
drwxrwxrwx	2 nobody  nobody  4096 Aug 20 17:56 TWiki
-rw-rw-rw-	1 twiki	twiki		1 Mar 11 04:19 debug.txt
-rw-r--r--	1 nobody  nobody  1516 Aug 20 17:56 log200008.txt
</pre>

Partial file list for =twiki/data/Main= :

<pre>
drwxrwxrwx	2 nobody  nobody  4096 Aug 19 04:15 .
drwxrwxrwx	6 nobody  nobody  4096 Aug  3 01:09 ..
-rw-rw-rw-	1 twiki twiki	  3716 Aug 19 02:19 .changes
-rw-rw-rw-	1 twiki twiki		  9 Aug 19 02:45 .mailnotify
-rw-r--r--	1 nobody  nobody	358 Aug 18 17:22 OfficeLocations.txt
-r--r--r--	1 nobody  nobody	878 Aug 18 17:22 OfficeLocations.txt,v
-rw-r--r--	1 nobody  nobody	680 Aug 18 17:36 TWikiGuest.txt
-r--r--r--	1 nobody  nobody  1989 Aug 18 17:36 TWikiGuest.txt,v
-rw-r--r--	1 nobody  nobody	459 Aug 18 17:19 TWikiUsers.txt
-r--r--r--	1 nobody  nobody  3840 Aug 18 17:19 TWikiUsers.txt,v
-rw-r--r--	1 nobody  nobody	 95 Aug 19 03:06 WebChanges.txt
-r--r--r--	1 nobody  nobody	284 Aug 19 03:06 WebChanges.txt,v
-rw-r--r--	1 nobody  nobody  1853 Aug 18 18:08 WebHome.txt
-r--r--r--	1 nobody  nobody  6523 Aug 18 18:08 WebHome.txt,v
</pre>

Directory =twiki/pub/= :

<pre>
drwxrwxrwx	6 nobody  nobody  4096 Aug  3 01:21 .
drwxrwxr-x	3 twiki	twiki	4096 Jun 17 16:35 ..
drwxrwxrwx	3 nobody  nobody  4096 Jun 17 16:35 Know
drwxrwxrwx	2 nobody  nobody  4096 Aug  3 01:21 Main
drwxrwxrwx	3 nobody  nobody  4096 Aug  3 01:21 TWiki
-rw-rw-r--	1 twiki	twiki	1078 Jan 14  2000 favicon.ico
drwxrwxr-x	2 twiki	twiki	4096 Jun 17 16:35 icn
-rw-rw-r--	1 twiki	twiki	3016 Oct  5  1999 twikilogo.gif
-rw-rw-r--	1 twiki	twiki	5320 Oct  5  1999 twikilogo1.gif
-rw-rw-r--	1 twiki	twiki	6125 Oct  5  1999 twikilogo2.gif
-rw-rw-r--	1 twiki	twiki	7218 Oct  5  1999 twikilogo3.gif
-rw-rw-r--	1 twiki	twiki	6710 Oct  5  1999 twikilogo4.gif
-rw-rw-r--	1 twiki	twiki	2877 Jun  7  1999 wikiHome.gif
</pre>

Partial file list for =twiki/pub/icn/= :

<pre>
drwxrwxr-x	2 twiki	twiki	4096 Jun 17 16:35 .
drwxrwxrwx	6 nobody  nobody  4096 Aug  3 01:21 ..
-rw-rw-r--	1 twiki	twiki	 801 Mar 26  1999 _filetypes.txt
-rw-rw-r--	1 twiki	twiki	 143 Mar  9  1999 bat.gif
-rw-rw-r--	1 twiki	twiki	 926 Mar  9  1999 bmp.gif
-rw-rw-r--	1 twiki	twiki	 141 Mar 25  1999 c.gif
-rw-rw-r--	1 twiki	twiki	 144 Mar  9  1999 dll.gif
-rw-rw-r--	1 twiki	twiki	 152 Mar  9  1999 doc.gif
</pre>
@


1.28
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999857002" format="1.0" version="1.28"}%
d12 1
a12 1
__Note:__ Below installation steps 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.
d14 1
a14 1
__Note:__ Below installation steps assume that you have control over the web server configuraton files. In case you don't - you may be installing on an ISP-hosted server - follow the steps but use these directories instead:
d26 1
a26 1
Request and download the TWiki %VERSION% distribution in Unix ZIP format from http://TWiki.org/download.html.
d101 1
a101 1
			* Add the new web to the WIKIWEBLIST variable.
d105 2
a106 2
			* Customize the WEBTOPICLIST variable to contain the web specific links you prefer.
			* Optional: Set the WEBCOPYRIGHT variable to have a web-specific copyright text (at the bottom of each topic).
d108 1
a108 1
		* If you want to use form templates - see FormTemplateSystem
d114 1
a114 1
	* You can add new rendering rules or new %<nop>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= .
d130 1
a130 1
Here are partial directory listings showing typical file permissions and ownership. This is provided for general debugging use only and isn't an exact representation of the current distribution. There is also a complete file [[TWiki.TWikiImplementationNotes][listing by directory]], with individual file descriptions, for the current TWiki release.
d244 1
a244 1
-- MikeMannix - 07 Sep 2001 <br />
@


1.27
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999566837" format="1.0" version="1.27"}%
d4 1
a4 1
---## TWiki Installation Guide
d8 1
a8 1
---+++ Overview
d24 1
a24 1
---+++ Standard Installation
d28 1
a28 1
---++++ Step 1: Create &amp; Configure the Directories
d52 1
a52 1
---++++ Step 2: Check the Server Directory Settings
d59 1
a59 1
---++++ Step 3: Enable Perl File Permissions
d69 1
a69 1
---++++ Step 4: Set the Main Configuration File
d79 1
a79 1
---++++ Step 5: Finish Up from Your Browser
d88 1
a88 1
---+++ Extra Server-Level Options
d93 1
a93 1
---++++ Creating a New Web
d112 1
a112 1
---++++ Adding Variables &amp; Rendering Rules 
d116 1
a116 1
---++++ Enabling Basic Authentication (.htaccess)
d128 1
a128 1
---+++ TWiki File System Snapshot
a155 1

a180 1

a193 1

a212 1

a230 1

d244 1
a244 1
-- PeterThoeny - 16 Mar 2001 <br>
@


1.26
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999329001" format="1.0" version="1.26"}%
d6 5
a10 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. (TWiki on Windows is possible, but has not been documented well. More on that at http://TWiki.org/cgi-bin/view/Codev/TWikiOnWindows )
d61 1
a61 1
	* Make sure Perl 5 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== ).
@


1.25
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999319650" format="1.0" version="1.25"}%
d10 2
a11 1
__Note:__ Below installation steps assume that you have control over the web server configuraton files. In case you don't (i.e. if you are installing it on a hosted server) follow the steps but use these directories instead:
d17 1
d20 5
a24 1
---+++ Standard Installation Steps
a25 1
	* Request the TWiki distribution (in Unix ZIP format) from http://TWiki.org/download.html .
d31 3
a33 1
	* Here are example =httpd.conf= entries:
d46 4
d53 17
a69 15
		* Execute the =testenv= script from your browser ( =http://your.domain.com/twiki/bin/testenv= ). It shows a table with all CGI environment variables and tests the settings in your =twiki/bin/wikicfg.pm= configuration file.
	* Make sure PERL 5 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= ).
	* 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.
	* The scripts execute as =nobody= . Set the file permission of all Perl scripts in the =twiki/bin= directory as executable to =-rwxr-xr-x= .
	* 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 666 ( =-rw-rw-rw-= ).
	* Set the permission of the =twiki/data= directory and all its subdirectories so that files in there are writable by user =nobody=. A simple way is to chmod them to 777 ( =drwxrwxrwx= ).
	* 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 777 ( =drwxrwxrwx= ).
	* Edit the file =twiki/bin/wikicfg.pm= and set the variables at the beginning of the file to your needs.
	* Make sure RCS is installed. Set =$rcsDir= in =twiki/bin/wikicfg.pm= to mach the location of your RCS binaries.
	* Point your browser at http://your.domain.com/twiki/bin/view and start TWiki-ing away!
	* Using your browser, edit the TWikiPreferences topic in the TWiki.%TWIKIWEB% web to set the WIKIWEBMASTER email address, the WEBCOPYRIGHT message and other preferences.
	* Note in case the cgi scripts must have a file extension like =.pl= or =.cgi=:
		* Add the extension to all the scripts (except for the =.pm= ones) in =twiki/bin=
		* Edit =wikicfg.pm= and set the file extension in the =$scriptSuffix= variable.
		* If you use =.htaccess=, edit the file and add the file extension to =edit=, =view=, =preview=, etc.
d71 2
a72 2
	* 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)
	* Enable email notification of topic changes, [[TWikiDocumentation#TWiki_Notification_of_Changes][Notification of Changes]] has more. Using your browser, edit also the WebNotify topic in all webs and set the users you want to notify.
d75 1
a75 15
---+++ Adding Variables &amp; Rendering Rules 

	* Optional: You can add new rendering rules or new %<nop>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= .

---+++ Enabling Basic Authentication (.htaccess)

	* Optional: If you are on a non authenticated server (i.e. not using SSL) and you would 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: <a href="http://www.apache.org/docs/mod/directives.html">[1]</a>, <a href="http://www.mcs.kent.edu/system/web_help/htaccess/introduction.html">[2]</a>). In particular, the following <font color="red">red</font> part needs to be configured correctly: <br>
		  =Redirect <font color="red">/urlpath/to/TWiki/index.html</font> http<nop>://<font color="red">your.domain.com/urlpath/to/TWiki/bin/</font>view= <br>
		  =AuthUserFile <font color="red">/filepath/to/TWiki/data/</font>.htpasswd= <br>
		  =ErrorDocument 401 <font color="red">/urlpath/to/TWiki/bin/</font>oops/TWiki/TWikiRegistration?template=oopsauth=
			* __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.
		* Copy the TWikiRegistrationPub topic to TWikiRegistration. Do that by either editing the topics in the%TWIKIWEB% web, or by renaming the =.txt= and =.txt,v= files in the =twiki/data/%TWIKIWEB%= directory.
			* __Note:__ You can customize the registration form if needed, like 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 will ensure that the fields are processed correctly.
		* A new line containing user name and encrypted password gets added to the =data/.htpasswd= file when a users registers. The file that comes with the TWiki installation contains a few user accounts of TWiki core team members (needed for testing). You can edit the file and delete those lines.
d77 8
a84 1
---+++ Generating Site Usage Statistics
d86 1
a86 10
	* Optional: You can automatically generate usage statistics for all webs. To enable this:
		* Make sure variable =$doLogTopicView, $doLogTopicSave and $doLogTopicUpload= in =wikicfg.pm= are set. This will generate log entries in file =twiki/data/log&lt;date&gt;.txt= .
		* 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.
		* Call the =twiki/bin/statistics= script from a cron job, once a day is recommended. This will update the WebStatistics topics in all webs.
		* __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 &gt;/dev/null 2&gt;&amp;1)=
		* 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 &gt;/dev/null 2&gt;&amp;1)=
		* The =twiki/bin/statistics= script can also be executed as a CGI script, just enter the URL in your browser. Examples:
			* Update current month for all webs: <br> =http://mydomain.com/twiki/bin/statistics=
			* Update current month for Main web only: <br> =http://mydomain.com/twiki/bin/statistics/Main=
			* Update January 2000 for Main web: <br> =http://mydomain.com/twiki/bin/statistics/Main?logdate=200001=
d89 1
a89 1
---+++ Creating a New Web
d107 16
@


1.24
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999255302" format="1.0" version="1.24"}%
d233 1
@


1.23
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999193564" format="1.0" version="1.23"}%
d4 1
a4 1
---## TWiki Installation Notes
d62 1
a62 1
---+++ Add New Rendering Rules &amp; Variables
d66 1
a66 1
---+++ Enable Basic Authentication (.htaccess)
d78 1
a78 1
---+++ Generate Site Usage Statistics
d92 1
a92 1
---+++ Create a New Web
d111 1
a111 1
---+++ Contents of Directories
d113 1
a113 1
Here are contents of directories showing file permissions. Please note that this is for debugging reasons only and does not exactly reflect the distribution:
a136 6
-rw-rw-r--	1 twiki twiki  34123 Nov  1 15:43 wiki.pm
-rw-rw-r--	1 twiki twiki	7234 Oct 23 00:34 wikiaccess.pm
-rw-rw-r--	1 twiki twiki  11719 Oct 28 21:58 wikicfg.pm
-rw-rw-r--	1 twiki twiki	6441 Nov  1 23:13 wikiprefs.pm
-rw-rw-r--	1 twiki twiki  13160 Oct 27 14:53 wikisearch.pm
-rw-rw-r--	1 twiki twiki  10540 Oct 28 21:43 wikistore.pm
a162 12
-rw-rw-r--	1 twiki twiki	 966 Mar  8 11:41 oopsregrequ.tmpl
-rw-rw-r--	1 twiki twiki	1244 Apr 28 17:11 oopsregthanks.tmpl
-rw-rw-r--	1 twiki twiki	1003 Jul 22 12:48 oopsregwiki.tmpl
-rw-rw-r--	1 twiki twiki	1607 Mar  8 11:42 oopsrev.tmpl
-rw-rw-r--	1 twiki twiki	 949 Mar  8 11:43 oopsupload.tmpl
-rw-rw-r--	1 twiki twiki	1735 Aug 15 18:14 preview.tmpl
-rw-rw-r--	1 twiki twiki	1682 Aug 15 18:14 rdiff.tmpl
-rw-rw-r--	1 twiki twiki	 530 Jul 22 12:10 register.tmpl
-rw-rw-r--	1 twiki twiki	 690 Apr 28 16:53 registernotify.tmpl
-rw-rw-r--	1 twiki twiki	1900 Aug 15 18:15 search.tmpl
-rw-rw-r--	1 twiki twiki	1785 Aug 15 18:15 searchbookview.tmpl
-rw-rw-r--	1 twiki twiki	1559 Aug 19 02:53 view.tmpl
d180 1
a180 1
Part of directory =twiki/data/Main= :
a196 10
-rw-r--r--	1 nobody  nobody	 56 Aug 18 17:21 WebIndex.txt
-r--r--r--	1 nobody  nobody	245 Aug 18 17:21 WebIndex.txt,v
-rw-r--r--	1 nobody  nobody	495 Aug 18 17:40 WebNotify.txt
-r--r--r--	1 nobody  nobody  1896 Aug 18 17:40 WebNotify.txt,v
-rw-r--r--	1 nobody  nobody  1904 Aug 19 01:01 WebPreferences.txt
-r--r--r--	1 nobody  nobody  3108 Aug 19 01:01 WebPreferences.txt,v
-rw-r--r--	1 nobody  nobody  5553 Aug 19 02:30 WebSearch.txt
-r--r--r--	1 nobody  nobody  8406 Aug 19 02:30 WebSearch.txt,v
-rw-r--r--	1 nobody  nobody	729 Aug 18 17:41 WebStatistics.txt
-r--r--r--	1 nobody  nobody  1129 Aug 18 17:41 WebStatistics.txt,v
d219 1
a219 1
Directory =twiki/pub/icn/= :
a229 23
-rw-rw-r--	1 twiki	twiki	 130 Mar  9  1999 else.gif
-rw-rw-r--	1 twiki	twiki	 876 Mar 26  1999 exe.gif
-rw-rw-r--	1 twiki	twiki	 147 Mar  9  1999 fon.gif
-rw-rw-r--	1 twiki	twiki	 142 Mar 25  1999 h.gif
-rw-rw-r--	1 twiki	twiki	 156 Mar  9  1999 hlp.gif
-rw-rw-r--	1 twiki	twiki	 186 Mar  9  1999 html.gif
-rw-rw-r--	1 twiki	twiki	 144 Mar 25  1999 java.gif
-rw-rw-r--	1 twiki	twiki	 148 Mar  9  1999 mov.gif
-rw-rw-r--	1 twiki	twiki	 150 Mar  9  1999 pdf.gif
-rw-rw-r--	1 twiki	twiki	 146 Mar 25  1999 pl.gif
-rw-rw-r--	1 twiki	twiki	 150 Mar  9  1999 ppt.gif
-rw-rw-r--	1 twiki	twiki	 148 Mar 25  1999 ps.gif
-rw-rw-r--	1 twiki	twiki	 148 Mar 25  1999 py.gif
-rw-rw-r--	1 twiki	twiki	 130 Mar  9  1999 ram.gif
-rw-rw-r--	1 twiki	twiki	 154 Mar  9  1999 reg.gif
-rw-rw-r--	1 twiki	twiki	 147 Mar 25  1999 sh.gif
-rw-rw-r--	1 twiki	twiki	 155 Mar  9  1999 sniff.gif
-rw-rw-r--	1 twiki	twiki	 149 Mar  9  1999 ttf.gif
-rw-rw-r--	1 twiki	twiki	 134 Mar  9  1999 txt.gif
-rw-rw-r--	1 twiki	twiki	 154 Mar  9  1999 wav.gif
-rw-rw-r--	1 twiki	twiki	 152 Mar  9  1999 wri.gif
-rw-rw-r--	1 twiki	twiki	 152 Mar  9  1999 xls.gif
-rw-rw-r--	1 twiki	twiki	 144 Mar  9  1999 zip.gif
@


1.22
log
@none
@
text
@d1 3
a3 1
%META:TOPICINFO{author="JohnTalintyre" date="999167655" format="1.0" version="1.22"}%
d18 1
a18 1
---+++ Installation steps
d62 2
d66 2
d78 2
d90 3
@


1.21
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="997578208" format="1.0beta2" version="1.21"}%
d96 1
a96 1
		* 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. More on that in <A href="TWikiDocumentation#category">TWiki Category Table</A>.
a169 12
</pre>


Directory =twiki/templates/Know= (has a TWiki Category Table) :

<pre>
drwxrwxr-x	2 twiki	twiki	4096 Jun 17 16:35 .
drwxrwxr-x	4 twiki	twiki	4096 Aug  3 01:17 ..
-rw-rw-r--	1 twiki	twiki	 446 Jun  7  1999 notedited.tmpl
-rw-rw-r--	1 twiki	twiki	 206 Jun  7  1999 twikicatedit.tmpl
-rw-rw-r--	1 twiki	twiki	1068 Aug 18 18:26 twikicatitems.tmpl
-rw-rw-r--	1 twiki	twiki	 231 Jun  7  1999 twikicatview.tmpl
@


1.20
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{version="1.20" date="994838433" author="PeterThoeny" format="1.0beta2"}%
d66 1
a66 1
		  =ErrorDocument 401 <font color="red">/urlpath/to/TWiki/bin/</font>view/TWiki/TWikiRegistration=
d70 1
@


1.19
log
@none
@
text
@d1 1
d63 7
a69 2
		* 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: <a href="http://www.apache.org/docs/mod/directives.html">[1]</a>, <a href="http://www.mcs.kent.edu/system/web_help/htaccess/introduction.html">[2]</a>). __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.
		* Copy the TWikiRegistrationPub topic to TWikiRegistration. You can customize the topic if needed. __Note:__ You can delete or add new input tags 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.
@


1.18
log
@none
@
text
@d1 2
d15 1
a15 1
Installation steps:
d56 2
a57 2
	* Enable email notification of topic changes, <A href="TWikiDocumentation#notification">Notification of Changes</A> has more. Using your browser, edit also the WebNotify topic in all webs and set the users you want to notify.
	* Add the <a href="http://TWiki.org/cgi-bin/view/Main/PoweredByTWikiLogo">TWiki:Main.PoweredByTWikiLogo</a> to your %MAINWEB%.WebHome topic.
d93 2
d277 1
a277 1
-- Main.PeterThoeny - 29 Dec 2000 <br>
@


1.17
log
@none
@
text
@d23 1
a23 1
 Alias /twiki/ "/home/httpd/twiki"
@


1.16
log
@none
@
text
@d89 1
a89 1

d273 1
a273 1
-- Main.PeterThoeny - 24 Nov 2000 <br>
@


1.15
log
@none
@
text
@d41 3
a43 3
	* Set the file permission of all files below =twiki/data= to 666 ( =-rw-rw-rw-= ).
	* Set the file permission of the =twiki/data= directory and all its subdirectories to 777 ( =drwxrwxrwx= ).
	* Set the file permission of the =twiki/pub= directory to 777 ( =drwxrwxrwx= ).
@


1.14
log
@none
@
text
@d47 1
d52 1
a52 1
	* 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 (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. A simple way to switch the locker of the RCS files is to use sed: <br> =for f in *,v; do sed 's/nobody/www-data/' $f &gt; x; mv x $f; done=
d54 1
a54 1
	* Enable email notification of topic changes, <A href="TWikiDocumentation#notification">Notification of Changes</A> has more.
@


1.13
log
@none
@
text
@d22 2
a23 2
 <pre> ScriptAlias /twiki/bin/ "/home/httpd/twiki/bin/"
 Alias /twiki/ "/home/httpd/twiki/pub/"
d26 1
a26 1
	 SetHandler cgi-script
d30 2
a31 2
	 Options FollowSymLinks +Includes
	 AllowOverride None
d272 1
a272 1
-- Main.PeterThoeny - 13 Nov 2000 <br>
@


1.12
log
@none
@
text
@d1 1
a1 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. (TWiki on Windows is possible, but has not been documented well. More on that at http://TWiki.org/Codev/TWikiOnWindows )
d11 1
a11 1
Read http://TWiki.org/Codev/SourceForgeHowTo in case you wnat to install TWiki on <nop>SourceForge.
d37 1
a37 1
		* Execute the =testenv= script from your browser ( =http://your.domain.com/twiki/bin/testenv= ). It should show a table wit all CGI environment variables.
d272 1
a272 1
-- Main.PeterThoeny - 02 Nov 2000 <br>
@


1.11
log
@none
@
text
@d3 11
a13 1
__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.
d47 4
@


1.10
log
@none
@
text
@d1 1
a1 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. (TWiki on Windows is possible, but has not been documented well. More on that at http://twiki.sourceforge.net/cgi-bin/view/Codev/TWikiOnWindows )
d5 1
a5 1
	* Request the TWiki distribution (in Unix ZIP format) from http://TWiki.SourceForge.net/download.html .
d40 1
a40 1
	* Add the <a href="http://TWiki.SourceForge.net/cgi-bin/view/Main/PoweredByTWikiLogo">PoweredByTWikiLogo</a> if TWiki is installed on a public web server.
@


1.9
log
@none
@
text
@d39 1
a39 1
	* Enable email notification of topic changes, <A href="TWikiDocumentation#notification">(4)</A> has more.
d72 1
a72 1
		* 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. More on that in <A href="TWikiDocumentation#category">(5)</A> TWiki Category Table.
d100 6
a105 3
-rw-rw-r--	1 twiki twiki  40103 Aug 18 13:00 wiki.pm
-rw-rw-r--	1 twiki twiki  11521 Aug 19 18:38 wikicfg.pm
-rw-rw-r--	1 twiki twiki  13969 Aug 19 00:30 wikisearch.pm
d126 2
d258 1
a258 1
-- Main.PeterThoeny - 23 Sep 2000 <br>
@


1.8
log
@none
@
text
@d44 2
a45 2
	* Optional: If you are on a public server and you would 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: <a href="http://www.scs.nevada.edu/cs/documents/web/htaccess.html">[1]</a>, <a href="http://www.mcs.kent.edu/system/web_help/htaccess/introduction.html">[2]</a>, <a href="http://www.apache.org/docs/mod/directives.html">[3]</a>). __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.
@


1.7
log
@none
@
text
@d37 1
a37 1
	* 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.
d253 1
a253 1
-- Main.PeterThoeny - 20 Aug 2000 <br>
@


1.6
log
@none
@
text
@d1 1
a1 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.
d6 1
a6 1
	* Create directory =/home/httpd/twiki= and unzip the TWiki distribution to this directory.
d10 1
a10 1
	  <br> __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. (MichaelBrooks 30 Jun 2000)_ <br>
d27 2
a28 2
		* Execute the =testenv= script from your browser ( =http://your.domain.com/twiki/bin/testenv= ). It should show a table of all CGI environment variables.
	* 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= ).
d30 1
a30 1
	* 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= .
d35 2
a36 2
	* 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= .
	* Point your browser at http://your.domain.com/twiki/bin/view and start wiki-ing away! 
d39 1
a39 1
	* Enable email notification of topic changes, <A href="TWikiDocumentation#notification">(3)</A> has more.
d42 1
a42 1
	* Optional: You can add new rendering rules or new %<nop>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= .
d46 1
a46 1
		* 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.
d63 2
a64 2
		* 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.
		* Add the new web to the web list (on top of each topic) by editing the site-level preferences %MAINWEB%.%WIKIPREFSTOPIC%:
d66 1
a66 1
		* Add the new web to the web table (at the bottom of each WebHome topic) by editing the %MAINWEB%.TWikiWebsTable topic.
d72 1
a72 1
		* 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.
d76 1
a76 1
Here are contents of directories with file permissions. Please note that this is for debugging reasons only and does not exactly reflect the distribution:
d78 1
a78 1
directory =twiki/bin= :
d81 170
a250 23
drwxr-xr-x	2 twiki	twiki		 1024 Feb 18 18:31 .
drwxr-xr-x	8 twiki	twiki		 1024 Feb 26 04:20 ..
-rw-rw-r--	1 twiki	twiki		  770 Feb 10 12:10 .htaccess
-rw-r-xr-x	1 twiki	twiki		 3968 Feb 18 00:26 attach
-rwxr-xr-x	1 twiki	twiki		 3033 Feb 17 23:57 changes
-rw-r-xr-x	1 twiki	twiki		 1377 Feb  8 18:18 delete
-rw-r-xr-x	1 twiki	twiki		 8785 Feb 17 23:58 edit
-rwxr--r--	1 twiki	twiki		 1811 Feb  4 14:31 geturl
-rwxr-xr-x	1 twiki	twiki		 5047 Feb  8 20:33 mailnotify
-rw-r-xr-x	1 twiki	twiki		 1825 Feb  8 18:29 oops
-rw-r-xr-x	1 twiki	twiki		 6932 Feb 11 02:06 preview
-rw-r-xr-x	1 twiki	twiki		 7804 Feb 17 23:59 rdiff
-rw-r-xr-x	1 twiki	twiki		 7010 Feb 18 00:03 register
-rw-r-xr-x	1 twiki	twiki		 2501 Jan 25 19:39 save
-rwxr-xr-x	1 twiki	twiki		 1778 Feb 18 00:04 search
-rw-r-xr-x	1 twiki	twiki		 9810 Feb  8 18:43 statistics
-rwxr-xr-x	1 twiki	twiki		  509 Feb  7 18:55 testenv
-rw-r-xr-x	1 twiki	twiki		 6856 Feb 18 00:11 upload
-rw-r-xr-x	1 twiki	twiki		 4922 Feb 17 23:54 view
-rw-r-xr-x	1 twiki	twiki		 1606 May 21  1999 viewfile
-rw-r-xr-x	1 twiki	twiki		27794 Feb 26 06:03 wiki.pm
-rw-r-xr-x	1 twiki	twiki		10143 Feb 27 04:03 wikicfg.pm
-rw-r-xr-x	1 twiki	twiki		 5440 Feb  7 04:36 wikisearch.pm
d253 1
a253 155
directory =twiki/templates/= :

<pre>
drwxr-xr-x	7 twiki	twiki		 1024 Jan 16 19:39 .
drwxr-xr-x	8 twiki	twiki		 1024 Feb 26 04:20 ..
drwxr-xr-x	2 twiki	twiki		 1024 Jun  8  1999 Know
drwxr-xr-x	2 twiki	twiki		 1024 Dec  9  1998 Main
-rw-r--r--	1 twiki	twiki		 2286 Feb 24 21:50 attach.tmpl
-rw-r--r--	1 twiki	twiki		 1272 Feb  8 16:07 attachtable.tmpl
-rw-r--r--	1 twiki	twiki		 1884 Feb 24 21:54 changes.tmpl
-rw-r--r--	1 twiki	twiki		 2242 Feb 24 21:33 edit.tmpl
-rw-r--r--	1 twiki	twiki		  965 Feb  8 16:07 mailnotify.tmpl
-rw-r--r--	1 twiki	twiki			30 Jan 14  1999 notedited.tmpl
-rw-r--r--	1 twiki	twiki		  934 Feb  8 16:07 notext.tmpl
-rw-r--r--	1 twiki	twiki		  899 Feb  8 16:07 notwiki.tmpl
-rw-r--r--	1 twiki	twiki		  299 Feb 24 21:58 noweb.tmpl
-rw-r--r--	1 twiki	twiki		  957 Feb 24 22:17 oops.tmpl
-rw-r--r--	1 twiki	twiki		  871 Feb 24 22:17 oopsdel.tmpl
-rw-r--r--	1 twiki	twiki		 1330 Feb 24 22:17 oopslocked.tmpl
-rw-r--r--	1 twiki	twiki		 1024 Feb 24 22:17 oopsregexist.tmpl
-rw-r--r--	1 twiki	twiki		  912 Feb 24 22:17 oopsregpasswd.tmpl
-rw-r--r--	1 twiki	twiki		  923 Feb 24 22:17 oopsregrequ.tmpl
-rw-r--r--	1 twiki	twiki		 1125 Feb 24 22:17 oopsregthanks.tmpl
-rw-r--r--	1 twiki	twiki		  942 Feb 24 22:17 oopsregwiki.tmpl
-rw-r--r--	1 twiki	twiki		 1564 Feb 24 22:17 oopsrev.tmpl
-rw-r--r--	1 twiki	twiki		  906 Feb 24 22:17 oopsupload.tmpl
-rw-r--r--	1 twiki	twiki		 1535 Feb 24 22:02 preview.tmpl
-rw-r--r--	1 twiki	twiki		 1661 Feb 24 22:04 rdiff.tmpl
-rw-r--r--	1 twiki	twiki		  263 Aug  3  1999 register.tmpl
-rw-r--r--	1 twiki	twiki		  936 Feb  8 16:08 registernotify.tmpl
-rw-r--r--	1 twiki	twiki		 1779 Feb 24 22:06 search.tmpl
-rw-r--r--	1 twiki	twiki		 1533 Feb 24 21:43 view.tmpl
</pre>

directory =twiki/templates/Main= :

<pre>
drwxr-xr-x	2 twiki	twiki		 1024 Dec  9  1998 .
drwxr-xr-x	7 twiki	twiki		 1024 Jan 16 19:39 ..
-rw-r--r--	1 twiki	twiki		 2732 Feb 24 21:34 edit.tmpl
</pre>

directory =twiki/templates/Know= (has a TWiki Category Table) :

<pre>
drwxr-xr-x	2 twiki	twiki		 1024 Jun  8  1999 .
drwxr-xr-x	7 twiki	twiki		 1024 Jan 16 19:39 ..
-rw-rw-r--	1 twiki	twiki		  446 Jun  8  1999 notedited.tmpl
-rw-rw-r--	1 twiki	twiki		  206 Jun  8  1999 twikicatedit.tmpl
-rw-rw-r--	1 twiki	twiki		 1060 Jul 16  1999 twikicatitems.tmpl
-rw-rw-r--	1 twiki	twiki		  231 Jun  8  1999 twikicatview.tmpl
</pre>

directory =twiki/data/= :

<pre>
drwxrwxrwx	8 twiki	twiki		 1024 Feb 26 04:17 .
drwxr-xr-x	8 twiki	twiki		 1024 Feb 26 04:20 ..
-rw-r--r--	1 nobody  nobody		2241 Feb 25 20:18 .htpasswd
drwxrwxrwx	2 twiki	twiki		 3072 Feb 27 01:15 Know
drwxrwxrwx	2 twiki	twiki		 9216 Feb 27 18:16 Main
-rw-rw-rw-	1 twiki	twiki			 1 Feb 26 06:01 debug.txt
-rw-r--r--	1 nobody  nobody	1263064 Jan 31 23:13 log200001.txt
-rw-r--r--	1 nobody  nobody	1063398 Feb 27 18:33 log200002.txt
</pre>

part of directory =twiki/data/Main= :

<pre>
drwxrwxrwx	2 twiki	twiki		 9216 Feb 27 18:16 .
drwxrwxrwx	8 twiki	twiki		 1024 Feb 26 04:17 ..
-rw-rw-rw-	1 twiki	twiki		 5722 Feb 27 18:13 .changes
-rw-rw-rw-	1 twiki	twiki			 9 Feb 27 18:15 .mailnotify
-rw-r--r--	1 nobody  nobody	  26163 Feb 24 12:22 TWikiDocumentation.txt
-r--r--r--	1 nobody  nobody	  44133 Feb 24 12:22 TWikiDocumentation.txt,v
-rw-r--r--	1 nobody  nobody	  11661 Feb 27 18:13 TWikiHistory.txt
-r--r--r--	1 nobody  nobody	  18877 Feb 27 18:13 TWikiHistory.txt,v
-rw-r--r--	1 nobody  nobody		3029 Feb 26 04:46 TWikiPreferences.txt
-r--r--r--	1 nobody  nobody		3219 Feb 26 04:46 TWikiPreferences.txt,v
-rw-r--r--	1 nobody  nobody		7188 Feb 11 21:39 TWikiRegistration.txt
-r--r--r--	1 nobody  nobody		7375 Feb 11 21:39 TWikiRegistration.txt,v
-rw-r--r--	1 nobody  nobody		3180 Feb 25 20:19 TWikiUsers.txt
-r--r--r--	1 nobody  nobody	  16537 Feb 25 20:19 TWikiUsers.txt,v
-rw-r--r--	1 nobody  nobody		2613 Feb  7 04:47 TWikiVariables.txt
-r--r--r--	1 nobody  nobody		3125 Feb  7 04:47 TWikiVariables.txt,v
-rw-r--r--	1 nobody  nobody		2068 Feb 10 11:34 TWikiWeb.txt
-r--r--r--	1 nobody  nobody		3610 Feb 10 11:34 TWikiWeb.txt,v
-rw-r--r--	1 nobody  nobody		1677 Feb 26 05:11 TWikiWebsTable.txt
-r--r--r--	1 nobody  nobody		1866 Feb 26 05:11 TWikiWebsTable.txt,v
-rw-r--r--	1 nobody  nobody		2294 Feb 27 17:54 WebHome.txt
-r--r--r--	1 nobody  nobody		5282 Feb 27 17:54 WebHome.txt,v
-rw-r--r--	1 nobody  nobody		 586 Jan 17 01:05 WebNotify.txt
-r--r--r--	1 nobody  nobody		1629 Jan 17 01:05 WebNotify.txt,v
-rw-r--r--	1 nobody  nobody		1834 Feb 25 14:13 WebPreferences.txt
-r--r--r--	1 nobody  nobody		2023 Feb 25 14:13 WebPreferences.txt,v
-rw-r--r--	1 nobody  nobody		4407 Feb 11 21:08 WebSearch.txt
-r--r--r--	1 nobody  nobody	  10822 Feb 11 21:08 WebSearch.txt,v
-rw-r--r--	1 nobody  nobody		4416 Feb 27 00:00 WebStatistics.txt
-r--r--r--	1 nobody  nobody	  27759 Feb 27 00:00 WebStatistics.txt,v
</pre>

directory =twiki/pub/= :

<pre>
drwxrwxrwx  11 twiki	twiki		 1024 Feb  8 18:10 .
drwxr-xr-x	8 twiki	twiki		 1024 Feb 26 04:20 ..
drwxrwxrwx	4 nobody  nobody		1024 Aug 28  1999 Know
drwxrwxrwx  19 nobody  nobody		1024 Feb 27 09:56 Main
-rw-r--r--	1 twiki	twiki		 1078 Jan 14 20:24 favicon.ico
drwxr-xr-x	2 twiki	twiki		 1024 Mar 27  1999 icn
-rw-r--r--	1 twiki	twiki		 3016 Sep 10 04:27 twikilogo.gif
-rw-r--r--	1 twiki	twiki		 5320 Sep 10 04:27 twikilogo1.gif
-rw-r--r--	1 twiki	twiki		 6125 Sep 10 04:27 twikilogo2.gif
-rw-r--r--	1 twiki	twiki		 7218 Sep 10 04:27 twikilogo3.gif
-rw-r--r--	1 twiki	twiki		 6710 Sep 11 02:21 twikilogo4.gif
-rw-r--r--	1 twiki	twiki		 2877 Jun 15  1999 wikiHome.gif
</pre>

directory =twiki/pub/icn/= :

<pre>
drwxr-xr-x	2 twiki	twiki		 1024 Mar 27  1999 .
drwxrwxrwx  11 twiki	twiki		 1024 Feb  8 18:10 ..
-rw-r--r--	1 twiki	twiki		  801 Mar 27  1999 _filetypes.txt
-rw-r--r--	1 twiki	twiki		  143 Mar 27  1999 bat.gif
-rw-r--r--	1 twiki	twiki		  926 Mar 27  1999 bmp.gif
-rw-r--r--	1 twiki	twiki		  141 Mar 27  1999 c.gif
-rw-r--r--	1 twiki	twiki		  144 Mar 27  1999 dll.gif
-rw-r--r--	1 twiki	twiki		  152 Mar 27  1999 doc.gif
-rw-r--r--	1 twiki	twiki		  130 Mar 27  1999 else.gif
-rw-r--r--	1 twiki	twiki		  876 Mar 27  1999 exe.gif
-rw-r--r--	1 twiki	twiki		  147 Mar 27  1999 fon.gif
-rw-r--r--	1 twiki	twiki		  142 Mar 27  1999 h.gif
-rw-r--r--	1 twiki	twiki		  156 Mar 27  1999 hlp.gif
-rw-r--r--	1 twiki	twiki		  186 Mar 27  1999 html.gif
-rw-r--r--	1 twiki	twiki		  144 Mar 27  1999 java.gif
-rw-r--r--	1 twiki	twiki		  148 Mar 27  1999 mov.gif
-rw-r--r--	1 twiki	twiki		  150 Mar 27  1999 pdf.gif
-rw-r--r--	1 twiki	twiki		  146 Mar 27  1999 pl.gif
-rw-r--r--	1 twiki	twiki		  150 Mar 27  1999 ppt.gif
-rw-r--r--	1 twiki	twiki		  148 Mar 27  1999 ps.gif
-rw-r--r--	1 twiki	twiki		  148 Mar 27  1999 py.gif
-rw-r--r--	1 twiki	twiki		  130 Mar 27  1999 ram.gif
-rw-r--r--	1 twiki	twiki		  154 Mar 27  1999 reg.gif
-rw-r--r--	1 twiki	twiki		  147 Mar 27  1999 sh.gif
-rw-r--r--	1 twiki	twiki		  155 Mar 27  1999 sniff.gif
-rw-r--r--	1 twiki	twiki		  149 Mar 27  1999 ttf.gif
-rw-r--r--	1 twiki	twiki		  134 Mar 27  1999 txt.gif
-rw-r--r--	1 twiki	twiki		  154 Mar 27  1999 wav.gif
-rw-r--r--	1 twiki	twiki		  152 Mar 27  1999 wri.gif
-rw-r--r--	1 twiki	twiki		  152 Mar 27  1999 xls.gif
-rw-r--r--	1 twiki	twiki		  144 Mar 27  1999 zip.gif
</pre>

-- Main.PeterThoeny - 27 Jul 2000 <br>
@


1.5
log
@none
@
text
@d7 5
a11 5
	* The =twiki/bin= directory of TWiki must be set as a cgi-bin directory. Add =/home/httpd/twiki/bin= to file =/etc/httpd/conf/http.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 =http.conf= with normal access options (copy from =/home/httpd/html= ).
	* Now add =ScriptAlias= for =/twiki/bin= and =Alias= for =/twiki= to file =http.conf= .
	  <br> __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.
	* Here are example =http.conf= entries:
d260 1
a260 1
-- Main.PeterThoeny - 17 Jul 2000 <br>
@


1.4
log
@none
@
text
@d7 17
a23 3
	* 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.
	* 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).
	* 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/= <br> __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.
d260 1
a260 1
-- Main.PeterThoeny - 24 May 2000 <br>
@


1.3
log
@none
@
text
@d9 1
a9 1
	* 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/=
@


1.2
log
@none
@
text
@d9 1
a9 1
	* Now add =Alias= for =/twiki= and =ScriptAlias= for =/twiki/bin= to =/etc/httpd/conf/srm-conf= .
d246 1
a246 1
-- Main.PeterThoeny - 21 Apr 2000 <br>
@


1.1
log
@none
@
text
@d8 2
a9 2
	* The =twiki/pub= directory of TWiki must be set so that it is visible as a URL. Add =/home/httpd/twiki/pub= to =/etc/httpd/conf/access.conf= with normal access options (copy from /home/httpd/html).
	* Now add =Alias= for =/twiki/pub= and =ScriptAlias= for =/twiki/bin= to =/etc/httpd/conf/srm-conf= .
@
