Skip to content

Latest commit

 

History

History
218 lines (143 loc) · 6.43 KB

README.rst

File metadata and controls

218 lines (143 loc) · 6.43 KB
Raw

README

The News app is a an RSS/Atom feed aggregator. It is based on the library SimplePie.

Maintainers

Bugs

Before reporting bugs:

  • We do not support Internet Explorer and Safari (Patches accepted though, except for IE < 10)
  • get the newest version of the App Framework
  • get the newest version of the News app
  • check if they have already been reported

If you are not able to add a feed because its XML does not validate and (see this issue for an example), check if:

  • you are able to add the feed in other feed readers
  • it runs without error through SimplePie demo

In the case the second condition is not met, please file a bug on SimplePie issue tracker.

Before you install the News app

Before you install the app check that the following requirements are met:

Should you have upgraded from a prior version, disable the CSS and JavaScript caching by adding this to :file:`owncloud/config/config.php`:

DEFINE('DEBUG', true);

You can remove the line after a page reload

App Store

Installation

  • Go to the ownCloud apps page
  • Activate the App Framework App first, then activate the News app in the apps menu
  • Set up ownCloud Background Jobs to enable feed updates. A recommended timespan for feed updates is 15-30 Minutes.

Keep up to date

Both the News and App Framework App can be updated through the ownCloud apps page.

Git (development version)

Installation

  • Clone the App Framework app into the /var/www directory:

    git clone https://github.com/owncloud/appframework.git

  • Clone the News app into the /var/www directory:

    git clone https://github.com/owncloud/news.git

  • Link both into ownCloud's apps folder:

    ln -s /var/www/appframework /var/www/owncloud/apps
ln -s /var/www/news /var/www/owncloud/apps

  • Activate the App Framework App first, then activate the News app in the apps menu

  • Set up ownCloud Background Jobs to enable feed updates. A recommended timespan for feed updates is 15-30 Minutes.

Keep up to date

To get the newest update you can use git. To update the appframework use:

cd /var/www/appframework
git pull --rebase origin master

To update the News app use:

cd /var/www/news
git pull --rebase origin master

Keyboard shortcuts

  • Next item: n / j / right arrow
  • Previous item: p / k / left arrow
  • Star current item: s / i
  • Keep current item unread: u
  • Star item and jump to next one: h

Mobile Clients

Official

Unofficial

Desktop Clients

Performance Notices

  • Use MySQL or PostgreSQL for better database performance

Known Problems

Configuration

This will be in a seperate config file in the future but for now you can tweak the folowing things.

:file:`dependencyinjection/dicontainer.php`

  • To cache feeds longer increase:

    $this['simplePieCacheDuration'] = 30*60;  // seconds

  • To let people have more read items per feed before they are purged increase:

    $this['autoPurgeCount'] = 200;  // per feed

:file:`js/app/app.coffee`

All changes in the coffee file have to be compiled by using:

make

in the js/ directory

  • To increase the interval when the app fetches new entries from database(!, not the webpage, thats set by the backgroundjob interval) change:

    feedUpdateInterval: 1000*60*3  # miliseconds

Building the package

To build the app simply run:

make

Then build the package with:

make dist

The package lies in the build/ directory and is ready to be uploaded to the App-Store

Running tests

All tests

To run them execute:

make test

PHP Unit tests

To run them execute:

make unit-tests

Integration tests

To run them execute:

make integration-tests

Acceptance tests

Note

For acceptance tests, a user with the name test and password test must exist!

To change the url under which ownCloud is installed, set the environment variable $OWNCLOUD_HOST:

export OWNCLOUD_HOST="localhost/core"

Otherwise it defaults to localhost/owncloud,

To run them execute:

make acceptance-tests

JavaScript unit tests

To run them execute:

make javascript-tests