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