git.wh0rd.org / tt-rss.git / blame
| Commit | Line | Data |
|---|---|---|
| 1945c416 AD |
1 | Tiny Tiny RSS |
| 2 | ============= | |
| 3 | ||
| 4 | Server-side RSS feed aggregator written in PHP and heavily based | |
| 5 | on XmlHttpRequest and related technologies for user interface and | |
| 6 | operation. | |
| 7 | ||
| 8 | Licensed under GPL version 2. | |
| 9 | ||
| a6ba8c5e AD |
10 | Warning: I don't know how to stress it enough - please do not install |
| 11 | this program wide open to the whole internet. It belongs to (host or password) | |
| 12 | protected directory on your webserver. There could be SQL-injection or other | |
| 13 | remote vulnerabilities, so beware. | |
| 14 | ||
| fa9b5ef9 AD |
15 | Version 1.1 adds experimental support for multi-user operation. This doesn't mean |
| 16 | that TT-RSS is suitable for large-scale open internet installations. It still | |
| 17 | continues to be personal application, just in the looser definition, e.g. not just for | |
| 18 | you, but for your friends too, who won't DOS you or try to hack in each other accounts. | |
| 19 | ||
| 1945c416 | 20 | |
| c3a8d71a AD |
21 | Interface: |
| 22 | ||
| 23 | There is (incomplete) support for keyboard navigation. | |
| fa9b5ef9 AD |
24 | |
| 25 | "n" and "p" moves between next/previous posts when feed is opened; | |
| 26 | "r" refreshes feed list; | |
| 27 | "u" refreshes currently selected feed; | |
| 28 | "a" hides or shows only unread feeds in the feedlist; | |
| c3a8d71a | 29 | |
| 1945c416 AD |
30 | Requirements: |
| 31 | ||
| 1945c416 AD |
32 | - Magpie RSS (http://magpierss.sourceforge.net/) - place it into |
| 33 | magpierss/ subdirectory; | |
| ca7c8ae3 AD |
34 | |
| 35 | - RDBMS backend: | |
| 36 | ||
| 37 | a) PostgreSQL | |
| 38 | ||
| 39 | b) MySQL (InnoDB and server version 4.1+ required) | |
| 40 | ||
| 14ce54af AD |
41 | Example DB schemas and configuration are in schema/ subdirectory. |
| 42 | ||
| 1aab5aec AD |
43 | For PostgreSQL don't forget to create database with UTF-8 encoding |
| 44 | (createdb -E UTF-8 -O owner_user database). | |
| 1945c416 AD |
45 | |
| 46 | Don't forget to copy config.php-dist to config.php and edit it. | |
| 47 | ||
| 78800912 AD |
48 | icons/ directory should be writable for your httpd user. |
| 49 | ||
| 1945c416 | 50 | Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com> |