aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/user/import.rst
diff options
context:
space:
mode:
authorNicolas LÅ“uillet <nicolas@loeuillet.org>2016-11-18 09:28:20 +0100
committerGitHub <noreply@github.com>2016-11-18 09:28:20 +0100
commit19d401b15c1151bfa6c2364f31cc1eb87e7c99ef (patch)
tree9c47399f9b1a9ad2228ec365a1fd5e20edc7771f /docs/en/user/import.rst
parent9e0a49e6acf60c3dbf3c479cb36d404239dfda89 (diff)
parent50540682ffcaa6acf16f3b17cede3da9694c494f (diff)
downloadwallabag-19d401b15c1151bfa6c2364f31cc1eb87e7c99ef.tar.gz
wallabag-19d401b15c1151bfa6c2364f31cc1eb87e7c99ef.tar.zst
wallabag-19d401b15c1151bfa6c2364f31cc1eb87e7c99ef.zip
Merge pull request #2550 from wallabag/reorder-documentation
Reordered documentation
Diffstat (limited to 'docs/en/user/import.rst')
-rw-r--r--docs/en/user/import.rst93
1 files changed, 82 insertions, 11 deletions
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst
index 38cd30c1..a6754fa0 100644
--- a/docs/en/user/import.rst
+++ b/docs/en/user/import.rst
@@ -1,8 +1,20 @@
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 <#id4>`_
9- `wallabag 1.x <#id6>`_
10- `wallabag 2.x <#id7>`_
11
12We also developed `a script to execute migrations via command-line interface <#import-via-command-line-interface-cli>`_.
13
14Because 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
16Pocket
17------
6 18
7Create a new application on Pocket 19Create a new application on Pocket
8~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 20~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -29,8 +41,8 @@ and then on ``Connect to Pocket and import data``.
29You need to authorize wallabag to interact with your Pocket account. 41You 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. 42Your data will be imported. Data import can be a demanding process for your server.
31 43
32From Readability 44Readability
33---------------- 45-----------
34 46
35Export your Readability data 47Export your Readability data
36~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 48~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -45,8 +57,8 @@ and then select your json file and upload it.
45 57
46Your data will be imported. Data import can be a demanding process for your server. 58Your data will be imported. Data import can be a demanding process for your server.
47 59
48From Instapaper 60Instapaper
49--------------- 61----------
50 62
51Export your Instapaper data 63Export your Instapaper data
52~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 64~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -61,7 +73,66 @@ and then select your CSV file and upload it.
61 73
62Your data will be imported. Data import can be a demanding process for your server. 74Your data will be imported. Data import can be a demanding process for your server.
63 75
64From HTML or JSON file 76wallabag 1.x
65---------------------- 77------------
78
79If 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
91When 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
93After 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
99wallabag 2.x
100------------
101
102From 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
108From 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
113Import via command-line interface (CLI)
114---------------------------------------
115
116If 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
122Please 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
127If you want to mark all these entries as read, you can add the ``--markAsRead`` option.
128
129To import a wallabag v2 file, you need to add the option ``--importer=v2``.
130
131You'll have this in return:
132
133::
66 134
67*Feature not yet implemented in wallabag v2.* 135 Start : 05-04-2016 11:36:07 ---
136 403 imported
137 0 already saved
138 End : 05-04-2016 11:36:09 ---