diff options
author | Nicolas LÅ“uillet <nicolas@loeuillet.org> | 2016-10-10 13:01:14 +0200 |
---|---|---|
committer | Nicolas LÅ“uillet <nicolas@loeuillet.org> | 2016-10-10 13:01:14 +0200 |
commit | ed11d7f7319dbc3ad9ea8265179f0f32d7d9ef6c (patch) | |
tree | 71b449ae7969f6d1185a9b765ab8efe74c7acfff /docs/en/user | |
parent | 6b1317a627686fea33662f56fa08231b7793803a (diff) | |
download | wallabag-ed11d7f7319dbc3ad9ea8265179f0f32d7d9ef6c.tar.gz wallabag-ed11d7f7319dbc3ad9ea8265179f0f32d7d9ef6c.tar.zst wallabag-ed11d7f7319dbc3ad9ea8265179f0f32d7d9ef6c.zip |
Added page about parameters.yml
Diffstat (limited to 'docs/en/user')
-rw-r--r-- | docs/en/user/android.rst | 6 | ||||
-rw-r--r-- | docs/en/user/parameters.rst | 48 |
2 files changed, 51 insertions, 3 deletions
diff --git a/docs/en/user/android.rst b/docs/en/user/android.rst index eec130f6..ccbad264 100644 --- a/docs/en/user/android.rst +++ b/docs/en/user/android.rst | |||
@@ -35,7 +35,7 @@ After you have filled in your data, push the button Connection test and wait for | |||
35 | :alt: Connection test with your wallabag data | 35 | :alt: Connection test with your wallabag data |
36 | :align: center | 36 | :align: center |
37 | 37 | ||
38 | The connection test shall finish with success. If not, you need to fix this first until you proceed. | 38 | The connection test should finish with success. If not, you need to fix this first until you proceed. |
39 | 39 | ||
40 | .. image:: ../../img/user/android_configuration_connection_test_success.en.png | 40 | .. image:: ../../img/user/android_configuration_connection_test_success.en.png |
41 | :alt: Connection test successful | 41 | :alt: Connection test successful |
@@ -65,10 +65,10 @@ After hitting the save button, you get the following screen. The app proposes to | |||
65 | :alt: Settings saved the first time | 65 | :alt: Settings saved the first time |
66 | :align: center | 66 | :align: center |
67 | 67 | ||
68 | Finally after the syncronisation finished successfully, you are presented the list of unread articles. | 68 | Finally after the synchronisation finished successfully, you are presented to the list of unread articles. |
69 | 69 | ||
70 | .. image:: ../../img/user/android_unread_feed_synced.en.png | 70 | .. image:: ../../img/user/android_unread_feed_synced.en.png |
71 | :alt: Filled article list cause feeds successfully syncronized | 71 | :alt: Filled article list cause feeds successfully synchronized |
72 | :align: center | 72 | :align: center |
73 | 73 | ||
74 | 74 | ||
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 @@ | |||
1 | What 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 | |||