aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorJeremy Benoist <jeremy.benoist@gmail.com>2016-10-11 21:01:30 +0200
committerJeremy Benoist <jeremy.benoist@gmail.com>2016-10-11 21:01:30 +0200
commite4cf672ccf61689ba28c2e89fc55f83167800b18 (patch)
tree5dc22c97797bdcdd0a3d2a7e182410f04a748c1e /docs
parente57df5611fe82ce61a71d51c762ee9296f18c3ac (diff)
parentdbe94e73a9eaf3acb250812913b0303b35d01a2e (diff)
downloadwallabag-e4cf672ccf61689ba28c2e89fc55f83167800b18.tar.gz
wallabag-e4cf672ccf61689ba28c2e89fc55f83167800b18.tar.zst
wallabag-e4cf672ccf61689ba28c2e89fc55f83167800b18.zip
Merge remote-tracking branch 'origin/master' into 2.2
Diffstat (limited to 'docs')
-rw-r--r--docs/de/developer/rabbitmq.rst4
-rw-r--r--docs/de/developer/redis.rst4
-rw-r--r--docs/de/developer/testsuite.rst10
-rw-r--r--docs/de/user/installation.rst48
-rw-r--r--docs/en/developer/rabbitmq.rst4
-rw-r--r--docs/en/developer/redis.rst4
-rw-r--r--docs/en/developer/testsuite.rst10
-rw-r--r--docs/en/index.rst4
-rw-r--r--docs/en/user/android.rst12
-rw-r--r--docs/en/user/import.rst4
-rw-r--r--docs/en/user/installation.rst43
-rw-r--r--docs/en/user/parameters.rst50
-rw-r--r--docs/en/user/upgrade-2.0.x-2.1.1.rst (renamed from docs/en/user/upgrade-2.0.x-2.1.y.rst)52
-rw-r--r--docs/en/user/upgrade-2.1.x-2.1.y.rst (renamed from docs/en/user/upgrade-2.0.x-2.0.y.rst)10
-rw-r--r--docs/fr/developer/rabbitmq.rst4
-rw-r--r--docs/fr/developer/redis.rst4
-rw-r--r--docs/fr/developer/testsuite.rst10
-rw-r--r--docs/fr/user/import.rst4
-rw-r--r--docs/fr/user/installation.rst37
19 files changed, 220 insertions, 98 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
49Enable RabbitMQ in wallabag
50---------------------------
51
52In internal settings, in the **Import** section, enable RabbitMQ (with the value 1).
49 53
50Starte den RabbitMQ Consumer 54Starte 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
38Enable Redis in wallabag
39------------------------
40
41In internal settings, in the **Import** section, enable Redis (with the value 1).
38 42
39Starte den Redis Consumer 43Starte 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 @@
1Testsuite
2=========
3
4To ensure wallabag development quality, we wrote tests with `PHPUnit <https://phpunit.de>`_.
5
6If you contribute to the project (by translating the application, by fixing bugs or by adding a new feature), please write your own tests.
7
8To launch wallabag testsuite, you need to install `ant <http://ant.apache.org>`_.
9
10Then, execute this command ``make test``.
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
7wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7. 7wallabag 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
13wallabag 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
15Composer installieren:
16
17::
18
19 curl -s http://getcomposer.org/installer | php
20
21Du kannst eine spezifische Anleitung `hier <https://getcomposer.org/doc/00-intro.md>`__ finden.
22
9Du benötigst die folgenden Extensions damit wallabag funktioniert. Einige von diesen sind vielleicht schon in deiner Version von PHP aktiviert, somit musst du eventuell 23Du benötigst die folgenden Extensions damit wallabag funktioniert. Einige von diesen sind vielleicht schon in deiner Version von PHP aktiviert, somit musst du eventuell
10nicht alle folgenden Pakete installieren. 24nicht alle folgenden Pakete installieren.
11 25
@@ -39,33 +53,20 @@ Installation
39Auf einem dedizierten Webserver (empfohlener Weg) 53Auf einem dedizierten Webserver (empfohlener Weg)
40~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 54~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
41 55
42wallabag 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
44Composer installieren:
45
46::
47
48 curl -s http://getcomposer.org/installer | php
49
50Du kannst eine spezifische Anleitung `hier <https://getcomposer.org/doc/00-intro.md>`__ finden.
51
52Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: 56Um 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
62Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen: 63Um 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
68Und wallabag unter http://deineserverip:8000 erreichen 69und 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``) 91Du findest die `md5 Hashsumme des neuesten Pakets auf unserer Website <https://www.wallabag.org/pages/download-wallabag.html>`_.
91 92
92Jetzt lese die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf dein wallabag zu. 93Jetzt lies die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf dein wallabag zu.
93Wenn 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``. 94Wenn 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
95Installation mit Docker 96Installation mit Docker
96------------------------ 97~~~~~~~~~~~~~~~~~~~~~~~
97 98
98Wir 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. 99Wir 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
100Kommando, um den Container zu starten 101Kommando, 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
110Konfiguration von Apache 111Konfiguration von Apache
111~~~~~~~~~~~~~~~~~~~~~~~ 112~~~~~~~~~~~~~~~~~~~~~~~~
112 113
113Angenommen 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: 114Angenommen 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
193Nach dem neuladen oder neustarten von nginx, solltest du nun wallabag unter http://domain.tld erreichen. 194Nach 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
200Konfiguration von lighttpd 200Konfiguration von lighttpd
201~~~~~~~~~~~~~~~~~~~~~~~~~ 201~~~~~~~~~~~~~~~~~~~~~~~~~~
202 202
203Angenommen 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): 203Angenommen 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/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
49Enable RabbitMQ in wallabag
50---------------------------
51
52In internal settings, in the **Import** section, enable RabbitMQ (with the value 1).
49 53
50Launch RabbitMQ consumer 54Launch RabbitMQ consumer
51------------------------ 55------------------------
diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst
index 005d6e4f..67b6452e 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
38Enable Redos in wallabag
39------------------------
40
41In internal settings, in the **Import** section, enable Redis (with the value 1).
38 42
39Launch Redis consumer 43Launch 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 @@
1Testsuite
2=========
3
4To ensure wallabag development quality, we wrote tests with `PHPUnit <https://phpunit.de>`_.
5
6If you contribute to the project (by translating the application, by fixing bugs or by adding a new feature), please write your own tests.
7
8To launch wallabag testsuite, you need to install `ant <http://ant.apache.org>`_.
9
10Then, execute this command ``make test``.
diff --git a/docs/en/index.rst b/docs/en/index.rst
index beb3816e..4e346ae6 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
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
32After you have filled in your data, push the button Connection test and wait for the test to finish. 32After 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
38The connection test shall finish with success. If not, you need to fix this first until you proceed. 38The 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
68Finally after the syncronisation finished successfully, you are presented the list of unread articles. 68Finally 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
76Known limitations 76Known limitations
77---- 77-----------------
78 78
792FA 792FA
80~~~ 80~~~
@@ -85,7 +85,7 @@ Currently the does not support two-factor authentication. You should disable tha
85Limited amount of articles with wallabag v2 85Limited amount of articles with wallabag v2
86~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 86~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
87 87
88In 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. 88In 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
91SSL/TLS encryption 91SSL/TLS encryption
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
35Export your Readability data 35Export your Readability data
36~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 36~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37 37
38On 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). 38On 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
40Import your data into wallabag 2.x 40Import your data into wallabag 2.x
41~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 41~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -51,7 +51,7 @@ From Instapaper
51Export your Instapaper data 51Export your Instapaper data
52~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 52~~~~~~~~~~~~~~~~~~~~~~~~~~~~
53 53
54On 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``). 54On 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
56Import your data into wallabag 2.x 56Import your data into wallabag 2.x
57~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 57~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index 4aaabd82..248c1995 100644
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -6,7 +6,21 @@ Requirements
6 6
7wallabag is compatible with PHP >= 5.5, including PHP 7. 7wallabag is compatible with PHP >= 5.5, including PHP 7.
8 8
9You'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 create a ``Makefile``, so you need to have the ``make`` tool.
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``).
14
15Install Composer:
16
17::
18
19 curl -s http://getcomposer.org/installer | php
20
21You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__.
22
23You'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
38On a dedicated web server (recommended way) 52On a dedicated web server (recommended way)
39~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 53~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
40 54
41wallabag 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
43Install Composer:
44
45::
46
47 curl -s http://getcomposer.org/installer | php
48
49You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__.
50
51To install wallabag itself, you must run the following commands: 55To 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
61To start PHP's build-in server and test if everything did install correctly, you can do: 62To 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
67And access wallabag at http://yourserverip:8000 68And 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``) 90You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
90 91
91Now, read the following documentation to create your virtual host, then access your wallabag. 92Now, read the following documentation to create your virtual host, then access your wallabag.
92If 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``. 93If 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
94Installation with Docker 95Installation with Docker
95------------------------ 96~~~~~~~~~~~~~~~~~~~~~~~~
96 97
97We 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 to our repository on `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ to have more information.
98 99
99Command to launch container 100Command to launch container
100~~~~~~~~~~~~~~~~~~~~~~~~~~~ 101^^^^^^^^^^^^^^^^^^^^^^^^^^^
101 102
102.. code-block:: bash 103.. code-block:: bash
103 104
@@ -239,12 +240,12 @@ Rights access to the folders of the project
239Test environment 240Test environment
240~~~~~~~~~~~~~~~~ 241~~~~~~~~~~~~~~~~
241 242
242When 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. 243When 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
244Production environment 245Production environment
245~~~~~~~~~~~~~~~~~~~~~~ 246~~~~~~~~~~~~~~~~~~~~~~
246 247
247As 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. 248As 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
249To 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).
250 251
diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst
new file mode 100644
index 00000000..79c50871
--- /dev/null
+++ b/docs/en/user/parameters.rst
@@ -0,0 +1,50 @@
1What 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 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", "Usee 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..2f08b7bd 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,5 +1,5 @@
1Upgrading from 2.0.x to 2.1.y 1Upgrade 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. 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.
@@ -7,8 +7,6 @@ Before this migration, if you configured the Pocket import by adding your consum
7Upgrade on a dedicated web server 7Upgrade on a dedicated web server
8--------------------------------- 8---------------------------------
9 9
10The 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:: 10::
13 11
14 rm -rf var/cache/* 12 rm -rf var/cache/*
@@ -28,25 +26,43 @@ Download the last release of 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(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) 31(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``)
34 32
35Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. 33Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
36 34
37Please 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) : 35Please 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 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
50 66
51If you use SQLite, you must also copy your ``data/`` folder inside the new installation. 67If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
52 68
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 @@
1Upgrade from 2.0.x to 2.0.y 1Upgrading from 2.1.x to 2.1.y
2=========================== 2=============================
3 3
4Upgrade on a dedicated web server 4Upgrade on a dedicated web server
5--------------------------------- 5---------------------------------
6 6
7The 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): 7The 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
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/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
49Activer RabbitMQ dans wallabag
50------------------------------
51
52Dans les paramètres internes, section **Import**, activez RabbitMQ (avec la valeur 1).
49 53
50Démarrer les clients RabbitMQ 54Dé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
38Activer Redis dans wallabag
39---------------------------
40
41Dans les paramètres internes, section **Import**, activez Redis (avec la valeur 1).
38 42
39Démarrer les clients Redis 43Dé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 @@
1Suite de tests
2==============
3
4Pour assurer la qualité du développement de wallabag, nous avons écrit des tests avec `PHPUnit <https://phpunit.de>`_.
5
6Si 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
8Pour lancer la suite de tests de wallabag, vous devez installer `ant <http://ant.apache.org>`_.
9
10Ensuite, exécutez la commande ``make test``.
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
36Exportez vos données de Readability 36Exportez vos données de Readability
37~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 37~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
38 38
39Sur 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. 39Sur 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
41Importez vos données dans wallabag 2.x 41Importez vos données dans wallabag 2.x
42~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 42~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -52,7 +52,7 @@ Depuis Instapaper
52Exportez vos données de Instapaper 52Exportez vos données de Instapaper
53~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 53~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
54 54
55Sur 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``). 55Sur 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
57Importez vos données dans wallabag 2.x 57Importez 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..62e7d334 100644
--- a/docs/fr/user/installation.rst
+++ b/docs/fr/user/installation.rst
@@ -6,6 +6,20 @@ Pré-requis
6 6
7wallabag est compatible avec PHP >= 5.5, PHP 7 inclus. 7wallabag 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
13wallabag 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
15Installation de Composer :
16
17::
18
19 curl -s http://getcomposer.org/installer | php
20
21Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__.
22
9Vous 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. 23Vous 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,31 +50,18 @@ Installation
36Sur un serveur dédié (méthode conseillée) 50Sur un serveur dédié (méthode conseillée)
37~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 51~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
38 52
39wallabag 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
41Installation de Composer :
42
43::
44
45 curl -s http://getcomposer.org/installer | php
46
47Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__.
48
49Pour installer wallabag, vous devez exécuter ces commandes : 53Pour 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
59Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : 60Pour 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
65Et accéder wallabag à l'adresse http://lipdevotreserveur:8000 66Et accéder wallabag à l'adresse http://lipdevotreserveur:8000
66 67
@@ -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``) 87Vous trouverez `le hash md5 du dernier package sur notre site <https://www.wallabag.org/pages/download-wallabag.html>`_.
87 88
88Maintenant, lisez la documentation ci-dessous pour crééer un virtual host. Accédez ensuite à votre installation de wallabag. 89Maintenant, lisez la documentation ci-dessous pour crééer un virtual host. Accédez ensuite à votre installation de wallabag.
89Si 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``. 90Si 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
91Installation avec Docker 92Installation avec Docker
92------------------------ 93~~~~~~~~~~~~~~~~~~~~~~~~
93 94
94Nous 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. 95Nous 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
96Commande pour démarrer le containeur 97Commande pour démarrer le containeur
97~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 98^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
98 99
99.. code-block:: bash 100.. code-block:: bash
100 101