Added page about parameters.yml

diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md
index 15855bc731207ef72c5fb34133b477e03f356a16..8ac9bbcde7bf49a824417fa589cb7701b02ef283 100644 (file)
--- a/RELEASE_PROCESS.md
+++ b/RELEASE_PROCESS.md
@@ -29,7 +29,7 @@ git push origin release-$LAST_WALLABAG_RELEASE
 - Run these command to create the package:
 
 ```
-make releas emaster /tmp wllbg-release prod
+make release master /tmp wllbg-release prod
 ```
 
 - [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new). You have to upload on this page the package.

diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst
index 2bb86269ba608c55317fc85f982a444d31273fa4..0d082e41f7bbdcf5f2043fb370e62d6e83a1ae27 100644 (file)
--- a/docs/de/user/installation.rst
+++ b/docs/de/user/installation.rst
@@ -7,7 +7,7 @@ Voraussetzungen
 wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7.
 
 .. note::
-Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``.
+To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool.
 
 wallabag nutzt eine große Anzahl an Bibliotheken, um zu funktionieren. Diese Bibliotheken müssen mit einem Tool namens Composer installiert werden. Du musst es installieren sofern du es bisher noch nicht gemacht hast.
 

diff --git a/docs/en/user/android.rst b/docs/en/user/android.rst
index eec130f6c028e21d58e715413be2b04353012f49..ccbad264260201150fcebae0b5fcb6908bcdc213 100644 (file)
--- a/docs/en/user/android.rst
+++ b/docs/en/user/android.rst
@@ -35,7 +35,7 @@ After you have filled in your data, push the button Connection test and wait for
     :alt: Connection test with your wallabag data
     :align: center
 
-The connection test shall finish with success. If not, you need to fix this first until you proceed.
+The connection test should finish with success. If not, you need to fix this first until you proceed.
 
 .. image:: ../../img/user/android_configuration_connection_test_success.en.png
     :alt: Connection test successful
@@ -65,10 +65,10 @@ After hitting the save button, you get the following screen. The app proposes to
     :alt: Settings saved the first time
     :align: center
 
-Finally after the syncronisation finished successfully, you are presented the list of unread articles.
+Finally after the synchronisation finished successfully, you are presented to the list of unread articles.
 
 .. image:: ../../img/user/android_unread_feed_synced.en.png
-    :alt: Filled article list cause feeds successfully syncronized
+    :alt: Filled article list cause feeds successfully synchronized
     :align: center
 
 

diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst
new file mode 100644 (file)
index 0000000..94eff68
--- /dev/null
+++ b/docs/en/user/parameters.rst
@@ -0,0 +1,48 @@
+What is the meaning of the parameters?
+======================================
+
+.. code-block:: yml
+
+    # Database parameters
+    database_driver: pdo_sqlite or pdo_mysql or pdo_pgsql
+    database_host: 127.0.0.1
+    database_port: ~
+    database_name: symfony
+    database_user: root
+    database_password: ~
+    database_path: "%kernel.root_dir%/../data/db/wallabag.sqlite" or empty (when using mysql or postgresql)
+    database_table_prefix: wallabag_
+    database_socket: null
+
+    # Configuration to send emails from wallabag
+    mailer_transport:  smtp
+    mailer_host:       127.0.0.1
+    mailer_user:       ~
+    mailer_password:   ~
+
+    locale:            en # Default language of your wallabag instance
+
+    secret:            ovmpmAWXRCabNlMgzlzFXDYmCFfzGv # A random string used for security
+
+    twofactor_auth: true # true to enable Two factor authentication
+    twofactor_sender: no-reply@wallabag.org
+
+    fosuser_registration: true # true to enable public registration
+    fosuser_confirmation: true # true to send a confirmation by email for each registration
+
+    from_email: no-reply@wallabag.org # email address used in From: field in each email
+
+    rss_limit: 50 # limit for RSS feeds
+
+    # RabbitMQ configuration
+    rabbitmq_host: localhost
+    rabbitmq_port: 5672
+    rabbitmq_user: guest
+    rabbitmq_password: guest
+
+    # Redis configuration
+    redis_scheme: tcp
+    redis_host: localhost
+    redis_port: 6379
+    redis_path: null
+