]> git.wh0rd.org - tt-rss.git/blame - README
bugfix: catchupAllFeeds was broken in iframe transition
[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
5a4ef316 16Uses Prototype javascript library, from http://prototype.conio.net/
ed313cde 17Uses FeedCreator library, from http://www.bitfolge.de/rsscreator-en.html
5a4ef316 18
ed313cde 19Tiny Tiny RSS is licensed under GNU GPL version 2
8983d995
AD
20
21Features Overview
22=================
23
24 Updates: http://tt-rss.spb.ru/trac/wiki/FeatureList
25
26 * Server-side application, user only needs a web browser
27 * Supports RSS, RDF, Atom feeds using Magpie library
28 * Supports OPML import/export
29 * Easy setup and configuration
30 * Streamlined interface using XmlHttpRequest (or AJAX for laypeople)
31
32Requirements
33============
34
35 * Compatible browser on the client side
36
37 Basically, Firefox, Konqueror or MSIE6 are okay. See here
38 for more information:
39
40 http://tt-rss.spb.ru/trac/wiki/CompatibleBrowsers
41
42 * Web server, for example Apache
43 * PHP (requires PHP4 DOMXML extension)
44 * MagpieRSS feed parser (http://magpierss.sourceforge.net/)
45
46 * PostgreSQL (tested on 7.4) or MySQL (InnoDB and version 4.1+ required)
47
1205abd0
AD
48 * XML-RPC for PHP library for XML-RPC support. Optional.
49
50 http://phpxmlrpc.sourceforge.net
51
8983d995
AD
52Installation Notes
53==================
54
55 Updates: http://tt-rss.spb.ru/trac/wiki/InstallationNotes
56
57 * If you are upgrading from the previous version, don't forget to update
58 schema and logout.
59
60 * icons directory should be writable to your httpd user if you plan on
61 using feed icons
62
63 * Leave DB_HOST empty if you want to connect to database via unix socket
64
65 * For PostgreSQL don't forget to create database with UTF-8 encoding
66
67 createdb -E utf-8 -O owner_user database)
68
69 * Don't forget to change your password from default value on your first login
70
71 * Check your config.php for blank lines out of PHP code tags (e.g.
72 before <? and after ?>), See #1
73
c017149c
AD
74 * Default username:password for multiuser mode is admin:password.
75
8983d995
AD
76See also
77========
78
79 * FAQ: http://tt-rss.spb.ru/trac/wiki/FrequentlyAskedQuestions
80 * Forum: http://tt-rss.spb.ru/forum
81 * Wiki: http://tt-rss.spb.ru/trac/wiki/WikiStart
82 * Bug Tracker: http://tt-rss.spb.ru/trac/report
83
84Contact
85=======
78800912 86
1945c416 87Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com>