diff options
Diffstat (limited to 'docs/en')
-rw-r--r-- | docs/en/conf.py | 2 | ||||
-rw-r--r-- | docs/en/developer/docker.rst | 2 | ||||
-rw-r--r-- | docs/en/developer/rabbitmq.rst | 11 | ||||
-rw-r--r-- | docs/en/developer/redis.rst | 15 | ||||
-rw-r--r-- | docs/en/index.rst | 5 | ||||
-rw-r--r-- | docs/en/user/import.rst | 22 | ||||
-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.rst | 64 |
8 files changed, 115 insertions, 19 deletions
diff --git a/docs/en/conf.py b/docs/en/conf.py index 86e33704..717b35f1 100644 --- a/docs/en/conf.py +++ b/docs/en/conf.py | |||
@@ -12,7 +12,7 @@ source_suffix = '.rst' | |||
12 | master_doc = 'index' | 12 | master_doc = 'index' |
13 | project = u'wallabag' | 13 | project = u'wallabag' |
14 | copyright = u'2013-2016, Nicolas LÅ“uillet - MIT Licence' | 14 | copyright = u'2013-2016, Nicolas LÅ“uillet - MIT Licence' |
15 | version = '2.0.0' | 15 | version = '2.1.0' |
16 | release = version | 16 | release = version |
17 | exclude_patterns = ['_build'] | 17 | exclude_patterns = ['_build'] |
18 | pygments_style = 'sphinx' | 18 | pygments_style = 'sphinx' |
diff --git a/docs/en/developer/docker.rst b/docs/en/developer/docker.rst index 8816cbcf..5e4f2ce6 100644 --- a/docs/en/developer/docker.rst +++ b/docs/en/developer/docker.rst | |||
@@ -40,7 +40,7 @@ Run wallabag | |||
40 | #. Edit ``app/config/parameters.yml`` to replace ``database_*`` | 40 | #. Edit ``app/config/parameters.yml`` to replace ``database_*`` |
41 | properties with commented ones (with values prefixed by ``env.``) | 41 | properties with commented ones (with values prefixed by ``env.``) |
42 | #. ``composer install`` the project dependencies | 42 | #. ``composer install`` the project dependencies |
43 | #. ``php app/console wallabag:install`` to create the schema | 43 | #. ``php bin/console wallabag:install`` to create the schema |
44 | #. ``docker-compose up`` to run the containers | 44 | #. ``docker-compose up`` to run the containers |
45 | #. Finally, browse to http://localhost:8080/ to find your freshly | 45 | #. Finally, browse to http://localhost:8080/ to find your freshly |
46 | installed wallabag. | 46 | installed wallabag. |
diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst index 8cee45fb..63b85106 100644 --- a/docs/en/developer/rabbitmq.rst +++ b/docs/en/developer/rabbitmq.rst | |||
@@ -57,11 +57,20 @@ Depending on which service you want to import from you need to enable one (or ma | |||
57 | # for Pocket import | 57 | # for Pocket import |
58 | bin/console rabbitmq:consumer import_pocket -w | 58 | bin/console rabbitmq:consumer import_pocket -w |
59 | 59 | ||
60 | # for Readbility import | 60 | # for Readability import |
61 | bin/console rabbitmq:consumer import_readability -w | 61 | bin/console rabbitmq:consumer import_readability -w |
62 | 62 | ||
63 | # for Instapaper import | ||
64 | bin/console rabbitmq:consumer import_instapaper -w | ||
65 | |||
63 | # for wallabag v1 import | 66 | # for wallabag v1 import |
64 | bin/console rabbitmq:consumer import_wallabag_v1 -w | 67 | bin/console rabbitmq:consumer import_wallabag_v1 -w |
65 | 68 | ||
66 | # for wallabag v2 import | 69 | # for wallabag v2 import |
67 | bin/console rabbitmq:consumer import_wallabag_v2 -w | 70 | bin/console rabbitmq:consumer import_wallabag_v2 -w |
71 | |||
72 | # for Firefox import | ||
73 | bin/console rabbitmq:consumer import_firefox -w | ||
74 | |||
75 | # for Chrome import | ||
76 | bin/console rabbitmq:consumer import_chrome -w | ||
diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst index 5748e260..820a52e9 100644 --- a/docs/en/developer/redis.rst +++ b/docs/en/developer/redis.rst | |||
@@ -1,5 +1,5 @@ | |||
1 | Install Redis for asynchronous tasks | 1 | Install Redis for asynchronous tasks |
2 | ======================================= | 2 | ==================================== |
3 | 3 | ||
4 | In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis. | 4 | In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis. |
5 | 5 | ||
@@ -37,7 +37,7 @@ Edit your ``parameters.yml`` file to edit Redis configuration. The default one s | |||
37 | 37 | ||
38 | 38 | ||
39 | Launch Redis consumer | 39 | Launch Redis consumer |
40 | ------------------------ | 40 | --------------------- |
41 | 41 | ||
42 | Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job: | 42 | Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job: |
43 | 43 | ||
@@ -46,15 +46,24 @@ Depending on which service you want to import from you need to enable one (or ma | |||
46 | # for Pocket import | 46 | # for Pocket import |
47 | bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log | 47 | bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log |
48 | 48 | ||
49 | # for Readbility import | 49 | # for Readability import |
50 | bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.log | 50 | bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.log |
51 | 51 | ||
52 | # for Instapaper import | ||
53 | bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log | ||
54 | |||
52 | # for wallabag v1 import | 55 | # for wallabag v1 import |
53 | bin/console wallabag:import:redis-worker wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log | 56 | bin/console wallabag:import:redis-worker wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log |
54 | 57 | ||
55 | # for wallabag v2 import | 58 | # for wallabag v2 import |
56 | bin/console wallabag:import:redis-worker wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log | 59 | bin/console wallabag:import:redis-worker wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log |
57 | 60 | ||
61 | # for Firefox import | ||
62 | bin/console wallabag:import:redis-worker firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log | ||
63 | |||
64 | # for Chrome import | ||
65 | bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log | ||
66 | |||
58 | If you want to launch the import only for some messages and not all, you can specify this number (here 12) and the worker will stop right after the 12th message : | 67 | If you want to launch the import only for some messages and not all, you can specify this number (here 12) and the worker will stop right after the 12th message : |
59 | 68 | ||
60 | .. code:: bash | 69 | .. code:: bash |
diff --git a/docs/en/index.rst b/docs/en/index.rst index 46450b8f..beb3816e 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst | |||
@@ -30,7 +30,8 @@ The documentation is available in other languages: | |||
30 | 30 | ||
31 | user/faq | 31 | user/faq |
32 | user/installation | 32 | user/installation |
33 | user/upgrade | 33 | user/upgrade-2.0.x-2.1.y |
34 | user/upgrade-2.0.x-2.0.y | ||
34 | user/migration | 35 | user/migration |
35 | user/import | 36 | user/import |
36 | user/create_account | 37 | user/create_account |
@@ -56,3 +57,5 @@ The documentation is available in other languages: | |||
56 | developer/documentation | 57 | developer/documentation |
57 | developer/translate | 58 | developer/translate |
58 | developer/maintenance | 59 | developer/maintenance |
60 | developer/redis | ||
61 | developer/rabbitmq | ||
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. | |||
23 | Import your data into wallabag 2.x | 23 | Import your data into wallabag 2.x |
24 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 24 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
25 | 25 | ||
26 | Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section | 26 | Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section |
27 | and then on ``Connect to Pocket and import data``. | 27 | and then on ``Connect to Pocket and import data``. |
28 | 28 | ||
29 | You need to authorize wallabag to interact with your Pocket account. | 29 | You need to authorize wallabag to interact with your Pocket account. |
30 | Your data will be imported. Data import can be a demanding process for your server | 30 | Your 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 | ||
33 | From Readability | 32 | From Readability |
34 | ---------------- | 33 | ---------------- |
@@ -41,15 +40,26 @@ On the tools (`https://www.readability.com/tools/<https://www.readability.com/to | |||
41 | Import your data into wallabag 2.x | 40 | Import your data into wallabag 2.x |
42 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 41 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
43 | 42 | ||
44 | Click on ``Import`` link in the menu, on ``Import contents`` in Readability section | 43 | Click on ``Import`` link in the menu, on ``Import contents`` in Readability section |
45 | and then select your json file and upload it. | 44 | and then select your json file and upload it. |
46 | 45 | ||
47 | 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). | 46 | Your data will be imported. Data import can be a demanding process for your server. |
48 | 47 | ||
49 | From Instapaper | 48 | From Instapaper |
50 | --------------- | 49 | --------------- |
51 | 50 | ||
52 | *Feature not yet implemented in wallabag v2.* | 51 | Export your Instapaper data |
52 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
53 | |||
54 | On 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 | |||
56 | Import your data into wallabag 2.x | ||
57 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
58 | |||
59 | Click on ``Import`` link in the menu, on ``Import contents`` in Instapaper section | ||
60 | and then select your CSV file and upload it. | ||
61 | |||
62 | Your data will be imported. Data import can be a demanding process for your server. | ||
53 | 63 | ||
54 | From HTML or JSON file | 64 | From 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 @@ | |||
1 | Upgrade wallabag | 1 | Upgrade from 2.0.x to 2.0.y |
2 | ================ | 2 | =========================== |
3 | 3 | ||
4 | Upgrade on a dedicated web server | 4 | Upgrade on a dedicated web server |
5 | --------------------------------- | 5 | --------------------------------- |
6 | 6 | ||
7 | The 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): | 7 | The 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 | ||
16 | Upgrade on a shared hosting | 17 | Upgrade 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 | ||
29 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. | 30 | Extract 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 @@ | |||
1 | Upgrading from 2.0.x to 2.1.y | ||
2 | ============================= | ||
3 | |||
4 | .. warning:: | ||
5 | Before 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 | |||
7 | Upgrade on a dedicated web server | ||
8 | --------------------------------- | ||
9 | |||
10 | The 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 | |||
21 | Upgrade on a shared hosting | ||
22 | --------------------------- | ||
23 | |||
24 | Backup your ``app/config/parameters.yml`` file. | ||
25 | |||
26 | Download 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 | |||
34 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. | ||
35 | |||
36 | Please 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 | |||
50 | If you use SQLite, you must also copy your ``data/`` folder inside the new installation. | ||
51 | |||
52 | Empty ``var/cache`` folder. | ||
53 | |||
54 | You 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'; | ||