wallabag/docs/en/developer/paywall.rst

Articles behind a paywall

wallabag can fetch articles from websites which use a paywall system.

Enable paywall authentication

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

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

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:

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"]

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