mirrors/wallabag
1
0
Fork 0
mirror of https://github.com/wallabag/wallabag.git synced 2024-11-23 09:31:04 +00:00
Code Issues Projects Releases Wiki Activity

Minor fixes in the english documentation

Browse source
This commit is contained in:
zertrin 2016-10-12 23:52:19 +02:00
parent da8ecdfa17
commit a25377cb4c
3 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/en/developer/redis.rst
View file

@ -35,7 +35,7 @@ Edit your ``parameters.yml`` file to edit Redis configuration. The default one s
redis_host: localhost redis_host: localhost
redis_port: 6379 redis_port: 6379
Enable Redos in wallabag Enable Redis in wallabag
------------------------ ------------------------
In internal settings, in the **Import** section, enable Redis (with the value 1). In internal settings, in the **Import** section, enable Redis (with the value 1).

10
docs/en/user/installation.rst
View file

@ -8,7 +8,7 @@ wallabag is compatible with PHP >= 5.5, including PHP 7.
.. note:: .. note::
To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. To install wallabag easily, we provide a ``Makefile``, so you need to have the ``make`` tool.
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``). 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``).
@ -95,7 +95,7 @@ If you changed the database configuration to use MySQL or PostgreSQL, you need t
Installation with Docker Installation with Docker
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
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. 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.
Command to launch container Command to launch container
^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -194,12 +194,12 @@ After reloading or restarting nginx, you should now be able to access wallabag a
.. tip:: .. tip::
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``. 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``.
Configuration on lighttpd Configuration on lighttpd
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
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): 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):
:: ::
@ -249,7 +249,7 @@ As soon as we use Apache or Nginx to access to our wallabag instance, and not fr
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). 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).
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. 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.
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: 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:

3
docs/en/user/upgrade-2.0.x-2.1.1.rst
View file

@ -2,7 +2,8 @@ Upgrade from 2.0.x to 2.1.1
=========================== ===========================
.. warning:: .. warning::
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.
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.
Upgrade on a dedicated web server Upgrade on a dedicated web server
--------------------------------- ---------------------------------