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