"Fossies" - the Fresh Open Source Software Archive

Member "betterawstats/docs/install.drupal.txt" (16 Mar 2008, 5437 Bytes) of package /linux/www/old/betterawstats-1.0.zip:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 CONTENTS OF THIS FILE
    2 ---------------------
    3 
    4  * Requirements
    5  * Installation
    6  * Configuration
    7  * Customising which statistics to display
    8 
    9 REQUIREMENTS
   10 ------------
   11 
   12 BAWstats (betterAWstats as a Drupal module) requires Drupal 6 (from
   13 beta 1 on) and betterAWstats (beta 1).  No other Drupal modules are
   14 required.
   15 
   16 A working AWstats system is needed with access to the AWstats data,
   17 however, AWstats does not have to be operating as a CGI.
   18 
   19 Administration privileges within Drupal are required to install the
   20 module. For viewing statistics from multiple sites (in addition to the
   21 default installed site) the ability to edit the Drupal site's
   22 settings.php file is required.
   23 
   24 
   25 INSTALLATION
   26 ------------
   27 
   28 1. You can obtain the latest code for betterAWstats either from
   29 tokyoahead.com or from the Drupal module repository.
   30 
   31 2. Unzip (or Untar) the betterAWstats source under the chosen module
   32 directory (e.g. sites/all/modules or under the modules directory of a
   33 specific site).
   34 
   35 3. As betterAWstats is designed as a stand alone CGI there are two
   36 main requirements for converting it into a safe Drupal only module.
   37 
   38 * Firstly, rename the directory from "betterawstats" to "bawstats"
   39 (the Drupal module name).
   40 
   41 * Secondly, remove or set permissions to unreadable the index.php file
   42 that is the main CGI component of betterAWstats.  This prevents the
   43 CGI component being run when you are using the code as a Drupal model.
   44 The BAWstats module itself does not need this file.
   45 
   46 4.  At this point the module should appear in the Drupal admin modules
   47 page (the Drupal path /admin/build/modules).  It can be activated in
   48 the usual Drupal way.
   49 
   50 
   51 CONFIGURATION
   52 -------------
   53 
   54 Before the BAWstats Drupal module can access the AWstats data, the
   55 locations of the key AWstats directories must be configured.  Once the
   56 BAWstats module is installed, it can be configured within the Drupal
   57 administration pages (Drupal path /admin/settings/bawstats).
   58 
   59 The module will not work without the correct locations of the four
   60 required AWstats paths:
   61 
   62 * AWstats data directory
   63   The directory containing the core AWstats data.  Within the AWstats
   64 configuration it is the directory specified by the "DirData"
   65 parameter.  The data must be accessible by php.
   66 
   67 * AWstats library directory
   68   In the top level of a default AWstats install, this is the directory
   69 wwwroot/cgi-bin/lib.  It's contents must be accessible by php.
   70 
   71 * AWstats language directory
   72   In the top level of a default AWstats install, this is the directory
   73 wwwroot/cgi-bin/lang.  Again it must be accessible by php.
   74 
   75 * AWstats icon directory
   76   In the top level of a default AWstats install, this is the directory
   77 wwwroot/icon.  IMPORTANT: This must be copied into the bawstats module
   78 directory - e.g. copy the "icon" directory and all its contents into
   79 the bawstats module directory.  NOTE, the "icon" directory is not the
   80 same as the betterAWstats "icons" directory.
   81 This is needed as the icons are referenced as URLs within the Drupal
   82 tree.  The default value for this configuration option assumes the
   83 icon directory has been copied.
   84 
   85 Once configured correctly, betterAWstats statistics can be viewed in the
   86 Drupal admin location admin/bawstats.
   87 
   88 
   89 CUSTOMISING WHICH STATISTICS TO DISPLAY
   90 ---------------------------------------
   91 
   92 AWstats can be configured to collect and store statistics for multiple
   93 sites in it's data directory.
   94 
   95 For privacy reasons, the BAWstats module will present and display
   96 statistics only for the domain name of the site it is running in Drupal
   97 under.  For example, if the BAWstats module is running on the Drupal
   98 website http://www.example.com the module will look for AWstats data
   99 files for "example.com" (AWstats drops the "www" by default).
  100 
  101 If this is incorrect, for example, you wish the BAWstats module
  102 running on site http://www.example.com to display some other AWstats
  103 statistics (say, stats for another site, http://www.myexample.com),
  104 the default can be overridden by editing the Drupal settings.php file
  105 belonging to the www.example.com site. In the settings.php file, the
  106 $conf['bawstats_defsite'] variable can be set to the site from which
  107 to collect and display AWstats statistics.  For example:
  108 
  109 $conf['bawstats_defsite'] = 'myexample.com';
  110 
  111 would configure the bawstats module to look for and display AWstats
  112 data for the domain myexample.com.
  113 
  114 The reason this is not made configurable with the other configuration
  115 settings above (i.e. via the Drupal admin pages) is that it may be
  116 deemed inappropriate that site administrators for one site can configure
  117 BAWstats to look at statistics for other sites.
  118 
  119 One of the nice features of betterAWstats is its ability to show
  120 statistics from multiple sites.  This is available in the Drupal
  121 module, again, by editing the settings.php of the Drupal site for
  122 which you want bawstats to have this ability.  Adding the following to
  123 a settings.php file will allow bawstats to view ALL statistics
  124 available in the AWstats data directory:
  125 
  126 $conf['bawstats_admin_access'] = 1;
  127 
  128 
  129 OTHER CUSTOMISATION
  130 -------------------
  131 
  132 Other configurations to the display of data can be made by directly
  133 editing the betterAWstats config.php.
  134 
  135 
  136 NOTICE
  137 -------
  138 
  139 This module uses one non-drupal CGI to render the world map of domain locations.
  140 No data is revealed from this CGI (as it simply builds the map image from the
  141 data it is given), but if this causes concern, it can be disabled by removing
  142 access to the file modules/render_map.inc.php