Line: 1 to 1 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TWiki Installation Guide | |||||||||||||
Changed: | |||||||||||||
< < | The following is installation instructions for the TWiki 4.3 production release on an Apache web server on Linux. Visit TWiki:TWiki.InstallingTWiki for the latest updates to this guide and supplemental information for installing or upgrading TWiki, including notes on installing TWiki on different platforms, environments and web hosting sites. | ||||||||||||
> > | The following is installation instructions for the TWiki 5.0 production release on an Apache web server on Linux. Visit TWiki:TWiki.InstallingTWiki for the latest updates to this guide and supplemental information for installing or upgrading TWiki, including notes on installing TWiki on different platforms, environments and web hosting sites. | ||||||||||||
If you are upgrading from a previous version of TWiki, you probably want to read TWikiUpgradeGuide instead. | |||||||||||||
Deleted: | |||||||||||||
< < | Both this document and the TWikiUpgradeGuide are also available in the root of the distribution as HTML files. | ||||||||||||
On this page:
Preparing to install TWiki | |||||||||||||
Changed: | |||||||||||||
< < | Before attempting to install TWiki, you are encouraged to review the TWiki:TWiki.AdminSkillsAssumptions. This guide assumes the person installing TWiki has, at a minimum, basic knowledge of server administration on the system on which TWiki is to be installed. While it is possible to install TWiki with FTP access alone (for example, on a hosted site), it is tricky and may require additional support from your hosting service (for example, in setting file ownership and installing missing perl CPAN libraries). | ||||||||||||
> > | Before attempting to install TWiki, you are encouraged to review the TWiki:TWiki.AdminSkillsAssumptions. This guide assumes the user installing TWiki has, at a minimum, basic knowledge of server administration on the system on which TWiki is to be installed. While it is possible to install TWiki with FTP access alone (for example, on a hosted site), it is tricky and may require additional support from your hosting service (for example, in setting file ownership and installing missing Perl CPAN libraries). | ||||||||||||
To help setup a correct Apache configuration, you are very much encouraged to use the automatic tool TWiki:TWiki.ApacheConfigGenerator which generates the contents for an Apache config file for TWiki based on your inputs. While this installation guide specifically describes installation on an Apache web server on Linux, TWiki should be fine with any web server and OS that meet the system requirements (see below). For additional notes on installing TWiki on other systems, see TWiki:TWiki.InstallingTWiki#OtherPlatforms. | |||||||||||||
Changed: | |||||||||||||
< < | If you are installing TWiki without Unix/Linux root (administrator) priviledges (for example, on a hosted domain), see "Notes on Installing TWiki on Non-Root Account" below for supplemental instructions to the basic steps presented below.
If you are upgrading from an earlier major version of TWiki such as Cairo (TWiki 3) you will need the information found in TWiki:TWiki.TWikiUpgradeGuide. There is also a static HTML TWikiUpgradeGuide.html included in the root of your TWiki distribution. | ||||||||||||
> > | If you are installing TWiki without Unix/Linux root (administrator) privileges (for example, on a hosted domain), see "Notes on Installing TWiki on Non-Root Account" below for supplemental instructions to the basic steps presented below. | ||||||||||||
Changed: | |||||||||||||
< < | Upgrading from a recent TWiki4 release is much simpler. Upgraders from earlier TWiki4 versions can follow the steps described in TWiki:TWiki.UpgradingTWiki04x00PatchReleases to ensure a safe upgrade without accidently overwriting customizations. | ||||||||||||
> > | If you are upgrading from an earlier major version of TWiki such as Cairo (TWiki-3) or TWiki 4.x you will need the information found at TWiki:TWiki.TWikiUpgradeGuide. | ||||||||||||
One of the more difficult tasks is installation of addition CPAN libraries. See TWiki:TWiki.HowToInstallCpanModules for detailed information on how to install CPAN libraries. | |||||||||||||
Changed: | |||||||||||||
< < | If you need help, ask a question in the TWiki:Support web or on TWiki:Codev.TWikiIRC (irc.freenode.net, channel #twiki) | ||||||||||||
> > | If you need help, ask a question in the TWiki:Support.Webhome web or on TWiki:Codev.TWikiIRC (irc.freenode.net, channel #twiki). | ||||||||||||
Basic Installation | |||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
| |||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
| |||||||||||||
Line: 47 to 43 | |||||||||||||
| |||||||||||||
Changed: | |||||||||||||
< < | |||||||||||||
> > |
| ||||||||||||
| |||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
| |||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
| |||||||||||||
Added: | |||||||||||||
> > |
| ||||||||||||
| |||||||||||||
Deleted: | |||||||||||||
< < |
| ||||||||||||
| |||||||||||||
Changed: | |||||||||||||
< < | You now have a basic, unauthenticated installation running. At this point you can just point your Web browser at http://yourdomain.com/twiki/bin/view and start TWiki-ing away! | ||||||||||||
> > | You now have a basic, unauthenticated installation running. At this point you can just point your web browser at http://yourdomain.com/twiki/bin/view and start TWiki-ing away! | ||||||||||||
Important Server Security Settings | |||||||||||||
Added: | |||||||||||||
> > | |||||||||||||
Before you continue any further there are some basic and very important security settings you have to make sure are set correctly.
| |||||||||||||
Line: 84 to 83 | |||||||||||||
Next Steps | |||||||||||||
Changed: | |||||||||||||
< < | Once you have TWiki installed and running, you might consider the following optional steps for setting up and customizing your TWiki site. Many of the references below refer to topics within your TWiki installation. For example, TWiki.TWikiSkins refers to the TWikiSkins topic in your TWiki web. Easy way to jump directly to view the pages is to open your own TWiki in your browser and write TWiki.TWikiSkins in the Jump test box to the right in the top bar and hit Enter. You can find these topics in the on-line reference copy at the official TWiki website: TWiki Release 4.3 | ||||||||||||
> > | Once you have TWiki installed and running, you might consider the following optional steps for setting up and customizing your TWiki site. Many of the references below refer to topics within your TWiki installation. For example, TWiki.TWikiSkins refers to the TWikiSkins topic in your TWiki web. Easy way to jump directly to view the pages is to open your own TWiki in your browser and write TWiki.TWikiSkins in the Jump test box to the right in the top bar and hit Enter. You can find these topics in the on-line reference copy at the official TWiki website: TWiki Release 5.0 | ||||||||||||
Enable Authentication of Users | |||||||||||||
Line: 103 to 102 | |||||||||||||
You are strongly encouraged to read TWikiUserAuthentication, TWiki:TWiki.TWikiUserAuthenticationSupplement, and TWiki:TWiki.SecuringTWikiSite for further information about managing users and security of your TWiki site. | |||||||||||||
Changed: | |||||||||||||
< < | Note! The other LoginManager option TWiki::LoginManager::ApacheLogin uses a basic Apache type authentication where the browser itself prompts you for username and password. Most will find the TemplateLogin looking nicer. But ApacheLogin is required when you use Apache authentication methods like mod_ldap where all authentication is handled by an Apache module and not by the TWiki perl code. When you use ApacheLogin the apache configuration must be set up to require authentication of the some but not all the scripts in the bin directory. This section in the Apache config (or .htaccess) controls this | ||||||||||||
> > | Note: The other LoginManager option TWiki::LoginManager::ApacheLogin uses a basic Apache type authentication where the browser itself prompts you for username and password. Most will find the TemplateLogin looking nicer. But ApacheLogin is required when you use Apache authentication methods like mod_ldap where all authentication is handled by an Apache module and not by the TWiki perl code. When you use ApacheLogin the apache configuration must be set up to require authentication of the some but not all the scripts in the bin directory. This section in the Apache config (or .htaccess) controls this | ||||||||||||
<FilesMatch "(attach|edit|manage|rename|save|upload|mail|logon|rest|.*auth).*"> | |||||||||||||
Line: 179 to 178 | |||||||||||||
If you added or removed fields from the user form you may also need to tailor TWikiRegistration.
Install Plugins | |||||||||||||
Changed: | |||||||||||||
< < | TWiki:Plugins is an extensive library of Plugins for TWiki, that enhance functionality in a huge number of ways. A few plugins are pre-installed in the TWiki distribution. For more information on these, see InstalledPlugins. | ||||||||||||
> > | TWiki:Plugins.Webhome is an extensive library of plugins for TWiki, that enhance functionality in a huge number of ways. A few plugins are pre-installed in the TWiki distribution. For more information on these, see InstalledPlugins. | ||||||||||||
You activate installed plugin in the Plugins section of configure . In this section you also find a Find More Extensions button which opens an application which can install additional plugins from the TWiki.org website. If you are behind a firewall or your server has no access to the Internet it is also possible to install plugins manually. Manual installation instructions for the plugins can be found in the plugin topics on TWiki.org. Additional documenation on TWiki plugins can be found at TWiki:TWiki.TWikiPluginsSupplement. | |||||||||||||
Line: 189 to 189 | |||||||||||||
The real power of TWiki lies in it's flexibility to be customized to meet your needs. You can with small means change the looks of the default skin (called PatternSkin) by reading the PatternSkinCustomization. | |||||||||||||
Changed: | |||||||||||||
< < | At the official TWiki website you can find more resources. A good place to start for exploring what's possible is TWiki:TWiki.TWikiAdminCookBook which offers tips and tricks for customizing your TWiki site. Many of these are appropriate to implement immediately after installing TWiki and before adding content so now's a good time to look at these. | ||||||||||||
> > | At the official TWiki website you can find more resources. A good place to start for exploring what's possible is TWiki:TWiki.TWikiAdminCookBook which offers tips and tricks for customizing your TWiki site. Many of these are appropriate to implement immediately after installing TWiki and before adding content so now's a good time to look at these. | ||||||||||||
Customization of Special Pages | |||||||||||||
Line: 222 to 222 | |||||||||||||
The first step is to re-run the configure script and make sure you have resolved all errors, and are satisfied that you understand any warnings. | |||||||||||||
Changed: | |||||||||||||
< < | Failing that, please check TWiki:TWiki.InstallingTWiki on TWiki.org, the supplemental documentation that help you install TWiki on different platforms, environments and web hosting sites. For example:
| ||||||||||||
> > | If by any chance you forgot the "admin" password, the same is used in "configure" script, then please login to the server. Delete $TWiki::cfg{Password}= ' ...'; . Set the new password using "configure" script.
Failing that, please check TWiki:TWiki.InstallingTWiki on TWiki.org, the supplemental documentation that help you install TWiki on different platforms, environments and web hosting sites. For example:
| ||||||||||||
| |||||||||||||
Changed: | |||||||||||||
< < | It is also advisable to review TWiki:Codev/KnownIssuesOfTWiki04x03. | ||||||||||||
> > | It is also advisable to review TWiki:Codev/KnownIssuesOfTWiki05x00. | ||||||||||||
If you need help, ask a question in the TWiki:Support web or on TWiki:Codev/TWikiIRC (irc.freenode.net, channel #twiki) | |||||||||||||
Line: 247 to 249 | |||||||||||||
| |||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
| |||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
Required CPAN ModulesMost of the CPAN libraries listesd below are part of a standard Perl installation so you most likely have them all! | |||||||||||||
Changed: | |||||||||||||
< < | See TWiki:TWiki.HowToInstallCpanModules for detailed information on how to install CPAN libraries | ||||||||||||
> > | See TWiki:TWiki.HowToInstallCpanModules for detailed information on how to install CPAN libraries | ||||||||||||
Changed: | |||||||||||||
< < | The following Perl CPAN modules are used by TWiki: | ||||||||||||
> > | The following Perl CPAN modules are used by TWiki: | ||||||||||||
| |||||||||||||
Line: 282 to 282 | |||||||||||||
The following Perl modules may be used by TWiki: | |||||||||||||
Changed: | |||||||||||||
< < | See TWiki:TWiki.HowToInstallCpanModules for detailed information on how to install CPAN libraries | ||||||||||||
> > | See TWiki:TWiki.HowToInstallCpanModules for detailed information on how to install CPAN libraries | ||||||||||||
| |||||||||||||
Line: 326 to 326 | |||||||||||||
Notes on Installing TWiki on Non-Root Account | |||||||||||||
Changed: | |||||||||||||
< < | The following supplemental notes to the Basic Installation instructions apply to installing TWiki on a system where you don't have Unix/Linux root (administrator) privileges, for example, on a hosted Web account or an intranet server administered by someone else. | ||||||||||||
> > | The following supplemental notes to the Basic Installation instructions apply to installing TWiki on a system where you don't have Unix/Linux root (administrator) privileges, for example, on a hosted Web account or an intranet server administered by someone else. | ||||||||||||
Changed: | |||||||||||||
< < | Referring to the Basic Installation steps presented above: | ||||||||||||
> > | Referring to the Basic Installation steps presented above: | ||||||||||||
| |||||||||||||
Deleted: | |||||||||||||
< < | |||||||||||||
| |||||||||||||
Line: 348 to 345 | |||||||||||||
| |||||||||||||
Deleted: | |||||||||||||
< < | |||||||||||||
|