]> git.wh0rd.org - tt-rss.git/blob - README
5aa84c53b5463edc96b93f40df174efe163a4c83
[tt-rss.git] / README
1 Tiny Tiny RSS
2 =============
3
4 Web-based news feed aggregator, designed to allow you to read news from
5 any location, while feeling as close to a real desktop application as possible.
6
7 Copyright (C) 2005 Andrew Dolgov unless stated otherwise.
8
9 Portions (C):
10
11 Bob Osola <bobosola@gmail.com> (pngfix.js)
12 Sundar Dorai-Raj <sdoraira@vt.edu> (isNumeric() in functions.js)
13
14 Licensed under GPL version 2.
15
16 Warning: I don't know how to stress it enough - please do not install
17 this program wide open to the whole internet. It belongs to (host or password)
18 protected directory on your webserver. There could be SQL-injection or other
19 remote vulnerabilities, so beware.
20
21 Version 1.1 adds support for multi-user operation, disable option SINGLE_USER_MODE
22 to access it. Default user is "admin" with password "password", don't forget to
23 change it.
24
25 Interface:
26
27 There is (incomplete) support for keyboard navigation.
28
29 "n" and "p" moves between next/previous posts when feed is opened;
30 "r" refreshes feed list;
31 "u" refreshes currently selected feed;
32 "a" hides or shows only unread feeds in the feedlist;
33
34 Requirements:
35
36 - Magpie RSS (http://magpierss.sourceforge.net/) - place it into
37 magpierss/ subdirectory;
38
39 - RDBMS backend:
40
41 a) PostgreSQL
42
43 b) MySQL (InnoDB and server version 4.1+ required)
44
45 Example DB schemas and configuration are in schema/ subdirectory.
46
47 For PostgreSQL don't forget to create database with UTF-8 encoding
48 (createdb -E UTF-8 -O owner_user database).
49
50 Don't forget to copy config.php-dist to config.php and edit it.
51
52 icons/ directory should be writable for your httpd user.
53
54 Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com>