wiki:WikiStart

Version 30 (modified by pierre-alain, 9 years ago) (diff)

--

Welcome to OpenWebReader

OpenWebReader is a PHP5, multi-user feed aggregator. It is designed for becoming a RIA and uses AJAX technology as main rich interface amplifyer.

OpenWebReader is free software.

/chrome/site/screenshots/0.2.1/main-home.jpg

Yet another web-based feed aggregator

There are already some free feed aggregators around there, like Gregarius, Tiny Tiny RSS, or Lilina.

So why yet another one ?

The main particularity of OpenWebReader is that it is fully written in object-oriented programming style, and uses MVC as architectural pattern.

It is designed to be fast and easy-to-use, and the interface tends to be the most user-friendly as possible.

It is foreseen to develop a desktop application, based on the API/REST?, you will then also be able to use OpenWebReader without the use of any web-browser and on any platform.

Features

  • Support for ATOM, RSS 0.92, RSS 1 (RDF), RSS 2 formats
  • Import/export feeds in OPML format
  • Multi-lingual interface, sober and fast, powered by AJAX
  • Feeds auto-discovery
  • Favicons support (requires Imagick if you want to validate the icon's integrity)
  • Mark some news easily into most spreaded services
  • Feeds tagging, with or without use of drag'n'drop
  • News tagging
  • Support for OpenID authentification
  • Multi-users, two level of rights (user, administrator)
  • API/REST?
  • Full-text search
  • OpenSearch compatible
  • Documented source code
  • RSS Gateway system
  • SSL support (HTTPS)
  • Caching system (both templates and SQL results)
  • E-tags support
  • 304 HTTP code status (not modified) support

Languages

Actually only french and english are supported. If you want to add your language, feel free to have a look at source:OWR/locale/en_US/LC_MESSAGES/messages.po and contact me.

License

OpenWebReader is released under GPL License.

Screenshots

You can see what it looks like on the screenshots page.

Demo

A demo is available at http://demo.openwebreader.org/. The login/password is demo/demo, and the user is not an administrator.

For security reason, I disabled uploading of OPML file. You still can import OPML, by giving to OpenWebReader the url of it.

The database will be resetted every day.

It is based on the Git version.

Pre-requisites

Server environment

  • UNIX-like (tested on Debian, Ubuntu, freeBSD, Arch Linux), maybe some others..
  • Web server (tested on Apache and nginx)
  • Database server (warning, only tested on MySQL)
  • PHP 5.3
  • PHP/cli
  • PHP/PDO
  • PHP/mbstring
  • PHP/XMLReader
  • PHP/libxml
  • PHP/gettext
  • PHP/date
  • PHP/Intl
  • PHP/SPL
  • PHP/JSON
  • PHP/PCRE
  • PHP/cURL (optionnal, but needed for servers that do not allow file_get_contents for external resources)
  • PHP/Imagick (optionnal, but recommended)
  • PHP/finfo (optionnal, but strongly recommended for security reasons)

Database

Database has to be created in utf8. The DB user must have the rights to read and write on all tables.

PHP/cli and cron

It is required to have an access to PHP cli interface and to webserver's user crontab.

Supported browsers

The interface (XHTML/CSS/Javascript) has been developped for recents navigators. The Git version of OpenWebReader has been successfully tested on following navigators :

  • Firefox 3.5
  • Chromium 4.0
  • Opera 10 (some CSS properties are not yet supported by this navigator : box-shadow, text-shadow, border-radius)
  • Konqueror 4.2 (some CSS properties are not yet supported by this navigator : box-shadow)
  • Safari 4

Installation

  • Download the package
  • Uncompress the archive
  • Comment the line in the file /path/to/myOpenWebReader/install/.htaccess, comment the two lines about /install in /path/to/myOpenWebReader/.htacces and remove (or comment) the third line of file /path/to/myOpenWebReader/install/install.php (the one beginning by 'die(')
  • Point your browser to http://domain.tld/path/to/myOpenWebReader/install/install.php and follow each step. You may have a look at Configuration page for help on installing properly OpenWebReader.
  • Delete the directory /path/to/myOpenWebReader/install/ (or undo the third part of this how-to, for security reason)
  • Create the first user, which will be set as administrator automatically
  • Enjoy !

In practice

After having installed OpenWebReader on your web server, you just have to log-in and gives it the url of a website you like, it will look for presence of feed(s) (either atom, rss, or opml) and add them to your collection.

You also have the possibility to import a list of feeds from an OPML file.

You will then be able to sort your feeds by category using drag'n'drop.

You may have a look at the Tricks page.

For developpers

A REST api has been developped, as you can use OpenWebReader as a web service. It is described here?.

Releases

All releases are available at the download page. You also can clone OpenWebReader with Git.

  • 2010-04-23 : 0.2.1
  • 2010-02-14 : 0.2
  • 2010-01-14 : 0.1
  • 2009-12-15 : 0.1b1
  • 2009-11-22 : 0.1a2
  • 2009-11-16 : 0.1a1

Contact

For every contact, please send a mail at contact/no-spam/@/no-spam/openwebreader/no-spam/./no-spam/org or join the irc channel irc://irc.freenode.net/#openwebreader.

Author

OpenWebReader is developped by Pierre-Alain Mignot.

See also Credits page.

Editing the wiki

To avoid spam, I closed ticket creation for un-authentified users. If you want to add a ticket, join the channel irc://irc.freenode.net/#openwebreader to get an anonymous login/passwd.


Trac reminder

For a complete list of local wiki pages, see TitleIndex.