summaryrefslogtreecommitdiff
path: root/README
blob: e1ef72490e9f2426eaee4848260cf271de4eb5a6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
Tiny Tiny RSS
=============

Server-side RSS feed aggregator written in PHP and heavily based
on XmlHttpRequest and related technologies for user interface and
operation.

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.

Also, TT-rss at present is not multi-user. It is designed for one person to
read news consistently from different locations, one location at a time. Otherwise,
last-read information will get messed up and other bad stuff could happen.

Interface:

	There is (incomplete) support for keyboard navigation.

	"n" and "p" moves between next/previous posts when feed is opened, switching
	pages as needed.

	"r" refreshes feed list

	"u" refreshes currently selected feed

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 in ttrss_schema.sql and
	  ttrss_schema_mysql.sql.

	  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 <[email protected]>