tt-rss/README

Tiny Tiny RSS
=============

Web-based news feed aggregator, designed to allow you to read news from 
any location, while feeling as close to a real desktop application as possible.

Copyright (C) 2005 Andrew Dolgov unless stated otherwise.

Portions (C):

	Bob Osola <bobosola@gmail.com> (pngfix.js)
	Sundar Dorai-Raj <sdoraira@vt.edu> (isNumeric() in functions.js)

Licensed under GPL version 2.

Warning: I don't know how to stress it enough - please do not install
this program wide open to the whole internet. It belongs to (host or password)
protected directory on your webserver. There could be SQL-injection or other
remote vulnerabilities, so beware.

Version 1.1 adds support for multi-user operation, disable option SINGLE_USER_MODE 
to access it. Default user is "admin" with password "password", don't forget to 
change it.

Interface:

	There is (incomplete) support for keyboard navigation.
	
	"n" and "p" moves between next/previous posts when feed is opened;
	"r" refreshes feed list;
	"u" refreshes currently selected feed;
	"a" hides or shows only unread feeds in the feedlist;

Requirements:
	
	- Magpie RSS (http://magpierss.sourceforge.net/) - place it into
	  magpierss/ subdirectory;
	  
	- RDBMS backend:
	
			a) PostgreSQL
			
			b) MySQL (InnoDB and server version 4.1+ required)

	  Example DB schemas and configuration are in schema/ subdirectory.
	  
	  For PostgreSQL don't forget to create database with UTF-8 encoding
	  (createdb -E UTF-8 -O owner_user database).

Don't forget to copy config.php-dist to config.php and edit it.

icons/ directory should be writable for your httpd user.

Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com>