aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en
diff options
context:
space:
mode:
authorNicolas LÅ“uillet <nicolas@loeuillet.org>2016-11-06 15:15:48 +0100
committerJulian Oster <jlnostr@outlook.de>2016-11-17 19:22:15 +0100
commit2e389b0b90f34d795e4bafc43d621955c05850a9 (patch)
treeeb9cd6197751383375339b0fee5ac32f362e3c0a /docs/en
parent9e0a49e6acf60c3dbf3c479cb36d404239dfda89 (diff)
downloadwallabag-2e389b0b90f34d795e4bafc43d621955c05850a9.tar.gz
wallabag-2e389b0b90f34d795e4bafc43d621955c05850a9.tar.zst
wallabag-2e389b0b90f34d795e4bafc43d621955c05850a9.zip
Reordered documentation
Diffstat (limited to 'docs/en')
-rw-r--r--docs/en/developer/asynchronous.rst159
-rw-r--r--docs/en/developer/rabbitmq.rst80
-rw-r--r--docs/en/developer/redis.rst75
-rw-r--r--docs/en/index.rst19
-rw-r--r--docs/en/user/android.rst11
-rw-r--r--docs/en/user/annotations.rst24
-rw-r--r--docs/en/user/articles.rst116
-rw-r--r--docs/en/user/backup.rst3
-rw-r--r--docs/en/user/create_account.rst21
-rw-r--r--docs/en/user/download_articles.rst17
-rw-r--r--docs/en/user/errors_during_fetching.rst4
-rw-r--r--docs/en/user/filters.rst6
-rw-r--r--docs/en/user/import.rst91
-rw-r--r--docs/en/user/login.rst13
-rw-r--r--docs/en/user/migration.rst66
-rw-r--r--docs/en/user/parameters.rst43
-rw-r--r--docs/en/user/upgrade-2.1.x-2.1.y.rst30
-rw-r--r--docs/en/user/upgrade.rst (renamed from docs/en/user/upgrade-2.0.x-2.1.1.rst)96
18 files changed, 485 insertions, 389 deletions
diff --git a/docs/en/developer/asynchronous.rst b/docs/en/developer/asynchronous.rst
new file mode 100644
index 00000000..6a991cf6
--- /dev/null
+++ b/docs/en/developer/asynchronous.rst
@@ -0,0 +1,159 @@
1Asynchronous tasks
2==================
3
4In order to launch asynchronous tasks (useful for huge imports for example), we can use RabbitMQ or Redis.
5
6Install RabbitMQ for asynchronous tasks
7---------------------------------------
8
9Requirements
10^^^^^^^^^^^^
11
12You need to have RabbitMQ installed on your server.
13
14Installation
15^^^^^^^^^^^^
16
17.. code:: bash
18
19 wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc
20 apt-key add rabbitmq-signing-key-public.asc
21 apt-get update
22 apt-get install rabbitmq-server
23
24Configuration and launch
25^^^^^^^^^^^^^^^^^^^^^^^^
26
27.. code:: bash
28
29 rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest)
30 rabbitmq-server -detached
31
32Stop RabbitMQ
33^^^^^^^^^^^^^
34
35.. code:: bash
36
37 rabbitmqctl stop
38
39
40Configure RabbitMQ in wallabag
41^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
42
43Edit your ``app/config/parameters.yml`` file to edit RabbitMQ configuration. The default one should be ok:
44
45.. code:: yaml
46
47 rabbitmq_host: localhost
48 rabbitmq_port: 5672
49 rabbitmq_user: guest
50 rabbitmq_password: guest
51
52Enable RabbitMQ in wallabag
53^^^^^^^^^^^^^^^^^^^^^^^^^^^
54
55In internal settings, in the **Import** section, enable RabbitMQ (with the value 1).
56
57Launch RabbitMQ consumer
58^^^^^^^^^^^^^^^^^^^^^^^^
59
60Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job:
61
62.. code:: bash
63
64 # for Pocket import
65 bin/console rabbitmq:consumer -e=prod import_pocket -w
66
67 # for Readability import
68 bin/console rabbitmq:consumer -e=prod import_readability -w
69
70 # for Instapaper import
71 bin/console rabbitmq:consumer -e=prod import_instapaper -w
72
73 # for wallabag v1 import
74 bin/console rabbitmq:consumer -e=prod import_wallabag_v1 -w
75
76 # for wallabag v2 import
77 bin/console rabbitmq:consumer -e=prod import_wallabag_v2 -w
78
79 # for Firefox import
80 bin/console rabbitmq:consumer -e=prod import_firefox -w
81
82 # for Chrome import
83 bin/console rabbitmq:consumer -e=prod import_chrome -w
84
85Install Redis for asynchronous tasks
86------------------------------------
87
88In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis.
89
90Requirements
91^^^^^^^^^^^^
92
93You need to have Redis installed on your server.
94
95Installation
96^^^^^^^^^^^^
97
98.. code:: bash
99
100 apt-get install redis-server
101
102Launch
103^^^^^^
104
105The server might be already running after installing, if not you can launch it using:
106
107.. code:: bash
108
109 redis-server
110
111
112Configure Redis in wallabag
113^^^^^^^^^^^^^^^^^^^^^^^^^^^
114
115Edit your ``app/config/parameters.yml`` file to edit Redis configuration. The default one should be ok:
116
117.. code:: yaml
118
119 redis_host: localhost
120 redis_port: 6379
121
122Enable Redis in wallabag
123^^^^^^^^^^^^^^^^^^^^^^^^
124
125In internal settings, in the **Import** section, enable Redis (with the value 1).
126
127Launch Redis consumer
128^^^^^^^^^^^^^^^^^^^^^
129
130Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job:
131
132.. code:: bash
133
134 # for Pocket import
135 bin/console wallabag:import:redis-worker -e=prod pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log
136
137 # for Readability import
138 bin/console wallabag:import:redis-worker -e=prod readability -vv >> /path/to/wallabag/var/logs/redis-readability.log
139
140 # for Instapaper import
141 bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log
142
143 # for wallabag v1 import
144 bin/console wallabag:import:redis-worker -e=prod wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log
145
146 # for wallabag v2 import
147 bin/console wallabag:import:redis-worker -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log
148
149 # for Firefox import
150 bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log
151
152 # for Chrome import
153 bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log
154
155If 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.. code:: bash
158
159 bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12
diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst
deleted file mode 100644
index 7ee8a5ce..00000000
--- a/docs/en/developer/rabbitmq.rst
+++ /dev/null
@@ -1,80 +0,0 @@
1Install RabbitMQ for asynchronous tasks
2=======================================
3
4In order to launch asynchronous tasks (useful for huge imports for example), we can use RabbitMQ.
5
6Requirements
7------------
8
9You need to have RabbitMQ installed on your server.
10
11Installation
12~~~~~~~~~~~~
13
14.. code:: bash
15
16 wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc
17 apt-key add rabbitmq-signing-key-public.asc
18 apt-get update
19 apt-get install rabbitmq-server
20
21Configuration and launch
22~~~~~~~~~~~~~~~~~~~~~~~~
23
24.. code:: bash
25
26 rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest)
27 rabbitmq-server -detached
28
29Stop RabbitMQ
30~~~~~~~~~~~~~
31
32.. code:: bash
33
34 rabbitmqctl stop
35
36
37Configure RabbitMQ in wallabag
38------------------------------
39
40Edit your ``app/config/parameters.yml`` file to edit RabbitMQ configuration. The default one should be ok:
41
42.. code:: yaml
43
44 rabbitmq_host: localhost
45 rabbitmq_port: 5672
46 rabbitmq_user: guest
47 rabbitmq_password: guest
48
49Enable RabbitMQ in wallabag
50---------------------------
51
52In internal settings, in the **Import** section, enable RabbitMQ (with the value 1).
53
54Launch RabbitMQ consumer
55------------------------
56
57Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job:
58
59.. code:: bash
60
61 # for Pocket import
62 bin/console rabbitmq:consumer -e=prod import_pocket -w
63
64 # for Readability import
65 bin/console rabbitmq:consumer -e=prod import_readability -w
66
67 # for Instapaper import
68 bin/console rabbitmq:consumer -e=prod import_instapaper -w
69
70 # for wallabag v1 import
71 bin/console rabbitmq:consumer -e=prod import_wallabag_v1 -w
72
73 # for wallabag v2 import
74 bin/console rabbitmq:consumer -e=prod import_wallabag_v2 -w
75
76 # for Firefox import
77 bin/console rabbitmq:consumer -e=prod import_firefox -w
78
79 # for Chrome import
80 bin/console rabbitmq:consumer -e=prod import_chrome -w
diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst
deleted file mode 100644
index ea084e66..00000000
--- a/docs/en/developer/redis.rst
+++ /dev/null
@@ -1,75 +0,0 @@
1Install Redis for asynchronous tasks
2====================================
3
4In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis.
5
6Requirements
7------------
8
9You need to have Redis installed on your server.
10
11Installation
12~~~~~~~~~~~~
13
14.. code:: bash
15
16 apt-get install redis-server
17
18Launch
19~~~~~~
20
21The server might be already running after installing, if not you can launch it using:
22
23.. code:: bash
24
25 redis-server
26
27
28Configure Redis in wallabag
29---------------------------
30
31Edit your ``app/config/parameters.yml`` file to edit Redis configuration. The default one should be ok:
32
33.. code:: yaml
34
35 redis_host: localhost
36 redis_port: 6379
37
38Enable Redis in wallabag
39------------------------
40
41In internal settings, in the **Import** section, enable Redis (with the value 1).
42
43Launch Redis consumer
44---------------------
45
46Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job:
47
48.. code:: bash
49
50 # for Pocket import
51 bin/console wallabag:import:redis-worker -e=prod pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log
52
53 # for Readability import
54 bin/console wallabag:import:redis-worker -e=prod readability -vv >> /path/to/wallabag/var/logs/redis-readability.log
55
56 # for Instapaper import
57 bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log
58
59 # for wallabag v1 import
60 bin/console wallabag:import:redis-worker -e=prod wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log
61
62 # for wallabag v2 import
63 bin/console wallabag:import:redis-worker -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log
64
65 # for Firefox import
66 bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log
67
68 # for Chrome import
69 bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log
70
71If 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 :
72
73.. code:: bash
74
75 bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12
diff --git a/docs/en/index.rst b/docs/en/index.rst
index 0ead261b..3c8595a4 100644
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -8,10 +8,6 @@ wallabag documentation
8**wallabag** is a read-it-later application: it saves a web page by 8**wallabag** is a read-it-later application: it saves a web page by
9keeping content only. Elements like navigation or ads are deleted. 9keeping content only. Elements like navigation or ads are deleted.
10 10
11.. tip::
12
13 This documentation is about wallabag v2. If you want to read documentation for wallabag v1, `please have a look here <https://github.com/wallabag/documentation>`__.
14
15The main documentation for this application is organized into a couple sections: 11The main documentation for this application is organized into a couple sections:
16 12
17* :ref:`user-docs` 13* :ref:`user-docs`
@@ -28,25 +24,19 @@ The documentation is available in other languages:
28 :maxdepth: 2 24 :maxdepth: 2
29 :caption: User documentation 25 :caption: User documentation
30 26
31 user/faq
32 user/installation 27 user/installation
33 user/upgrade-2.0.x-2.1.1 28 user/upgrade
34 user/upgrade-2.1.x-2.1.y
35 user/migration
36 user/import 29 user/import
37 user/create_account 30 user/create_account
38 user/login
39 user/configuration 31 user/configuration
40 user/first_article 32 user/articles
41 user/errors_during_fetching 33 user/errors_during_fetching
42 user/annotations
43 user/download_articles
44 user/share
45 user/filters 34 user/filters
46 user/tags 35 user/tags
47 user/android 36 user/android
48 user/parameters 37 user/parameters
49 user/backup 38 user/backup
39 user/faq
50 40
51.. _dev-docs: 41.. _dev-docs:
52 42
@@ -59,5 +49,4 @@ The documentation is available in other languages:
59 developer/documentation 49 developer/documentation
60 developer/translate 50 developer/translate
61 developer/maintenance 51 developer/maintenance
62 developer/redis 52 developer/asynchronous
63 developer/rabbitmq
diff --git a/docs/en/user/android.rst b/docs/en/user/android.rst
index 91dcb2fc..d210d6da 100644
--- a/docs/en/user/android.rst
+++ b/docs/en/user/android.rst
@@ -1,13 +1,11 @@
1Android App 1Android application
2=========== 2===================
3
4 3
5Purpose of this document 4Purpose of this document
6------------------------ 5------------------------
7 6
8This document describes how you can setup your Android application to work with your wallabag instance. There is no difference in this procedure for wallabag v1 or v2. 7This document describes how you can setup your Android application to work with your wallabag instance. There is no difference in this procedure for wallabag v1 or v2.
9 8
10
11Steps to configure your app 9Steps to configure your app
12--------------------------- 10---------------------------
13 11
@@ -71,8 +69,6 @@ Finally after the synchronisation finished successfully, you are presented to th
71 :alt: Filled article list cause feeds successfully synchronized 69 :alt: Filled article list cause feeds successfully synchronized
72 :align: center 70 :align: center
73 71
74
75
76Known limitations 72Known limitations
77----------------- 73-----------------
78 74
@@ -81,19 +77,16 @@ Known limitations
81 77
82Currently the Android application does not support two-factor authentication. You should disable that to get the application working. 78Currently the Android application does not support two-factor authentication. You should disable that to get the application working.
83 79
84
85Limited amount of articles with wallabag v2 80Limited amount of articles with wallabag v2
86~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 81~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
87 82
88In your wallabag web instance you can configure how many items are part of the RSS feed. This option did not exist in wallabag v1, where all articles were part of the feed. So if you set the amount of articles being displayed greater than the number of items being content of your RSS feed, you will only see the number of items in your RSS feed. 83In your wallabag web instance you can configure how many items are part of the RSS feed. This option did not exist in wallabag v1, where all articles were part of the feed. So if you set the amount of articles being displayed greater than the number of items being content of your RSS feed, you will only see the number of items in your RSS feed.
89 84
90
91SSL/TLS encryption 85SSL/TLS encryption
92~~~~~~~~~~~~~~~~~~ 86~~~~~~~~~~~~~~~~~~
93 87
94If you can reach your wallabag web instance via HTTPS, you should use that. Especially if your HTTP URL redirects you to the HTTPS one. Currently, the app cannot handle that redirect properly. 88If you can reach your wallabag web instance via HTTPS, you should use that. Especially if your HTTP URL redirects you to the HTTPS one. Currently, the app cannot handle that redirect properly.
95 89
96
97References 90References
98---------- 91----------
99 92
diff --git a/docs/en/user/annotations.rst b/docs/en/user/annotations.rst
deleted file mode 100644
index fab854aa..00000000
--- a/docs/en/user/annotations.rst
+++ /dev/null
@@ -1,24 +0,0 @@
1Annotations
2===========
3
4In each article you read, you can write annotations. It's easier to understand with some pictures.
5
6Select the part of the article that you want to annotate and click on the pencil:
7
8.. image:: ../../img/user/annotations_1.png
9 :alt: Select your text
10 :align: center
11
12Then, write your annotation:
13
14.. image:: ../../img/user/annotations_2.png
15 :alt: Write your annotation
16 :align: center
17
18The text is now highlighted and you can read your annotation if you move the mouse cursor over it.
19
20.. image:: ../../img/user/annotations_3.png
21 :alt: Read your annotation
22 :align: center
23
24You can create as many annotations as you wish.
diff --git a/docs/en/user/articles.rst b/docs/en/user/articles.rst
new file mode 100644
index 00000000..16b3b0d2
--- /dev/null
+++ b/docs/en/user/articles.rst
@@ -0,0 +1,116 @@
1Articles
2========
3
4Save your first article
5-----------------------
6
7The main purpose of wallabag is to save web articles. You have many ways to do it. If you think that the article is wrong displayed, `you can read this documentation <http://doc.wallabag.org/en/master/user/errors_during_fetching.html>`_.
8
9By using a bookmarklet
10^^^^^^^^^^^^^^^^^^^^^^
11
12On the ``Howto`` page, you have a ``Bookmarklet`` tab. Drag and drop the ``bag it!``
13link to your bookmarks bar of your browser.
14
15Now, each time you're reading an article on the web and you want to save it,
16click on the ``bag it!`` link in your bookmarks bar. The article is saved.
17
18By using the classic form
19^^^^^^^^^^^^^^^^^^^^^^^^^
20
21In the top bar of your screen, you have 3 icons. With the first one, a plus sign,
22you can easily save a new article.
23
24.. image:: ../../img/user/topbar.png
25 :alt: Top bar
26 :align: center
27
28Click on it to display a new field, paste the article URL inside and press your
29``Return`` key. The article is saved.
30
31By using a browser add-on
32^^^^^^^^^^^^^^^^^^^^^^^^^
33
34Firefox
35"""""""
36
37You can download the `Firefox addon here <https://addons.mozilla.org/firefox/addon/wallabag-v2/>`_.
38
39Chrome
40""""""
41
42You can download the `Chrome addon here <https://chrome.google.com/webstore/detail/wallabagger/gbmgphmejlcoihgedabhgjdkcahacjlj?hl=fr>`_.
43
44By using your smarphone application
45^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
46
47Android
48"""""""
49
50You can download the `Android application here <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_.
51
52Windows Phone
53"""""""""""""
54
55You can downlaod the `Windows Phone application here <https://www.microsoft.com/store/apps/9nblggh5x3p6>`_.
56
57Download your articles
58----------------------
59
60You can download each article in several formats: ePUB, MOBI, PDF, XML, JSON, CSV.
61
62On the article view, click on this icon, in the sidebar:
63
64.. image:: ../../img/user/download_article.png
65 :alt: download article
66 :align: center
67
68You can also download a full category (unread, starred, archive) in these formats.
69For example, on **Unread** view, click on this icon in the top bar:
70
71.. image:: ../../img/user/download_articles.png
72 :alt: download articles
73 :align: center
74
75Share your articles
76-------------------
77
78When you're reading an article, you can share it. Just click on the share button:
79
80.. image:: ../../img/user/share.png
81 :alt: share article
82 :align: center
83
84Now, you can share the article:
85
86- with a public URL (you'll have a light view of the article)
87- with a tweet
88- into your Shaarli
89- with a post in Diaspora*
90- to Carrot
91- with an email
92
93Annotate your articles
94----------------------
95
96In each article you read, you can write annotations. It's easier to understand with some pictures.
97
98Select the part of the article that you want to annotate and click on the pencil:
99
100.. image:: ../../img/user/annotations_1.png
101 :alt: Select your text
102 :align: center
103
104Then, write your annotation:
105
106.. image:: ../../img/user/annotations_2.png
107 :alt: Write your annotation
108 :align: center
109
110The text is now highlighted and you can read your annotation if you move the mouse cursor over it.
111
112.. image:: ../../img/user/annotations_3.png
113 :alt: Read your annotation
114 :align: center
115
116You can create as many annotations as you wish.
diff --git a/docs/en/user/backup.rst b/docs/en/user/backup.rst
index 51721000..f8b480a3 100644
--- a/docs/en/user/backup.rst
+++ b/docs/en/user/backup.rst
@@ -1,5 +1,6 @@
1Backup wallabag 1Backup wallabag
2=============== 2===============
3
3Because sometimes you may do a mistake with your wallabag and lose data or in case you need to move your wallabag to another server you want to backup your data. 4Because sometimes you may do a mistake with your wallabag and lose data or in case you need to move your wallabag to another server you want to backup your data.
4This articles describes what you need to backup. 5This articles describes what you need to backup.
5 6
@@ -22,4 +23,4 @@ To backup the SQLite database, you just need to copy the directory `data/db` fro
22 23
23Images 24Images
24------ 25------
25The images retrieved by wallabag are stored under `data/assets/images` (the images storage will be implemented in wallabag 2.2). 26The images retrieved by wallabag are stored under `web/assets/images` (the images storage will be implemented in wallabag 2.2).
diff --git a/docs/en/user/create_account.rst b/docs/en/user/create_account.rst
index 2e883c88..8c43867d 100644
--- a/docs/en/user/create_account.rst
+++ b/docs/en/user/create_account.rst
@@ -1,5 +1,8 @@
1Create an account 1Create an account and authentication
2================= 2====================================
3
4Register
5--------
3 6
4On the login page, click on ``Register`` button. 7On the login page, click on ``Register`` button.
5 8
@@ -23,3 +26,17 @@ Your account is now activated.
23.. image:: ../../img/user/activated_account.png 26.. image:: ../../img/user/activated_account.png
24 :alt: Welcome on board! 27 :alt: Welcome on board!
25 :align: center 28 :align: center
29
30Login
31-----
32
33Your account is now enabled, congratulations!
34
35To login to wallabag, fill the form on login page.
36
37If you are on your personal computer and you want to stay connected,
38you can check the ``Keep me logged in`` checkbox: wallabag will remember you for one year.
39
40.. image:: ../../img/user/login_form.png
41 :alt: Login form
42 :align: center
diff --git a/docs/en/user/download_articles.rst b/docs/en/user/download_articles.rst
deleted file mode 100644
index 4813776d..00000000
--- a/docs/en/user/download_articles.rst
+++ /dev/null
@@ -1,17 +0,0 @@
1Download articles
2=================
3
4You can download each article in several formats: ePUB, MOBI, PDF, XML, JSON, CSV.
5
6On the article view, click on this icon, in the sidebar:
7
8.. image:: ../../img/user/download_article.png
9 :alt: download article
10 :align: center
11
12You can also download a full category (unread, starred, archive) in these formats.
13For example, on **Unread** view, click on this icon in the top bar:
14
15.. image:: ../../img/user/download_articles.png
16 :alt: download articles
17 :align: center
diff --git a/docs/en/user/errors_during_fetching.rst b/docs/en/user/errors_during_fetching.rst
index 6684563a..c5e18d3b 100644
--- a/docs/en/user/errors_during_fetching.rst
+++ b/docs/en/user/errors_during_fetching.rst
@@ -12,9 +12,7 @@ There may be several reasons:
12How can I help to fix that? 12How can I help to fix that?
13--------------------------- 13---------------------------
14 14
15You can `sending us an email with the article's URL <mailto:hello@wallabag.org>`_. 15You can try to fix this problem by yourself (so we can be focused on improving wallabag internally instead of writing siteconfig :) ).
16
17Or you can also try to fix this problem by yourself (so we can be focused on improving wallabag internally instead of writing siteconfig :) ).
18 16
19You can try to see if it works here: `http://f43.me/feed/test <http://f43.me/feed/test>`_ (it uses almost the same system as wallabag to retrieve content). 17You can try to see if it works here: `http://f43.me/feed/test <http://f43.me/feed/test>`_ (it uses almost the same system as wallabag to retrieve content).
20 18
diff --git a/docs/en/user/filters.rst b/docs/en/user/filters.rst
index ad06819b..4d1df6eb 100644
--- a/docs/en/user/filters.rst
+++ b/docs/en/user/filters.rst
@@ -1,7 +1,7 @@
1Filters 1Retrieve your articles thanks to filters
2======= 2========================================
3 3
4To retrieve articles easier, you can use filters. 4To retrieve articles easily, you can use filters.
5Click on the third icon in the top bar. 5Click on the third icon in the top bar.
6 6
7.. image:: ../../img/user/topbar.png 7.. image:: ../../img/user/topbar.png
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst
index 38cd30c1..269e226c 100644
--- a/docs/en/user/import.rst
+++ b/docs/en/user/import.rst
@@ -1,8 +1,18 @@
1Migrate from a third service 1Migrate from ...
2============================ 2================
3 3
4From Pocket 4In wallabag 2.x, you can import data from:
5----------- 5
6- `Pocket <#id1>`_
7- `Readability <#id2>`_
8- `Instapaper <#instapaper>`_
9- `wallabag 1.x <#wallabag-1-x>`_
10- `wallabag 2.x <#wallabag-2-x>`_
11
12We also developed `a script to execute migrations via command-line interface <#import-via-command-line-interface-cli>`_.
13
14Pocket
15------
6 16
7Create a new application on Pocket 17Create a new application on Pocket
8~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 18~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -29,8 +39,8 @@ and then on ``Connect to Pocket and import data``.
29You need to authorize wallabag to interact with your Pocket account. 39You need to authorize wallabag to interact with your Pocket account.
30Your data will be imported. Data import can be a demanding process for your server. 40Your data will be imported. Data import can be a demanding process for your server.
31 41
32From Readability 42Readability
33---------------- 43-----------
34 44
35Export your Readability data 45Export your Readability data
36~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 46~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -45,8 +55,8 @@ and then select your json file and upload it.
45 55
46Your data will be imported. Data import can be a demanding process for your server. 56Your data will be imported. Data import can be a demanding process for your server.
47 57
48From Instapaper 58Instapaper
49--------------- 59----------
50 60
51Export your Instapaper data 61Export your Instapaper data
52~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 62~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -61,7 +71,66 @@ and then select your CSV file and upload it.
61 71
62Your data will be imported. Data import can be a demanding process for your server. 72Your data will be imported. Data import can be a demanding process for your server.
63 73
64From HTML or JSON file 74wallabag 1.x
65---------------------- 75------------
76
77If you were using wallabag v1.x, you need to export your data before migrating to wallabag v2.x, because the application and its database changed a lot. In your old wallabag installation, you can export your data, which can be done on the Config page of your old wallabag installation.
78
79.. image:: ../../img/user/export_v1.png
80 :alt: Exporting from wallabag v1
81 :align: center
82
83.. note::
84 If you have multiple accounts on the same instance of wallabag, each user must export from v1 and import into v2 its data.
85
86.. note::
87 If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
88
89When you have retrieved the json file containing your entries, you can install wallabag v2 if needed by following `the standard procedure <http://doc.wallabag.org/en/master/user/installation.html>`__.
90
91After creating an user account on your new wallabag v2 instance, you must head over to the `Import` section and select `Import from wallabag v1`. Select your json file and upload it.
92
93.. image:: ../../img/user/import_wallabagv1.png
94 :alt: Import from wallabag v1
95 :align: center
96
97wallabag 2.x
98------------
99
100From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json.
101
102.. image:: ../../img/user/export_v2.png
103 :alt: Export depuis wallabag v2
104 :align: center
105
106From your new wallabag instance, create your user account and click on the link in the menu to proceed to import. Choose import from wallabag v2 and select your json file to upload it.
107
108.. note::
109 If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
110
111Import via command-line interface (CLI)
112---------------------------------------
113
114If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export:
115
116::
117
118 bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
119
120Please replace values:
121
122* ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1)
123* ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export
124
125If you want to mark all these entries as read, you can add the ``--markAsRead`` option.
126
127To import a wallabag v2 file, you need to add the option ``--importer=v2``.
128
129You'll have this in return:
130
131::
66 132
67*Feature not yet implemented in wallabag v2.* 133 Start : 05-04-2016 11:36:07 ---
134 403 imported
135 0 already saved
136 End : 05-04-2016 11:36:09 ---
diff --git a/docs/en/user/login.rst b/docs/en/user/login.rst
deleted file mode 100644
index e66089bd..00000000
--- a/docs/en/user/login.rst
+++ /dev/null
@@ -1,13 +0,0 @@
1Login
2=====
3
4Your account is now enabled, congratulations!
5
6To login to wallabag, fill the form on login page.
7
8If you are on your personal computer and you want to stay connected,
9you can check the ``Keep me logged in`` checkbox: wallabag will remember you for one year.
10
11.. image:: ../../img/user/login_form.png
12 :alt: Login form
13 :align: center
diff --git a/docs/en/user/migration.rst b/docs/en/user/migration.rst
deleted file mode 100644
index 42062796..00000000
--- a/docs/en/user/migration.rst
+++ /dev/null
@@ -1,66 +0,0 @@
1Migrate from v1 or v2
2=====================
3
4From wallabag 1.x
5-----------------
6
7If you were using wallabag v1.x, you need to export your data before migrating to wallabag v2.x, because the application and its database changed a lot. In your old wallabag installation, you can export your data, which can be done on the Config page of your old wallabag installation.
8
9.. image:: ../../img/user/export_v1.png
10 :alt: Exporting from wallabag v1
11 :align: center
12
13.. note::
14 If you have multiple accounts on the same instance of wallabag, each user must export from v1 and import into v2 its data.
15
16.. note::
17 If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
18
19When you have retrieved the json file containing your entries, you can install wallabag v2 if needed by following `the standard procedure <http://doc.wallabag.org/en/master/user/installation.html>`__.
20
21After creating an user account on your new wallabag v2 instance, you must head over to the `Import` section and select `Import from wallabag v1`. Select your json file and upload it.
22
23.. image:: ../../img/user/import_wallabagv1.png
24 :alt: Import from wallabag v1
25 :align: center
26
27From wallabag 2.x
28-----------------
29
30From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json.
31
32.. image:: ../../img/user/export_v2.png
33 :alt: Export depuis wallabag v2
34 :align: center
35
36From your new wallabag instance, create your user account and click on the link in the menu to proceed to import. Choose import from wallabag v2 and select your json file to upload it.
37
38.. note::
39 If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
40
41Import via command-line interface (CLI)
42---------------------------------------
43
44If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export:
45
46::
47
48 bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
49
50Please replace values:
51
52* ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1)
53* ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export
54
55If you want to mark all these entries as read, you can add the ``--markAsRead`` option.
56
57To import a wallabag v2 file, you need to add the option ``--importer=v2``.
58
59You'll have this in return:
60
61::
62
63 Start : 05-04-2016 11:36:07 ---
64 403 imported
65 0 already saved
66 End : 05-04-2016 11:36:09 ---
diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst
index 6cbd5ae4..6ccc03b4 100644
--- a/docs/en/user/parameters.rst
+++ b/docs/en/user/parameters.rst
@@ -1,5 +1,48 @@
1What is the meaning of the parameters? 1What is the meaning of the parameters?
2====================================== 2======================================
3
4Default `parameters.yml` file
5-----------------------------
6
7Here is the last version of the default `app/config/parameters.yml` file. Be sure that yours respects this one.
8If you don't know which parameter you need to set, please leave the default one.
9
10.. code-block:: yml
11
12 parameters:
13 database_driver: pdo_sqlite
14 database_host: 127.0.0.1
15 database_port: null
16 database_name: symfony
17 database_user: root
18 database_password: null
19 database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite'
20 database_table_prefix: wallabag_
21 database_socket: null
22 mailer_transport: smtp
23 mailer_host: 127.0.0.1
24 mailer_user: null
25 mailer_password: null
26 locale: en
27 secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv
28 twofactor_auth: true
29 twofactor_sender: no-reply@wallabag.org
30 fosuser_registration: true
31 fosuser_confirmation: true
32 from_email: no-reply@wallabag.org
33 rss_limit: 50
34 rabbitmq_host: localhost
35 rabbitmq_port: 5672
36 rabbitmq_user: guest
37 rabbitmq_password: guest
38 redis_scheme: tcp
39 redis_host: localhost
40 redis_port: 6379
41 redis_path: null
42
43Meaning of each parameter
44-------------------------
45
3.. csv-table:: Database parameters 46.. csv-table:: Database parameters
4 :header: "name", "default", "description" 47 :header: "name", "default", "description"
5 48
diff --git a/docs/en/user/upgrade-2.1.x-2.1.y.rst b/docs/en/user/upgrade-2.1.x-2.1.y.rst
deleted file mode 100644
index fb41a07b..00000000
--- a/docs/en/user/upgrade-2.1.x-2.1.y.rst
+++ /dev/null
@@ -1,30 +0,0 @@
1Upgrading from 2.1.x to 2.1.y
2=============================
3
4Upgrade on a dedicated web server
5---------------------------------
6
7The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.1.3`` by the last release number):
8
9::
10
11 make update
12
13Upgrade on a shared hosting
14---------------------------
15
16Backup your ``app/config/parameters.yml`` file.
17
18Download the last release of wallabag:
19
20.. code-block:: bash
21
22 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
23
24You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
25
26Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
27
28If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
29
30Empty ``var/cache`` folder.
diff --git a/docs/en/user/upgrade-2.0.x-2.1.1.rst b/docs/en/user/upgrade.rst
index 3b39fc8c..544d57eb 100644
--- a/docs/en/user/upgrade-2.0.x-2.1.1.rst
+++ b/docs/en/user/upgrade.rst
@@ -1,12 +1,21 @@
1Upgrade your wallabag installation
2==================================
3
4You will find here different ways to upgrade your wallabag:
5
6- `from 2.0.x to 2.1.1 <#upgrade-from-2-0-x-to-2-1-1>`_
7- `from 2.1.x to 2.1.y <#upgrading-from-2-1-x-to-2-1-y>`_
8- `from 1.x to 2.x <#from-wallabag-1-x>`_
9
1Upgrade from 2.0.x to 2.1.1 10Upgrade from 2.0.x to 2.1.1
2=========================== 11---------------------------
3 12
4.. warning:: 13.. warning::
5 14
6 Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade. 15 Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade.
7 16
8Upgrade on a dedicated web server 17Upgrade on a dedicated web server
9--------------------------------- 18^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10 19
11:: 20::
12 21
@@ -19,11 +28,11 @@ Upgrade on a dedicated web server
19 php bin/console cache:clear --env=prod 28 php bin/console cache:clear --env=prod
20 29
21Upgrade on a shared hosting 30Upgrade on a shared hosting
22--------------------------- 31^^^^^^^^^^^^^^^^^^^^^^^^^^^
23 32
24Backup your ``app/config/parameters.yml`` file. 33Backup your ``app/config/parameters.yml`` file.
25 34
26Download the last release of wallabag: 35Download the 2.1.1 release of wallabag:
27 36
28.. code-block:: bash 37.. code-block:: bash
29 38
@@ -33,42 +42,7 @@ Download the last release of wallabag:
33 42
34Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. 43Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
35 44
36Please check that your ``app/config/parameters.yml`` contains all the required parameters. Here is a default ``parameters.yml`` file. If you don't know which parameter you need to set, please leave the default one. 45Please check that your ``app/config/parameters.yml`` contains all the required parameters. You can find `here a documentation about parameters <http://doc.wallabag.org/en/master/user/parameters.html>`_.
37
38.. code-block:: yml
39
40 parameters:
41 database_driver: pdo_sqlite
42 database_host: 127.0.0.1
43 database_port: null
44 database_name: symfony
45 database_user: root
46 database_password: null
47 database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite'
48 database_table_prefix: wallabag_
49 database_socket: null
50 mailer_transport: smtp
51 mailer_host: 127.0.0.1
52 mailer_user: null
53 mailer_password: null
54 locale: en
55 secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv
56 twofactor_auth: true
57 twofactor_sender: no-reply@wallabag.org
58 fosuser_registration: true
59 fosuser_confirmation: true
60 from_email: no-reply@wallabag.org
61 rss_limit: 50
62 rabbitmq_host: localhost
63 rabbitmq_port: 5672
64 rabbitmq_user: guest
65 rabbitmq_password: guest
66 redis_scheme: tcp
67 redis_host: localhost
68 redis_port: 6379
69 redis_path: null
70
71You can find `here a documentation about parameters <http://doc.wallabag.org/en/master/user/parameters.html>`_.
72 46
73If you use SQLite, you must also copy your ``data/`` folder inside the new installation. 47If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
74 48
@@ -85,3 +59,45 @@ You must run some SQL queries to upgrade your database. We assume that the table
85 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); 59 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import');
86 ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; 60 ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL;
87 DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; 61 DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key';
62
63Upgrading from 2.1.x to 2.1.y
64-----------------------------
65
66Upgrade on a dedicated web server
67^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
68
69In order to upgrade your wallabag installation and get the last version, run the following command in you wallabag folder:
70
71::
72
73 make update
74
75Upgrade on a shared hosting
76^^^^^^^^^^^^^^^^^^^^^^^^^^^
77
78Backup your ``app/config/parameters.yml`` file.
79
80Download the last release of wallabag:
81
82.. code-block:: bash
83
84 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
85
86You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
87
88Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
89
90Please check that your ``app/config/parameters.yml`` contains all the required parameters. You can find `here a documentation about parameters <http://doc.wallabag.org/en/master/user/parameters.html>`_.
91
92If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
93
94Empty ``var/cache`` folder.
95
96From wallabag 1.x
97-----------------
98
99There is no automatic script to update from wallabag 1.x to wallabag 2.x. You need to:
100
101- export your data
102- install wallabag 2.x (`read the installation documentation <http://doc.wallabag.org/en/master/user/installation.html>`_ )
103- import data in this fresh installation (`read the import documentation <http://doc.wallabag.org/en/master/user/import.html>`_ )