diff options
Diffstat (limited to 'docs/en/developer')
-rw-r--r-- | docs/en/developer/api.rst | 7 | ||||
-rw-r--r-- | docs/en/developer/paywall.rst | 15 |
2 files changed, 16 insertions, 6 deletions
diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst index b6c9ed3f..80c96025 100644 --- a/docs/en/developer/api.rst +++ b/docs/en/developer/api.rst | |||
@@ -8,7 +8,7 @@ Requirements | |||
8 | 8 | ||
9 | * wallabag freshly (or not) installed on http://localhost:8000 | 9 | * wallabag freshly (or not) installed on http://localhost:8000 |
10 | * ``httpie`` installed on your computer (`see project website <https://github.com/jkbrzt/httpie>`__). Note that you can also adapt the commands using curl or wget. | 10 | * ``httpie`` installed on your computer (`see project website <https://github.com/jkbrzt/httpie>`__). Note that you can also adapt the commands using curl or wget. |
11 | * all the API methods are documented here http://localhost:8000/api/doc (on your instance) and `on our example instance <http://v2.wallabag.org/api/doc>`_ | 11 | * all the API methods are documented here http://localhost:8000/api/doc (on your instance) and `on our example instance <http://v2.wallabag.org/api/doc>`_ |
12 | 12 | ||
13 | Creating a new API client | 13 | Creating a new API client |
14 | ------------------------- | 14 | ------------------------- |
@@ -263,8 +263,9 @@ Third party resources | |||
263 | 263 | ||
264 | Some applications or libraries use our API. Here is a non-exhaustive list of them: | 264 | Some applications or libraries use our API. Here is a non-exhaustive list of them: |
265 | 265 | ||
266 | - `Java wrapper for the wallabag API <https://github.com/Strubbl/jWallabag>`_ by Strubbl. | 266 | - `Java wrapper for the wallabag API <https://github.com/di72nn/wallabag-api-wrapper>`_ by Dmitriy Bogdanov. |
267 | - `.NET library for the wallabag v2 API <https://github.com/jlnostr/wallabag-api>`_ by Julian Oster. | 267 | - `.NET library for the wallabag v2 API <https://github.com/jlnostr/wallabag-api>`_ by Julian Oster. |
268 | - `Python API for wallabag <https://github.com/foxmask/wallabag_api>`_ by FoxMaSk, for his project `Trigger Happy <https://blog.trigger-happy.eu/>`_. | 268 | - `Python API for wallabag <https://github.com/foxmask/wallabag_api>`_ by FoxMaSk, for his project `Trigger Happy <https://blog.trigger-happy.eu/>`_. |
269 | - `A plugin <https://github.com/joshp23/ttrss-to-wallabag-v2>`_ designed for `Tiny Tiny RSS <https://tt-rss.org/gitlab/fox/tt-rss/wikis/home>`_ that makes use of the wallabag v2 API. By Josh Panter. | 269 | - `A plugin <https://github.com/joshp23/ttrss-to-wallabag-v2>`_ designed for `Tiny Tiny RSS <https://tt-rss.org/gitlab/fox/tt-rss/wikis/home>`_ that makes use of the wallabag v2 API. By Josh Panter. |
270 | - `Golang wrapper for the wallabag API <https://github.com/Strubbl/wallabago>`_ by Strubbl, for his project `wallabag-stats graph <https://github.com/Strubbl/wallabag-stats>`_. | 270 | - `Golang wrapper for the wallabag API <https://github.com/Strubbl/wallabago>`_ by Strubbl, for his projects `wallabag-stats graph <https://github.com/Strubbl/wallabag-stats>`_ and the command line tool `wallabag-add-article <https://github.com/Strubbl/wallabag-add-article>`_. |
271 | - Tool to automatically download Wallabag articles into your local computer or Kobo ebook reader `wallabako <https://gitlab.com/anarcat/wallabako>`_ by anarcat. | ||
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. | |||
6 | Enable paywall authentication | 6 | Enable paywall authentication |
7 | ----------------------------- | 7 | ----------------------------- |
8 | 8 | ||
9 | In internal settings, in the **Article** section, enable authentication for websites with paywall (with the value 1). | 9 | In internal settings, as a wallabag administrator, in the **Article** section, enable authentication for websites with paywall (with the value 1). |
10 | 10 | ||
11 | Configure credentials in wallabag | 11 | Configure credentials in wallabag |
12 | --------------------------------- | 12 | --------------------------------- |
13 | 13 | ||
14 | Edit your ``app/config/parameters.yml`` file to edit credentials for each website with paywall. Here is an example for some french websites: | 14 | Edit your ``app/config/parameters.yml`` file to edit credentials for each website with paywall. For example, under Ubuntu: |
15 | |||
16 | ``sudo -u www-data nano /var/www/html/wallabag/app/config/parameters.yml`` | ||
17 | |||
18 | Here is an example for some french websites (be careful: don't use the "tab" key, only spaces): | ||
15 | 19 | ||
16 | .. code:: yaml | 20 | .. code:: yaml |
17 | 21 | ||
@@ -28,7 +32,7 @@ Parsing configuration files | |||
28 | 32 | ||
29 | .. note:: | 33 | .. note:: |
30 | 34 | ||
31 | Read `this part of the documentation <http://doc.wallabag.org/en/master/user/errors_during_fetching.html>`_ to understand the configuration files. | 35 | Read `this part of the documentation <http://doc.wallabag.org/en/master/user/errors_during_fetching.html>`_ 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. |
32 | 36 | ||
33 | Each parsing configuration file needs to be improved by adding ``requires_login``, ``login_uri``, | 37 | Each parsing configuration file needs to be improved by adding ``requires_login``, ``login_uri``, |
34 | ``login_username_field``, ``login_password_field`` and ``not_logged_in_xpath``. | 38 | ``login_username_field``, ``login_password_field`` and ``not_logged_in_xpath``. |
@@ -54,3 +58,8 @@ For example: | |||
54 | login_password_field: password | 58 | login_password_field: password |
55 | 59 | ||
56 | not_logged_in_xpath: //body[@class="not-logged-in"] | 60 | not_logged_in_xpath: //body[@class="not-logged-in"] |
61 | |||
62 | Last step: clear the cache | ||
63 | -------------------------- | ||
64 | |||
65 | 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`` | ||