]> git.wh0rd.org - tt-rss.git/blob - README
more work on tag support
[tt-rss.git] / README
1 Tiny Tiny RSS
2 =============
3
4 Server-side RSS feed aggregator written in PHP and heavily based
5 on XmlHttpRequest and related technologies for user interface and
6 operation.
7
8 Licensed under GPL version 2.
9
10 Warning: I don't know how to stress it enough - please do not install
11 this program wide open to the whole internet. It belongs to (host or password)
12 protected directory on your webserver. There could be SQL-injection or other
13 remote vulnerabilities, so beware.
14
15 Also, TT-rss at present is not multi-user. It is designed for one person to
16 read news consistently from different locations, one location at a time. Otherwise,
17 last-read information will get messed up and other bad stuff could happen.
18
19 Interface:
20
21 There is (incomplete) support for keyboard navigation.
22
23 "n" and "p" moves between next/previous posts when feed is opened, switching
24 pages as needed.
25
26 "r" refreshes feed list
27
28 "u" refreshes currently selected feed
29
30 Requirements:
31
32 - Magpie RSS (http://magpierss.sourceforge.net/) - place it into
33 magpierss/ subdirectory;
34
35 - RDBMS backend:
36
37 a) PostgreSQL
38
39 b) MySQL (InnoDB and server version 4.1+ required)
40
41 Example DB schemas and configuration are in schema/ subdirectory.
42
43 For PostgreSQL don't forget to create database with UTF-8 encoding
44 (createdb -E UTF-8 -O owner_user database).
45
46 Don't forget to copy config.php-dist to config.php and edit it.
47
48 icons/ directory should be writable for your httpd user.
49
50 Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com>