diff options
Diffstat (limited to 'docs/en')
-rw-r--r-- | docs/en/developer/asynchronous.rst | 159 | ||||
-rw-r--r-- | docs/en/developer/rabbitmq.rst | 80 | ||||
-rw-r--r-- | docs/en/developer/redis.rst | 75 | ||||
-rw-r--r-- | docs/en/index.rst | 23 | ||||
-rw-r--r-- | docs/en/user/android.rst | 32 | ||||
-rw-r--r-- | docs/en/user/annotations.rst | 24 | ||||
-rw-r--r-- | docs/en/user/articles.rst | 116 | ||||
-rw-r--r-- | docs/en/user/backup.rst | 3 | ||||
-rw-r--r-- | docs/en/user/configuration.rst | 10 | ||||
-rw-r--r-- | docs/en/user/create_account.rst | 21 | ||||
-rw-r--r-- | docs/en/user/download_articles.rst | 17 | ||||
-rw-r--r-- | docs/en/user/errors_during_fetching.rst | 4 | ||||
-rw-r--r-- | docs/en/user/filters.rst | 6 | ||||
-rw-r--r-- | docs/en/user/import.rst | 91 | ||||
-rw-r--r-- | docs/en/user/installation.rst | 6 | ||||
-rw-r--r-- | docs/en/user/login.rst | 13 | ||||
-rw-r--r-- | docs/en/user/migration.rst | 66 | ||||
-rw-r--r-- | docs/en/user/parameters.rst | 43 | ||||
-rw-r--r-- | docs/en/user/upgrade-2.1.x-2.1.y.rst | 35 | ||||
-rw-r--r-- | docs/en/user/upgrade.rst (renamed from docs/en/user/upgrade-2.0.x-2.1.1.rst) | 93 |
20 files changed, 506 insertions, 411 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 @@ | |||
1 | Asynchronous tasks | ||
2 | ================== | ||
3 | |||
4 | In order to launch asynchronous tasks (useful for huge imports for example), we can use RabbitMQ or Redis. | ||
5 | |||
6 | Install RabbitMQ for asynchronous tasks | ||
7 | --------------------------------------- | ||
8 | |||
9 | Requirements | ||
10 | ^^^^^^^^^^^^ | ||
11 | |||
12 | You need to have RabbitMQ installed on your server. | ||
13 | |||
14 | Installation | ||
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 | |||
24 | Configuration 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 | |||
32 | Stop RabbitMQ | ||
33 | ^^^^^^^^^^^^^ | ||
34 | |||
35 | .. code:: bash | ||
36 | |||
37 | rabbitmqctl stop | ||
38 | |||
39 | |||
40 | Configure RabbitMQ in wallabag | ||
41 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
42 | |||
43 | Edit 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 | |||
52 | Enable RabbitMQ in wallabag | ||
53 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
54 | |||
55 | In internal settings, in the **Import** section, enable RabbitMQ (with the value 1). | ||
56 | |||
57 | Launch RabbitMQ consumer | ||
58 | ^^^^^^^^^^^^^^^^^^^^^^^^ | ||
59 | |||
60 | Depending 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 | |||
85 | Install Redis for asynchronous tasks | ||
86 | ------------------------------------ | ||
87 | |||
88 | In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis. | ||
89 | |||
90 | Requirements | ||
91 | ^^^^^^^^^^^^ | ||
92 | |||
93 | You need to have Redis installed on your server. | ||
94 | |||
95 | Installation | ||
96 | ^^^^^^^^^^^^ | ||
97 | |||
98 | .. code:: bash | ||
99 | |||
100 | apt-get install redis-server | ||
101 | |||
102 | Launch | ||
103 | ^^^^^^ | ||
104 | |||
105 | The server might be already running after installing, if not you can launch it using: | ||
106 | |||
107 | .. code:: bash | ||
108 | |||
109 | redis-server | ||
110 | |||
111 | |||
112 | Configure Redis in wallabag | ||
113 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
114 | |||
115 | Edit 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 | |||
122 | Enable Redis in wallabag | ||
123 | ^^^^^^^^^^^^^^^^^^^^^^^^ | ||
124 | |||
125 | In internal settings, in the **Import** section, enable Redis (with the value 1). | ||
126 | |||
127 | Launch Redis consumer | ||
128 | ^^^^^^^^^^^^^^^^^^^^^ | ||
129 | |||
130 | Depending 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 | |||
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 | |||
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 @@ | |||
1 | Install RabbitMQ for asynchronous tasks | ||
2 | ======================================= | ||
3 | |||
4 | In order to launch asynchronous tasks (useful for huge imports for example), we can use RabbitMQ. | ||
5 | |||
6 | Requirements | ||
7 | ------------ | ||
8 | |||
9 | You need to have RabbitMQ installed on your server. | ||
10 | |||
11 | Installation | ||
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 | |||
21 | Configuration 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 | |||
29 | Stop RabbitMQ | ||
30 | ~~~~~~~~~~~~~ | ||
31 | |||
32 | .. code:: bash | ||
33 | |||
34 | rabbitmqctl stop | ||
35 | |||
36 | |||
37 | Configure RabbitMQ in wallabag | ||
38 | ------------------------------ | ||
39 | |||
40 | Edit 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 | |||
49 | Enable RabbitMQ in wallabag | ||
50 | --------------------------- | ||
51 | |||
52 | In internal settings, in the **Import** section, enable RabbitMQ (with the value 1). | ||
53 | |||
54 | Launch RabbitMQ consumer | ||
55 | ------------------------ | ||
56 | |||
57 | Depending 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 @@ | |||
1 | Install Redis for asynchronous tasks | ||
2 | ==================================== | ||
3 | |||
4 | In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis. | ||
5 | |||
6 | Requirements | ||
7 | ------------ | ||
8 | |||
9 | You need to have Redis installed on your server. | ||
10 | |||
11 | Installation | ||
12 | ~~~~~~~~~~~~ | ||
13 | |||
14 | .. code:: bash | ||
15 | |||
16 | apt-get install redis-server | ||
17 | |||
18 | Launch | ||
19 | ~~~~~~ | ||
20 | |||
21 | The server might be already running after installing, if not you can launch it using: | ||
22 | |||
23 | .. code:: bash | ||
24 | |||
25 | redis-server | ||
26 | |||
27 | |||
28 | Configure Redis in wallabag | ||
29 | --------------------------- | ||
30 | |||
31 | Edit 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 | |||
38 | Enable Redis in wallabag | ||
39 | ------------------------ | ||
40 | |||
41 | In internal settings, in the **Import** section, enable Redis (with the value 1). | ||
42 | |||
43 | Launch Redis consumer | ||
44 | --------------------- | ||
45 | |||
46 | Depending 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 | |||
71 | 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 : | ||
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 6fe33c76..54a1eef8 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 |
9 | keeping content only. Elements like navigation or ads are deleted. | 9 | keeping 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 | |||
15 | The main documentation for this application is organized into a couple sections: | 11 | The main documentation for this application is organized into a couple sections: |
16 | 12 | ||
17 | * :ref:`user-docs` | 13 | * :ref:`user-docs` |
@@ -20,7 +16,7 @@ The main documentation for this application is organized into a couple sections: | |||
20 | The documentation is available in other languages: | 16 | The documentation is available in other languages: |
21 | 17 | ||
22 | * `Documentation en français <http://doc.wallabag.org/fr/master/>`_ | 18 | * `Documentation en français <http://doc.wallabag.org/fr/master/>`_ |
23 | * `Deutsch Dokumentation <http://doc.wallabag.org/de/master/>`_ | 19 | * `Dokumentation in Deutsch <http://doc.wallabag.org/de/master/>`_ |
24 | 20 | ||
25 | .. _user-docs: | 21 | .. _user-docs: |
26 | 22 | ||
@@ -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 | 29 | user/configuration |
35 | user/migration | ||
36 | user/import | 30 | user/import |
37 | user/create_account | 31 | user/create_account |
38 | user/login | 32 | user/articles |
39 | user/configuration | ||
40 | user/first_article | ||
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 | ||
@@ -58,5 +48,4 @@ The documentation is available in other languages: | |||
58 | developer/docker | 48 | developer/docker |
59 | developer/documentation | 49 | developer/documentation |
60 | developer/translate | 50 | developer/translate |
61 | developer/redis | 51 | developer/asynchronous |
62 | developer/rabbitmq | ||
diff --git a/docs/en/user/android.rst b/docs/en/user/android.rst index 91dcb2fc..e286bb3b 100644 --- a/docs/en/user/android.rst +++ b/docs/en/user/android.rst | |||
@@ -1,13 +1,11 @@ | |||
1 | Android App | 1 | Android application |
2 | =========== | 2 | =================== |
3 | |||
4 | 3 | ||
5 | Purpose of this document | 4 | Purpose of this document |
6 | ------------------------ | 5 | ------------------------ |
7 | 6 | ||
8 | This 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. | 7 | This 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 | |||
11 | Steps to configure your app | 9 | Steps to configure your app |
12 | --------------------------- | 10 | --------------------------- |
13 | 11 | ||
@@ -23,7 +21,7 @@ Just confirm that message and you get redirected to the settings screen. | |||
23 | :alt: Settings screen | 21 | :alt: Settings screen |
24 | :align: center | 22 | :align: center |
25 | 23 | ||
26 | Fill in your wallabag data. You need to enter your wallabag address. It is important that this URL does not end with a slash. Also add your wallabag credentials to the user name and password field. | 24 | Fill in your wallabag data. You need to enter your wallabag address. **It is important that this URL does not end with a slash**. Also add your wallabag credentials to the user name and password field. |
27 | 25 | ||
28 | .. image:: ../../img/user/android_configuration_filled_in.en.png | 26 | .. image:: ../../img/user/android_configuration_filled_in.en.png |
29 | :alt: Filled in settings | 27 | :alt: Filled in settings |
@@ -59,49 +57,39 @@ Now you need to scroll to the bottom of the settings menu. Of course you can adj | |||
59 | :alt: Bottom of the settings screen | 57 | :alt: Bottom of the settings screen |
60 | :align: center | 58 | :align: center |
61 | 59 | ||
62 | After hitting the save button, you get the following screen. The app proposes to initiate a syncronisation process to update your feeds of articles. It is recommended to acknowledge this action and press Yes. | 60 | After hitting the save button, you get the following screen. The app proposes to initiate a synchronization process to update your feeds of articles. It is recommended to acknowledge this action and press Yes. |
63 | 61 | ||
64 | .. image:: ../../img/user/android_configuration_saved_feed_update.en.png | 62 | .. image:: ../../img/user/android_configuration_saved_feed_update.en.png |
65 | :alt: Settings saved the first time | 63 | :alt: Settings saved the first time |
66 | :align: center | 64 | :align: center |
67 | 65 | ||
68 | Finally after the synchronisation finished successfully, you are presented to the list of unread articles. | 66 | Finally after the synchronization finished successfully, you are presented to the list of unread articles. |
69 | 67 | ||
70 | .. image:: ../../img/user/android_unread_feed_synced.en.png | 68 | .. image:: ../../img/user/android_unread_feed_synced.en.png |
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 | |||
76 | Known limitations | 72 | Known limitations |
77 | ----------------- | 73 | ----------------- |
78 | 74 | ||
79 | 2FA | 75 | Two factor authentication (2FA) |
80 | ~~~ | 76 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
81 | 77 | ||
82 | Currently the Android application does not support two-factor authentication. You should disable that to get the application working. | 78 | Currently the Android application does not support two-factor authentication. You should disable that to get the application working. |
83 | 79 | ||
84 | |||
85 | Limited amount of articles with wallabag v2 | 80 | Limited amount of articles with wallabag v2 |
86 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 81 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
87 | 82 | ||
88 | In 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. | 83 | In 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 | |||
91 | SSL/TLS encryption | 85 | SSL/TLS encryption |
92 | ~~~~~~~~~~~~~~~~~~ | 86 | ~~~~~~~~~~~~~~~~~~ |
93 | 87 | ||
94 | If 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. | 88 | If 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 | |||
97 | References | 90 | References |
98 | ---------- | 91 | ---------- |
99 | 92 | ||
100 | `Source code of the Android application <https://github.com/wallabag/android-app>`_ | 93 | - `Source code of the Android application <https://github.com/wallabag/android-app>`_ |
101 | 94 | - `Android Application on F-Droid <https://f-droid.org/repository/browse/?fdfilter=wallabag&fdid=fr.gaulupeau.apps.InThePoche>`_ | |
102 | `Android Application on F-Droid <https://f-droid.org/repository/browse/?fdfilter=wallabag&fdid=fr.gaulupeau.apps.InThePoche>`_ | 95 | - `Android Application on Google Play <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_ |
103 | |||
104 | `Android Application on Google Play <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_ | ||
105 | |||
106 | `Support chat <https://gitter.im/wallabag/wallabag>`_ | ||
107 | |||
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 @@ | |||
1 | Annotations | ||
2 | =========== | ||
3 | |||
4 | In each article you read, you can write annotations. It's easier to understand with some pictures. | ||
5 | |||
6 | Select 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 | |||
12 | Then, write your annotation: | ||
13 | |||
14 | .. image:: ../../img/user/annotations_2.png | ||
15 | :alt: Write your annotation | ||
16 | :align: center | ||
17 | |||
18 | The 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 | |||
24 | You 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 @@ | |||
1 | Articles | ||
2 | ======== | ||
3 | |||
4 | Save your first article | ||
5 | ----------------------- | ||
6 | |||
7 | The 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 | |||
9 | By using a bookmarklet | ||
10 | ^^^^^^^^^^^^^^^^^^^^^^ | ||
11 | |||
12 | On the ``Howto`` page, you have a ``Bookmarklet`` tab. Drag and drop the ``bag it!`` | ||
13 | link to your bookmarks bar of your browser. | ||
14 | |||
15 | Now, each time you're reading an article on the web and you want to save it, | ||
16 | click on the ``bag it!`` link in your bookmarks bar. The article is saved. | ||
17 | |||
18 | By using the classic form | ||
19 | ^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
20 | |||
21 | In the top bar of your screen, you have 3 icons. With the first one, a plus sign, | ||
22 | you can easily save a new article. | ||
23 | |||
24 | .. image:: ../../img/user/topbar.png | ||
25 | :alt: Top bar | ||
26 | :align: center | ||
27 | |||
28 | Click on it to display a new field, paste the article URL inside and press your | ||
29 | ``Return`` key. The article is saved. | ||
30 | |||
31 | By using a browser add-on | ||
32 | ^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
33 | |||
34 | Firefox | ||
35 | """"""" | ||
36 | |||
37 | You can download the `Firefox addon here <https://addons.mozilla.org/firefox/addon/wallabag-v2/>`_. | ||
38 | |||
39 | Chrome | ||
40 | """""" | ||
41 | |||
42 | You can download the `Chrome addon here <https://chrome.google.com/webstore/detail/wallabagger/gbmgphmejlcoihgedabhgjdkcahacjlj?hl=fr>`_. | ||
43 | |||
44 | By using your smarphone application | ||
45 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
46 | |||
47 | Android | ||
48 | """"""" | ||
49 | |||
50 | You can download the `Android application here <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_. | ||
51 | |||
52 | Windows Phone | ||
53 | """"""""""""" | ||
54 | |||
55 | You can downlaod the `Windows Phone application here <https://www.microsoft.com/store/apps/9nblggh5x3p6>`_. | ||
56 | |||
57 | Download your articles | ||
58 | ---------------------- | ||
59 | |||
60 | You can download each article in several formats: ePUB, MOBI, PDF, XML, JSON, CSV. | ||
61 | |||
62 | On 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 | |||
68 | You can also download a full category (unread, starred, archive) in these formats. | ||
69 | For 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 | |||
75 | Share your articles | ||
76 | ------------------- | ||
77 | |||
78 | When 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 | |||
84 | Now, 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 | |||
93 | Annotate your articles | ||
94 | ---------------------- | ||
95 | |||
96 | In each article you read, you can write annotations. It's easier to understand with some pictures. | ||
97 | |||
98 | Select 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 | |||
104 | Then, write your annotation: | ||
105 | |||
106 | .. image:: ../../img/user/annotations_2.png | ||
107 | :alt: Write your annotation | ||
108 | :align: center | ||
109 | |||
110 | The 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 | |||
116 | You 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 @@ | |||
1 | Backup wallabag | 1 | Backup wallabag |
2 | =============== | 2 | =============== |
3 | |||
3 | Because 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. | 4 | Because 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. |
4 | This articles describes what you need to backup. | 5 | This 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 | ||
23 | Images | 24 | Images |
24 | ------ | 25 | ------ |
25 | The images retrieved by wallabag are stored under `data/assets/images` (the images storage will be implemented in wallabag 2.2). | 26 | The 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/configuration.rst b/docs/en/user/configuration.rst index e16af12c..a52d3ddd 100644 --- a/docs/en/user/configuration.rst +++ b/docs/en/user/configuration.rst | |||
@@ -12,8 +12,7 @@ Settings | |||
12 | Theme | 12 | Theme |
13 | ~~~~~ | 13 | ~~~~~ |
14 | 14 | ||
15 | wallabag is customizable. You can choose your prefered theme here. You can also | 15 | wallabag is customizable. You can choose your prefered theme here. The default theme is |
16 | create a new one, a chapter will be dedicated for this. The default theme is | ||
17 | ``Material``, it's the theme used in the documentation screenshots. | 16 | ``Material``, it's the theme used in the documentation screenshots. |
18 | 17 | ||
19 | Items per page | 18 | Items per page |
@@ -39,8 +38,7 @@ after deleting an article, after removing a tag from an entry), you can be redir | |||
39 | Language | 38 | Language |
40 | ~~~~~~~~ | 39 | ~~~~~~~~ |
41 | 40 | ||
42 | You can change the language of wallabag interface. You need to logout for this change | 41 | You can change the language of wallabag interface. |
43 | to take effect. | ||
44 | 42 | ||
45 | RSS | 43 | RSS |
46 | --- | 44 | --- |
@@ -61,8 +59,8 @@ You can change your name, your email address and enable ``Two factor authenticat | |||
61 | 59 | ||
62 | If the wallabag instance has more than one enabled user, you can delete your account here. **Take care, we delete all your data**. | 60 | If the wallabag instance has more than one enabled user, you can delete your account here. **Take care, we delete all your data**. |
63 | 61 | ||
64 | Two factor authentication | 62 | Two factor authentication (2FA) |
65 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | 63 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
66 | 64 | ||
67 | Two-factor authentication (also known as 2FA) is a technology patented in 1984 | 65 | Two-factor authentication (also known as 2FA) is a technology patented in 1984 |
68 | that provides identification of users by means of the combination of two different components. | 66 | that provides identification of users by means of the combination of two different components. |
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 @@ | |||
1 | Create an account | 1 | Create an account and authentication |
2 | ================= | 2 | ==================================== |
3 | |||
4 | Register | ||
5 | -------- | ||
3 | 6 | ||
4 | On the login page, click on ``Register`` button. | 7 | On 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 | |||
30 | Login | ||
31 | ----- | ||
32 | |||
33 | Your account is now enabled, congratulations! | ||
34 | |||
35 | To login to wallabag, fill the form on login page. | ||
36 | |||
37 | If you are on your personal computer and you want to stay connected, | ||
38 | you 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 @@ | |||
1 | Download articles | ||
2 | ================= | ||
3 | |||
4 | You can download each article in several formats: ePUB, MOBI, PDF, XML, JSON, CSV. | ||
5 | |||
6 | On 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 | |||
12 | You can also download a full category (unread, starred, archive) in these formats. | ||
13 | For 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: | |||
12 | How can I help to fix that? | 12 | How can I help to fix that? |
13 | --------------------------- | 13 | --------------------------- |
14 | 14 | ||
15 | You can `sending us an email with the article's URL <mailto:hello@wallabag.org>`_. | 15 | You can try to fix this problem by yourself (so we can be focused on improving wallabag internally instead of writing siteconfig :) ). |
16 | |||
17 | Or 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 | ||
19 | You 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). | 17 | You 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 de0da016..aae8a749 100644 --- a/docs/en/user/filters.rst +++ b/docs/en/user/filters.rst | |||
@@ -1,7 +1,7 @@ | |||
1 | Filters | 1 | Retrieve your articles thanks to filters |
2 | ======= | 2 | ======================================== |
3 | 3 | ||
4 | To retrieve articles easier, you can use filters. | 4 | To retrieve articles easily, you can use filters. |
5 | Click on the third icon in the top bar. | 5 | Click 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 cde2ecd6..f420a131 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst | |||
@@ -1,8 +1,20 @@ | |||
1 | Migrate from a third service | 1 | Migrate from ... |
2 | ============================ | 2 | ================ |
3 | 3 | ||
4 | From Pocket | 4 | In wallabag 2.x, you can import data from: |
5 | ----------- | 5 | |
6 | - `Pocket <#id1>`_ | ||
7 | - `Readability <#id2>`_ | ||
8 | - `Instapaper <#id4>`_ | ||
9 | - `wallabag 1.x <#id6>`_ | ||
10 | - `wallabag 2.x <#id7>`_ | ||
11 | |||
12 | We also developed `a script to execute migrations via command-line interface <#import-via-command-line-interface-cli>`_. | ||
13 | |||
14 | Because imports can take ages, we developed an asynchronous tasks system. `You can read the documentation here <http://doc.wallabag.org/fr/master/developer/asynchronous.html>`_ (for experts). | ||
15 | |||
16 | |||
17 | ------ | ||
6 | 18 | ||
7 | Create a new application on Pocket | 19 | Create a new application on Pocket |
8 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 20 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
@@ -16,7 +28,7 @@ a new application on their developer website to continue. | |||
16 | and submit your new application | 28 | and submit your new application |
17 | 29 | ||
18 | Pocket will give you a **Consumer Key** (for example, `49961-985e4b92fe21fe4c78d682c1`). | 30 | Pocket will give you a **Consumer Key** (for example, `49961-985e4b92fe21fe4c78d682c1`). |
19 | You need to configure the ``pocket_consumer_key`` into the ``Import`` section in the ``Internal settings`` menu. | 31 | You need to configure the ``pocket_consumer_key`` in the ``Config`` menu. |
20 | 32 | ||
21 | Now, all is fine to migrate from Pocket. | 33 | Now, all is fine to migrate from Pocket. |
22 | 34 | ||
@@ -29,8 +41,8 @@ and then on ``Connect to Pocket and import data``. | |||
29 | You need to authorize wallabag to interact with your Pocket account. | 41 | You need to authorize wallabag to interact with your Pocket account. |
30 | Your data will be imported. Data import can be a demanding process for your server. | 42 | Your data will be imported. Data import can be a demanding process for your server. |
31 | 43 | ||
32 | From Readability | 44 | Readability |
33 | ---------------- | 45 | ----------- |
34 | 46 | ||
35 | Export your Readability data | 47 | Export your Readability data |
36 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 48 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
@@ -77,7 +89,66 @@ and then select your CSV file and upload it. | |||
77 | 89 | ||
78 | Your data will be imported. Data import can be a demanding process for your server. | 90 | Your data will be imported. Data import can be a demanding process for your server. |
79 | 91 | ||
80 | From HTML or JSON file | 92 | wallabag 1.x |
81 | ---------------------- | 93 | ------------ |
94 | |||
95 | If 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. | ||
96 | |||
97 | .. image:: ../../img/user/export_v1.png | ||
98 | :alt: Exporting from wallabag v1 | ||
99 | :align: center | ||
100 | |||
101 | .. note:: | ||
102 | If you have multiple accounts on the same instance of wallabag, each user must export from v1 and import into v2 its data. | ||
103 | |||
104 | .. note:: | ||
105 | If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__. | ||
106 | |||
107 | When 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>`__. | ||
108 | |||
109 | After 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. | ||
110 | |||
111 | .. image:: ../../img/user/import_wallabagv1.png | ||
112 | :alt: Import from wallabag v1 | ||
113 | :align: center | ||
114 | |||
115 | wallabag 2.x | ||
116 | ------------ | ||
117 | |||
118 | From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json. | ||
119 | |||
120 | .. image:: ../../img/user/export_v2.png | ||
121 | :alt: Export depuis wallabag v2 | ||
122 | :align: center | ||
123 | |||
124 | From 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. | ||
125 | |||
126 | .. note:: | ||
127 | If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__. | ||
128 | |||
129 | Import via command-line interface (CLI) | ||
130 | --------------------------------------- | ||
131 | |||
132 | If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export: | ||
133 | |||
134 | :: | ||
135 | |||
136 | bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod | ||
137 | |||
138 | Please replace values: | ||
139 | |||
140 | * ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1) | ||
141 | * ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export | ||
142 | |||
143 | If you want to mark all these entries as read, you can add the ``--markAsRead`` option. | ||
144 | |||
145 | To import a wallabag v2 file, you need to add the option ``--importer=v2``. | ||
146 | |||
147 | You'll have this in return: | ||
148 | |||
149 | :: | ||
82 | 150 | ||
83 | *Feature not yet implemented in wallabag v2.* | 151 | Start : 05-04-2016 11:36:07 --- |
152 | 403 imported | ||
153 | 0 already saved | ||
154 | End : 05-04-2016 11:36:09 --- | ||
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 45e14616..77ef60a8 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst | |||
@@ -186,6 +186,12 @@ Assuming you installed wallabag in the ``/var/www/wallabag`` folder, here's the | |||
186 | internal; | 186 | internal; |
187 | } | 187 | } |
188 | 188 | ||
189 | # return 404 for all other php files not matching the front controller | ||
190 | # this prevents access to other php files you don't want to be accessible. | ||
191 | location ~ \.php$ { | ||
192 | return 404; | ||
193 | } | ||
194 | |||
189 | error_log /var/log/nginx/wallabag_error.log; | 195 | error_log /var/log/nginx/wallabag_error.log; |
190 | access_log /var/log/nginx/wallabag_access.log; | 196 | access_log /var/log/nginx/wallabag_access.log; |
191 | } | 197 | } |
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 @@ | |||
1 | Login | ||
2 | ===== | ||
3 | |||
4 | Your account is now enabled, congratulations! | ||
5 | |||
6 | To login to wallabag, fill the form on login page. | ||
7 | |||
8 | If you are on your personal computer and you want to stay connected, | ||
9 | you 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 @@ | |||
1 | Migrate from v1 or v2 | ||
2 | ===================== | ||
3 | |||
4 | From wallabag 1.x | ||
5 | ----------------- | ||
6 | |||
7 | If 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 | |||
19 | When 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 | |||
21 | After 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 | |||
27 | From wallabag 2.x | ||
28 | ----------------- | ||
29 | |||
30 | From 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 | |||
36 | From 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 | |||
41 | Import via command-line interface (CLI) | ||
42 | --------------------------------------- | ||
43 | |||
44 | If 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 | |||
50 | Please 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 | |||
55 | If you want to mark all these entries as read, you can add the ``--markAsRead`` option. | ||
56 | |||
57 | To import a wallabag v2 file, you need to add the option ``--importer=v2``. | ||
58 | |||
59 | You'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 c35cf3b8..eb312f7e 100644 --- a/docs/en/user/parameters.rst +++ b/docs/en/user/parameters.rst | |||
@@ -1,5 +1,48 @@ | |||
1 | What is the meaning of the parameters? | 1 | What is the meaning of the parameters? |
2 | ====================================== | 2 | ====================================== |
3 | |||
4 | Default `parameters.yml` file | ||
5 | ----------------------------- | ||
6 | |||
7 | Here is the last version of the default `app/config/parameters.yml` file. Be sure that yours respects this one. | ||
8 | If you don't know which value 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 | |||
43 | Meaning 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 62cb7dc0..00000000 --- a/docs/en/user/upgrade-2.1.x-2.1.y.rst +++ /dev/null | |||
@@ -1,35 +0,0 @@ | |||
1 | Upgrading from 2.1.x to 2.1.y | ||
2 | ============================= | ||
3 | |||
4 | Upgrade on a dedicated web server | ||
5 | --------------------------------- | ||
6 | |||
7 | The 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.2`` by the last release number): | ||
8 | |||
9 | :: | ||
10 | |||
11 | rm -rf var/cache/* | ||
12 | git fetch origin | ||
13 | git fetch --tags | ||
14 | git checkout 2.1.2 --force | ||
15 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist | ||
16 | php bin/console cache:clear --env=prod | ||
17 | |||
18 | Upgrade on a shared hosting | ||
19 | --------------------------- | ||
20 | |||
21 | Backup your ``app/config/parameters.yml`` file. | ||
22 | |||
23 | Download the last release of wallabag: | ||
24 | |||
25 | .. code-block:: bash | ||
26 | |||
27 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | ||
28 | |||
29 | You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_. | ||
30 | |||
31 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. | ||
32 | |||
33 | If you use SQLite, you must also copy your ``data/`` folder inside the new installation. | ||
34 | |||
35 | Empty ``var/cache`` folder. | ||
diff --git a/docs/en/user/upgrade-2.0.x-2.1.1.rst b/docs/en/user/upgrade.rst index 4f9b9cee..544d57eb 100644 --- a/docs/en/user/upgrade-2.0.x-2.1.1.rst +++ b/docs/en/user/upgrade.rst | |||
@@ -1,12 +1,21 @@ | |||
1 | Upgrade your wallabag installation | ||
2 | ================================== | ||
3 | |||
4 | You 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 | |||
1 | Upgrade from 2.0.x to 2.1.1 | 10 | Upgrade 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 | ||
8 | Upgrade on a dedicated web server | 17 | Upgrade 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 | ||
21 | Upgrade on a shared hosting | 30 | Upgrade on a shared hosting |
22 | --------------------------- | 31 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
23 | 32 | ||
24 | Backup your ``app/config/parameters.yml`` file. | 33 | Backup your ``app/config/parameters.yml`` file. |
25 | 34 | ||
26 | Download the last release of wallabag: | 35 | Download the 2.1.1 release of wallabag: |
27 | 36 | ||
28 | .. code-block:: bash | 37 | .. code-block:: bash |
29 | 38 | ||
@@ -33,39 +42,7 @@ Download the last release of wallabag: | |||
33 | 42 | ||
34 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. | 43 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. |
35 | 44 | ||
36 | Please 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. | 45 | Please 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 | mailer_transport: smtp | ||
50 | mailer_host: 127.0.0.1 | ||
51 | mailer_user: null | ||
52 | mailer_password: null | ||
53 | locale: en | ||
54 | secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv | ||
55 | twofactor_auth: true | ||
56 | twofactor_sender: no-reply@wallabag.org | ||
57 | fosuser_registration: true | ||
58 | fosuser_confirmation: true | ||
59 | from_email: no-reply@wallabag.org | ||
60 | rss_limit: 50 | ||
61 | rabbitmq_host: localhost | ||
62 | rabbitmq_port: 5672 | ||
63 | rabbitmq_user: guest | ||
64 | rabbitmq_password: guest | ||
65 | redis_host: localhost | ||
66 | redis_port: 6379 | ||
67 | |||
68 | You can find `here a documentation about parameters <http://doc.wallabag.org/en/master/user/parameters.html>`_. | ||
69 | 46 | ||
70 | If you use SQLite, you must also copy your ``data/`` folder inside the new installation. | 47 | If you use SQLite, you must also copy your ``data/`` folder inside the new installation. |
71 | 48 | ||
@@ -82,3 +59,45 @@ You must run some SQL queries to upgrade your database. We assume that the table | |||
82 | 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'); |
83 | 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; |
84 | DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; | 61 | DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; |
62 | |||
63 | Upgrading from 2.1.x to 2.1.y | ||
64 | ----------------------------- | ||
65 | |||
66 | Upgrade on a dedicated web server | ||
67 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
68 | |||
69 | In 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 | |||
75 | Upgrade on a shared hosting | ||
76 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
77 | |||
78 | Backup your ``app/config/parameters.yml`` file. | ||
79 | |||
80 | Download 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 | |||
86 | You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_. | ||
87 | |||
88 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. | ||
89 | |||
90 | Please 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 | |||
92 | If you use SQLite, you must also copy your ``data/`` folder inside the new installation. | ||
93 | |||
94 | Empty ``var/cache`` folder. | ||
95 | |||
96 | From wallabag 1.x | ||
97 | ----------------- | ||
98 | |||
99 | There 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>`_ ) | ||