docs/fr/user/installation.rst

   1 Installer wallabag
   2 ==================
   3
   4 Pré-requis
   5 ------------
   6
   7 wallabag est compatible avec **PHP >= 5.6**, PHP 7 inclus.
   8
   9 .. note::
  10
  11     Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``.
  12
  13 wallabag utilise un grand nombre de bibliothèques PHP pour fonctionner. Ces bibliothèques doivent être installées à l'aide d'un outil nommé Composer. Vous devez l'installer si ce n'est déjà fait et vous assurer que vous utilisez bien la version 1.2 (si vous avez déjà Composer, faite un ``composer selfupdate``).
  14
  15 Installation de Composer :
  16
  17 ::
  18
  19     curl -s https://getcomposer.org/installer | php
  20
  21 Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__.
  22
  23 Vous aurez besoin des extensions suivantes pour que wallabag fonctionne. Il est possible que certaines de ces extensions soient déjà activées dans votre version de PHP, donc vous n'avez pas forcément besoin d'installer tous les paquets correspondants.
  24
  25 - php-session
  26 - php-ctype
  27 - php-dom
  28 - php-hash
  29 - php-simplexml
  30 - php-json
  31 - php-gd
  32 - php-mbstring
  33 - php-xml
  34 - php-tidy
  35 - php-iconv
  36 - php-curl
  37 - php-gettext
  38 - php-tokenizer
  39 - php-bcmath
  40
  41 wallabag utilise PDO afin de se connecter à une base de données, donc vous aurez besoin d'une extension et d'un système de bases de données parmi :
  42
  43 - pdo_mysql
  44 - pdo_sqlite
  45 - pdo_pgsql
  46
  47 Installation
  48 ------------
  49
  50 Sur un serveur dédié (méthode conseillée)
  51 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  52
  53 Pour installer wallabag, vous devez exécuter ces commandes :
  54
  55 ::
  56
  57     git clone https://github.com/wallabag/wallabag.git
  58     cd wallabag && make install
  59
  60 Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter :
  61
  62 ::
  63
  64     make run
  65
  66 Et accéder wallabag à l'adresse http://lipdevotreserveur:8000
  67
  68 .. tip::
  69     Pour définir des paramètres via des variables d'environnement, vous pouvez les spécifier avec le préfixe ``SYMFONY__``. Par exemple, ``SYMFONY__DATABASE_DRIVER``. Vous pouvez lire la `documentation Symfony <http://symfony.com/doc/current/cookbook/configuration/external_parameters.html>`__ pour en savoir plus.
  70
  71 Sur un serveur mutualisé
  72 ~~~~~~~~~~~~~~~~~~~~~~~~
  73
  74 Nous mettons à votre disposition une archive avec toutes les dépendances à l'intérieur.
  75 La configuration par défaut utilise SQLite pour la base de données. Si vous souhaitez changer ces paramètres, vous devez modifier le fichier ``app/config/parameters.yml``.
  76
  77 Nous avons déjà créé un utilisateur : le login et le mot de passe sont ``wallabag``.
  78
  79 .. caution:: Avec cette archive, wallabag ne vérifie pas si les extensions obligatoires sont présentes sur votre serveur pour bien fonctionner (ces vérifications sont faites durant le ``composer install`` quand vous avez un serveur dédié, voir ci-dessus).
  80
  81 Exécutez cette commande pour télécharger et décompresser l'archive :
  82
  83 .. code-block:: bash
  84
  85     wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package
  86
  87 Vous trouverez `le hash md5 du dernier package sur notre site <https://www.wallabag.org/pages/download-wallabag.html>`_.
  88
  89 Maintenant, lisez la documentation ci-dessous pour crééer un virtual host. Accédez ensuite à votre installation de wallabag.
  90 Si vous avez changé la configuration pour modifier le type de stockage (MySQL ou PostgreSQL), vous devrez vous créer un utilisateur via la commande ``php bin/console wallabag:install --env=prod``.
  91
  92 Installation avec Docker
  93 ~~~~~~~~~~~~~~~~~~~~~~~~
  94
  95 Nous vous proposons une image Docker pour installer wallabag facilement. Allez voir du côté de `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ pour plus d'informations.
  96
  97 Commande pour démarrer le containeur
  98 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  99
 100 .. code-block:: bash
 101
 102     docker pull wallabag/wallabag
 103
 104 Virtual hosts
 105 -------------
 106
 107 Configuration avec Apache
 108 ~~~~~~~~~~~~~~~~~~~~~~~~~
 109
 110 N'oubliez pas d'activer le mod *rewrite* de Apache
 111
 112 .. code-block:: bash
 113
 114     a2enmod rewrite && systemctl reload apache2
 115
 116 En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag`` et que vous utilisiez PHP comme un module Apache, voici un vhost pour wallabag :
 117
 118 ::
 119
 120     <VirtualHost *:80>
 121         ServerName domain.tld
 122         ServerAlias www.domain.tld
 123
 124         DocumentRoot /var/www/wallabag/web
 125         <Directory /var/www/wallabag/web>
 126             AllowOverride None
 127             Order Allow,Deny
 128             Allow from All
 129
 130             <IfModule mod_rewrite.c>
 131                 Options -MultiViews
 132                 RewriteEngine On
 133                 RewriteCond %{REQUEST_FILENAME} !-f
 134                 RewriteRule ^(.*)$ app.php [QSA,L]
 135             </IfModule>
 136         </Directory>
 137
 138         # uncomment the following lines if you install assets as symlinks
 139         # or run into problems when compiling LESS/Sass/CoffeScript assets
 140         # <Directory /var/www/wallabag>
 141         #     Options FollowSymlinks
 142         # </Directory>
 143
 144         # optionally disable the RewriteEngine for the asset directories
 145         # which will allow apache to simply reply with a 404 when files are
 146         # not found instead of passing the request into the full symfony stack
 147         <Directory /var/www/wallabag/web/bundles>
 148             <IfModule mod_rewrite.c>
 149                 RewriteEngine Off
 150             </IfModule>
 151         </Directory>
 152         ErrorLog /var/log/apache2/wallabag_error.log
 153         CustomLog /var/log/apache2/wallabag_access.log combined
 154     </VirtualHost>
 155
 156 .. tip:: Pour Apache 2.4, dans la section `<Directory /var/www/wallabag/web>` vous devez remplacer les directives suivantes :
 157
 158 ::
 159
 160     AllowOverride None
 161     Order Allow,Deny
 162     Allow from All
 163
 164
 165 par
 166
 167 ::
 168
 169     Require All granted
 170
 171
 172
 173
 174 Après que vous ayez rechargé/redémarré Apache, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
 175
 176 Configuration avec Nginx
 177 ~~~~~~~~~~~~~~~~~~~~~~~~
 178
 179 En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag``, voici un fichier de configuration Nginx pour wallabag :
 180
 181 ::
 182
 183     server {
 184         server_name domain.tld www.domain.tld;
 185         root /var/www/wallabag/web;
 186
 187         location / {
 188             # try to serve file directly, fallback to app.php
 189             try_files $uri /app.php$is_args$args;
 190         }
 191         location ~ ^/app\.php(/|$) {
 192             fastcgi_pass unix:/var/run/php5-fpm.sock;
 193             fastcgi_split_path_info ^(.+\.php)(/.*)$;
 194             include fastcgi_params;
 195             # When you are using symlinks to link the document root to the
 196             # current version of your application, you should pass the real
 197             # application path instead of the path to the symlink to PHP
 198             # FPM.
 199             # Otherwise, PHP's OPcache may not properly detect changes to
 200             # your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126
 201             # for more information).
 202             fastcgi_param  SCRIPT_FILENAME  $realpath_root$fastcgi_script_name;
 203             fastcgi_param DOCUMENT_ROOT $realpath_root;
 204             # Prevents URIs that include the front controller. This will 404:
 205             # http://domain.tld/app.php/some-path
 206             # Remove the internal directive to allow URIs like this
 207             internal;
 208         }
 209
 210         # return 404 for all other php files not matching the front controller
 211         # this prevents access to other php files you don't want to be accessible.
 212         location ~ \.php$ {
 213             return 404;
 214         }
 215
 216         error_log /var/log/nginx/wallabag_error.log;
 217         access_log /var/log/nginx/wallabag_access.log;
 218     }
 219
 220 Après que vous ayez rechargé/redémarré Nginx, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
 221
 222 .. tip::
 223
 224     Si vous voulez importer un fichier important dans wallabag, vous devez ajouter cette ligne dans votre configuration nginx ``client_max_body_size XM; # allows file uploads up to X megabytes``.
 225
 226 Configuration avec lighttpd
 227 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 228
 229 En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag``, voici un fichier de configuration pour wallabag (éditez votre fichier ``lighttpd.conf`` collez-y cette configuration) :
 230
 231 ::
 232
 233     server.modules = (
 234         "mod_fastcgi",
 235         "mod_access",
 236         "mod_alias",
 237         "mod_compress",
 238         "mod_redirect",
 239         "mod_rewrite",
 240     )
 241     server.document-root = "/var/www/wallabag/web"
 242     server.upload-dirs = ( "/var/cache/lighttpd/uploads" )
 243     server.errorlog = "/var/log/lighttpd/error.log"
 244     server.pid-file = "/var/run/lighttpd.pid"
 245     server.username = "www-data"
 246     server.groupname = "www-data"
 247     server.port = 80
 248     server.follow-symlink = "enable"
 249     index-file.names = ( "index.php", "index.html", "index.lighttpd.html")
 250     url.access-deny = ( "~", ".inc" )
 251     static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" )
 252     compress.cache-dir = "/var/cache/lighttpd/compress/"
 253     compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" )
 254     include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
 255     include_shell "/usr/share/lighttpd/create-mime.assign.pl"
 256     include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
 257     dir-listing.activate = "disable"
 258
 259     url.rewrite-if-not-file = (
 260         "^/([^?])(?:\?(.))?" => "/app.php?$1&$2",
 261         "^/([^?]*)" => "/app.php?=$1",
 262     )
 263
 264 Droits d'accès aux dossiers du projet
 265 -------------------------------------
 266
 267 Environnement de test
 268 ~~~~~~~~~~~~~~~~~~~~~
 269
 270 Quand nous souhaitons juste tester wallabag, nous lançons simplement la commande  ``php bin/console server:run --env=prod`` pour démarrer l'instance wallabag et tout se passe correctement car l'utilisateur qui a démarré le projet a accès naturellement au repertoire courant, tout va bien.
 271
 272 Environnement de production
 273 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 274
 275 Dès lors que nous utilisons Apache ou Nginx pour accéder à notre instance wallabag, et non plus la commande ``php bin/console server:run --env=prod`` pour la démarrer, il faut prendre garde à octroyer les bons droits aux bons dossiers afin de préserver la sécurité de l'ensemble des fichiers fournis par le projet.
 276
 277 Aussi, le dossier, connu sous le nom de ``DocumentRoot`` (pour apache) ou ``root`` (pour Nginx), doit être impérativement accessible par l'utilisateur de Apache ou Nginx. Le nom de cet utilisateur est généralement ``www-data``, ``apache`` ou ``nobody`` (selon les systèmes linux utilisés).
 278
 279 Donc le dossier ``/var/www/wallabag/web`` doit être accessible par ce dernier. Mais cela ne suffira pas si nous nous contentons de ce dossier, et nous pourrions avoir, au mieux une page blanche en accédant à la page d'accueil du projet, au pire une erreur 500.
 280
 281 Cela est dû au fait qu'il faut aussi octroyer les mêmes droits d'accès au dossier ``/var/www/wallabag/var`` que ceux octroyés au dossier ``/var/www/wallabag/web``. Ainsi, on règle le problème par la commande suivante :
 282
 283 .. code-block:: bash
 284
 285    chown -R www-data:www-data /var/www/wallabag/var
 286
 287 Il en est de même pour les dossiers suivants :
 288
 289 * /var/www/wallabag/bin/
 290 * /var/www/wallabag/app/config/
 291 * /var/www/wallabag/vendor/
 292
 293 en tapant
 294
 295 .. code-block:: bash
 296
 297    chown -R www-data:www-data /var/www/wallabag/bin
 298    chown -R www-data:www-data /var/www/wallabag/app/config
 299    chown -R www-data:www-data /var/www/wallabag/vendor
 300
 301 sinon lors de la mise à jour vous finirez par rencontrer les erreurs suivantes :
 302
 303
 304 .. code-block:: bash
 305
 306     Unable to write to the "bin" directory.
 307     file_put_contents(app/config/parameters.yml): failed to open stream: Permission denied
 308     file_put_contents(/.../wallabag/vendor/autoload.php): failed to open stream: Permission denied