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 | |
| 09165533 AD |
7 | Please read UPGRADING for upgrade instructions from version 1.0.7 |
| 8 | ||
| 9 | Other Installation/upgrade notes: | |
| 10 | ||
| 11 | http://tt-rss.spb.ru/trac/wiki/InstallationNotes | |
| 12 | ||
| fbd94c53 AD |
13 | Copyright (C) 2005 Andrew Dolgov unless stated otherwise. |
| 14 | ||
| b2e9654e | 15 | Portions (C): |
| fbd94c53 AD |
16 | |
| 17 | Bob Osola <bobosola@gmail.com> (pngfix.js) | |
| 18 | Sundar Dorai-Raj <sdoraira@vt.edu> (isNumeric() in functions.js) | |
| b2e9654e | 19 | |
| 1945c416 AD |
20 | Licensed under GPL version 2. |
| 21 | ||
| a6ba8c5e AD |
22 | Warning: I don't know how to stress it enough - please do not install |
| 23 | this program wide open to the whole internet. It belongs to (host or password) | |
| 24 | protected directory on your webserver. There could be SQL-injection or other | |
| 25 | remote vulnerabilities, so beware. | |
| 26 | ||
| b2e9654e AD |
27 | Version 1.1 adds support for multi-user operation, disable option SINGLE_USER_MODE |
| 28 | to access it. Default user is "admin" with password "password", don't forget to | |
| 29 | change it. | |
| 1945c416 | 30 | |
| c3a8d71a AD |
31 | Interface: |
| 32 | ||
| 33 | There is (incomplete) support for keyboard navigation. | |
| fa9b5ef9 AD |
34 | |
| 35 | "n" and "p" moves between next/previous posts when feed is opened; | |
| 36 | "r" refreshes feed list; | |
| 37 | "u" refreshes currently selected feed; | |
| 38 | "a" hides or shows only unread feeds in the feedlist; | |
| 7b433d8c AD |
39 | "j" move to previous feed |
| 40 | "k" move to next feed | |
| 3a955202 | 41 | "s" star/unstar selected article(s) |
| c3a8d71a | 42 | |
| 1945c416 AD |
43 | Requirements: |
| 44 | ||
| 1945c416 AD |
45 | - Magpie RSS (http://magpierss.sourceforge.net/) - place it into |
| 46 | magpierss/ subdirectory; | |
| ca7c8ae3 AD |
47 | |
| 48 | - RDBMS backend: | |
| 49 | ||
| 50 | a) PostgreSQL | |
| ca7c8ae3 AD |
51 | b) MySQL (InnoDB and server version 4.1+ required) |
| 52 | ||
| 14ce54af AD |
53 | Example DB schemas and configuration are in schema/ subdirectory. |
| 54 | ||
| 1aab5aec AD |
55 | For PostgreSQL don't forget to create database with UTF-8 encoding |
| 56 | (createdb -E UTF-8 -O owner_user database). | |
| 1945c416 | 57 | |
| 6aece853 AD |
58 | - PHP4 DOMXML extension is required for some functions |
| 59 | ||
| 1945c416 AD |
60 | Don't forget to copy config.php-dist to config.php and edit it. |
| 61 | ||
| 78800912 AD |
62 | icons/ directory should be writable for your httpd user. |
| 63 | ||
| 1945c416 | 64 | Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com> |