docs/fr/user/installation.rst

   1 Installer wallabag
   2 ==================
   3
   4 Pré-requis
   5 ------------
   6
   7 wallabag est compatible avec PHP >= 5.5, 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 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 :
 111
 112 ::
 113
 114     <VirtualHost *:80>
 115         ServerName domain.tld
 116         ServerAlias www.domain.tld
 117
 118         DocumentRoot /var/www/wallabag/web
 119         <Directory /var/www/wallabag/web>
 120             AllowOverride None
 121             Order Allow,Deny
 122             Allow from All
 123
 124             <IfModule mod_rewrite.c>
 125                 Options -MultiViews
 126                 RewriteEngine On
 127                 RewriteCond %{REQUEST_FILENAME} !-f
 128                 RewriteRule ^(.*)$ app.php [QSA,L]
 129             </IfModule>
 130         </Directory>
 131
 132         # uncomment the following lines if you install assets as symlinks
 133         # or run into problems when compiling LESS/Sass/CoffeScript assets
 134         # <Directory /var/www/wallabag>
 135         #     Options FollowSymlinks
 136         # </Directory>
 137
 138         # optionally disable the RewriteEngine for the asset directories
 139         # which will allow apache to simply reply with a 404 when files are
 140         # not found instead of passing the request into the full symfony stack
 141         <Directory /var/www/wallabag/web/bundles>
 142             <IfModule mod_rewrite.c>
 143                 RewriteEngine Off
 144             </IfModule>
 145         </Directory>
 146         ErrorLog /var/log/apache2/wallabag_error.log
 147         CustomLog /var/log/apache2/wallabag_access.log combined
 148     </VirtualHost>
 149
 150 .. tip:: Pour Apache 2.4, dans la section `<Directory /var/www/wallabag/web>` vous devez remplacer les directives suivantes :
 151
 152 ::
 153
 154     AllowOverride None
 155     Order Allow,Deny
 156     Allow from All
 157
 158
 159 par
 160
 161 ::
 162
 163     Require All granted
 164
 165
 166
 167
 168 Après que vous ayez rechargé/redémarré Apache, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
 169
 170 Configuration avec Nginx
 171 ~~~~~~~~~~~~~~~~~~~~~~~~
 172
 173 En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag``, voici un fichier de configuration Nginx pour wallabag :
 174
 175 ::
 176
 177     server {
 178         server_name domain.tld www.domain.tld;
 179         root /var/www/wallabag/web;
 180
 181         location / {
 182             # try to serve file directly, fallback to app.php
 183             try_files $uri /app.php$is_args$args;
 184         }
 185         location ~ ^/app\.php(/|$) {
 186             fastcgi_pass unix:/var/run/php5-fpm.sock;
 187             fastcgi_split_path_info ^(.+\.php)(/.*)$;
 188             include fastcgi_params;
 189             # When you are using symlinks to link the document root to the
 190             # current version of your application, you should pass the real
 191             # application path instead of the path to the symlink to PHP
 192             # FPM.
 193             # Otherwise, PHP's OPcache may not properly detect changes to
 194             # your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126
 195             # for more information).
 196             fastcgi_param  SCRIPT_FILENAME  $realpath_root$fastcgi_script_name;
 197             fastcgi_param DOCUMENT_ROOT $realpath_root;
 198             # Prevents URIs that include the front controller. This will 404:
 199             # http://domain.tld/app.php/some-path
 200             # Remove the internal directive to allow URIs like this
 201             internal;
 202         }
 203
 204         # return 404 for all other php files not matching the front controller
 205         # this prevents access to other php files you don't want to be accessible.
 206         location ~ \.php$ {
 207             return 404;
 208         }
 209
 210         error_log /var/log/nginx/wallabag_error.log;
 211         access_log /var/log/nginx/wallabag_access.log;
 212     }
 213
 214 Après que vous ayez rechargé/redémarré Nginx, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
 215
 216 .. tip::
 217
 218     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``.
 219
 220 Configuration avec lighttpd
 221 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 222
 223 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) :
 224
 225 ::
 226
 227     server.modules = (
 228         "mod_fastcgi",
 229         "mod_access",
 230         "mod_alias",
 231         "mod_compress",
 232         "mod_redirect",
 233         "mod_rewrite",
 234     )
 235     server.document-root = "/var/www/wallabag/web"
 236     server.upload-dirs = ( "/var/cache/lighttpd/uploads" )
 237     server.errorlog = "/var/log/lighttpd/error.log"
 238     server.pid-file = "/var/run/lighttpd.pid"
 239     server.username = "www-data"
 240     server.groupname = "www-data"
 241     server.port = 80
 242     server.follow-symlink = "enable"
 243     index-file.names = ( "index.php", "index.html", "index.lighttpd.html")
 244     url.access-deny = ( "~", ".inc" )
 245     static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" )
 246     compress.cache-dir = "/var/cache/lighttpd/compress/"
 247     compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" )
 248     include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
 249     include_shell "/usr/share/lighttpd/create-mime.assign.pl"
 250     include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
 251     dir-listing.activate = "disable"
 252
 253     url.rewrite-if-not-file = (
 254         "^/([^?])(?:\?(.))?" => "/app.php?$1&$2",
 255         "^/([^?]*)" => "/app.php?=$1",
 256     )
 257
 258 Droits d'accès aux dossiers du projet
 259 -------------------------------------
 260
 261 Environnement de test
 262 ~~~~~~~~~~~~~~~~~~~~~
 263
 264 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.
 265
 266 Environnement de production
 267 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 268
 269 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.
 270
 271 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).
 272
 273 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.
 274
 275 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 :
 276
 277 .. code-block:: bash
 278
 279    chown -R www-data:www-data /var/www/wallabag/var
 280
 281 Il en est de même pour les dossiers suivants :
 282
 283 * /var/www/wallabag/bin/
 284 * /var/www/wallabag/app/config/
 285 * /var/www/wallabag/vendor/
 286
 287 en tapant
 288
 289 .. code-block:: bash
 290
 291    chown -R www-data:www-data /var/www/wallabag/bin
 292    chown -R www-data:www-data /var/www/wallabag/app/config
 293    chown -R www-data:www-data /var/www/wallabag/vendor
 294
 295 sinon lors de la mise à jour vous finirez par rencontrer les erreurs suivantes :
 296
 297
 298 .. code-block:: bash
 299
 300     Unable to write to the "bin" directory.
 301     file_put_contents(app/config/parameters.yml): failed to open stream: Permission denied
 302     file_put_contents(/.../wallabag/vendor/autoload.php): failed to open stream: Permission denied