diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 110 |
1 files changed, 64 insertions, 46 deletions
@@ -1,16 +1,12 @@ -# ownCloud News app -[](https://webchat.freenode.net/?channels=owncloud-news) -[](https://gitter.im/owncloud/news?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +# Nextcloud News app +[](https://travis-ci.org/nextcloud/news) [](https://webchat.freenode.net/?channels=nextcloud-news) -[](https://travis-ci.org/owncloud/news) -[](https://scrutinizer-ci.com/g/owncloud/news/?branch=master) -The News app is an RSS/Atom feed aggregator. It offers a [RESTful API](https://github.com/owncloud/news/wiki/API-1.2) for app developers. The source code is [available on GitHub](https://github.com/owncloud/news) +The News app is an RSS/Atom feed aggregator. It offers a [RESTful API](https://github.com/nextcloud/news/tree/master/docs/externalapi) for app developers. The source code is [available on GitHub](https://github.com/nextcloud/news) - + -For further developer and user documentation please visit [the wiki](https://github.com/owncloud/news/wiki) ## Maintainers * [Bernhard Posselt](https://github.com/BernhardPosselt) @@ -18,12 +14,26 @@ For further developer and user documentation please visit [the wiki](https://git * [Jan-Christoph Borchardt](https://github.com/jancborchardt) (Design) ## Sync Clients -are listed on the [ownCloud apps overview](https://github.com/owncloud/core/wiki/Apps) +Nextcloud News can be synced with the following apps: + * [RSS Guard (Windows, Linux, OS/2, Mac OS)](https://bitbucket.org/skunkos/rssguard), [open source](https://bitbucket.org/skunkos/rssguard/src) + * [ownCloud News Reader (Android)](https://play.google.com/store/apps/details?id=de.luhmer.owncloudnewsreader), [open source](https://github.com/nextcloud/news-android-app) + * [OCReader (Android)](https://f-droid.org/repository/browse/?fdid=email.schaal.ocreader), [open source](https://github.com/schaal/ocreader) + * [CloudNews (iOS)](https://itunes.apple.com/app/cloudnews-owncloud-news-reader/id683859706), [open source](https://github.com/nextcloud/news-ios-app) + * [News Checker (Chrome extension)](https://chrome.google.com/webstore/detail/owncloud-news-checker/hnmagnmdnfdhabdlicankfbfhcdgbfhe) + * [own News (BlackBerry)](http://appworld.blackberry.com/webstore/content/32767887/) + * [ocNews (Sailfish OS)](http://www.buschmann23.de/entwicklung/anwendungen/ocnews/), [open source](https://github.com/Buschtrommel/ocNews) + * [MyWebRSS (Firefox OS)](https://marketplace.firefox.com/app/mywebrss), [open source](https://github.com/ybulach/MyWebRSS), also works as [web app](http://html5.mywebrss.net/) + * [FeedSpider (Firefox OS, WebOS, LuneOS)](http://www.feedspider.net/), [open source](https://github.com/OthelloVentures/feedspider) + * [FeedMonkey (Firefox OS)](https://marketplace.firefox.com/app/feedmonkey), [open source](https://github.com/jeena/feedmonkey) + * [fastReader (Windows Phone)](http://www.windowsphone.com/en-us/store/app/fastreader/e55e696d-aa45-4a49-bb1c-a1fc7fdabec1), closed source + * [OwnCloud News Reader (WebOS)](http://www.webosnation.com/owncloud-news-reader), [open source](https://bitbucket.org/andpeters/webos-owncloud-news-reader) + * [FeedReader (Linux desktop)](http://jangernert.github.io/FeedReader/), [open source](https://github.com/jangernert/FeedReader) + ## Dependencies * 64bit operating system and PHP * PHP >= 5.6 -* ownCloud >= 9.0 +* Nextcloud >= 10 * libxml >= 2.7.8 (2.9 recommended) * php-curl * iconv @@ -47,15 +57,15 @@ These Dependencies are only relevant if you want to build the source code: * SQLite (discouraged) ## Bugs -Please read the [appropriate section in the contributing notices](https://github.com/owncloud/news/blob/master/CONTRIBUTING.md#issues) +Please read the [appropriate section in the contributing notices](https://github.com/nextcloud/news/blob/master/CONTRIBUTING.md#issues) ## Installation/Update ### Before you install/update the News app Before you install the app do the following: -* Check that your **owncloud/data/** directory is owned by your webserver user and that it is write/readable -* Check that your installation fullfills the [requirements listed in the README section](https://github.com/owncloud/news#dependencies) -* [Set up ownCloud Background Jobs](https://doc.owncloud.org/server/8.0/admin_manual/configuration_server/background_jobs_configuration.html) to enable feed updates. A recommended timespan for feed updates is 15-30 Minutes. +* Check that your **nextcloud/data/** directory is owned by your web server user and that it is write/readable +* Check that your installation fulfills the [requirements listed in the README section](https://github.com/nextcloud/news#dependencies) +* [Set up Nextcloud Background Jobs](https://docs.nextcloud.org/server/9/admin_manual/configuration_server/background_jobs_configuration.html#cron) to enable feed updates. A recommended timespan for feed updates is 15-30 Minutes. Then proceed to install the app either from an archive (zip/tar.gz) or clone it from the repository using git @@ -63,31 +73,31 @@ Then proceed to install the app either from an archive (zip/tar.gz) or clone it This is the easiest solution: Simply go the the apps page and enable the News app ### Installing from archive -* Go to the [ownCloud News GitHub releases page](https://github.com/owncloud/news/releases) and download the latest release/archive to your server +* Go to the [Nextcloud News GitHub releases page](https://github.com/nextcloud/news/releases) and download the latest release/archive to your server * Starting with 8.0.0, there are two different releases: **news.tar.gz** and **Source code**. The first one requires no additional steps, the second one requires you to install the dependencies and compile the JavaScript. Choose the first one if you don't want to work on the code. If you want to install a version prior to 8.0.0, choose the **Source code** download. -* On your server, check if there is a folder called **owncloud/apps/news**. If there is one, delete it. -* Extract the downloaded archive to the **owncloud/apps/** folder. -* Remove the version from the extracted folder (e.g. rename **owncloud/apps/news-4.0.3/** to **owncloud/apps/news/** -* If you are a version greater than or equal to 8.0.0 and downloaded the **Source code** zip or tar.gz, you need to install the JavaScript and PHP dependencies and compile the JavaScript first. On your terminal, change into the **owncloud/apps/news/** directory and run the following command (requires node >5.6, npm, curl, make and which): +* On your server, check if there is a folder called **nextcloud/apps/news**. If there is one, delete it. +* Extract the downloaded archive to the **nextcloud/apps/** folder. +* Remove the version from the extracted folder (e.g. rename **nextcloud/apps/news-4.0.3/** to **nextcloud/apps/news/** +* If you are a version greater than or equal to 8.0.0 and downloaded the **Source code** zip or tar.gz, you need to install the JavaScript and PHP dependencies and compile the JavaScript first. On your terminal, change into the **nextcloud/apps/news/** directory and run the following command (requires node >5.6, npm, curl, make and which): sudo -u www-data make # www-data might vary depending on your distribution -* Finally make sure that the **owncloud/apps/news** directory is owned by the web server user +* Finally make sure that the **nextcloud/apps/news** directory is owned by the web server user - sudo chown -R www-data:www-data owncloud/apps/news # www-data:www-data might vary depending on your distribution + sudo chown -R www-data:www-data nextcloud/apps/news # www-data:www-data might vary depending on your distribution * Activate the **News** app in the apps menu ### Installing from Git (development version) -* The master branch will always be stable in conjunction with the latest master branch from ownCloud +* The master branch will always be stable in conjunction with the latest master branch from Nextcloud * JavaScript and PHP libraries are not included anymore since 8.0.0 and will require you to run **make** after updating/installing the app -* In your terminal go into the **owncloud/apps/** directory and then run the following command: +* In your terminal go into the **nextcloud/apps/** directory and then run the following command: - git clone https://github.com/owncloud/news.git + git clone https://github.com/nextcloud/news.git cd news make -* If you are using a stable ownCloud release, stay with the [latest git tag release which is running on your version](https://github.com/owncloud/news/releases). To get an overview over all existing tags run: +* If you are using a stable Nextcloud release, stay with the [latest git tag release which is running on your version](https://github.com/nextcloud/news/releases). To get an overview over all existing tags run: git tag @@ -102,25 +112,25 @@ This is the easiest solution: Simply go the the apps page and enable the News ap * Activate the **News** app in the apps menu -To update the News app use change into the **owncloud/apps/news/** directory using your terminal and then run: +To update the News app use change into the **nextcloud/apps/news/** directory using your terminal and then run: git pull --rebase origin master make ## Performance Notices * Use MySQL or PostgreSQL for better database performance -* Use the [updater script to thread and speed up the update](https://github.com/owncloud/news-updater) +* Use the [updater script to thread and speed up the update](https://github.com/nextcloud/news-updater) ## Updating Notices To receive notifications when a new News app version was released, simply add the following Atom feed in your currently installed News app: - https://github.com/owncloud/news/releases.atom + https://github.com/nextcloud/news/releases.atom ## FAQ ### My browser shows a mixed content warning (Connection is Not Secure) -If you are serving your ownCloud over HTTPS your browser will very likely warn you with a yellow warnings sign about your connection not being secure. +If you are serving your Nextcloud over HTTPS your browser will very likely warn you with a yellow warnings sign about your connection not being secure. Chrome will show no green HTTPS lock sign, Firefox will show you the following image  @@ -146,7 +156,7 @@ Since an attacker can not execute code in contrast to mixed active content, but #### Why don't you simply use an HTTPS image/audio/video proxy -For the same reason that we can't fix non HTTPS websites: It does not fix the underlying issue but only silences it. If you are using an image HTTPS proxy, an attacker can simply attack your image proxy since the proxy fetches insecure content. **Even worse**: if your image proxy serves these images from the same domain as your ownCloud installation you [are vulnerable to XSS via SVG images](https://www.owasp.org/images/0/03/Mario_Heiderich_OWASP_Sweden_The_image_that_called_me.pdf). In addition people feel save when essentially they are not. +For the same reason that we can't fix non HTTPS websites: It does not fix the underlying issue but only silences it. If you are using an image HTTPS proxy, an attacker can simply attack your image proxy since the proxy fetches insecure content. **Even worse**: if your image proxy serves these images from the same domain as your Nextcloud installation you [are vulnerable to XSS via SVG images](https://www.owasp.org/images/0/03/Mario_Heiderich_OWASP_Sweden_The_image_that_called_me.pdf). In addition people feel save when essentially they are not. Since most people don't understand mixed content and don't have two domains and a standalone server for the image proxy, it is very likely they will choose to host it under the same domain. @@ -168,7 +178,7 @@ The exception name itself will give you a hint about what is wrong: One reason for this error could be old files which were not overwritten properly when the app was upgraded. Make sure that all files match the files in the release archive! Most of the time however this is caused by users trying to downgrade (**not supported!!!**) or by failed/timed out database migrations. To prevent future timeouts use - php -f owncloud/occ upgrade + php -f nextcloud/occ upgrade instead of clicking the upgrade button on the web interface. @@ -216,11 +226,11 @@ Some hints: * type clob is usually an Sql TEXT * length for integer fields means bytes, so an integer with length 8 means its 64bit -### I am getting: Exception: Some\\Class does not exist erros in my owncloud.log +### I am getting: Exception: Some\\Class does not exist erros in my nextcloud.log This is very often caused by missing or old files, e.g. by failing to upload all of the News app' files or errors during installation. Before you report a bug, please recheck if all files from the archive are in place and accessible. ### How do I reset the News app -Delete the folder **owncloud/apps/news/** and **owncloud/data/news/**, then connect to your database and run the following commands where **oc\_** is your table prefix (defaults to oc\_) +Delete the folder **nextcloud/apps/news/** and **nextcloud/data/news/**, then connect to your database and run the following commands where **oc\_** is your table prefix (defaults to oc\_) ```sql DELETE FROM oc_appconfig WHERE appid = 'news'; @@ -231,35 +241,36 @@ DROP TABLE oc_news_folders; ### App is stuck in maintenance mode after failed update -Check the **owncloud/data/owncloud.log** for hints why it failed. After the issues are fixed, turn off the maintenance mode by editing your **owncloud/config/config.php** by setting the **maintenance** key to false: +Check the **nextcloud/data/nextcloud.log** for hints why it failed. After the issues are fixed, turn off the maintenance mode by editing your **nextcloud/config/config.php** by setting the **maintenance** key to false: "maintenance" => false, ### Feeds are not updated -Feeds can be updated using ownCloud's system cron or any program that implements the [News app's updater API](https://github.com/owncloud/news/wiki/Updater-1.2), most notably [ownCloud News Updater](https://github.com/owncloud/news-updater). **The feed update is not run in Webcron and AJAX cron mode!** +Feeds can be updated using Nextcloud's system cron or any program that implements the [News app's updater API](https://github.com/nextcloud/news/tree/master/docs/externalapi), most notably [Nextcloud News Updater](https://github.com/nextcloud/news-updater). **The feed update is not run in Webcron and AJAX cron mode!** System Cron: -* Check if the config.ini in **owncloud/data/news/config/config.ini** contains **useCronUpdates = true** +* Check if the config.ini in **nextcloud/data/news/config/config.ini** contains **useCronUpdates = true** * Check if you are using the system cron (Cron) setting on the admin page. AJAX and Web cron will not update feeds * 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 you can execute the cron with **sudo -u www-data php -f owncloud/cron.php** (replace www-data with your httpd user) -* Check your **data/owncloud.log** for errors -* Check if the cronjob is ever executed by placing an **error_log('updating');** in the [background job file](https://github.com/owncloud/news/blob/master/cron/updater.php#L28). If the cronjob runs, there should be an updating log statement in your httpd log. +* Check if you can execute the cron with **sudo -u www-data php -f nextcloud/cron.php** (replace www-data with your httpd user) +* Check your **data/nextcloud.log** for errors +* Check if the cronjob is ever executed by placing an **error_log('updating');** in the [background job file](https://github.com/nextcloud/news/blob/master/cron/updater.php#L28). 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](https://github.com/owncloud/core/) +* If your cron works fine but Nextcloud's cronjobs are never executed, file a bug in [core](https://github.com/nextcloud/core/) -[ownCloud News Updater](https://github.com/owncloud/news-updater): -* Check if the config.ini in **owncloud/data/news/config/config.ini** contains **useCronUpdates = false** +[Nextcloud News Updater](https://github.com/nextcloud/news-updater): +* Check if the config.ini in **nextcloud/data/news/config/config.ini** contains **useCronUpdates = false** * Start the updater in loglevel info mode and check if the feed update urls are polled, e.g.: - owncloud_news_updater --loglevel info -c /path/to/config.ini + nextcloud_news_updater --loglevel info -c /path/to/config.ini -* Check your **data/owncloud.log** for errors +* Check your **data/nextcloud.log** for errors ### Adding feeds that use self-signed certificates If you want to add a feed that uses a self-signed certificate that is not signed by a trusted CA the request will fail with "SSL certficate is invalid". A common solution is to turn off the certificate verification **which is wrong** and **makes your installation vulnerable to MITM attacks**. Therefore **turning off certificate verification is not supported**. + If you have control over the feed in question, consider signing your certificate for free on one of the following providers: * [letsencrypt.com](http://letsencrypt.com/) * [StartSSL](https://www.startssl.com/) @@ -267,10 +278,17 @@ If you have control over the feed in question, consider signing your certificate If you do not have control over the chosen feed, you should [download the certificate from the feed's website](http://superuser.com/questions/97201/how-to-save-a-remote-server-ssl-certificate-locally-as-a-file) and [add it to your server's trusted certificates](http://www.onlinesmartketer.com/2009/06/23/curl-adding-installing-trusting-new-self-signed-certificate/). The exact procedure however may vary depending on your distribution. +### Is There An Subscription URL To Easily Subscribe To Feeds + +By appending **?subscribe_to=SOME_URL** to your News app URL, you can launch the News app with a pre-filled URL, e.g.: + + https://yourdomain.com/nextcloud/index.php/apps/news?subscribe_to=https://github.com/nextcloud/news/releases + + Configuration ------------- -All configuration values are set inside **owncloud/data/news/config/config.ini** and can be edited in the admin panel. +All configuration values are set inside **nextcloud/data/news/config/config.ini** and can be edited in the admin panel. The configuration is in **INI** format and looks like this: @@ -290,5 +308,5 @@ exploreUrl = * **maxRedirects**: How many redirects the updater should follow * **maxSize**: Maximum feed size in bytes. If the RSS/Atom page is bigger than this value, the update will be aborted * **feedFetcherTimeout**: Maximum number of seconds to wait for an RSS or Atom feed to load. If a feed takes longer than that number of seconds to update, the update will be aborted -* **useCronUpdates**: To use a custom update/cron script you need to disable the cronjob which is run by ownCloud by default by setting this to false +* **useCronUpdates**: To use a custom update/cron script you need to disable the cronjob which is run by Nextcloud by default by setting this to false * **exploreUrl**: If given that url will be contacted for fetching content for the explore feed |