doc/INSTALL

   1 NewsStats 0.1  (c) 2010-2013 Thomas Hochstein <thh@inter.net>
   2
   3 NewsStats is a software package used to gather statistical information
   4 from a live Usenet feed and for its subsequent examination.
   5
   6 This script package is free software; you can redistribute it and/or
   7 modify it under the terms of the GNU Public License as published by
   8 the Free Software Foundation.
   9
  10 ---------------------------------------------------------------------
  11
  12 INSTALLATION INSTRUCTIONS
  13
  14 1) Install the scripts
  15
  16    * Download the current version of NewsStats from
  17      <http://th-h.de/download/scripts.php>.
  18
  19    * Untar it into a directory of your choice:
  20
  21      # tar -xzf newsstats-nn.tar.gz
  22
  23      Scripts in this path - at least feedlog.pl - should be executable by the
  24      news user.
  25
  26 2) Configuration
  27
  28    * Copy the sample configuration file newsstats.conf.sample to
  29      newsstats.conf and modify it for your purposes:
  30
  31      # cp newsstats.conf.sample newsstats.conf
  32      # vim newsstats.conf
  33
  34    a) Mandatory configuration options
  35
  36    * DBDriver = mysql
  37      Database driver used; currently only mysql is supported.
  38
  39    * DBHost = localhost
  40      The host your mysql server is running on.
  41
  42    * DBUser =
  43      The username to connect to the database server.
  44
  45    * DBPw =
  46      Matching password for your username.
  47
  48    * DBDatabase = newsstats
  49      Database name.
  50
  51    NewsStats will use those credentials to connect to your mysql
  52    installation.
  53
  54    * DBTableRaw = raw_de
  55      Table holding raw statistical data.
  56
  57    * DBTableGrps = groups_de
  58      Table holding data on postings per group.
  59
  60    b) Optional configuration options
  61
  62    * TLH = de
  63      Limit examination to that top-level hierarchy.
  64
  65 3) Database (mysql) setup
  66
  67    * Setup your database server with a username, password and
  68      database matching the NewsStats configuration (see 2 a).
  69
  70    * Start the installation script:
  71
  72      # install/install.pl
  73
  74      It will setup the necessary database tables and display some
  75      information on the next steps.
  76
  77 4) Feed (INN) setup
  78
  79    You have to setup an INN feed to feedlog.pl.
  80
  81    * Edit your 'newsfeeds' file and insert something like
  82
  83      ## gather statistics for NewsStats
  84      newsstats!\
  85              :!*,de.*\
  86              :Tc,WmtfbsPNH,Ac:/path/to/feedlog.pl
  87
  88    * You should only feed that hierarchy (those hierarchies ...) to
  89      feedlog.pl you'll want to cover with your statistical
  90      examination. It may be a good idea to setup different feeds (to
  91      different databases ...) for different hierarchies.
  92
  93    * Please double check that your path to feedlog.pl is correct and
  94      feedlog.pl can be executed by the news user
  95
  96    * Check your 'newsfeeds' syntax:
  97
  98      # ctlinnd checkfile
  99
 100    * Reload 'newsfeeds':
 101
 102      # ctlinnd reload newsfeeds 'Adding newsstats! feed'
 103
 104    * Watch your 'news.notice' and 'errlog' files:
 105
 106      # tail -f /var/log/news/news.notice
 107      ...
 108      # tail -f /var/log/news/errlog
 109
 110    Everything should be going smoothly now.
 111
 112    * If INN is spewing error messages to 'errlog' or reporting
 113      continous respawns of feedlog.pl to 'news.notice', stop your feed:
 114
 115      # ctlinnd drop 'newsstats!'
 116
 117      and investigate. 'errlog' may be helpful here.
 118
 119    * You can restart the feed with
 120
 121      # ctlinnd begin 'newsstats!'
 122
 123      later.
 124
 125 You should be done now.
 126
 127 Just have a look at your raw data (DBTableRaw). It should now start to
 128 fill up.
 129