README

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