aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorNicolas Lœuillet <nicolas@loeuillet.org>2016-05-03 15:50:13 +0200
committerNicolas Lœuillet <nicolas@loeuillet.org>2016-05-03 15:50:13 +0200
commitbba9907d1ffe993da3bc9b7e6c87169953a11160 (patch)
tree07bdb64837956dd13f20fa0cf9f8cbaca1924cba /docs
parent97c8eb3c2398d0aaf06155de5e0828e4020cb5d4 (diff)
downloadwallabag-bba9907d1ffe993da3bc9b7e6c87169953a11160.tar.gz
wallabag-bba9907d1ffe993da3bc9b7e6c87169953a11160.tar.zst
wallabag-bba9907d1ffe993da3bc9b7e6c87169953a11160.zip
Update documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/README.rst0
-rw-r--r--docs/en/index.rst4
-rw-r--r--docs/en/user/installation.rst63
-rw-r--r--docs/en/user/upgrade.rst12
-rw-r--r--docs/fr/index.rst3
-rw-r--r--docs/fr/user/installation.rst56
-rw-r--r--docs/fr/user/upgrade.rst32
7 files changed, 138 insertions, 32 deletions
diff --git a/docs/README.rst b/docs/README.rst
deleted file mode 100644
index e69de29b..00000000
--- a/docs/README.rst
+++ /dev/null
diff --git a/docs/en/index.rst b/docs/en/index.rst
index 590c234a..cd0948c2 100644
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -8,7 +8,7 @@ wallabag documentation
8**wallabag** is a read-it-later application: it saves a web page by 8**wallabag** is a read-it-later application: it saves a web page by
9keeping content only. Elements like navigation or ads are deleted. 9keeping content only. Elements like navigation or ads are deleted.
10 10
11.. note:: 11.. tip::
12 12
13 This documentation is about wallabag v2. If you want to read documentation for wallabag v1, `please have a look here <https://github.com/wallabag/documentation>`__. 13 This documentation is about wallabag v2. If you want to read documentation for wallabag v1, `please have a look here <https://github.com/wallabag/documentation>`__.
14 14
@@ -25,8 +25,8 @@ The main documentation for this application is organized into a couple sections:
25 25
26 user/faq 26 user/faq
27 user/installation 27 user/installation
28 user/migration
29 user/upgrade 28 user/upgrade
29 user/migration
30 user/create_account 30 user/create_account
31 user/login 31 user/login
32 user/configuration 32 user/configuration
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index c2174a53..3057373c 100644
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -34,6 +34,9 @@ and it's corresponding database server.
34Installation 34Installation
35------------ 35------------
36 36
37On a dedicated web server (recommended way)
38~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
39
37wallabag uses a big number of libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you don't already have. 40wallabag uses a big number of libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you don't already have.
38 41
39Install Composer: 42Install Composer:
@@ -54,7 +57,7 @@ To install wallabag itself, you must run these two commands:
54 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist 57 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
55 php bin/console wallabag:install --env=prod 58 php bin/console wallabag:install --env=prod
56 59
57To start php's build-in server and test if everything did install correctly, you can do: 60To start PHP's build-in server and test if everything did install correctly, you can do:
58 61
59:: 62::
60 63
@@ -62,14 +65,48 @@ To start php's build-in server and test if everything did install correctly, you
62 65
63And access wallabag at http://yourserverip:8000 66And access wallabag at http://yourserverip:8000
64 67
65.. note:: 68.. tip::
66 69
67 To define parameters with environment variables, you have to set these variables with ``SYMFONY__`` prefix. For example, ``SYMFONY__DATABASE_DRIVER``. You can have a look to the `Symfony documentation <http://symfony.com/doc/current/cookbook/configuration/external_parameters.html>`__. 70 To define parameters with environment variables, you have to set these variables with ``SYMFONY__`` prefix. For example, ``SYMFONY__DATABASE_DRIVER``. You can have a look to the `Symfony documentation <http://symfony.com/doc/current/cookbook/configuration/external_parameters.html>`__.
68 71
69Installing on Apache 72On a shared hosting
70-------------------- 73~~~~~~~~~~~~~~~~~~~
74
75We provide you a package with all dependancies inside.
76The default configuration uses SQLite for the database. If you want to change these settings, please edit ``app/config/parameters.yml``.
77
78We already created a user: login and password are ``wallabag``.
79
80.. caution:: With this package, wallabag don't check mandatory extensions used in the application (theses checks are made during ``composer install`` when you have a dedicated web server, see above).
81
82Execute this command to download and extract the latest package:
83
84.. code-block:: bash
85
86 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
87
88Now, read the following documentation to create your virtual host, then access to your wallabag.
89If you changed the database configuration to use MySQL or PostgreSQL, you need to create a user via this command ``php bin/console wallabag:install --env=prod``.
90
91Installation with Docker
92------------------------
93
94We provide you a Docker image to install wallabag easily. Have a look to our repository on `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ to have more information.
71 95
72Assuming you install wallabag in the /var/www/wallabag folder and that you want to use php as an Apache module, here's a vhost for wallabag: 96Command to launch container
97~~~~~~~~~~~~~~~~~~~~~~~~~~~
98
99.. code-block:: bash
100
101 docker pull wallabag/wallabag
102
103Virtual hosts
104-------------
105
106Configuration on Apache
107~~~~~~~~~~~~~~~~~~~~~~~
108
109Assuming you install wallabag in the ``/var/www/wallabag`` folder and that you want to use PHP as an Apache module, here's a vhost for wallabag:
73 110
74:: 111::
75 112
@@ -111,10 +148,10 @@ Assuming you install wallabag in the /var/www/wallabag folder and that you want
111 148
112After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld. 149After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld.
113 150
114Installing on Nginx 151Configuration on Nginx
115------------------- 152~~~~~~~~~~~~~~~~~~~~~~
116 153
117Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe for wallabag : 154Assuming you install wallabag in the ``/var/www/wallabag`` folder, here's the recipe for wallabag :
118 155
119:: 156::
120 157
@@ -151,22 +188,19 @@ Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe
151 188
152After reloading or restarting nginx, you should now be able to access wallabag at http://domain.tld. 189After reloading or restarting nginx, you should now be able to access wallabag at http://domain.tld.
153 190
154.. note:: 191.. tip::
155 192
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``. 193 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 194
158
159Rights access to the folders of the project 195Rights access to the folders of the project
160------------------------------------------- 196-------------------------------------------
161 197
162 198Test environment
163Test Environment
164~~~~~~~~~~~~~~~~ 199~~~~~~~~~~~~~~~~
165 200
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. 201When 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 202
168 203Production environment
169Production Environment
170~~~~~~~~~~~~~~~~~~~~~~ 204~~~~~~~~~~~~~~~~~~~~~~
171 205
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. 206As 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.
@@ -180,4 +214,3 @@ This is due to the fact that we will need to grant the same rights access on the
180.. code-block:: bash 214.. code-block:: bash
181 215
182 chown -R www-data:www-data /var/www/wallabag/var 216 chown -R www-data:www-data /var/www/wallabag/var
183
diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst
index e4735631..7782dc8a 100644
--- a/docs/en/user/upgrade.rst
+++ b/docs/en/user/upgrade.rst
@@ -5,6 +5,7 @@ Upgrade on a dedicated web server
5--------------------------------- 5---------------------------------
6 6
7The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.0.3`` by the last release number): 7The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.0.3`` by the last release number):
8
8:: 9::
9 10
10 git fetch origin 11 git fetch origin
@@ -12,12 +13,19 @@ The last release is published on https://www.wallabag.org/pages/download-wallaba
12 git checkout 2.0.3 13 git checkout 2.0.3
13 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist 14 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
14 php bin/console cache:clear --env=prod 15 php bin/console cache:clear --env=prod
15
16 16
17Upgrade on a shared hosting 17Upgrade on a shared hosting
18--------------------------- 18---------------------------
19 19
20Backup your ``app/config/parameters.yml`` file. Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. 20Backup your ``app/config/parameters.yml`` file.
21
22Download the last release of wallabag:
23
24.. code-block:: bash
25
26 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
27
28Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
21 29
22If you use SQLite, you must also copy your ``data/`` folder inside the new installation. 30If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
23 31
diff --git a/docs/fr/index.rst b/docs/fr/index.rst
index 29237721..b4275a43 100644
--- a/docs/fr/index.rst
+++ b/docs/fr/index.rst
@@ -9,7 +9,7 @@ Documentation de wallabag
9simplement d’archiver une page web en ne conservant que le contenu. Les 9simplement d’archiver une page web en ne conservant que le contenu. Les
10éléments superflus (menu, publicité, etc.) sont supprimés. 10éléments superflus (menu, publicité, etc.) sont supprimés.
11 11
12.. note:: 12.. tip::
13 13
14 Vous vous trouvez sur la documentation de wallabag v2. Si vous voulez lire la documentation de wallabag v1, `vous pouvez jeter un œil ici <https://github.com/wallabag/documentation>`__. 14 Vous vous trouvez sur la documentation de wallabag v2. Si vous voulez lire la documentation de wallabag v1, `vous pouvez jeter un œil ici <https://github.com/wallabag/documentation>`__.
15 15
@@ -26,6 +26,7 @@ La documentation principale de cette application est découpée en plusieurs sec
26 26
27 user/faq 27 user/faq
28 user/installation 28 user/installation
29 user/upgrade
29 user/migration 30 user/migration
30 user/create_account 31 user/create_account
31 user/login 32 user/login
diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst
index 33a2cf5c..4645ef74 100644
--- a/docs/fr/user/installation.rst
+++ b/docs/fr/user/installation.rst
@@ -32,6 +32,9 @@ wallabag utilise PDO afin de se connecter à une base de données, donc vous aur
32Installation 32Installation
33------------ 33------------
34 34
35Sur un serveur dédié (méthode conseillée)
36~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37
35wallabag 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. 38wallabag 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.
36 39
37Installation de Composer : 40Installation de Composer :
@@ -60,13 +63,47 @@ Pour démarrer le serveur interne à php et vérifier que tout s'est installé c
60 63
61Et accéder wallabag à l'adresse http://lipdevotreserveur:8000 64Et accéder wallabag à l'adresse http://lipdevotreserveur:8000
62 65
63.. note:: 66.. tip::
64 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 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.
65 68
66Installation avec Apache 69Sur un serveur mutualisé
70~~~~~~~~~~~~~~~~~~~~~~~~
71
72Nous mettons à votre disposition une archive avec toutes les dépendances à l'intérieur.
73La 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``.
74
75Nous avons déjà créé un utilisateur : le login et le mot de passe sont ``wallabag``.
76
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).
78
79Exécutez cette commande pour télécharger et décompresser l'archive :
80
81.. code-block:: bash
82
83 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
84
85Maintenant, lisez la documentation ci-dessous pour crééer un virtual host. Accédez ensuite à votre installation de wallabag.
86Si 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``.
87
88Installation avec Docker
67------------------------ 89------------------------
68 90
69En 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 : 91Nous 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.
92
93Commande pour démarrer le containeur
94~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
95
96.. code-block:: bash
97
98 docker pull wallabag/wallabag
99
100Virtual hosts
101-------------
102
103Configuration avec Apache
104~~~~~~~~~~~~~~~~~~~~~~~~~
105
106En 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 :
70 107
71:: 108::
72 109
@@ -108,10 +145,10 @@ En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallab
108 145
109Après que vous ayez rechargé/redémarré Apache, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld. 146Après que vous ayez rechargé/redémarré Apache, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
110 147
111Installation avec Nginx 148Configuration avec Nginx
112----------------------- 149~~~~~~~~~~~~~~~~~~~~~~~~
113 150
114En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallabag, voici un fichier de configuration Nginx pour wallabag : 151En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag``, voici un fichier de configuration Nginx pour wallabag :
115 152
116:: 153::
117 154
@@ -148,22 +185,18 @@ En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallab
148 185
149Après que vous ayez rechargé/redémarré Nginx, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld. 186Après que vous ayez rechargé/redémarré Nginx, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
150 187
151 188.. tip::
152.. note::
153 189
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``. 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``.
155 191
156
157Droits d'accès aux dossiers du projet 192Droits d'accès aux dossiers du projet
158------------------------------------- 193-------------------------------------
159 194
160
161Environnement de test 195Environnement de test
162~~~~~~~~~~~~~~~~~~~~~ 196~~~~~~~~~~~~~~~~~~~~~
163 197
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. 198Quand 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 199
166
167Environnement de production 200Environnement de production
168~~~~~~~~~~~~~~~~~~~~~~~~~~~ 201~~~~~~~~~~~~~~~~~~~~~~~~~~~
169 202
@@ -178,4 +211,3 @@ Cela est dû au fait qu'il faut aussi octroyer les mêmes droits d'accès au dos
178.. code-block:: bash 211.. code-block:: bash
179 212
180 chown -R www-data:www-data /var/www/wallabag/var 213 chown -R www-data:www-data /var/www/wallabag/var
181
diff --git a/docs/fr/user/upgrade.rst b/docs/fr/user/upgrade.rst
new file mode 100644
index 00000000..84a1692d
--- /dev/null
+++ b/docs/fr/user/upgrade.rst
@@ -0,0 +1,32 @@
1Mettre à jour wallabag
2======================
3
4Mise à jour sur un serveur dédié
5--------------------------------
6
7La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.0.3`` par le numéro de la dernière version) :
8
9::
10
11 git fetch origin
12 git fetch --tags
13 git checkout 2.0.3
14 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
15 php bin/console cache:clear --env=prod
16
17Mise à jour sur un hébergement mutualisé
18----------------------------------------
19
20Effectuez une sauvegarde du fichier ``app/config/parameters.yml``.
21
22Téléchargez la dernière version de wallabag :
23
24.. code-block:: bash
25
26 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
27
28Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre.
29
30Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``.
31
32Videz le répertoire ``var/cache``.