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 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.
  10
  11 - php-session
  12 - php-ctype
  13 - php-dom
  14 - php-hash
  15 - php-simplexml
  16 - php-json
  17 - php-gd
  18 - php-mbstring
  19 - php-xml
  20 - php-tidy
  21 - php-iconv
  22 - php-curl
  23 - php-gettext
  24 - php-tokenizer
  25
  26 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 :
  27
  28 - pdo_mysql
  29 - pdo_sqlite
  30 - pdo_pgsql
  31
  32 Installation
  33 ------------
  34
  35 Sur un serveur dédié (méthode conseillée)
  36 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  37
  38 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``).
  39
  40 Installation de Composer :
  41
  42 ::
  43
  44     curl -s http://getcomposer.org/installer | php
  45
  46 Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__.
  47
  48 Vous devez aussi installer node.js (via `la page de téléchargements <https://nodejs.org/en/download/>`__), npm (déjà installé avec node.js), bower et grunt:
  49
  50 ::
  51
  52     npm install -g bower
  53     npm install -g grunt-cli
  54
  55 Pour installer wallabag, vous devez exécuter ces commandes :
  56
  57 ::
  58
  59     git clone https://github.com/wallabag/wallabag.git
  60     cd wallabag
  61     git checkout 2.1
  62     ./install.sh
  63
  64 Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter :
  65
  66 ::
  67
  68     php bin/console server:run --env=prod
  69
  70 Et accéder wallabag à l'adresse http://lipdevotreserveur:8000
  71
  72 .. tip::
  73     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 `documentation Symfony <http://symfony.com/doc/current/cookbook/configuration/external_parameters.html>`__ pour en savoir plus.
  74
  75 Sur un serveur mutualisé
  76 ~~~~~~~~~~~~~~~~~~~~~~~~
  77
  78 Nous mettons à votre disposition une archive avec toutes les dépendances à l'intérieur.
  79 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``.
  80
  81 Nous avons déjà créé un utilisateur : le login et le mot de passe sont ``wallabag``.
  82
  83 .. 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).
  84
  85 Exécutez cette commande pour télécharger et décompresser l'archive :
  86
  87 .. code-block:: bash
  88
  89     wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
  90
  91 (hash md5 de l'archive : ``4f84c725d1d6e3345eae0a406115e5ff``)
  92
  93 Maintenant, lisez la documentation ci-dessous pour crééer un virtual host. Accédez ensuite à votre installation de wallabag.
  94 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``.
  95
  96 Installation avec Docker
  97 ------------------------
  98
  99 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.
 100
 101 Commande pour démarrer le containeur
 102 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 103
 104 .. code-block:: bash
 105
 106     docker pull wallabag/wallabag
 107
 108 Virtual hosts
 109 -------------
 110
 111 Configuration avec Apache
 112 ~~~~~~~~~~~~~~~~~~~~~~~~~
 113
 114 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 :
 115
 116 ::
 117
 118     <VirtualHost *:80>
 119         ServerName domain.tld
 120         ServerAlias www.domain.tld
 121
 122         DocumentRoot /var/www/wallabag/web
 123         <Directory /var/www/wallabag/web>
 124             AllowOverride None
 125             Order Allow,Deny
 126             Allow from All
 127
 128             <IfModule mod_rewrite.c>
 129                 Options -MultiViews
 130                 RewriteEngine On
 131                 RewriteCond %{REQUEST_FILENAME} !-f
 132                 RewriteRule ^(.*)$ app.php [QSA,L]
 133             </IfModule>
 134         </Directory>
 135
 136         # uncomment the following lines if you install assets as symlinks
 137         # or run into problems when compiling LESS/Sass/CoffeScript assets
 138         # <Directory /var/www/wallabag>
 139         #     Options FollowSymlinks
 140         # </Directory>
 141
 142         # optionally disable the RewriteEngine for the asset directories
 143         # which will allow apache to simply reply with a 404 when files are
 144         # not found instead of passing the request into the full symfony stack
 145         <Directory /var/www/wallabag/web/bundles>
 146             <IfModule mod_rewrite.c>
 147                 RewriteEngine Off
 148             </IfModule>
 149         </Directory>
 150         ErrorLog /var/log/apache2/wallabag_error.log
 151         CustomLog /var/log/apache2/wallabag_access.log combined
 152     </VirtualHost>
 153
 154 Après que vous ayez rechargé/redémarré Apache, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
 155
 156 Configuration avec Nginx
 157 ~~~~~~~~~~~~~~~~~~~~~~~~
 158
 159 En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag``, voici un fichier de configuration Nginx pour wallabag :
 160
 161 ::
 162
 163     server {
 164         server_name domain.tld www.domain.tld;
 165         root /var/www/wallabag/web;
 166
 167         location / {
 168             # try to serve file directly, fallback to app.php
 169             try_files $uri /app.php$is_args$args;
 170         }
 171         location ~ ^/app\.php(/|$) {
 172             fastcgi_pass unix:/var/run/php5-fpm.sock;
 173             fastcgi_split_path_info ^(.+\.php)(/.*)$;
 174             include fastcgi_params;
 175             # When you are using symlinks to link the document root to the
 176             # current version of your application, you should pass the real
 177             # application path instead of the path to the symlink to PHP
 178             # FPM.
 179             # Otherwise, PHP's OPcache may not properly detect changes to
 180             # your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126
 181             # for more information).
 182             fastcgi_param  SCRIPT_FILENAME  $realpath_root$fastcgi_script_name;
 183             fastcgi_param DOCUMENT_ROOT $realpath_root;
 184             # Prevents URIs that include the front controller. This will 404:
 185             # http://domain.tld/app.php/some-path
 186             # Remove the internal directive to allow URIs like this
 187             internal;
 188         }
 189
 190         error_log /var/log/nginx/wallabag_error.log;
 191         access_log /var/log/nginx/wallabag_access.log;
 192     }
 193
 194 Après que vous ayez rechargé/redémarré Nginx, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
 195
 196 .. tip::
 197
 198     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``.
 199
 200 Configuration avec lighttpd
 201 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 202
 203 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) :
 204
 205 ::
 206
 207     server.modules = (
 208         "mod_fastcgi",
 209         "mod_access",
 210         "mod_alias",
 211         "mod_compress",
 212         "mod_redirect",
 213         "mod_rewrite",
 214     )
 215     server.document-root = "/var/www/wallabag/web"
 216     server.upload-dirs = ( "/var/cache/lighttpd/uploads" )
 217     server.errorlog = "/var/log/lighttpd/error.log"
 218     server.pid-file = "/var/run/lighttpd.pid"
 219     server.username = "www-data"
 220     server.groupname = "www-data"
 221     server.port = 80
 222     server.follow-symlink = "enable"
 223     index-file.names = ( "index.php", "index.html", "index.lighttpd.html")
 224     url.access-deny = ( "~", ".inc" )
 225     static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" )
 226     compress.cache-dir = "/var/cache/lighttpd/compress/"
 227     compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" )
 228     include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
 229     include_shell "/usr/share/lighttpd/create-mime.assign.pl"
 230     include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
 231     dir-listing.activate = "disable"
 232
 233     url.rewrite-if-not-file = (
 234         "^/([^?])(?:\?(.))?" => "/app.php?$1&$2",
 235         "^/([^?]*)" => "/app.php?=$1",
 236     )
 237
 238 Droits d'accès aux dossiers du projet
 239 -------------------------------------
 240
 241 Environnement de test
 242 ~~~~~~~~~~~~~~~~~~~~~
 243
 244 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.
 245
 246 Environnement de production
 247 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 248
 249 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.
 250
 251 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).
 252
 253 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.
 254
 255 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 :
 256
 257 .. code-block:: bash
 258
 259    chown -R www-data:www-data /var/www/wallabag/var
 260
 261 Il en est de même pour les dossiers suivants :
 262
 263 * /var/www/wallabag/bin/
 264 * /var/www/wallabag/app/config/
 265 * /var/www/wallabag/vendor/
 266
 267 en tapant
 268
 269 .. code-block:: bash
 270
 271    chown -R www-data:www-data /var/www/wallabag/bin
 272    chown -R www-data:www-data /var/www/wallabag/app/config
 273    chown -R www-data:www-data /var/www/wallabag/vendor
 274
 275 sinon lors de la mise à jour vous finirez par rencontrer les erreurs suivantes :
 276
 277
 278 .. code-block:: bash
 279
 280     Unable to write to the "bin" directory.
 281     file_put_contents(app/config/parameters.yml): failed to open stream: Permission denied
 282     file_put_contents(/.../wallabag/vendor/autoload.php): failed to open stream: Permission denied