[github/wallabag/wallabag.git] / docs / de / developer / paywall.rst

Articles behind a paywall
=========================

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).

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:

.. code:: yaml

    sites_credentials:
        mediapart.fr: {username: "myMediapartLogin", password: "mypassword"}
        arretsurimages.net: {username: "myASILogin", password: "mypassword"}

.. note::

    These credentials will be shared between each user of your wallabag instance.

Parsing configuration files
---------------------------

.. note::

    Read `this part of the documentation <http://doc.wallabag.org/en/master/user/errors_during_fetching.html>`_ to understand the configuration files.

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``.

Be careful, the login form must be in the page content when wallabag loads it. It's impossible for wallabag to be authenticated
on a website where the login form is loaded after the page (by ajax for example).

``login_uri`` is the action URL of the form (``action`` attribute in the form).
``login_username_field`` is the ``name`` attribute of the login field.
``login_password_field`` is the ``name`` attribute of the password field.

For example:

.. code::

    title://div[@id="titrage-contenu"]/h1[@class="title"]
    body: //div[@class="contenu-html"]/div[@class="page-pane"]

    requires_login: yes

    login_uri: http://www.arretsurimages.net/forum/login.php
    login_username_field: username
    login_password_field: password

    not_logged_in_xpath: //body[@class="not-logged-in"]
Commit	Line	Data
d51093a7 NL	1	Articles behind a paywall
	2	=========================
	3
	4	wallabag can fetch articles from websites which use a paywall system.
	5
	6	Enable paywall authentication
	7	-----------------------------
	8
	9	In internal settings, in the Article section, enable authentication for websites with paywall (with the value 1).
	10
	11	Configure credentials in wallabag
	12	---------------------------------
	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:
	15
	16	.. code:: yaml
	17
	18	sites_credentials:
	19	mediapart.fr: {username: "myMediapartLogin", password: "mypassword"}
	20	arretsurimages.net: {username: "myASILogin", password: "mypassword"}
	21
	22	.. note::
	23
	24	These credentials will be shared between each user of your wallabag instance.
	25
	26	Parsing configuration files
	27	---------------------------
	28
	29	.. note::
	30
	31	Read `this part of the documentation <http://doc.wallabag.org/en/master/user/errors_during_fetching.html>`_ to understand the configuration files.
	32
	33	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``.
	35
	36	Be careful, the login form must be in the page content when wallabag loads it. It's impossible for wallabag to be authenticated
	37	on a website where the login form is loaded after the page (by ajax for example).
	38
	39	``login_uri`` is the action URL of the form (``action`` attribute in the form).
	40	``login_username_field`` is the ``name`` attribute of the login field.
	41	``login_password_field`` is the ``name`` attribute of the password field.
	42
	43	For example:
	44
	45	.. code::
	46
	47	title://div[@id="titrage-contenu"]/h1[@class="title"]
	48	body: //div[@class="contenu-html"]/div[@class="page-pane"]
	49
	50	requires_login: yes
	51
	52	login_uri: http://www.arretsurimages.net/forum/login.php
	53	login_username_field: username
	54	login_password_field: password
	55
	56	not_logged_in_xpath: //body[@class="not-logged-in"]