diff options
Diffstat (limited to 'docs/en')
-rw-r--r-- | docs/en/developer/maintenance.rst | 4 | ||||
-rw-r--r-- | docs/en/developer/rabbitmq.rst | 14 | ||||
-rw-r--r-- | docs/en/developer/redis.rst | 16 | ||||
-rw-r--r-- | docs/en/user/errors_during_fetching.rst | 18 | ||||
-rw-r--r-- | docs/en/user/installation.rst | 7 | ||||
-rw-r--r-- | docs/en/user/upgrade-2.0.x-2.1.y.rst | 8 |
6 files changed, 40 insertions, 27 deletions
diff --git a/docs/en/developer/maintenance.rst b/docs/en/developer/maintenance.rst index 8277fb1f..6d55ed60 100644 --- a/docs/en/developer/maintenance.rst +++ b/docs/en/developer/maintenance.rst | |||
@@ -11,7 +11,7 @@ To enable maintenance mode, execute this command: | |||
11 | 11 | ||
12 | :: | 12 | :: |
13 | 13 | ||
14 | bin/console lexik:maintenance:lock --no-interaction | 14 | bin/console lexik:maintenance:lock --no-interaction -e=prod |
15 | 15 | ||
16 | You can set your IP address in ``app/config/config.yml`` if you want to access to wallabag even if maintenance mode is enabled. For example: | 16 | You can set your IP address in ``app/config/config.yml`` if you want to access to wallabag even if maintenance mode is enabled. For example: |
17 | 17 | ||
@@ -29,4 +29,4 @@ To disable maintenance mode, execute this command: | |||
29 | 29 | ||
30 | :: | 30 | :: |
31 | 31 | ||
32 | bin/console lexik:maintenance:unlock | 32 | bin/console lexik:maintenance:unlock -e=prod |
diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst index 63b85106..ca0b0f3a 100644 --- a/docs/en/developer/rabbitmq.rst +++ b/docs/en/developer/rabbitmq.rst | |||
@@ -55,22 +55,22 @@ Depending on which service you want to import from you need to enable one (or ma | |||
55 | .. code:: bash | 55 | .. code:: bash |
56 | 56 | ||
57 | # for Pocket import | 57 | # for Pocket import |
58 | bin/console rabbitmq:consumer import_pocket -w | 58 | bin/console rabbitmq:consumer -e=prod import_pocket -w |
59 | 59 | ||
60 | # for Readability import | 60 | # for Readability import |
61 | bin/console rabbitmq:consumer import_readability -w | 61 | bin/console rabbitmq:consumer -e=prod import_readability -w |
62 | 62 | ||
63 | # for Instapaper import | 63 | # for Instapaper import |
64 | bin/console rabbitmq:consumer import_instapaper -w | 64 | bin/console rabbitmq:consumer -e=prod import_instapaper -w |
65 | 65 | ||
66 | # for wallabag v1 import | 66 | # for wallabag v1 import |
67 | bin/console rabbitmq:consumer import_wallabag_v1 -w | 67 | bin/console rabbitmq:consumer -e=prod import_wallabag_v1 -w |
68 | 68 | ||
69 | # for wallabag v2 import | 69 | # for wallabag v2 import |
70 | bin/console rabbitmq:consumer import_wallabag_v2 -w | 70 | bin/console rabbitmq:consumer -e=prod import_wallabag_v2 -w |
71 | 71 | ||
72 | # for Firefox import | 72 | # for Firefox import |
73 | bin/console rabbitmq:consumer import_firefox -w | 73 | bin/console rabbitmq:consumer -e=prod import_firefox -w |
74 | 74 | ||
75 | # for Chrome import | 75 | # for Chrome import |
76 | bin/console rabbitmq:consumer import_chrome -w | 76 | bin/console rabbitmq:consumer -e=prod import_chrome -w |
diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst index 820a52e9..005d6e4f 100644 --- a/docs/en/developer/redis.rst +++ b/docs/en/developer/redis.rst | |||
@@ -44,28 +44,28 @@ Depending on which service you want to import from you need to enable one (or ma | |||
44 | .. code:: bash | 44 | .. code:: bash |
45 | 45 | ||
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 -e=prod pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log |
48 | 48 | ||
49 | # for Readability 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 -e=prod readability -vv >> /path/to/wallabag/var/logs/redis-readability.log |
51 | 51 | ||
52 | # for Instapaper import | 52 | # for Instapaper import |
53 | bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log | 53 | bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log |
54 | 54 | ||
55 | # for wallabag v1 import | 55 | # for wallabag v1 import |
56 | 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 -e=prod wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log |
57 | 57 | ||
58 | # for wallabag v2 import | 58 | # for wallabag v2 import |
59 | 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 -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log |
60 | 60 | ||
61 | # for Firefox import | 61 | # for Firefox import |
62 | bin/console wallabag:import:redis-worker firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log | 62 | bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log |
63 | 63 | ||
64 | # for Chrome import | 64 | # for Chrome import |
65 | bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log | 65 | bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log |
66 | 66 | ||
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 : | 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 : |
68 | 68 | ||
69 | .. code:: bash | 69 | .. code:: bash |
70 | 70 | ||
71 | bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12 | 71 | bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12 |
diff --git a/docs/en/user/errors_during_fetching.rst b/docs/en/user/errors_during_fetching.rst index 68892750..6684563a 100644 --- a/docs/en/user/errors_during_fetching.rst +++ b/docs/en/user/errors_during_fetching.rst | |||
@@ -12,9 +12,21 @@ There may be several reasons: | |||
12 | How can I help to fix that? | 12 | How can I help to fix that? |
13 | --------------------------- | 13 | --------------------------- |
14 | 14 | ||
15 | - `by sending us an email with the article's URL <mailto:hello@wallabag.org>`_ | 15 | You can `sending us an email with the article's URL <mailto:hello@wallabag.org>`_. |
16 | - by trying to fix this article by yourself :) by creating a file for the article. | 16 | |
17 | You can use `this tool <http://siteconfig.fivefilters.org/>`__. | 17 | Or you can also try to fix this problem by yourself (so we can be focused on improving wallabag internally instead of writing siteconfig :) ). |
18 | |||
19 | You can try to see if it works here: `http://f43.me/feed/test <http://f43.me/feed/test>`_ (it uses almost the same system as wallabag to retrieve content). | ||
20 | |||
21 | If it works here and not on wallabag, it means there is something internally in wallabag that breaks the parser (hard to fix: please open an issue about it). | ||
22 | |||
23 | If it doesn't works, try to extract a site config using: `http://siteconfig.fivefilters.org/ <http://siteconfig.fivefilters.org/>`_ (select which part of the content is actually the content). You can `read this documentation before <http://help.fivefilters.org/customer/en/portal/articles/223153-site-patterns>`_. | ||
24 | |||
25 | You can test it on **f43.me** website: click on **Want to try a custom siteconfig?** and put the generated file from siteconfig.fivefilters.org. | ||
26 | |||
27 | Repeat until you have something ok. | ||
28 | |||
29 | Then you can submit a pull request to `https://github.com/fivefilters/ftr-site-config <https://github.com/fivefilters/ftr-site-config>`_ which is the global repo for siteconfig files. | ||
18 | 30 | ||
19 | How can I try to re-fetch this article? | 31 | How can I try to re-fetch this article? |
20 | --------------------------------------- | 32 | --------------------------------------- |
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 82fa6f4e..4aaabd82 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst | |||
@@ -22,6 +22,7 @@ You'll need the following extensions for wallabag to work. Some of these may alr | |||
22 | - php-curl | 22 | - php-curl |
23 | - php-gettext | 23 | - php-gettext |
24 | - php-tokenizer | 24 | - php-tokenizer |
25 | - php-bcmath | ||
25 | 26 | ||
26 | wallabag uses PDO to connect to the database, so you'll need one of the following: | 27 | wallabag uses PDO to connect to the database, so you'll need one of the following: |
27 | 28 | ||
@@ -53,8 +54,8 @@ To install wallabag itself, you must run the following commands: | |||
53 | 54 | ||
54 | git clone https://github.com/wallabag/wallabag.git | 55 | git clone https://github.com/wallabag/wallabag.git |
55 | cd wallabag | 56 | cd wallabag |
56 | git checkout 2.1.0 | 57 | git checkout 2.1.1 --force |
57 | ASSETS=build ./install.sh | 58 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist |
58 | php bin/console wallabag:install --env=prod | 59 | php bin/console wallabag:install --env=prod |
59 | 60 | ||
60 | To start PHP's build-in server and test if everything did install correctly, you can do: | 61 | To start PHP's build-in server and test if everything did install correctly, you can do: |
@@ -85,7 +86,7 @@ Execute this command to download and extract the latest package: | |||
85 | 86 | ||
86 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | 87 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package |
87 | 88 | ||
88 | (md5 hash of the 2.1.0 package: ``6c33520e29cc754b687f9cee0398dede``) | 89 | (md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) |
89 | 90 | ||
90 | Now, read the following documentation to create your virtual host, then access your wallabag. | 91 | Now, read the following documentation to create your virtual host, then access your wallabag. |
91 | If you changed the database configuration to use MySQL or PostgreSQL, you need to create a user via this command ``php bin/console wallabag:install --env=prod``. | 92 | If you changed the database configuration to use MySQL or PostgreSQL, you need to create a user via this command ``php bin/console wallabag:install --env=prod``. |
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 index 234045ba..ec353a18 100644 --- a/docs/en/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/en/user/upgrade-2.0.x-2.1.y.rst | |||
@@ -7,15 +7,15 @@ Before this migration, if you configured the Pocket import by adding your consum | |||
7 | Upgrade on a dedicated web server | 7 | Upgrade on a dedicated web server |
8 | --------------------------------- | 8 | --------------------------------- |
9 | 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): | 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.1`` by the last release number): |
11 | 11 | ||
12 | :: | 12 | :: |
13 | 13 | ||
14 | rm -rf var/cache/* | 14 | rm -rf var/cache/* |
15 | git fetch origin | 15 | git fetch origin |
16 | git fetch --tags | 16 | git fetch --tags |
17 | git checkout 2.1.0 | 17 | git checkout 2.1.1 --force |
18 | ASSETS=build ./install.sh | 18 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist |
19 | php bin/console doctrine:migrations:migrate --env=prod | 19 | php bin/console doctrine:migrations:migrate --env=prod |
20 | php bin/console cache:clear --env=prod | 20 | php bin/console cache:clear --env=prod |
21 | 21 | ||
@@ -30,7 +30,7 @@ Download the last release of wallabag: | |||
30 | 30 | ||
31 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | 31 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package |
32 | 32 | ||
33 | (md5 hash of the 2.1.0 package: ``6c33520e29cc754b687f9cee0398dede``) | 33 | (md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) |
34 | 34 | ||
35 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. | 35 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. |
36 | 36 | ||