]> git.wh0rd.org - tt-rss.git/blame - README
TAG 1.0.3.1
[tt-rss.git] / README
CommitLineData
1945c416
AD
1Tiny Tiny RSS
2=============
3
4Server-side RSS feed aggregator written in PHP and heavily based
5on XmlHttpRequest and related technologies for user interface and
6operation.
7
8Licensed under GPL version 2.
9
a6ba8c5e
AD
10Warning: I don't know how to stress it enough - please do not install
11this program wide open to the whole internet. It belongs to (host or password)
12protected directory on your webserver. There could be SQL-injection or other
13remote vulnerabilities, so beware.
14
15Also, TT-rss at present is not multi-user. It is designed for one person to
16read news consistently from different locations, one location at a time. Otherwise,
17last-read information will get messed up and other bad stuff could happen.
1945c416 18
c3a8d71a
AD
19Interface:
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
1945c416
AD
30Requirements:
31
1945c416
AD
32 - Magpie RSS (http://magpierss.sourceforge.net/) - place it into
33 magpierss/ subdirectory;
34 - PostgreSQL (example schema and configuration in ttrss_schema.sql)
35
36Don't forget to copy config.php-dist to config.php and edit it.
37
78800912
AD
38icons/ directory should be writable for your httpd user.
39
1945c416 40Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com>