]> git.immae.eu Git - github/wallabag/wallabag.git/blame - docs/fr/user/installation.rst
Dropping PHP 5.5
[github/wallabag/wallabag.git] / docs / fr / user / installation.rst
CommitLineData
4bf0d4e0
NL
1Installer wallabag
2==================
e6ebb14f
NL
3
4Pré-requis
89d95cdd
TC
5------------
6
eff75729 7wallabag est compatible avec PHP >= 5.5, PHP 7 inclus.
89d95cdd 8
84e3c36e 9.. note::
36ef9e27
NL
10
11 Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``.
84e3c36e 12
7eff4736
NL
13wallabag 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
15Installation de Composer :
16
17::
18
7c05d591 19 curl -s https://getcomposer.org/installer | php
7eff4736
NL
20
21Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__.
22
eff75729 23Vous 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.
89d95cdd
TC
24
25- php-session
26- php-ctype
27- php-dom
7bf4dd89 28- php-hash
89d95cdd
TC
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
f7265b4b 39- php-bcmath
89d95cdd
TC
40
41wallabag 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
eff75729
NL
43- pdo_mysql
44- pdo_sqlite
45- pdo_pgsql
e6ebb14f
NL
46
47Installation
48------------
49
bba9907d
NL
50Sur un serveur dédié (méthode conseillée)
51~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
52
8fed8d1b 53Pour installer wallabag, vous devez exécuter ces commandes :
e6ebb14f
NL
54
55::
56
c1181313 57 git clone https://github.com/wallabag/wallabag.git
7c122534 58 cd wallabag && make install
e6ebb14f 59
89d95cdd
TC
60Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter :
61
62::
63
7c122534 64 make run
89d95cdd
TC
65
66Et accéder wallabag à l'adresse http://lipdevotreserveur:8000
67
bba9907d 68.. tip::
b09cafbb 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.
7704ef5d 70
bba9907d
NL
71Sur un serveur mutualisé
72~~~~~~~~~~~~~~~~~~~~~~~~
73
74Nous mettons à votre disposition une archive avec toutes les dépendances à l'intérieur.
75La 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
77Nous avons déjà créé un utilisateur : le login et le mot de passe sont ``wallabag``.
78
e546a2d6 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).
bba9907d
NL
80
81Exécutez cette commande pour télécharger et décompresser l'archive :
82
83.. code-block:: bash
84
7c05d591 85 wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package
bba9907d 86
7eff4736 87Vous trouverez `le hash md5 du dernier package sur notre site <https://www.wallabag.org/pages/download-wallabag.html>`_.
94d1dae4 88
e546a2d6 89Maintenant, lisez la documentation ci-dessous pour crééer un virtual host. Accédez ensuite à votre installation de wallabag.
bba9907d
NL
90Si 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
92Installation avec Docker
7eff4736 93~~~~~~~~~~~~~~~~~~~~~~~~
89d95cdd 94
bba9907d
NL
95Nous 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
97Commande pour démarrer le containeur
7eff4736 98^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
bba9907d
NL
99
100.. code-block:: bash
101
102 docker pull wallabag/wallabag
103
104Virtual hosts
105-------------
106
107Configuration avec Apache
108~~~~~~~~~~~~~~~~~~~~~~~~~
109
110En 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 :
89d95cdd
TC
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
426bfdc3 150Après que vous ayez rechargé/redémarré Apache, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
89d95cdd 151
bba9907d
NL
152Configuration avec Nginx
153~~~~~~~~~~~~~~~~~~~~~~~~
89d95cdd 154
bba9907d 155En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag``, voici un fichier de configuration Nginx pour wallabag :
89d95cdd
TC
156
157::
158
159 server {
160 server_name domain.tld www.domain.tld;
161 root /var/www/wallabag/web;
162
163 location / {
164 # try to serve file directly, fallback to app.php
165 try_files $uri /app.php$is_args$args;
166 }
167 location ~ ^/app\.php(/|$) {
168 fastcgi_pass unix:/var/run/php5-fpm.sock;
169 fastcgi_split_path_info ^(.+\.php)(/.*)$;
170 include fastcgi_params;
171 # When you are using symlinks to link the document root to the
172 # current version of your application, you should pass the real
173 # application path instead of the path to the symlink to PHP
174 # FPM.
175 # Otherwise, PHP's OPcache may not properly detect changes to
176 # your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126
177 # for more information).
178 fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
179 fastcgi_param DOCUMENT_ROOT $realpath_root;
180 # Prevents URIs that include the front controller. This will 404:
181 # http://domain.tld/app.php/some-path
182 # Remove the internal directive to allow URIs like this
183 internal;
184 }
185
ccad5d76
OD
186 # return 404 for all other php files not matching the front controller
187 # this prevents access to other php files you don't want to be accessible.
188 location ~ \.php$ {
189 return 404;
190 }
191
89d95cdd
TC
192 error_log /var/log/nginx/wallabag_error.log;
193 access_log /var/log/nginx/wallabag_access.log;
194 }
195
426bfdc3 196Après que vous ayez rechargé/redémarré Nginx, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
cea846d4 197
bba9907d 198.. tip::
cea846d4 199
61fcbe9f 200 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``.
9ddf49ba 201
8b563fc0 202Configuration avec lighttpd
e546a2d6
NL
203~~~~~~~~~~~~~~~~~~~~~~~~~~~
204
8b563fc0 205En 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) :
e546a2d6
NL
206
207::
208
209 server.modules = (
8b563fc0
NL
210 "mod_fastcgi",
211 "mod_access",
212 "mod_alias",
213 "mod_compress",
214 "mod_redirect",
215 "mod_rewrite",
e546a2d6
NL
216 )
217 server.document-root = "/var/www/wallabag/web"
218 server.upload-dirs = ( "/var/cache/lighttpd/uploads" )
219 server.errorlog = "/var/log/lighttpd/error.log"
220 server.pid-file = "/var/run/lighttpd.pid"
221 server.username = "www-data"
222 server.groupname = "www-data"
223 server.port = 80
224 server.follow-symlink = "enable"
225 index-file.names = ( "index.php", "index.html", "index.lighttpd.html")
226 url.access-deny = ( "~", ".inc" )
227 static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" )
228 compress.cache-dir = "/var/cache/lighttpd/compress/"
229 compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" )
230 include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
231 include_shell "/usr/share/lighttpd/create-mime.assign.pl"
232 include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
233 dir-listing.activate = "disable"
234
235 url.rewrite-if-not-file = (
8b563fc0
NL
236 "^/([^?])(?:\?(.))?" => "/app.php?$1&$2",
237 "^/([^?]*)" => "/app.php?=$1",
e546a2d6
NL
238 )
239
9ddf49ba
OD
240Droits d'accès aux dossiers du projet
241-------------------------------------
242
9ddf49ba
OD
243Environnement de test
244~~~~~~~~~~~~~~~~~~~~~
245
87b8461e 246Quand 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.
9ddf49ba 247
e546a2d6 248Environnement de production
9ddf49ba
OD
249~~~~~~~~~~~~~~~~~~~~~~~~~~~
250
87b8461e 251Dè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.
9ddf49ba
OD
252
253Aussi, 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).
254
255Donc 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.
256
257Cela 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 :
258
259.. code-block:: bash
260
261 chown -R www-data:www-data /var/www/wallabag/var
ab46a256
OD
262
263Il en est de même pour les dossiers suivants :
264
265* /var/www/wallabag/bin/
266* /var/www/wallabag/app/config/
267* /var/www/wallabag/vendor/
268
269en tapant
270
271.. code-block:: bash
272
273 chown -R www-data:www-data /var/www/wallabag/bin
274 chown -R www-data:www-data /var/www/wallabag/app/config
275 chown -R www-data:www-data /var/www/wallabag/vendor
276
277sinon lors de la mise à jour vous finirez par rencontrer les erreurs suivantes :
278
279
280.. code-block:: bash
281
282 Unable to write to the "bin" directory.
283 file_put_contents(app/config/parameters.yml): failed to open stream: Permission denied
284 file_put_contents(/.../wallabag/vendor/autoload.php): failed to open stream: Permission denied