From: eldy <> Date: Sun, 1 May 2005 16:42:13 +0000 (+0000) Subject: Review of AWStats documentation X-Git-Tag: AWSTATS_WEBMIN_1_6_BETA~38 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b1ade934210c526fe8d2b363508ecf83193eb68f;p=thirdparty%2FAWStats.git Review of AWStats documentation --- diff --git a/docs/awstats_upgrade.html b/docs/awstats_upgrade.html index a63ce884..4a6335ae 100644 --- a/docs/awstats_upgrade.html +++ b/docs/awstats_upgrade.html @@ -1,7 +1,8 @@
- + @@ -9,85 +10,117 @@ - - - - -![]() |
-
+
+
Upgrading AWStats to a new version- -To upgrade AWStats from an old version to a new one, all you have to do is:- -* Check your Perl version is at least 5.005_03 (or higher). For this you can run perl -v command. - -* Replace AWStats runtime files by new ones. For this you can: - - decompress new AWStats zip or tgz package to old install directory (AWStats -old runtime files are replaced by new ones. This works whatever is the old and new version, 3.x, 4.x, 5.x, 6.x). - - or just run your OS package tool (rpm, apt, or just .exe for windows). - -* Your setup files should not be lost as AWStats default distribution should not overwite -config file (it provides only one config file example called awstats.model.conf). However -some packages are not official, so you can save and restore AWStats config files (awstats*.conf) -if you prefer. -Sometimes, there is new parameter supported by the new version. Since those parameters are not -present in old config files, AWStats will use default values for them, to work as it did when -those parameters did not exist, so there is no need to add them, except if you want to use -differently the new feature. - - -Note 0: Perl 5.005_03 or higher is a requirement to use AWStats 6.0 or higher. -Note 1: When migrating to 6.x series, if you use the ExtraSections feature, - you must check that the parameter(s) ExtraSectionConditionX use a full - REGEX syntax (with 5.x series, this parameter could contain simple string - values). If not, feature will be broken. -Note 2: When migrating to 6.x series, if you use the Misc feature, you must - check that your ShowMiscStats parameter is set to "ajdfrqwp", if you want - to have all miscellanous info reported (you must also have added the - awstats_misc_tracker.js script in your home page as described in - MiscTrackerUrl parameter description). Otherwise the new default value "a" - will be used (only the "Add to favourites" will be reported). + Upgrading +AWStats from a previous version+To upgrade AWStats, all you have +to do is:-Note 3: In 6.x series, MaxLengthOfURL parameter has been renamed into MaxLengthOfShownURL +1. Read this page completely before beginning the upgrade. -Note 4: When migrating to 6.x series, to enable the new worm detection, you must add parameter - LevelForWormsDetection=2 in your config file. +2. Optionally backup your AWStats configuration and history +data files. +Standard AWStats distributions do not change these, but +backing them up allows you to recover them if something does go +amiss. The AWStats default distribution will only overwrite the +configuration file example called awstats.model.conf. +Your +history data files are saved in the +directory defined with the DirData parameter in your AWStats +configuration file (awstats.mysite.conf). -Note 5: When migrating to 6.x series, if you used the urlalias or userinfo plugin, you must move the urlalias.*.txt -or userinfo.*.txt file from Plugins directory to DirData directory. +3. Replace AWStats runtime files with the new ones. +To do this you can: +- decompress the new AWStats zip or tgz +package over the old installation directory (old AWStats runtime files +are replaced by new ones. This works for AWStats versions 3.x and +higher). +- or just run your OS package tool (i.e. +rpm, apt for Linux, .exe for MS Windows). - - -* Your old analyzed data should not be lost since your 'history files' are saved in the -directory defined in DirData parameter in your AWStats config file and 'history files' format is -compatible with each new version of AWStats since 5.x series. If you upgrade from 3.x or 4.x -series to 5.x, 6.x or higher, AWStats will still be able to 'read' your old history files but -a warning will appear to ask you to run the 'migrate' process on your old data files. +Migrating to 6.x versions from earlier versions, observe the following additional notes: +i. As of AWStats 6.0+, Perl version is 5.005_03 or +higher is required. To see the version number, run the command perl +-v +from your operating system's command line. +ii. If you use the ExtraSections feature, you +must check that the parameter(s) ExtraSectionConditionX uses a full +REGEX syntax (with the 5.x series, this parameter could contain simple +string values). If you don't update your configuration, the feature +will be broken. + +iii. If you use the MiscTrackerUrl +feature, you must check +that your ShowMiscStats parameter is set to "ajdfrqwp" in addition to +setting up MiscTrackerUrl tags and a JavaScript include for your web +site. Otherwise the new default value "a" will be used (only the "Add +to favorites" will be reported). + +iv. The MaxLengthOfURL parameter has been renamed +MaxLengthOfShownURL; +update your configuration file accordingly. + +v. To enable the worm +detection feature (not enabled by default), you must add +the parameter LevelForWormsDetection=2 +in your configuration file. + +vi. If you use the urlalias +or userinfo plugins, you must +move the urlalias.*.txt +or userinfo.*.txt file from the Plugins directory to the DirData +directory. + + +4. Convert your AWStats history files when migrating from 3.x or +4.x +versions to 5.x or higher. +If you upgrade from the 3.x or 4.x +series to 5.x or higher, AWStats will still be able to 'read' your +old history files but +a warning may appear to ask you to run the 'migrate' process on your +old data files. Just run the command that will appear in warning message. -This warning will appear only after upgrade from 3.x or 4.x series to a 5.x, 6.x or higher -version and only if 'migrate' is necessary. +This warning will only appear if data migration is necessary after an +upgrade from the 3.x or 4.x series to a +5.x or higher +version. + +5. Review new feature default settings. +Sometimes new feature parameters are introduced in a new AWStats +version. AWStats will +use default values for them, maintaining backward compatibility with +your existing AWStats configuration. However, you can review the +"New Features / Change Log" to see how you might change the new +feature's +behavior. + - - |