diff options
author | Jérémy Benoist <j0k3r@users.noreply.github.com> | 2017-10-23 11:09:17 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-10-23 11:09:17 +0200 |
commit | 1953a872932a63792293b4aec087880265ba89f7 (patch) | |
tree | fd16599e737fcdaf193c933ef3ec4a4ee248b117 /docs/en/user/parameters.rst | |
parent | d83d25dadec2c38460a32d96f5d2903426fec9d3 (diff) | |
parent | 702f2d67d60ca963492b90dad74cb5f8dcc84e51 (diff) | |
download | wallabag-1953a872932a63792293b4aec087880265ba89f7.tar.gz wallabag-1953a872932a63792293b4aec087880265ba89f7.tar.zst wallabag-1953a872932a63792293b4aec087880265ba89f7.zip |
Merge pull request #3011 from wallabag/2.3
wallabag 2.3.0
Diffstat (limited to 'docs/en/user/parameters.rst')
-rw-r--r-- | docs/en/user/parameters.rst | 96 |
1 files changed, 0 insertions, 96 deletions
diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst deleted file mode 100644 index d8a209e7..00000000 --- a/docs/en/user/parameters.rst +++ /dev/null | |||
@@ -1,96 +0,0 @@ | |||
1 | What is the meaning of the parameters? | ||
2 | ====================================== | ||
3 | |||
4 | Default `parameters.yml` file | ||
5 | ----------------------------- | ||
6 | |||
7 | Here is the last version of the default `app/config/parameters.yml` file. Be sure that yours respects this one. | ||
8 | If you don't know which value you need to set, please leave the default one. | ||
9 | |||
10 | .. code-block:: yml | ||
11 | |||
12 | parameters: | ||
13 | database_driver: pdo_sqlite | ||
14 | database_host: 127.0.0.1 | ||
15 | database_port: null | ||
16 | database_name: symfony | ||
17 | database_user: root | ||
18 | database_password: null | ||
19 | database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite' | ||
20 | database_table_prefix: wallabag_ | ||
21 | database_socket: null | ||
22 | mailer_transport: smtp | ||
23 | mailer_host: 127.0.0.1 | ||
24 | mailer_user: null | ||
25 | mailer_password: null | ||
26 | locale: en | ||
27 | secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv | ||
28 | twofactor_auth: true | ||
29 | twofactor_sender: no-reply@wallabag.org | ||
30 | fosuser_registration: true | ||
31 | fosuser_confirmation: true | ||
32 | from_email: no-reply@wallabag.org | ||
33 | rss_limit: 50 | ||
34 | rabbitmq_host: localhost | ||
35 | rabbitmq_port: 5672 | ||
36 | rabbitmq_user: guest | ||
37 | rabbitmq_password: guest | ||
38 | redis_scheme: tcp | ||
39 | redis_host: localhost | ||
40 | redis_port: 6379 | ||
41 | redis_path: null | ||
42 | redis_password: null | ||
43 | |||
44 | Meaning of each parameter | ||
45 | ------------------------- | ||
46 | |||
47 | .. csv-table:: Database parameters | ||
48 | :header: "name", "default", "description" | ||
49 | |||
50 | "database_driver", "pdo_sqlite", "Should be pdo_sqlite or pdo_mysql or pdo_pgsql" | ||
51 | "database_host", "127.0.0.1", "host of your database (usually localhost or 127.0.0.1)" | ||
52 | "database_port", "~", "port of your database (you can leave ``~`` to use the default one)" | ||
53 | "database_name", "symfony", "name of your database" | ||
54 | "database_user", "root", "user that can write to this database" | ||
55 | "database_password", "~", "password of that user" | ||
56 | "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" | ||
57 | "database_table_prefix", "wallabag_", "all wallabag's tables will be prefixed with that string. You can include a ``_`` for clarity" | ||
58 | "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)" | ||
59 | "database_charset", "utf8mb4", "For PostgreSQL & SQLite you should use utf8, for MySQL use utf8mb4 which handle emoji" | ||
60 | |||
61 | .. csv-table:: Configuration to send emails from wallabag | ||
62 | :header: "name", "default", "description" | ||
63 | |||
64 | "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)" | ||
65 | "mailer_host", "127.0.0.1", "The host to connect to when using smtp as the transport." | ||
66 | "mailer_user", "~", "The username when using smtp as the transport." | ||
67 | "mailer_password", "~", "The password when using smtp as the transport." | ||
68 | |||
69 | .. csv-table:: Other wallabag's option | ||
70 | :header: "name", "default", "description" | ||
71 | |||
72 | "locale", "en", "Default language of your wallabag instance (like en, fr, es, etc.)" | ||
73 | "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." | ||
74 | "twofactor_auth", "true", "true to enable Two factor authentication" | ||
75 | "twofactor_sender", "no-reply@wallabag.org", "email of the email sender to receive the two factor code" | ||
76 | "fosuser_registration", "true", "true to enable public registration" | ||
77 | "fosuser_confirmation", "true", "true to send a confirmation by email for each registration" | ||
78 | "from_email", "no-reply@wallabag.org", "email address used in From: field in each email" | ||
79 | "rss_limit", "50", "limit for RSS feeds" | ||
80 | |||
81 | .. csv-table:: RabbitMQ configuration | ||
82 | :header: "name", "default", "description" | ||
83 | |||
84 | "rabbitmq_host", "localhost", "Host of your RabbitMQ" | ||
85 | "rabbitmq_port", "5672", "Port of your RabbitMQ" | ||
86 | "rabbitmq_user", "guest", "User that can read queues" | ||
87 | "rabbitmq_password", "guest", "Password of that user" | ||
88 | |||
89 | .. csv-table:: Redis configuration | ||
90 | :header: "name", "default", "description" | ||
91 | |||
92 | "redis_scheme", "tcp", "Specifies the protocol used to communicate with an instance of Redis. Valid values are: tcp, unix, http" | ||
93 | "redis_host", "localhost", "IP or hostname of the target server (ignored for unix scheme)" | ||
94 | "redis_port", "6379", "TCP/IP port of the target server (ignored for unix scheme)" | ||
95 | "redis_path", "null", "Path of the UNIX domain socket file used when connecting to Redis using UNIX domain sockets" | ||
96 | "redis_password", "null", "Password defined in the Redis server configuration (parameter `requirepass` in `redis.conf`)" | ||