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 | ||
| 690c1c48 AD |
15 | Version 1.1 adds experimental support for multi-user operation, disable option |
| 16 | SINGLE_USER_MODE to access it. Default user is "admin" with password "password", | |
| 17 | don't forget to change it. | |
| 1945c416 | 18 | |
| c3a8d71a AD |
19 | Interface: |
| 20 | ||
| 21 | There is (incomplete) support for keyboard navigation. | |
| fa9b5ef9 AD |
22 | |
| 23 | "n" and "p" moves between next/previous posts when feed is opened; | |
| 24 | "r" refreshes feed list; | |
| 25 | "u" refreshes currently selected feed; | |
| 26 | "a" hides or shows only unread feeds in the feedlist; | |
| c3a8d71a | 27 | |
| 1945c416 AD |
28 | Requirements: |
| 29 | ||
| 1945c416 AD |
30 | - Magpie RSS (http://magpierss.sourceforge.net/) - place it into |
| 31 | magpierss/ subdirectory; | |
| ca7c8ae3 AD |
32 | |
| 33 | - RDBMS backend: | |
| 34 | ||
| 35 | a) PostgreSQL | |
| 36 | ||
| 37 | b) MySQL (InnoDB and server version 4.1+ required) | |
| 38 | ||
| 14ce54af AD |
39 | Example DB schemas and configuration are in schema/ subdirectory. |
| 40 | ||
| 1aab5aec AD |
41 | For PostgreSQL don't forget to create database with UTF-8 encoding |
| 42 | (createdb -E UTF-8 -O owner_user database). | |
| 1945c416 AD |
43 | |
| 44 | Don't forget to copy config.php-dist to config.php and edit it. | |
| 45 | ||
| 78800912 AD |
46 | icons/ directory should be writable for your httpd user. |
| 47 | ||
| 1945c416 | 48 | Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com> |