|
|
|
TWiki Installation Guide
|
|
- 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/.
|
> > |
-
- 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.
|
|
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.
|
< < |
NOTE: User home topics are located in the AVO TWiki.Main web - don't try to move them or create them in other webs. From any other web, user signatures have to point to AVO TWiki.Main web, using a Main.UserName or %MAINWEB%.UserName format. (The %MAINWEB% variable is an advantage if you ever change the Main web name, but the standard Main.UserName is easier for users to enter, which is the bottom line!
|
> > |
NOTE: User home topics are located in the AVO TWiki.Main web - don't try to move them or create them in other webs. From any other web, user signatures have to point to AVO TWiki.Main web, using a Main.UserName or %MAINWEB%.UserName format. (The %MAINWEB% variable is an advantage if you ever change the Main web name, but the standard Main.UserName is easier for users to enter, which is the bottom line!)
|
|
TWiki File System Info
|
|
TWiki Installation Guide
|
|
|
< < |
Step 1 for Non-Root Accounts
|
> > |
Aletrnative Step 1: Create & 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:
|
|
-
- 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.
-
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 relock all the rcs files
|
> > |
-
-
- Run the
testenv script from your browser; in the %BROWN% Fix %ENDCOLOR% line you can relock all the rcs files (recommended)
|
|
-
-
- Alternatively, run this in your shell:
cd twiki/data
|
< < |
find . -name *.v~ -exec perl -pi~ -e '$. <= 10 && s/nobody:/www-data:/ ' {} ;
|
> > |
find . -name *,v -exec perl -pi~ -e '$. <= 10 && s/nobody:/www-data:/ ' {} \;
This will create *,v~ backup files which you should remove after verification:
find . -name *,v~ -exec rm -f {} \;
|
|
Step 3: Edit the Configuration Files
|
|
Enabling Authentication of Users
- If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users:
|
< < |
-
- Rename file
.htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details, consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
Redirect /urlpathto/twiki/index.html http://yourdomain.com/urlpathto/twiki/bin/view
AuthUserFile /filepathto/twiki/data/.htpasswd
ErrorDocument 401 /urlpathto/twiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
|
> > |
-
- 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: [1], [2]).
|
|
-
-
-
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.
-
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 [3] 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.
|
|
See Appendix A: TWiki File System for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2004 distribution.
|
< < |
-- TWiki:Main/PeterThoeny - 15 Aug 2004
|
> > |
-- TWiki:Main/PeterThoeny - 29 Aug 2004
|
|
-- TWiki:Main/MikeMannix - 16 May 2002
|
|
TWiki Installation Guide
|
|
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 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 under development.
|
> > |
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:
- 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.
- 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.
- In
TWiki.cfg, set the $siteLocale parameter to your chosen locale, e.g. pl_PL.ISO-8859-2 for Poland.
- 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.
|
< < |
- 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.
|
> > |
- (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.
|
|
- 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 ActiveState Perl), since Perl locales are not working on Windows as of Feb 2004.
|
> > |
- NOTE: You will need to do the above workaround for Windows based servers (whether using Cygwin or 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.
|
|
TWiki Installation Guide
|
< < |
Installation instructions for the TWiki 01-Feb-2003 production release.
|
> > |
Installation instructions for the TWiki 01-Sep-2004 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.
|
|
|
< < |
|
> > |
|
|
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.
|
> > |
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 & Configure the Directories
|
|
</Directory>
|
< < |
- Restart Apache by
/etc/rc.d/rc5.d/S85httpd restart .
|
> > |
- 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".
|
|
twiki/templates | web templates | dir secure from public access | /home/smith/twiki/templates |
|
< < |
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:
# -------------- Change these settings if required
$twikiLibPath = '/some/other/path/lib'; # Path to lib directory containing TWiki.pm
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.
|
> > |
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)
|
|
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.
|
> > |
-
- 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.
-
This Guide assumes user nobody ownership for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. You can:
- replace
nobody with another user if your server executes scripts under a different name (ex: default for Debian is www-data).
-
HINT: Run the testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. It will show you the user name of the CGI scripts, a table listing all CGI environment variables, and a test of your twiki/lib/TWiki.cfg configuration file (you'll configure that in a minute).
- replace user
twiki with your own username
|
< < |
- 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 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.
|
< < |
-
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!):
cd twiki/data
perl -pi~ -e 'NR <= 10 && s/nobody:/www-data:/ ' */*,v
|
> > |
-
-
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 relock all the rcs files
- Alternatively, run this in your shell:
cd twiki/data
find . -name *.v~ -exec perl -pi~ -e '$. <= 10 && s/nobody:/www-data:/ ' {} ;
|
|
|
< < |
Step 3: Set the Main Configuration File
|
|
|
> > |
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.
-
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.
-
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.
|
|
- 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
|
> > |
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 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 under development.
To configure internationalisation suppport:
- 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.
- 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.
- In
TWiki.cfg, set the $siteLocale parameter to your chosen locale, e.g. pl_PL.ISO-8859-2 for Poland.
- 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.
- 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.
- 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.
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 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 TWiki web (by pointing your browser to http://yourdomain.com/twiki/bin/view/TWiki/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
|
|
|
< < |
Step 5: Finish Up from Your Browser
|
> > |
Step 6: Finish Up from Your Browser
|
|
- Point your Web browser at
http://yourdomain.com/twiki/bin/view and start TWiki-ing away!
-
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.
|
< < |
|
> > |
|
|
|
< < |
That's it for the standard virgin installation of TWiki. Read on for server-level customization options.
|
> > |
That's it for the standard installation of TWiki. Read on for server-level customization options.
|
|
Additional Server-Level Options
|
|
-
-
-
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 [3] 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.
-
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.
|
> > |
-
- 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
|
|
-
- Copy the TWikiRegistrationPub topic to TWikiRegistration, overwriting old version of TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the
.txt and .txt,v files in the twiki/data/TWiki directory.
- 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.
|
< < |
|
> > |
|
|
- Register yourself in the TWikiRegistration topic.
-
NOTE: When a user registers, a new line with the username and encrypted password is added to the data/.htpasswd file. The .htpasswd file that comes with the TWiki installation includes user accounts for TWiki core team members that are used for testing on TWiki.org. You can edit the file and delete those lines.
- Create a new topic to check if authentication works.
|
|
|
< < |
That's it for a basic new web set-up!
|
> > |
WYSIWYG Editor
|
|
|
< < |
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.
|
> > |
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.
|
|
NOTE: User home topics are located in the AVO TWiki.Main web - don't try to move them or create them in other webs. From any other web, user signatures have to point to AVO TWiki.Main web, using a Main.UserName or %MAINWEB%.UserName format. (The %MAINWEB% variable is an advantage if you ever change the Main web name, but the standard Main.UserName is easier for users to enter, which is the bottom line!
TWiki File System Info
|
< < |
See Appendix A: TWiki File System for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
|
> > |
See Appendix A: TWiki File System for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2004 distribution.
|
|
|
< < |
-- PeterThoeny - 03 Jun 2003
-- MikeMannix - 16 May 2002
|
> > |
-- TWiki:Main/PeterThoeny - 15 Aug 2004
-- TWiki:Main/MikeMannix - 16 May 2002
|
|
|
> > |
|
|
| META TOPICMOVED | MikeMannix | date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide" |
|
|
TWiki Installation Guide
|
< < |
Installation instructions for the TWiki 01-Feb-2003 production release. Update notes for the new RCS configuration are marked Dataframework.
|
> > |
Installation instructions for the TWiki 01-Feb-2003 production release.
|
|
|
< < |
These installation steps are based on the Apache web server on Linux. TWiki runs on other web servers and Unix systems, and should be fine with any web server and OS that meet the system requirements. Documentation for other platforms is somewhat limited:
|
> > |
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 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.
|
|
|
< < |
|
> > |
|
|
Standard Installation
|
|
NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account, or you don't have administrator privileges on your intranet server - use the alternative Step 1 instead.
- Create directory
/home/httpd/twiki and unzip the TWiki distribution into this directory.
|
< < |
- The
twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.
|
> > |
- 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 .
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.
|
|
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, 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.
|
> > |
-
- 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.
-
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:
|
|
TWiki Installation Guide
|
|
- 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.
|
< < |
|
> > |
|
|
That's it for the standard virgin installation of TWiki. Read on for server-level customization options.
|
|
TWiki Installation Guide
|
|
|
> > |
|
|
Standard Installation
|
|
- 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.
|
< < |
-
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:
|
> > |
-
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!):
|
|
cd twiki/data
|
< < |
perl -pi~ -e 's/nobody(\:[0-9\.]+[\;\s]+strict\;)/www-data$1/' /,v
|
> > |
perl -pi~ -e 'NR <= 10 && s/nobody:/www-data:/ ' /,v
|
|
|
|
Step 4: Configure Site-Wide Email Preferences
|
< < |
|
> > |
- Edit the TWikiPreferences topic in the TWiki web (by pointing your browser to http://yourdomain.com/twiki/bin/view/TWiki/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.
|
> > |
|
|
Step 5: Finish Up from Your Browser
|
|
See Appendix A: TWiki File System for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
|
< < |
-- PeterThoeny - 28 Dec 2002
|
> > |
-- PeterThoeny - 03 Jun 2003
|
|
-- MikeMannix - 16 May 2002
| META TOPICMOVED | MikeMannix | date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide" |
|
|
TWiki Installation Guide
|
|
cd twiki/data
|
< < |
perl -pi~ -e 's/nobody:/www-data:/' /,v
|
> > |
perl -pi~ -e 's/nobody(\:[0-9\.]+[\;\s]+strict\;)/www-data$1/' /,v
|
|
|
|
TWiki Installation Guide
|
|
Enabling Authentication of Users
- If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users:
|
< < |
-
- Rename file
.htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details, consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
|
> > |
-
- Rename file
.htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details, consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
|
|
Redirect /urlpathto/twiki/index.html http://yourdomain.com/urlpathto/twiki/bin/view
AuthUserFile /filepathto/twiki/data/.htpasswd
ErrorDocument 401 /urlpathto/twiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
|
|
TWiki Installation Guide
|
< < |
Installation instructions for the TWiki 01-Dec-2001 production release. Update notes for the new RCS configuration are marked Dataframework.
|
> > |
Installation instructions for the TWiki 01-Feb-2003 production release. Update notes for the new RCS configuration are marked Dataframework.
|
|
These installation steps are based on the Apache web server on Linux. TWiki runs on other web servers and Unix systems, and should be fine with any web server and OS that meet the system requirements. Documentation for other platforms is somewhat limited:
|
|
Standard Installation
|
< < |
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.
|
> > |
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 & Configure the Directories
|
|
TWiki Installation Guide
|
|
|
< < |
Adding a New Web
To create a new web:
- 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.)
- Copy all files from the
twiki/data/_default directory to the new data directory, preserving the original files' owner, group and permissions (on Unix, use cp -p). The data files must be writable by the owner the CGI scripts are running on (usually, nobody).
-
HINT: You can set permissions of .txt and .txt,v files to -rw-rw-rw- (666) and then edit the topic using your browser; RCS will restore the file permissions correctly when saving the topic.
- Add the new web to the web list (visible in the upper right corner of each topic) by editing the site-level preferences, TWikiPreferences:
- Add the new web to the
%WIKIWEBLIST% variable.
- Update the web settings by editing the WebPreferences topic of the new web:
- Customize the
%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:
%WEBCOPYRIGHT% can be set for an individual web).
- Test the new web: view pages, create a new page.
|
|
That's it for a basic new web set-up!
Optionally, you can also:
|
|
TWiki Installation Guide
Installation instructions for the TWiki 01-Dec-2001 production release. Update notes for the new RCS configuration are marked Dataframework.
|
< < |
These installation steps are based on the Apache web server on Linux. TWiki runs on other web servers and Unix systems, and should be fine with any web server and OS that meet the system requirements. Documentation for other platforms is somewhat limited:
|
> > |
These installation steps are based on the Apache web server on Linux. TWiki runs on other web servers and Unix systems, and should be fine with any web server and OS that meet the system requirements. Documentation for other platforms is somewhat limited:
|
|
|
|
TWiki Installation Guide
Installation instructions for the TWiki 01-Dec-2001 production release. Update notes for the new RCS configuration are marked Dataframework.
|
< < |
These installation steps are based on the Apache Web server on Linux. TWiki runs on other Web servers and Unix systems, and should be fine with any OS and server that meet the system requirements. Documentation for other platforms is currently limited. For Windows, check TWiki:Codev/TWikiOnWindows. Search the TWiki:Codev web for other intallation notes.
|
> > |
These installation steps are based on the Apache web server on Linux. TWiki runs on other web servers and Unix systems, and should be fine with any web server and OS that meet the system requirements. Documentation for other platforms is somewhat limited:
|
|
Standard Installation
|
|
Step 1: Create & Configure the Directories
|
< < |
NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the alternative Step 1 instead.
|
> > |
NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account, or you don't have administrator privileges on your intranet server - use the alternative Step 1 instead.
|
|
- Create directory
/home/httpd/twiki and unzip the TWiki distribution into this directory.
- The
twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.
|
|
Step 1 for Non-Root Accounts
|
< < |
To install TWiki on a system where you don't have server administrator privileges, for example, on a hosted Web account:
|
> > |
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
|
|
twiki/templates | web templates | dir secure from public access | /home/smith/twiki/templates |
|
> > |
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:
# -------------- Change these settings if required
$twikiLibPath = '/some/other/path/lib'; # Path to lib directory containing TWiki.pm
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.
|
|
Step 2: Set File Permissions
|
|
cd twiki/data
|
< < |
perl -pi -e 's/nobody:/www-data:/' /,v
|
> > |
perl -pi~ -e 's/nobody:/www-data:/' /,v
|
|
|
|
- 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 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)
|
> > |
-
- 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
$storeTopicImpl = "RcsWrap"; for the RCS executables and make sure RCS is installed. Set $rcsDir in twiki/lib/TWiki.cfg to match the location of your RCS binaries. You can check this by issuing the command rcs at the prompt, it should result in something like "rcs: no input file".
- 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
$storeTopicImpl = "RcsLite"; for the Perl based RCS
|
< < |
-
-
- Set
$storeTopicImpl = "RcsWrap"; 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)
|
> > |
- 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: Finish Up from Your Browser
|
> > |
Step 4: Configure Site-Wide Email Preferences
- From your web browser, edit the TWikiPreferences topic in the TWiki:TWiki web to set the
WIKIWEBMASTER email address, and other email settings required for registration and WebChangesAlert to work:
-
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.
Step 5: Finish Up from Your Browser
|
|
- Point your Web browser at
http://yourdomain.com/twiki/bin/view and start TWiki-ing away!
-
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.
|
|
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.
|
> > |
|
|
Enabling Authentication of Users
- If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users:
|
|
-
-
-
- This applies only if you have root access: on hosted accounts, you shouldn't have this problem - otherwise, email tech support.
-
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.
- Copy the TWikiRegistrationPub topic to TWikiRegistration, overwriting old version of TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the
.txt and .txt,v files in the twiki/data/TWiki directory.
|
< < |
-
-
-
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.
|
> > |
- 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.
-
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.
|
|
TWiki File System Info
|
< < |
See Appendix A: TWiki File System for an installed system snapshot and descriptions of all files in the TWiki 01-Dec-2001 distribution.
|
> > |
See Appendix A: TWiki File System for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
|
|
|
< < |
-- PeterThoeny - 13 Sep 2001
|
> > |
-- PeterThoeny - 28 Dec 2002
|
|
-- MikeMannix - 16 May 2002
| META TOPICMOVED | MikeMannix | date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide" |
|
|
TWiki Installation Guide
|
|
NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the alternative Step 1 instead.
|
< < |
- Create directory
/home/httpd/twiki and unzip the TWiki distribution into this directory.
|
> > |
- Create directory
/home/httpd/twiki and unzip the TWiki distribution into this directory.
|
|
- The
twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.
- The
twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki to file httpd.conf with normal access options (copy from /home/httpd/html ).
- Now add
ScriptAlias for /twiki/bin and Alias for /twiki to file httpd.conf .
|
|
TWiki Installation Guide
|
|
- 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.
|
< < |
-
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:
|
> > |
-
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:
|
|
cd twiki/data
|
< < |
for f in /,v; do sed 's/nobody\:/www-data\:/' $f > x; mv -f x $f; done
|
> > |
perl -pi -e 's/nobody:/www-data:/' /,v
|
|
|
< < |
Note that this is not required if you use the Perl based RCS implementation - see Dataframework.
|
|
Step 3: Set the Main Configuration File
|
|
TWiki Installation Guide
|
|
-
-
-
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 [3] 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.
-
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.
|
< < |
-
- 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.
|
> > |
-
- Copy the TWikiRegistrationPub topic to TWikiRegistration, overwriting old version of TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the
.txt and .txt,v files in the twiki/data/TWiki directory.
|
|
-
-
-
HINT: You can customize the registration form by deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This ensures that the fields are processed correctly.
- Register yourself in the TWikiRegistration topic.
-
NOTE: When a user registers, a new line with the username and encrypted password is added to the data/.htpasswd file. The .htpasswd file that comes with the TWiki installation includes user accounts for TWiki core team members that are used for testing on TWiki.org. You can edit the file and delete those lines.
|
|
TWiki Installation Guide
|
< < |
Installation instructions for the TWiki 01-Sep-2001 production release
|
> > |
Installation instructions for the TWiki 01-Dec-2001 production release. Update notes for the new RCS configuration are marked Dataframework.
|
|
These installation steps are based on the Apache Web server on Linux. TWiki runs on other Web servers and Unix systems, and should be fine with any OS and server that meet the system requirements. Documentation for other platforms is currently limited. For Windows, check TWiki:Codev/TWikiOnWindows. Search the TWiki:Codev web for other intallation notes.
Standard Installation
|
< < |
Request and download the TWiki 01-Sep-2001 distribution in Unix ZIP format from http://TWiki.org/download.html. (To install TWiki on SourceForge, for use on a software development project, read TWiki:Codev/SourceForgeHowTo .)
|
> > |
Request and download the TWiki 01-Dec-2001 distribution in Unix ZIP format from http://TWiki.org/download.html. (To install TWiki on SourceForge, for use on a software development project, read TWiki:Codev/SourceForgeHowTo .)
|
|
Step 1: Create & Configure the Directories
|
|
for f in /,v; do sed 's/nobody\:/www-data\:/' $f > x; mv -f x $f; done
|
> > |
Note that this is not required if you use the Perl based RCS implementation - see Dataframework.
|
|
Step 3: Set the Main Configuration File
- Edit the file
twiki/lib/TWiki.cfg, setting the variables to your needs.
- Set the file extension in the
$scriptSuffix variable to cgi or pl if required.
|
< < |
-
- Make sure RCS is installed. Set
$rcsDir in twiki/lib/TWiki.cfg to mach the location of your RCS binaries. You can check this by issuing the comand rcs at the prompt, it should result in something like "rcs: no input file".
|
> > |
-
- 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
$storeTopicImpl = "RcsLite"; for the Perl based RCS
- Set
$storeTopicImpl = "RcsWrap"; 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)
- 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.
|
|
-
-
-
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.
-
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 [3] 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.
|
< < |
-
-
-
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.
|
> > |
-
-
-
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.
|
|
-
- Copy the TWikiRegistrationPub topic to TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the
.txt and .txt,v files in the twiki/data/TWiki directory.
-
HINT: You can customize the registration form by deleting or adding input tags. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This ensures that the fields are processed correctly.
|
|
TWiki File System Info
|
< < |
See Appendix A: TWiki File System for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
|
> > |
See Appendix A: TWiki File System for an installed system snapshot and descriptions of all files in the TWiki 01-Dec-2001 distribution.
|
|
-- PeterThoeny - 13 Sep 2001
|
< < |
-- MikeMannix - 27 Jan 2002
|
> > |
-- MikeMannix - 16 May 2002
|
|
| META TOPICMOVED | MikeMannix | date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide" |
|
|
TWiki Installation Guide
|
|
-
- Customize the
%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:
%WEBCOPYRIGHT% can be set for an individual web).
|
< < |
- Add the new web to the color-coded web directory table by editing the TWikiWebsTable topic.
|
|
- Test the new web: view pages, create a new page.
That's it for a basic new web set-up!
|
|
TWiki Installation Guide
Installation instructions for the TWiki 01-Sep-2001 production release
|
< < |
Overview
|
|
These installation steps are based on the Apache Web server on Linux. TWiki runs on other Web servers and Unix systems, and should be fine with any OS and server that meet the system requirements. Documentation for other platforms is currently limited. For Windows, check TWiki:Codev/TWikiOnWindows. Search the TWiki:Codev web for other intallation notes.
|
|
Step 1: Create & Configure the Directories
|
< < |
NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the alternative Step 1 instead.
|
> > |
NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the alternative Step 1 instead.
|
|
- Create directory
/home/httpd/twiki and unzip the TWiki distribution into this directory.
- The
twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.
- 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 .
|
< < |
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.
|
> > |
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.
|
|
Example httpd.conf entries:
|
|
<Directory "/home/httpd/twiki/bin">
Options +ExecCGI
SetHandler cgi-script
|
< < |
AllowOverride? all
|
|
Allow from all
</Directory>
<Directory "/home/httpd/twiki/pub">
Options FollowSymLinks +Includes
AllowOverride None
Allow from all
|
> > |
</Directory>
<Directory "/home/httpd/twiki/data">
deny from all
</Directory>
<Directory "/home/httpd/twiki/templates">
deny from all
|
|
</Directory>
|
|
- Upload the TWiki files by FTP (transfer as text except for the image files in
pub)
|
< < |
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 |
|
> > |
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 |
|
|
|
|
-
- 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.
- 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.
|
< < |
- 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:
|
> > |
-
This Guide assumes user nobody ownership for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. You can:
|
|
-
- replace
nobody with another user if your server executes scripts under a different name (ex: default for Debian is www-data).
|
< < |
-
-
- HINT: Run the
testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. It will show you the user name of the CGI scripts, a table listing all CGI environment variables, and a test of your twiki/lib/TWiki.cfg configuration file (you'll configure that in a minute).
|
> > |
-
-
-
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.
|
< < |
- NOTE: The
twiki/data/*/*.txt,v RCS repository files in the installation package are locked by user nobody. If your CGI scripts are not running as user nobody, it's not possible to check in files (you'll see that the revision number won't increase after saving a topic). In this case, you need to unlock all repository files (check the RCS man pages) and lock them with a different user, ex www-data, or delete them all - new files will be automatically created the first time each topic is edited. A simple way to change ownership is with a search-and-replace in all files; for example, using sed: for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
|
> > |
-
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:
cd twiki/data
for f in */*,v; do sed 's/nobody\:/www-data\:/' $f > x; mv -f x $f; done
|
|
Step 3: Set the Main Configuration File
- Edit the file
twiki/lib/TWiki.cfg, setting the variables to your needs.
- Set the file extension in the
$scriptSuffix variable to cgi or pl if required.
|
< < |
-
- Make sure RCS is installed. Set
$rcsDir in twiki/lib/TWiki.cfg to mach the location of your RCS binaries.
|
> > |
-
- 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)
- Test your settings by running the
testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. Check if your twiki/lib/TWiki.cfg configuration file settings are correct.
Step 4: Finish Up from Your Browser
- Point your Web browser at
http://yourdomain.com/twiki/bin/view and start TWiki-ing away!
|
> > |
-
-
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 TWikiPreferences topic in the TWiki:TWiki web to set the
WIKIWEBMASTER email address, and other preferences.
- Edit the WebPreferences topic in each web, if necessary: set individual
WEBCOPYRIGHT messages, and other preferences.
- Enable email notification of topic changes, TWikiSiteTools has more.
|
|
Enabling Authentication of Users
- If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users:
|
< < |
-
- Rename file
.htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details, consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
AuthUserFile /filepath/to/TWiki/data/.htpasswd
ErrorDocument 401 /urlpath/to/TWiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
- NOTE: In case you renamed the CGI script files to have a file extension you need to reflect that in the
edit, view, preview, etc entries in .htaccess.
- NOTE: The browser should ask for login name and password when you click on the Edit link. In case
.htaccess does not have the desired effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
- 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.
|
> > |
-
- Rename file
.htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details, consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
Redirect /urlpathto/twiki/index.html http://yourdomain.com/urlpathto/twiki/bin/view
AuthUserFile /filepathto/twiki/data/.htpasswd
ErrorDocument 401 /urlpathto/twiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
-
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.
-
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 [3] 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.
-
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.
|
|
-
- Copy the TWikiRegistrationPub topic to TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the
.txt and .txt,v files in the twiki/data/TWiki directory.
|
< < |
-
-
- HINT: You can customize the registration form by deleting or adding input tags. The
name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This ensures that the fields are processed correctly.
|
> > |
-
-
-
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.
|
|
|
< < |
-
- 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.
|
> > |
-
-
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.
|
|
|
|
To create a new web:
- Create a new web data directory under
twiki/data and check the file permission of the directory.
|
< < |
-
- Use a name starting with characters
A..Z, followed by a..z and/or 0..9 characters, but not a WikiWord.
|
> > |
-
- 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.)
|
|
- 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.
|
> > |
-
-
HINT: You can set permissions of .txt and .txt,v files to -rw-rw-rw- (666) and then edit the topic using your browser; RCS will restore the file permissions correctly when saving the topic.
|
|
- Add the new web to the web list (visible in the upper right corner of each topic) by editing the site-level preferences, TWikiPreferences:
- Add the new web to the
%WIKIWEBLIST% variable.
- Update the web settings by editing the WebPreferences topic of the new web:
|
|
- 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.
|
< < |
NOTE: User home topics are located in the AVO TWiki.Main web - don't try to move them or create them in other webs. From any other web, user signatures have to point to AVO TWiki.Main web, using a Main.UserName or %MAINWEB%.UserName format. (The %MAINWEB% variable is an advantage if you ever change the Main web name, but the standard Main.UserName is easier for users to enter, which is the bottom line!
|
> > |
NOTE: User home topics are located in the AVO TWiki.Main web - don't try to move them or create them in other webs. From any other web, user signatures have to point to AVO TWiki.Main web, using a Main.UserName or %MAINWEB%.UserName format. (The %MAINWEB% variable is an advantage if you ever change the Main web name, but the standard Main.UserName is easier for users to enter, which is the bottom line!
|
|
TWiki File System Info
See Appendix A: TWiki File System for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
-- PeterThoeny - 13 Sep 2001
|
< < |
-- MikeMannix - 03 Dec 2001
|
> > |
-- MikeMannix - 27 Jan 2002
|
|
| META TOPICMOVED | MikeMannix | date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide" |
|
|
TWiki Installation Guide
|
|
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.
|
> > |
-
-
- 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.
|
|
-
- Copy the TWikiRegistrationPub topic to TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the
.txt and .txt,v files in the twiki/data/TWiki directory.
- HINT: You can customize the registration form by deleting or adding input tags. The
name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This ensures that the fields are processed correctly.
|
|
TWiki Installation Guide
|
|
<Directory "/home/httpd/twiki/bin">
Options +ExecCGI
SetHandler cgi-script
|
> > |
AllowOverride? all
|
|
Allow from all
</Directory>
<Directory "/home/httpd/twiki/pub">
|
|
TWiki Installation Guide
|
|
- Point your Web browser at
http://yourdomain.com/twiki/bin/view and start TWiki-ing away!
- Edit the TWikiPreferences topic in the TWiki:TWiki web to set the
WIKIWEBMASTER email address, and other preferences.
- Edit the WebPreferences topic in each web, if necessary: set individual
WEBCOPYRIGHT messages, and other preferences.
|
< < |
- Enable email notification of topic changes, MonitoringSiteActivity? has more.
|
> > |
|
|
|
|
See Appendix A: TWiki File System for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
-- PeterThoeny - 13 Sep 2001
|
< < |
-- MikeMannix - 14 Sep 2001
|
> > |
-- MikeMannix - 03 Dec 2001
|
|
| META TOPICMOVED | MikeMannix | date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide" |
|
|
TWiki Installation Guide
|
|
- Make sure Perl 5 and the Perl CGI library are installed on your system. The default location of Perl is
/usr/bin/perl. If it's elsewhere, change the path to Perl in the first line of each script in the twiki/bin directory, or create a symbolic link from /usr/bin/perl.
- IMPORTANT: On ISP-hosted accounts, Perl CGI scripts usually require a
.cgi extension to run. Some systems need .pl, the regular Perl extension. Modify all twiki/bin script filenames if necessary.
|
> > |
- 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.
- NOTE: This Guide assumes user
nobody ownership for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. You can:
- replace
nobody with another user if your server executes scripts under a different name (ex: default for Debian is www-data).
- HINT: Run the
testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. It will show you the user name of the CGI scripts, a table listing all CGI environment variables, and a test of your twiki/lib/TWiki.cfg configuration file (you'll configure that in a minute).
- replace user
twiki with your own username
|
< < |
- 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.
|
|
TWiki Installation Guide
|
|
To create a new web:
- 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.
|
> > |
-
- Use a name starting with characters
A..Z, followed by a..z and/or 0..9 characters, but not a WikiWord.
|
|
- Copy all files from the
twiki/data/_default directory to the new data directory, preserving the original files' owner, group and permissions (on Unix, use cp -p). The data files must be writable by the owner the CGI scripts are running on (usually, nobody).
- HINT: You can set permissions of
.txt and .txt,v files to -rw-rw-rw- (666) and then edit the topic using your browser; RCS will restore the file permissions correctly when saving the topic.
- Add the new web to the web list (visible in the upper right corner of each topic) by editing the site-level preferences, TWikiPreferences:
|
|
TWiki Installation Guide
|
|
- To be able to edit the Perl scripts and
.tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
- NOTE: This Guide assumes user
nobody ownership for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. You can:
- replace
nobody with another user if your server executes scripts under a different name (ex: default for Debian is www-data).
|
> > |
-
-
- HINT: Run the
testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. It will show you the user name of the CGI scripts, a table listing all CGI environment variables, and a test of your twiki/lib/TWiki.cfg configuration file (you'll configure that in a minute).
|
|
-
- replace user
twiki with your own username
|
< < |
- The CGI scripts execute as
nobody. Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x (755).
- Test your settings by running the
testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. You should get a table listing all CGI environment variables, and a test of your twiki/lib/TWiki.cfg configuration file (you'll configure that in a minute).
|
> > |
- Set the file permission of all Perl scripts in the
twiki/bin directory as executable to -rwxr-xr-x (755).
|
|
- Set the permission of all files below
twiki/data so that they are writable by user nobody. A simple way is to chmod them to -rw-rw-r-- (664) and to chown them to nobody.
- Set the permission of the
twiki/data directory and its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
- Set the permission of the
twiki/pub directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
|
> > |
- NOTE: The
twiki/data/*/*.txt,v RCS repository files in the installation package are locked by user nobody. If your CGI scripts are not running as user nobody, it's not possible to check in files (you'll see that the revision number won't increase after saving a topic). In this case, you need to unlock all repository files (check the RCS man pages) and lock them with a different user, ex www-data, or delete them all - new files will be automatically created the first time each topic is edited. A simple way to change ownership is with a search-and-replace in all files; for example, using sed: for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
|
|
Step 3: Set the Main Configuration File
- Edit the file
twiki/lib/TWiki.cfg, setting the variables to your needs.
- Set the file extension in the
$scriptSuffix variable to cgi or pl if required.
- Make sure RCS is installed. Set
$rcsDir in twiki/lib/TWiki.cfg to mach the location of your RCS binaries.
|
< < |
- NOTE: The
*,v RCS repository files in the installation package are locked by user nobody. If your CGI scripts are not running as user nobody, it's not possible to check in files (you'll see that the revision number won't increase after saving a topic). In this case, you need to unlock all repository files and lock them as user www-data (check the RCS man pages), or delete them all - new files will be automatically created the first time each topic is edited. A simple way to change ownership is with a search-and-replace in all files; for example, using sed: for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
|
|
- Security issue: Directories
twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directories to a place where they are not visible, and change the variables in twiki/lib/TWiki.cfg accordingly)
|
< < |
|
> > |
- Test your settings by running the
testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. Check if your twiki/lib/TWiki.cfg configuration file settings are correct.
|
|
Step 4: Finish Up from Your Browser
- Point your Web browser at
http://yourdomain.com/twiki/bin/view and start TWiki-ing away!
|
< < |
- Edit the TWikiAdminGroup topic to include users with system administrator status.
- Edit the TWikiPreferences topic in the TWiki:TWiki web to set the
WIKIWEBMASTER email address, the WEBCOPYRIGHT message, access privileges, and other preferences.
- Edit the WebPreferences topic in each web, if necessary: set access priviliges, individual
WEBCOPYRIGHT messages, other preferences.
|
> > |
- Edit the TWikiPreferences topic in the TWiki:TWiki web to set the
WIKIWEBMASTER email address, and other preferences.
- Edit the WebPreferences topic in each web, if necessary: set individual
WEBCOPYRIGHT messages, and other preferences.
- Enable email notification of topic changes, MonitoringSiteActivity? has more.
|
|
- Edit the WebNotify topic in all webs and add the users you want to notify.
|
> > |
|
|
That's it for the standard virgin installation of TWiki. Read on for server-level customization 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.
|
> > |
Enabling Authentication of Users
- If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users:
- Rename file
.htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details, consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
AuthUserFile /filepath/to/TWiki/data/.htpasswd
ErrorDocument 401 /urlpath/to/TWiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
- NOTE: In case you renamed the CGI script files to have a file extension you need to reflect that in the
edit, view, preview, etc entries in .htaccess.
- NOTE: The browser should ask for login name and password when you click on the Edit link. In case
.htaccess does not have the desired effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
- Copy the TWikiRegistrationPub topic to TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the
.txt and .txt,v files in the twiki/data/TWiki directory.
- HINT: You can customize the registration form by deleting or adding input tags. The
name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This ensures that the fields are processed correctly.
- Register yourself in the TWikiRegistration topic.
- NOTE: When a user registers, a new line with the username and encrypted password is added to the
data/.htpasswd file. The .htpasswd file that comes with the TWiki installation includes user accounts for TWiki core team members that are used for testing on TWiki.org. You can edit the file and delete those lines.
- Create a new topic to check if authentication works.
- Edit the TWikiAdminGroup topic in the TWiki:Main web to include users with system administrator status.
- Edit the TWikiPreferences topic in the TWiki:TWiki web to set access privileges.
- Edit the WebPreferences topic in each web, if necessary: set access priviliges.
|
|
Adding a New Web
|
|
NOTE: User home topics are located in the AVO TWiki.Main web - don't try to move them or create them in other webs. From any other web, user signatures have to point to AVO TWiki.Main web, using a Main.UserName or %MAINWEB%.UserName format. (The %MAINWEB% variable is an advantage if you ever change the Main web name, but the standard Main.UserName is easier for users to enter, which is the bottom line!
|
< < |
Enabling Basic Authentication (.htaccess)
- If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users:
- Rename file
.htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details, consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
AuthUserFile /filepath/to/TWiki/data/.htpasswd
ErrorDocument 401 /urlpath/to/TWiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
- NOTE: In case you renamed the CGI script files to have a file extension you need to reflect that in the
edit, view, preview, etc entries in .htaccess.
- NOTE: The browser should ask for login name and password when you click on the Edit link. In case
.htaccess does not have the desired effect you need to enable it: Add "AllowOverride All" to the Directory section of access.conf for your twiki/bin directory.
- Copy the TWikiRegistrationPub topic to TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the
.txt and .txt,v files in the twiki/data/TWiki directory.
- You can customize the registration form by deleting or adding input tags. The
name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), or "Twk1..." (if this is a required entry). This ensures that the fields are processed correctly.
-
- NOTE: When a user registers, a new line with the username and encrypted password is added to the
data/.htpasswd file. The .htpasswd file that comes with the TWiki installation includes user accounts for TWiki core team members that are used for testing on TWiki.org. You can edit the file and delete those lines.
|
|
TWiki File System Info
See Appendix A: TWiki File System for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
|
|
TWiki Installation Guide
|
|
Request and download the TWiki 01-Sep-2001 distribution in Unix ZIP format from http://TWiki.org/download.html. (To install TWiki on SourceForge, for use on a software development project, read TWiki:Codev/SourceForgeHowTo.)
|
< < |
- NOTE: This Guide assumes user
nobody ownership for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. You can:
- replace
nobody with another user if your server executes scripts under a different name (ex: default for Debian is www-data).
- replace user
twiki with your own username
|
|
Step 1: Create & Configure the Directories
NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the alternative Step 1 instead.
|
|
</Directory>
|
> > |
- Restart Apache by
/etc/rc.d/rc5.d/S85httpd restart .
- Test that the
twiki/bin directory is CGI-enabled by trying visiting it in your browser:
- Enter the URL for the
bin directory, http://yourdomain.com/twiki/bin/.
- Your settings are OK if you get a message like
"Forbidden. You don't have permission to access /twiki/bin/ on this server".
- Settings are NOT correct if you get something like
"Index of /twiki/bin" - recheck your httpd.conf file.
|
|
|
|
|
< < |
Step 2: Check the Server Directory Settings
|
> > |
Step 2: Set File Permissions
|
|
|
< < |
- Restart Apache by
/etc/rc.d/rc5.d/S85httpd restart .
- Test if the
twiki/bin directory is CGI-enabled:
- Enter the URL of that directory into your browser (
http://your.domain.com/twiki/bin ). It is not set correctly as cgi-bin in case you get something like "Index of /twiki/bin" . It is OK if you get a message like "Forbidden. You don't have permission to access /twiki/bin/ on this server."
- Execute the
testenv script from your browser ( http://your.domain.com/twiki/bin/testenv ). It shows a table with all CGI environment variables. It also tests the settings in your twiki/lib/TWiki.cfg configuration file, which you will set later on.
Step 3: Enable Perl File Permissions
- Make sure Perl 5 and the Perl CGI library are installed on your system. The default location of Perl is
/usr/bin/perl. If Perl is installed elsewhere, change the first line of all scripts in the twiki/bin directory (or create a symbolic link from /usr/bin/perl).
- IMPORTANT: On most ISP virtual domain accounts, Perl CGI scripts require a
.cgi extension to run. Some systems need .pl, the regular Perl extension. Change all twiki/bin scripts appropriately if necessary.
|
> > |
- Make sure Perl 5 and the Perl CGI library are installed on your system. The default location of Perl is
/usr/bin/perl. If it's elsewhere, change the path to Perl in the first line of each script in the twiki/bin directory, or create a symbolic link from /usr/bin/perl.
- IMPORTANT: On ISP-hosted accounts, Perl CGI scripts usually require a
.cgi extension to run. Some systems need .pl, the regular Perl extension. Modify all twiki/bin script filenames if necessary.
|
|
- To be able to edit the Perl scripts and
.tmpl files it is necessary to chown and chgrp -R twiki so all the files have the owner you want.
|
> > |
- NOTE: This Guide assumes user
nobody ownership for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. You can:
- replace
nobody with another user if your server executes scripts under a different name (ex: default for Debian is www-data).
- replace user
twiki with your own username
|
|
- The CGI scripts execute as
nobody. Set the file permission of all Perl scripts in the twiki/bin directory as executable to -rwxr-xr-x (755).
|
> > |
- Test your settings by running the
testenv script from your browser: http://yourdomain.com/twiki/bin/testenv. You should get a table listing all CGI environment variables, and a test of your twiki/lib/TWiki.cfg configuration file (you'll configure that in a minute).
|
|
- Set the permission of all files below
twiki/data so that they are writable by user nobody. A simple way is to chmod them to -rw-rw-r-- (664) and to chown them to nobody.
- Set the permission of the
twiki/data directory and its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
- Set the permission of the
twiki/pub directory and all its subdirectories so that files in there are writable by user nobody. A simple way is to chmod them to drwxrwxr-x (775) and to chown them to nobody.
|
< < |
Step 4: Set the Main Configuration File
|
> > |
Step 3: Set the Main Configuration File
|
|
|
< < |
- Edit the file
twiki/lib/TWiki.cfg and set the variables to your needs.
|
> > |
- Edit the file
twiki/lib/TWiki.cfg, setting the variables to your needs.
|
|
-
- Set the file extension in the
$scriptSuffix variable to cgi or pl if required.
- Make sure RCS is installed. Set
$rcsDir in twiki/lib/TWiki.cfg to mach the location of your RCS binaries.
|
< < |
- Note in case the CGI scripts are not running as user
nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (ex: www-data ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user www-data (check the rcs man pages), or simply delete all the repository files. A simple way to switch the locker of the RCS files is to use sed: for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
|
> > |
- NOTE: The
*,v RCS repository files in the installation package are locked by user nobody. If your CGI scripts are not running as user nobody, it's not possible to check in files (you'll see that the revision number won't increase after saving a topic). In this case, you need to unlock all repository files and lock them as user www-data (check the RCS man pages), or delete them all - new files will be automatically created the first time each topic is edited. A simple way to change ownership is with a search-and-replace in all files; for example, using sed: for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
|
|
- Security issue: Directories
twiki/data , twiki/templates and all its subdirectories should be set so that they are not visible as a URL. (Alternatively, move the directories to a place where they are not visible, and change the variables in twiki/lib/TWiki.cfg accordingly)
- Enable email notification of topic changes, MonitoringSiteActivity? has more.
- Add the TWiki:Main/PoweredByTWikiLogo to your Main topic.
|
< < |
Step 5: Finish Up from Your Browser
|
> > |
Step 4: Finish Up from Your Browser
|
|
- Point your Web browser at
http://yourdomain.com/twiki/bin/view and start TWiki-ing away!
- Edit the TWikiAdminGroup topic to include users with system administrator status.
|
|
TWiki Installation Guide
|
< < |
Installation instructions for the current public release (01-Sep-2001)
|
> > |
Installation instructions for the TWiki 01-Sep-2001 production release
|
|
Overview
These installation steps are based on the Apache Web server on Linux. TWiki runs on other Web servers and Unix systems, and should be fine with any OS and server that meet the system requirements. Documentation for other platforms is currently limited. For Windows, check TWiki:Codev/TWikiOnWindows. Search the TWiki:Codev web for other intallation notes.
|
> > |
Standard Installation
Request and download the TWiki 01-Sep-2001 distribution in Unix ZIP format from http://TWiki.org/download.html. (To install TWiki on SourceForge, for use on a software development project, read TWiki:Codev/SourceForgeHowTo.)
|
|
- NOTE: This Guide assumes user
nobody ownership for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. You can:
- replace
nobody with another user if your server executes scripts under a different name (ex: default for Debian is www-data).
- replace user
twiki with your own username
|
< < |
Standard Installation
Request and download the TWiki 01-Sep-2001 distribution in Unix ZIP format from http://TWiki.org/download.html.
|
|
Step 1: Create & Configure the Directories
|
< < |
- NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the alternative Step 1 instead.
- NOTE: To install TWiki on SourceForge, for use on a software development project, read TWiki:Codev/SourceForgeHowTo.
|
> > |
NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the alternative Step 1 instead.
|
|
- Create directory
/home/httpd/twiki and unzip the TWiki distribution into this directory.
- The
twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.
|
|
TWiki Installation Guide
|
|
Standard Installation
Request and download the TWiki 01-Sep-2001 distribution in Unix ZIP format from http://TWiki.org/download.html.
|
< < |
|
|
Step 1: Create & Configure the Directories
|
< < |
NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the alternative Step 1 instead.
|
> > |
- NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the alternative Step 1 instead.
- NOTE: To install TWiki on SourceForge, for use on a software development project, read TWiki:Codev/SourceForgeHowTo.
|
|
- Create directory
/home/httpd/twiki and unzip the TWiki distribution into this directory.
- The
twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.
- The
twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki to file httpd.conf with normal access options (copy from /home/httpd/html ).
- Now add
ScriptAlias for /twiki/bin and Alias for /twiki to file httpd.conf .
|
< < |
Note: The ScriptAlias must come before the Alias in Apache, otherwise it will fail to correctly set up /twiki/bin/ , due to the fact that it sees that as being just another subdirectory of the /twiki/ alias.
|
> > |
NOTE: The ScriptAlias must come before the Alias, otherwise, Apache will fail to correctly set up /twiki/bin/, by treating it as just another subdirectory of the /twiki/ alias.
|
|
|
< < |
|
> > |
|
|
Example httpd.conf entries:
ScriptAlias /twiki/bin/ "/home/httpd/twiki/bin/"
Alias /twiki/ "/home/httpd/twiki/"
|
|
- Upload the TWiki files by FTP (transfer as text except for the image files in
pub)
|
< < |
twiki/bin | CGI bin | cgi-bin enabled dir | /home/smith/public_html/cgi-bin |
twiki/lib | library files | same level like twiki/bin | /home/smith/public_html/lib |
|
> > |
twiki/bin | CGI bin | cgi-enabled dir | /home/smith/public_html/cgi-bin |
twiki/lib | library files | same level as twiki/bin | /home/smith/public_html/lib |
|
|
twiki/pub | public files | htdoc enabled dir | /home/smith/public_html/pub |
twiki/data | topic data | outside of htdoc tree (for security) | /home/smith/twiki/data |
twiki/templates | web templates | outside of htdoc tree (for security) | /home/smith/twiki/templates |
|
< < |
(Read TWiki:Codev/SourceForgeHowTo in case you want to install TWiki on SourceForge, to use on a software development project.)
|
|
|
|
TWiki Installation Guide
|
< < |
Clean install of the current public release (01-Sep-2001)
|
> > |
Installation instructions for the current public release (01-Sep-2001)
|
|
Overview
|
< < |
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.)
|
> > |
These installation steps are based on the Apache Web server on Linux. TWiki runs on other Web servers and Unix systems, and should be fine with any OS and server that meet the system requirements. Documentation for other platforms is currently limited. For Windows, check TWiki:Codev/TWikiOnWindows. Search the TWiki:Codev web for other intallation notes.
|
|
|
< < |
- 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.
-
- 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 SourceForge.
|
> > |
- NOTE: This Guide assumes user
nobody ownership for all files manipulated by the CGI scripts (executed by the Web server), and user twiki for all other files. You can:
- replace
nobody with another user if your server executes scripts under a different name (ex: default for Debian is www-data).
- replace user
twiki with your own username
|
|
|
> > |
|
|
Standard Installation
Request and download the TWiki 01-Sep-2001 distribution in Unix ZIP format from http://TWiki.org/download.html.
Step 1: Create & Configure the Directories
|
> > |
NOTE: If you don't have access to your Web server configuration files - for example, if you're installing on an ISP-hosted account - use the alternative Step 1 instead.
|
|
- Create directory
/home/httpd/twiki and unzip the TWiki distribution into this directory.
- The
twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.
- The
twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki to file httpd.conf with normal access options (copy from /home/httpd/html ).
|
|
</Directory>
|
> > |
Step 1 for Non-Root Accounts
To install TWiki on a system where you don't have server administrator privileges, for example, on a hosted Web account:
- 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)
| 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 SourceForge, to use on a software development project.)
|
|
Step 2: Check the Server Directory Settings
- 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.
|
> > |
-
- 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 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.
|
> > |
- 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.
- 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.
|
|
Step 4: Set the Main Configuration File
|
< < |
- 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.
|
> > |
- 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/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 directories to a place where they are not visible, and change the variables in twiki/lib/TWiki.cfg accordingly)
|
> > |
- Note in case the CGI scripts are not running as user
nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (ex: www-data ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user www-data (check the rcs man pages), or simply delete all the repository files. A simple way to switch the locker of the RCS files is to use sed: for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
- 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)
|
|
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.
- Edit the WebNotify topic in all webs and set the users you want to notify.
|
> > |
- Point your Web browser at
http://yourdomain.com/twiki/bin/view and start TWiki-ing away!
- Edit the TWikiAdminGroup topic to include users with system administrator status.
- Edit the TWikiPreferences topic in the TWiki:TWiki web to set the
WIKIWEBMASTER email address, the WEBCOPYRIGHT message, access privileges, and other preferences.
- Edit the WebPreferences topic in each web, if necessary: set access priviliges, individual
WEBCOPYRIGHT messages, other preferences.
- Edit the WebNotify topic in all webs and add the users you want to notify.
- You can add new
%VARIABLES%. Define site-level variables in the TWikiPreferences topic. See also: TWikiVariables.
|
|
|
< < |
That's it for the standard virgin installation of TWiki. Read on to learn how to customize TWiki.
|
> > |
That's it for the standard virgin installation of TWiki. Read on for server-level customization options.
|
|
Additional Server-Level Options
|
< < |
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.
|
> > |
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.
|
|
|
< < |
Creating a New Web
|
> > |
Adding a New Web
|
|
|
< < |
|
> > |
To create a new web:
|
|
-
- 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.
- 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.
|
> > |
-
- HINT: You can set permissions of
.txt and .txt,v files to -rw-rw-rw- (666) and then edit the topic using your browser; RCS will restore the file permissions correctly when saving the topic.
|
|
-
- Add the new web to the web list (visible in the upper right corner of each topic) by editing the site-level preferences, TWikiPreferences:
- Add the new web to the
%WIKIWEBLIST% variable.
- Update the web settings by editing the WebPreferences topic of the new web:
|
|
-
- Add the new web to the color-coded web directory table by editing the TWikiWebsTable topic.
- 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 AVO 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 AVO TWiki.Main web with
Main.UserName or %MAINWEB%.UserName - using the %MAINWEB% variable is preferable, particularly if you might change the Main web name.
|
> > |
That's it for a basic new web set-up!
|
|
|
< < |
Adding Variables & Rendering Rules
|
> > |
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.
|
|
|
< < |
- 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.
|
> > |
NOTE: User home topics are located in the AVO TWiki.Main web - don't try to move them or create them in other webs. From any other web, user signatures have to point to AVO TWiki.Main web, using a Main.UserName or %MAINWEB%.UserName format. (The %MAINWEB% variable is an advantage if you ever change the Main web name, but the standard Main.UserName is easier for users to enter, which is the bottom line!
|
|
Enabling Basic Authentication (.htaccess)
|
< < |
- If you are on a non-authenticated server - not using SSL - and you would like to authenticate users:
|
> > |
- If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users:
|
|
-
- Rename file
.htaccess.txt in the twiki/bin directory to .htaccess and change it to your needs. For details, consult the HTTP server documentation (for Apache server: [1], [2]). In particular, the following red part needs to be configured correctly:
Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
AuthUserFile /filepath/to/TWiki/data/.htpasswd
|
|
-
-
- 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.
|
> > |
-
-
- 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.
|
|
|
< < |
-
- 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.
|
> > |
-
- NOTE: When a user registers, a new line with the username and encrypted password is added to the
data/.htpasswd file. The .htpasswd file that comes with the TWiki installation includes user accounts for TWiki core team members that are used for testing on TWiki.org. You can edit the file and delete those lines.
|
|
TWiki File System Info
|
< < |
See A: TWiki File System for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
|
> > |
See Appendix A: TWiki File System for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2001 distribution.
|
|
|
> > |
-- PeterThoeny - 13 Sep 2001
|
|
-- MikeMannix - 14 Sep 2001
|
< < |
-- PeterThoeny - 13 Sep 2001
|
|
| META TOPICMOVED | MikeMannix | date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide" |
|
|
TWiki Installation Guide
|
|
-
- 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:
|
> > |
-
- 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:
|
|
|
|
Step 2: Check the Server Directory Settings
- Restart Apache by
/etc/rc.d/rc5.d/S85httpd restart .
|
< < |
- Test if the
twiki/bin directory is cgi-enabled:
|
> > |
- 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. 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.
|
> > |
-
- 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 file extension in the
$scriptSuffix variable to cgi or pl if required.
- Make sure RCS is installed. Set
$rcsDir in twiki/lib/TWiki.cfg to mach the location of your RCS binaries.
- Note in case the CGI scripts are not running as user
nobody: The *,v RCS repository files delivered with the installation package are locked by user nobody . In case the user is different (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)
|
> > |
- 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)
|
|
|
|
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
|
> > |
-- MikeMannix - 14 Sep 2001
|
|
-- PeterThoeny - 13 Sep 2001
| META TOPICMOVED | MikeMannix | date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide" |
|
|
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 AVO 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 AVO 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 | MikeMannix | date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide" |
|
|
TWiki Installation Guide
|
|
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.)
|
< < |
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.
|
> > |
- NOTE: This Installation Guide assumes the following:
|
|
|
< < |
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:
|
> > |
-
- 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:
|
|
|
|
That's it for the standard virgin installation of TWiki. Read on to learn how to customize TWiki.
|
< < |
Extra Server-Level Options
|
> > |
Additional Server-Level Options
|
|
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.
|
|
Creating a New Web
|
< < |
-
- 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 TWikiPreferences:
|
> > |
-
- 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.
- Copy all files from the
twiki/data/_default directory to the new data directory, preserving the original files' owner, group and permissions (on Unix, use cp -p). The data files must be writable by the owner the CGI scripts are running on (usually, nobody).
- Hint: You can set permissions of
.txt and .txt,v files to -rw-rw-rw- (666) and then edit the topic using your browser; RCS will restore the file permissions correctly when saving the topic.
- Add the new web to the web list (visible in the upper right corner of each topic) by editing the site-level preferences, TWikiPreferences:
|
|
-
-
- Add the new web to the
%WIKIWEBLIST% variable.
|
< < |
-
- Add the new web to the web table (at the bottom of each WebHome topic) by editing the TWikiWebsTable topic.
- Change the web preferences by editing the 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
%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).
- 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 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 WebStatistics in the new web and delete old usage entries.
- Note that user home topics are only located in the AVO TWiki.Main 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 AVO TWiki.Main web like
Main.UserName or %MAINWEB%.UserName.
|
> > |
-
- Update the web settings by editing the WebPreferences topic of the new web:
- Customize the
%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:
%WEBCOPYRIGHT% can be set for an individual web).
- Add the new web to the color-coded web directory table by editing the TWikiWebsTable topic.
- 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 Form Templates 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 AVO 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 AVO 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 customization in twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .
|
> > |
- 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.
|
|
Enabling Basic Authentication (.htaccess)
|
< < |
- 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: [1], [2]). In particular, the following red part needs to be configured correctly:
|
> > |
- If you are on a non-authenticated server - 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: [1], [2]). In particular, the following red part needs to be configured correctly:
|
|
Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
AuthUserFile /filepath/to/TWiki/data/.htpasswd
ErrorDocument 401 /urlpath/to/TWiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
|
< < |
-
-
- Note: 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.
- 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.
|
> > |
-
-
- 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.
|
|
|
< < |
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 listing by directory?, with individual file descriptions, for the current TWiki release.
|
> > |
-
- 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.
|
|
|
< < |
Directory twiki/bin :
|
> > |
TWiki File System Info
|
|
|
< < |
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
Directory twiki/templates/ :
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
Directory twiki/data/ :
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
Partial file list for twiki/data/Main :
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
Directory twiki/pub/ :
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
Partial file list for twiki/pub/icn/ :
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
|
> > |
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
| META TOPICMOVED | MikeMannix | date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide" |
|
|
TWiki Installation Guide
|
|
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.)
|
< < |
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.
|
> > |
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.
|
|
|
< < |
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:
|
> > |
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:
|
|
|
|
Standard Installation
|
< < |
Request and download the TWiki %VERSION% distribution in Unix ZIP format from http://TWiki.org/download.html.
|
> > |
Request and download the TWiki 01-Sep-2001 distribution in Unix ZIP format from http://TWiki.org/download.html.
|
|
Step 1: Create & Configure the Directories
|
|
-
- 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 TWikiPreferences:
|
< < |
-
-
- Add the new web to the WIKIWEBLIST variable.
|
> > |
-
-
- Add the new web to the
%WIKIWEBLIST% variable.
|
|
-
- Add the new web to the web table (at the bottom of each WebHome topic) by editing the TWikiWebsTable topic.
- Change the web preferences by editing the 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 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).
|
> > |
-
-
- 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).
|
|
-
- 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 FormTemplateSystem?
|
> > |
|
|
-
- 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 WebStatistics in the new web and delete old usage entries.
- Note that user home topics are only located in the AVO TWiki.Main 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 AVO TWiki.Main web like
Main.UserName or %MAINWEB%.UserName.
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 customization in
twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .
|
> > |
- You can add new rendering rules or new
%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)
|
|
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 complete file listing by directory, with individual file descriptions, for the current TWiki release.
|
> > |
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 listing by directory?, with individual file descriptions, for the current TWiki release.
|
|
Directory twiki/bin :
|
|
TOC: No TOC in "TWiki.TWikiInstallationGuide"
|
< < |
TWiki Installation Guide
|
> > |
TWiki Installation Guide
|
|
Clean install of the current public release (01-Sep-2001)
|
< < |
Overview
|
> > |
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.)
|
|
Read http://TWiki.org/cgi-bin/view/Codev/SourceForgeHowTo in case you want to install TWiki on SourceForge.
|
< < |
Standard Installation
|
> > |
Standard Installation
|
|
Request and download the TWiki %VERSION% distribution in Unix ZIP format from http://TWiki.org/download.html.
|
< < |
Step 1: Create & Configure the Directories
|
> > |
Step 1: Create & Configure the Directories
|
|
- Create directory
/home/httpd/twiki and unzip the TWiki distribution into this directory.
- The
twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.
|
|
</Directory>
|
< < |
Step 2: Check the Server Directory Settings
|
> > |
Step 2: Check the Server Directory Settings
|
|
- 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.
|
< < |
Step 3: Enable Perl File Permissions
|
> > |
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.
|
|
- 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).
|
< < |
Step 4: Set the Main Configuration File
|
> > |
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.
- Set the file extension in the
$scriptSuffix variable to cgi or pl if required.
|
|
|
< < |
Step 5: Finish Up from Your Browser
|
> > |
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.
|
|
That's it for the standard virgin installation of TWiki. Read on to learn how to customize TWiki.
|
< < |
Extra Server-Level Options
|
> > |
Extra Server-Level Options
|
|
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.
|
< < |
Creating a New Web
|
> > |
Creating a New Web
|
|
- To create a new web:
- Use a name for the web consisting of characters
A..Z , a..z but not in WikiNotation.
|
|
-
- 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 WebStatistics in the new web and delete old usage entries.
- Note that user home topics are only located in the AVO TWiki.Main 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 AVO TWiki.Main web like
Main.UserName or %MAINWEB%.UserName.
|
< < |
Adding Variables & Rendering Rules
|
> > |
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 customization in
twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .
|
< < |
Enabling Basic Authentication (.htaccess)
|
> > |
Enabling Basic Authentication (.htaccess)
|
|
- 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: [1], [2]). In particular, the following red part needs to be configured correctly:
|
|
-
-
- 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.
|
< < |
TWiki File System Snapshot
|
> > |
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 complete file listing by directory, with individual file descriptions, for the current TWiki release.
|
|
-rwxrwxr-x 1 twiki twiki 1689 Jun 20 20:10 viewfile
|
< < |
|
|
Directory twiki/templates/ :
|
|
-rw-rw-r-- 1 twiki twiki 955 Mar 8 11:41 oopsregpasswd.tmpl
|
< < |
|
|
Directory twiki/data/ :
|
|
-rw-r--r-- 1 nobody nobody 1516 Aug 20 17:56 log200008.txt
|
< < |
|
|
Partial file list for twiki/data/Main :
|
|
-r--r--r-- 1 nobody nobody 6523 Aug 18 18:08 WebHome.txt,v
|
< < |
|
|
Directory twiki/pub/ :
|
|
-rw-rw-r-- 1 twiki twiki 2877 Jun 7 1999 wikiHome.gif
|
< < |
|
|
Partial file list for twiki/pub/icn/ :
|
|
-rw-rw-r-- 1 twiki twiki 152 Mar 9 1999 doc.gif
|
< < |
-- PeterThoeny - 16 Mar 2001
|
> > |
-- MikeMannix - 07 Sep 2001
|
|
| META TOPICMOVED | MikeMannix | date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide" |
|
|
TWiki Installation Guide
|
< < |
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 )
|
> > |
Clean install of the current public release (01-Sep-2001)
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.)
|
|
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.
|
|
Step 3: Enable Perl File Permissions
|
< < |
- 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 ).
|
> > |
- 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).
|
|
TWiki Installation Guide
|
|
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.
|
< < |
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:
|
> > |
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:
|
|
| TWiki dir: | What it is: | Where to copy: | Example: |
twiki/bin | CGI bin | cgi-bin enabled dir | /home/smith/public_html/cgi-bin/twiki |
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.
|
< < |
Standard Installation Steps
|
> > |
Standard Installation
Request and download the TWiki %VERSION% distribution in Unix ZIP format from http://TWiki.org/download.html.
Step 1: Create & Configure the Directories
|
|
|
< < |
|
|
- Create directory
/home/httpd/twiki and unzip the TWiki distribution into this directory.
- The
twiki/bin directory of TWiki must be set as a cgi-bin directory. Add /home/httpd/twiki/bin to file /etc/httpd/httpd.conf with only ExecCGI option.
- The
twiki/pub directory of TWiki must be set so that it is visible as a URL. Add /home/httpd/twiki to file httpd.conf with normal access options (copy from /home/httpd/html ).
- Now add
ScriptAlias for /twiki/bin and Alias for /twiki to file httpd.conf .
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
httpd.conf entries:
|
> > |
Example httpd.conf entries:
|
|
ScriptAlias /twiki/bin/ "/home/httpd/twiki/bin/"
Alias /twiki/ "/home/httpd/twiki/"
<Directory "/home/httpd/twiki/bin">
|
|
AllowOverride None
Allow from all
</Directory>
|
> > |
Step 2: Check the Server Directory Settings
|
|
- 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.
- 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.
|
> > |
-
- 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.
Step 3: Enable Perl File Permissions
- 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 ).
- 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).
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.
- 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.
|
< < |
- 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.TWiki 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.
|
|
- 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. Using your browser, edit also the WebNotify topic in all webs and set the users you want to notify.
|
> > |
- 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.
|
|
|
< < |
Adding Variables & Rendering Rules
- Optional: You can add new rendering rules or new %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 .
|
> > |
Step 5: Finish Up from Your Browser
|
|
|
< < |
Enabling Basic Authentication (.htaccess)
|
> > |
- 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.
|
|
|
< < |
- 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: [1], [2]). In particular, the following red part needs to be configured correctly:
Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
AuthUserFile /filepath/to/TWiki/data/.htpasswd
ErrorDocument 401 /urlpath/to/TWiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
- Note: 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.
- 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.
|
> > |
That's it for the standard virgin installation of TWiki. Read on to learn how to customize TWiki.
|
|
|
< < |
Generating Site Usage Statistics
|
> > |
Extra Server-Level Options
|
|
|
< < |
- 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<date>.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: 0 0 * * * (cd /path/to/TWiki/bin; ./statistics >/dev/null 2>&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: 0 0 * * * (cd /path/to/TWiki/bin; ./geturl mydomain.com /urlpath/to/TWiki/bin/statistics >/dev/null 2>&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:
http://mydomain.com/twiki/bin/statistics
- Update current month for Main web only:
http://mydomain.com/twiki/bin/statistics/Main
- Update January 2000 for Main web:
http://mydomain.com/twiki/bin/statistics/Main?logdate=200001
|
> > |
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.
|
|
|
< < |
Creating a New Web
|
> > |
Creating a New Web
|
|
- To create a new web:
- Use a name for the web consisting of characters
A..Z , a..z but not in WikiNotation.
|
|
-
- 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 WebStatistics in the new web and delete old usage entries.
- Note that user home topics are only located in the AVO TWiki.Main 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 AVO TWiki.Main web like
Main.UserName or %MAINWEB%.UserName.
|
> > |
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 customization in
twiki/bin/wikicfg.pm , not twiki/bin/wiki.pm .
Enabling Basic Authentication (.htaccess)
- 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: [1], [2]). In particular, the following red part needs to be configured correctly:
Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
AuthUserFile /filepath/to/TWiki/data/.htpasswd
ErrorDocument 401 /urlpath/to/TWiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
- Note: 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.
- 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.
|
|
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 complete file listing by directory, with individual file descriptions, for the current TWiki release.
|
|
TWiki Installation Guide
|
|
-- PeterThoeny - 16 Mar 2001
|
> > |
| META TOPICMOVED | MikeMannix | date="999319650" from="TWiki.TWikiInstallationNotes" to="TWiki.TWikiInstallationGuide" |
|
|
TOC: No TOC in "TWiki.TWikiInstallationGuide"
|
< < |
TWiki Installation Notes
|
> > |
TWiki Installation Guide
|
|
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 )
|
|
|
< < |
Add New Rendering Rules & Variables
|
> > |
Adding Variables & Rendering Rules
|
|
- Optional: You can add new rendering rules or new %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 .
|
< < |
Enable Basic Authentication (.htaccess)
|
> > |
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: [1], [2]). In particular, the following red part needs to be configured correctly:
|
|
-
-
- 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.
|
< < |
Generate Site Usage Statistics
|
> > |
Generating Site Usage Statistics
|
|
- 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<date>.txt .
|
|
-
-
- Update January 2000 for Main web:
http://mydomain.com/twiki/bin/statistics/Main?logdate=200001
|
< < |
Create a New Web
|
> > |
Creating a New Web
|
|
- To create a new web:
- Use a name for the web consisting of characters
A..Z , a..z but not in WikiNotation.
|
|
-
- 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 WebStatistics in the new web and delete old usage entries.
- Note that user home topics are only located in the AVO TWiki.Main 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 AVO TWiki.Main web like
Main.UserName or %MAINWEB%.UserName.
|
< < |
Contents of Directories
|
> > |
TWiki File System Snapshot
|
|
|
< < |
Here are contents of directories showing file permissions. Please note that this is for debugging reasons only and does not exactly reflect the distribution:
|
> > |
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 listing by directory, with individual file descriptions, for the current TWiki release.
|
|
Directory twiki/bin :
|
|
-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
|
< < |
-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
|
|
|
|
-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
|
< < |
-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
|
|
|
|
|
< < |
Part of directory twiki/data/Main :
|
> > |
Partial file list for twiki/data/Main :
|
|
drwxrwxrwx 2 nobody nobody 4096 Aug 19 04:15 .
|
|
-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
|
< < |
-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
|
|
|
|
|
< < |
Directory twiki/pub/icn/ :
|
> > |
Partial file list for twiki/pub/icn/ :
|
|
drwxrwxr-x 2 twiki twiki 4096 Jun 17 16:35 .
|
|
-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
|
< < |
-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
|
|
-- PeterThoeny - 16 Mar 2001
|
> > |
TOC: No TOC in "TWiki.TWikiInstallationGuide"
|
|
TWiki Installation Notes
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 )
|
|
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.
|
< < |
Installation steps
|
> > |
Standard Installation Steps
|
|
- Request the TWiki distribution (in Unix ZIP format) from http://TWiki.org/download.html .
- Create directory
/home/httpd/twiki and unzip the TWiki distribution into this directory.
|
|
|
> > |
Add New Rendering Rules & Variables
|
|
- Optional: You can add new rendering rules or new %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 .
|
> > |
Enable 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: [1], [2]). In particular, the following red part needs to be configured correctly:
Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
|
|
-
-
- 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.
|
> > |
Generate Site Usage Statistics
|
|
- 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<date>.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.
|
|
-
-
- Update current month for Main web only:
http://mydomain.com/twiki/bin/statistics/Main
- Update January 2000 for Main web:
http://mydomain.com/twiki/bin/statistics/Main?logdate=200001
|
> > |
Create a New Web
|
|
- To create a new web:
- 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 .
|
|
TWiki Installation Notes
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 )
|
|
-
-
- 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).
- If needed, create customized templates in the new templates directory. (Non existing templates are inherited from
twiki/templates )
|
< < |
-
- 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 TWiki Category Table.
|
> > |
-
- If you want to use form templates - see FormTemplateSystem?
|
|
-
- 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 WebStatistics in the new web and delete old usage entries.
- Note that user home topics are only located in the AVO TWiki.Main 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 AVO TWiki.Main web like
Main.UserName or %MAINWEB%.UserName.
|
|
|
< < |
Directory twiki/templates/Know (has a TWiki Category Table) :
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
| | |