diff options
author | Nicolas LÅ“uillet <nicolas@loeuillet.org> | 2016-10-13 16:52:25 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-10-13 16:52:25 +0200 |
commit | e65c27587b940ef8de88578e57f109b5b7819684 (patch) | |
tree | 417e6ab1ca92bc3e117eb08e21cb289cb491799e /docs/en | |
parent | da8ecdfa17a0ed482f9066c674a0e7d76a9354cd (diff) | |
parent | a25377cb4c6308710f82f147e27c72e64cead752 (diff) | |
download | wallabag-e65c27587b940ef8de88578e57f109b5b7819684.tar.gz wallabag-e65c27587b940ef8de88578e57f109b5b7819684.tar.zst wallabag-e65c27587b940ef8de88578e57f109b5b7819684.zip |
Merge pull request #2439 from zertrin/minor-fix-docs-1
Minor fixes in the english documentation
Diffstat (limited to 'docs/en')
-rw-r--r-- | docs/en/developer/redis.rst | 2 | ||||
-rw-r--r-- | docs/en/user/installation.rst | 10 | ||||
-rw-r--r-- | docs/en/user/upgrade-2.0.x-2.1.1.rst | 3 |
3 files changed, 8 insertions, 7 deletions
diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst index 67b6452e..2e2bbbea 100644 --- a/docs/en/developer/redis.rst +++ b/docs/en/developer/redis.rst | |||
@@ -35,7 +35,7 @@ Edit your ``parameters.yml`` file to edit Redis configuration. The default one s | |||
35 | redis_host: localhost | 35 | redis_host: localhost |
36 | redis_port: 6379 | 36 | redis_port: 6379 |
37 | 37 | ||
38 | Enable Redos in wallabag | 38 | Enable Redis in wallabag |
39 | ------------------------ | 39 | ------------------------ |
40 | 40 | ||
41 | In internal settings, in the **Import** section, enable Redis (with the value 1). | 41 | In internal settings, in the **Import** section, enable Redis (with the value 1). |
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 | ||
13 | wallabag 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``). | 13 | wallabag 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 | |||
95 | Installation with Docker | 95 | Installation with Docker |
96 | ~~~~~~~~~~~~~~~~~~~~~~~~ | 96 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
97 | 97 | ||
98 | We 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. | 98 | We 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 | ||
100 | Command to launch container | 100 | Command 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 | ||
199 | Configuration on lighttpd | 199 | Configuration on lighttpd |
200 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | 200 | ~~~~~~~~~~~~~~~~~~~~~~~~~ |
201 | 201 | ||
202 | Assuming 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): | 202 | Assuming 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 | ||
250 | To 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). | 250 | To 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 | ||
252 | So 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. | 252 | So 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 | ||
254 | This 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: | 254 | This 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/upgrade-2.0.x-2.1.1.rst b/docs/en/user/upgrade-2.0.x-2.1.1.rst index 2f08b7bd..f5a48592 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:: |
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. | 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 | ||
7 | Upgrade on a dedicated web server | 8 | Upgrade on a dedicated web server |
8 | --------------------------------- | 9 | --------------------------------- |