]> git.wh0rd.org - tt-rss.git/blame - README
create filter dialog uses prototype
[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
8983d995 7 http://tt-rss.spb.ru
09165533 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
8983d995
AD
16Licensed under GNU GPL version 2
17
18Features 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
29Requirements
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
1205abd0
AD
45 * XML-RPC for PHP library for XML-RPC support. Optional.
46
47 http://phpxmlrpc.sourceforge.net
48
8983d995
AD
49Installation Notes
50==================
51
52 Updates: http://tt-rss.spb.ru/trac/wiki/InstallationNotes
53
54 * If you are upgrading from the previous version, don't forget to update
55 schema and logout.
56
57 * icons directory should be writable to your httpd user if you plan on
58 using feed icons
59
60 * Leave DB_HOST empty if you want to connect to database via unix socket
61
62 * For PostgreSQL don't forget to create database with UTF-8 encoding
63
64 createdb -E utf-8 -O owner_user database)
65
66 * Don't forget to change your password from default value on your first login
67
68 * Check your config.php for blank lines out of PHP code tags (e.g.
69 before <? and after ?>), See #1
70
71See also
72========
73
74 * FAQ: http://tt-rss.spb.ru/trac/wiki/FrequentlyAskedQuestions
75 * Forum: http://tt-rss.spb.ru/forum
76 * Wiki: http://tt-rss.spb.ru/trac/wiki/WikiStart
77 * Bug Tracker: http://tt-rss.spb.ru/trac/report
78
79Contact
80=======
78800912 81
1945c416 82Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com>