7 wallabag est compatible avec PHP >= 5.5, PHP 7 inclus.
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.
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 :
35 Sur un serveur dédié (méthode conseillée)
36 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
38 wallabag utilise un grand nombre de bibliothèques 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``).
40 Installation de Composer :
44 curl -s http://getcomposer.org/installer | php
46 Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__ :
48 Pour installer wallabag, vous devez exécuter ces deux commandes :
52 git clone https://github.com/wallabag/wallabag.git
55 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
56 php bin/console wallabag:install --env=prod
58 Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter :
62 php bin/console server:run --env=prod
64 Et accéder wallabag à l'adresse http://lipdevotreserveur:8000
67 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.
69 Sur un serveur mutualisé
70 ~~~~~~~~~~~~~~~~~~~~~~~~
72 Nous mettons à votre disposition une archive avec toutes les dépendances à l'intérieur.
73 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``.
75 Nous avons déjà créé un utilisateur : le login et le mot de passe sont ``wallabag``.
77 .. 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).
79 Exécutez cette commande pour télécharger et décompresser l'archive :
83 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
85 Maintenant, lisez la documentation ci-dessous pour crééer un virtual host. Accédez ensuite à votre installation de wallabag.
86 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 Installation avec Docker
89 ------------------------
91 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 Commande pour démarrer le containeur
94 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
98 docker pull wallabag/wallabag
103 Configuration avec Apache
104 ~~~~~~~~~~~~~~~~~~~~~~~~~
106 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 ServerName domain.tld
112 ServerAlias www.domain.tld
114 DocumentRoot /var/www/wallabag/web
115 <Directory /var/www/wallabag/web>
120 <IfModule mod_rewrite.c>
123 RewriteCond %{REQUEST_FILENAME} !-f
124 RewriteRule ^(.*)$ app.php [QSA,L]
128 # uncomment the following lines if you install assets as symlinks
129 # or run into problems when compiling LESS/Sass/CoffeScript assets
130 # <Directory /var/www/wallabag>
131 # Options FollowSymlinks
134 # optionally disable the RewriteEngine for the asset directories
135 # which will allow apache to simply reply with a 404 when files are
136 # not found instead of passing the request into the full symfony stack
137 <Directory /var/www/wallabag/web/bundles>
138 <IfModule mod_rewrite.c>
142 ErrorLog /var/log/apache2/wallabag_error.log
143 CustomLog /var/log/apache2/wallabag_access.log combined
146 Après que vous ayez rechargé/redémarré Apache, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
148 Configuration avec Nginx
149 ~~~~~~~~~~~~~~~~~~~~~~~~
151 En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag``, voici un fichier de configuration Nginx pour wallabag :
156 server_name domain.tld www.domain.tld;
157 root /var/www/wallabag/web;
160 # try to serve file directly, fallback to app.php
161 try_files $uri /app.php$is_args$args;
163 location ~ ^/app\.php(/|$) {
164 fastcgi_pass unix:/var/run/php5-fpm.sock;
165 fastcgi_split_path_info ^(.+\.php)(/.*)$;
166 include fastcgi_params;
167 # When you are using symlinks to link the document root to the
168 # current version of your application, you should pass the real
169 # application path instead of the path to the symlink to PHP
171 # Otherwise, PHP's OPcache may not properly detect changes to
172 # your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126
173 # for more information).
174 fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
175 fastcgi_param DOCUMENT_ROOT $realpath_root;
176 # Prevents URIs that include the front controller. This will 404:
177 # http://domain.tld/app.php/some-path
178 # Remove the internal directive to allow URIs like this
182 error_log /var/log/nginx/wallabag_error.log;
183 access_log /var/log/nginx/wallabag_access.log;
186 Après que vous ayez rechargé/redémarré Nginx, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
190 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 Configuration avec lighttpd
193 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
195 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) :
207 server.document-root = "/var/www/wallabag/web"
208 server.upload-dirs = ( "/var/cache/lighttpd/uploads" )
209 server.errorlog = "/var/log/lighttpd/error.log"
210 server.pid-file = "/var/run/lighttpd.pid"
211 server.username = "www-data"
212 server.groupname = "www-data"
214 server.follow-symlink = "enable"
215 index-file.names = ( "index.php", "index.html", "index.lighttpd.html")
216 url.access-deny = ( "~", ".inc" )
217 static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" )
218 compress.cache-dir = "/var/cache/lighttpd/compress/"
219 compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" )
220 include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
221 include_shell "/usr/share/lighttpd/create-mime.assign.pl"
222 include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
223 dir-listing.activate = "disable"
225 url.rewrite-if-not-file = (
226 "^/([^?])(?:\?(.))?" => "/app.php?$1&$2",
227 "^/([^?]*)" => "/app.php?=$1",
230 Droits d'accès aux dossiers du projet
231 -------------------------------------
233 Environnement de test
234 ~~~~~~~~~~~~~~~~~~~~~
236 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 Environnement de production
239 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
241 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 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 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 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 :
251 chown -R www-data:www-data /var/www/wallabag/var
253 Il en est de même pour les dossiers suivants :
255 * /var/www/wallabag/bin/
256 * /var/www/wallabag/app/config/
257 * /var/www/wallabag/vendor/
263 chown -R www-data:www-data /var/www/wallabag/bin
264 chown -R www-data:www-data /var/www/wallabag/app/config
265 chown -R www-data:www-data /var/www/wallabag/vendor
267 sinon lors de la mise à jour vous finirez par rencontrer les erreurs suivantes :
272 Unable to write to the "bin" directory.
273 file_put_contents(app/config/parameters.yml): failed to open stream: Permission denied
274 file_put_contents(/.../wallabag/vendor/autoload.php): failed to open stream: Permission denied