diff options
Diffstat (limited to 'docs/en/developer')
-rw-r--r-- | docs/en/developer/api.rst | 7 | ||||
-rw-r--r-- | docs/en/developer/asynchronous.rst | 3 | ||||
-rw-r--r-- | docs/en/developer/maintenance.rst | 32 | ||||
-rw-r--r-- | docs/en/developer/paywall.rst | 56 | ||||
-rw-r--r-- | docs/en/developer/translate.rst | 2 |
5 files changed, 63 insertions, 37 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/asynchronous.rst b/docs/en/developer/asynchronous.rst index 6a991cf6..2e409e4a 100644 --- a/docs/en/developer/asynchronous.rst +++ b/docs/en/developer/asynchronous.rst | |||
@@ -48,6 +48,7 @@ Edit your ``app/config/parameters.yml`` file to edit RabbitMQ configuration. The | |||
48 | rabbitmq_port: 5672 | 48 | rabbitmq_port: 5672 |
49 | rabbitmq_user: guest | 49 | rabbitmq_user: guest |
50 | rabbitmq_password: guest | 50 | rabbitmq_password: guest |
51 | rabbitmq_prefetch_count: 10 # read http://www.rabbitmq.com/consumer-prefetch.html | ||
51 | 52 | ||
52 | Enable RabbitMQ in wallabag | 53 | Enable RabbitMQ in wallabag |
53 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | 54 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
@@ -150,7 +151,7 @@ Depending on which service you want to import from you need to enable one (or ma | |||
150 | bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log | 151 | bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log |
151 | 152 | ||
152 | # for Chrome import | 153 | # for Chrome import |
153 | bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log | 154 | bin/console wallabag:import:redis-worker -e=prod chrome -vv >> /path/to/wallabag/var/logs/redis-chrome.log |
154 | 155 | ||
155 | If you want to launch the import only for some messages and not all, you can specify this number (here 12) and the worker will stop right after the 12th message : | 156 | If you want to launch the import only for some messages and not all, you can specify this number (here 12) and the worker will stop right after the 12th message : |
156 | 157 | ||
diff --git a/docs/en/developer/maintenance.rst b/docs/en/developer/maintenance.rst deleted file mode 100644 index 6d55ed60..00000000 --- a/docs/en/developer/maintenance.rst +++ /dev/null | |||
@@ -1,32 +0,0 @@ | |||
1 | Maintenance mode | ||
2 | ================ | ||
3 | |||
4 | If you have some long tasks to do on your wallabag instance, you can enable a maintenance mode. | ||
5 | Nobody will have access to your instance. | ||
6 | |||
7 | Enable maintenance mode | ||
8 | ----------------------- | ||
9 | |||
10 | To enable maintenance mode, execute this command: | ||
11 | |||
12 | :: | ||
13 | |||
14 | bin/console lexik:maintenance:lock --no-interaction -e=prod | ||
15 | |||
16 | You can set your IP address in ``app/config/config.yml`` if you want to access to wallabag even if maintenance mode is enabled. For example: | ||
17 | |||
18 | :: | ||
19 | |||
20 | lexik_maintenance: | ||
21 | authorized: | ||
22 | ips: ['127.0.0.1'] | ||
23 | |||
24 | |||
25 | Disable maintenance mode | ||
26 | ------------------------ | ||
27 | |||
28 | To disable maintenance mode, execute this command: | ||
29 | |||
30 | :: | ||
31 | |||
32 | bin/console lexik:maintenance:unlock -e=prod | ||
diff --git a/docs/en/developer/paywall.rst b/docs/en/developer/paywall.rst new file mode 100644 index 00000000..365027b4 --- /dev/null +++ b/docs/en/developer/paywall.rst | |||
@@ -0,0 +1,56 @@ | |||
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"] | ||
diff --git a/docs/en/developer/translate.rst b/docs/en/developer/translate.rst index d412d3e9..1e5d5009 100644 --- a/docs/en/developer/translate.rst +++ b/docs/en/developer/translate.rst | |||
@@ -20,7 +20,7 @@ is the ISO 639-1 code of your language (`see wikipedia <https://en.wikipedia.org | |||
20 | Other files to translate: | 20 | Other files to translate: |
21 | 21 | ||
22 | - https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations. | 22 | - https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations. |
23 | - https://github.com/wallabag/wallabag/tree/master/app/Resources/FOSUserBundle/translations. | 23 | - https://github.com/wallabag/wallabag/tree/master/src/Wallabag/UserBundle/Resources/translations. |
24 | 24 | ||
25 | You have to create ``THE_TRANSLATION_FILE.CODE.yml`` files. | 25 | You have to create ``THE_TRANSLATION_FILE.CODE.yml`` files. |
26 | 26 | ||