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