docs/en/user/import.rst

   1 Migrate from ...
   2 ================
   3
   4 In wallabag 2.x, you can import data from:
   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 Pocket
  17 ------
  18
  19 Create a new application on Pocket
  20 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  21
  22 To import your data from Pocket, we use the Pocket API. You need to create
  23 a new application on their developer website to continue.
  24
  25 * Create a new application `on the developer website <https://getpocket.com/developer/apps/new>`_
  26 * Fill in the required fields: application name, application description,
  27   permissions (only **retrieve**), platform (**web**), accept the terms of service
  28   and submit your new application
  29
  30 Pocket will give you a **Consumer Key** (for example, `49961-985e4b92fe21fe4c78d682c1`).
  31 You need to configure the ``pocket_consumer_key`` in the ``Config`` menu.
  32
  33 Now, all is fine to migrate from Pocket.
  34
  35 Import your data into wallabag 2.x
  36 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  37
  38 Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section
  39 and then on ``Connect to Pocket and import data``.
  40
  41 You need to authorize wallabag to interact with your Pocket account.
  42 Your data will be imported. Data import can be a demanding process for your server.
  43
  44 Readability
  45 -----------
  46
  47 Export your Readability data
  48 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  49
  50 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).
  51
  52 Import your data into wallabag 2.x
  53 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  54
  55 Click on ``Import`` link in the menu, on ``Import contents`` in Readability section
  56 and then select your json file and upload it.
  57
  58 Your data will be imported. Data import can be a demanding process for your server.
  59
  60 Instapaper
  61 ----------
  62
  63 Export your Instapaper data
  64 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  65
  66 On the settings (`https://www.instapaper.com/user <https://www.instapaper.com/user>`_) page, click on "Download .CSV file" in the "Export" section. A CSV file will be downloaded (like ``instapaper-export.csv``).
  67
  68 Import your data into wallabag 2.x
  69 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  70
  71 Click on ``Import`` link in the menu, on ``Import contents`` in Instapaper section
  72 and then select your CSV file and upload it.
  73
  74 Your data will be imported. Data import can be a demanding process for your server.
  75
  76 wallabag 1.x
  77 ------------
  78
  79 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.
  80
  81 .. image:: ../../img/user/export_v1.png
  82    :alt: Exporting from wallabag v1
  83    :align: center
  84
  85 .. note::
  86     If you have multiple accounts on the same instance of wallabag, each user must export from v1 and import into v2 its data.
  87
  88 .. note::
  89     If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
  90
  91 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>`__.
  92
  93 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.
  94
  95 .. image:: ../../img/user/import_wallabagv1.png
  96    :alt: Import from wallabag v1
  97    :align: center
  98
  99 wallabag 2.x
 100 ------------
 101
 102 From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json.
 103
 104 .. image:: ../../img/user/export_v2.png
 105    :alt: Export depuis wallabag v2
 106    :align: center
 107
 108 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.
 109
 110 .. note::
 111     If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
 112
 113 Import via command-line interface (CLI)
 114 ---------------------------------------
 115
 116 If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export:
 117
 118 ::
 119
 120     bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
 121
 122 Please replace values:
 123
 124 * ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1)
 125 * ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export
 126
 127 If you want to mark all these entries as read, you can add the ``--markAsRead`` option.
 128
 129 To import a wallabag v2 file, you need to add the option ``--importer=v2``.
 130
 131 You'll have this in return:
 132
 133 ::
 134
 135     Start : 05-04-2016 11:36:07 ---
 136     403 imported
 137     0 already saved
 138     End : 05-04-2016 11:36:09 ---