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