aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/user
diff options
context:
space:
mode:
Diffstat (limited to 'docs/en/user')
-rw-r--r--docs/en/user/installation.rst12
-rw-r--r--docs/en/user/migration.rst62
2 files changed, 68 insertions, 6 deletions
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index 11ad54fd..bc35a02b 100644
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -4,9 +4,9 @@ Install wallabag
4Requirements 4Requirements
5------------ 5------------
6 6
7wallabag is compatible with php >= 5.5, including php 7. 7wallabag is compatible with PHP >= 5.5, including PHP 7.
8 8
9You'll need the following extensions for wallabag to work. Some of these may already activated in your version of php, so you may not have to install all corresponding packages. 9You'll need the following extensions for wallabag to work. Some of these may already activated in your version of PHP, so you may not have to install all corresponding packages.
10 10
11- php-session 11- php-session
12- php-ctype 12- php-ctype
@@ -25,9 +25,9 @@ You'll need the following extensions for wallabag to work. Some of these may alr
25 25
26wallabag uses PDO to connect to database, so you'll need one of: 26wallabag uses PDO to connect to database, so you'll need one of:
27 27
28- php-pdo_mysql 28- pdo_mysql
29- php-pdo_sqlite 29- pdo_sqlite
30- php-pdo_pgsql 30- pdo_pgsql
31 31
32and it's corresponding database server. 32and it's corresponding database server.
33 33
@@ -50,7 +50,7 @@ To install wallabag itself, you must run these two commands:
50 50
51 git clone https://github.com/wallabag/wallabag.git 51 git clone https://github.com/wallabag/wallabag.git
52 cd wallabag 52 cd wallabag
53 git checkout 2.0.0-beta.2 53 git checkout 2.0.0
54 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist 54 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
55 php bin/console wallabag:install --env=prod 55 php bin/console wallabag:install --env=prod
56 56
diff --git a/docs/en/user/migration.rst b/docs/en/user/migration.rst
new file mode 100644
index 00000000..e1fee961
--- /dev/null
+++ b/docs/en/user/migration.rst
@@ -0,0 +1,62 @@
1Migrate wallabag
2================
3
4From wallabag 1.x
5-----------------
6
7If 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.
8
9.. image:: ../../img/user/export_v1.png
10 :alt: Exporting from wallabag v1
11 :align: center
12
13.. note::
14 If you have multiple accounts on the same instance of wallabag, each user must export from v1 and import into v2 its data.
15
16.. note::
17 If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
18
19When 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/v2/user/installation.html>`__.
20
21After 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.
22
23.. image:: ../../img/user/import_wallabagv1.png
24 :alt: Import from wallabag v1
25 :align: center
26
27Import via command-line interface (CLI)
28~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
29
30If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export:
31
32::
33
34 bin/console wallabag:import-v1 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
35
36Please replace values:
37
38* ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1)
39* ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export
40
41You'll have this in return:
42
43::
44
45 Start : 05-04-2016 11:36:07 ---
46 403 imported
47 0 already saved
48 End : 05-04-2016 11:36:09 ---
49
50From wallabag 2.x
51-----------------
52
53From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json.
54
55.. image:: ../../img/user/export_v2.png
56 :alt: Export depuis wallabag v2
57 :align: center
58
59From 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.
60
61.. note::
62 If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.