]> git.immae.eu Git - github/wallabag/wallabag.git/blobdiff - docs/en/user/installation.rst
Merge pull request #2861 from wallabag/2.3-droping-5.5
[github/wallabag/wallabag.git] / docs / en / user / installation.rst
index 248c19958bac00391df21a10f2d1485c186fb57a..2c4b8749f1046362e3c0849fba3699aa23bc8de0 100644 (file)
@@ -4,11 +4,11 @@ Install wallabag
 Requirements
 ------------
 
-wallabag is compatible with PHP >= 5.5, including PHP 7.
+wallabag is compatible with **PHP >= 5.6**, including PHP 7.
 
 .. 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``).
 
@@ -16,7 +16,7 @@ Install Composer:
 
 ::
 
-    curl -s http://getcomposer.org/installer | php
+    curl -s https://getcomposer.org/installer | php
 
 You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__.
 
@@ -85,7 +85,7 @@ Execute this command to download and extract the latest package:
 
 .. code-block:: bash
 
-    wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
+    wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package
 
 You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
 
@@ -95,7 +95,7 @@ If you changed the database configuration to use MySQL or PostgreSQL, you need t
 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
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -110,6 +110,12 @@ Virtual hosts
 Configuration on Apache
 ~~~~~~~~~~~~~~~~~~~~~~~
 
+Do not forget to active the *rewrite* mod of Apache
+
+.. code-block:: bash
+
+    a2enmod rewrite && systemctl reload apache2
+
 Assuming you install wallabag in the ``/var/www/wallabag`` folder and that you want to use PHP as an Apache module, here's a vhost for wallabag:
 
 ::
@@ -149,6 +155,23 @@ Assuming you install wallabag in the ``/var/www/wallabag`` folder and that you w
         ErrorLog /var/log/apache2/wallabag_error.log
         CustomLog /var/log/apache2/wallabag_access.log combined
     </VirtualHost>
+    
+    
+.. tip:: Note for Apache 2.4, in the section `<Directory /var/www/wallabag/web>` you have to replace the directives : 
+
+::
+
+    AllowOverride None
+    Order Allow,Deny
+    Allow from All
+
+
+by 
+
+::
+    
+    Require All granted
+    
 
 After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld.
 
@@ -186,6 +209,12 @@ Assuming you installed wallabag in the ``/var/www/wallabag`` folder, here's the
             internal;
         }
 
+        # return 404 for all other php files not matching the front controller
+        # this prevents access to other php files you don't want to be accessible.
+        location ~ \.php$ {
+            return 404;
+        }
+
         error_log /var/log/nginx/wallabag_error.log;
         access_log /var/log/nginx/wallabag_access.log;
     }
@@ -194,12 +223,12 @@ After reloading or restarting nginx, you should now be able to access wallabag a
 
 .. 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
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-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 +278,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).
 
-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: