diff options
author | Jeremy Benoist <jeremy.benoist@gmail.com> | 2017-03-28 14:07:42 +0200 |
---|---|---|
committer | Jeremy Benoist <jeremy.benoist@gmail.com> | 2017-03-28 14:07:42 +0200 |
commit | 7d1d961267c129e2110ce9cc14c5a9d0a7d255cb (patch) | |
tree | d260d7b4ffc8466d7d410ec61bd896bdadd8456e /docs/en | |
parent | e1cc8fd79921fdff9999087ba896c88b14ffc0cd (diff) | |
parent | 6ae579e43f6a4ffe607a6361191366410d19f806 (diff) | |
download | wallabag-7d1d961267c129e2110ce9cc14c5a9d0a7d255cb.tar.gz wallabag-7d1d961267c129e2110ce9cc14c5a9d0a7d255cb.tar.zst wallabag-7d1d961267c129e2110ce9cc14c5a9d0a7d255cb.zip |
Merge remote-tracking branch 'origin/master' into 2.3
Diffstat (limited to 'docs/en')
-rw-r--r-- | docs/en/developer/api.rst | 7 | ||||
-rw-r--r-- | docs/en/developer/paywall.rst | 15 | ||||
-rw-r--r-- | docs/en/index.rst | 1 | ||||
-rw-r--r-- | docs/en/user/configuration.rst | 4 | ||||
-rw-r--r-- | docs/en/user/configuring_mobile.rst | 14 | ||||
-rw-r--r-- | docs/en/user/first_article.rst | 66 | ||||
-rw-r--r-- | docs/en/user/installation.rst | 25 | ||||
-rw-r--r-- | docs/en/user/share.rst | 17 |
8 files changed, 51 insertions, 98 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`` | ||
diff --git a/docs/en/index.rst b/docs/en/index.rst index 2e20aee6..89f61d6d 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst | |||
@@ -33,6 +33,7 @@ The documentation is available in other languages: | |||
33 | user/errors_during_fetching | 33 | user/errors_during_fetching |
34 | user/filters | 34 | user/filters |
35 | user/tags | 35 | user/tags |
36 | user/configuring_mobile | ||
36 | user/android | 37 | user/android |
37 | user/parameters | 38 | user/parameters |
38 | user/backup | 39 | user/backup |
diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst index caca834f..bba12cb9 100644 --- a/docs/en/user/configuration.rst +++ b/docs/en/user/configuration.rst | |||
@@ -68,7 +68,9 @@ Two factor authentication (2FA) | |||
68 | Two-factor authentication (also known as 2FA) is a technology patented in 1984 | 68 | Two-factor authentication (also known as 2FA) is a technology patented in 1984 |
69 | that provides identification of users by means of the combination of two different components. | 69 | that provides identification of users by means of the combination of two different components. |
70 | 70 | ||
71 | https://en.wikipedia.org/wiki/Two-factor_authentication | 71 | https://en.wikipedia.org/wiki/Two-factor_authentication |
72 | |||
73 | **Warning**: enabling 2FA from the configuration interface is only possible if it has been authorized before in `app/config/parameters.yml` by setting the *twofactor_auth* property to `true` (do not forget to run `php bin/console cache:clear -e=prod` after modification). | ||
72 | 74 | ||
73 | If you enable 2FA, each time you want to login to wallabag, you'll receive | 75 | If you enable 2FA, each time you want to login to wallabag, you'll receive |
74 | a code by email. You have to put this code on the following form. | 76 | a code by email. You have to put this code on the following form. |
diff --git a/docs/en/user/configuring_mobile.rst b/docs/en/user/configuring_mobile.rst index 2bcf3bcb..7229aed6 100644 --- a/docs/en/user/configuring_mobile.rst +++ b/docs/en/user/configuring_mobile.rst | |||
@@ -1,13 +1,13 @@ | |||
1 | Configuring Mobile Apps to Work With wallabag.it | 1 | Configuring mobile apps to work with wallabag |
2 | ================================================ | 2 | ============================================= |
3 | 3 | ||
4 | Steps to configure the app | 4 | Steps to configure the app |
5 | --------------------------- | 5 | -------------------------- |
6 | 6 | ||
7 | - First *create a new client* in the ``Developer`` section. The name of your app doesn't matter as much as the ``Client ID`` and the ``Client secret``. Write these two values down. | 7 | - First *create a new client* in the ``API clients management`` section. The name of your app doesn't matter as much as the ``Client ID`` and the ``Client secret``. Write these two values down. |
8 | - When you download a mobile app, it's going to ask for the server address of the hosted wallabag instance. With wallabag.it that is: ``https://app.wallabag.it``. | 8 | - When you download a mobile app, it's going to ask for the server address of the hosted wallabag instance. For example, with wallabag.it that is: ``https://app.wallabag.it``. |
9 | - It's also going to ask for the aforementioned ``Client ID`` and ``secret``. Please insert those in the text fields, when asked. | 9 | - It's also going to ask for the aforementioned ``Client ID`` and ``secret``. Please insert those in the text fields, when asked. |
10 | - Lastly you need to provide your ``username`` and ``password``. These are the same credentials you use to login in to wallabag.it. | 10 | - Lastly you need to provide your ``username`` and ``password``. These are the same credentials you use to login in to wallabag. |
11 | 11 | ||
12 | Please also have a look at `Android <android>`_. Especially the section on *known limitations*. | 12 | Please also have a look at `Android <android.html>`_ page. Especially the section on *known limitations*. |
13 | 13 | ||
diff --git a/docs/en/user/first_article.rst b/docs/en/user/first_article.rst deleted file mode 100644 index 1400e1e8..00000000 --- a/docs/en/user/first_article.rst +++ /dev/null | |||
@@ -1,66 +0,0 @@ | |||
1 | Save your first article | ||
2 | ======================= | ||
3 | |||
4 | The main purpose of wallabag is to save web articles. You have many ways to do it. | ||
5 | |||
6 | .. note:: | ||
7 | |||
8 | A quickstart will be displayed in the application until you save your first article. | ||
9 | |||
10 | By using a bookmarklet | ||
11 | ---------------------- | ||
12 | |||
13 | On the ``Howto`` page, you have a ``Bookmarklet`` tab. Drag and drop the ``bag it!`` | ||
14 | link to your bookmarks bar of your browser. | ||
15 | |||
16 | Now, each time you're reading an article on the web and you want to save it, | ||
17 | click on the ``bag it!`` link in your bookmarks bar. The article is saved. | ||
18 | |||
19 | By using the classic form | ||
20 | ------------------------- | ||
21 | |||
22 | In the top bar of your screen, you have 3 icons. With the first one, a plus sign, | ||
23 | you can easily save a new article. | ||
24 | |||
25 | .. image:: ../../img/user/topbar.png | ||
26 | :alt: Top bar | ||
27 | :align: center | ||
28 | |||
29 | Click on it to display a new field, paste the article URL inside and press your | ||
30 | ``Return`` key. The article is saved. | ||
31 | |||
32 | By using a browser add-on | ||
33 | ------------------------- | ||
34 | |||
35 | Firefox | ||
36 | ~~~~~~~ | ||
37 | |||
38 | *This addon is not yet available for wallabag v2*. | ||
39 | |||
40 | Chrome | ||
41 | ~~~~~~ | ||
42 | |||
43 | *This addon is not yet available for wallabag v2*. | ||
44 | |||
45 | By using your smarphone application | ||
46 | ----------------------------------- | ||
47 | |||
48 | Android | ||
49 | ~~~~~~~ | ||
50 | |||
51 | *This application is not yet available for wallabag v2*. | ||
52 | |||
53 | Firefox OS | ||
54 | ~~~~~~~~~~ | ||
55 | |||
56 | *This application is not yet available for wallabag v2*. | ||
57 | |||
58 | Windows Phone | ||
59 | ~~~~~~~~~~~~~ | ||
60 | |||
61 | *This application is not yet available for wallabag v2*. | ||
62 | |||
63 | iOS | ||
64 | ~~~ | ||
65 | |||
66 | *This application is not yet available for wallabag v2*. | ||
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 7d3bcf61..2c4b8749 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst | |||
@@ -4,7 +4,7 @@ Install wallabag | |||
4 | Requirements | 4 | Requirements |
5 | ------------ | 5 | ------------ |
6 | 6 | ||
7 | wallabag is compatible with PHP >= 5.5, including PHP 7. | 7 | wallabag is compatible with **PHP >= 5.6**, including PHP 7. |
8 | 8 | ||
9 | .. note:: | 9 | .. note:: |
10 | 10 | ||
@@ -110,6 +110,12 @@ Virtual hosts | |||
110 | Configuration on Apache | 110 | Configuration on Apache |
111 | ~~~~~~~~~~~~~~~~~~~~~~~ | 111 | ~~~~~~~~~~~~~~~~~~~~~~~ |
112 | 112 | ||
113 | Do not forget to active the *rewrite* mod of Apache | ||
114 | |||
115 | .. code-block:: bash | ||
116 | |||
117 | a2enmod rewrite && systemctl reload apache2 | ||
118 | |||
113 | Assuming you install wallabag in the ``/var/www/wallabag`` folder and that you want to use PHP as an Apache module, here's a vhost for wallabag: | 119 | Assuming you install wallabag in the ``/var/www/wallabag`` folder and that you want to use PHP as an Apache module, here's a vhost for wallabag: |
114 | 120 | ||
115 | :: | 121 | :: |
@@ -149,6 +155,23 @@ Assuming you install wallabag in the ``/var/www/wallabag`` folder and that you w | |||
149 | ErrorLog /var/log/apache2/wallabag_error.log | 155 | ErrorLog /var/log/apache2/wallabag_error.log |
150 | CustomLog /var/log/apache2/wallabag_access.log combined | 156 | CustomLog /var/log/apache2/wallabag_access.log combined |
151 | </VirtualHost> | 157 | </VirtualHost> |
158 | |||
159 | |||
160 | .. tip:: Note for Apache 2.4, in the section `<Directory /var/www/wallabag/web>` you have to replace the directives : | ||
161 | |||
162 | :: | ||
163 | |||
164 | AllowOverride None | ||
165 | Order Allow,Deny | ||
166 | Allow from All | ||
167 | |||
168 | |||
169 | by | ||
170 | |||
171 | :: | ||
172 | |||
173 | Require All granted | ||
174 | |||
152 | 175 | ||
153 | After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld. | 176 | After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld. |
154 | 177 | ||
diff --git a/docs/en/user/share.rst b/docs/en/user/share.rst deleted file mode 100644 index e99e51ab..00000000 --- a/docs/en/user/share.rst +++ /dev/null | |||
@@ -1,17 +0,0 @@ | |||
1 | Share articles | ||
2 | ============== | ||
3 | |||
4 | When you're reading an article, you can share it. Just click on the share button: | ||
5 | |||
6 | .. image:: ../../img/user/share.png | ||
7 | :alt: share article | ||
8 | :align: center | ||
9 | |||
10 | Now, you can share the article: | ||
11 | |||
12 | - with a public URL (you'll have a light view of the article) | ||
13 | - with a tweet | ||
14 | - into your Shaarli | ||
15 | - with a post in Diaspora* | ||
16 | - to Carrot | ||
17 | - with an email | ||