From 7eff4736a1309ad71a75fa74dc1081a3b2303169 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Sat, 8 Oct 2016 15:10:56 +0200 Subject: Cleaned up documentation for installation process --- docs/de/user/installation.rst | 34 ++++++++++++++++------------------ docs/en/user/android.rst | 10 +++++----- docs/en/user/installation.rst | 32 +++++++++++++++----------------- docs/fr/user/installation.rst | 30 ++++++++++++++---------------- 4 files changed, 50 insertions(+), 56 deletions(-) (limited to 'docs') diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index 3578dca9..263d53c0 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -6,6 +6,16 @@ Voraussetzungen wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7. +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. + +Composer installieren: + +:: + + curl -s http://getcomposer.org/installer | php + +Du kannst eine spezifische Anleitung `hier `__ finden. + 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 nicht alle folgenden Pakete installieren. @@ -39,25 +49,13 @@ Installation Auf einem dedizierten Webserver (empfohlener Weg) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -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. - -Composer installieren: - -:: - - curl -s http://getcomposer.org/installer | php - -Du kannst eine spezifische Anleitung `hier `__ finden. - Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: :: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.1.1 --force - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console wallabag:install --env=prod + ./install.sh Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen: @@ -87,18 +85,18 @@ Führe dieses Kommando aus, um das neueste Paket herunterzuladen und zu entpacke wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(md5 hash: ``6c33520e29cc754b687f9cee0398dede``) +You will find the `md5 hash of the latest package on our website `_. Jetzt lese die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf dein wallabag zu. 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``. Installation mit Docker ------------------------- +~~~~~~~~~~~~~~~~~~~~~~ Wir stellen ein Docker Image zu Verfügung, um wallabag einfach zu installieren. Schaue in unser Repository in unserem `Docker Hub `__, um mehr Informationen zu erhalten. Kommando, um den Container zu starten -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: bash @@ -108,7 +106,7 @@ Virtualhosts ------------ Konfiguration von Apache -~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~ 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: @@ -198,7 +196,7 @@ Nach dem neuladen oder neustarten von nginx, solltest du nun wallabag unter http 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``. Konfiguration von lighttpd -~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~ 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): diff --git a/docs/en/user/android.rst b/docs/en/user/android.rst index 4271f037..eec130f6 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 :alt: Filled in settings :align: center -After you have filled in your data, push the button Connection test and wait for the test to finish. +After you have filled in your data, push the button Connection test and wait for the test to finish. .. image:: ../../img/user/android_configuration_connection_test.en.png :alt: Connection test with your wallabag data :align: center -The connection test shall finish with success. If not, you need to fix this first until you proceed. +The connection test shall finish with success. If not, you need to fix this first until you proceed. .. image:: ../../img/user/android_configuration_connection_test_success.en.png :alt: Connection test successful @@ -65,7 +65,7 @@ After hitting the save button, you get the following screen. The app proposes to :alt: Settings saved the first time :align: center -Finally after the syncronisation finished successfully, you are presented the list of unread articles. +Finally after the syncronisation finished successfully, you are presented the list of unread articles. .. image:: ../../img/user/android_unread_feed_synced.en.png :alt: Filled article list cause feeds successfully syncronized @@ -74,7 +74,7 @@ Finally after the syncronisation finished successfully, you are presented the li Known limitations ----- +----------------- 2FA ~~~ @@ -85,7 +85,7 @@ Currently the does not support two-factor authentication. You should disable tha Limited amount of articles with wallabag v2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -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. +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. SSL/TLS encryption diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 4aaabd82..a2f0d07b 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -6,7 +6,17 @@ Requirements wallabag is compatible with PHP >= 5.5, including PHP 7. -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. +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``). + +Install Composer: + +:: + + curl -s http://getcomposer.org/installer | php + +You can find specific instructions `here `__. + +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. - php-session - php-ctype @@ -38,25 +48,13 @@ Installation On a dedicated web server (recommended way) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -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``). - -Install Composer: - -:: - - curl -s http://getcomposer.org/installer | php - -You can find specific instructions `here `__. - To install wallabag itself, you must run the following commands: :: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.1.1 --force - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console wallabag:install --env=prod + ./install.sh To start PHP's build-in server and test if everything did install correctly, you can do: @@ -86,18 +84,18 @@ Execute this command to download and extract the latest package: wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) +You will find the `md5 hash of the latest package on our website `_. Now, read the following documentation to create your virtual host, then access your wallabag. 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``. Installation with Docker ------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~ We provide you a Docker image to install wallabag easily. Have a look to our repository on `Docker Hub `__ to have more information. Command to launch container -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: bash diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index 9dd39af7..b47813be 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -6,6 +6,16 @@ Pré-requis wallabag est compatible avec PHP >= 5.5, PHP 7 inclus. +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``). + +Installation de Composer : + +:: + + curl -s http://getcomposer.org/installer | php + +Vous pouvez trouver des instructions spécifiques `ici (en anglais) `__. + 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. - php-session @@ -36,25 +46,13 @@ Installation Sur un serveur dédié (méthode conseillée) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -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``). - -Installation de Composer : - -:: - - curl -s http://getcomposer.org/installer | php - -Vous pouvez trouver des instructions spécifiques `ici (en anglais) `__. - Pour installer wallabag, vous devez exécuter ces commandes : :: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.1.1 --force - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console wallabag:install --env=prod + ./install.sh Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : @@ -83,18 +81,18 @@ Exécutez cette commande pour télécharger et décompresser l'archive : wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``) +Vous trouverez `le hash md5 du dernier package sur notre site `_. Maintenant, lisez la documentation ci-dessous pour crééer un virtual host. Accédez ensuite à votre installation de wallabag. 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``. Installation avec Docker ------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~ Nous vous proposons une image Docker pour installer wallabag facilement. Allez voir du côté de `Docker Hub `__ pour plus d'informations. Commande pour démarrer le containeur -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: bash -- cgit v1.2.3 From 5334381509990ea5a5351575abf163c3b6c9dc18 Mon Sep 17 00:00:00 2001 From: Strubbl Date: Sat, 8 Oct 2016 20:25:48 +0200 Subject: update German installation.rst --- docs/de/user/installation.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index 263d53c0..615f5f28 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -63,7 +63,7 @@ Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installier php bin/console server:run --env=prod -Und wallabag unter http://deineserverip:8000 erreichen +und wallabag unter http://deineserverip:8000 erreichen. .. tip:: @@ -91,7 +91,7 @@ Jetzt lese die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf 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``. Installation mit Docker -~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~ Wir stellen ein Docker Image zu Verfügung, um wallabag einfach zu installieren. Schaue in unser Repository in unserem `Docker Hub `__, um mehr Informationen zu erhalten. @@ -188,11 +188,10 @@ Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installie access_log /var/log/nginx/wallabag_access.log; } -Nach dem neuladen oder neustarten von nginx, solltest du nun wallabag unter http://domain.tld erreichen. +Nach dem Neuladen oder Neustarten von nginx solltest du nun wallabag unter http://domain.tld erreichen. .. tip:: - 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``. 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``. Konfiguration von lighttpd -- cgit v1.2.3 From 5112b3556b5a85c791cac6ec89c19939e0677904 Mon Sep 17 00:00:00 2001 From: Strubbl Date: Sat, 8 Oct 2016 20:28:18 +0200 Subject: update German installation.rst --- docs/de/user/installation.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index 615f5f28..dc2b8b4d 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -85,9 +85,9 @@ Führe dieses Kommando aus, um das neueste Paket herunterzuladen und zu entpacke wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -You will find the `md5 hash of the latest package on our website `_. +Du findest die `md5 Hashsumme des neuesten Pakets auf unserer Website `_. -Jetzt lese die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf dein wallabag zu. +Jetzt lies die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf dein wallabag zu. 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``. Installation mit Docker -- cgit v1.2.3 From 84e3c36e02e4ffb4611f6e1eca37c97a0ffb4660 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 09:15:53 +0200 Subject: Added documentation about testsuite Fix #2415 --- docs/de/developer/testsuite.rst | 10 ++++++++++ docs/de/user/installation.rst | 3 +++ docs/en/developer/testsuite.rst | 10 ++++++++++ docs/en/user/installation.rst | 3 +++ docs/fr/developer/testsuite.rst | 10 ++++++++++ docs/fr/user/installation.rst | 3 +++ 6 files changed, 39 insertions(+) create mode 100644 docs/de/developer/testsuite.rst create mode 100644 docs/en/developer/testsuite.rst create mode 100644 docs/fr/developer/testsuite.rst (limited to 'docs') 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 @@ +Testsuite +========= + +To ensure wallabag development quality, we wrote tests with `PHPUnit `_. + +If you contribute to the project (by translating the application, by fixing bugs or by adding a new feature), please write your own tests. + +To launch wallabag testsuite, you need to install `ant `_. + +Then, execute this command ``make test``. diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index dc2b8b4d..bee3249b 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -6,6 +6,9 @@ Voraussetzungen wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7. +.. note:: +Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``. + 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. Composer installieren: 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 @@ +Testsuite +========= + +To ensure wallabag development quality, we wrote tests with `PHPUnit `_. + +If you contribute to the project (by translating the application, by fixing bugs or by adding a new feature), please write your own tests. + +To launch wallabag testsuite, you need to install `ant `_. + +Then, execute this command ``make test``. diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index a2f0d07b..0920b976 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -6,6 +6,9 @@ Requirements wallabag is compatible with PHP >= 5.5, including PHP 7. +.. note:: +To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. + 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``). Install Composer: 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 @@ +Suite de tests +============== + +Pour assurer la qualité du développement de wallabag, nous avons écrit des tests avec `PHPUnit `_. + +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. + +Pour lancer la suite de tests de wallabag, vous devez installer `ant `_. + +Ensuite, exécutez la commande ``make test``. diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index b47813be..55614d72 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -6,6 +6,9 @@ Pré-requis wallabag est compatible avec PHP >= 5.5, PHP 7 inclus. +.. note:: +Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``. + 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``). Installation de Composer : -- cgit v1.2.3 From 7c1225347db8b516cc268709939f6b359bc283c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 10:20:32 +0200 Subject: Update documentation --- docs/de/user/installation.rst | 5 ++--- docs/en/user/installation.rst | 9 ++++----- docs/fr/user/installation.rst | 5 ++--- 3 files changed, 8 insertions(+), 11 deletions(-) (limited to 'docs') diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index bee3249b..2bb86269 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -57,14 +57,13 @@ Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: :: git clone https://github.com/wallabag/wallabag.git - cd wallabag - ./install.sh + cd wallabag && make install Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen: :: - php bin/console server:run --env=prod + make run und wallabag unter http://deineserverip:8000 erreichen. diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 0920b976..e08e0306 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -56,14 +56,13 @@ To install wallabag itself, you must run the following commands: :: git clone https://github.com/wallabag/wallabag.git - cd wallabag - ./install.sh + cd wallabag && make install To start PHP's build-in server and test if everything did install correctly, you can do: :: - php bin/console server:run --env=prod + make run And access wallabag at http://yourserverip:8000 @@ -240,12 +239,12 @@ Rights access to the folders of the project Test environment ~~~~~~~~~~~~~~~~ -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. +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. Production environment ~~~~~~~~~~~~~~~~~~~~~~ -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. +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. 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). diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index 55614d72..b32707f8 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -54,14 +54,13 @@ Pour installer wallabag, vous devez exécuter ces commandes : :: git clone https://github.com/wallabag/wallabag.git - cd wallabag - ./install.sh + cd wallabag && make install Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : :: - php bin/console server:run --env=prod + make run Et accéder wallabag à l'adresse http://lipdevotreserveur:8000 -- cgit v1.2.3 From 7c1ce28342c85abb21dc79b9d22be35c0c09891b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 11:21:20 +0200 Subject: Update upgrade documentation --- docs/en/user/upgrade-2.0.x-2.0.y.rst | 35 ------------------- docs/en/user/upgrade-2.0.x-2.1.1.rst | 55 ++++++++++++++++++++++++++++++ docs/en/user/upgrade-2.0.x-2.1.y.rst | 65 ------------------------------------ docs/en/user/upgrade-2.1.x-2.1.y.rst | 35 +++++++++++++++++++ 4 files changed, 90 insertions(+), 100 deletions(-) delete mode 100644 docs/en/user/upgrade-2.0.x-2.0.y.rst create mode 100644 docs/en/user/upgrade-2.0.x-2.1.1.rst delete mode 100644 docs/en/user/upgrade-2.0.x-2.1.y.rst create mode 100644 docs/en/user/upgrade-2.1.x-2.1.y.rst (limited to 'docs') diff --git a/docs/en/user/upgrade-2.0.x-2.0.y.rst b/docs/en/user/upgrade-2.0.x-2.0.y.rst deleted file mode 100644 index 3391c2cd..00000000 --- a/docs/en/user/upgrade-2.0.x-2.0.y.rst +++ /dev/null @@ -1,35 +0,0 @@ -Upgrade from 2.0.x to 2.0.y -=========================== - -Upgrade on a dedicated web server ---------------------------------- - -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): - -:: - - rm -rf var/cache/* - git fetch origin - git fetch --tags - git checkout 2.0.8 - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console cache:clear --env=prod - -Upgrade on a shared hosting ---------------------------- - -Backup your ``app/config/parameters.yml`` file. - -Download the last release of wallabag: - -.. code-block:: bash - - wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -(md5 hash of the 2.0.8 package: ``4f84c725d1d6e3345eae0a406115e5ff``) - -Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. - -If you use SQLite, you must also copy your ``data/`` folder inside the new installation. - -Empty ``var/cache`` folder. 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 new file mode 100644 index 00000000..898b4ccc --- /dev/null +++ b/docs/en/user/upgrade-2.0.x-2.1.1.rst @@ -0,0 +1,55 @@ +Upgrade from 2.0.x to 2.1.1 +=========================== + +.. warning:: +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. + +Upgrade on a dedicated web server +--------------------------------- + +:: + + rm -rf var/cache/* + git fetch origin + git fetch --tags + git checkout 2.1.1 --force + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console cache:clear --env=prod + +Upgrade on a shared hosting +--------------------------- + +Backup your ``app/config/parameters.yml`` file. + +Download the last release of wallabag: + +.. code-block:: bash + + wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.0.8.tar.gz + +(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) + +Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. + +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. + +.. code-block:: yml + + + + +If you use SQLite, you must also copy your ``data/`` folder inside the new installation. + +Empty ``var/cache`` folder. + +You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one: + +.. code-block:: sql + + ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); + ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); + ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; + DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; diff --git a/docs/en/user/upgrade-2.0.x-2.1.y.rst b/docs/en/user/upgrade-2.0.x-2.1.y.rst deleted file mode 100644 index ec353a18..00000000 --- a/docs/en/user/upgrade-2.0.x-2.1.y.rst +++ /dev/null @@ -1,65 +0,0 @@ -Upgrading from 2.0.x to 2.1.y -============================= - -.. warning:: -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. - -Upgrade on a dedicated web server ---------------------------------- - -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): - -:: - - rm -rf var/cache/* - git fetch origin - git fetch --tags - git checkout 2.1.1 --force - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console doctrine:migrations:migrate --env=prod - php bin/console cache:clear --env=prod - -Upgrade on a shared hosting ---------------------------- - -Backup your ``app/config/parameters.yml`` file. - -Download the last release of wallabag: - -.. code-block:: bash - - wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) - -Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. - -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) : - -.. code-block:: bash - - # RabbitMQ processing - rabbitmq_host: localhost - rabbitmq_port: 5672 - rabbitmq_user: guest - rabbitmq_password: guest - - # Redis processing - redis_host: localhost - redis_port: 6379 - -If you use SQLite, you must also copy your ``data/`` folder inside the new installation. - -Empty ``var/cache`` folder. - -You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one: - -.. code-block:: sql - - ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); - ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); - ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; - DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; 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 new file mode 100644 index 00000000..575f4ba9 --- /dev/null +++ b/docs/en/user/upgrade-2.1.x-2.1.y.rst @@ -0,0 +1,35 @@ +Upgrading from 2.1.x to 2.1.y +============================= + +Upgrade on a dedicated web server +--------------------------------- + +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): + +:: + + rm -rf var/cache/* + git fetch origin + git fetch --tags + git checkout 2.1.2 --force + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console cache:clear --env=prod + +Upgrade on a shared hosting +--------------------------- + +Backup your ``app/config/parameters.yml`` file. + +Download the last release of wallabag: + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) + +Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. + +If you use SQLite, you must also copy your ``data/`` folder inside the new installation. + +Empty ``var/cache`` folder. -- cgit v1.2.3 From eb54d338e8d013ed9323f619c960fa57369bd9a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 11:35:32 +0200 Subject: Typos in upgrade doc --- docs/en/user/upgrade-2.0.x-2.1.1.rst | 32 +++++++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) (limited to 'docs') 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 898b4ccc..2f08b7bd 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 @@ -14,6 +14,7 @@ Upgrade on a dedicated web server git fetch --tags git checkout 2.1.1 --force SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console doctrine:migrations:migrate --env=prod php bin/console cache:clear --env=prod Upgrade on a shared hosting @@ -25,7 +26,7 @@ Download the last release of wallabag: .. code-block:: bash - wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.0.8.tar.gz + wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz (md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) @@ -35,8 +36,33 @@ Please check that your ``app/config/parameters.yml`` contains all the required p .. code-block:: yml - - + parameters: + database_driver: pdo_sqlite + database_host: 127.0.0.1 + database_port: null + database_name: symfony + database_user: root + database_password: null + database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite' + database_table_prefix: wallabag_ + mailer_transport: smtp + mailer_host: 127.0.0.1 + mailer_user: null + mailer_password: null + locale: en + secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv + twofactor_auth: true + twofactor_sender: no-reply@wallabag.org + fosuser_registration: true + fosuser_confirmation: true + from_email: no-reply@wallabag.org + rss_limit: 50 + rabbitmq_host: localhost + rabbitmq_port: 5672 + rabbitmq_user: guest + rabbitmq_password: guest + redis_host: localhost + redis_port: 6379 If you use SQLite, you must also copy your ``data/`` folder inside the new installation. -- cgit v1.2.3 From ed11d7f7319dbc3ad9ea8265179f0f32d7d9ef6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 13:01:14 +0200 Subject: Added page about parameters.yml --- docs/de/user/installation.rst | 2 +- docs/en/user/android.rst | 6 +++--- docs/en/user/parameters.rst | 48 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 52 insertions(+), 4 deletions(-) create mode 100644 docs/en/user/parameters.rst (limited to 'docs') diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index 2bb86269..0d082e41 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -7,7 +7,7 @@ Voraussetzungen wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7. .. note:: -Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``. +To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. 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. diff --git a/docs/en/user/android.rst b/docs/en/user/android.rst index eec130f6..ccbad264 100644 --- a/docs/en/user/android.rst +++ b/docs/en/user/android.rst @@ -35,7 +35,7 @@ After you have filled in your data, push the button Connection test and wait for :alt: Connection test with your wallabag data :align: center -The connection test shall finish with success. If not, you need to fix this first until you proceed. +The connection test should finish with success. If not, you need to fix this first until you proceed. .. image:: ../../img/user/android_configuration_connection_test_success.en.png :alt: Connection test successful @@ -65,10 +65,10 @@ After hitting the save button, you get the following screen. The app proposes to :alt: Settings saved the first time :align: center -Finally after the syncronisation finished successfully, you are presented the list of unread articles. +Finally after the synchronisation finished successfully, you are presented to the list of unread articles. .. image:: ../../img/user/android_unread_feed_synced.en.png - :alt: Filled article list cause feeds successfully syncronized + :alt: Filled article list cause feeds successfully synchronized :align: center diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst new file mode 100644 index 00000000..94eff689 --- /dev/null +++ b/docs/en/user/parameters.rst @@ -0,0 +1,48 @@ +What is the meaning of the parameters? +====================================== + +.. code-block:: yml + + # Database parameters + database_driver: pdo_sqlite or pdo_mysql or pdo_pgsql + database_host: 127.0.0.1 + database_port: ~ + database_name: symfony + database_user: root + database_password: ~ + database_path: "%kernel.root_dir%/../data/db/wallabag.sqlite" or empty (when using mysql or postgresql) + database_table_prefix: wallabag_ + database_socket: null + + # Configuration to send emails from wallabag + mailer_transport: smtp + mailer_host: 127.0.0.1 + mailer_user: ~ + mailer_password: ~ + + locale: en # Default language of your wallabag instance + + secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv # A random string used for security + + twofactor_auth: true # true to enable Two factor authentication + twofactor_sender: no-reply@wallabag.org + + fosuser_registration: true # true to enable public registration + fosuser_confirmation: true # true to send a confirmation by email for each registration + + from_email: no-reply@wallabag.org # email address used in From: field in each email + + rss_limit: 50 # limit for RSS feeds + + # RabbitMQ configuration + rabbitmq_host: localhost + rabbitmq_port: 5672 + rabbitmq_user: guest + rabbitmq_password: guest + + # Redis configuration + redis_scheme: tcp + redis_host: localhost + redis_port: 6379 + redis_path: null + -- cgit v1.2.3 From 035513b0257ca5147759432e463e81bc9000221e Mon Sep 17 00:00:00 2001 From: Jeremy Benoist Date: Mon, 10 Oct 2016 13:42:50 +0200 Subject: Use table for parameters.yml --- docs/en/user/parameters.rst | 94 +++++++++++++++++++++++---------------------- 1 file changed, 48 insertions(+), 46 deletions(-) (limited to 'docs') diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst index 94eff689..79c50871 100644 --- a/docs/en/user/parameters.rst +++ b/docs/en/user/parameters.rst @@ -1,48 +1,50 @@ What is the meaning of the parameters? ====================================== - -.. code-block:: yml - - # Database parameters - database_driver: pdo_sqlite or pdo_mysql or pdo_pgsql - database_host: 127.0.0.1 - database_port: ~ - database_name: symfony - database_user: root - database_password: ~ - database_path: "%kernel.root_dir%/../data/db/wallabag.sqlite" or empty (when using mysql or postgresql) - database_table_prefix: wallabag_ - database_socket: null - - # Configuration to send emails from wallabag - mailer_transport: smtp - mailer_host: 127.0.0.1 - mailer_user: ~ - mailer_password: ~ - - locale: en # Default language of your wallabag instance - - secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv # A random string used for security - - twofactor_auth: true # true to enable Two factor authentication - twofactor_sender: no-reply@wallabag.org - - fosuser_registration: true # true to enable public registration - fosuser_confirmation: true # true to send a confirmation by email for each registration - - from_email: no-reply@wallabag.org # email address used in From: field in each email - - rss_limit: 50 # limit for RSS feeds - - # RabbitMQ configuration - rabbitmq_host: localhost - rabbitmq_port: 5672 - rabbitmq_user: guest - rabbitmq_password: guest - - # Redis configuration - redis_scheme: tcp - redis_host: localhost - redis_port: 6379 - redis_path: null - +.. csv-table:: Database parameters + :header: "name", "default", "description" + + "database_driver", "pdo_sqlite", "Should be pdo_sqlite or pdo_mysql or pdo_pgsql" + "database_host", "127.0.0.1", "host of your database (usually localhost or 127.0.0.1)" + "database_port", "~", "port of your database (you can leave ``~`` to use the default one)" + "database_name", "symfony", "name of your database" + "database_user", "root", "user that can write to this database" + "database_password", "~", "password of that user" + "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "only for SQLite, define where to put the database file. Leave it for other database" + "database_table_prefix", "wallabag_", "all wallabag's tables will be prefixed with that string. You can include a ``_`` for clarity" + "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" + +.. csv-table:: Configuration to send emails from wallabag + :header: "name", "default", "description" + + "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)" + "mailer_host", "127.0.0.1", "The host to connect to when using smtp as the transport." + "mailer_user", "~", "The username when using smtp as the transport." + "mailer_password", "~", "The password when using smtp as the transport." + +.. csv-table:: Other wallabag's option + :header: "name", "default", "description" + + "locale", "en", "Default language of your wallabag instance (like en, fr, es, etc.)" + "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." + "twofactor_auth", "true", "true to enable Two factor authentication" + "twofactor_sender", "no-reply@wallabag.org", "email of the email sender to receive the two factor code" + "fosuser_registration", "true", "true to enable public registration" + "fosuser_confirmation", "true", "true to send a confirmation by email for each registration" + "from_email", "no-reply@wallabag.org", "email address used in From: field in each email" + "rss_limit", "50", "limit for RSS feeds" + +.. csv-table:: RabbitMQ configuration + :header: "name", "default", "description" + + "rabbitmq_host", "localhost", "Host of your RabbitMQ" + "rabbitmq_port", "5672", "Port of your RabbitMQ" + "rabbitmq_user", "guest", "Usee that can read queues" + "rabbitmq_password", "guest", "Password of that user" + +.. csv-table:: Redis configuration + :header: "name", "default", "description" + + "redis_scheme", "tcp", "Specifies the protocol used to communicate with an instance of Redis. Valid values are: tcp, unix, http" + "redis_host", "localhost", "IP or hostname of the target server (ignored for unix scheme)" + "redis_port", "6379", "TCP/IP port of the target server (ignored for unix scheme)" + "redis_path", "null", "Path of the UNIX domain socket file used when connecting to Redis using UNIX domain sockets" -- cgit v1.2.3 From c15f083896768ff7eb38be35003b7668bfaa7252 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 15:38:42 +0200 Subject: Fixed links on import page --- docs/en/user/import.rst | 4 ++-- docs/fr/user/import.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'docs') 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 Export your Readability data ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -On the 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). +On the 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). Import your data into wallabag 2.x ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -51,7 +51,7 @@ From Instapaper Export your Instapaper data ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -On the settings (`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``). +On the settings (`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``). Import your data into wallabag 2.x ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 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 Exportez vos données de Readability ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Sur la page des outils (`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. +Sur la page des outils (`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. Importez vos données dans wallabag 2.x ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -52,7 +52,7 @@ Depuis Instapaper Exportez vos données de Instapaper ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Sur la page des paramètres (`https://www.instapaper.com/user`_), cliquez sur "Download .CSV file" dans la section "Export". Un fichier CSV se téléchargera (``instapaper-export.csv``). +Sur la page des paramètres (`https://www.instapaper.com/user `_), cliquez sur "Download .CSV file" dans la section "Export". Un fichier CSV se téléchargera (``instapaper-export.csv``). Importez vos données dans wallabag 2.x ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- cgit v1.2.3 From fa4c39b37c1e1a1b52739a070775e9ba0fafe802 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 15:38:49 +0200 Subject: Added steps about Redis/RabbitMQ activation --- docs/de/developer/rabbitmq.rst | 4 ++++ docs/de/developer/redis.rst | 4 ++++ docs/en/developer/rabbitmq.rst | 4 ++++ docs/en/developer/redis.rst | 4 ++++ docs/fr/developer/rabbitmq.rst | 4 ++++ docs/fr/developer/redis.rst | 4 ++++ 6 files changed, 24 insertions(+) (limited to 'docs') 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 rabbitmq_user: guest rabbitmq_password: guest +Enable RabbitMQ in wallabag +--------------------------- + +In internal settings, in the **Import** section, enable RabbitMQ (with the value 1). Starte den RabbitMQ Consumer ---------------------------- 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 redis_host: localhost redis_port: 6379 +Enable Redis in wallabag +------------------------ + +In internal settings, in the **Import** section, enable Redis (with the value 1). Starte den Redis Consumer ------------------------- 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 rabbitmq_user: guest rabbitmq_password: guest +Enable RabbitMQ in wallabag +--------------------------- + +In internal settings, in the **Import** section, enable RabbitMQ (with the value 1). Launch RabbitMQ consumer ------------------------ 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 redis_host: localhost redis_port: 6379 +Enable Redos in wallabag +------------------------ + +In internal settings, in the **Import** section, enable Redis (with the value 1). Launch Redis consumer --------------------- 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 rabbitmq_user: guest rabbitmq_password: guest +Activer RabbitMQ dans wallabag +------------------------------ + +Dans les paramètres internes, section **Import**, activez RabbitMQ (avec la valeur 1). Démarrer les clients RabbitMQ ----------------------------- 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 redis_host: localhost redis_port: 6379 +Activer Redis dans wallabag +--------------------------- + +Dans les paramètres internes, section **Import**, activez Redis (avec la valeur 1). Démarrer les clients Redis -------------------------- -- cgit v1.2.3 From 36ef9e2730cad290861cca6813370bc87b8f16c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 18:51:20 +0200 Subject: Fixed display for note in installation page --- docs/de/user/installation.rst | 3 ++- docs/en/user/installation.rst | 3 ++- docs/fr/user/installation.rst | 3 ++- 3 files changed, 6 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index 0d082e41..35a30f52 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -7,7 +7,8 @@ Voraussetzungen wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7. .. note:: -To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. + + To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. 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. diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index e08e0306..248c1995 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -7,7 +7,8 @@ Requirements wallabag is compatible with PHP >= 5.5, including PHP 7. .. note:: -To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. + + To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. 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``). diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index b32707f8..62e7d334 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -7,7 +7,8 @@ Pré-requis wallabag est compatible avec PHP >= 5.5, PHP 7 inclus. .. note:: -Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``. + + Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``. 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``). -- cgit v1.2.3 From 7e72b371bab76539708340f9c4305b745e591269 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Tue, 11 Oct 2016 14:59:32 +0200 Subject: Fix links on english documentation homepage --- docs/en/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') 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: user/faq user/installation - user/upgrade-2.0.x-2.1.y - user/upgrade-2.0.x-2.0.y + user/upgrade-2.0.x-2.1.1 + user/upgrade-2.1.x-2.1.y user/migration user/import user/create_account -- cgit v1.2.3