aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/user/import.rst
diff options
context:
space:
mode:
authorJeremy Benoist <jeremy.benoist@gmail.com>2016-11-19 15:30:49 +0100
committerJeremy Benoist <jeremy.benoist@gmail.com>2016-11-19 15:30:49 +0100
commit68003139e133835805b143b62c4407f19b495dab (patch)
tree9a71a15d021330fb6d55cc338f125161ddfc61dd /docs/en/user/import.rst
parentbbd4ae7b56d9db744482a5630abad350f2d819af (diff)
parentcb1a6590c0e58c56d0612066501b3a586b103ed5 (diff)
downloadwallabag-68003139e133835805b143b62c4407f19b495dab.tar.gz
wallabag-68003139e133835805b143b62c4407f19b495dab.tar.zst
wallabag-68003139e133835805b143b62c4407f19b495dab.zip
Merge remote-tracking branch 'origin/master' into 2.2
# Conflicts: # .editorconfig # docs/de/index.rst # docs/de/user/import.rst # docs/en/index.rst # docs/en/user/configuration.rst # docs/en/user/import.rst # docs/fr/index.rst # docs/fr/user/import.rst # src/Wallabag/CoreBundle/Command/InstallCommand.php # src/Wallabag/CoreBundle/Resources/translations/messages.da.yml # src/Wallabag/CoreBundle/Resources/translations/messages.de.yml # src/Wallabag/CoreBundle/Resources/translations/messages.en.yml # src/Wallabag/CoreBundle/Resources/translations/messages.es.yml # src/Wallabag/CoreBundle/Resources/translations/messages.fa.yml # src/Wallabag/CoreBundle/Resources/translations/messages.fr.yml # src/Wallabag/CoreBundle/Resources/translations/messages.it.yml # src/Wallabag/CoreBundle/Resources/translations/messages.oc.yml # src/Wallabag/CoreBundle/Resources/translations/messages.pl.yml # src/Wallabag/CoreBundle/Resources/translations/messages.pt.yml # src/Wallabag/CoreBundle/Resources/translations/messages.ro.yml # src/Wallabag/CoreBundle/Resources/translations/messages.tr.yml # src/Wallabag/CoreBundle/Resources/views/themes/baggy/Config/index.html.twig # web/bundles/wallabagcore/themes/baggy/css/style.min.css # web/bundles/wallabagcore/themes/baggy/js/baggy.min.js # web/bundles/wallabagcore/themes/material/css/style.min.css # web/bundles/wallabagcore/themes/material/js/material.min.js
Diffstat (limited to 'docs/en/user/import.rst')
-rw-r--r--docs/en/user/import.rst91
1 files changed, 81 insertions, 10 deletions
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst
index cde2ecd6..f420a131 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~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -16,7 +28,7 @@ a new application on their developer website to continue.
16 and submit your new application 28 and submit your new application
17 29
18Pocket will give you a **Consumer Key** (for example, `49961-985e4b92fe21fe4c78d682c1`). 30Pocket will give you a **Consumer Key** (for example, `49961-985e4b92fe21fe4c78d682c1`).
19You need to configure the ``pocket_consumer_key`` into the ``Import`` section in the ``Internal settings`` menu. 31You need to configure the ``pocket_consumer_key`` in the ``Config`` menu.
20 32
21Now, all is fine to migrate from Pocket. 33Now, all is fine to migrate from Pocket.
22 34
@@ -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~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -77,7 +89,66 @@ and then select your CSV file and upload it.
77 89
78Your data will be imported. Data import can be a demanding process for your server. 90Your data will be imported. Data import can be a demanding process for your server.
79 91
80From HTML or JSON file 92wallabag 1.x
81---------------------- 93------------
94
95If 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.
96
97.. image:: ../../img/user/export_v1.png
98 :alt: Exporting from wallabag v1
99 :align: center
100
101.. note::
102 If you have multiple accounts on the same instance of wallabag, each user must export from v1 and import into v2 its data.
103
104.. note::
105 If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
106
107When 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>`__.
108
109After 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.
110
111.. image:: ../../img/user/import_wallabagv1.png
112 :alt: Import from wallabag v1
113 :align: center
114
115wallabag 2.x
116------------
117
118From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json.
119
120.. image:: ../../img/user/export_v2.png
121 :alt: Export depuis wallabag v2
122 :align: center
123
124From 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.
125
126.. note::
127 If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
128
129Import via command-line interface (CLI)
130---------------------------------------
131
132If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export:
133
134::
135
136 bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
137
138Please replace values:
139
140* ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1)
141* ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export
142
143If you want to mark all these entries as read, you can add the ``--markAsRead`` option.
144
145To import a wallabag v2 file, you need to add the option ``--importer=v2``.
146
147You'll have this in return:
148
149::
82 150
83*Feature not yet implemented in wallabag v2.* 151 Start : 05-04-2016 11:36:07 ---
152 403 imported
153 0 already saved
154 End : 05-04-2016 11:36:09 ---