aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/user/parameters.rst
diff options
context:
space:
mode:
authorNicolas LÅ“uillet <nicolas@loeuillet.org>2016-10-10 13:01:14 +0200
committerNicolas LÅ“uillet <nicolas@loeuillet.org>2016-10-10 13:01:14 +0200
commited11d7f7319dbc3ad9ea8265179f0f32d7d9ef6c (patch)
tree71b449ae7969f6d1185a9b765ab8efe74c7acfff /docs/en/user/parameters.rst
parent6b1317a627686fea33662f56fa08231b7793803a (diff)
downloadwallabag-ed11d7f7319dbc3ad9ea8265179f0f32d7d9ef6c.tar.gz
wallabag-ed11d7f7319dbc3ad9ea8265179f0f32d7d9ef6c.tar.zst
wallabag-ed11d7f7319dbc3ad9ea8265179f0f32d7d9ef6c.zip
Added page about parameters.yml
Diffstat (limited to 'docs/en/user/parameters.rst')
-rw-r--r--docs/en/user/parameters.rst48
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst
new file mode 100644
index 00000000..94eff689
--- /dev/null
+++ b/docs/en/user/parameters.rst
@@ -0,0 +1,48 @@
1What is the meaning of the parameters?
2======================================
3
4.. code-block:: yml
5
6 # Database parameters
7 database_driver: pdo_sqlite or pdo_mysql or pdo_pgsql
8 database_host: 127.0.0.1
9 database_port: ~
10 database_name: symfony
11 database_user: root
12 database_password: ~
13 database_path: "%kernel.root_dir%/../data/db/wallabag.sqlite" or empty (when using mysql or postgresql)
14 database_table_prefix: wallabag_
15 database_socket: null
16
17 # Configuration to send emails from wallabag
18 mailer_transport: smtp
19 mailer_host: 127.0.0.1
20 mailer_user: ~
21 mailer_password: ~
22
23 locale: en # Default language of your wallabag instance
24
25 secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv # A random string used for security
26
27 twofactor_auth: true # true to enable Two factor authentication
28 twofactor_sender: no-reply@wallabag.org
29
30 fosuser_registration: true # true to enable public registration
31 fosuser_confirmation: true # true to send a confirmation by email for each registration
32
33 from_email: no-reply@wallabag.org # email address used in From: field in each email
34
35 rss_limit: 50 # limit for RSS feeds
36
37 # RabbitMQ configuration
38 rabbitmq_host: localhost
39 rabbitmq_port: 5672
40 rabbitmq_user: guest
41 rabbitmq_password: guest
42
43 # Redis configuration
44 redis_scheme: tcp
45 redis_host: localhost
46 redis_port: 6379
47 redis_path: null
48