Merge remote-tracking branch 'origin/master' into 2.2

[github/wallabag/wallabag.git] / docs / en / user / import.rst

diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst
index cde2ecd689fb092f85e262076f2a2d1d6493ccd2..f420a1318babe0002de039f915ac4341541b08e7 100644 (file)
--- a/docs/en/user/import.rst
+++ b/docs/en/user/import.rst
@@ -1,8 +1,20 @@
-Migrate from a third service
-============================
+Migrate from ...
+================
 
-From Pocket
------------
+In wallabag 2.x, you can import data from:
+
+- `Pocket <#id1>`_
+- `Readability <#id2>`_
+- `Instapaper <#id4>`_
+- `wallabag 1.x <#id6>`_
+- `wallabag 2.x <#id7>`_
+
+We also developed `a script to execute migrations via command-line interface <#import-via-command-line-interface-cli>`_.
+
+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).
+
+Pocket
+------
 
 Create a new application on Pocket
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -16,7 +28,7 @@ a new application on their developer website to continue.
   and submit your new application
 
 Pocket will give you a **Consumer Key** (for example, `49961-985e4b92fe21fe4c78d682c1`).
-You need to configure the ``pocket_consumer_key`` into the ``Import`` section in the ``Internal settings`` menu.
+You need to configure the ``pocket_consumer_key`` in the ``Config`` menu.
 
 Now, all is fine to migrate from Pocket.
 
@@ -29,8 +41,8 @@ and then on ``Connect to Pocket and import data``.
 You need to authorize wallabag to interact with your Pocket account.
 Your data will be imported. Data import can be a demanding process for your server.
 
-From Readability
-----------------
+Readability
+-----------
 
 Export your Readability data
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -77,7 +89,66 @@ and then select your CSV file and upload it.
 
 Your data will be imported. Data import can be a demanding process for your server.
 
-From HTML or JSON file
-----------------------
+wallabag 1.x
+------------
+
+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.
+
+.. image:: ../../img/user/export_v1.png
+   :alt: Exporting from wallabag v1
+   :align: center
+
+.. note::
+    If you have multiple accounts on the same instance of wallabag, each user must export from v1 and import into v2 its data.
+
+.. note::
+    If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
+
+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>`__.
+
+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.
+
+.. image:: ../../img/user/import_wallabagv1.png
+   :alt: Import from wallabag v1
+   :align: center
+
+wallabag 2.x
+------------
+
+From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json.
+
+.. image:: ../../img/user/export_v2.png
+   :alt: Export depuis wallabag v2
+   :align: center
+
+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.
+
+.. note::
+    If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
+
+Import via command-line interface (CLI)
+---------------------------------------
+
+If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export:
+
+::
+
+    bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
+
+Please replace values:
+
+* ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1)
+* ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export
+
+If you want to mark all these entries as read, you can add the ``--markAsRead`` option.
+
+To import a wallabag v2 file, you need to add the option ``--importer=v2``.
+
+You'll have this in return:
+
+::
 
-*Feature not yet implemented in wallabag v2.*
+    Start : 05-04-2016 11:36:07 ---
+    403 imported
+    0 already saved
+    End : 05-04-2016 11:36:09 ---