aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/user
diff options
context:
space:
mode:
authorJeremy Benoist <j0k3r@users.noreply.github.com>2016-10-10 13:42:50 +0200
committerGitHub <noreply@github.com>2016-10-10 13:42:50 +0200
commit035513b0257ca5147759432e463e81bc9000221e (patch)
treeae83431feff65efca86096f0090d967092a7053e /docs/en/user
parented11d7f7319dbc3ad9ea8265179f0f32d7d9ef6c (diff)
downloadwallabag-035513b0257ca5147759432e463e81bc9000221e.tar.gz
wallabag-035513b0257ca5147759432e463e81bc9000221e.tar.zst
wallabag-035513b0257ca5147759432e463e81bc9000221e.zip
Use table for parameters.yml
Diffstat (limited to 'docs/en/user')
-rw-r--r--docs/en/user/parameters.rst94
1 files changed, 48 insertions, 46 deletions
diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst
index 94eff689..79c50871 100644
--- a/docs/en/user/parameters.rst
+++ b/docs/en/user/parameters.rst
@@ -1,48 +1,50 @@
1What is the meaning of the parameters? 1What is the meaning of the parameters?
2====================================== 2======================================
3 3.. csv-table:: Database parameters
4.. code-block:: yml 4 :header: "name", "default", "description"
5 5
6 # Database parameters 6 "database_driver", "pdo_sqlite", "Should be pdo_sqlite or pdo_mysql or pdo_pgsql"
7 database_driver: pdo_sqlite or pdo_mysql or pdo_pgsql 7 "database_host", "127.0.0.1", "host of your database (usually localhost or 127.0.0.1)"
8 database_host: 127.0.0.1 8 "database_port", "~", "port of your database (you can leave ``~`` to use the default one)"
9 database_port: ~ 9 "database_name", "symfony", "name of your database"
10 database_name: symfony 10 "database_user", "root", "user that can write to this database"
11 database_user: root 11 "database_password", "~", "password of that user"
12 database_password: ~ 12 "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "only for SQLite, define where to put the database file. Leave it for other database"
13 database_path: "%kernel.root_dir%/../data/db/wallabag.sqlite" or empty (when using mysql or postgresql) 13 "database_table_prefix", "wallabag_", "all wallabag's tables will be prefixed with that string. You can include a ``_`` for clarity"
14 database_table_prefix: wallabag_ 14 "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"
15 database_socket: null 15
16 16.. csv-table:: Configuration to send emails from wallabag
17 # Configuration to send emails from wallabag 17 :header: "name", "default", "description"
18 mailer_transport: smtp 18
19 mailer_host: 127.0.0.1 19 "mailer_transport", "smtp", "The exact transport method to use to deliver emails. Valid values are: smtp, gmail, mail, sendmail, null (which will disable the mailer)"
20 mailer_user: ~ 20 "mailer_host", "127.0.0.1", "The host to connect to when using smtp as the transport."
21 mailer_password: ~ 21 "mailer_user", "~", "The username when using smtp as the transport."
22 22 "mailer_password", "~", "The password when using smtp as the transport."
23 locale: en # Default language of your wallabag instance 23
24 24.. csv-table:: Other wallabag's option
25 secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv # A random string used for security 25 :header: "name", "default", "description"
26 26
27 twofactor_auth: true # true to enable Two factor authentication 27 "locale", "en", "Default language of your wallabag instance (like en, fr, es, etc.)"
28 twofactor_sender: no-reply@wallabag.org 28 "secret", "ovmpmAWXRCabNlMgzlzFXDYmCFfzGv", "This is a string that should be unique to your application and it's commonly used to add more entropy to security related operations."
29 29 "twofactor_auth", "true", "true to enable Two factor authentication"
30 fosuser_registration: true # true to enable public registration 30 "twofactor_sender", "no-reply@wallabag.org", "email of the email sender to receive the two factor code"
31 fosuser_confirmation: true # true to send a confirmation by email for each registration 31 "fosuser_registration", "true", "true to enable public registration"
32 32 "fosuser_confirmation", "true", "true to send a confirmation by email for each registration"
33 from_email: no-reply@wallabag.org # email address used in From: field in each email 33 "from_email", "no-reply@wallabag.org", "email address used in From: field in each email"
34 34 "rss_limit", "50", "limit for RSS feeds"
35 rss_limit: 50 # limit for RSS feeds 35
36 36.. csv-table:: RabbitMQ configuration
37 # RabbitMQ configuration 37 :header: "name", "default", "description"
38 rabbitmq_host: localhost 38
39 rabbitmq_port: 5672 39 "rabbitmq_host", "localhost", "Host of your RabbitMQ"
40 rabbitmq_user: guest 40 "rabbitmq_port", "5672", "Port of your RabbitMQ"
41 rabbitmq_password: guest 41 "rabbitmq_user", "guest", "Usee that can read queues"
42 42 "rabbitmq_password", "guest", "Password of that user"
43 # Redis configuration 43
44 redis_scheme: tcp 44.. csv-table:: Redis configuration
45 redis_host: localhost 45 :header: "name", "default", "description"
46 redis_port: 6379 46
47 redis_path: null 47 "redis_scheme", "tcp", "Specifies the protocol used to communicate with an instance of Redis. Valid values are: tcp, unix, http"
48 48 "redis_host", "localhost", "IP or hostname of the target server (ignored for unix scheme)"
49 "redis_port", "6379", "TCP/IP port of the target server (ignored for unix scheme)"
50 "redis_path", "null", "Path of the UNIX domain socket file used when connecting to Redis using UNIX domain sockets"