diff options
Diffstat (limited to 'docs')
31 files changed, 418 insertions, 152 deletions
diff --git a/docs/de/developer/rabbitmq.rst b/docs/de/developer/rabbitmq.rst index 37e9984b..f81e07e3 100644 --- a/docs/de/developer/rabbitmq.rst +++ b/docs/de/developer/rabbitmq.rst | |||
@@ -46,6 +46,10 @@ Bearbeite die Datei ``parameters.yml``, um die RabbitMQ Konfiguration einzuricht | |||
46 | rabbitmq_user: guest | 46 | rabbitmq_user: guest |
47 | rabbitmq_password: guest | 47 | rabbitmq_password: guest |
48 | 48 | ||
49 | Enable RabbitMQ in wallabag | ||
50 | --------------------------- | ||
51 | |||
52 | In internal settings, in the **Import** section, enable RabbitMQ (with the value 1). | ||
49 | 53 | ||
50 | Starte den RabbitMQ Consumer | 54 | Starte den RabbitMQ Consumer |
51 | ---------------------------- | 55 | ---------------------------- |
diff --git a/docs/de/developer/redis.rst b/docs/de/developer/redis.rst index 46334cf0..57b41550 100644 --- a/docs/de/developer/redis.rst +++ b/docs/de/developer/redis.rst | |||
@@ -35,6 +35,10 @@ Bearbeite die Datei ``parameters.yml``, um die RabbitMQ Konfiguration einzuricht | |||
35 | redis_host: localhost | 35 | redis_host: localhost |
36 | redis_port: 6379 | 36 | redis_port: 6379 |
37 | 37 | ||
38 | Enable Redis in wallabag | ||
39 | ------------------------ | ||
40 | |||
41 | In internal settings, in the **Import** section, enable Redis (with the value 1). | ||
38 | 42 | ||
39 | Starte den Redis Consumer | 43 | Starte den Redis Consumer |
40 | ------------------------- | 44 | ------------------------- |
diff --git a/docs/de/developer/testsuite.rst b/docs/de/developer/testsuite.rst new file mode 100644 index 00000000..b2b16cdc --- /dev/null +++ b/docs/de/developer/testsuite.rst | |||
@@ -0,0 +1,10 @@ | |||
1 | Testsuite | ||
2 | ========= | ||
3 | |||
4 | To ensure wallabag development quality, we wrote tests with `PHPUnit <https://phpunit.de>`_. | ||
5 | |||
6 | If you contribute to the project (by translating the application, by fixing bugs or by adding a new feature), please write your own tests. | ||
7 | |||
8 | To launch wallabag testsuite, you need to install `ant <http://ant.apache.org>`_. | ||
9 | |||
10 | Then, execute this command ``make test``. | ||
diff --git a/docs/de/index.rst b/docs/de/index.rst index b3cd33b0..a380d7bd 100644 --- a/docs/de/index.rst +++ b/docs/de/index.rst | |||
@@ -30,8 +30,8 @@ Die Dokumentation ist in anderen Sprachen verfügbar : | |||
30 | 30 | ||
31 | user/faq | 31 | user/faq |
32 | user/installation | 32 | user/installation |
33 | user/upgrade-2.0.x-2.1.y | 33 | user/upgrade-2.0.x-2.1.1 |
34 | user/upgrade-2.0.x-2.0.y | 34 | user/upgrade-2.0.x-2.1.1 |
35 | user/migration | 35 | user/migration |
36 | user/import | 36 | user/import |
37 | user/create_account | 37 | user/create_account |
@@ -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/configuration.rst b/docs/de/user/configuration.rst index 67695ff1..0b0793b1 100644 --- a/docs/de/user/configuration.rst +++ b/docs/de/user/configuration.rst | |||
@@ -102,7 +102,7 @@ Wenn *readingTime >= 5 AND domainName = "github.com"*, dann tagge als *lange zu | |||
102 | Welche Variablen und Operatoren kann ich zum Regeln schreiben nutzen? | 102 | Welche Variablen und Operatoren kann ich zum Regeln schreiben nutzen? |
103 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 103 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
104 | 104 | ||
105 | Die folgenden Variabel und Operatoren können genutzt werden, um Tagging-Regeln zu erstellen: | 105 | Die folgenden Variablen und Operatoren können genutzt werden, um Tagging-Regeln zu erstellen (sei vorsichtig, denn bei einigen Werten musst du Anführungszeichen hinzufügen, z.B. ``language = "de"``): |
106 | 106 | ||
107 | =========== ============================================== ======== ========== | 107 | =========== ============================================== ======== ========== |
108 | Variable Bedeutung Operator Bedeutung | 108 | Variable Bedeutung Operator Bedeutung |
diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index 3578dca9..35a30f52 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst | |||
@@ -6,6 +6,20 @@ Voraussetzungen | |||
6 | 6 | ||
7 | wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7. | 7 | wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7. |
8 | 8 | ||
9 | .. note:: | ||
10 | |||
11 | To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. | ||
12 | |||
13 | wallabag nutzt eine große Anzahl an Bibliotheken, um zu funktionieren. Diese Bibliotheken müssen mit einem Tool namens Composer installiert werden. Du musst es installieren sofern du es bisher noch nicht gemacht hast. | ||
14 | |||
15 | Composer installieren: | ||
16 | |||
17 | :: | ||
18 | |||
19 | curl -s http://getcomposer.org/installer | php | ||
20 | |||
21 | Du kannst eine spezifische Anleitung `hier <https://getcomposer.org/doc/00-intro.md>`__ finden. | ||
22 | |||
9 | Du benötigst die folgenden Extensions damit wallabag funktioniert. Einige von diesen sind vielleicht schon in deiner Version von PHP aktiviert, somit musst du eventuell | 23 | Du benötigst die folgenden Extensions damit wallabag funktioniert. Einige von diesen sind vielleicht schon in deiner Version von PHP aktiviert, somit musst du eventuell |
10 | nicht alle folgenden Pakete installieren. | 24 | nicht alle folgenden Pakete installieren. |
11 | 25 | ||
@@ -39,33 +53,20 @@ Installation | |||
39 | Auf einem dedizierten Webserver (empfohlener Weg) | 53 | Auf einem dedizierten Webserver (empfohlener Weg) |
40 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 54 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
41 | 55 | ||
42 | wallabag nutzt eine große Anzahl an Bibliotheken, um zu funktionieren. Diese Bibliotheken müssen mit einem Tool namens Composer installiert werden. Du musst es installieren sofern du es bisher noch nicht gemacht hast. | ||
43 | |||
44 | Composer installieren: | ||
45 | |||
46 | :: | ||
47 | |||
48 | curl -s http://getcomposer.org/installer | php | ||
49 | |||
50 | Du kannst eine spezifische Anleitung `hier <https://getcomposer.org/doc/00-intro.md>`__ finden. | ||
51 | |||
52 | Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: | 56 | Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: |
53 | 57 | ||
54 | :: | 58 | :: |
55 | 59 | ||
56 | git clone https://github.com/wallabag/wallabag.git | 60 | git clone https://github.com/wallabag/wallabag.git |
57 | cd wallabag | 61 | cd wallabag && make install |
58 | git checkout 2.1.1 --force | ||
59 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist | ||
60 | php bin/console wallabag:install --env=prod | ||
61 | 62 | ||
62 | Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen: | 63 | Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen: |
63 | 64 | ||
64 | :: | 65 | :: |
65 | 66 | ||
66 | php bin/console server:run --env=prod | 67 | make run |
67 | 68 | ||
68 | Und wallabag unter http://deineserverip:8000 erreichen | 69 | und wallabag unter http://deineserverip:8000 erreichen. |
69 | 70 | ||
70 | .. tip:: | 71 | .. tip:: |
71 | 72 | ||
@@ -87,18 +88,18 @@ Führe dieses Kommando aus, um das neueste Paket herunterzuladen und zu entpacke | |||
87 | 88 | ||
88 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | 89 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package |
89 | 90 | ||
90 | (md5 hash: ``6c33520e29cc754b687f9cee0398dede``) | 91 | Du findest die `md5 Hashsumme des neuesten Pakets auf unserer Website <https://www.wallabag.org/pages/download-wallabag.html>`_. |
91 | 92 | ||
92 | Jetzt lese die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf dein wallabag zu. | 93 | Jetzt lies die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf dein wallabag zu. |
93 | Wenn du die Datenbankkonfiguration eingestellt hast, MySQL oder PostgreSQL zu nutzen, musst du einen Nutzer über das folgende Kommando erstellen ``php bin/console wallabag:install --env=prod``. | 94 | Wenn du die Datenbankkonfiguration eingestellt hast, MySQL oder PostgreSQL zu nutzen, musst du einen Nutzer über das folgende Kommando erstellen ``php bin/console wallabag:install --env=prod``. |
94 | 95 | ||
95 | Installation mit Docker | 96 | Installation mit Docker |
96 | ------------------------ | 97 | ~~~~~~~~~~~~~~~~~~~~~~~ |
97 | 98 | ||
98 | Wir stellen ein Docker Image zu Verfügung, um wallabag einfach zu installieren. Schaue in unser Repository in unserem `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__, um mehr Informationen zu erhalten. | 99 | Wir stellen ein Docker Image zu Verfügung, um wallabag einfach zu installieren. Schaue in unser Repository in unserem `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__, um mehr Informationen zu erhalten. |
99 | 100 | ||
100 | Kommando, um den Container zu starten | 101 | Kommando, um den Container zu starten |
101 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 102 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
102 | 103 | ||
103 | .. code-block:: bash | 104 | .. code-block:: bash |
104 | 105 | ||
@@ -108,7 +109,7 @@ Virtualhosts | |||
108 | ------------ | 109 | ------------ |
109 | 110 | ||
110 | Konfiguration von Apache | 111 | Konfiguration von Apache |
111 | ~~~~~~~~~~~~~~~~~~~~~~~ | 112 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
112 | 113 | ||
113 | Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren und du willst PHP als Apache Modul nutzen, dann ist hier ein vhost für wallabag: | 114 | Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren und du willst PHP als Apache Modul nutzen, dann ist hier ein vhost für wallabag: |
114 | 115 | ||
@@ -190,15 +191,14 @@ Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installie | |||
190 | access_log /var/log/nginx/wallabag_access.log; | 191 | access_log /var/log/nginx/wallabag_access.log; |
191 | } | 192 | } |
192 | 193 | ||
193 | Nach dem neuladen oder neustarten von nginx, solltest du nun wallabag unter http://domain.tld erreichen. | 194 | Nach dem Neuladen oder Neustarten von nginx solltest du nun wallabag unter http://domain.tld erreichen. |
194 | 195 | ||
195 | .. tip:: | 196 | .. tip:: |
196 | 197 | ||
197 | When you want to import large file into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``. | ||
198 | Wenn du eine große Datei in wallabag importieren willst, solltest du diese Zeile zu deiner nginx Konfiguration hinzufügen ``client_max_body_size XM; # allows file uploads up to X megabytes``. | 198 | Wenn du eine große Datei in wallabag importieren willst, solltest du diese Zeile zu deiner nginx Konfiguration hinzufügen ``client_max_body_size XM; # allows file uploads up to X megabytes``. |
199 | 199 | ||
200 | Konfiguration von lighttpd | 200 | Konfiguration von lighttpd |
201 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | 201 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ |
202 | 202 | ||
203 | Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren, dann ist hier ein Rezept für wallabag (bearbeite deine ``lighttpd.conf`` und füge die Konfiguration dort ein): | 203 | Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren, dann ist hier ein Rezept für wallabag (bearbeite deine ``lighttpd.conf`` und füge die Konfiguration dort ein): |
204 | 204 | ||
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 @@ | |||
1 | Was 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/de/user/upgrade-2.0.x-2.1.y.rst b/docs/de/user/upgrade-2.0.x-2.1.1.rst index eee50fe4..db81a1be 100644 --- a/docs/de/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/de/user/upgrade-2.0.x-2.1.1.rst | |||
@@ -1,5 +1,5 @@ | |||
1 | Wallabag updaten | 1 | Wallabag von 2.0.x auf 2.1.1 updaten |
2 | ================ | 2 | ==================================== |
3 | 3 | ||
4 | .. warning:: | 4 | .. warning:: |
5 | Wenn du den Import von Pocket durch das Hinzufügen des Consumer Key in den internen Einstellungen konfiguriert hast, fertige bitte ein Backup deines Keys an, bevor du auf das neue Release migrierst: Du wirst den Key nach dem Update in der Konfiguration erneut eintragen müssen. | 5 | Wenn du den Import von Pocket durch das Hinzufügen des Consumer Key in den internen Einstellungen konfiguriert hast, fertige bitte ein Backup deines Keys an, bevor du auf das neue Release migrierst: Du wirst den Key nach dem Update in der Konfiguration erneut eintragen müssen. |
@@ -30,23 +30,43 @@ Lade das neueste Release von wallabag herunter: | |||
30 | 30 | ||
31 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | 31 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package |
32 | 32 | ||
33 | (2.1.1 md5 hash: ``9584a3b60a2b2a4de87f536548caac93``) | 33 | (2.1.1 md5 Hashsumme: ``9584a3b60a2b2a4de87f536548caac93``) |
34 | 34 | ||
35 | Entpacke das Archiv in deinen wallabag-Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. | 35 | Entpacke das Archiv in deinen wallabag-Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. |
36 | 36 | ||
37 | Bitte beachte, dass wir in dieser Version neue Parameter hinzugefügt haben. Du musst die Datei ``app/config/parameters.yml`` bearbeiten und die folgenden Zeilen hinzufügen (ersetze die Werte mit deiner Konfiguration): | 37 | Bitte beachte, dass wir in dieser Version neue Parameter hinzugefügt haben. Du musst die Datei ``app/config/parameters.yml`` bearbeiten und die folgenden Zeilen hinzufügen (ersetze die Werte mit deiner Konfiguration): |
38 | 38 | ||
39 | .. code-block:: bash | 39 | .. code-block:: yml |
40 | 40 | ||
41 | # RabbitMQ processing | 41 | parameters: |
42 | rabbitmq_host: localhost | 42 | database_driver: pdo_sqlite |
43 | rabbitmq_port: 5672 | 43 | database_host: 127.0.0.1 |
44 | rabbitmq_user: guest | 44 | database_port: null |
45 | rabbitmq_password: guest | 45 | database_name: symfony |
46 | 46 | database_user: root | |
47 | # Redis processing | 47 | database_password: null |
48 | redis_host: localhost | 48 | database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite' |
49 | redis_port: 6379 | 49 | database_table_prefix: wallabag_ |
50 | mailer_transport: smtp | ||
51 | mailer_host: 127.0.0.1 | ||
52 | mailer_user: null | ||
53 | mailer_password: null | ||
54 | locale: en | ||
55 | secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv | ||
56 | twofactor_auth: true | ||
57 | twofactor_sender: no-reply@wallabag.org | ||
58 | fosuser_registration: true | ||
59 | fosuser_confirmation: true | ||
60 | from_email: no-reply@wallabag.org | ||
61 | rss_limit: 50 | ||
62 | rabbitmq_host: localhost | ||
63 | rabbitmq_port: 5672 | ||
64 | rabbitmq_user: guest | ||
65 | rabbitmq_password: guest | ||
66 | redis_host: localhost | ||
67 | redis_port: 6379 | ||
68 | |||
69 | Du kannst `hier eine Dokumentation über die Parameter finden <http://doc.wallabag.org/en/master/user/parameters.html>`_. | ||
50 | 70 | ||
51 | Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. | 71 | Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. |
52 | 72 | ||
diff --git a/docs/de/user/upgrade-2.0.x-2.0.y.rst b/docs/de/user/upgrade-2.1.x-2.1.y.rst index 5820a0d2..e638ea9b 100644 --- a/docs/de/user/upgrade-2.0.x-2.0.y.rst +++ b/docs/de/user/upgrade-2.1.x-2.1.y.rst | |||
@@ -1,17 +1,17 @@ | |||
1 | Wallabag updaten 2.0.x -> 2.1.x | 1 | Wallabag von 2.1.x auf 2.1.y updaten |
2 | =============================== | 2 | ==================================== |
3 | 3 | ||
4 | Update auf einem dedizierten Webserver | 4 | Update auf einem dedizierten Webserver |
5 | -------------------------------------- | 5 | -------------------------------------- |
6 | 6 | ||
7 | Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.0.8`` mit der neuesten Releasenummer): | 7 | Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.1.2`` mit der neuesten Releasenummer): |
8 | 8 | ||
9 | :: | 9 | :: |
10 | 10 | ||
11 | rm -rf var/cache/* | 11 | rm -rf var/cache/* |
12 | git fetch origin | 12 | git fetch origin |
13 | git fetch --tags | 13 | git fetch --tags |
14 | git checkout 2.0.8 | 14 | git checkout 2.1.2 --force |
15 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist | 15 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist |
16 | php bin/console cache:clear --env=prod | 16 | php bin/console cache:clear --env=prod |
17 | 17 | ||
@@ -26,7 +26,7 @@ Lade das neueste Release von wallabag herunter: | |||
26 | 26 | ||
27 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | 27 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package |
28 | 28 | ||
29 | (md5 hash: ``4f84c725d1d6e3345eae0a406115e5ff``) | 29 | (md5 Hashsumme von 2.1.1: ``9584a3b60a2b2a4de87f536548caac93``) |
30 | 30 | ||
31 | Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. | 31 | Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. |
32 | 32 | ||
diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst index 83f0bb8f..4828cddd 100644 --- a/docs/en/developer/api.rst +++ b/docs/en/developer/api.rst | |||
@@ -8,7 +8,7 @@ Requirements | |||
8 | 8 | ||
9 | * wallabag freshly (or not) installed on http://localhost:8000 | 9 | * wallabag freshly (or not) installed on http://localhost:8000 |
10 | * ``httpie`` installed on your computer (`see project website <https://github.com/jkbrzt/httpie>`__). Note that you can also adapt the commands using curl or wget. | 10 | * ``httpie`` installed on your computer (`see project website <https://github.com/jkbrzt/httpie>`__). Note that you can also adapt the commands using curl or wget. |
11 | * all the API methods are documented here http://localhost:8000/api/doc | 11 | * all the API methods are documented here http://localhost:8000/api/doc (on your instance) and `on our example instance <http://v2.wallabag.org/api/doc>`_ |
12 | 12 | ||
13 | Creating a new API client | 13 | Creating a new API client |
14 | ------------------------- | 14 | ------------------------- |
diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst index ca0b0f3a..673228e9 100644 --- a/docs/en/developer/rabbitmq.rst +++ b/docs/en/developer/rabbitmq.rst | |||
@@ -46,6 +46,10 @@ Edit your ``parameters.yml`` file to edit RabbitMQ configuration. The default on | |||
46 | rabbitmq_user: guest | 46 | rabbitmq_user: guest |
47 | rabbitmq_password: guest | 47 | rabbitmq_password: guest |
48 | 48 | ||
49 | Enable RabbitMQ in wallabag | ||
50 | --------------------------- | ||
51 | |||
52 | In internal settings, in the **Import** section, enable RabbitMQ (with the value 1). | ||
49 | 53 | ||
50 | Launch RabbitMQ consumer | 54 | Launch RabbitMQ consumer |
51 | ------------------------ | 55 | ------------------------ |
diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst index 005d6e4f..2e2bbbea 100644 --- a/docs/en/developer/redis.rst +++ b/docs/en/developer/redis.rst | |||
@@ -35,6 +35,10 @@ Edit your ``parameters.yml`` file to edit Redis configuration. The default one s | |||
35 | redis_host: localhost | 35 | redis_host: localhost |
36 | redis_port: 6379 | 36 | redis_port: 6379 |
37 | 37 | ||
38 | Enable Redis in wallabag | ||
39 | ------------------------ | ||
40 | |||
41 | In internal settings, in the **Import** section, enable Redis (with the value 1). | ||
38 | 42 | ||
39 | Launch Redis consumer | 43 | Launch Redis consumer |
40 | --------------------- | 44 | --------------------- |
diff --git a/docs/en/developer/testsuite.rst b/docs/en/developer/testsuite.rst new file mode 100644 index 00000000..b2b16cdc --- /dev/null +++ b/docs/en/developer/testsuite.rst | |||
@@ -0,0 +1,10 @@ | |||
1 | Testsuite | ||
2 | ========= | ||
3 | |||
4 | To ensure wallabag development quality, we wrote tests with `PHPUnit <https://phpunit.de>`_. | ||
5 | |||
6 | If you contribute to the project (by translating the application, by fixing bugs or by adding a new feature), please write your own tests. | ||
7 | |||
8 | To launch wallabag testsuite, you need to install `ant <http://ant.apache.org>`_. | ||
9 | |||
10 | Then, execute this command ``make test``. | ||
diff --git a/docs/en/index.rst b/docs/en/index.rst index beb3816e..6d85db2b 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst | |||
@@ -30,8 +30,8 @@ The documentation is available in other languages: | |||
30 | 30 | ||
31 | user/faq | 31 | user/faq |
32 | user/installation | 32 | user/installation |
33 | user/upgrade-2.0.x-2.1.y | 33 | user/upgrade-2.0.x-2.1.1 |
34 | user/upgrade-2.0.x-2.0.y | 34 | user/upgrade-2.1.x-2.1.y |
35 | user/migration | 35 | user/migration |
36 | user/import | 36 | user/import |
37 | user/create_account | 37 | user/create_account |
@@ -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/android.rst b/docs/en/user/android.rst index 4271f037..ccbad264 100644 --- a/docs/en/user/android.rst +++ b/docs/en/user/android.rst | |||
@@ -29,13 +29,13 @@ Fill in your wallabag data. You need to enter your wallabag address. It is impor | |||
29 | :alt: Filled in settings | 29 | :alt: Filled in settings |
30 | :align: center | 30 | :align: center |
31 | 31 | ||
32 | After you have filled in your data, push the button Connection test and wait for the test to finish. | 32 | After you have filled in your data, push the button Connection test and wait for the test to finish. |
33 | 33 | ||
34 | .. image:: ../../img/user/android_configuration_connection_test.en.png | 34 | .. image:: ../../img/user/android_configuration_connection_test.en.png |
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,16 +65,16 @@ 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 | ||
75 | 75 | ||
76 | Known limitations | 76 | Known limitations |
77 | ---- | 77 | ----------------- |
78 | 78 | ||
79 | 2FA | 79 | 2FA |
80 | ~~~ | 80 | ~~~ |
@@ -85,7 +85,7 @@ Currently the does not support two-factor authentication. You should disable tha | |||
85 | Limited amount of articles with wallabag v2 | 85 | Limited amount of articles with wallabag v2 |
86 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 86 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
87 | 87 | ||
88 | In your wallabag web instance you can configure how many items are part of the RSS feed. This option did not exist in wallabag v1, where all articles were part of the feed. So if you set the amount of articles being displayed greater than the number of items being content of your RSS feed, you will only see the number of items in your RSS feed. | 88 | In your wallabag web instance you can configure how many items are part of the RSS feed. This option did not exist in wallabag v1, where all articles were part of the feed. So if you set the amount of articles being displayed greater than the number of items being content of your RSS feed, you will only see the number of items in your RSS feed. |
89 | 89 | ||
90 | 90 | ||
91 | SSL/TLS encryption | 91 | SSL/TLS encryption |
diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst index f4c55dea..f74924df 100644 --- a/docs/en/user/configuration.rst +++ b/docs/en/user/configuration.rst | |||
@@ -100,7 +100,7 @@ if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long r | |||
100 | Which variables and operators can I use to write rules? | 100 | Which variables and operators can I use to write rules? |
101 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 101 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
102 | 102 | ||
103 | The following variables and operators can be used to create tagging rules: | 103 | The following variables and operators can be used to create tagging rules (be careful, for some values, you need to add quotes, for example ``language = "en"``): |
104 | 104 | ||
105 | =========== ============================================== ======== ========== | 105 | =========== ============================================== ======== ========== |
106 | Variable Meaning Operator Meaning | 106 | Variable Meaning Operator Meaning |
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst index 758e3816..70f0187d 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst | |||
@@ -35,7 +35,7 @@ From Readability | |||
35 | Export your Readability data | 35 | Export your Readability data |
36 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 36 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
37 | 37 | ||
38 | On the tools (`https://www.readability.com/tools/<https://www.readability.com/tools/>`_) page, click on "Export your data" in the "Data Export" section. You will received an email to download a json (which does not end with .json in fact). | 38 | On the tools (`https://www.readability.com/tools/ <https://www.readability.com/tools/>`_) page, click on "Export your data" in the "Data Export" section. You will received an email to download a json (which does not end with .json in fact). |
39 | 39 | ||
40 | Import your data into wallabag 2.x | 40 | Import your data into wallabag 2.x |
41 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 41 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
@@ -51,7 +51,7 @@ From Instapaper | |||
51 | Export your Instapaper data | 51 | Export your Instapaper data |
52 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 52 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
53 | 53 | ||
54 | On the settings (`https://www.instapaper.com/user<https://www.instapaper.com/user>`_) page, click on "Download .CSV file" in the "Export" section. A CSV file will be downloaded (like ``instapaper-export.csv``). | 54 | On the settings (`https://www.instapaper.com/user <https://www.instapaper.com/user>`_) page, click on "Download .CSV file" in the "Export" section. A CSV file will be downloaded (like ``instapaper-export.csv``). |
55 | 55 | ||
56 | Import your data into wallabag 2.x | 56 | Import your data into wallabag 2.x |
57 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 57 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 4aaabd82..45e14616 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst | |||
@@ -6,7 +6,21 @@ Requirements | |||
6 | 6 | ||
7 | wallabag is compatible with PHP >= 5.5, including PHP 7. | 7 | wallabag is compatible with PHP >= 5.5, including PHP 7. |
8 | 8 | ||
9 | You'll need the following extensions for wallabag to work. Some of these may already activated in your version of PHP, so you may not have to install all corresponding packages. | 9 | .. note:: |
10 | |||
11 | To install wallabag easily, we provide a ``Makefile``, so you need to have the ``make`` tool. | ||
12 | |||
13 | wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``). | ||
14 | |||
15 | Install Composer: | ||
16 | |||
17 | :: | ||
18 | |||
19 | curl -s http://getcomposer.org/installer | php | ||
20 | |||
21 | You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__. | ||
22 | |||
23 | You'll also need the following extensions for wallabag to work. Some of these may already activated in your version of PHP, so you may not have to install all corresponding packages. | ||
10 | 24 | ||
11 | - php-session | 25 | - php-session |
12 | - php-ctype | 26 | - php-ctype |
@@ -38,31 +52,18 @@ Installation | |||
38 | On a dedicated web server (recommended way) | 52 | On a dedicated web server (recommended way) |
39 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 53 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
40 | 54 | ||
41 | wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``). | ||
42 | |||
43 | Install Composer: | ||
44 | |||
45 | :: | ||
46 | |||
47 | curl -s http://getcomposer.org/installer | php | ||
48 | |||
49 | You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__. | ||
50 | |||
51 | To install wallabag itself, you must run the following commands: | 55 | To install wallabag itself, you must run the following commands: |
52 | 56 | ||
53 | :: | 57 | :: |
54 | 58 | ||
55 | git clone https://github.com/wallabag/wallabag.git | 59 | git clone https://github.com/wallabag/wallabag.git |
56 | cd wallabag | 60 | cd wallabag && make install |
57 | git checkout 2.1.1 --force | ||
58 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist | ||
59 | php bin/console wallabag:install --env=prod | ||
60 | 61 | ||
61 | To start PHP's build-in server and test if everything did install correctly, you can do: | 62 | To start PHP's build-in server and test if everything did install correctly, you can do: |
62 | 63 | ||
63 | :: | 64 | :: |
64 | 65 | ||
65 | php bin/console server:run --env=prod | 66 | make run |
66 | 67 | ||
67 | And access wallabag at http://yourserverip:8000 | 68 | And access wallabag at http://yourserverip:8000 |
68 | 69 | ||
@@ -86,18 +87,18 @@ Execute this command to download and extract the latest package: | |||
86 | 87 | ||
87 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | 88 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package |
88 | 89 | ||
89 | (md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) | 90 | You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_. |
90 | 91 | ||
91 | Now, read the following documentation to create your virtual host, then access your wallabag. | 92 | Now, read the following documentation to create your virtual host, then access your wallabag. |
92 | If you changed the database configuration to use MySQL or PostgreSQL, you need to create a user via this command ``php bin/console wallabag:install --env=prod``. | 93 | If you changed the database configuration to use MySQL or PostgreSQL, you need to create a user via this command ``php bin/console wallabag:install --env=prod``. |
93 | 94 | ||
94 | Installation with Docker | 95 | Installation with Docker |
95 | ------------------------ | 96 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
96 | 97 | ||
97 | We provide you a Docker image to install wallabag easily. Have a look to our repository on `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ to have more information. | 98 | We provide you a Docker image to install wallabag easily. Have a look at our repository on `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ for more information. |
98 | 99 | ||
99 | Command to launch container | 100 | Command to launch container |
100 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 101 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
101 | 102 | ||
102 | .. code-block:: bash | 103 | .. code-block:: bash |
103 | 104 | ||
@@ -193,12 +194,12 @@ After reloading or restarting nginx, you should now be able to access wallabag a | |||
193 | 194 | ||
194 | .. tip:: | 195 | .. tip:: |
195 | 196 | ||
196 | When you want to import large file into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``. | 197 | When you want to import large files into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``. |
197 | 198 | ||
198 | Configuration on lighttpd | 199 | Configuration on lighttpd |
199 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | 200 | ~~~~~~~~~~~~~~~~~~~~~~~~~ |
200 | 201 | ||
201 | Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe for wallabag (edit your ``lighttpd.conf`` file and paste this configuration into it): | 202 | Assuming you install wallabag in the ``/var/www/wallabag`` folder, here's the recipe for wallabag (edit your ``lighttpd.conf`` file and paste this configuration into it): |
202 | 203 | ||
203 | :: | 204 | :: |
204 | 205 | ||
@@ -239,16 +240,16 @@ Rights access to the folders of the project | |||
239 | Test environment | 240 | Test environment |
240 | ~~~~~~~~~~~~~~~~ | 241 | ~~~~~~~~~~~~~~~~ |
241 | 242 | ||
242 | When we just want to test wallabag, we just run the command ``php bin/console server:run --env=prod`` to start our wallabag instance and everything will go smoothly because the user who started the project can access to the current folder naturally, without any problem. | 243 | When we just want to test wallabag, we just run the command ``make run`` to start our wallabag instance and everything will go smoothly because the user who started the project can access to the current folder naturally, without any problem. |
243 | 244 | ||
244 | Production environment | 245 | Production environment |
245 | ~~~~~~~~~~~~~~~~~~~~~~ | 246 | ~~~~~~~~~~~~~~~~~~~~~~ |
246 | 247 | ||
247 | As soon as we use Apache or Nginx to access to our wallabag instance, and not from the command ``php bin/console server:run --env=prod`` to start it, we should take care to grant the good rights on the good folders to keep safe all the folders of the project. | 248 | As soon as we use Apache or Nginx to access to our wallabag instance, and not from the command ``make run`` to start it, we should take care to grant the good rights on the good folders to keep safe all the folders of the project. |
248 | 249 | ||
249 | To do so, the folder name, known as ``DocumentRoot`` (for apache) or ``root`` (for Nginx), has to be absolutely accessible by the Apache/Nginx user. Its name is generally ``www-data``, ``apache`` or ``nobody`` (depending on linux system used). | 250 | To do so, the folder name, known as ``DocumentRoot`` (for apache) or ``root`` (for Nginx), has to be absolutely accessible by the Apache/Nginx user. Its name is generally ``www-data``, ``apache`` or ``nobody`` (depending on linux system used). |
250 | 251 | ||
251 | So the folder ``/var/www/wallabag/web`` has to be accessible by this last one. But this could be not enough if we just care about this folder, because we could meet a blank page or get an error 500 when trying to access to the homepage of the project. | 252 | So the folder ``/var/www/wallabag/web`` has to be accessible by this last one. But this may not be enough if we just care about this folder, because we could meet a blank page or get an error 500 when trying to access to the homepage of the project. |
252 | 253 | ||
253 | This is due to the fact that we will need to grant the same rights access on the folder ``/var/www/wallabag/var`` like those we gave on the folder ``/var/www/wallabag/web``. Thus, we fix this problem with the following command: | 254 | This is due to the fact that we will need to grant the same rights access on the folder ``/var/www/wallabag/var`` like those we gave on the folder ``/var/www/wallabag/web``. Thus, we fix this problem with the following command: |
254 | 255 | ||
diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst new file mode 100644 index 00000000..6cbd5ae4 --- /dev/null +++ b/docs/en/user/parameters.rst | |||
@@ -0,0 +1,50 @@ | |||
1 | What 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 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" | ||
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", "User 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" | ||
diff --git a/docs/en/user/upgrade-2.0.x-2.1.y.rst b/docs/en/user/upgrade-2.0.x-2.1.1.rst index ec353a18..4f9b9cee 100644 --- a/docs/en/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/en/user/upgrade-2.0.x-2.1.1.rst | |||
@@ -1,14 +1,13 @@ | |||
1 | Upgrading from 2.0.x to 2.1.y | 1 | Upgrade from 2.0.x to 2.1.1 |
2 | ============================= | 2 | =========================== |
3 | 3 | ||
4 | .. warning:: | 4 | .. warning:: |
5 | Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade. | 5 | |
6 | Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade. | ||
6 | 7 | ||
7 | Upgrade on a dedicated web server | 8 | Upgrade on a dedicated web server |
8 | --------------------------------- | 9 | --------------------------------- |
9 | 10 | ||
10 | The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.1.1`` by the last release number): | ||
11 | |||
12 | :: | 11 | :: |
13 | 12 | ||
14 | rm -rf var/cache/* | 13 | rm -rf var/cache/* |
@@ -28,25 +27,45 @@ Download the last release of wallabag: | |||
28 | 27 | ||
29 | .. code-block:: bash | 28 | .. code-block:: bash |
30 | 29 | ||
31 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | 30 | wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz |
32 | 31 | ||
33 | (md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) | 32 | (md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) |
34 | 33 | ||
35 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. | 34 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. |
36 | 35 | ||
37 | Please note that we added new parameters in this version. You have to edit ``app/config/parameters.yml`` by adding these lines (replace with your configuration) : | 36 | Please check that your ``app/config/parameters.yml`` contains all the required parameters. Here is a default ``parameters.yml`` file. If you don't know which parameter you need to set, please leave the default one. |
38 | 37 | ||
39 | .. code-block:: bash | 38 | .. code-block:: yml |
40 | 39 | ||
41 | # RabbitMQ processing | 40 | parameters: |
42 | rabbitmq_host: localhost | 41 | database_driver: pdo_sqlite |
43 | rabbitmq_port: 5672 | 42 | database_host: 127.0.0.1 |
44 | rabbitmq_user: guest | 43 | database_port: null |
45 | rabbitmq_password: guest | 44 | database_name: symfony |
46 | 45 | database_user: root | |
47 | # Redis processing | 46 | database_password: null |
48 | redis_host: localhost | 47 | database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite' |
49 | redis_port: 6379 | 48 | database_table_prefix: wallabag_ |
49 | mailer_transport: smtp | ||
50 | mailer_host: 127.0.0.1 | ||
51 | mailer_user: null | ||
52 | mailer_password: null | ||
53 | locale: en | ||
54 | secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv | ||
55 | twofactor_auth: true | ||
56 | twofactor_sender: no-reply@wallabag.org | ||
57 | fosuser_registration: true | ||
58 | fosuser_confirmation: true | ||
59 | from_email: no-reply@wallabag.org | ||
60 | rss_limit: 50 | ||
61 | rabbitmq_host: localhost | ||
62 | rabbitmq_port: 5672 | ||
63 | rabbitmq_user: guest | ||
64 | rabbitmq_password: guest | ||
65 | redis_host: localhost | ||
66 | redis_port: 6379 | ||
67 | |||
68 | You can find `here a documentation about parameters <http://doc.wallabag.org/en/master/user/parameters.html>`_. | ||
50 | 69 | ||
51 | If you use SQLite, you must also copy your ``data/`` folder inside the new installation. | 70 | If you use SQLite, you must also copy your ``data/`` folder inside the new installation. |
52 | 71 | ||
diff --git a/docs/en/user/upgrade-2.0.x-2.0.y.rst b/docs/en/user/upgrade-2.1.x-2.1.y.rst index 3391c2cd..575f4ba9 100644 --- a/docs/en/user/upgrade-2.0.x-2.0.y.rst +++ b/docs/en/user/upgrade-2.1.x-2.1.y.rst | |||
@@ -1,17 +1,17 @@ | |||
1 | Upgrade from 2.0.x to 2.0.y | 1 | Upgrading from 2.1.x to 2.1.y |
2 | =========================== | 2 | ============================= |
3 | 3 | ||
4 | Upgrade on a dedicated web server | 4 | Upgrade on a dedicated web server |
5 | --------------------------------- | 5 | --------------------------------- |
6 | 6 | ||
7 | The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.0.8`` by the last release number): | 7 | The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.1.2`` by the last release number): |
8 | 8 | ||
9 | :: | 9 | :: |
10 | 10 | ||
11 | rm -rf var/cache/* | 11 | rm -rf var/cache/* |
12 | git fetch origin | 12 | git fetch origin |
13 | git fetch --tags | 13 | git fetch --tags |
14 | git checkout 2.0.8 | 14 | git checkout 2.1.2 --force |
15 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist | 15 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist |
16 | php bin/console cache:clear --env=prod | 16 | php bin/console cache:clear --env=prod |
17 | 17 | ||
@@ -26,7 +26,7 @@ Download the last release of wallabag: | |||
26 | 26 | ||
27 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | 27 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package |
28 | 28 | ||
29 | (md5 hash of the 2.0.8 package: ``4f84c725d1d6e3345eae0a406115e5ff``) | 29 | (md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) |
30 | 30 | ||
31 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. | 31 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. |
32 | 32 | ||
diff --git a/docs/fr/developer/rabbitmq.rst b/docs/fr/developer/rabbitmq.rst index 771725a7..92db5a28 100644 --- a/docs/fr/developer/rabbitmq.rst +++ b/docs/fr/developer/rabbitmq.rst | |||
@@ -46,6 +46,10 @@ Modifiez votre fichier ``parameters.yml`` pour éditer la configuration RabbitMQ | |||
46 | rabbitmq_user: guest | 46 | rabbitmq_user: guest |
47 | rabbitmq_password: guest | 47 | rabbitmq_password: guest |
48 | 48 | ||
49 | Activer RabbitMQ dans wallabag | ||
50 | ------------------------------ | ||
51 | |||
52 | Dans les paramètres internes, section **Import**, activez RabbitMQ (avec la valeur 1). | ||
49 | 53 | ||
50 | Démarrer les clients RabbitMQ | 54 | Démarrer les clients RabbitMQ |
51 | ----------------------------- | 55 | ----------------------------- |
diff --git a/docs/fr/developer/redis.rst b/docs/fr/developer/redis.rst index 5557e7a8..8a212e8a 100644 --- a/docs/fr/developer/redis.rst +++ b/docs/fr/developer/redis.rst | |||
@@ -35,6 +35,10 @@ Modifiez votre fichier ``parameters.yml`` pour éditer la configuration Redis. C | |||
35 | redis_host: localhost | 35 | redis_host: localhost |
36 | redis_port: 6379 | 36 | redis_port: 6379 |
37 | 37 | ||
38 | Activer Redis dans wallabag | ||
39 | --------------------------- | ||
40 | |||
41 | Dans les paramètres internes, section **Import**, activez Redis (avec la valeur 1). | ||
38 | 42 | ||
39 | Démarrer les clients Redis | 43 | Démarrer les clients Redis |
40 | -------------------------- | 44 | -------------------------- |
diff --git a/docs/fr/developer/testsuite.rst b/docs/fr/developer/testsuite.rst new file mode 100644 index 00000000..bd5c68c6 --- /dev/null +++ b/docs/fr/developer/testsuite.rst | |||
@@ -0,0 +1,10 @@ | |||
1 | Suite de tests | ||
2 | ============== | ||
3 | |||
4 | Pour assurer la qualité du développement de wallabag, nous avons écrit des tests avec `PHPUnit <https://phpunit.de>`_. | ||
5 | |||
6 | Si vous contribuez au projet (en traduisant l'application, en corrigeant des bugs ou en ajoutant une nouvelle fonctionnalité), merci d'écrire vos propres tests. | ||
7 | |||
8 | Pour lancer la suite de tests de wallabag, vous devez installer `ant <http://ant.apache.org>`_. | ||
9 | |||
10 | Ensuite, exécutez la commande ``make test``. | ||
diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 359b103c..2a265ff3 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst | |||
@@ -31,8 +31,8 @@ La documentation est disponible dans d'autres langues : | |||
31 | 31 | ||
32 | user/faq | 32 | user/faq |
33 | user/installation | 33 | user/installation |
34 | user/upgrade-2.0.x-2.1.y | 34 | user/upgrade-2.0.x-2.1.1 |
35 | user/upgrade-2.0.x-2.0.y | 35 | user/upgrade-2.0.x-2.1.1 |
36 | user/migration | 36 | user/migration |
37 | user/import | 37 | user/import |
38 | user/create_account | 38 | user/create_account |
@@ -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/configuration.rst b/docs/fr/user/configuration.rst index 278f0022..8bfe66f5 100644 --- a/docs/fr/user/configuration.rst +++ b/docs/fr/user/configuration.rst | |||
@@ -102,7 +102,7 @@ if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long r | |||
102 | Quels variables et opérateurs puis-je utiliser pour écrire mes règles ? | 102 | Quels variables et opérateurs puis-je utiliser pour écrire mes règles ? |
103 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 103 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
104 | 104 | ||
105 | Les variables et opérateurs suivants peuvent être utilisés lors de la création de vos règles : | 105 | Les variables et opérateurs suivants peuvent être utilisés lors de la création de vos règles (attention, pour certaines valeurs, vous devez ajouter des guillemets, par exemple ``language = "en"``) : |
106 | 106 | ||
107 | =========== ============================================== ========== ========== | 107 | =========== ============================================== ========== ========== |
108 | Variable Sens Opérateur Sens | 108 | Variable Sens Opérateur Sens |
diff --git a/docs/fr/user/import.rst b/docs/fr/user/import.rst index 6f114dd6..2e6caafb 100644 --- a/docs/fr/user/import.rst +++ b/docs/fr/user/import.rst | |||
@@ -36,7 +36,7 @@ Depuis Readability | |||
36 | Exportez vos données de Readability | 36 | Exportez vos données de Readability |
37 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 37 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
38 | 38 | ||
39 | Sur la page des outils (`https://www.readability.com/tools/<https://www.readability.com/tools/>`_), cliquez sur "Export your data" dans la section "Data Export". Vous allez recevoir un email avec un lien pour télécharger le json. | 39 | Sur la page des outils (`https://www.readability.com/tools/ <https://www.readability.com/tools/>`_), cliquez sur "Export your data" dans la section "Data Export". Vous allez recevoir un email avec un lien pour télécharger le json. |
40 | 40 | ||
41 | Importez vos données dans wallabag 2.x | 41 | Importez vos données dans wallabag 2.x |
42 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 42 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
@@ -52,7 +52,7 @@ Depuis Instapaper | |||
52 | Exportez vos données de Instapaper | 52 | Exportez vos données de Instapaper |
53 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 53 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
54 | 54 | ||
55 | Sur la page des paramètres (`https://www.instapaper.com/user<https://www.instapaper.com/user>`_), cliquez sur "Download .CSV file" dans la section "Export". Un fichier CSV se téléchargera (``instapaper-export.csv``). | 55 | Sur la page des paramètres (`https://www.instapaper.com/user <https://www.instapaper.com/user>`_), cliquez sur "Download .CSV file" dans la section "Export". Un fichier CSV se téléchargera (``instapaper-export.csv``). |
56 | 56 | ||
57 | Importez vos données dans wallabag 2.x | 57 | Importez vos données dans wallabag 2.x |
58 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 58 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index 9dd39af7..4f94d6c8 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst | |||
@@ -6,6 +6,20 @@ Pré-requis | |||
6 | 6 | ||
7 | wallabag est compatible avec PHP >= 5.5, PHP 7 inclus. | 7 | wallabag est compatible avec PHP >= 5.5, PHP 7 inclus. |
8 | 8 | ||
9 | .. note:: | ||
10 | |||
11 | Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``. | ||
12 | |||
13 | wallabag utilise un grand nombre de bibliothèques PHP pour fonctionner. Ces bibliothèques doivent être installées à l'aide d'un outil nommé Composer. Vous devez l'installer si ce n'est déjà fait et vous assurer que vous utilisez bien la version 1.2 (si vous avez déjà Composer, faite un ``composer selfupdate``). | ||
14 | |||
15 | Installation de Composer : | ||
16 | |||
17 | :: | ||
18 | |||
19 | curl -s http://getcomposer.org/installer | php | ||
20 | |||
21 | Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__. | ||
22 | |||
9 | Vous aurez besoin des extensions suivantes pour que wallabag fonctionne. Il est possible que certaines de ces extensions soient déjà activées dans votre version de PHP, donc vous n'avez pas forcément besoin d'installer tous les paquets correspondants. | 23 | Vous aurez besoin des extensions suivantes pour que wallabag fonctionne. Il est possible que certaines de ces extensions soient déjà activées dans votre version de PHP, donc vous n'avez pas forcément besoin d'installer tous les paquets correspondants. |
10 | 24 | ||
11 | - php-session | 25 | - php-session |
@@ -36,36 +50,23 @@ Installation | |||
36 | Sur un serveur dédié (méthode conseillée) | 50 | Sur un serveur dédié (méthode conseillée) |
37 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 51 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
38 | 52 | ||
39 | wallabag utilise un grand nombre de bibliothèques PHP pour fonctionner. Ces bibliothèques doivent être installées à l'aide d'un outil nommé Composer. Vous devez l'installer si ce n'est déjà fait et vous assurer que vous utilisez bien la version 1.2 (si vous avez déjà Composer, faite un ``composer selfupdate``). | ||
40 | |||
41 | Installation de Composer : | ||
42 | |||
43 | :: | ||
44 | |||
45 | curl -s http://getcomposer.org/installer | php | ||
46 | |||
47 | Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__. | ||
48 | |||
49 | Pour installer wallabag, vous devez exécuter ces commandes : | 53 | Pour installer wallabag, vous devez exécuter ces commandes : |
50 | 54 | ||
51 | :: | 55 | :: |
52 | 56 | ||
53 | git clone https://github.com/wallabag/wallabag.git | 57 | git clone https://github.com/wallabag/wallabag.git |
54 | cd wallabag | 58 | cd wallabag && make install |
55 | git checkout 2.1.1 --force | ||
56 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist | ||
57 | php bin/console wallabag:install --env=prod | ||
58 | 59 | ||
59 | Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : | 60 | Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : |
60 | 61 | ||
61 | :: | 62 | :: |
62 | 63 | ||
63 | php bin/console server:run --env=prod | 64 | make run |
64 | 65 | ||
65 | Et accéder wallabag à l'adresse http://lipdevotreserveur:8000 | 66 | Et accéder wallabag à l'adresse http://lipdevotreserveur:8000 |
66 | 67 | ||
67 | .. tip:: | 68 | .. tip:: |
68 | Pour définir des paramètres via des variables d'environnement, vous pouvez les spécifier avec le préfixe ``SYMFONY__``. Par exemple, ``SYMFONY__DATABASE_DRIVER``. Vous pouvez lire `documentation Symfony <http://symfony.com/doc/current/cookbook/configuration/external_parameters.html>`__ pour en savoir plus. | 69 | Pour définir des paramètres via des variables d'environnement, vous pouvez les spécifier avec le préfixe ``SYMFONY__``. Par exemple, ``SYMFONY__DATABASE_DRIVER``. Vous pouvez lire la `documentation Symfony <http://symfony.com/doc/current/cookbook/configuration/external_parameters.html>`__ pour en savoir plus. |
69 | 70 | ||
70 | Sur un serveur mutualisé | 71 | Sur un serveur mutualisé |
71 | ~~~~~~~~~~~~~~~~~~~~~~~~ | 72 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
@@ -83,18 +84,18 @@ Exécutez cette commande pour télécharger et décompresser l'archive : | |||
83 | 84 | ||
84 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | 85 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package |
85 | 86 | ||
86 | (hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``) | 87 | Vous trouverez `le hash md5 du dernier package sur notre site <https://www.wallabag.org/pages/download-wallabag.html>`_. |
87 | 88 | ||
88 | Maintenant, lisez la documentation ci-dessous pour crééer un virtual host. Accédez ensuite à votre installation de wallabag. | 89 | Maintenant, lisez la documentation ci-dessous pour crééer un virtual host. Accédez ensuite à votre installation de wallabag. |
89 | Si vous avez changé la configuration pour modifier le type de stockage (MySQL ou PostgreSQL), vous devrez vous créer un utilisateur via la commande ``php bin/console wallabag:install --env=prod``. | 90 | Si vous avez changé la configuration pour modifier le type de stockage (MySQL ou PostgreSQL), vous devrez vous créer un utilisateur via la commande ``php bin/console wallabag:install --env=prod``. |
90 | 91 | ||
91 | Installation avec Docker | 92 | Installation avec Docker |
92 | ------------------------ | 93 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
93 | 94 | ||
94 | Nous vous proposons une image Docker pour installer wallabag facilement. Allez voir du côté de `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ pour plus d'informations. | 95 | Nous vous proposons une image Docker pour installer wallabag facilement. Allez voir du côté de `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ pour plus d'informations. |
95 | 96 | ||
96 | Commande pour démarrer le containeur | 97 | Commande pour démarrer le containeur |
97 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 98 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
98 | 99 | ||
99 | .. code-block:: bash | 100 | .. code-block:: bash |
100 | 101 | ||
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" | ||
diff --git a/docs/fr/user/upgrade-2.0.x-2.1.y.rst b/docs/fr/user/upgrade-2.0.x-2.1.1.rst index 952fa737..ec883d10 100644 --- a/docs/fr/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/fr/user/upgrade-2.0.x-2.1.1.rst | |||
@@ -1,4 +1,4 @@ | |||
1 | Mettre à jour de la 2.0.x à la 2.1.y | 1 | Mettre à jour de la 2.0.x à la 2.1.1 |
2 | ==================================== | 2 | ==================================== |
3 | 3 | ||
4 | .. warning:: | 4 | .. warning:: |
@@ -7,8 +7,6 @@ Avant cette migration, si vous aviez configuré l'import depuis Pocket en ajouta | |||
7 | Mise à jour sur un serveur dédié | 7 | Mise à jour sur un serveur dédié |
8 | -------------------------------- | 8 | -------------------------------- |
9 | 9 | ||
10 | La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.1.1`` par le numéro de la dernière version) : | ||
11 | |||
12 | :: | 10 | :: |
13 | 11 | ||
14 | rm -rf var/cache/* | 12 | rm -rf var/cache/* |
@@ -28,25 +26,45 @@ Téléchargez la dernière version de wallabag : | |||
28 | 26 | ||
29 | .. code-block:: bash | 27 | .. code-block:: bash |
30 | 28 | ||
31 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | 29 | wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz |
32 | 30 | ||
33 | (hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``) | 31 | (hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``) |
34 | 32 | ||
35 | Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. | 33 | Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. |
36 | 34 | ||
37 | Nous avons ajouté de nouveaux paramètres dans cette nouvelle version. Vous devez donc éditer le fichier ``app/config/parameters.yml`` en ajoutant ces lignes (et en remplaçant par votre configuration) : | 35 | Vérifiez que votre fichier ``app/config/parameters.yml`` contient tous les paramètres requis. Voici un fichier ``parameters.yml`` par défaut. Si vous ne savez pas quelle valeur mettre à un paramètre, laissez la valeur par défaut. |
38 | 36 | ||
39 | .. code-block:: bash | 37 | .. code-block:: yml |
40 | 38 | ||
41 | # RabbitMQ processing | 39 | parameters: |
42 | rabbitmq_host: localhost | 40 | database_driver: pdo_sqlite |
43 | rabbitmq_port: 5672 | 41 | database_host: 127.0.0.1 |
44 | rabbitmq_user: guest | 42 | database_port: null |
45 | rabbitmq_password: guest | 43 | database_name: symfony |
46 | 44 | database_user: root | |
47 | # Redis processing | 45 | database_password: null |
48 | redis_host: localhost | 46 | database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite' |
49 | redis_port: 6379 | 47 | database_table_prefix: wallabag_ |
48 | mailer_transport: smtp | ||
49 | mailer_host: 127.0.0.1 | ||
50 | mailer_user: null | ||
51 | mailer_password: null | ||
52 | locale: en | ||
53 | secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv | ||
54 | twofactor_auth: true | ||
55 | twofactor_sender: no-reply@wallabag.org | ||
56 | fosuser_registration: true | ||
57 | fosuser_confirmation: true | ||
58 | from_email: no-reply@wallabag.org | ||
59 | rss_limit: 50 | ||
60 | rabbitmq_host: localhost | ||
61 | rabbitmq_port: 5672 | ||
62 | rabbitmq_user: guest | ||
63 | rabbitmq_password: guest | ||
64 | redis_host: localhost | ||
65 | redis_port: 6379 | ||
66 | |||
67 | Vous trouverez `ici une documentation détaillée concernant les paramètres <http://doc.wallabag.org/fr/master/user/parameters.html>`_. | ||
50 | 68 | ||
51 | Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. | 69 | Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. |
52 | 70 | ||
diff --git a/docs/fr/user/upgrade-2.0.x-2.0.y.rst b/docs/fr/user/upgrade-2.1.x-2.1.y.rst index 8d8ad806..c048099f 100644 --- a/docs/fr/user/upgrade-2.0.x-2.0.y.rst +++ b/docs/fr/user/upgrade-2.1.x-2.1.y.rst | |||
@@ -1,17 +1,17 @@ | |||
1 | Mettre à jour de la 2.0.x à la 2.0.y | 1 | Mettre à jour de la 2.1.x à la 2.1.y |
2 | ==================================== | 2 | ==================================== |
3 | 3 | ||
4 | Mise à jour sur un serveur dédié | 4 | Mise à jour sur un serveur dédié |
5 | -------------------------------- | 5 | -------------------------------- |
6 | 6 | ||
7 | La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.0.8`` par le numéro de la dernière version) : | 7 | La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.1.2`` par le numéro de la dernière version) : |
8 | 8 | ||
9 | :: | 9 | :: |
10 | 10 | ||
11 | rm -rf var/cache/* | 11 | rm -rf var/cache/* |
12 | git fetch origin | 12 | git fetch origin |
13 | git fetch --tags | 13 | git fetch --tags |
14 | git checkout 2.0.8 | 14 | git checkout 2.1.2 --force |
15 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist | 15 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist |
16 | php bin/console cache:clear --env=prod | 16 | php bin/console cache:clear --env=prod |
17 | 17 | ||
@@ -26,7 +26,7 @@ Téléchargez la dernière version de wallabag : | |||
26 | 26 | ||
27 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | 27 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package |
28 | 28 | ||
29 | (hash md5 de l'archive 2.0.8 : ``4f84c725d1d6e3345eae0a406115e5ff``) | 29 | (hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``) |
30 | 30 | ||
31 | Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. | 31 | Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. |
32 | 32 | ||