RSSProxy Files

###################################################################
# Title:   RSSProxy                                               #
# Author:  Torsten Amshove <torsten@amshove.net>                  #
# Website: https://sourceforge.net/projects/rssproxy/             #
#                                                                 #
# Copyright(c) 2009 torsten@amshove.net. All rights reserved.     #
# This software is released under the GNU General Public License. #
###################################################################


DESCRIPTION:
  RSSProxy is a web based RSS-Reader with export. It exports
  only the unread messages. So you can read online and your
  RSS-Reader at home only gets unread messages.

   - RSS- and Atom-Feeds are supported
   - Export in Atom-Format
   - Supports many RSS-Feeds at once - One Feed per Tab
   - Different refresh- and expire-Timers per Feed
   - Checks every feed for new messages and marks the Tab when there is a new messages
   - Changes the Browser-Title if there are new messages
   - Ability to edit the message automatically before it is displayed
   - Secured by User and Password
   - Secure export with special security-tag - your RSS-Reader doesn't need User/Password
   - Supports Conditional GET (to fetch the original Feed AND at the export)
   - Dynamic Themeswitcher
   - Multilanguage-Support (by now: English (I did my best :D ), German)


INSTALL:
  1) Extract the archive
  2) Edit includes/config.inc.php
       - Set up your MySQL-Configuration
       - Set your username and password
       - Set $try_to_create_tables to "true"
  3) Copy all files to your webspace
  4) Change permission of "cache" to 777
  5) Open the site with your browser and log in (default user: admin pw: test)
  6) Change $try_to_create_tables in includes/config.inc.php to false
  7) Set up your feeds at the settings-tab
  8) Enjoy


NOTES:
  - Where do I get the export-URL for my RSS-Reader?
    At the settings-tab there is a RSS-Icon at the beginning of
    every row. You can click right and choose "copy link to clipboard".
    This link already contains the ID of the feed and the right
    security-tag.

  - What the hell is the security-tag?
    The security-tag is a Hash-value appended to the export-URL to prevent
    others from reading your exportet feeds. This is necessary because
    reading the export-URL marks every message as "read by RSS-Reader".
    Also the security-tag prevents to type username and password on every
    request of your RSS-Reader.
    IMPORTANT: The securityt-tag is calculated of your MySQL- and Admin-Settings
               so if you change them, your export-URL is changed and your RSS-
               Reader isn't able to fetch the feeds with the old one.

  - Why are there two variables for my admin-password?
    You only need to set one of this variables. You can decide if you
    want to store your Password in plaintext or as an MD5-Hash.

  - What does $try_to_create_tables do?
    If this variable is set to true, the script tries at EVERY request
    to create the needed tables in the MySQL-Database. So if it was
    "true" for one request, the tables are created, and there is no need
    to try again. Therefore set this variable to false to prevent this.

  - Why do I have to choose a height in the configuration?
    This is the height of the space where the messages are displayed.
    If you have a high resolution you can increase it to see the whole
    message at once.

  - What are all these refresh- and expire-times?
    In the config-file you define the expire-time of the cookies. There
    are three cookies: permanent login, choosen theme and last selected
    tab. All these cookies expires at the given period (in days). But they
    only expire, if you doesn't open the RSSProxy in this period. If you
    do, the cookies will be renewed and the expire-time will be newly set
    to the value of the configurateion-file.
    The expire-time you set up at a feed is the expire-time of the cache.
    If a message gets marked as "read" or as "read by RSS-Reader", the
    message is added to the cache. This cache has to be cleaned from time
    to time, because there may be messages in the cache, which aren't in
    the original RSS-Feed cause they are old. So every message in the cache
    older than the given expire-time (in days) will be erased. (0 = no expire)
    The refresh-time you set up at a feed is the time (in minutes), the
    original RSS-Feed is checked for new messages. If there are new messages
    the headline of the tab gets an " * ". If you select the tab (or a
    message in the tab) the mark gets erased.


HINT:
  You can add an ?user=<username> to the login-url to prefill the username
  field. It's a benefit, if add your RSSProxy to your favorites.
  Sample: http://rssproxy.example.com/login.php?user=Admin


REFERENCES:
  - The RSS/Atom-Reader Library
    http://magpierss.sourceforge.net/

  - The Atom-Writer Library
    http://flaimo.com/php-atom.php

  - The Conditional GET function
    http://simonwillison.net/2003/Apr/23/conditionalGet/

  - A nice article about Conditional GET
    http://fishbowl.pastiche.org/2002/10/21/http_conditional_get_for_rss_hackers/