aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorNicolas Lœuillet <nicolas@loeuillet.org>2016-04-27 07:19:31 +0200
committerNicolas Lœuillet <nicolas@loeuillet.org>2016-04-27 07:19:31 +0200
commit4c295cb928e2d2343e0879981c7567897e474dd0 (patch)
tree61582f398ce894da69276b79ac6cbe7cde218456 /docs
parentedf3e88d88a00ee558983095618726c4af97895b (diff)
parent87b8461ed8a0cb8a5ba53317759325271a57a4c5 (diff)
downloadwallabag-4c295cb928e2d2343e0879981c7567897e474dd0.tar.gz
wallabag-4c295cb928e2d2343e0879981c7567897e474dd0.tar.zst
wallabag-4c295cb928e2d2343e0879981c7567897e474dd0.zip
Merge pull request #1985 from foxmask/master
Rights access to the folders of the project
Diffstat (limited to 'docs')
-rw-r--r--docs/en/user/installation.rst27
-rw-r--r--docs/fr/user/installation.rst28
2 files changed, 55 insertions, 0 deletions
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index 8250d2d7..c2174a53 100644
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -154,3 +154,30 @@ After reloading or restarting nginx, you should now be able to access wallabag a
154.. note:: 154.. note::
155 155
156 When you want to import large file into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``. 156 When you want to import large file into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``.
157
158
159Rights access to the folders of the project
160-------------------------------------------
161
162
163Test Environment
164~~~~~~~~~~~~~~~~
165
166When we just want to test wallabag, we just run the command ``php bin/console server:run --env=prod`` to start our wallabag instance and everything will go smoothly because the user who started the project can access to the current folder naturally, without any problem.
167
168
169Production Environment
170~~~~~~~~~~~~~~~~~~~~~~
171
172As soon as we use Apache or Nginx to access to our wallabag instance, and not from the command ``php bin/console server:run --env=prod`` to start it, we should take care to grant the good rights on the good folders to keep safe all the folders of the project.
173
174To do so, the folder name, known as ``DocumentRoot`` (for apache) or ``root`` (for Nginx), has to be absolutely accessible by the Apache/Nginx user. Its name is generally ``www-data``, ``apache`` or ``nobody`` (depending on linux system used).
175
176So the folder ``/var/www/wallabag/web`` has to be accessible by this last one. But this could be not enough if we just care about this folder, because we could meet a blank page or get an error 500 when trying to access to the homepage of the project.
177
178This is due to the fact that we will need to grant the same rights access on the folder ``/var/www/wallabag/var`` like those we gave on the folder ``/var/www/wallabag/web``. Thus, we fix this problem with the following command:
179
180.. code-block:: bash
181
182 chown -R www-data:www-data /var/www/wallabag/var
183
diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst
index 8282c474..33a2cf5c 100644
--- a/docs/fr/user/installation.rst
+++ b/docs/fr/user/installation.rst
@@ -148,6 +148,34 @@ En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallab
148 148
149Après que vous ayez rechargé/redémarré Nginx, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld. 149Après que vous ayez rechargé/redémarré Nginx, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
150 150
151
151.. note:: 152.. note::
152 153
153 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``. 154 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``.
155
156
157Droits d'accès aux dossiers du projet
158-------------------------------------
159
160
161Environnement de test
162~~~~~~~~~~~~~~~~~~~~~
163
164Quand 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.
165
166
167Environnement de production
168~~~~~~~~~~~~~~~~~~~~~~~~~~~
169
170Dè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.
171
172Aussi, 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).
173
174Donc 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.
175
176Cela 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 :
177
178.. code-block:: bash
179
180 chown -R www-data:www-data /var/www/wallabag/var
181