7 wallabag est compatible avec PHP >= 5.5, PHP 7 inclus.
11 Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``.
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``).
15 Installation de Composer :
19 curl -s https://getcomposer.org/installer | php
21 Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__.
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.
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 :
50 Sur un serveur dédié (méthode conseillée)
51 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
53 Pour installer wallabag, vous devez exécuter ces commandes :
57 git clone https://github.com/wallabag/wallabag.git
58 cd wallabag && make install
60 Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter :
66 Et accéder wallabag à l'adresse http://lipdevotreserveur:8000
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.
71 Sur un serveur mutualisé
72 ~~~~~~~~~~~~~~~~~~~~~~~~
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``.
77 Nous avons déjà créé un utilisateur : le login et le mot de passe sont ``wallabag``.
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).
81 Exécutez cette commande pour télécharger et décompresser l'archive :
85 wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package
87 Vous trouverez `le hash md5 du dernier package sur notre site <https://www.wallabag.org/pages/download-wallabag.html>`_.
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``.
92 Installation avec Docker
93 ~~~~~~~~~~~~~~~~~~~~~~~~
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.
97 Commande pour démarrer le containeur
98 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
102 docker pull wallabag/wallabag
107 Configuration avec Apache
108 ~~~~~~~~~~~~~~~~~~~~~~~~~
110 N'oubliez pas d'activer le mod *rewrite* de Apache
114 a2enmod rewrite && systemctl reload apache2
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 :
121 ServerName domain.tld
122 ServerAlias www.domain.tld
124 DocumentRoot /var/www/wallabag/web
125 <Directory /var/www/wallabag/web>
130 <IfModule mod_rewrite.c>
133 RewriteCond %{REQUEST_FILENAME} !-f
134 RewriteRule ^(.*)$ app.php [QSA,L]
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
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>
152 ErrorLog /var/log/apache2/wallabag_error.log
153 CustomLog /var/log/apache2/wallabag_access.log combined
156 .. tip:: Pour Apache 2.4, dans la section `<Directory /var/www/wallabag/web>` vous devez remplacer les directives suivantes :
174 Après que vous ayez rechargé/redémarré Apache, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
176 Configuration avec Nginx
177 ~~~~~~~~~~~~~~~~~~~~~~~~
179 En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag``, voici un fichier de configuration Nginx pour wallabag :
184 server_name domain.tld www.domain.tld;
185 root /var/www/wallabag/web;
188 # try to serve file directly, fallback to app.php
189 try_files $uri /app.php$is_args$args;
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
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
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.
216 error_log /var/log/nginx/wallabag_error.log;
217 access_log /var/log/nginx/wallabag_access.log;
220 Après que vous ayez rechargé/redémarré Nginx, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
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``.
226 Configuration avec lighttpd
227 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
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) :
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"
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"
259 url.rewrite-if-not-file = (
260 "^/([^?])(?:\?(.))?" => "/app.php?$1&$2",
261 "^/([^?]*)" => "/app.php?=$1",
264 Droits d'accès aux dossiers du projet
265 -------------------------------------
267 Environnement de test
268 ~~~~~~~~~~~~~~~~~~~~~
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.
272 Environnement de production
273 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
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).
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.
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 :
285 chown -R www-data:www-data /var/www/wallabag/var
287 Il en est de même pour les dossiers suivants :
289 * /var/www/wallabag/bin/
290 * /var/www/wallabag/app/config/
291 * /var/www/wallabag/vendor/
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
301 sinon lors de la mise à jour vous finirez par rencontrer les erreurs suivantes :
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