aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/de/index.rst6
-rw-r--r--docs/de/user/backup.rst25
-rw-r--r--docs/de/user/configuration.rst2
-rw-r--r--docs/de/user/parameters.rst50
-rw-r--r--docs/de/user/upgrade-2.0.x-2.1.1.rst (renamed from docs/de/user/upgrade-2.0.x-2.1.y.rst)48
-rw-r--r--docs/de/user/upgrade-2.1.x-2.1.y.rst (renamed from docs/de/user/upgrade-2.0.x-2.0.y.rst)10
-rw-r--r--docs/en/developer/api.rst2
-rw-r--r--docs/en/developer/redis.rst2
-rw-r--r--docs/en/index.rst2
-rw-r--r--docs/en/user/android.rst2
-rw-r--r--docs/en/user/backup.rst25
-rw-r--r--docs/en/user/configuration.rst2
-rw-r--r--docs/en/user/installation.rst10
-rw-r--r--docs/en/user/parameters.rst4
-rw-r--r--docs/en/user/upgrade-2.0.x-2.1.1.rst5
-rw-r--r--docs/en/user/upgrade-2.1.x-2.1.y.rst2
-rw-r--r--docs/fr/index.rst6
-rw-r--r--docs/fr/user/backup.rst26
-rw-r--r--docs/fr/user/configuration.rst2
-rw-r--r--docs/fr/user/installation.rst2
-rw-r--r--docs/fr/user/parameters.rst50
-rw-r--r--docs/fr/user/upgrade-2.0.x-2.1.1.rst (renamed from docs/fr/user/upgrade-2.0.x-2.1.y.rst)52
-rw-r--r--docs/fr/user/upgrade-2.1.x-2.1.y.rst (renamed from docs/fr/user/upgrade-2.0.x-2.0.y.rst)8
23 files changed, 283 insertions, 60 deletions
diff --git a/docs/de/index.rst b/docs/de/index.rst
index b3cd33b0..b422bf83 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,8 @@ 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
48 user/backup
47 49
48.. _dev-docs: 50.. _dev-docs:
49 51
diff --git a/docs/de/user/backup.rst b/docs/de/user/backup.rst
new file mode 100644
index 00000000..ffe3ce37
--- /dev/null
+++ b/docs/de/user/backup.rst
@@ -0,0 +1,25 @@
1wallabag sichern
2================
3Da es manchmal vorkommen kann, dass dir ein Fehler mit deiner wallabag unterläuft und du Daten verlierst oder deine wallabag auf einen anderen Server verschieben willst, ist eine Sicherung der Daten sicher ratsam.
4Dieser Artikel beschreibt, was du für die Sicherung benötigst.
5
6Grundlegende Einstellungen
7--------------------------
8wallabag speichert grundlegende Parameter (etwa der SMTP-Server oder das Datenbank-Backend) in der Datei `app/config/parameters.yml`.
9
10Datenbank
11---------
12Da wallabag verschiedene Datenbank-Typen unterstützt, hängt der Weg der Sicherung von dem verwendeten Typ ab. Daher verweisen wir an dieser Stelle auf die entsprechenden Dokumentationen:
13
14Hier sind einige Beispiele:
15
16- MySQL: http://dev.mysql.com/doc/refman/5.7/en/backup-methods.html
17- PostgreSQL: https://www.postgresql.org/docs/current/static/backup.html
18
19SQLite
20~~~~~~
21Um die SQLite-Datenbank zu sichern, ist es lediglich notwendig, das Verzeichnis `data/db` aus dem wallabag-Installations-Ordner zu kopieren.
22
23Bilder
24------
25Die Bilder, die von wallabag empfangen worden, sind unter `data/assets/images` gespeichert (der Bilder-Speicher wird in wallabag 2.2 implementiert).
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
102Welche Variablen und Operatoren kann ich zum Regeln schreiben nutzen? 102Welche Variablen und Operatoren kann ich zum Regeln schreiben nutzen?
103~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 103~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104 104
105Die folgenden Variabel und Operatoren können genutzt werden, um Tagging-Regeln zu erstellen: 105Die 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=========== ============================================== ======== ==========
108Variable Bedeutung Operator Bedeutung 108Variable Bedeutung Operator Bedeutung
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/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 @@
1Wallabag updaten 1Wallabag von 2.0.x auf 2.1.1 updaten
2================ 2====================================
3 3
4.. warning:: 4.. warning::
5Wenn 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. 5Wenn 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
35Entpacke das Archiv in deinen wallabag-Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. 35Entpacke das Archiv in deinen wallabag-Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei.
36 36
37Bitte 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): 37Bitte 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
69Du kannst `hier eine Dokumentation über die Parameter finden <http://doc.wallabag.org/en/master/user/parameters.html>`_.
50 70
51Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. 71Wenn 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..2f9b7791 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 @@
1Wallabag updaten 2.0.x -> 2.1.x 1Wallabag von 2.1.x auf 2.1.y updaten
2=============================== 2====================================
3 3
4Update auf einem dedizierten Webserver 4Update auf einem dedizierten Webserver
5-------------------------------------- 5--------------------------------------
6 6
7Das 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): 7Das 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``) 29Du findest die `md5 Hashsumme des neuesten Pakets auf unserer Website <https://www.wallabag.org/pages/download-wallabag.html>`_.
30 30
31Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. 31Entpacke 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
13Creating a new API client 13Creating a new API client
14------------------------- 14-------------------------
diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst
index 67b6452e..2e2bbbea 100644
--- a/docs/en/developer/redis.rst
+++ b/docs/en/developer/redis.rst
@@ -35,7 +35,7 @@ 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
38Enable Redos in wallabag 38Enable Redis in wallabag
39------------------------ 39------------------------
40 40
41In internal settings, in the **Import** section, enable Redis (with the value 1). 41In internal settings, in the **Import** section, enable Redis (with the value 1).
diff --git a/docs/en/index.rst b/docs/en/index.rst
index 4e346ae6..0ead261b 100644
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -45,6 +45,8 @@ 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
49 user/backup
48 50
49.. _dev-docs: 51.. _dev-docs:
50 52
diff --git a/docs/en/user/android.rst b/docs/en/user/android.rst
index ccbad264..91dcb2fc 100644
--- a/docs/en/user/android.rst
+++ b/docs/en/user/android.rst
@@ -79,7 +79,7 @@ Known limitations
792FA 792FA
80~~~ 80~~~
81 81
82Currently the does not support two-factor authentication. You should disable that to get the app working. 82Currently the Android application does not support two-factor authentication. You should disable that to get the application working.
83 83
84 84
85Limited amount of articles with wallabag v2 85Limited amount of articles with wallabag v2
diff --git a/docs/en/user/backup.rst b/docs/en/user/backup.rst
new file mode 100644
index 00000000..51721000
--- /dev/null
+++ b/docs/en/user/backup.rst
@@ -0,0 +1,25 @@
1Backup wallabag
2===============
3Because sometimes you may do a mistake with your wallabag and lose data or in case you need to move your wallabag to another server you want to backup your data.
4This articles describes what you need to backup.
5
6Basic settings
7--------------
8wallabag stores some basic parameters (like SMTP server or database backend) in the file `app/config/parameters.yml`.
9
10Database
11--------
12As wallabag supports different kinds of database, the way to perform the backup depends on the database you use, so you need to refer to the vendor documentation.
13
14Here's some examples:
15
16- MySQL: http://dev.mysql.com/doc/refman/5.7/en/backup-methods.html
17- PostgreSQL: https://www.postgresql.org/docs/current/static/backup.html
18
19SQLite
20~~~~~~
21To backup the SQLite database, you just need to copy the directory `data/db` from the wallabag application directory.
22
23Images
24------
25The images retrieved by wallabag are stored under `data/assets/images` (the images storage will be implemented in wallabag 2.2).
diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst
index 824878dc..e7055a14 100644
--- a/docs/en/user/configuration.rst
+++ b/docs/en/user/configuration.rst
@@ -102,7 +102,7 @@ if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long r
102Which variables and operators can I use to write rules? 102Which variables and operators can I use to write rules?
103~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 103~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104 104
105The following variables and operators can be used to create tagging rules: 105The 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"``):
106 106
107=========== ============================================== ======== ========== 107=========== ============================================== ======== ==========
108Variable Meaning Operator Meaning 108Variable Meaning Operator Meaning
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index 248c1995..45e14616 100644
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -8,7 +8,7 @@ wallabag is compatible with PHP >= 5.5, including PHP 7.
8 8
9.. note:: 9.. note::
10 10
11 To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. 11 To install wallabag easily, we provide a ``Makefile``, so you need to have the ``make`` tool.
12 12
13wallabag 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``). 13wallabag 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 14
@@ -95,7 +95,7 @@ If you changed the database configuration to use MySQL or PostgreSQL, you need t
95Installation with Docker 95Installation with Docker
96~~~~~~~~~~~~~~~~~~~~~~~~ 96~~~~~~~~~~~~~~~~~~~~~~~~
97 97
98We 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. 98We 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.
99 99
100Command to launch container 100Command to launch container
101^^^^^^^^^^^^^^^^^^^^^^^^^^^ 101^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -194,12 +194,12 @@ After reloading or restarting nginx, you should now be able to access wallabag a
194 194
195.. tip:: 195.. tip::
196 196
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``. 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``.
198 198
199Configuration on lighttpd 199Configuration on lighttpd
200~~~~~~~~~~~~~~~~~~~~~~~~~ 200~~~~~~~~~~~~~~~~~~~~~~~~~
201 201
202Assuming 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): 202Assuming 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):
203 203
204:: 204::
205 205
@@ -249,7 +249,7 @@ As soon as we use Apache or Nginx to access to our wallabag instance, and not fr
249 249
250To 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). 250To 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).
251 251
252So 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. 252So 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.
253 253
254This 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: 254This 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:
255 255
diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst
index 2fca020e..c35cf3b8 100644
--- a/docs/en/user/parameters.rst
+++ b/docs/en/user/parameters.rst
@@ -9,7 +9,7 @@ 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 "database_charset", "utf8mb4", "For PostgreSQL & SQLite you should use utf8, for MySQL use utf8mb4 which handle emoji" 15 "database_charset", "utf8mb4", "For PostgreSQL & SQLite you should use utf8, for MySQL use utf8mb4 which handle emoji"
@@ -39,7 +39,7 @@ What is the meaning of the parameters?
39 39
40 "rabbitmq_host", "localhost", "Host of your RabbitMQ" 40 "rabbitmq_host", "localhost", "Host of your RabbitMQ"
41 "rabbitmq_port", "5672", "Port of your RabbitMQ" 41 "rabbitmq_port", "5672", "Port of your RabbitMQ"
42 "rabbitmq_user", "guest", "Usee that can read queues" 42 "rabbitmq_user", "guest", "User that can read queues"
43 "rabbitmq_password", "guest", "Password of that user" 43 "rabbitmq_password", "guest", "Password of that user"
44 44
45.. csv-table:: Redis configuration 45.. csv-table:: Redis configuration
diff --git a/docs/en/user/upgrade-2.0.x-2.1.1.rst b/docs/en/user/upgrade-2.0.x-2.1.1.rst
index 2f08b7bd..4f9b9cee 100644
--- a/docs/en/user/upgrade-2.0.x-2.1.1.rst
+++ b/docs/en/user/upgrade-2.0.x-2.1.1.rst
@@ -2,7 +2,8 @@ Upgrade from 2.0.x to 2.1.1
2=========================== 2===========================
3 3
4.. warning:: 4.. warning::
5Before 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
7Upgrade on a dedicated web server 8Upgrade on a dedicated web server
8--------------------------------- 9---------------------------------
@@ -64,6 +65,8 @@ Please check that your ``app/config/parameters.yml`` contains all the required p
64 redis_host: localhost 65 redis_host: localhost
65 redis_port: 6379 66 redis_port: 6379
66 67
68You can find `here a documentation about parameters <http://doc.wallabag.org/en/master/user/parameters.html>`_.
69
67If you use SQLite, you must also copy your ``data/`` folder inside the new installation. 70If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
68 71
69Empty ``var/cache`` folder. 72Empty ``var/cache`` folder.
diff --git a/docs/en/user/upgrade-2.1.x-2.1.y.rst b/docs/en/user/upgrade-2.1.x-2.1.y.rst
index 575f4ba9..62cb7dc0 100644
--- a/docs/en/user/upgrade-2.1.x-2.1.y.rst
+++ b/docs/en/user/upgrade-2.1.x-2.1.y.rst
@@ -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.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) 29You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
30 30
31Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. 31Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
32 32
diff --git a/docs/fr/index.rst b/docs/fr/index.rst
index 359b103c..dbb85910 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,8 @@ 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
49 user/backup
48 50
49.. _dev-docs: 51.. _dev-docs:
50 52
diff --git a/docs/fr/user/backup.rst b/docs/fr/user/backup.rst
new file mode 100644
index 00000000..ec4b1f4d
--- /dev/null
+++ b/docs/fr/user/backup.rst
@@ -0,0 +1,26 @@
1Sauvegarde de wallabag
2======================
3
4Parce que des fois vous faites des erreurs avec votre installation de wallabag et vous perdez des données ou parce que vous souhaitez migrer votre installation sur un autre serveur, vous souhaitez faire une sauvegarde de vos données.
5Cette documentation décrit ce que vous devez sauvegarder.
6
7Configuration
8-------------
9wallabag stocke quelques paramètres (comme la configuration SMTP ou les infos de bases de données) dans le fichier `app/config/parameters.yml`.
10
11Base de données
12---------------
13Comme wallabag supporte différentes sortes de bases de données, la manière de sauvegarder dépend du type de base de données que vous utilisez, donc vous devez vous en référez à la documentation correspondante.
14
15Quelques exemples :
16
17- MySQL: http://dev.mysql.com/doc/refman/5.7/en/backup-methods.html
18- PostgreSQL: https://www.postgresql.org/docs/current/static/backup.html
19
20SQLite
21~~~~~~
22Pour sauvegarder une base SQLite, vous devez juste copier le répertoire `data/db` de votre installation wallabag.
23
24Images
25------
26Les images sauvegardées par wallabag sont stockées dans `data/assets/images` (le stockage des images sera implémenté dans wallabag 2.2).
diff --git a/docs/fr/user/configuration.rst b/docs/fr/user/configuration.rst
index 2654e8ad..90eece11 100644
--- a/docs/fr/user/configuration.rst
+++ b/docs/fr/user/configuration.rst
@@ -104,7 +104,7 @@ if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long r
104Quels variables et opérateurs puis-je utiliser pour écrire mes règles ? 104Quels variables et opérateurs puis-je utiliser pour écrire mes règles ?
105~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 105~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106 106
107Les variables et opérateurs suivants peuvent être utilisés lors de la création de vos règles : 107Les 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"``) :
108 108
109=========== ============================================== ========== ========== 109=========== ============================================== ========== ==========
110Variable Sens Opérateur Sens 110Variable Sens Opérateur Sens
diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst
index 62e7d334..4f94d6c8 100644
--- a/docs/fr/user/installation.rst
+++ b/docs/fr/user/installation.rst
@@ -66,7 +66,7 @@ Pour démarrer le serveur interne à php et vérifier que tout s'est installé c
66Et accéder wallabag à l'adresse http://lipdevotreserveur:8000 66Et accéder wallabag à l'adresse http://lipdevotreserveur:8000
67 67
68.. tip:: 68.. tip::
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 `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.
70 70
71Sur un serveur mutualisé 71Sur un serveur mutualisé
72~~~~~~~~~~~~~~~~~~~~~~~~ 72~~~~~~~~~~~~~~~~~~~~~~~~
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 @@
1Mettre à jour de la 2.0.x à la 2.1.y 1Mettre à 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
7Mise à jour sur un serveur dédié 7Mise à jour sur un serveur dédié
8-------------------------------- 8--------------------------------
9 9
10La 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
35Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. 33Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre.
36 34
37Nous 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) : 35Vé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
67Vous trouverez `ici une documentation détaillée concernant les paramètres <http://doc.wallabag.org/fr/master/user/parameters.html>`_.
50 68
51Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. 69Si 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..b6f1a2d0 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 @@
1Mettre à jour de la 2.0.x à la 2.0.y 1Mettre à jour de la 2.1.x à la 2.1.y
2==================================== 2====================================
3 3
4Mise à jour sur un serveur dédié 4Mise à jour sur un serveur dédié
5-------------------------------- 5--------------------------------
6 6
7La 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) : 7La 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``) 29Vous trouverez `le hash md5 du dernier package sur notre site <https://www.wallabag.org/pages/download-wallabag.html>`_.
30 30
31Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. 31Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre.
32 32