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

Migrate to wallabag
===================

From wallabag
-------------

Export your data from your wallabag 1.x
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

On your config page, click on ``JSON export`` in the ``Export your wallabag data`` section.

.. image:: ../../img/user/export_wllbg_1.png
   :alt: Export from wallabag 1.x
   :align: center

You will have a ``wallabag-export-1-1970-01-01.json`` file.

Export your data from your wallabag 2.x
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

On the export sidebar, click on ``JSON``.

.. image:: ../../img/user/export_wllbg_2.png
   :alt: Export from wallabag 2.x
   :align: center

You will have a ``Unread articles.json`` file.

Import your data into wallabag 2.x
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Click on  ``Import`` link in the menu, choose the right wallabag version,
select your export file on your computer and import it.

.. image:: ../../img/user/import_wllbg.png
   :alt: Import from wallabag 1.x
   :align: center

All your wallabag articles will be imported.

From Pocket
-----------

Create a new application on Pocket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To import your data from Pocket, we use the Pocket API. You need to create
a new application on their developer website to continue.

* Create a new application `on the developer website <https://getpocket.com/developer/apps/new>`_
* Fill in the required fields: application name, application description,
  permissions (only **retrieve**), platform (**web**), accept the terms of service
  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 ``app/config/parameters.yml`` file in wallabag.

Now, all is fine to migrate from Pocket.

Import your data into wallabag 2.x
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Click on  ``Import`` link in the menu, on ``Import contents`` in Pocket section
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
(we need to work on this import to improve it).

From Instapaper
---------------

*Feature not yet implemented in wallabag v2.*

From Readability
----------------

*Feature not yet implemented in wallabag v2.*

From HTML or JSON file
----------------------

*Feature not yet implemented in wallabag v2.*
Commit	Line	Data
	1	Migrate to wallabag
	2	===================
	3
	4	From wallabag
	5	-------------
	6
	7	Export your data from your wallabag 1.x
	8	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	9
	10	On your config page, click on ``JSON export`` in the ``Export your wallabag data`` section.
	11
	12	.. image:: ../../img/user/export_wllbg_1.png
	13	:alt: Export from wallabag 1.x
	14	:align: center
	15
	16	You will have a ``wallabag-export-1-1970-01-01.json`` file.
	17
	18	Export your data from your wallabag 2.x
	19	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	20
	21	On the export sidebar, click on ``JSON``.
	22
	23	.. image:: ../../img/user/export_wllbg_2.png
	24	:alt: Export from wallabag 2.x
	25	:align: center
	26
	27	You will have a ``Unread articles.json`` file.
	28
	29	Import your data into wallabag 2.x
	30	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	31
	32	Click on ``Import`` link in the menu, choose the right wallabag version,
	33	select your export file on your computer and import it.
	34
	35	.. image:: ../../img/user/import_wllbg.png
	36	:alt: Import from wallabag 1.x
	37	:align: center
	38
	39	All your wallabag articles will be imported.
	40
	41	From Pocket
	42	-----------
	43
	44	Create a new application on Pocket
	45	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	46
	47	To import your data from Pocket, we use the Pocket API. You need to create
	48	a new application on their developer website to continue.
	49
	50	* Create a new application `on the developer website <https://getpocket.com/developer/apps/new>`_
	51	* Fill in the required fields: application name, application description,
	52	permissions (only retrieve), platform (web), accept the terms of service
	53	and submit your new application
	54
	55	Pocket will give you a Consumer Key (for example, `49961-985e4b92fe21fe4c78d682c1`).
	56	You need to configure the ``pocket_consumer_key`` into the ``app/config/parameters.yml`` file in wallabag.
	57
	58	Now, all is fine to migrate from Pocket.
	59
	60	Import your data into wallabag 2.x
	61	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	62
	63	Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section
	64	and then on ``Connect to Pocket and import data``.
	65
	66	You need to authorize wallabag to interact with your Pocket account.
	67	Your data will be imported. Data import can be a demanding process for your server
	68	(we need to work on this import to improve it).
	69
	70	From Instapaper
	71	---------------
	72
	73	Feature not yet implemented in wallabag v2.
	74
	75	From Readability
	76	----------------
	77
	78	Feature not yet implemented in wallabag v2.
	79
	80	From HTML or JSON file
	81	----------------------
	82
	83	Feature not yet implemented in wallabag v2.