fixed typo

[github/wallabag/wallabag.git] / docs / en / user / installation.rst

diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index 760fd4d2fa4b94ab91158ccf16aa64a77459b9d1..c2174a53da34a0e436679d16bf5b827667b96541 100644 (file)
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -4,14 +4,14 @@ Install wallabag
 Requirements
 ------------
 
-wallabag is compatible with php >= 5.5
+wallabag is compatible with PHP >= 5.5, including PHP 7.
 
-You'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.
+You'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.
 
 - php-session
 - php-ctype
 - php-dom
-- pĥp-hash
+- php-hash
 - php-simplexml
 - php-json
 - php-gd
@@ -25,9 +25,9 @@ You'll need the following extensions for wallabag to work. Some of these may alr
 
 wallabag uses PDO to connect to database, so you'll need one of:
 
-- php-pdo_mysql
-- php-pdo_sqlite
-- php-pdo_pgsql
+- pdo_mysql
+- pdo_sqlite
+- pdo_pgsql
 
 and it's corresponding database server.
 
@@ -42,13 +42,16 @@ Install Composer:
 
     curl -s http://getcomposer.org/installer | php
 
-You can find specific instructions here : __ https://getcomposer.org/doc/00-intro.md
+You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__:
 
 To install wallabag itself, you must run these two commands:
 
 ::
 
-    SYMFONY_ENV=prod composer create-project wallabag/wallabag wallabag "2.0.*@alpha" --no-dev
+    git clone https://github.com/wallabag/wallabag.git
+    cd wallabag
+    git checkout 2.0.3
+    SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
     php bin/console wallabag:install --env=prod
 
 To start php's build-in server and test if everything did install correctly, you can do:
@@ -59,6 +62,10 @@ To start php's build-in server and test if everything did install correctly, you
 
 And access wallabag at http://yourserverip:8000
 
+.. note::
+
+    To define parameters with environment variables, you have to set these variables with ``SYMFONY__`` prefix. For example, ``SYMFONY__DATABASE_DRIVER``. You can have a look to the `Symfony documentation <http://symfony.com/doc/current/cookbook/configuration/external_parameters.html>`__.
+
 Installing on Apache
 --------------------
 
@@ -143,3 +150,34 @@ Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe
     }
 
 After reloading or restarting nginx, you should now be able to access wallabag at http://domain.tld.
+
+.. note::
+
+    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``.
+
+
+Rights access to the folders of the project
+-------------------------------------------
+
+
+Test Environment
+~~~~~~~~~~~~~~~~
+
+When 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.
+
+
+Production Environment
+~~~~~~~~~~~~~~~~~~~~~~
+
+As 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.
+
+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.
+
+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:
+
+.. code-block:: bash
+
+   chown -R www-data:www-data /var/www/wallabag/var
+