]> git.wh0rd.org - tt-rss.git/blob - README
TAG 1.0.6
[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 http://tt-rss.spb.ru
8
9 Copyright (C) 2005 Andrew Dolgov unless stated otherwise.
10
11 Portions (C):
12
13 Bob Osola <bobosola@gmail.com> (pngfix.js)
14 Sundar Dorai-Raj <sdoraira@vt.edu> (isNumeric() in functions.js)
15
16 Licensed under GNU GPL version 2
17
18 Features Overview
19 =================
20
21 Updates: http://tt-rss.spb.ru/trac/wiki/FeatureList
22
23 * Server-side application, user only needs a web browser
24 * Supports RSS, RDF, Atom feeds using Magpie library
25 * Supports OPML import/export
26 * Easy setup and configuration
27 * Streamlined interface using XmlHttpRequest (or AJAX for laypeople)
28
29 Requirements
30 ============
31
32 * Compatible browser on the client side
33
34 Basically, Firefox, Konqueror or MSIE6 are okay. See here
35 for more information:
36
37 http://tt-rss.spb.ru/trac/wiki/CompatibleBrowsers
38
39 * Web server, for example Apache
40 * PHP (requires PHP4 DOMXML extension)
41 * MagpieRSS feed parser (http://magpierss.sourceforge.net/)
42
43 * PostgreSQL (tested on 7.4) or MySQL (InnoDB and version 4.1+ required)
44
45 Installation Notes
46 ==================
47
48 Updates: http://tt-rss.spb.ru/trac/wiki/InstallationNotes
49
50 * If you are upgrading from the previous version, don't forget to update
51 schema and logout.
52
53 * icons directory should be writable to your httpd user if you plan on
54 using feed icons
55
56 * Leave DB_HOST empty if you want to connect to database via unix socket
57
58 * For PostgreSQL don't forget to create database with UTF-8 encoding
59
60 createdb -E utf-8 -O owner_user database)
61
62 * Don't forget to change your password from default value on your first login
63
64 * Check your config.php for blank lines out of PHP code tags (e.g.
65 before <? and after ?>), See #1
66
67 See also
68 ========
69
70 * FAQ: http://tt-rss.spb.ru/trac/wiki/FrequentlyAskedQuestions
71 * Forum: http://tt-rss.spb.ru/forum
72 * Wiki: http://tt-rss.spb.ru/trac/wiki/WikiStart
73 * Bug Tracker: http://tt-rss.spb.ru/trac/report
74
75 Contact
76 =======
77
78 Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com>