diff options
Diffstat (limited to 'docs/en')
-rw-r--r-- | docs/en/developer/rabbitmq.rst | 67 | ||||
-rw-r--r-- | docs/en/developer/redis.rst | 62 | ||||
-rw-r--r-- | docs/en/index.rst | 5 | ||||
-rw-r--r-- | docs/en/user/import.rst | 21 | ||||
-rw-r--r-- | docs/en/user/migration.rst | 36 |
5 files changed, 170 insertions, 21 deletions
diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst new file mode 100644 index 00000000..8cee45fb --- /dev/null +++ b/docs/en/developer/rabbitmq.rst | |||
@@ -0,0 +1,67 @@ | |||
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 ``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 | |||
50 | Launch RabbitMQ consumer | ||
51 | ------------------------ | ||
52 | |||
53 | Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job: | ||
54 | |||
55 | .. code:: bash | ||
56 | |||
57 | # for Pocket import | ||
58 | bin/console rabbitmq:consumer import_pocket -w | ||
59 | |||
60 | # for Readbility import | ||
61 | bin/console rabbitmq:consumer import_readability -w | ||
62 | |||
63 | # for wallabag v1 import | ||
64 | bin/console rabbitmq:consumer import_wallabag_v1 -w | ||
65 | |||
66 | # for wallabag v2 import | ||
67 | bin/console rabbitmq:consumer import_wallabag_v2 -w | ||
diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst new file mode 100644 index 00000000..5748e260 --- /dev/null +++ b/docs/en/developer/redis.rst | |||
@@ -0,0 +1,62 @@ | |||
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 ``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 | |||
39 | Launch Redis consumer | ||
40 | ------------------------ | ||
41 | |||
42 | Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job: | ||
43 | |||
44 | .. code:: bash | ||
45 | |||
46 | # for Pocket import | ||
47 | bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log | ||
48 | |||
49 | # for Readbility import | ||
50 | bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.log | ||
51 | |||
52 | # for wallabag v1 import | ||
53 | bin/console wallabag:import:redis-worker wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log | ||
54 | |||
55 | # for wallabag v2 import | ||
56 | bin/console wallabag:import:redis-worker wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log | ||
57 | |||
58 | 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 : | ||
59 | |||
60 | .. code:: bash | ||
61 | |||
62 | bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12 | ||
diff --git a/docs/en/index.rst b/docs/en/index.rst index 03025ef9..bc3ce4c2 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst | |||
@@ -17,6 +17,11 @@ The main documentation for this application is organized into a couple sections: | |||
17 | * :ref:`user-docs` | 17 | * :ref:`user-docs` |
18 | * :ref:`dev-docs` | 18 | * :ref:`dev-docs` |
19 | 19 | ||
20 | The documentation is available in other languages: | ||
21 | |||
22 | * `Documentation en français <http://doc.wallabag.org/fr/master/>`_ | ||
23 | * `Deutsch Dokumentation <http://doc.wallabag.org/de/master/>`_ | ||
24 | |||
20 | .. _user-docs: | 25 | .. _user-docs: |
21 | 26 | ||
22 | .. toctree:: | 27 | .. toctree:: |
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst index 63210484..e6c37d72 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst | |||
@@ -30,14 +30,25 @@ 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 | 30 | Your data will be imported. Data import can be a demanding process for your server |
31 | (we need to work on this import to improve it). | 31 | (we need to work on this import to improve it). |
32 | 32 | ||
33 | From Instapaper | ||
34 | --------------- | ||
35 | |||
36 | *Feature not yet implemented in wallabag v2.* | ||
37 | |||
38 | From Readability | 33 | From Readability |
39 | ---------------- | 34 | ---------------- |
40 | 35 | ||
36 | Export your Readability data | ||
37 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
38 | |||
39 | On the tools (`https://www.readability.com/tools/<https://www.readability.com/tools/>`_) page, click on "Export your data" in the "Data Export" section. You will received an email to download a json (which does not end with .json in fact). | ||
40 | |||
41 | Import your data into wallabag 2.x | ||
42 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
43 | |||
44 | Click on ``Import`` link in the menu, on ``Import contents`` in Readability section | ||
45 | and then select your json file and upload it. | ||
46 | |||
47 | Your data will be imported. Data import can be a demanding process for your server (we need to work on this import to improve it). | ||
48 | |||
49 | From Instapaper | ||
50 | --------------- | ||
51 | |||
41 | *Feature not yet implemented in wallabag v2.* | 52 | *Feature not yet implemented in wallabag v2.* |
42 | 53 | ||
43 | From HTML or JSON file | 54 | From HTML or JSON file |
diff --git a/docs/en/user/migration.rst b/docs/en/user/migration.rst index e141ae40..42062796 100644 --- a/docs/en/user/migration.rst +++ b/docs/en/user/migration.rst | |||
@@ -24,20 +24,38 @@ After creating an user account on your new wallabag v2 instance, you must head o | |||
24 | :alt: Import from wallabag v1 | 24 | :alt: Import from wallabag v1 |
25 | :align: center | 25 | :align: center |
26 | 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 | |||
27 | Import via command-line interface (CLI) | 41 | Import via command-line interface (CLI) |
28 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 42 | --------------------------------------- |
29 | 43 | ||
30 | If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export: | 44 | If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export: |
31 | 45 | ||
32 | :: | 46 | :: |
33 | 47 | ||
34 | bin/console wallabag:import-v1 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod | 48 | bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod |
35 | 49 | ||
36 | Please replace values: | 50 | Please replace values: |
37 | 51 | ||
38 | * ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1) | 52 | * ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1) |
39 | * ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export | 53 | * ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export |
40 | 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 | |||
41 | You'll have this in return: | 59 | You'll have this in return: |
42 | 60 | ||
43 | :: | 61 | :: |
@@ -46,17 +64,3 @@ You'll have this in return: | |||
46 | 403 imported | 64 | 403 imported |
47 | 0 already saved | 65 | 0 already saved |
48 | End : 05-04-2016 11:36:09 --- | 66 | End : 05-04-2016 11:36:09 --- |
49 | |||
50 | From wallabag 2.x | ||
51 | ----------------- | ||
52 | |||
53 | From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json. | ||
54 | |||
55 | .. image:: ../../img/user/export_v2.png | ||
56 | :alt: Export depuis wallabag v2 | ||
57 | :align: center | ||
58 | |||
59 | 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. | ||
60 | |||
61 | .. note:: | ||
62 | If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__. | ||