blob: 2e92c012638ed79a64de1fec6ccd9d51d3360ff6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
README
======
The News app is a an rss/atom feed aggregator. It is based on the library SimplePie.
Maintainers
-----------
* `Alessandro Cosentino <https://github.com/zimba12>`_
* `Bernhard Posselt <https://github.com/Raydiation>`_
Status
------
The app is in alpha status and can be tested.
See the `beta milestone in the bugtracker <https://github.com/owncloud/news/issues?milestone=3&state=open>`_ for more information on progress
Bugs
----
Before reporting bugs:
* get the newest version of the App Framework
* get the newest version of the News app
* `check if they already have been reported <https://github.com/owncloud/news/issues?state=open>`_
Before you install the News app
-------------------------------
Before you install the app check that the following requirements are met:
- Your database uses utf-8
- Your webserver uses utf-8 (`Apache <http://stackoverflow.com/questions/913869/how-to-change-the-default-encoding-to-utf-8-for-server>`_, `NginX <http://www.cyberciti.biz/faq/nginx-set-http-content-type-response-header-to-charset-utf8/>`_)
- `Magic quotes are turned off <http://php.net/manual/de/security.magicquotes.disabling.php>`_
- `You use a browser that supports the FileReader API <https://developer.mozilla.org/en/docs/DOM/FileReader#Browser_compatibility>`_
- You can use a cron or webcron to call Background Jobs in ownCloud
- (optional) install php-curl
How to install the News app
---------------------------
- Install ownCloud **5.0.5**
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);
- 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 <http://doc.owncloud.org/server/5.0/admin_manual/configuration/background_jobs.html>`_ to enable feed updates. A recommended timespan for feed updates is 15-30 Minutes.
How to 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
Performance Notices
-------------------
* It is currently discouraged to use it in large hosted installations since there is no way to restrict the backgroundjob to require a pause of X minutes. This `will be addressed <https://github.com/owncloud/news/issues/103>`_ in the `next ownCloud release <https://github.com/owncloud/core/pull/3051>`_.
* Use MySQL or PostgreSQL for better database performance
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
|
