git.wh0rd.org / tt-rss.git / blame
| Commit | Line | Data |
|---|---|---|
| 1945c416 AD |
1 | Tiny Tiny RSS |
| 2 | ============= | |
| 3 | ||
| fbd94c53 AD |
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. | |
| 1945c416 | 6 | |
| 8983d995 | 7 | http://tt-rss.spb.ru |
| 09165533 | 8 | |
| fbd94c53 AD |
9 | Copyright (C) 2005 Andrew Dolgov unless stated otherwise. |
| 10 | ||
| b2e9654e | 11 | Portions (C): |
| fbd94c53 AD |
12 | |
| 13 | Bob Osola <bobosola@gmail.com> (pngfix.js) | |
| 14 | Sundar Dorai-Raj <sdoraira@vt.edu> (isNumeric() in functions.js) | |
| a8931123 | 15 | Sean M. Burke. <sburke@cpan.org> (xsl_mop-up.js) |
| b2e9654e | 16 | |
| c4587ce3 AD |
17 | Other bundled libraries: |
| 18 | ||
| 19 | Prototype javascript library, from http://prototype.conio.net/ | |
| 20 | Script.aculo.us javascript library, http://http://script.aculo.us/ | |
| 21 | MagpieRSS feed parser, http://magpierss.sourceforge.net/ | |
| 22 | SimplePie feed parser, http://simplepie.org/ | |
| a8931123 | 23 | PHPMailer class, http://phpmailer.sourceforge.net/ |
| 5a4ef316 | 24 | |
| 3baeeeca | 25 | Licensed under GNU GPL version 2 |
| 8983d995 AD |
26 | |
| 27 | Features Overview | |
| 28 | ================= | |
| 29 | ||
| 30 | Updates: http://tt-rss.spb.ru/trac/wiki/FeatureList | |
| 31 | ||
| 32 | * Server-side application, user only needs a web browser | |
| 52cc33a0 | 33 | * Supports RSS, RDF, Atom feeds using Magpie or SimplePie library |
| 8983d995 AD |
34 | * Supports OPML import/export |
| 35 | * Easy setup and configuration | |
| 36 | * Streamlined interface using XmlHttpRequest (or AJAX for laypeople) | |
| 37 | ||
| 38 | Requirements | |
| 39 | ============ | |
| 40 | ||
| 41 | * Compatible browser on the client side | |
| 42 | ||
| 43 | Basically, Firefox, Konqueror or MSIE6 are okay. See here | |
| 44 | for more information: | |
| 45 | ||
| 46 | http://tt-rss.spb.ru/trac/wiki/CompatibleBrowsers | |
| 47 | ||
| 48 | * Web server, for example Apache | |
| 49 | * PHP (requires PHP4 DOMXML extension) | |
| 8983d995 AD |
50 | * PostgreSQL (tested on 7.4) or MySQL (InnoDB and version 4.1+ required) |
| 51 | ||
| 1205abd0 AD |
52 | * XML-RPC for PHP library for XML-RPC support. Optional. |
| 53 | ||
| 54 | http://phpxmlrpc.sourceforge.net | |
| 55 | ||
| 8983d995 AD |
56 | Installation Notes |
| 57 | ================== | |
| 58 | ||
| 59 | Updates: http://tt-rss.spb.ru/trac/wiki/InstallationNotes | |
| 60 | ||
| 61 | * If you are upgrading from the previous version, don't forget to update | |
| 62 | schema and logout. | |
| 63 | ||
| 64 | * icons directory should be writable to your httpd user if you plan on | |
| 65 | using feed icons | |
| 66 | ||
| 67 | * Leave DB_HOST empty if you want to connect to database via unix socket | |
| 68 | ||
| 69 | * For PostgreSQL don't forget to create database with UTF-8 encoding | |
| 70 | ||
| 71 | createdb -E utf-8 -O owner_user database) | |
| 72 | ||
| 73 | * Don't forget to change your password from default value on your first login | |
| 74 | ||
| 75 | * Check your config.php for blank lines out of PHP code tags (e.g. | |
| 76 | before <? and after ?>), See #1 | |
| 77 | ||
| c017149c AD |
78 | * Default username:password for multiuser mode is admin:password. |
| 79 | ||
| 8983d995 AD |
80 | See also |
| 81 | ======== | |
| 82 | ||
| 83 | * FAQ: http://tt-rss.spb.ru/trac/wiki/FrequentlyAskedQuestions | |
| 84 | * Forum: http://tt-rss.spb.ru/forum | |
| 85 | * Wiki: http://tt-rss.spb.ru/trac/wiki/WikiStart | |
| 86 | * Bug Tracker: http://tt-rss.spb.ru/trac/report | |
| 87 | ||
| 88 | Contact | |
| 89 | ======= | |
| 78800912 | 90 | |
| 1f8361c4 | 91 | Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com> |