| |
TWiki Installation Guide |
| |
Overview |
|
<
< | 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 .) |
>
> | 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.) |
| |
- NOTE: This Installation Guide assumes the following:
|
|
<
< |
-
- 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.
|
>
> |
-
- 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.
|
| |
-
- 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:
|
|
<
< |
twiki/bin |
CGI bin |
cgi-bin enabled dir |
/home/smith/public_html/cgi-bin/twiki |
|
>
> |
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 http://TWiki.org/cgi-bin/view/Codev/SourceForgeHowTo in case you want to install TWiki on SourceForge. |
>
> | Read TWiki:Codev/SourceForgeHowTo in case you want to install TWiki on SourceForge. |
| |
Standard Installation |
| |
- 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 and tests the settings in your twiki/bin/wikicfg.pm configuration file.
|
>
> |
-
- 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. 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 necssary.
- 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 (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).
|
>
> |
- 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.
|
| |
Step 4: Set the Main Configuration File |
|
<
< |
- Edit the file
twiki/bin/wikicfg.pm and set the variables at the beginning of the file to your needs.
|
>
> |
- 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.
|
|
<
< |
-
- 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:
for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
- Security issue: Directories
twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the 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, Notification of Changes has more.
- Add the TWiki:Main.PoweredByTWikiLogo to your Main topic.
|
>
> |
-
- Make sure RCS is installed. Set
$rcsDir in twiki/lib/TWiki.cfg to mach the location of your RCS binaries.
- Note in case the CGI scripts are not running as user
nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (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:
for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
- Security issue: Directories
twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directries to a place where they are not visible, and change the variables in twiki/lib/TWiki.cfg accordingly)
- Enable email notification of topic changes, MonitoringSiteActivity has more.
- Add the TWiki:Main/PoweredByTWikiLogo to your Main topic.
|
| |
Step 5: Finish Up from Your Browser
- Point your Web browser at
http://your.domain.com/twiki/bin/view and start TWiki-ing away!
- Edit the TWikiPreferences topic in the TWiki:TWiki web to set the WIKIWEBMASTER email address, the WEBCOPYRIGHT message and other preferences.
|
|
<
< |
- If you use
.htaccess, edit the file and add the file extension to edit, view, preview, etc.
|
| |
- Edit the WebNotify topic in all webs and set the users you want to notify.
That's it for the standard virgin installation of TWiki. Read on to learn how to customize TWiki. |
| |
- 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 Form Templates to add form-based page input that's stored separately from the main free-form topic text.
|
>
> |
-
- 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 TWiki.Main web - don't try to move them or create them in other webs. From any web you can refer to users located in the TWiki.Main web with
Main.UserName or %MAINWEB%.UserName - using the %MAINWEB% variable is preferable, particularly if you might change the Main web name.
Adding Variables & Rendering Rules |
|
<
< |
- You can add new rendering rules or new
%VARIABLES%. To insure an easy upgrade of TWiki, it is recommended to do this sort of customization with TWiki Plugins and the Plugins API.
|
>
> |
- You can add new
%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.
|
| |
Enabling Basic Authentication (.htaccess) |
| | Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
AuthUserFile /filepath/to/TWiki/data/.htpasswd
ErrorDocument 401 /urlpath/to/TWiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth |
|
>
> |
-
-
- NOTE: In case you renamed the CGI script files to have a file extension you need to reflect that in the
edit, view, preview, etc entries in .htaccess.
|
| |
-
-
- NOTE: The browser should ask for login name and password when you click on the Edit link. In case
.htaccess does not have the desired effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
- Copy the TWikiRegistrationPub topic to TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the
.txt and .txt,v files in the twiki/data/TWiki directory.
- 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.
|
| | See A: TWiki File System for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
-- MikeMannix - 07 Sep 2001
|
|
>
> | -- PeterThoeny - 13 Sep 2001
|
| |
| META TOPICMOVED |
by="MikeMannix" date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide" |
|
Copyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.