X-Git-Url: https://code.th-h.de/?p=usenet%2Fnewsstats.git;a=blobdiff_plain;f=doc%2FINSTALL;h=307ec0e9f458fca0bea36f268da1ef4807fdd10d;hp=225fdbf4b3f04ce57070b4625c73cfe0155eb724;hb=91c674c4fe8136657b3bfc5c862e0c096ea2dd87;hpb=610b5ef4928b81ab4eecbcdf2ac38197614f0953 diff --git a/doc/INSTALL b/doc/INSTALL index 225fdbf..307ec0e 100644 --- a/doc/INSTALL +++ b/doc/INSTALL @@ -1,7 +1,7 @@ -NewsStats 0.1 (c) 2010 Thomas Hochstein +NewsStats 0.1 (c) 2010-2013 Thomas Hochstein -NewsStats is a software package for gathering statistical data live -from a Usenet feed and subsequent examination. +NewsStats is a software package used to gather statistical information +from a live Usenet feed and for its subsequent examination. This script package is free software; you can redistribute it and/or modify it under the terms of the GNU Public License as published by @@ -20,28 +20,29 @@ INSTALLATION INSTRUCTIONS # tar -xzf newsstats-nn.tar.gz - Scripts in this path should be executable by the news user. + Scripts in this path - at least feedlog.pl - should be executable by the + news user. 2) Configuration * Copy the sample configuration file newsstats.conf.sample to newsstats.conf and modify it for your purposes: - # cp newsstats.conf.sample newsstats.conf - # vim newsstats.conf + # cp etc/newsstats.conf.sample etc/newsstats.conf + # vim etc/newsstats.conf a) Mandatory configuration options * DBDriver = mysql Database driver used; currently only mysql is supported. - + * DBHost = localhost The host your mysql server is running on. * DBUser = The username to connect to the database server. - * DBPw = + * DBPw = Matching password for your username. * DBDatabase = newsstats @@ -60,17 +61,17 @@ INSTALLATION INSTRUCTIONS * TLH = de Limit examination to that top-level hierarchy. - + 3) Database (mysql) setup * Setup your database server with a username, password and database matching the NewsStats configuration (see 2 a). * Start the installation script: - + # install/install.pl - It will setup the necessary database tables and display some + It will setup the necessary database tables and display some information on the next steps. 4) Feed (INN) setup @@ -80,8 +81,8 @@ INSTALLATION INSTRUCTIONS * Edit your 'newsfeeds' file and insert something like ## gather statistics for NewsStats - newsstats! - :!*,de.* + newsstats!\ + :!*,de.*\ :Tc,WmtfbsPNH,Ac:/path/to/feedlog.pl * You should only feed that hierarchy (those hierarchies ...) to @@ -109,7 +110,7 @@ INSTALLATION INSTRUCTIONS Everything should be going smoothly now. * If INN is spewing error messages to 'errlog' or reporting - continous respaws of feedlog.pl to 'news.notice', stop your feed: + continous respawns of feedlog.pl to 'news.notice', stop your feed: # ctlinnd drop 'newsstats!'