Merge pull request #2788 from Zettt/master

[github/wallabag/wallabag.git] / docs / en / user / parameters.rst

diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst
index 79c508717d208fd8324042107a84a6cd586288fd..d8a209e7376813588e0e40fefe1cf43b80c88289 100644 (file)
--- a/docs/en/user/parameters.rst
+++ b/docs/en/user/parameters.rst
@@ -1,5 +1,49 @@
 What is the meaning of the parameters?
 ======================================
+
+Default `parameters.yml` file
+-----------------------------
+
+Here is the last version of the default `app/config/parameters.yml` file. Be sure that yours respects this one.
+If you don't know which value you need to set, please leave the default one.
+
+.. code-block:: yml
+
+    parameters:
+        database_driver: pdo_sqlite
+        database_host: 127.0.0.1
+        database_port: null
+        database_name: symfony
+        database_user: root
+        database_password: null
+        database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite'
+        database_table_prefix: wallabag_
+        database_socket: null
+        mailer_transport: smtp
+        mailer_host: 127.0.0.1
+        mailer_user: null
+        mailer_password: null
+        locale: en
+        secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv
+        twofactor_auth: true
+        twofactor_sender: no-reply@wallabag.org
+        fosuser_registration: true
+        fosuser_confirmation: true
+        from_email: no-reply@wallabag.org
+        rss_limit: 50
+        rabbitmq_host: localhost
+        rabbitmq_port: 5672
+        rabbitmq_user: guest
+        rabbitmq_password: guest
+        redis_scheme: tcp
+        redis_host: localhost
+        redis_port: 6379
+        redis_path: null
+        redis_password: null
+
+Meaning of each parameter
+-------------------------
+
 .. csv-table:: Database parameters
    :header: "name", "default", "description"
 
@@ -9,9 +53,10 @@ What is the meaning of the parameters?
    "database_name", "symfony", "name of your database"
    "database_user", "root", "user that can write to this database"
    "database_password", "~", "password of that user"
-   "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "only for SQLite, define where to put the database file. Leave it for other database"
+   "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "only for SQLite, define where to put the database file. Leave it empty for other database"
    "database_table_prefix", "wallabag_", "all wallabag's tables will be prefixed with that string. You can include a ``_`` for clarity"
-   "database_socket", "null", "If your database is using a socket instead of tcp, put the path of the socket (other connection parameters will then be ignored"
+   "database_socket", "null", "If your database is using a socket instead of tcp, put the path of the socket (other connection parameters will then be ignored)"
+   "database_charset", "utf8mb4", "For PostgreSQL & SQLite you should use utf8, for MySQL use utf8mb4 which handle emoji"
 
 .. csv-table:: Configuration to send emails from wallabag
    :header: "name", "default", "description"
@@ -38,7 +83,7 @@ What is the meaning of the parameters?
 
    "rabbitmq_host", "localhost", "Host of your RabbitMQ"
    "rabbitmq_port", "5672", "Port of your RabbitMQ"
-   "rabbitmq_user", "guest", "Usee that can read queues"
+   "rabbitmq_user", "guest", "User that can read queues"
    "rabbitmq_password", "guest", "Password of that user"
 
 .. csv-table:: Redis configuration
@@ -48,3 +93,4 @@ What is the meaning of the parameters?
    "redis_host", "localhost", "IP or hostname of the target server (ignored for unix scheme)"
    "redis_port", "6379", "TCP/IP port of the target server (ignored for unix scheme)"
    "redis_path", "null", "Path of the UNIX domain socket file used when connecting to Redis using UNIX domain sockets"
+   "redis_password", "null", "Password defined in the Redis server configuration (parameter `requirepass` in `redis.conf`)"