aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en
diff options
context:
space:
mode:
Diffstat (limited to 'docs/en')
-rw-r--r--docs/en/conf.py2
-rw-r--r--docs/en/developer/api.rst2
-rw-r--r--docs/en/developer/maintenance.rst4
-rw-r--r--docs/en/developer/rabbitmq.rst80
-rw-r--r--docs/en/developer/redis.rst75
-rw-r--r--docs/en/developer/testsuite.rst10
-rw-r--r--docs/en/index.rst12
-rw-r--r--docs/en/user/android.rst12
-rw-r--r--docs/en/user/configuration.rst2
-rw-r--r--docs/en/user/errors_during_fetching.rst18
-rw-r--r--docs/en/user/import.rst35
-rw-r--r--docs/en/user/installation.rst52
-rw-r--r--docs/en/user/migration.rst36
-rw-r--r--docs/en/user/parameters.rst50
-rw-r--r--docs/en/user/share.rst17
-rw-r--r--docs/en/user/upgrade-2.0.x-2.1.1.rst84
-rw-r--r--docs/en/user/upgrade-2.1.x-2.1.y.rst (renamed from docs/en/user/upgrade.rst)11
17 files changed, 434 insertions, 68 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'
12master_doc = 'index' 12master_doc = 'index'
13project = u'wallabag' 13project = u'wallabag'
14copyright = u'2013-2016, Nicolas LÅ“uillet - MIT Licence' 14copyright = u'2013-2016, Nicolas LÅ“uillet - MIT Licence'
15version = '2.0.0' 15version = '2.1.0'
16release = version 16release = version
17exclude_patterns = ['_build'] 17exclude_patterns = ['_build']
18pygments_style = 'sphinx' 18pygments_style = 'sphinx'
diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst
index 83f0bb8f..4828cddd 100644
--- a/docs/en/developer/api.rst
+++ b/docs/en/developer/api.rst
@@ -8,7 +8,7 @@ Requirements
8 8
9* wallabag freshly (or not) installed on http://localhost:8000 9* wallabag freshly (or not) installed on http://localhost:8000
10* ``httpie`` installed on your computer (`see project website <https://github.com/jkbrzt/httpie>`__). Note that you can also adapt the commands using curl or wget. 10* ``httpie`` installed on your computer (`see project website <https://github.com/jkbrzt/httpie>`__). Note that you can also adapt the commands using curl or wget.
11* all the API methods are documented here http://localhost:8000/api/doc 11* all the API methods are documented here http://localhost:8000/api/doc (on your instance) and `on our example instance <http://v2.wallabag.org/api/doc>`_
12 12
13Creating a new API client 13Creating a new API client
14------------------------- 14-------------------------
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
16You 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: 16You 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
new file mode 100644
index 00000000..673228e9
--- /dev/null
+++ b/docs/en/developer/rabbitmq.rst
@@ -0,0 +1,80 @@
1Install RabbitMQ for asynchronous tasks
2=======================================
3
4In order to launch asynchronous tasks (useful for huge imports for example), we can use RabbitMQ.
5
6Requirements
7------------
8
9You need to have RabbitMQ installed on your server.
10
11Installation
12~~~~~~~~~~~~
13
14.. code:: bash
15
16 wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc
17 apt-key add rabbitmq-signing-key-public.asc
18 apt-get update
19 apt-get install rabbitmq-server
20
21Configuration and launch
22~~~~~~~~~~~~~~~~~~~~~~~~
23
24.. code:: bash
25
26 rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest)
27 rabbitmq-server -detached
28
29Stop RabbitMQ
30~~~~~~~~~~~~~
31
32.. code:: bash
33
34 rabbitmqctl stop
35
36
37Configure RabbitMQ in wallabag
38------------------------------
39
40Edit your ``parameters.yml`` file to edit RabbitMQ configuration. The default one should be ok:
41
42.. code:: yaml
43
44 rabbitmq_host: localhost
45 rabbitmq_port: 5672
46 rabbitmq_user: guest
47 rabbitmq_password: guest
48
49Enable RabbitMQ in wallabag
50---------------------------
51
52In internal settings, in the **Import** section, enable RabbitMQ (with the value 1).
53
54Launch RabbitMQ consumer
55------------------------
56
57Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job:
58
59.. code:: bash
60
61 # for Pocket import
62 bin/console rabbitmq:consumer -e=prod import_pocket -w
63
64 # for Readability import
65 bin/console rabbitmq:consumer -e=prod import_readability -w
66
67 # for Instapaper import
68 bin/console rabbitmq:consumer -e=prod import_instapaper -w
69
70 # for wallabag v1 import
71 bin/console rabbitmq:consumer -e=prod import_wallabag_v1 -w
72
73 # for wallabag v2 import
74 bin/console rabbitmq:consumer -e=prod import_wallabag_v2 -w
75
76 # for Firefox import
77 bin/console rabbitmq:consumer -e=prod import_firefox -w
78
79 # for Chrome import
80 bin/console rabbitmq:consumer -e=prod import_chrome -w
diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst
new file mode 100644
index 00000000..2e2bbbea
--- /dev/null
+++ b/docs/en/developer/redis.rst
@@ -0,0 +1,75 @@
1Install Redis for asynchronous tasks
2====================================
3
4In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis.
5
6Requirements
7------------
8
9You need to have Redis installed on your server.
10
11Installation
12~~~~~~~~~~~~
13
14.. code:: bash
15
16 apt-get install redis-server
17
18Launch
19~~~~~~
20
21The server might be already running after installing, if not you can launch it using:
22
23.. code:: bash
24
25 redis-server
26
27
28Configure Redis in wallabag
29---------------------------
30
31Edit your ``parameters.yml`` file to edit Redis configuration. The default one should be ok:
32
33.. code:: yaml
34
35 redis_host: localhost
36 redis_port: 6379
37
38Enable Redis in wallabag
39------------------------
40
41In internal settings, in the **Import** section, enable Redis (with the value 1).
42
43Launch Redis consumer
44---------------------
45
46Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job:
47
48.. code:: bash
49
50 # for Pocket import
51 bin/console wallabag:import:redis-worker -e=prod pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log
52
53 # for Readability import
54 bin/console wallabag:import:redis-worker -e=prod readability -vv >> /path/to/wallabag/var/logs/redis-readability.log
55
56 # for Instapaper import
57 bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log
58
59 # for wallabag v1 import
60 bin/console wallabag:import:redis-worker -e=prod wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log
61
62 # for wallabag v2 import
63 bin/console wallabag:import:redis-worker -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log
64
65 # for Firefox import
66 bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log
67
68 # for Chrome import
69 bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log
70
71If 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 :
72
73.. code:: bash
74
75 bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12
diff --git a/docs/en/developer/testsuite.rst b/docs/en/developer/testsuite.rst
new file mode 100644
index 00000000..b2b16cdc
--- /dev/null
+++ b/docs/en/developer/testsuite.rst
@@ -0,0 +1,10 @@
1Testsuite
2=========
3
4To ensure wallabag development quality, we wrote tests with `PHPUnit <https://phpunit.de>`_.
5
6If you contribute to the project (by translating the application, by fixing bugs or by adding a new feature), please write your own tests.
7
8To launch wallabag testsuite, you need to install `ant <http://ant.apache.org>`_.
9
10Then, execute this command ``make test``.
diff --git a/docs/en/index.rst b/docs/en/index.rst
index 03025ef9..6d85db2b 100644
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -17,6 +17,11 @@ The main documentation for this application is organized into a couple sections:
17* :ref:`user-docs` 17* :ref:`user-docs`
18* :ref:`dev-docs` 18* :ref:`dev-docs`
19 19
20The documentation is available in other languages:
21
22* `Documentation en français <http://doc.wallabag.org/fr/master/>`_
23* `Deutsch Dokumentation <http://doc.wallabag.org/de/master/>`_
24
20.. _user-docs: 25.. _user-docs:
21 26
22.. toctree:: 27.. toctree::
@@ -25,7 +30,8 @@ The main documentation for this application is organized into a couple sections:
25 30
26 user/faq 31 user/faq
27 user/installation 32 user/installation
28 user/upgrade 33 user/upgrade-2.0.x-2.1.1
34 user/upgrade-2.1.x-2.1.y
29 user/migration 35 user/migration
30 user/import 36 user/import
31 user/create_account 37 user/create_account
@@ -35,9 +41,11 @@ The main documentation for this application is organized into a couple sections:
35 user/errors_during_fetching 41 user/errors_during_fetching
36 user/annotations 42 user/annotations
37 user/download_articles 43 user/download_articles
44 user/share
38 user/filters 45 user/filters
39 user/tags 46 user/tags
40 user/android 47 user/android
48 user/parameters
41 49
42.. _dev-docs: 50.. _dev-docs:
43 51
@@ -50,3 +58,5 @@ The main documentation for this application is organized into a couple sections:
50 developer/documentation 58 developer/documentation
51 developer/translate 59 developer/translate
52 developer/maintenance 60 developer/maintenance
61 developer/redis
62 developer/rabbitmq
diff --git a/docs/en/user/android.rst b/docs/en/user/android.rst
index 4271f037..ccbad264 100644
--- a/docs/en/user/android.rst
+++ b/docs/en/user/android.rst
@@ -29,13 +29,13 @@ Fill in your wallabag data. You need to enter your wallabag address. It is impor
29 :alt: Filled in settings 29 :alt: Filled in settings
30 :align: center 30 :align: center
31 31
32After you have filled in your data, push the button Connection test and wait for the test to finish. 32After you have filled in your data, push the button Connection test and wait for the test to finish.
33 33
34.. image:: ../../img/user/android_configuration_connection_test.en.png 34.. image:: ../../img/user/android_configuration_connection_test.en.png
35 :alt: Connection test with your wallabag data 35 :alt: Connection test with your wallabag data
36 :align: center 36 :align: center
37 37
38The connection test shall finish with success. If not, you need to fix this first until you proceed. 38The connection test should finish with success. If not, you need to fix this first until you proceed.
39 39
40.. image:: ../../img/user/android_configuration_connection_test_success.en.png 40.. image:: ../../img/user/android_configuration_connection_test_success.en.png
41 :alt: Connection test successful 41 :alt: Connection test successful
@@ -65,16 +65,16 @@ After hitting the save button, you get the following screen. The app proposes to
65 :alt: Settings saved the first time 65 :alt: Settings saved the first time
66 :align: center 66 :align: center
67 67
68Finally after the syncronisation finished successfully, you are presented the list of unread articles. 68Finally after the synchronisation finished successfully, you are presented to the list of unread articles.
69 69
70.. image:: ../../img/user/android_unread_feed_synced.en.png 70.. image:: ../../img/user/android_unread_feed_synced.en.png
71 :alt: Filled article list cause feeds successfully syncronized 71 :alt: Filled article list cause feeds successfully synchronized
72 :align: center 72 :align: center
73 73
74 74
75 75
76Known limitations 76Known limitations
77---- 77-----------------
78 78
792FA 792FA
80~~~ 80~~~
@@ -85,7 +85,7 @@ Currently the does not support two-factor authentication. You should disable tha
85Limited amount of articles with wallabag v2 85Limited amount of articles with wallabag v2
86~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 86~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
87 87
88In your wallabag web instance you can configure how many items are part of the RSS feed. This option did not exist in wallabag v1, where all articles were part of the feed. So if you set the amount of articles being displayed greater than the number of items being content of your RSS feed, you will only see the number of items in your RSS feed. 88In your wallabag web instance you can configure how many items are part of the RSS feed. This option did not exist in wallabag v1, where all articles were part of the feed. So if you set the amount of articles being displayed greater than the number of items being content of your RSS feed, you will only see the number of items in your RSS feed.
89 89
90 90
91SSL/TLS encryption 91SSL/TLS encryption
diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst
index f4c55dea..f74924df 100644
--- a/docs/en/user/configuration.rst
+++ b/docs/en/user/configuration.rst
@@ -100,7 +100,7 @@ if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long r
100Which variables and operators can I use to write rules? 100Which variables and operators can I use to write rules?
101~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 101~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
102 102
103The following variables and operators can be used to create tagging rules: 103The following variables and operators can be used to create tagging rules (be careful, for some values, you need to add quotes, for example ``language = "en"``):
104 104
105=========== ============================================== ======== ========== 105=========== ============================================== ======== ==========
106Variable Meaning Operator Meaning 106Variable Meaning Operator Meaning
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:
12How can I help to fix that? 12How 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>`_ 15You 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/>`__. 17Or you can also try to fix this problem by yourself (so we can be focused on improving wallabag internally instead of writing siteconfig :) ).
18
19You 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
21If 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
23If 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
25You 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
27Repeat until you have something ok.
28
29Then 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
19How can I try to re-fetch this article? 31How can I try to re-fetch this article?
20--------------------------------------- 32---------------------------------------
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst
index 63210484..70f0187d 100644
--- a/docs/en/user/import.rst
+++ b/docs/en/user/import.rst
@@ -23,22 +23,43 @@ 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). 31
32From Readability
33----------------
34
35Export your Readability data
36~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37
38On the tools (`https://www.readability.com/tools/ <https://www.readability.com/tools/>`_) page, click on "Export your data" in the "Data Export" section. You will received an email to download a json (which does not end with .json in fact).
39
40Import your data into wallabag 2.x
41~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
42
43Click on ``Import`` link in the menu, on ``Import contents`` in Readability section
44and then select your json file and upload it.
45
46Your data will be imported. Data import can be a demanding process for your server.
32 47
33From Instapaper 48From Instapaper
34--------------- 49---------------
35 50
36*Feature not yet implemented in wallabag v2.* 51Export your Instapaper data
52~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37 53
38From Readability 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``).
39----------------
40 55
41*Feature not yet implemented in wallabag v2.* 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.
42 63
43From HTML or JSON file 64From HTML or JSON file
44---------------------- 65----------------------
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index 763d7c66..45e14616 100644
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -6,7 +6,21 @@ Requirements
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. 9.. note::
10
11 To install wallabag easily, we provide a ``Makefile``, so you need to have the ``make`` tool.
12
13wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``).
14
15Install Composer:
16
17::
18
19 curl -s http://getcomposer.org/installer | php
20
21You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__.
22
23You'll also 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 24
11- php-session 25- php-session
12- php-ctype 26- php-ctype
@@ -22,6 +36,7 @@ You'll need the following extensions for wallabag to work. Some of these may alr
22- php-curl 36- php-curl
23- php-gettext 37- php-gettext
24- php-tokenizer 38- php-tokenizer
39- php-bcmath
25 40
26wallabag uses PDO to connect to the database, so you'll need one of the following: 41wallabag uses PDO to connect to the database, so you'll need one of the following:
27 42
@@ -37,31 +52,18 @@ Installation
37On a dedicated web server (recommended way) 52On a dedicated web server (recommended way)
38~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 53~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
39 54
40wallabag uses a large number of libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``).
41
42Install Composer:
43
44::
45
46 curl -s http://getcomposer.org/installer | php
47
48You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__:
49
50To install wallabag itself, you must run the following commands: 55To install wallabag itself, you must run the following commands:
51 56
52:: 57::
53 58
54 git clone https://github.com/wallabag/wallabag.git 59 git clone https://github.com/wallabag/wallabag.git
55 cd wallabag 60 cd wallabag && make install
56 git checkout 2.0.8
57 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
58 php bin/console wallabag:install --env=prod
59 61
60To start PHP's build-in server and test if everything did install correctly, you can do: 62To start PHP's build-in server and test if everything did install correctly, you can do:
61 63
62:: 64::
63 65
64 php bin/console server:run --env=prod 66 make run
65 67
66And access wallabag at http://yourserverip:8000 68And access wallabag at http://yourserverip:8000
67 69
@@ -85,18 +87,18 @@ Execute this command to download and extract the latest package:
85 87
86 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package 88 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
87 89
88(md5 hash of the package: ``4f84c725d1d6e3345eae0a406115e5ff``) 90You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
89 91
90Now, read the following documentation to create your virtual host, then access your wallabag. 92Now, read the following documentation to create your virtual host, then access your wallabag.
91If 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``. 93If 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 94
93Installation with Docker 95Installation with Docker
94------------------------ 96~~~~~~~~~~~~~~~~~~~~~~~~
95 97
96We provide you a Docker image to install wallabag easily. Have a look to our repository on `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ to have more information. 98We provide you a Docker image to install wallabag easily. Have a look at our repository on `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ for more information.
97 99
98Command to launch container 100Command to launch container
99~~~~~~~~~~~~~~~~~~~~~~~~~~~ 101^^^^^^^^^^^^^^^^^^^^^^^^^^^
100 102
101.. code-block:: bash 103.. code-block:: bash
102 104
@@ -192,12 +194,12 @@ After reloading or restarting nginx, you should now be able to access wallabag a
192 194
193.. tip:: 195.. tip::
194 196
195 When you want to import large file into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``. 197 When you want to import large files into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``.
196 198
197Configuration on lighttpd 199Configuration on lighttpd
198~~~~~~~~~~~~~~~~~~~~~~~~~ 200~~~~~~~~~~~~~~~~~~~~~~~~~
199 201
200Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe for wallabag (edit your ``lighttpd.conf`` file and paste this configuration into it): 202Assuming you install wallabag in the ``/var/www/wallabag`` folder, here's the recipe for wallabag (edit your ``lighttpd.conf`` file and paste this configuration into it):
201 203
202:: 204::
203 205
@@ -238,16 +240,16 @@ Rights access to the folders of the project
238Test environment 240Test environment
239~~~~~~~~~~~~~~~~ 241~~~~~~~~~~~~~~~~
240 242
241When we just want to test wallabag, we just run the command ``php bin/console server:run --env=prod`` to start our wallabag instance and everything will go smoothly because the user who started the project can access to the current folder naturally, without any problem. 243When we just want to test wallabag, we just run the command ``make run`` to start our wallabag instance and everything will go smoothly because the user who started the project can access to the current folder naturally, without any problem.
242 244
243Production environment 245Production environment
244~~~~~~~~~~~~~~~~~~~~~~ 246~~~~~~~~~~~~~~~~~~~~~~
245 247
246As soon as we use Apache or Nginx to access to our wallabag instance, and not from the command ``php bin/console server:run --env=prod`` to start it, we should take care to grant the good rights on the good folders to keep safe all the folders of the project. 248As soon as we use Apache or Nginx to access to our wallabag instance, and not from the command ``make run`` to start it, we should take care to grant the good rights on the good folders to keep safe all the folders of the project.
247 249
248To do so, the folder name, known as ``DocumentRoot`` (for apache) or ``root`` (for Nginx), has to be absolutely accessible by the Apache/Nginx user. Its name is generally ``www-data``, ``apache`` or ``nobody`` (depending on linux system used). 250To do so, the folder name, known as ``DocumentRoot`` (for apache) or ``root`` (for Nginx), has to be absolutely accessible by the Apache/Nginx user. Its name is generally ``www-data``, ``apache`` or ``nobody`` (depending on linux system used).
249 251
250So the folder ``/var/www/wallabag/web`` has to be accessible by this last one. But this could be not enough if we just care about this folder, because we could meet a blank page or get an error 500 when trying to access to the homepage of the project. 252So the folder ``/var/www/wallabag/web`` has to be accessible by this last one. But this may not be enough if we just care about this folder, because we could meet a blank page or get an error 500 when trying to access to the homepage of the project.
251 253
252This is due to the fact that we will need to grant the same rights access on the folder ``/var/www/wallabag/var`` like those we gave on the folder ``/var/www/wallabag/web``. Thus, we fix this problem with the following command: 254This is due to the fact that we will need to grant the same rights access on the folder ``/var/www/wallabag/var`` like those we gave on the folder ``/var/www/wallabag/web``. Thus, we fix this problem with the following command:
253 255
diff --git a/docs/en/user/migration.rst b/docs/en/user/migration.rst
index e141ae40..42062796 100644
--- a/docs/en/user/migration.rst
+++ b/docs/en/user/migration.rst
@@ -24,20 +24,38 @@ After creating an user account on your new wallabag v2 instance, you must head o
24 :alt: Import from wallabag v1 24 :alt: Import from wallabag v1
25 :align: center 25 :align: center
26 26
27From wallabag 2.x
28-----------------
29
30From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json.
31
32.. image:: ../../img/user/export_v2.png
33 :alt: Export depuis wallabag v2
34 :align: center
35
36From 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.
37
38.. note::
39 If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
40
27Import via command-line interface (CLI) 41Import via command-line interface (CLI)
28~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 42---------------------------------------
29 43
30If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export: 44If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export:
31 45
32:: 46::
33 47
34 bin/console wallabag:import-v1 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod 48 bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
35 49
36Please replace values: 50Please replace values:
37 51
38* ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1) 52* ``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 53* ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export
40 54
55If you want to mark all these entries as read, you can add the ``--markAsRead`` option.
56
57To import a wallabag v2 file, you need to add the option ``--importer=v2``.
58
41You'll have this in return: 59You'll have this in return:
42 60
43:: 61::
@@ -46,17 +64,3 @@ You'll have this in return:
46 403 imported 64 403 imported
47 0 already saved 65 0 already saved
48 End : 05-04-2016 11:36:09 --- 66 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>`__.
diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst
new file mode 100644
index 00000000..6cbd5ae4
--- /dev/null
+++ b/docs/en/user/parameters.rst
@@ -0,0 +1,50 @@
1What is the meaning of the parameters?
2======================================
3.. csv-table:: Database parameters
4 :header: "name", "default", "description"
5
6 "database_driver", "pdo_sqlite", "Should be pdo_sqlite or pdo_mysql or pdo_pgsql"
7 "database_host", "127.0.0.1", "host of your database (usually localhost or 127.0.0.1)"
8 "database_port", "~", "port of your database (you can leave ``~`` to use the default one)"
9 "database_name", "symfony", "name of your database"
10 "database_user", "root", "user that can write to this database"
11 "database_password", "~", "password of that user"
12 "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "only for SQLite, define where to put the database file. Leave it empty for other database"
13 "database_table_prefix", "wallabag_", "all wallabag's tables will be prefixed with that string. You can include a ``_`` for clarity"
14 "database_socket", "null", "If your database is using a socket instead of tcp, put the path of the socket (other connection parameters will then be ignored)"
15
16.. csv-table:: Configuration to send emails from wallabag
17 :header: "name", "default", "description"
18
19 "mailer_transport", "smtp", "The exact transport method to use to deliver emails. Valid values are: smtp, gmail, mail, sendmail, null (which will disable the mailer)"
20 "mailer_host", "127.0.0.1", "The host to connect to when using smtp as the transport."
21 "mailer_user", "~", "The username when using smtp as the transport."
22 "mailer_password", "~", "The password when using smtp as the transport."
23
24.. csv-table:: Other wallabag's option
25 :header: "name", "default", "description"
26
27 "locale", "en", "Default language of your wallabag instance (like en, fr, es, etc.)"
28 "secret", "ovmpmAWXRCabNlMgzlzFXDYmCFfzGv", "This is a string that should be unique to your application and it's commonly used to add more entropy to security related operations."
29 "twofactor_auth", "true", "true to enable Two factor authentication"
30 "twofactor_sender", "no-reply@wallabag.org", "email of the email sender to receive the two factor code"
31 "fosuser_registration", "true", "true to enable public registration"
32 "fosuser_confirmation", "true", "true to send a confirmation by email for each registration"
33 "from_email", "no-reply@wallabag.org", "email address used in From: field in each email"
34 "rss_limit", "50", "limit for RSS feeds"
35
36.. csv-table:: RabbitMQ configuration
37 :header: "name", "default", "description"
38
39 "rabbitmq_host", "localhost", "Host of your RabbitMQ"
40 "rabbitmq_port", "5672", "Port of your RabbitMQ"
41 "rabbitmq_user", "guest", "User that can read queues"
42 "rabbitmq_password", "guest", "Password of that user"
43
44.. csv-table:: Redis configuration
45 :header: "name", "default", "description"
46
47 "redis_scheme", "tcp", "Specifies the protocol used to communicate with an instance of Redis. Valid values are: tcp, unix, http"
48 "redis_host", "localhost", "IP or hostname of the target server (ignored for unix scheme)"
49 "redis_port", "6379", "TCP/IP port of the target server (ignored for unix scheme)"
50 "redis_path", "null", "Path of the UNIX domain socket file used when connecting to Redis using UNIX domain sockets"
diff --git a/docs/en/user/share.rst b/docs/en/user/share.rst
new file mode 100644
index 00000000..e99e51ab
--- /dev/null
+++ b/docs/en/user/share.rst
@@ -0,0 +1,17 @@
1Share articles
2==============
3
4When you're reading an article, you can share it. Just click on the share button:
5
6.. image:: ../../img/user/share.png
7 :alt: share article
8 :align: center
9
10Now, you can share the article:
11
12- with a public URL (you'll have a light view of the article)
13- with a tweet
14- into your Shaarli
15- with a post in Diaspora*
16- to Carrot
17- with an email
diff --git a/docs/en/user/upgrade-2.0.x-2.1.1.rst b/docs/en/user/upgrade-2.0.x-2.1.1.rst
new file mode 100644
index 00000000..4f9b9cee
--- /dev/null
+++ b/docs/en/user/upgrade-2.0.x-2.1.1.rst
@@ -0,0 +1,84 @@
1Upgrade from 2.0.x to 2.1.1
2===========================
3
4.. warning::
5
6 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.
7
8Upgrade on a dedicated web server
9---------------------------------
10
11::
12
13 rm -rf var/cache/*
14 git fetch origin
15 git fetch --tags
16 git checkout 2.1.1 --force
17 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
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://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz
31
32(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``)
33
34Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
35
36Please check that your ``app/config/parameters.yml`` contains all the required parameters. Here is a default ``parameters.yml`` file. If you don't know which parameter you need to set, please leave the default one.
37
38.. code-block:: yml
39
40 parameters:
41 database_driver: pdo_sqlite
42 database_host: 127.0.0.1
43 database_port: null
44 database_name: symfony
45 database_user: root
46 database_password: null
47 database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite'
48 database_table_prefix: wallabag_
49 mailer_transport: smtp
50 mailer_host: 127.0.0.1
51 mailer_user: null
52 mailer_password: null
53 locale: en
54 secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv
55 twofactor_auth: true
56 twofactor_sender: no-reply@wallabag.org
57 fosuser_registration: true
58 fosuser_confirmation: true
59 from_email: no-reply@wallabag.org
60 rss_limit: 50
61 rabbitmq_host: localhost
62 rabbitmq_port: 5672
63 rabbitmq_user: guest
64 rabbitmq_password: guest
65 redis_host: localhost
66 redis_port: 6379
67
68You can find `here a documentation about parameters <http://doc.wallabag.org/en/master/user/parameters.html>`_.
69
70If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
71
72Empty ``var/cache`` folder.
73
74You 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:
75
76.. code-block:: sql
77
78 ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL;
79 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry');
80 ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL;
81 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import');
82 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import');
83 ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL;
84 DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key';
diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade-2.1.x-2.1.y.rst
index 90ed6c70..62cb7dc0 100644
--- a/docs/en/user/upgrade.rst
+++ b/docs/en/user/upgrade-2.1.x-2.1.y.rst
@@ -1,16 +1,17 @@
1Upgrade wallabag 1Upgrading from 2.1.x to 2.1.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.0.8`` 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.1.2`` by the last release number):
8 8
9:: 9::
10 10
11 rm -rf var/cache/*
11 git fetch origin 12 git fetch origin
12 git fetch --tags 13 git fetch --tags
13 git checkout 2.0.8 14 git checkout 2.1.2 --force
14 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist 15 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
15 php bin/console cache:clear --env=prod 16 php bin/console cache:clear --env=prod
16 17
@@ -25,7 +26,7 @@ Download the last release of wallabag:
25 26
26 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package 27 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
27 28
28(md5 hash of the package: ``4f84c725d1d6e3345eae0a406115e5ff``) 29You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
29 30
30Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. 31Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
31 32