From: <Pet...@nt...> - 2006-01-30 08:03:14
|
Author: PeterThoeny Date: 2006-01-30 00:01:29 -0800 (Mon, 30 Jan 2006) New Revision: 8588 Modified: twiki/branches/DEVELOP/data/TWiki/TWikiInstallationGuide.txt twiki/branches/DEVELOP/data/TWiki/TWikiUpgradeGuide.txt twiki/branches/DEVELOP/data/TWiki/TWikiUserAuthentication.txt Log: Item663: TWiki.org doc merge & doc work Modified: twiki/branches/DEVELOP/data/TWiki/TWikiInstallationGuide.txt =================================================================== --- twiki/branches/DEVELOP/data/TWiki/TWikiInstallationGuide.txt 2006-01-30 04:31:42 UTC (rev 8587) +++ twiki/branches/DEVELOP/data/TWiki/TWikiInstallationGuide.txt 2006-01-30 08:01:29 UTC (rev 8588) @@ -3,11 +3,11 @@ %STARTINCLUDE% ---# TWiki Installation Guide -Please review the AdminSkillsAssumptions before you install TWiki. +_Installation instructions for the TWiki 4.0 production release._ -TWiki should be fine with any web server and OS that meet the [[TWikiSystemRequirements][system requirements]]. See the cookbooks list at TWiki:Codev.CategoryCookbook for guidance for your particular platform. +TWiki should be fine with any web server and OS that meet the [[TWikiSystemRequirements][system requirements]]. The following installation instructions are written for experienced system administrators; please review the AdminSkillsAssumptions before you install TWiki. If you need help, ask a question in the TWiki:Support web or on TWiki:Codev.TWikiIRC (irc.freenode.net, channel #twiki) -If you need help, ask a question in the TWiki:Support web or on TWiki:Codev.TWikiIRC (irc.freenode.net, channel #twiki) +__%H% Hint:__ TWiki:TWiki.InstallingTWiki on TWiki.org has supplemental documentation that help you install TWiki on different platforms, environments and web hosting sites. #StandardInstallation ---++ Basic Installation @@ -48,17 +48,10 @@ * *Install Plugins* if needed - TWiki:Plugins is an extensive library of Plugins for TWiki, that enhance functionality in a huge number of ways. A few Plugins are pre-installed in the TWiki distribution. Installation instructions for the other Plugins can be found in the Plugin topics on [[TWiki:Plugins][TWiki.org]]. ---++ Troubleshooting -The first step is to re-run the =configure= script and make sure you have resolved all errors, and are happy that you understand any warnings. + * The first step is to re-run the =configure= script and make sure you have resolved all errors, and are happy that you understand any warnings. + * TWiki:TWiki.InstallingTWiki on TWiki.org has supplemental documentation that help you install TWiki on different platforms, environments and web hosting sites. + * If you need help, ask a question in the TWiki:Support web or on TWiki:Codev.TWikiIRC (irc.freenode.net, channel #twiki) -Failing that, please check the topics listed below, they include some important tips for HP-UX, Solaris, OS/390, and many other platforms. - * For Unix or Linux, check TWiki:Codev/TWikiOnUnix and TWiki:Codev/TWikiOnLinux. - * For Windows, check the TWiki:Codev/WindowsInstallCookbook. - * For <nop>MacOS X, check TWiki:Codev/TWikiOnMacOSX. - * To install TWiki on <nop>SourceForge, for use on a software development project, read TWiki:Codev/TWikiOnSourceForge - * For other platforms, see TWiki:Codev/TWikiOn, and search the TWiki:Codev and TWiki:Support webs for other installation notes. - -If you need help, ask a question in the TWiki:Support web or on TWiki:Codev.TWikiIRC (irc.freenode.net, channel #twiki) - %STOPINCLUDE% -__Related Topics:__ AdminDocumentationCategory +__Related Topics:__ AdminDocumentationCategory, TWiki:TWiki.InstallingTWiki Modified: twiki/branches/DEVELOP/data/TWiki/TWikiUpgradeGuide.txt =================================================================== --- twiki/branches/DEVELOP/data/TWiki/TWikiUpgradeGuide.txt 2006-01-30 04:31:42 UTC (rev 8587) +++ twiki/branches/DEVELOP/data/TWiki/TWikiUpgradeGuide.txt 2006-01-30 08:01:29 UTC (rev 8588) @@ -13,7 +13,7 @@ * Please review the AdminSkillsAssumptions before you upgrade TWiki * Review TWiki:Codev.TWikiUpgradeTo04x00x00 for latest information and experience notes. - * To upgrade from a release prior to TWiki Release 01-Sep-2004, start with TWiki:TWiki.UpgradingTWiki + * To upgrade from a release prior to TWiki Release 01-Sep-2004, start with TWiki:TWiki.UpgradingTWiki on TWiki.org * To upgrade from a standard TWiki Release 01-Sep-2004 to the latest TWiki-4.0.0 Production Release, follow the instructions below * Once the upgrade has been applied, an existing earlier installation will still be able to read all the topics, but should not be used to write. Make sure you take a backup! * Not all Plugins written for TWiki Release 01-Sep-2004 are fully supported with Dakar. Make sure the Plugins you use can be upgraded as well! @@ -75,7 +75,7 @@ * You could also use softlinks to link the web directories in data and pub to the old installation area 1 Examine your old TWiki.cfg, and for each local setting, set the corresponding value in the =configure= interface for the new install. * If you can't use =configure=, then copy the *new* =TWiki.cfg= to =LocalSite.cfg=, and edit =LocalSite.cfg=. Remove all the settings that you didn't change in your previous install, and change the remaining settings to the values from your *old* TWiki.cfg. - 1 Transfer any local settings from [[%TWIKIWEB%.TWikiPreferences]] to the topic pointed at by {LocalSitePreferences} ([[%LOCALSITEPREFS%]]). This avoids having to write over files in the distribution. + 1 Transfer any customized and local settings from [[%TWIKIWEB%.TWikiPreferences]] to the topic pointed at by {LocalSitePreferences} ([[%LOCALSITEPREFS%]]). This avoids having to write over files in the distribution. 1 If you changed any of the topics in the original TWiki distribution, you will have to transfer your changes to the new install manually. There is no simple way to do this, though the following procedure may help: 1 Install a copy of the original TWiki release you were using in a temporary directory 1 Use 'diff' to find changed files, and transfer the changes into the new Dakar install. Modified: twiki/branches/DEVELOP/data/TWiki/TWikiUserAuthentication.txt =================================================================== --- twiki/branches/DEVELOP/data/TWiki/TWikiUserAuthentication.txt 2006-01-30 04:31:42 UTC (rev 8587) +++ twiki/branches/DEVELOP/data/TWiki/TWikiUserAuthentication.txt 2006-01-30 08:01:29 UTC (rev 8588) @@ -40,6 +40,8 @@ Does exactly what it says on the tin. Forget about authentication to make your site completely public - anyone can browse and edit freely, in classic Wiki style. All visitors are given the %MAINWEB%.TWikiGuest default identity, so you can't track individual user activity. +__%X% Note:__ This setup is not recommended on public websites for security reasons; anyone would be able to change system settings and perform tasks usually restricted to the %MAINWEB%.TWikiAdminGroup. + ---+++ Template Login Template Login asks for a username and password in a web page, and processes them using whatever Password Manager you choose. Users can log in and log out. @@ -51,7 +53,7 @@ 1 Register yourself in the TWikiRegistration topic. <br /> %H% Check that the password manager recongises the new user. If you are using =.htpasswd= files, check that a new line with the username and encrypted password is added to the =.htpasswd= file. If not, you probably got a path wrong, or the permissions may not allow the webserver user to write to that file. 1 Create a new topic to check if authentication works. - 1 *Edit the %MAINWEB%.TWikiAdminGroup topic in the TWiki:%MAINWEB% web to include users with system administrator status.* + 1 *Edit the %MAINWEB%.TWikiAdminGroup topic in the %MAINWEB% web to include users with system administrator status.* <br /> %X% *This is a very important step*, as users in this group can access _all_ topics, independent of TWiki access controls. TWikiAccessControl has more information on setting up access controls. @@ -68,7 +70,7 @@ The advantage of this scheme is that if you have an existing website authentication scheme using Apache modules such as =mod_auth_ldap= or =mod_auth_mysql= you can just plug in directly to them. -The disadvantage is that because the user identity is cached in the browser, you can log in, but you can't log out again. +The disadvantage is that because the user identity is cached in the browser, you can log in, but you can't log out again unless you restart the browser. TWiki maps the =REMOTE_USER= that was used to log in to the webserver to a WikiName using the table in %MAINWEB%.TWikiUsers. This table is updated whenever a user registers, so users can choose not to register (in which case their webserver login name is used for their signature) or register (in which case that login name is mapped to their WikiName). @@ -85,7 +87,7 @@ 1 Register yourself in the TWikiRegistration topic. <br /> %H% Check that a new line with the username and encrypted password is added to the =.htpasswd= file. If not, you may have got a path wrong, or the permissions may not allow the webserver user to write to that file. 1 Create a new topic to check if authentication works. - 1 *Edit the %MAINWEB%.TWikiAdminGroup topic in the TWiki:%MAINWEB% web to include users with system administrator status.* + 1 *Edit the %MAINWEB%.TWikiAdminGroup topic in the %MAINWEB% web to include users with system administrator status.* <br /> %X% *This is a very important step*, as users in this group can access _all_ topics, independent of TWiki access controls. TWikiAccessControl has more information on setting up access controls. @@ -132,9 +134,8 @@ TWiki can automatically map an Intranet (Login) Username to a TWiki Username if the {AllowLoginName} is enabled in =configure=. The default is to use your WikiName as a login name. <blockquote> -__NOTE:__ *To correctly enter a WikiName* - your own or someone else's - be sure to include the %MAINWEB% web name in front of the Wiki username, followed by a period, and no spaces. Ex: -<div align="center"> ==%MAINWEB%.<nop>WikiUsername== or ==%<nop>MAINWEB%.<nop>WikiUsername== </div> -This points ==<nop>WikiUser== to the %MAINWEB% web, where user registration pages are stored, no matter which web it's entered in. Without the web prefix, the name appears as a NewTopic everywhere but in the %MAINWEB% web. +__NOTE:__ *To correctly enter a WikiName* - your own or someone else's - be sure to include the %MAINWEB% web name in front of the Wiki username, followed by a period, and no spaces, for example ==%MAINWEB%.<nop>WikiUsername== or ==%<nop>MAINWEB%.<nop>WikiUsername==. +This points ==<nop>WikiUsername== to the %MAINWEB% web, where user home pages are located, no matter which web it's entered in. Without the web prefix, the name appears as a NewTopic everywhere but in the %MAINWEB% web. </blockquote> #ChangingPasswords |