]> git.wh0rd.org - tt-rss.git/blob - README
selectTableRowsByIdPrefix now checks required checkboxes
[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 Version 1.1 adds experimental support for multi-user operation, disable option
16 SINGLE_USER_MODE to access it. Default user is "admin" with password "password",
17 don't forget to change it.
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;
24 "r" refreshes feed list;
25 "u" refreshes currently selected feed;
26 "a" hides or shows only unread feeds in the feedlist;
27
28 Requirements:
29
30 - Magpie RSS (http://magpierss.sourceforge.net/) - place it into
31 magpierss/ subdirectory;
32
33 - RDBMS backend:
34
35 a) PostgreSQL
36
37 b) MySQL (InnoDB and server version 4.1+ required)
38
39 Example DB schemas and configuration are in schema/ subdirectory.
40
41 For PostgreSQL don't forget to create database with UTF-8 encoding
42 (createdb -E UTF-8 -O owner_user database).
43
44 Don't forget to copy config.php-dist to config.php and edit it.
45
46 icons/ directory should be writable for your httpd user.
47
48 Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com>