aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/user/import.rst
diff options
context:
space:
mode:
authorNicolas LÅ“uillet <nicolas@loeuillet.org>2016-11-06 15:15:48 +0100
committerJulian Oster <jlnostr@outlook.de>2016-11-17 19:22:15 +0100
commit2e389b0b90f34d795e4bafc43d621955c05850a9 (patch)
treeeb9cd6197751383375339b0fee5ac32f362e3c0a /docs/en/user/import.rst
parent9e0a49e6acf60c3dbf3c479cb36d404239dfda89 (diff)
downloadwallabag-2e389b0b90f34d795e4bafc43d621955c05850a9.tar.gz
wallabag-2e389b0b90f34d795e4bafc43d621955c05850a9.tar.zst
wallabag-2e389b0b90f34d795e4bafc43d621955c05850a9.zip
Reordered documentation
Diffstat (limited to 'docs/en/user/import.rst')
-rw-r--r--docs/en/user/import.rst91
1 files changed, 80 insertions, 11 deletions
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst
index 38cd30c1..269e226c 100644
--- a/docs/en/user/import.rst
+++ b/docs/en/user/import.rst
@@ -1,8 +1,18 @@
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 <#instapaper>`_
9- `wallabag 1.x <#wallabag-1-x>`_
10- `wallabag 2.x <#wallabag-2-x>`_
11
12We also developed `a script to execute migrations via command-line interface <#import-via-command-line-interface-cli>`_.
13
14Pocket
15------
6 16
7Create a new application on Pocket 17Create a new application on Pocket
8~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 18~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -29,8 +39,8 @@ and then on ``Connect to Pocket and import data``.
29You need to authorize wallabag to interact with your Pocket account. 39You 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. 40Your data will be imported. Data import can be a demanding process for your server.
31 41
32From Readability 42Readability
33---------------- 43-----------
34 44
35Export your Readability data 45Export your Readability data
36~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 46~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -45,8 +55,8 @@ and then select your json file and upload it.
45 55
46Your data will be imported. Data import can be a demanding process for your server. 56Your data will be imported. Data import can be a demanding process for your server.
47 57
48From Instapaper 58Instapaper
49--------------- 59----------
50 60
51Export your Instapaper data 61Export your Instapaper data
52~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 62~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -61,7 +71,66 @@ and then select your CSV file and upload it.
61 71
62Your data will be imported. Data import can be a demanding process for your server. 72Your data will be imported. Data import can be a demanding process for your server.
63 73
64From HTML or JSON file 74wallabag 1.x
65---------------------- 75------------
76
77If 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.
78
79.. image:: ../../img/user/export_v1.png
80 :alt: Exporting from wallabag v1
81 :align: center
82
83.. note::
84 If you have multiple accounts on the same instance of wallabag, each user must export from v1 and import into v2 its data.
85
86.. note::
87 If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
88
89When 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>`__.
90
91After 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.
92
93.. image:: ../../img/user/import_wallabagv1.png
94 :alt: Import from wallabag v1
95 :align: center
96
97wallabag 2.x
98------------
99
100From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json.
101
102.. image:: ../../img/user/export_v2.png
103 :alt: Export depuis wallabag v2
104 :align: center
105
106From 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.
107
108.. note::
109 If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
110
111Import via command-line interface (CLI)
112---------------------------------------
113
114If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export:
115
116::
117
118 bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
119
120Please replace values:
121
122* ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1)
123* ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export
124
125If you want to mark all these entries as read, you can add the ``--markAsRead`` option.
126
127To import a wallabag v2 file, you need to add the option ``--importer=v2``.
128
129You'll have this in return:
130
131::
66 132
67*Feature not yet implemented in wallabag v2.* 133 Start : 05-04-2016 11:36:07 ---
134 403 imported
135 0 already saved
136 End : 05-04-2016 11:36:09 ---