The documentation was imported from the former wallabag/doc repository.
We imported the documentation with:
git subtree add --prefix=doc <path-or-url-to-wallabag/doc> master
A one-pass equivalent cleanup for imported commit messages was then:
python3 git-filter-repo \
--message-callback 'return re.sub(br"(?<![/\w])#(\d{1,3})(?!\d)", br"https://github.com/wallabag/doc/pull/\1", message)' \
--refs master..chore/merge-doc-into-monorepo \
--force
The rewrite approach was inspired by https://web.archive.org/web/20241208191856/https://aaronhe.org/git-filter-repo-to-rewrite-commit-history.
git-subtree-dir: doc
git-subtree-mainline: 6c48d72c64
git-subtree-split: 04f0bd51cc
1.6 KiB
title, weight
| title | weight |
|---|---|
| Paywall | 8 |
Configuring paywall access
{{< callout icon="beaker" >}} This is the technical part about the paywall. If you are looking for the user part, please check [that page instead]({{< relref "../user/articles/restricted.md" >}}). {{< /callout >}}
Read [this part of the documentation]({{< relref "../user/errors_during_fetching.md" >}})
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"]
To add additional parameters to the login query, specify them using the following format:
login_extra_fields: myParameter=value