From 8148675cb7ef8081fee0b14307deb869abf0f6e3 Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Sat, 11 Feb 2017 00:43:04 +0100 Subject: docs 3rd party tools: update java wrapper, add cmd tool to add article --- docs/en/developer/api.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/en/developer') diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst index b6c9ed3f..074da1a7 100644 --- a/docs/en/developer/api.rst +++ b/docs/en/developer/api.rst @@ -263,8 +263,8 @@ Third party resources Some applications or libraries use our API. Here is a non-exhaustive list of them: -- `Java wrapper for the wallabag API `_ by Strubbl. +- `Java wrapper for the wallabag API `_ by Dmitriy Bogdanov. - `.NET library for the wallabag v2 API `_ by Julian Oster. - `Python API for wallabag `_ by FoxMaSk, for his project `Trigger Happy `_. - `A plugin `_ designed for `Tiny Tiny RSS `_ that makes use of the wallabag v2 API. By Josh Panter. -- `Golang wrapper for the wallabag API `_ by Strubbl, for his project `wallabag-stats graph `_. +- `Golang wrapper for the wallabag API `_ by Strubbl, for his projects `wallabag-stats graph `_ and the command line tool `wallabag-add-article `_. -- cgit v1.2.3 From c772c473a1002a712b25b7c35922075d4d4116ff Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Sat, 11 Feb 2017 09:11:55 +0100 Subject: docs: add 3rd party app wallabako for Kobo readers --- docs/en/developer/api.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs/en/developer') diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst index 074da1a7..80c96025 100644 --- a/docs/en/developer/api.rst +++ b/docs/en/developer/api.rst @@ -8,7 +8,7 @@ Requirements * wallabag freshly (or not) installed on http://localhost:8000 * ``httpie`` installed on your computer (`see project website `__). Note that you can also adapt the commands using curl or wget. -* all the API methods are documented here http://localhost:8000/api/doc (on your instance) and `on our example instance `_ +* all the API methods are documented here http://localhost:8000/api/doc (on your instance) and `on our example instance `_ Creating a new API client ------------------------- @@ -268,3 +268,4 @@ Some applications or libraries use our API. Here is a non-exhaustive list of the - `Python API for wallabag `_ by FoxMaSk, for his project `Trigger Happy `_. - `A plugin `_ designed for `Tiny Tiny RSS `_ that makes use of the wallabag v2 API. By Josh Panter. - `Golang wrapper for the wallabag API `_ by Strubbl, for his projects `wallabag-stats graph `_ and the command line tool `wallabag-add-article `_. +- Tool to automatically download Wallabag articles into your local computer or Kobo ebook reader `wallabako `_ by anarcat. -- cgit v1.2.3 From 5301d664d9459b7b8ef46a0d5c28bb3c1af90f07 Mon Sep 17 00:00:00 2001 From: etiess Date: Thu, 23 Feb 2017 08:54:33 +0100 Subject: Update paywall.rst (EN) with details + clear cache --- docs/en/developer/paywall.rst | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) (limited to 'docs/en/developer') diff --git a/docs/en/developer/paywall.rst b/docs/en/developer/paywall.rst index 365027b4..153afa6f 100644 --- a/docs/en/developer/paywall.rst +++ b/docs/en/developer/paywall.rst @@ -6,12 +6,16 @@ wallabag can fetch articles from websites which use a paywall system. Enable paywall authentication ----------------------------- -In internal settings, in the **Article** section, enable authentication for websites with paywall (with the value 1). +In internal settings, as a wallabag administrator, in the **Article** section, enable authentication for websites with paywall (with the value 1). Configure credentials in wallabag --------------------------------- -Edit your ``app/config/parameters.yml`` file to edit credentials for each website with paywall. Here is an example for some french websites: +Edit your ``app/config/parameters.yml`` file to edit credentials for each website with paywall. For example, under Ubuntu: + +``sudo -u www-data nano /var/www/html/wallabag/app/config/parameters.yml`` + +Here is an example for some french websites (be careful: don't use the "tab" key, only spaces): .. code:: yaml @@ -28,7 +32,7 @@ Parsing configuration files .. note:: - Read `this part of the documentation `_ to understand the configuration files. + Read `this part of the documentation `_ to understand the configuration files, which are located under ``vendor/j0k3r/graby-site-config/``. For most of the websites, this file is already configured: the following instructions are only for the websites that are not configured yet. Each parsing configuration file needs to be improved by adding ``requires_login``, ``login_uri``, ``login_username_field``, ``login_password_field`` and ``not_logged_in_xpath``. @@ -54,3 +58,8 @@ For example: login_password_field: password not_logged_in_xpath: //body[@class="not-logged-in"] + +Last step: clear the cache +-------------------------- + +It's necessary to clear the wallabag cache with the following command (here under Ubuntu): ``sudo -u www-data php /var/www/html/wallabag/bin/console cache:clear -e=prod`` -- cgit v1.2.3