aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/user
diff options
context:
space:
mode:
Diffstat (limited to 'docs/en/user')
-rw-r--r--docs/en/user/import.rst22
-rw-r--r--docs/en/user/upgrade-2.0.x-2.0.y.rst (renamed from docs/en/user/upgrade.rst)13
-rw-r--r--docs/en/user/upgrade-2.0.x-2.1.y.rst64
3 files changed, 87 insertions, 12 deletions
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst
index e6c37d72..758e3816 100644
--- a/docs/en/user/import.rst
+++ b/docs/en/user/import.rst
@@ -23,12 +23,11 @@ Now, all is fine to migrate from Pocket.
23Import your data into wallabag 2.x 23Import your data into wallabag 2.x
24~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 24~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25 25
26Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section 26Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section
27and then on ``Connect to Pocket and import data``. 27and then on ``Connect to Pocket and import data``.
28 28
29You need to authorize wallabag to interact with your Pocket account. 29You 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 30Your data will be imported. Data import can be a demanding process for your server.
31(we need to work on this import to improve it).
32 31
33From Readability 32From Readability
34---------------- 33----------------
@@ -41,15 +40,26 @@ On the tools (`https://www.readability.com/tools/<https://www.readability.com/to
41Import your data into wallabag 2.x 40Import your data into wallabag 2.x
42~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 41~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
43 42
44Click on ``Import`` link in the menu, on ``Import contents`` in Readability section 43Click on ``Import`` link in the menu, on ``Import contents`` in Readability section
45and then select your json file and upload it. 44and then select your json file and upload it.
46 45
47Your data will be imported. Data import can be a demanding process for your server (we need to work on this import to improve it). 46Your data will be imported. Data import can be a demanding process for your server.
48 47
49From Instapaper 48From Instapaper
50--------------- 49---------------
51 50
52*Feature not yet implemented in wallabag v2.* 51Export your Instapaper data
52~~~~~~~~~~~~~~~~~~~~~~~~~~~~
53
54On the settings (`https://www.instapaper.com/user<https://www.instapaper.com/user>`_) page, click on "Download .CSV file" in the "Export" section. A CSV file will be downloaded (like ``instapaper-export.csv``).
55
56Import your data into wallabag 2.x
57~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
58
59Click on ``Import`` link in the menu, on ``Import contents`` in Instapaper section
60and then select your CSV file and upload it.
61
62Your data will be imported. Data import can be a demanding process for your server.
53 63
54From HTML or JSON file 64From HTML or JSON file
55---------------------- 65----------------------
diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade-2.0.x-2.0.y.rst
index 5c37be95..6a0818b3 100644
--- a/docs/en/user/upgrade.rst
+++ b/docs/en/user/upgrade-2.0.x-2.0.y.rst
@@ -1,17 +1,18 @@
1Upgrade wallabag 1Upgrade from 2.0.x to 2.0.y
2================ 2===========================
3 3
4Upgrade on a dedicated web server 4Upgrade on a dedicated web server
5--------------------------------- 5---------------------------------
6 6
7The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.1.0`` by the last release number): 7The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.0.8`` by the last release number):
8 8
9:: 9::
10 10
11 git fetch origin 11 git fetch origin
12 git fetch --tags 12 git fetch --tags
13 git checkout 2.1.0 13 git checkout 2.0.8
14 ./install.sh 14 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
15 php bin/console cache:clear --env=prod
15 16
16Upgrade on a shared hosting 17Upgrade on a shared hosting
17--------------------------- 18---------------------------
@@ -24,7 +25,7 @@ Download the last release of wallabag:
24 25
25 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package 26 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
26 27
27(md5 hash of the package: ``4f84c725d1d6e3345eae0a406115e5ff``) 28(md5 hash of the 2.0.8 package: ``4f84c725d1d6e3345eae0a406115e5ff``)
28 29
29Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. 30Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
30 31
diff --git a/docs/en/user/upgrade-2.0.x-2.1.y.rst b/docs/en/user/upgrade-2.0.x-2.1.y.rst
new file mode 100644
index 00000000..5ae5eb43
--- /dev/null
+++ b/docs/en/user/upgrade-2.0.x-2.1.y.rst
@@ -0,0 +1,64 @@
1Upgrading from 2.0.x to 2.1.y
2=============================
3
4.. warning::
5Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade.
6
7Upgrade on a dedicated web server
8---------------------------------
9
10The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.1.0`` by the last release number):
11
12::
13
14 git fetch origin
15 git fetch --tags
16 git checkout 2.1.0
17 ASSETS=build ./install.sh
18 php bin/console doctrine:migrations:migrate --env=prod
19 php bin/console cache:clear --env=prod
20
21Upgrade on a shared hosting
22---------------------------
23
24Backup your ``app/config/parameters.yml`` file.
25
26Download the last release of wallabag:
27
28.. code-block:: bash
29
30 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
31
32(md5 hash of the package: ``4f84c725d1d6e3345eae0a406115e5ff``)
33
34Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
35
36Please note that we added new parameters in this version. You have to edit ``app/config/parameters.yml`` by adding these lines (replace with your configuration) :
37
38.. code-block:: bash
39
40 # RabbitMQ processing
41 rabbitmq_host: localhost
42 rabbitmq_port: 5672
43 rabbitmq_user: guest
44 rabbitmq_password: guest
45
46 # Redis processing
47 redis_host: localhost
48 redis_port: 6379
49
50If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
51
52Empty ``var/cache`` folder.
53
54You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one:
55
56.. code-block:: sql
57
58 ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL;
59 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry');
60 ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL;
61 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import');
62 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import');
63 ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL;
64 DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key';