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