Skip to content

ilijalazarevic/news

 
 

Repository files navigation

README

travis-ci

The News app is a an RSS/Atom feed aggregator. It offers a RESTful API for app developers. The source code is available on GitHub

For further developer and user documentation please visit the wiki

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 (see this issue for an example), check if:

  • it is a valid RSS by running it through the W3C validator
  • you are able to add the feed in other feed readers
  • it runs without error through SimplePie demo

In the case the third 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
  • Open current item: o

Performance Notices

Frequent Problems

All feeds are not updated anymore

This is a bug in the core backgroundjob system deleting the :file:`owncloud/data/cron.lock` file gets the cron back up running

Another way to fix this is to run a custom updater script

All feeds are not updated and theres no cron.lock

  • Check if the cronjob exists with crontab -u www-data -e (replace www-data with your httpd user)
  • Check the file permissions of the cron.php file and if www-data (or whatever your httpd user is called like) can read and execute that script
  • Check if the cronjob is ever executed by placing an error_log('updating') in the background job file. If the cronjob runs, there should be an updating log statement in your httpd log.
  • If there is no updating statement in your logs check if your cronjob is executed by executing a different script
  • If your cron works fine but owncloud's cronjobs are never executed, file a bug in core
  • Try the updater script

Configuration

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

:file:`dependencyinjection/dicontainer.php`

  • To use a custom update/cron script you need to disable the cronjob which is run by ownCloud by default:

    $this['useCronUpdates'] = false;
    
  • 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
    

About

Repo for the news app

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors