aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorNicolas Lœuillet <nicolas@loeuillet.org>2016-10-13 16:53:13 +0200
committerGitHub <noreply@github.com>2016-10-13 16:53:13 +0200
commit8b28151e1426fc884cc34b444f9b182a1a0b6001 (patch)
tree3fcbd29b74a6318f66202ce5201b32f373cee4f1
parente65c27587b940ef8de88578e57f109b5b7819684 (diff)
parent75a1506c276a43f0d3ad65ac1436329e9d5c8c0f (diff)
downloadwallabag-8b28151e1426fc884cc34b444f9b182a1a0b6001.tar.gz
wallabag-8b28151e1426fc884cc34b444f9b182a1a0b6001.tar.zst
wallabag-8b28151e1426fc884cc34b444f9b182a1a0b6001.zip
Merge pull request #2434 from wallabag/parameters-doc
Added french documentation for parameters.yml
-rw-r--r--docs/de/index.rst1
-rw-r--r--docs/de/user/parameters.rst50
-rw-r--r--docs/en/index.rst1
-rw-r--r--docs/en/user/parameters.rst6
-rw-r--r--docs/fr/index.rst1
-rw-r--r--docs/fr/user/parameters.rst50
6 files changed, 106 insertions, 3 deletions
diff --git a/docs/de/index.rst b/docs/de/index.rst
index b3cd33b0..9ad62013 100644
--- a/docs/de/index.rst
+++ b/docs/de/index.rst
@@ -44,6 +44,7 @@ Die Dokumentation ist in anderen Sprachen verfügbar :
44 user/filters 44 user/filters
45 user/tags 45 user/tags
46 user/android 46 user/android
47 user/parameters
47 48
48.. _dev-docs: 49.. _dev-docs:
49 50
diff --git a/docs/de/user/parameters.rst b/docs/de/user/parameters.rst
new file mode 100644
index 00000000..4c68fe9e
--- /dev/null
+++ b/docs/de/user/parameters.rst
@@ -0,0 +1,50 @@
1Was bedeuten die Parameter?
2===========================
3.. csv-table:: Datenbankparameter
4 :header: "Name", "Standardwert", "Beschreibung"
5
6 "database_driver", "pdo_sqlite", "Sollte pdo_sqlite oder pdo_mysql oder pdo_pgsql sein"
7 "database_host", "127.0.0.1", "Hostadresse deiner Datenbank (normalerweise localhost oder 127.0.0.1)"
8 "database_port", "~", "Port deiner Datenbank (Du kannst ``~`` stehen lassen, um den Standardport zu nutzen)"
9 "database_name", "symfony", "Benenne deine Datenbank"
10 "database_user", "root", "Benutzer, der Schreibrecht in der Datenbank hat"
11 "database_password", "~", "Passwort des Benutzers"
12 "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "nur für SQLite, definiere, wo die Datenbankdatei abgelegt werden soll. Lass den Parameter leer für andere Datenbanktypen."
13 "database_table_prefix", "wallabag_", "alle wallabag Tabellen erhalten diesen Präfix im Namen. Du kannst einen ``_`` dafür im Präfix nutzen, um das zu verdeutlichen."
14 "database_socket", "null", "Wenn deine Datenbank einen Socket statt TCP nutzt, schreibe hier den Pfad zum Socket hin (andere Verbindungsparameter werden dann ignoriert."
15
16.. csv-table:: Konfiguration, um mit wallabag E-Mails senden zu können
17 :header: "Name", "Standardwert", "Beschreibung"
18
19 "mailer_transport", "smtp", "Die exakte Transportmethode, um E-Mails zuzustellen. Gültige Werte sind: smtp, gmail, mail, sendmail, null (was das Mailen deaktivert)"
20 "mailer_host", "127.0.0.1", "Der Host, zu dem sich verbunden wird, wenn SMTP als Transport genutzt wird."
21 "mailer_user", "~", "Der Benutzername, wenn SMTP als Transport genutzt wird."
22 "mailer_password", "~", "Das Passwort, wenn SMTP als Transport genutzt wird."
23
24.. csv-table:: Andere wallabag Optionen
25 :header: "Name", "Standardwert", "Beschreibung"
26
27 "locale", "en", "Standardsprache deiner wallabag Instanz (wie z.B. en, fr, es, etc.)"
28 "secret", "ovmpmAWXRCabNlMgzlzFXDYmCFfzGv", "Dieser String sollte einzigartig für deine Applikation sein und er wird genutzt, um sicherheitsrelevanten Operationen mehr Entropie hinzuzufügen."
29 "twofactor_auth", "true", "true, um Zwei-Faktor-Authentifizierung zu aktivieren"
30 "twofactor_sender", "no-reply@wallabag.org", "E-Mail-Adresse des Senders der Mails mit dem Code für die Zwei-Faktor-Authentifizierung"
31 "fosuser_registration", "true", "true, um die Registrierung für jedermann zu aktivieren"
32 "fosuser_confirmation", "true", "true, um eine Bestätigungsmail für jede Registrierung zu senden"
33 "from_email", "no-reply@wallabag.org", "E-Mail-Adresse, die im Absenderfeld jeder Mail genutzt wird"
34 "rss_limit", "50", "Artikellimit für RSS Feeds"
35
36.. csv-table:: RabbitMQ Konfiguration
37 :header: "Name", "Standardwert", "Beschreibung"
38
39 "rabbitmq_host", "localhost", "Host deines RabbitMQ"
40 "rabbitmq_port", "5672", "Port deines RabbitMQ"
41 "rabbitmq_user", "guest", "Benutzer, der die Queue lesen kann"
42 "rabbitmq_password", "guest", "Passwort dieses Benutzers"
43
44.. csv-table:: Redis Konfiguration
45 :header: "Name", "Standardwert", "Beschreibung"
46
47 "redis_scheme", "tcp", "Bestimmt das Protokoll, dass genutzt wird, um mit Redis zu kommunizieren. Gültige Werte sind: tcp, unix, http"
48 "redis_host", "localhost", "IP oder Hostname des Zielservers (ignoriert bei Unix Schema)"
49 "redis_port", "6379", "TCP/IP Port des Zielservers (ignoriert bei Unix Schema)"
50 "redis_path", "null", "Pfad zur Unix Domain Socket Datei, wenn Redis Unix Domain Sockets nutzt"
diff --git a/docs/en/index.rst b/docs/en/index.rst
index 4e346ae6..6d85db2b 100644
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -45,6 +45,7 @@ The documentation is available in other languages:
45 user/filters 45 user/filters
46 user/tags 46 user/tags
47 user/android 47 user/android
48 user/parameters
48 49
49.. _dev-docs: 50.. _dev-docs:
50 51
diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst
index 79c50871..6cbd5ae4 100644
--- a/docs/en/user/parameters.rst
+++ b/docs/en/user/parameters.rst
@@ -9,9 +9,9 @@ What is the meaning of the parameters?
9 "database_name", "symfony", "name of your database" 9 "database_name", "symfony", "name of your database"
10 "database_user", "root", "user that can write to this database" 10 "database_user", "root", "user that can write to this database"
11 "database_password", "~", "password of that user" 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" 12 "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"
13 "database_table_prefix", "wallabag_", "all wallabag's tables will be prefixed with that string. You can include a ``_`` for clarity" 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" 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 15
16.. csv-table:: Configuration to send emails from wallabag 16.. csv-table:: Configuration to send emails from wallabag
17 :header: "name", "default", "description" 17 :header: "name", "default", "description"
@@ -38,7 +38,7 @@ What is the meaning of the parameters?
38 38
39 "rabbitmq_host", "localhost", "Host of your RabbitMQ" 39 "rabbitmq_host", "localhost", "Host of your RabbitMQ"
40 "rabbitmq_port", "5672", "Port of your RabbitMQ" 40 "rabbitmq_port", "5672", "Port of your RabbitMQ"
41 "rabbitmq_user", "guest", "Usee that can read queues" 41 "rabbitmq_user", "guest", "User that can read queues"
42 "rabbitmq_password", "guest", "Password of that user" 42 "rabbitmq_password", "guest", "Password of that user"
43 43
44.. csv-table:: Redis configuration 44.. csv-table:: Redis configuration
diff --git a/docs/fr/index.rst b/docs/fr/index.rst
index 359b103c..082173e5 100644
--- a/docs/fr/index.rst
+++ b/docs/fr/index.rst
@@ -45,6 +45,7 @@ La documentation est disponible dans d'autres langues :
45 user/share 45 user/share
46 user/filters 46 user/filters
47 user/tags 47 user/tags
48 user/parameters
48 49
49.. _dev-docs: 50.. _dev-docs:
50 51
diff --git a/docs/fr/user/parameters.rst b/docs/fr/user/parameters.rst
new file mode 100644
index 00000000..ec8c8995
--- /dev/null
+++ b/docs/fr/user/parameters.rst
@@ -0,0 +1,50 @@
1À quoi servent les paramètres ?
2===============================
3.. csv-table:: Paramètres de base de données
4 :header: "name", "default", "description"
5
6 "database_driver", "pdo_sqlite", "Doit être pdo_sqlite ou pdo_mysql ou pdo_pgsql"
7 "database_host", "127.0.0.1", "Hôte de votre base de données (généralement localhost ou 127.0.0.1)"
8 "database_port", "~", "Port de votre base de données (vous pouvez laisser ``~`` pour utiliser celui par défaut)"
9 "database_name", "symfony", "Nom de votre base de données"
10 "database_user", "root", "Utilisateur de votre base de données"
11 "database_password", "~", "Mot de passe de cet utilisateur"
12 "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "Uniquement pour SQLite. Chemin du fichier de base de données. Laissez vide pour les autres bases de données."
13 "database_table_prefix", "wallabag_", "Toutes les tables de wallabag seront préfixées par cette chaine. Vous pouvez ajouter un ``_`` pour plus de clarté"
14 "database_socket", "null", "Si votre base de données utilise un socket plutôt que tcp, spécifiez le chemin du socket (les autres paramètres de connexion seront alors ignorés)"
15
16.. csv-table:: Configuration pour envoyer des emails depuis wallabag
17 :header: "name", "default", "description"
18
19 "mailer_transport", "smtp", "Méthode de transport exacte utilisée pour envoyer des emails. Les valeurs correctes sont : smtp, gmail, mail, sendmail, null (ce qui désactivera l'envoi des emails)"
20 "mailer_host", "127.0.0.1", "Hôte sur lequel se connecter quand on utilise smtp comme transport."
21 "mailer_user", "~", "Utilisateur smtp."
22 "mailer_password", "~", "Mot de passe de cet utilisateur."
23
24.. csv-table:: Autres options de wallabag
25 :header: "name", "default", "description"
26
27 "locale", "en", "Langue par défaut de votre instance wallabag (comme en, fr, es, etc.)"
28 "secret", "ovmpmAWXRCabNlMgzlzFXDYmCFfzGv", "C'est une chaine qui doit être unique à votre application et qui est couramment utilisée pour ajouter plus d'entropie aux opérations relatives à la sécurité."
29 "twofactor_auth", "true", "true pour activer l'authentification à deux facteurs"
30 "twofactor_sender", "no-reply@wallabag.org", "Email de l'expéditeur du code de l'authentification à deux facteurs"
31 "fosuser_registration", "true", "true pour activer l'inscription publique"
32 "fosuser_confirmation", "true", "true pour envoyer un email de confirmation pour chaque création de compte"
33 "from_email", "no-reply@wallabag.org", "Email de l'expéditeur pour chaque email envoyé"
34 "rss_limit", "50", "Limite pour les flux RSS"
35
36.. csv-table:: Configuration RabbitMQ
37 :header: "name", "default", "description"
38
39 "rabbitmq_host", "localhost", "Hôte de votre instance RabbitMQ"
40 "rabbitmq_port", "5672", "Port de votre instance RabbitMQ"
41 "rabbitmq_user", "guest", "Utilisateur de votre instance RabbitMQ"
42 "rabbitmq_password", "guest", "Mot de passe de cet utilisateur"
43
44.. csv-table:: Configuration Redis
45 :header: "name", "default", "description"
46
47 "redis_scheme", "tcp", "Définit le protocole utilisé pour commuiquer avec l'instance Redis. Les valeurs correctes sont : tcp, unix, http"
48 "redis_host", "localhost", "IP ou hôte du serveur cible (ignoré pour un schéma unix)"
49 "redis_port", "6379", "Port TCP/IP du serveur cible (ignoré pour un schéma unix)"
50 "redis_path", "null", "Chemin du fichier de socket du domaine UNIX utilisé quand on se connecte à Redis en utilisant les sockets du domaine UNIX"