diff options
author | Jeremy Benoist <j0k3r@users.noreply.github.com> | 2016-05-07 11:10:21 +0200 |
---|---|---|
committer | Jeremy Benoist <j0k3r@users.noreply.github.com> | 2016-05-07 11:10:21 +0200 |
commit | 1556c925a42619c1298edebb73eb86c009b3f3c8 (patch) | |
tree | 2e893a9ed9ab1fb28db290d3643d7945e0ad611b /docs | |
parent | f54de6817ea320e6d92bea368123b2fb1395d95f (diff) | |
parent | e0f4f25fd6fba6f41532e9bf5cb6fa4c515c7a46 (diff) | |
download | wallabag-1556c925a42619c1298edebb73eb86c009b3f3c8.tar.gz wallabag-1556c925a42619c1298edebb73eb86c009b3f3c8.tar.zst wallabag-1556c925a42619c1298edebb73eb86c009b3f3c8.zip |
Merge pull request #2016 from wallabag/update-documentation
Update documentation
Diffstat (limited to 'docs')
-rw-r--r-- | docs/README.rst | 0 | ||||
-rw-r--r-- | docs/en/developer/api.rst | 4 | ||||
-rw-r--r-- | docs/en/developer/documentation.rst | 12 | ||||
-rw-r--r-- | docs/en/index.rst | 7 | ||||
-rw-r--r-- | docs/en/user/create_account.rst | 21 | ||||
-rw-r--r-- | docs/en/user/faq.rst | 25 | ||||
-rw-r--r-- | docs/en/user/import.rst | 43 | ||||
-rw-r--r-- | docs/en/user/installation.rst | 99 | ||||
-rw-r--r-- | docs/en/user/login.rst | 10 | ||||
-rw-r--r-- | docs/en/user/migration.rst | 4 | ||||
-rw-r--r-- | docs/en/user/upgrade.rst | 12 | ||||
-rw-r--r-- | docs/fr/developer/api.rst | 4 | ||||
-rw-r--r-- | docs/fr/developer/documentation.rst | 12 | ||||
-rw-r--r-- | docs/fr/index.rst | 6 | ||||
-rw-r--r-- | docs/fr/user/create_account.rst | 21 | ||||
-rw-r--r-- | docs/fr/user/faq.rst | 25 | ||||
-rw-r--r-- | docs/fr/user/import.rst | 43 | ||||
-rw-r--r-- | docs/fr/user/installation.rst | 94 | ||||
-rw-r--r-- | docs/fr/user/login.rst | 10 | ||||
-rw-r--r-- | docs/fr/user/migration.rst | 4 | ||||
-rw-r--r-- | docs/fr/user/upgrade.rst | 32 |
21 files changed, 307 insertions, 181 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/developer/api.rst b/docs/en/developer/api.rst index 3de8ba05..9594f9af 100644 --- a/docs/en/developer/api.rst +++ b/docs/en/developer/api.rst | |||
@@ -261,6 +261,8 @@ Have a look on the listing here: http://localhost:8000/api/doc to know each meth | |||
261 | Third resources | 261 | Third resources |
262 | --------------- | 262 | --------------- |
263 | 263 | ||
264 | Some applications use our API. Here is a non-exhaustive list of them: | 264 | Some applications or libraries use our API. Here is a non-exhaustive list of them: |
265 | 265 | ||
266 | - `Java wrapper for the wallabag API <https://github.com/Strubbl/wallabag-java>`_ by Strubbl. | ||
267 | - `.NET library for the wallabag v2 API <https://github.com/jlnostr/wallabag-api>`_ by Julian Oster. | ||
266 | - `Python API for wallabag <https://github.com/foxmask/wallabag_api>`_ by FoxMaSk, for his project `Trigger Happy <https://blog.trigger-happy.eu/>`_. | 268 | - `Python API for wallabag <https://github.com/foxmask/wallabag_api>`_ by FoxMaSk, for his project `Trigger Happy <https://blog.trigger-happy.eu/>`_. |
diff --git a/docs/en/developer/documentation.rst b/docs/en/developer/documentation.rst new file mode 100644 index 00000000..ab206479 --- /dev/null +++ b/docs/en/developer/documentation.rst | |||
@@ -0,0 +1,12 @@ | |||
1 | Contribute to this documentation | ||
2 | ================================ | ||
3 | |||
4 | Sources of our documentation are here https://github.com/wallabag/wallabag/tree/master/docs | ||
5 | |||
6 | We use `ReadTheDocs | ||
7 | <https://readthedocs.org>`__ to generate it. | ||
8 | |||
9 | Pages are written in `Restructured Text | ||
10 | <https://en.wikipedia.org/wiki/ReStructuredText>`__ format. You can use online tools like http://rst.aaroniles.net/ or http://rst.ninjs.org/ to preview your articles. | ||
11 | |||
12 | If you create a new page, don't forget to edit the `index.rst <https://raw.githubusercontent.com/wallabag/wallabag/master/docs/en/index.rst>`__ file to add a link in the sidebar. \ No newline at end of file | ||
diff --git a/docs/en/index.rst b/docs/en/index.rst index f4b8628a..03025ef9 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 |
9 | keeping content only. Elements like navigation or ads are deleted. | 9 | keeping 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,15 +25,15 @@ 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/import | ||
30 | user/create_account | 31 | user/create_account |
31 | user/login | 32 | user/login |
32 | user/configuration | 33 | user/configuration |
33 | user/first_article | 34 | user/first_article |
34 | user/errors_during_fetching | 35 | user/errors_during_fetching |
35 | user/annotations | 36 | user/annotations |
36 | user/import | ||
37 | user/download_articles | 37 | user/download_articles |
38 | user/filters | 38 | user/filters |
39 | user/tags | 39 | user/tags |
@@ -47,5 +47,6 @@ The main documentation for this application is organized into a couple sections: | |||
47 | 47 | ||
48 | developer/api | 48 | developer/api |
49 | developer/docker | 49 | developer/docker |
50 | developer/documentation | ||
50 | developer/translate | 51 | developer/translate |
51 | developer/maintenance | 52 | developer/maintenance |
diff --git a/docs/en/user/create_account.rst b/docs/en/user/create_account.rst index f0110e55..2e883c88 100644 --- a/docs/en/user/create_account.rst +++ b/docs/en/user/create_account.rst | |||
@@ -23,24 +23,3 @@ Your account is now activated. | |||
23 | .. image:: ../../img/user/activated_account.png | 23 | .. image:: ../../img/user/activated_account.png |
24 | :alt: Welcome on board! | 24 | :alt: Welcome on board! |
25 | :align: center | 25 | :align: center |
26 | |||
27 | Frequently asked questions | ||
28 | -------------------------- | ||
29 | |||
30 | I can't valid the registration form | ||
31 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
32 | |||
33 | Make sure that all fields are well filled: | ||
34 | |||
35 | * valid email address | ||
36 | * same passwords in two fields | ||
37 | |||
38 | I don't receive my activation email | ||
39 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
40 | |||
41 | Are you sure your email address was correct? Did you check your spams folder? | ||
42 | |||
43 | When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``. | ||
44 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
45 | |||
46 | You already enabled your account or the URL of the activation email is wrong. | ||
diff --git a/docs/en/user/faq.rst b/docs/en/user/faq.rst index 04fb25e3..1e36dc26 100644 --- a/docs/en/user/faq.rst +++ b/docs/en/user/faq.rst | |||
@@ -8,3 +8,28 @@ It seems you have a problem with your ``composer`` installation. Try to uninstal | |||
8 | 8 | ||
9 | `Read the documentation about composer to know how to install it | 9 | `Read the documentation about composer to know how to install it |
10 | <https://getcomposer.org/doc/00-intro.md>`__. | 10 | <https://getcomposer.org/doc/00-intro.md>`__. |
11 | |||
12 | I can't valid the registration form | ||
13 | ----------------------------------- | ||
14 | |||
15 | Make sure that all fields are well filled: | ||
16 | |||
17 | * valid email address | ||
18 | * same passwords in two fields | ||
19 | |||
20 | I don't receive my activation email | ||
21 | ----------------------------------- | ||
22 | |||
23 | Are you sure your email address was correct? Did you check your spams folder? | ||
24 | |||
25 | When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``. | ||
26 | ---------------------------------------------------------------------------------------------------------------------------------- | ||
27 | |||
28 | You already enabled your account or the URL of the activation email is wrong. | ||
29 | |||
30 | I forgot my password | ||
31 | -------------------- | ||
32 | |||
33 | You can reset your password by clicking on ``Forgot your password?`` link, | ||
34 | on the login page. Then, fill the form with your email address or your username, | ||
35 | you'll receive an email to reset your password. | ||
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst index d6054d39..63210484 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst | |||
@@ -1,42 +1,5 @@ | |||
1 | Migrate to wallabag | 1 | Migrate from a third service |
2 | =================== | 2 | ============================ |
3 | |||
4 | From wallabag | ||
5 | ------------- | ||
6 | |||
7 | Export your data from your wallabag 1.x | ||
8 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
9 | |||
10 | On your config page, click on ``JSON export`` in the ``Export your wallabag data`` section. | ||
11 | |||
12 | .. image:: ../../img/user/export_wllbg_1.png | ||
13 | :alt: Export from wallabag 1.x | ||
14 | :align: center | ||
15 | |||
16 | You will have a ``wallabag-export-1-1970-01-01.json`` file. | ||
17 | |||
18 | Export your data from your wallabag 2.x | ||
19 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
20 | |||
21 | On the export sidebar, click on ``JSON``. | ||
22 | |||
23 | .. image:: ../../img/user/export_wllbg_2.png | ||
24 | :alt: Export from wallabag 2.x | ||
25 | :align: center | ||
26 | |||
27 | You will have a ``Unread articles.json`` file. | ||
28 | |||
29 | Import your data into wallabag 2.x | ||
30 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
31 | |||
32 | Click on ``Import`` link in the menu, choose the right wallabag version, | ||
33 | select your export file on your computer and import it. | ||
34 | |||
35 | .. image:: ../../img/user/import_wllbg.png | ||
36 | :alt: Import from wallabag 1.x | ||
37 | :align: center | ||
38 | |||
39 | All your wallabag articles will be imported. | ||
40 | 3 | ||
41 | From Pocket | 4 | From Pocket |
42 | ----------- | 5 | ----------- |
@@ -53,7 +16,7 @@ a new application on their developer website to continue. | |||
53 | and submit your new application | 16 | and submit your new application |
54 | 17 | ||
55 | Pocket will give you a **Consumer Key** (for example, `49961-985e4b92fe21fe4c78d682c1`). | 18 | Pocket will give you a **Consumer Key** (for example, `49961-985e4b92fe21fe4c78d682c1`). |
56 | You need to configure the ``pocket_consumer_key`` into the ``app/config/parameters.yml`` file in wallabag. | 19 | You need to configure the ``pocket_consumer_key`` into the ``Import`` section in the ``Internal settings`` menu. |
57 | 20 | ||
58 | Now, all is fine to migrate from Pocket. | 21 | Now, all is fine to migrate from Pocket. |
59 | 22 | ||
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index c2174a53..d22f8549 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst | |||
@@ -34,6 +34,9 @@ and it's corresponding database server. | |||
34 | Installation | 34 | Installation |
35 | ------------ | 35 | ------------ |
36 | 36 | ||
37 | On a dedicated web server (recommended way) | ||
38 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
39 | |||
37 | wallabag 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. | 40 | wallabag 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 | ||
39 | Install Composer: | 42 | Install 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 | ||
57 | To start php's build-in server and test if everything did install correctly, you can do: | 60 | To 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 | ||
63 | And access wallabag at http://yourserverip:8000 | 66 | And 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 | ||
69 | Installing on Apache | 72 | On a shared hosting |
70 | -------------------- | 73 | ~~~~~~~~~~~~~~~~~~~ |
74 | |||
75 | We provide you a package with all dependancies inside. | ||
76 | The default configuration uses SQLite for the database. If you want to change these settings, please edit ``app/config/parameters.yml``. | ||
77 | |||
78 | We 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 | |||
82 | Execute this command to download and extract the latest package: | ||
83 | |||
84 | .. code-block:: bash | ||
71 | 85 | ||
72 | Assuming 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: | 86 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package |
87 | |||
88 | Now, read the following documentation to create your virtual host, then access to your wallabag. | ||
89 | If 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 | |||
91 | Installation with Docker | ||
92 | ------------------------ | ||
93 | |||
94 | We 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. | ||
95 | |||
96 | Command to launch container | ||
97 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
98 | |||
99 | .. code-block:: bash | ||
100 | |||
101 | docker pull wallabag/wallabag | ||
102 | |||
103 | Virtual hosts | ||
104 | ------------- | ||
105 | |||
106 | Configuration on Apache | ||
107 | ~~~~~~~~~~~~~~~~~~~~~~~ | ||
108 | |||
109 | Assuming 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 | ||
112 | After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld. | 149 | After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld. |
113 | 150 | ||
114 | Installing on Nginx | 151 | Configuration on Nginx |
115 | ------------------- | 152 | ~~~~~~~~~~~~~~~~~~~~~~ |
116 | 153 | ||
117 | Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe for wallabag : | 154 | Assuming you install wallabag in the ``/var/www/wallabag`` folder, here's the recipe for wallabag : |
118 | 155 | ||
119 | :: | 156 | :: |
120 | 157 | ||
@@ -151,22 +188,57 @@ Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe | |||
151 | 188 | ||
152 | After reloading or restarting nginx, you should now be able to access wallabag at http://domain.tld. | 189 | After 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 | ||
195 | Configuration on lighttpd | ||
196 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
197 | |||
198 | Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe for wallabag (edit your ``lighttpd.conf`` file and paste this configuration into it): | ||
199 | |||
200 | :: | ||
201 | |||
202 | server.modules = ( | ||
203 | "mod_fastcgi", | ||
204 | "mod_access", | ||
205 | "mod_alias", | ||
206 | "mod_compress", | ||
207 | "mod_redirect", | ||
208 | "mod_rewrite", | ||
209 | ) | ||
210 | server.document-root = "/var/www/wallabag/web" | ||
211 | server.upload-dirs = ( "/var/cache/lighttpd/uploads" ) | ||
212 | server.errorlog = "/var/log/lighttpd/error.log" | ||
213 | server.pid-file = "/var/run/lighttpd.pid" | ||
214 | server.username = "www-data" | ||
215 | server.groupname = "www-data" | ||
216 | server.port = 80 | ||
217 | server.follow-symlink = "enable" | ||
218 | index-file.names = ( "index.php", "index.html", "index.lighttpd.html") | ||
219 | url.access-deny = ( "~", ".inc" ) | ||
220 | static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" ) | ||
221 | compress.cache-dir = "/var/cache/lighttpd/compress/" | ||
222 | compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" ) | ||
223 | include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port | ||
224 | include_shell "/usr/share/lighttpd/create-mime.assign.pl" | ||
225 | include_shell "/usr/share/lighttpd/include-conf-enabled.pl" | ||
226 | dir-listing.activate = "disable" | ||
227 | |||
228 | url.rewrite-if-not-file = ( | ||
229 | "^/([^?])(?:\?(.))?" => "/app.php?$1&$2", | ||
230 | "^/([^?]*)" => "/app.php?=$1", | ||
231 | ) | ||
158 | 232 | ||
159 | Rights access to the folders of the project | 233 | Rights access to the folders of the project |
160 | ------------------------------------------- | 234 | ------------------------------------------- |
161 | 235 | ||
162 | 236 | Test environment | |
163 | Test Environment | ||
164 | ~~~~~~~~~~~~~~~~ | 237 | ~~~~~~~~~~~~~~~~ |
165 | 238 | ||
166 | When 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. | 239 | When 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 | 240 | ||
168 | 241 | Production environment | |
169 | Production Environment | ||
170 | ~~~~~~~~~~~~~~~~~~~~~~ | 242 | ~~~~~~~~~~~~~~~~~~~~~~ |
171 | 243 | ||
172 | As 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. | 244 | As 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 +252,3 @@ This is due to the fact that we will need to grant the same rights access on the | |||
180 | .. code-block:: bash | 252 | .. code-block:: bash |
181 | 253 | ||
182 | chown -R www-data:www-data /var/www/wallabag/var | 254 | chown -R www-data:www-data /var/www/wallabag/var |
183 | |||
diff --git a/docs/en/user/login.rst b/docs/en/user/login.rst index 1813f3d8..e66089bd 100644 --- a/docs/en/user/login.rst +++ b/docs/en/user/login.rst | |||
@@ -11,13 +11,3 @@ you can check the ``Keep me logged in`` checkbox: wallabag will remember you for | |||
11 | .. image:: ../../img/user/login_form.png | 11 | .. image:: ../../img/user/login_form.png |
12 | :alt: Login form | 12 | :alt: Login form |
13 | :align: center | 13 | :align: center |
14 | |||
15 | Frequently asked questions | ||
16 | -------------------------- | ||
17 | |||
18 | I forgot my password | ||
19 | ~~~~~~~~~~~~~~~~~~~~ | ||
20 | |||
21 | You can reset your password by clicking on ``Forgot your password?`` link, | ||
22 | on the login page. Then, fill the form with your email address or your username, | ||
23 | you'll receive an email to reset your password. | ||
diff --git a/docs/en/user/migration.rst b/docs/en/user/migration.rst index e97c6315..e141ae40 100644 --- a/docs/en/user/migration.rst +++ b/docs/en/user/migration.rst | |||
@@ -1,5 +1,5 @@ | |||
1 | Migrate wallabag | 1 | Migrate from v1 or v2 |
2 | ================ | 2 | ===================== |
3 | 3 | ||
4 | From wallabag 1.x | 4 | From wallabag 1.x |
5 | ----------------- | 5 | ----------------- |
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 | ||
7 | The 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): | 7 | The 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 | ||
17 | Upgrade on a shared hosting | 17 | Upgrade on a shared hosting |
18 | --------------------------- | 18 | --------------------------- |
19 | 19 | ||
20 | Backup your ``app/config/parameters.yml`` file. Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. | 20 | Backup your ``app/config/parameters.yml`` file. |
21 | |||
22 | Download 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 | |||
28 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. | ||
21 | 29 | ||
22 | If you use SQLite, you must also copy your ``data/`` folder inside the new installation. | 30 | If you use SQLite, you must also copy your ``data/`` folder inside the new installation. |
23 | 31 | ||
diff --git a/docs/fr/developer/api.rst b/docs/fr/developer/api.rst index 458df4a9..af38d3ec 100644 --- a/docs/fr/developer/api.rst +++ b/docs/fr/developer/api.rst | |||
@@ -261,6 +261,8 @@ Jetez un œil à la liste complète ici http://localhost:8000/api/doc pour conna | |||
261 | Ressources tierces | 261 | Ressources tierces |
262 | ------------------ | 262 | ------------------ |
263 | 263 | ||
264 | Certaines applications utilisent notre API. En voici une liste non exhaustive : | 264 | Certaines applications ou bibliothèques utilisent notre API. En voici une liste non exhaustive : |
265 | 265 | ||
266 | - `Java wrapper for the wallabag API <https://github.com/Strubbl/wallabag-java>`_ par Strubbl. | ||
267 | - `.NET library for the wallabag v2 API <https://github.com/jlnostr/wallabag-api>`_ par Julian Oster. | ||
266 | - `Python API for wallabag <https://github.com/foxmask/wallabag_api>`_ par FoxMaSk, pour son projet `Trigger Happy <https://blog.trigger-happy.eu/>`_. | 268 | - `Python API for wallabag <https://github.com/foxmask/wallabag_api>`_ par FoxMaSk, pour son projet `Trigger Happy <https://blog.trigger-happy.eu/>`_. |
diff --git a/docs/fr/developer/documentation.rst b/docs/fr/developer/documentation.rst new file mode 100644 index 00000000..0fbe5626 --- /dev/null +++ b/docs/fr/developer/documentation.rst | |||
@@ -0,0 +1,12 @@ | |||
1 | Contribuer à cette documentation | ||
2 | ================================ | ||
3 | |||
4 | Les sources de notre documentation sont ici https://github.com/wallabag/wallabag/tree/master/docs | ||
5 | |||
6 | Nous utilisons `ReadTheDocs | ||
7 | <https://readthedocs.org>`__ pour la générer. | ||
8 | |||
9 | Les pages sont écrites au format `Restructured Text | ||
10 | <https://fr.wikipedia.org/wiki/ReStructuredText>`__. Vous pouvez utiliser des outils en ligne comme http://rst.aaroniles.net/ ou http://rst.ninjs.org/ pour prévisualiser vos articles. | ||
11 | |||
12 | Si vous créez une nouvelle page, n'oubliez pas d'éditer le fichier `index.rst <https://raw.githubusercontent.com/wallabag/wallabag/master/docs/en/index.rst>`__ pour ajouter un lien dans la barre latérale. \ No newline at end of file | ||
diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 29237721..1e72dae7 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst | |||
@@ -9,7 +9,7 @@ Documentation de wallabag | |||
9 | simplement d’archiver une page web en ne conservant que le contenu. Les | 9 | simplement 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,14 +26,15 @@ 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 |
31 | user/import | ||
30 | user/create_account | 32 | user/create_account |
31 | user/login | 33 | user/login |
32 | user/configuration | 34 | user/configuration |
33 | user/first_article | 35 | user/first_article |
34 | user/errors_during_fetching | 36 | user/errors_during_fetching |
35 | user/annotations | 37 | user/annotations |
36 | user/import | ||
37 | user/download_articles | 38 | user/download_articles |
38 | user/filters | 39 | user/filters |
39 | user/tags | 40 | user/tags |
@@ -46,5 +47,6 @@ La documentation principale de cette application est découpée en plusieurs sec | |||
46 | 47 | ||
47 | developer/api | 48 | developer/api |
48 | developer/docker | 49 | developer/docker |
50 | developer/documentation | ||
49 | developer/translate | 51 | developer/translate |
50 | developer/maintenance | 52 | developer/maintenance |
diff --git a/docs/fr/user/create_account.rst b/docs/fr/user/create_account.rst index 7f29b0f0..6e188ab3 100644 --- a/docs/fr/user/create_account.rst +++ b/docs/fr/user/create_account.rst | |||
@@ -23,24 +23,3 @@ Votre compte est maintenant actif. | |||
23 | .. image:: ../../img/user/activated_account.png | 23 | .. image:: ../../img/user/activated_account.png |
24 | :alt: Bienvenue à bord ! | 24 | :alt: Bienvenue à bord ! |
25 | :align: center | 25 | :align: center |
26 | |||
27 | Foire aux questions | ||
28 | ------------------- | ||
29 | |||
30 | Je ne peux pas valider le formulaire de création de compte | ||
31 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
32 | |||
33 | Soyez sur d'avoir bien renseigné tous les champs : | ||
34 | |||
35 | * une adresse email valide | ||
36 | * le même mot de passe dans les deux champs | ||
37 | |||
38 | Je n'ai pas reçu mon email d'activation | ||
39 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
40 | |||
41 | Êtes-vous sur d'avoir renseigné votre bonne adresse ? Avez-vous vérifié le dossier de spams ? | ||
42 | |||
43 | Quand je clique sur le lien d'activation, j'ai ce message : ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``. | ||
44 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
45 | |||
46 | Vous avez déjà activé votre compte ou l'URL d'activation n'est pas correcte. | ||
diff --git a/docs/fr/user/faq.rst b/docs/fr/user/faq.rst index f5ae2776..e220c8a7 100644 --- a/docs/fr/user/faq.rst +++ b/docs/fr/user/faq.rst | |||
@@ -8,3 +8,28 @@ Il semblerait que vous ayiez un problème avec votre installation de ``composer` | |||
8 | 8 | ||
9 | `Vous pouvez lire la documentation de composer pour savoir comment l'installer | 9 | `Vous pouvez lire la documentation de composer pour savoir comment l'installer |
10 | <https://getcomposer.org/doc/00-intro.md>`__. | 10 | <https://getcomposer.org/doc/00-intro.md>`__. |
11 | |||
12 | Je ne peux pas valider le formulaire de création de compte | ||
13 | ---------------------------------------------------------- | ||
14 | |||
15 | Soyez sur d'avoir bien renseigné tous les champs : | ||
16 | |||
17 | * une adresse email valide | ||
18 | * le même mot de passe dans les deux champs | ||
19 | |||
20 | Je n'ai pas reçu mon email d'activation | ||
21 | --------------------------------------- | ||
22 | |||
23 | Êtes-vous sur d'avoir renseigné votre bonne adresse ? Avez-vous vérifié le dossier de spams ? | ||
24 | |||
25 | Quand je clique sur le lien d'activation, j'ai ce message : ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``. | ||
26 | ---------------------------------------------------------------------------------------------------------------------------------- | ||
27 | |||
28 | Vous avez déjà activé votre compte ou l'URL d'activation n'est pas correcte. | ||
29 | |||
30 | J'ai oublié mon mot de passe | ||
31 | ---------------------------- | ||
32 | |||
33 | Vous pouvez réinitialiser votre mot de passe en cliquant sur ``Mot de passe oublié ?``, | ||
34 | sur la page de connexion. Ensuite, renseignez votre adresse email ou votre nom d'utilisateur, | ||
35 | un email vous sera envoyé. | ||
diff --git a/docs/fr/user/import.rst b/docs/fr/user/import.rst index 967df1f6..e6c2fa02 100644 --- a/docs/fr/user/import.rst +++ b/docs/fr/user/import.rst | |||
@@ -1,42 +1,5 @@ | |||
1 | Migrer à wallabag | 1 | Migrer depuis un service externe |
2 | ================= | 2 | ================================ |
3 | |||
4 | Depuis wallabag | ||
5 | --------------- | ||
6 | |||
7 | Exportez vos données de wallabag 1.x | ||
8 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
9 | |||
10 | Sur la page de configuration, cliquez sur ``Export JSON`` dans la section ``Exportez vos données wallabag``. | ||
11 | |||
12 | .. image:: ../../img/user/export_wllbg_1.png | ||
13 | :alt: Export depuis wallabag 1.x | ||
14 | :align: center | ||
15 | |||
16 | Vous obtiendrez un fichier ``wallabag-export-1-1970-01-01.json``. | ||
17 | |||
18 | Exportez vos données de wallabag 2.x | ||
19 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
20 | |||
21 | Dans la barre latérale de téléchargement, cliquez sur ``JSON``. | ||
22 | |||
23 | .. image:: ../../img/user/export_wllbg_2.png | ||
24 | :alt: Export depuis wallabag 2.x | ||
25 | :align: center | ||
26 | |||
27 | Vous obtiendrez un fichier ``Unread articles.json``. | ||
28 | |||
29 | Importez vos données wallabag 2.x | ||
30 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
31 | |||
32 | Cliquez sur le lien ``Importer`` dans le menu, choisissez la version de wallabag correspondante, | ||
33 | sélectionnez votre fichier d'export sur votre ordinateur et importez-le. | ||
34 | |||
35 | .. image:: ../../img/user/import_wllbg.png | ||
36 | :alt: Import depuis wallabag 1.x | ||
37 | :align: center | ||
38 | |||
39 | Tous vos articles wallabag seront importés. | ||
40 | 3 | ||
41 | Depuis Pocket | 4 | Depuis Pocket |
42 | ------------- | 5 | ------------- |
@@ -53,7 +16,7 @@ Vous devez créer une nouvelle application sur leur site dédié aux développeu | |||
53 | termes d'utilisation du service et soumettez votre application | 16 | termes d'utilisation du service et soumettez votre application |
54 | 17 | ||
55 | Pocket vous fournira une **Consumer Key** (par exemple, `49961-985e4b92fe21fe4c78d682c1`). | 18 | Pocket vous fournira une **Consumer Key** (par exemple, `49961-985e4b92fe21fe4c78d682c1`). |
56 | Vous devez configurer la ``pocket_consumer_key`` dans le fichier ``app/config/parameters.yml``. | 19 | Vous devez configurer la ``pocket_consumer_key`` dans la section ``Import`` du menu ``Configuration interne``. |
57 | 20 | ||
58 | Maintenant, tout est bien configuré pour migrer depuis Pocket. | 21 | Maintenant, tout est bien configuré pour migrer depuis Pocket. |
59 | 22 | ||
diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index 33a2cf5c..8f2ae25d 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 | |||
32 | Installation | 32 | Installation |
33 | ------------ | 33 | ------------ |
34 | 34 | ||
35 | Sur un serveur dédié (méthode conseillée) | ||
36 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
37 | |||
35 | 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. | 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. |
36 | 39 | ||
37 | Installation de Composer : | 40 | Installation de Composer : |
@@ -60,13 +63,47 @@ Pour démarrer le serveur interne à php et vérifier que tout s'est installé c | |||
60 | 63 | ||
61 | Et accéder wallabag à l'adresse http://lipdevotreserveur:8000 | 64 | Et 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 | ||
66 | Installation avec Apache | 69 | Sur un serveur mutualisé |
70 | ~~~~~~~~~~~~~~~~~~~~~~~~ | ||
71 | |||
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``. | ||
74 | |||
75 | Nous 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 | |||
79 | Exé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 | |||
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``. | ||
87 | |||
88 | Installation avec Docker | ||
67 | ------------------------ | 89 | ------------------------ |
68 | 90 | ||
69 | 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 : | 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. |
92 | |||
93 | Commande pour démarrer le containeur | ||
94 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
95 | |||
96 | .. code-block:: bash | ||
97 | |||
98 | docker pull wallabag/wallabag | ||
99 | |||
100 | Virtual hosts | ||
101 | ------------- | ||
102 | |||
103 | Configuration avec Apache | ||
104 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
105 | |||
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 : | ||
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 | ||
109 | Après que vous ayez rechargé/redémarré Apache, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld. | 146 | Après que vous ayez rechargé/redémarré Apache, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld. |
110 | 147 | ||
111 | Installation avec Nginx | 148 | Configuration avec Nginx |
112 | ----------------------- | 149 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
113 | 150 | ||
114 | En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallabag, voici un fichier de configuration Nginx pour wallabag : | 151 | En 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,23 +185,57 @@ En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallab | |||
148 | 185 | ||
149 | Après que vous ayez rechargé/redémarré Nginx, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld. | 186 | Aprè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 | ||
192 | Configuration avec lighttpd | ||
193 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
194 | |||
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) : | ||
196 | |||
197 | :: | ||
198 | |||
199 | server.modules = ( | ||
200 | "mod_fastcgi", | ||
201 | "mod_access", | ||
202 | "mod_alias", | ||
203 | "mod_compress", | ||
204 | "mod_redirect", | ||
205 | "mod_rewrite", | ||
206 | ) | ||
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" | ||
213 | server.port = 80 | ||
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" | ||
224 | |||
225 | url.rewrite-if-not-file = ( | ||
226 | "^/([^?])(?:\?(.))?" => "/app.php?$1&$2", | ||
227 | "^/([^?]*)" => "/app.php?=$1", | ||
228 | ) | ||
156 | 229 | ||
157 | Droits d'accès aux dossiers du projet | 230 | Droits d'accès aux dossiers du projet |
158 | ------------------------------------- | 231 | ------------------------------------- |
159 | 232 | ||
160 | |||
161 | Environnement de test | 233 | Environnement de test |
162 | ~~~~~~~~~~~~~~~~~~~~~ | 234 | ~~~~~~~~~~~~~~~~~~~~~ |
163 | 235 | ||
164 | 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. | 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. |
165 | 237 | ||
166 | 238 | Environnement de production | |
167 | Environnement de production | ||
168 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 239 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
169 | 240 | ||
170 | 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. | 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. |
@@ -178,4 +249,3 @@ Cela est dû au fait qu'il faut aussi octroyer les mêmes droits d'accès au dos | |||
178 | .. code-block:: bash | 249 | .. code-block:: bash |
179 | 250 | ||
180 | chown -R www-data:www-data /var/www/wallabag/var | 251 | chown -R www-data:www-data /var/www/wallabag/var |
181 | |||
diff --git a/docs/fr/user/login.rst b/docs/fr/user/login.rst index 3a02d1d5..522ac259 100644 --- a/docs/fr/user/login.rst +++ b/docs/fr/user/login.rst | |||
@@ -11,13 +11,3 @@ vous pouvez cocher la case ``Restez connecté`` : wallabag se souviendra de vous | |||
11 | .. image:: ../../img/user/login_form.png | 11 | .. image:: ../../img/user/login_form.png |
12 | :alt: Formulaire de connexion | 12 | :alt: Formulaire de connexion |
13 | :align: center | 13 | :align: center |
14 | |||
15 | Foire aux questions | ||
16 | ------------------- | ||
17 | |||
18 | J'ai oublié mon mot de passe | ||
19 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
20 | |||
21 | Vous pouvez réinitialiser votre mot de passe en cliquant sur ``Mot de passe oublié ?``, | ||
22 | sur la page de connexion. Ensuite, renseignez votre adresse email ou votre nom d'utilisateur, | ||
23 | un email vous sera envoyé. | ||
diff --git a/docs/fr/user/migration.rst b/docs/fr/user/migration.rst index 012c4988..66024572 100644 --- a/docs/fr/user/migration.rst +++ b/docs/fr/user/migration.rst | |||
@@ -1,5 +1,5 @@ | |||
1 | Migrer wallabag | 1 | Migrer depuis la v1 ou la v2 |
2 | =============== | 2 | ============================ |
3 | 3 | ||
4 | Depuis wallabag 1.x | 4 | Depuis wallabag 1.x |
5 | ------------------- | 5 | ------------------- |
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 @@ | |||
1 | Mettre à jour wallabag | ||
2 | ====================== | ||
3 | |||
4 | Mise à jour sur un serveur dédié | ||
5 | -------------------------------- | ||
6 | |||
7 | La 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 | |||
17 | Mise à jour sur un hébergement mutualisé | ||
18 | ---------------------------------------- | ||
19 | |||
20 | Effectuez une sauvegarde du fichier ``app/config/parameters.yml``. | ||
21 | |||
22 | Té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 | |||
28 | Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. | ||
29 | |||
30 | Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. | ||
31 | |||
32 | Videz le répertoire ``var/cache``. | ||