aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/user
diff options
context:
space:
mode:
Diffstat (limited to 'docs/en/user')
-rw-r--r--docs/en/user/installation.rst10
-rw-r--r--docs/en/user/parameters.rst6
-rw-r--r--docs/en/user/upgrade-2.0.x-2.1.1.rst5
3 files changed, 12 insertions, 9 deletions
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index 248c1995..45e14616 100644
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -8,7 +8,7 @@ wallabag is compatible with PHP >= 5.5, including PHP 7.
8 8
9.. note:: 9.. note::
10 10
11 To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. 11 To install wallabag easily, we provide a ``Makefile``, so you need to have the ``make`` tool.
12 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``). 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 14
@@ -95,7 +95,7 @@ If you changed the database configuration to use MySQL or PostgreSQL, you need t
95Installation with Docker 95Installation with Docker
96~~~~~~~~~~~~~~~~~~~~~~~~ 96~~~~~~~~~~~~~~~~~~~~~~~~
97 97
98We 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.
99 99
100Command to launch container 100Command to launch container
101^^^^^^^^^^^^^^^^^^^^^^^^^^^ 101^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -194,12 +194,12 @@ After reloading or restarting nginx, you should now be able to access wallabag a
194 194
195.. tip:: 195.. tip::
196 196
197 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``.
198 198
199Configuration on lighttpd 199Configuration on lighttpd
200~~~~~~~~~~~~~~~~~~~~~~~~~ 200~~~~~~~~~~~~~~~~~~~~~~~~~
201 201
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): 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):
203 203
204:: 204::
205 205
@@ -249,7 +249,7 @@ As soon as we use Apache or Nginx to access to our wallabag instance, and not fr
249 249
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). 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).
251 251
252So 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.
253 253
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: 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:
255 255
diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst
index 79c50871..6cbd5ae4 100644
--- a/docs/en/user/parameters.rst
+++ b/docs/en/user/parameters.rst
@@ -9,9 +9,9 @@ What is the meaning of the parameters?
9 "database_name", "symfony", "name of your database" 9 "database_name", "symfony", "name of your database"
10 "database_user", "root", "user that can write to this database" 10 "database_user", "root", "user that can write to this database"
11 "database_password", "~", "password of that user" 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 for other database" 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" 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" 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 15
16.. csv-table:: Configuration to send emails from wallabag 16.. csv-table:: Configuration to send emails from wallabag
17 :header: "name", "default", "description" 17 :header: "name", "default", "description"
@@ -38,7 +38,7 @@ What is the meaning of the parameters?
38 38
39 "rabbitmq_host", "localhost", "Host of your RabbitMQ" 39 "rabbitmq_host", "localhost", "Host of your RabbitMQ"
40 "rabbitmq_port", "5672", "Port of your RabbitMQ" 40 "rabbitmq_port", "5672", "Port of your RabbitMQ"
41 "rabbitmq_user", "guest", "Usee that can read queues" 41 "rabbitmq_user", "guest", "User that can read queues"
42 "rabbitmq_password", "guest", "Password of that user" 42 "rabbitmq_password", "guest", "Password of that user"
43 43
44.. csv-table:: Redis configuration 44.. csv-table:: Redis configuration
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
index 2f08b7bd..4f9b9cee 100644
--- a/docs/en/user/upgrade-2.0.x-2.1.1.rst
+++ b/docs/en/user/upgrade-2.0.x-2.1.1.rst
@@ -2,7 +2,8 @@ Upgrade from 2.0.x to 2.1.1
2=========================== 2===========================
3 3
4.. warning:: 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. 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.
6 7
7Upgrade on a dedicated web server 8Upgrade on a dedicated web server
8--------------------------------- 9---------------------------------
@@ -64,6 +65,8 @@ Please check that your ``app/config/parameters.yml`` contains all the required p
64 redis_host: localhost 65 redis_host: localhost
65 redis_port: 6379 66 redis_port: 6379
66 67
68You can find `here a documentation about parameters <http://doc.wallabag.org/en/master/user/parameters.html>`_.
69
67If you use SQLite, you must also copy your ``data/`` folder inside the new installation. 70If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
68 71
69Empty ``var/cache`` folder. 72Empty ``var/cache`` folder.