public/tt-rss
1
0
Fork 0
mirror of https://git.tt-rss.org/git/tt-rss.git synced 2025-12-16 00:25:56 +00:00
Code Issues Releases Wiki Activity

rewrite README, update UPGRADING

Browse Source
This commit is contained in:
Andrew Dolgov
2005-12-20 18:30:04 +01:00
parent 27da8b1ec3
commit 8983d99556
2 changed files with 66 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

92
README
View File

@@ -4,11 +4,7 @@ Tiny Tiny RSS
Web-based news feed aggregator, designed to allow you to read news from 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. any location, while feeling as close to a real desktop application as possible.
Please read UPGRADING for upgrade instructions from version 1.0.7 http://tt-rss.spb.ru
Other Installation/upgrade notes:
http://tt-rss.spb.ru/trac/wiki/InstallationNotes
Copyright (C) 2005 Andrew Dolgov unless stated otherwise. Copyright (C) 2005 Andrew Dolgov unless stated otherwise.
@@ -17,48 +13,66 @@ Portions (C):
Bob Osola <bobosola@gmail.com> (pngfix.js) Bob Osola <bobosola@gmail.com> (pngfix.js)
Sundar Dorai-Raj <sdoraira@vt.edu> (isNumeric() in functions.js) Sundar Dorai-Raj <sdoraira@vt.edu> (isNumeric() in functions.js)
Licensed under GPL version 2. Licensed under GNU GPL version 2
Warning: I don't know how to stress it enough - please do not install Features Overview
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 Updates: http://tt-rss.spb.ru/trac/wiki/FeatureList
to access it. Default user is "admin" with password "password", don't forget to
change it.
Interface: * Server-side application, user only needs a web browser
* Supports RSS, RDF, Atom feeds using Magpie library
* Supports OPML import/export
* Easy setup and configuration
* Streamlined interface using XmlHttpRequest (or AJAX for laypeople)
There is (incomplete) support for keyboard navigation. Requirements
============
"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;
"j" move to previous feed
"k" move to next feed
"s" star/unstar selected article(s)
Requirements: * Compatible browser on the client side
- 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. Basically, Firefox, Konqueror or MSIE6 are okay. See here
for more information:
For PostgreSQL don't forget to create database with UTF-8 encoding
(createdb -E UTF-8 -O owner_user database).
- PHP4 DOMXML extension is required for some functions http://tt-rss.spb.ru/trac/wiki/CompatibleBrowsers
Don't forget to copy config.php-dist to config.php and edit it. * Web server, for example Apache
* PHP (requires PHP4 DOMXML extension)
* MagpieRSS feed parser (http://magpierss.sourceforge.net/)
icons/ directory should be writable for your httpd user. * PostgreSQL (tested on 7.4) or MySQL (InnoDB and version 4.1+ required)
Installation Notes
==================
Updates: http://tt-rss.spb.ru/trac/wiki/InstallationNotes
* If you are upgrading from the previous version, don't forget to update
schema and logout.
* icons directory should be writable to your httpd user if you plan on
using feed icons
* Leave DB_HOST empty if you want to connect to database via unix socket
* For PostgreSQL don't forget to create database with UTF-8 encoding
createdb -E utf-8 -O owner_user database)
* Don't forget to change your password from default value on your first login
* Check your config.php for blank lines out of PHP code tags (e.g.
before <? and after ?>), See #1
See also
========
* FAQ: http://tt-rss.spb.ru/trac/wiki/FrequentlyAskedQuestions
* Forum: http://tt-rss.spb.ru/forum
* Wiki: http://tt-rss.spb.ru/trac/wiki/WikiStart
* Bug Tracker: http://tt-rss.spb.ru/trac/report
Contact
=======
Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com> Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com>

21
UPGRADING
View File

@@ -1,18 +1,23 @@
= Upgrading TT-RSS 1.0.7 to 1.1 = Updates: http://tt-rss.spb.ru/trac/wiki/Upgrading107to11
Upgrading TT-RSS 1.0.7 to 1.1
=============================
Unfortunately, there is no simple database upgrade script, the schema is just too different. Yet, your articles and feed subscriptions may be transferred the following way: Unfortunately, there is no simple database upgrade script, the schema is just too different. Yet, your articles and feed subscriptions may be transferred the following way:
== 1.0.7 == 1.0.7
=====
* Export your feed subscriptions to OPML * Export your feed subscriptions to OPML
* Copy xml-export.php from TT-RSS 1.1 tarball to your 1.0.7 directory and open it in the browser. This script exports your articles in neutral XML format. * Copy xml-export.php from TT-RSS 1.1 tarball to your 1.0.7 directory and open it in the browser. This script exports your articles in neutral XML format.
* Save resulting XML file somewhere * Save resulting XML file somewhere
Unpack and configure TT-RSS 1.1. You may need to remove old tables manualy Unpack and configure TT-RSS 1.1. You may need to remove old tables manualy
(or choose the different database, etc.) (or choose the different database, etc.)
== 1.1 == 1.1
===
* Import your feeds OPML * Import your feeds OPML
* Run xml-import.php and import your old starred articles * Run xml-import.php and import your old starred articles