aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/user/parameters.rst
diff options
context:
space:
mode:
authorJeremy Benoist <jeremy.benoist@gmail.com>2016-10-11 21:01:30 +0200
committerJeremy Benoist <jeremy.benoist@gmail.com>2016-10-11 21:01:30 +0200
commite4cf672ccf61689ba28c2e89fc55f83167800b18 (patch)
tree5dc22c97797bdcdd0a3d2a7e182410f04a748c1e /docs/en/user/parameters.rst
parente57df5611fe82ce61a71d51c762ee9296f18c3ac (diff)
parentdbe94e73a9eaf3acb250812913b0303b35d01a2e (diff)
downloadwallabag-e4cf672ccf61689ba28c2e89fc55f83167800b18.tar.gz
wallabag-e4cf672ccf61689ba28c2e89fc55f83167800b18.tar.zst
wallabag-e4cf672ccf61689ba28c2e89fc55f83167800b18.zip
Merge remote-tracking branch 'origin/master' into 2.2
Diffstat (limited to 'docs/en/user/parameters.rst')
-rw-r--r--docs/en/user/parameters.rst50
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst
new file mode 100644
index 00000000..79c50871
--- /dev/null
+++ b/docs/en/user/parameters.rst
@@ -0,0 +1,50 @@
1What is the meaning of the parameters?
2======================================
3.. csv-table:: Database parameters
4 :header: "name", "default", "description"
5
6 "database_driver", "pdo_sqlite", "Should be 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_port", "~", "port of your database (you can leave ``~`` to use the default one)"
9 "database_name", "symfony", "name of your database"
10 "database_user", "root", "user that can write to this database"
11 "database_password", "~", "password of that user"
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_table_prefix", "wallabag_", "all wallabag's tables will be prefixed with that string. You can include a ``_`` for clarity"
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
16.. csv-table:: Configuration to send emails from wallabag
17 :header: "name", "default", "description"
18
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_host", "127.0.0.1", "The host to connect to when using smtp as the transport."
21 "mailer_user", "~", "The username when using smtp as the transport."
22 "mailer_password", "~", "The password when using smtp as the transport."
23
24.. csv-table:: Other wallabag's option
25 :header: "name", "default", "description"
26
27 "locale", "en", "Default language of your wallabag instance (like en, fr, es, etc.)"
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 "twofactor_auth", "true", "true to enable Two factor authentication"
30 "twofactor_sender", "no-reply@wallabag.org", "email of the email sender to receive the two factor code"
31 "fosuser_registration", "true", "true to enable public registration"
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"
34 "rss_limit", "50", "limit for RSS feeds"
35
36.. csv-table:: RabbitMQ configuration
37 :header: "name", "default", "description"
38
39 "rabbitmq_host", "localhost", "Host of your RabbitMQ"
40 "rabbitmq_port", "5672", "Port of your RabbitMQ"
41 "rabbitmq_user", "guest", "Usee that can read queues"
42 "rabbitmq_password", "guest", "Password of that user"
43
44.. csv-table:: Redis configuration
45 :header: "name", "default", "description"
46
47 "redis_scheme", "tcp", "Specifies the protocol used to communicate with an instance of Redis. Valid values are: tcp, unix, http"
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"