From 18470d7c6a5c71e4503f7661e85120630541afb8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 12 Oct 2016 13:19:45 +0200 Subject: Added french documentation for parameters.yml --- docs/en/index.rst | 1 + docs/en/user/parameters.rst | 6 +++--- docs/fr/index.rst | 1 + docs/fr/user/parameters.rst | 50 +++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 55 insertions(+), 3 deletions(-) create mode 100644 docs/fr/user/parameters.rst (limited to 'docs') diff --git a/docs/en/index.rst b/docs/en/index.rst index 4e346ae6..6d85db2b 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -45,6 +45,7 @@ The documentation is available in other languages: user/filters user/tags user/android + user/parameters .. _dev-docs: diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst index 79c50871..6cbd5ae4 100644 --- a/docs/en/user/parameters.rst +++ b/docs/en/user/parameters.rst @@ -9,9 +9,9 @@ What is the meaning of the parameters? "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_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "only for SQLite, define where to put the database file. Leave it empty 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" + "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" @@ -38,7 +38,7 @@ What is the meaning of the parameters? "rabbitmq_host", "localhost", "Host of your RabbitMQ" "rabbitmq_port", "5672", "Port of your RabbitMQ" - "rabbitmq_user", "guest", "Usee that can read queues" + "rabbitmq_user", "guest", "User that can read queues" "rabbitmq_password", "guest", "Password of that user" .. csv-table:: Redis configuration diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 359b103c..082173e5 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -45,6 +45,7 @@ La documentation est disponible dans d'autres langues : user/share user/filters user/tags + user/parameters .. _dev-docs: diff --git a/docs/fr/user/parameters.rst b/docs/fr/user/parameters.rst new file mode 100644 index 00000000..ec8c8995 --- /dev/null +++ b/docs/fr/user/parameters.rst @@ -0,0 +1,50 @@ +À quoi servent les paramètres ? +=============================== +.. csv-table:: Paramètres de base de données + :header: "name", "default", "description" + + "database_driver", "pdo_sqlite", "Doit être pdo_sqlite ou pdo_mysql ou pdo_pgsql" + "database_host", "127.0.0.1", "Hôte de votre base de données (généralement localhost ou 127.0.0.1)" + "database_port", "~", "Port de votre base de données (vous pouvez laisser ``~`` pour utiliser celui par défaut)" + "database_name", "symfony", "Nom de votre base de données" + "database_user", "root", "Utilisateur de votre base de données" + "database_password", "~", "Mot de passe de cet utilisateur" + "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "Uniquement pour SQLite. Chemin du fichier de base de données. Laissez vide pour les autres bases de données." + "database_table_prefix", "wallabag_", "Toutes les tables de wallabag seront préfixées par cette chaine. Vous pouvez ajouter un ``_`` pour plus de clarté" + "database_socket", "null", "Si votre base de données utilise un socket plutôt que tcp, spécifiez le chemin du socket (les autres paramètres de connexion seront alors ignorés)" + +.. csv-table:: Configuration pour envoyer des emails depuis wallabag + :header: "name", "default", "description" + + "mailer_transport", "smtp", "Méthode de transport exacte utilisée pour envoyer des emails. Les valeurs correctes sont : smtp, gmail, mail, sendmail, null (ce qui désactivera l'envoi des emails)" + "mailer_host", "127.0.0.1", "Hôte sur lequel se connecter quand on utilise smtp comme transport." + "mailer_user", "~", "Utilisateur smtp." + "mailer_password", "~", "Mot de passe de cet utilisateur." + +.. csv-table:: Autres options de wallabag + :header: "name", "default", "description" + + "locale", "en", "Langue par défaut de votre instance wallabag (comme en, fr, es, etc.)" + "secret", "ovmpmAWXRCabNlMgzlzFXDYmCFfzGv", "C'est une chaine qui doit être unique à votre application et qui est couramment utilisée pour ajouter plus d'entropie aux opérations relatives à la sécurité." + "twofactor_auth", "true", "true pour activer l'authentification à deux facteurs" + "twofactor_sender", "no-reply@wallabag.org", "Email de l'expéditeur du code de l'authentification à deux facteurs" + "fosuser_registration", "true", "true pour activer l'inscription publique" + "fosuser_confirmation", "true", "true pour envoyer un email de confirmation pour chaque création de compte" + "from_email", "no-reply@wallabag.org", "Email de l'expéditeur pour chaque email envoyé" + "rss_limit", "50", "Limite pour les flux RSS" + +.. csv-table:: Configuration RabbitMQ + :header: "name", "default", "description" + + "rabbitmq_host", "localhost", "Hôte de votre instance RabbitMQ" + "rabbitmq_port", "5672", "Port de votre instance RabbitMQ" + "rabbitmq_user", "guest", "Utilisateur de votre instance RabbitMQ" + "rabbitmq_password", "guest", "Mot de passe de cet utilisateur" + +.. csv-table:: Configuration Redis + :header: "name", "default", "description" + + "redis_scheme", "tcp", "Définit le protocole utilisé pour commuiquer avec l'instance Redis. Les valeurs correctes sont : tcp, unix, http" + "redis_host", "localhost", "IP ou hôte du serveur cible (ignoré pour un schéma unix)" + "redis_port", "6379", "Port TCP/IP du serveur cible (ignoré pour un schéma unix)" + "redis_path", "null", "Chemin du fichier de socket du domaine UNIX utilisé quand on se connecte à Redis en utilisant les sockets du domaine UNIX" -- cgit v1.2.3 From b09cafbb3fb928ccb0c6c7cc98e717133e0df560 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 12 Oct 2016 13:37:50 +0200 Subject: Added french documentation for upgrade --- docs/de/user/upgrade-2.0.x-2.1.1.rst | 65 ++++++++++++++++++++++++++++ docs/de/user/upgrade-2.0.x-2.1.y.rst | 65 ---------------------------- docs/en/user/upgrade-2.0.x-2.1.1.rst | 2 + docs/fr/user/installation.rst | 2 +- docs/fr/user/upgrade-2.0.x-2.0.y.rst | 35 --------------- docs/fr/user/upgrade-2.0.x-2.1.1.rst | 84 ++++++++++++++++++++++++++++++++++++ docs/fr/user/upgrade-2.0.x-2.1.y.rst | 66 ---------------------------- docs/fr/user/upgrade-2.1.x-2.1.y.rst | 35 +++++++++++++++ 8 files changed, 187 insertions(+), 167 deletions(-) create mode 100644 docs/de/user/upgrade-2.0.x-2.1.1.rst delete mode 100644 docs/de/user/upgrade-2.0.x-2.1.y.rst delete mode 100644 docs/fr/user/upgrade-2.0.x-2.0.y.rst create mode 100644 docs/fr/user/upgrade-2.0.x-2.1.1.rst delete mode 100644 docs/fr/user/upgrade-2.0.x-2.1.y.rst create mode 100644 docs/fr/user/upgrade-2.1.x-2.1.y.rst (limited to 'docs') diff --git a/docs/de/user/upgrade-2.0.x-2.1.1.rst b/docs/de/user/upgrade-2.0.x-2.1.1.rst new file mode 100644 index 00000000..eee50fe4 --- /dev/null +++ b/docs/de/user/upgrade-2.0.x-2.1.1.rst @@ -0,0 +1,65 @@ +Wallabag updaten +================ + +.. warning:: +Wenn du den Import von Pocket durch das Hinzufügen des Consumer Key in den internen Einstellungen konfiguriert hast, fertige bitte ein Backup deines Keys an, bevor du auf das neue Release migrierst: Du wirst den Key nach dem Update in der Konfiguration erneut eintragen müssen. + +Update auf einem dedizierten Webserver +-------------------------------------- + +Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag-Installation auf die neueste Version zu aktualisieren, führe die folgenden Kommandos in deinem wallabag-Ordner aus (ersetze ``2.1.1`` mit der neuesten Releasenummer): + +:: + + 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 + +Update auf einem Shared Webhosting +---------------------------------- + +Sichere deine ``app/config/parameters.yml`` Datei. + +Lade das neueste Release von wallabag herunter: + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +(2.1.1 md5 hash: ``9584a3b60a2b2a4de87f536548caac93``) + +Entpacke das Archiv in deinen wallabag-Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. + +Bitte beachte, dass wir in dieser Version neue Parameter hinzugefügt haben. Du musst die Datei ``app/config/parameters.yml`` bearbeiten und die folgenden Zeilen hinzufügen (ersetze die Werte mit deiner Konfiguration): + +.. 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 + +Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. + +Leere den ``var/cache`` Ordner. + +Du musst einige SQL-Abfragen ausführen, um die Datenbank zu aktualisieren. Wir nehmen in diesem Fall an, dass das Tabellenpräfix ``wallabag_`` ist und eine MySQL-Datenbank genutzt wird: + +.. 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/de/user/upgrade-2.0.x-2.1.y.rst b/docs/de/user/upgrade-2.0.x-2.1.y.rst deleted file mode 100644 index eee50fe4..00000000 --- a/docs/de/user/upgrade-2.0.x-2.1.y.rst +++ /dev/null @@ -1,65 +0,0 @@ -Wallabag updaten -================ - -.. warning:: -Wenn du den Import von Pocket durch das Hinzufügen des Consumer Key in den internen Einstellungen konfiguriert hast, fertige bitte ein Backup deines Keys an, bevor du auf das neue Release migrierst: Du wirst den Key nach dem Update in der Konfiguration erneut eintragen müssen. - -Update auf einem dedizierten Webserver --------------------------------------- - -Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag-Installation auf die neueste Version zu aktualisieren, führe die folgenden Kommandos in deinem wallabag-Ordner aus (ersetze ``2.1.1`` mit der neuesten Releasenummer): - -:: - - 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 - -Update auf einem Shared Webhosting ----------------------------------- - -Sichere deine ``app/config/parameters.yml`` Datei. - -Lade das neueste Release von wallabag herunter: - -.. code-block:: bash - - wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -(2.1.1 md5 hash: ``9584a3b60a2b2a4de87f536548caac93``) - -Entpacke das Archiv in deinen wallabag-Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. - -Bitte beachte, dass wir in dieser Version neue Parameter hinzugefügt haben. Du musst die Datei ``app/config/parameters.yml`` bearbeiten und die folgenden Zeilen hinzufügen (ersetze die Werte mit deiner Konfiguration): - -.. 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 - -Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. - -Leere den ``var/cache`` Ordner. - -Du musst einige SQL-Abfragen ausführen, um die Datenbank zu aktualisieren. Wir nehmen in diesem Fall an, dass das Tabellenpräfix ``wallabag_`` ist und eine MySQL-Datenbank genutzt wird: - -.. 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.1.rst b/docs/en/user/upgrade-2.0.x-2.1.1.rst index 2f08b7bd..630d4b74 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 @@ -64,6 +64,8 @@ Please check that your ``app/config/parameters.yml`` contains all the required p redis_host: localhost redis_port: 6379 +You can find `here a documentation about parameters `_. + If you use SQLite, you must also copy your ``data/`` folder inside the new installation. Empty ``var/cache`` folder. diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index 62e7d334..4f94d6c8 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -66,7 +66,7 @@ Pour démarrer le serveur interne à php et vérifier que tout s'est installé c Et accéder wallabag à l'adresse http://lipdevotreserveur:8000 .. tip:: - Pour définir des paramètres via des variables d'environnement, vous pouvez les spécifier avec le préfixe ``SYMFONY__``. Par exemple, ``SYMFONY__DATABASE_DRIVER``. Vous pouvez lire `documentation Symfony `__ pour en savoir plus. + Pour définir des paramètres via des variables d'environnement, vous pouvez les spécifier avec le préfixe ``SYMFONY__``. Par exemple, ``SYMFONY__DATABASE_DRIVER``. Vous pouvez lire la `documentation Symfony `__ pour en savoir plus. Sur un serveur mutualisé ~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/fr/user/upgrade-2.0.x-2.0.y.rst b/docs/fr/user/upgrade-2.0.x-2.0.y.rst deleted file mode 100644 index 8d8ad806..00000000 --- a/docs/fr/user/upgrade-2.0.x-2.0.y.rst +++ /dev/null @@ -1,35 +0,0 @@ -Mettre à jour de la 2.0.x à la 2.0.y -==================================== - -Mise à jour sur un serveur dédié --------------------------------- - -La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.0.8`` par le numéro de la dernière version) : - -:: - - 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 - -Mise à jour sur un hébergement mutualisé ----------------------------------------- - -Effectuez une sauvegarde du fichier ``app/config/parameters.yml``. - -Téléchargez la dernière version de wallabag : - -.. code-block:: bash - - wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -(hash md5 de l'archive 2.0.8 : ``4f84c725d1d6e3345eae0a406115e5ff``) - -Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. - -Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. - -Videz le répertoire ``var/cache``. diff --git a/docs/fr/user/upgrade-2.0.x-2.1.1.rst b/docs/fr/user/upgrade-2.0.x-2.1.1.rst new file mode 100644 index 00000000..ec883d10 --- /dev/null +++ b/docs/fr/user/upgrade-2.0.x-2.1.1.rst @@ -0,0 +1,84 @@ +Mettre à jour de la 2.0.x à la 2.1.1 +==================================== + +.. warning:: +Avant cette migration, si vous aviez configuré l'import depuis Pocket en ajoutant votre consumer key dans les paramètres internes, pensez à effectuer une sauvegarde de celle-ci : vous devrez l'ajouter dans la configuration de wallabag après la mise à jour. + +Mise à jour sur un serveur dédié +-------------------------------- + +:: + + 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 + +Mise à jour sur un hébergement mutualisé +---------------------------------------- + +Effectuez une sauvegarde du fichier ``app/config/parameters.yml``. + +Téléchargez la dernière version de wallabag : + +.. code-block:: bash + + wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz + +(hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``) + +Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. + +Vérifiez que votre fichier ``app/config/parameters.yml`` contient tous les paramètres requis. Voici un fichier ``parameters.yml`` par défaut. Si vous ne savez pas quelle valeur mettre à un paramètre, laissez la valeur par défaut. + +.. 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 + +Vous trouverez `ici une documentation détaillée concernant les paramètres `_. + +Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. + +Videz le répertoire ``var/cache``. + +Vous allez devoir également exécuter des requêtes SQL pour mettre à jour votre base de données. Nous partons du principe que le préfixe de vos tables est ``wallabag_`` et que le serveur SQL est un serveur MySQL : + +.. 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/fr/user/upgrade-2.0.x-2.1.y.rst b/docs/fr/user/upgrade-2.0.x-2.1.y.rst deleted file mode 100644 index 952fa737..00000000 --- a/docs/fr/user/upgrade-2.0.x-2.1.y.rst +++ /dev/null @@ -1,66 +0,0 @@ -Mettre à jour de la 2.0.x à la 2.1.y -==================================== - -.. warning:: -Avant cette migration, si vous aviez configuré l'import depuis Pocket en ajoutant votre consumer key dans les paramètres internes, pensez à effectuer une sauvegarde de celle-ci : vous devrez l'ajouter dans la configuration de wallabag après la mise à jour. - -Mise à jour sur un serveur dédié --------------------------------- - -La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.1.1`` par le numéro de la dernière version) : - -:: - - 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 - -Mise à jour sur un hébergement mutualisé ----------------------------------------- - -Effectuez une sauvegarde du fichier ``app/config/parameters.yml``. - -Téléchargez la dernière version de wallabag : - -.. code-block:: bash - - wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -(hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``) - -Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. - -Nous avons ajouté de nouveaux paramètres dans cette nouvelle version. Vous devez donc éditer le fichier ``app/config/parameters.yml`` en ajoutant ces lignes (et en remplaçant par votre configuration) : - -.. 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 - -Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. - -Videz le répertoire ``var/cache``. - -Vous allez devoir également exécuter des requêtes SQL pour mettre à jour votre base de données. Nous partons du principe que le préfixe de vos tables est ``wallabag_`` et que le serveur SQL est un serveur MySQL : - -.. 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/fr/user/upgrade-2.1.x-2.1.y.rst b/docs/fr/user/upgrade-2.1.x-2.1.y.rst new file mode 100644 index 00000000..c048099f --- /dev/null +++ b/docs/fr/user/upgrade-2.1.x-2.1.y.rst @@ -0,0 +1,35 @@ +Mettre à jour de la 2.1.x à la 2.1.y +==================================== + +Mise à jour sur un serveur dédié +-------------------------------- + +La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.1.2`` par le numéro de la dernière version) : + +:: + + 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 + +Mise à jour sur un hébergement mutualisé +---------------------------------------- + +Effectuez une sauvegarde du fichier ``app/config/parameters.yml``. + +Téléchargez la dernière version de wallabag : + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +(hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``) + +Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. + +Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. + +Videz le répertoire ``var/cache``. -- cgit v1.2.3 From 75a1506c276a43f0d3ad65ac1436329e9d5c8c0f Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Wed, 12 Oct 2016 20:33:55 +0200 Subject: translate to German: user/parameters --- docs/de/index.rst | 1 + docs/de/user/parameters.rst | 50 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+) create mode 100644 docs/de/user/parameters.rst (limited to 'docs') diff --git a/docs/de/index.rst b/docs/de/index.rst index b3cd33b0..9ad62013 100644 --- a/docs/de/index.rst +++ b/docs/de/index.rst @@ -44,6 +44,7 @@ Die Dokumentation ist in anderen Sprachen verfügbar : user/filters user/tags user/android + user/parameters .. _dev-docs: diff --git a/docs/de/user/parameters.rst b/docs/de/user/parameters.rst new file mode 100644 index 00000000..4c68fe9e --- /dev/null +++ b/docs/de/user/parameters.rst @@ -0,0 +1,50 @@ +Was bedeuten die Parameter? +=========================== +.. csv-table:: Datenbankparameter + :header: "Name", "Standardwert", "Beschreibung" + + "database_driver", "pdo_sqlite", "Sollte pdo_sqlite oder pdo_mysql oder pdo_pgsql sein" + "database_host", "127.0.0.1", "Hostadresse deiner Datenbank (normalerweise localhost oder 127.0.0.1)" + "database_port", "~", "Port deiner Datenbank (Du kannst ``~`` stehen lassen, um den Standardport zu nutzen)" + "database_name", "symfony", "Benenne deine Datenbank" + "database_user", "root", "Benutzer, der Schreibrecht in der Datenbank hat" + "database_password", "~", "Passwort des Benutzers" + "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "nur für SQLite, definiere, wo die Datenbankdatei abgelegt werden soll. Lass den Parameter leer für andere Datenbanktypen." + "database_table_prefix", "wallabag_", "alle wallabag Tabellen erhalten diesen Präfix im Namen. Du kannst einen ``_`` dafür im Präfix nutzen, um das zu verdeutlichen." + "database_socket", "null", "Wenn deine Datenbank einen Socket statt TCP nutzt, schreibe hier den Pfad zum Socket hin (andere Verbindungsparameter werden dann ignoriert." + +.. csv-table:: Konfiguration, um mit wallabag E-Mails senden zu können + :header: "Name", "Standardwert", "Beschreibung" + + "mailer_transport", "smtp", "Die exakte Transportmethode, um E-Mails zuzustellen. Gültige Werte sind: smtp, gmail, mail, sendmail, null (was das Mailen deaktivert)" + "mailer_host", "127.0.0.1", "Der Host, zu dem sich verbunden wird, wenn SMTP als Transport genutzt wird." + "mailer_user", "~", "Der Benutzername, wenn SMTP als Transport genutzt wird." + "mailer_password", "~", "Das Passwort, wenn SMTP als Transport genutzt wird." + +.. csv-table:: Andere wallabag Optionen + :header: "Name", "Standardwert", "Beschreibung" + + "locale", "en", "Standardsprache deiner wallabag Instanz (wie z.B. en, fr, es, etc.)" + "secret", "ovmpmAWXRCabNlMgzlzFXDYmCFfzGv", "Dieser String sollte einzigartig für deine Applikation sein und er wird genutzt, um sicherheitsrelevanten Operationen mehr Entropie hinzuzufügen." + "twofactor_auth", "true", "true, um Zwei-Faktor-Authentifizierung zu aktivieren" + "twofactor_sender", "no-reply@wallabag.org", "E-Mail-Adresse des Senders der Mails mit dem Code für die Zwei-Faktor-Authentifizierung" + "fosuser_registration", "true", "true, um die Registrierung für jedermann zu aktivieren" + "fosuser_confirmation", "true", "true, um eine Bestätigungsmail für jede Registrierung zu senden" + "from_email", "no-reply@wallabag.org", "E-Mail-Adresse, die im Absenderfeld jeder Mail genutzt wird" + "rss_limit", "50", "Artikellimit für RSS Feeds" + +.. csv-table:: RabbitMQ Konfiguration + :header: "Name", "Standardwert", "Beschreibung" + + "rabbitmq_host", "localhost", "Host deines RabbitMQ" + "rabbitmq_port", "5672", "Port deines RabbitMQ" + "rabbitmq_user", "guest", "Benutzer, der die Queue lesen kann" + "rabbitmq_password", "guest", "Passwort dieses Benutzers" + +.. csv-table:: Redis Konfiguration + :header: "Name", "Standardwert", "Beschreibung" + + "redis_scheme", "tcp", "Bestimmt das Protokoll, dass genutzt wird, um mit Redis zu kommunizieren. Gültige Werte sind: tcp, unix, http" + "redis_host", "localhost", "IP oder Hostname des Zielservers (ignoriert bei Unix Schema)" + "redis_port", "6379", "TCP/IP Port des Zielservers (ignoriert bei Unix Schema)" + "redis_path", "null", "Pfad zur Unix Domain Socket Datei, wenn Redis Unix Domain Sockets nutzt" -- cgit v1.2.3 From f68e351018287ab1998e803b7b1515235b734efc Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Wed, 12 Oct 2016 20:41:15 +0200 Subject: update German user/upgrade-2.0.x-2.1.1 --- docs/de/user/upgrade-2.0.x-2.1.1.rst | 48 +++++++++++++++++++++++++----------- 1 file changed, 34 insertions(+), 14 deletions(-) (limited to 'docs') diff --git a/docs/de/user/upgrade-2.0.x-2.1.1.rst b/docs/de/user/upgrade-2.0.x-2.1.1.rst index eee50fe4..e603f596 100644 --- a/docs/de/user/upgrade-2.0.x-2.1.1.rst +++ b/docs/de/user/upgrade-2.0.x-2.1.1.rst @@ -1,5 +1,5 @@ -Wallabag updaten -================ +Wallabag von 2.0.x auf 2.1.1 updaten +==================================== .. warning:: Wenn du den Import von Pocket durch das Hinzufügen des Consumer Key in den internen Einstellungen konfiguriert hast, fertige bitte ein Backup deines Keys an, bevor du auf das neue Release migrierst: Du wirst den Key nach dem Update in der Konfiguration erneut eintragen müssen. @@ -30,23 +30,43 @@ Lade das neueste Release von wallabag herunter: wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(2.1.1 md5 hash: ``9584a3b60a2b2a4de87f536548caac93``) +(2.1.1 md5 Hashsumme: ``9584a3b60a2b2a4de87f536548caac93``) Entpacke das Archiv in deinen wallabag-Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. Bitte beachte, dass wir in dieser Version neue Parameter hinzugefügt haben. Du musst die Datei ``app/config/parameters.yml`` bearbeiten und die folgenden Zeilen hinzufügen (ersetze die Werte mit deiner Konfiguration): -.. 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 +.. 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 + +Du kannst `hier eine Dokumentation über die Parameter finden`_. Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. -- cgit v1.2.3 From 17064d3c54a26b7ba9ecf2b7fb854a3cf4178915 Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Wed, 12 Oct 2016 20:44:22 +0200 Subject: update German user/upgrade-2.1.x-2.1.y.rst --- docs/de/user/upgrade-2.0.x-2.0.y.rst | 35 ----------------------------------- docs/de/user/upgrade-2.1.x-2.1.y.rst | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+), 35 deletions(-) delete mode 100644 docs/de/user/upgrade-2.0.x-2.0.y.rst create mode 100644 docs/de/user/upgrade-2.1.x-2.1.y.rst (limited to 'docs') diff --git a/docs/de/user/upgrade-2.0.x-2.0.y.rst b/docs/de/user/upgrade-2.0.x-2.0.y.rst deleted file mode 100644 index 5820a0d2..00000000 --- a/docs/de/user/upgrade-2.0.x-2.0.y.rst +++ /dev/null @@ -1,35 +0,0 @@ -Wallabag updaten 2.0.x -> 2.1.x -=============================== - -Update auf einem dedizierten Webserver --------------------------------------- - -Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.0.8`` mit der neuesten Releasenummer): - -:: - - 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 - -Update auf einem Shared Webhosting ----------------------------------- - -Sichere deine ``app/config/parameters.yml`` Datei. - -Lade das neueste Release von wallabag herunter: - -.. code-block:: bash - - wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -(md5 hash: ``4f84c725d1d6e3345eae0a406115e5ff``) - -Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. - -Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. - -Leere den ``var/cache`` Ordner. diff --git a/docs/de/user/upgrade-2.1.x-2.1.y.rst b/docs/de/user/upgrade-2.1.x-2.1.y.rst new file mode 100644 index 00000000..e638ea9b --- /dev/null +++ b/docs/de/user/upgrade-2.1.x-2.1.y.rst @@ -0,0 +1,35 @@ +Wallabag von 2.1.x auf 2.1.y updaten +==================================== + +Update auf einem dedizierten Webserver +-------------------------------------- + +Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.1.2`` mit der neuesten Releasenummer): + +:: + + 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 + +Update auf einem Shared Webhosting +---------------------------------- + +Sichere deine ``app/config/parameters.yml`` Datei. + +Lade das neueste Release von wallabag herunter: + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +(md5 Hashsumme von 2.1.1: ``9584a3b60a2b2a4de87f536548caac93``) + +Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. + +Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. + +Leere den ``var/cache`` Ordner. -- cgit v1.2.3 From a25377cb4c6308710f82f147e27c72e64cead752 Mon Sep 17 00:00:00 2001 From: zertrin Date: Wed, 12 Oct 2016 23:52:19 +0200 Subject: Minor fixes in the english documentation --- docs/en/developer/redis.rst | 2 +- docs/en/user/installation.rst | 10 +++++----- docs/en/user/upgrade-2.0.x-2.1.1.rst | 3 ++- 3 files changed, 8 insertions(+), 7 deletions(-) (limited to 'docs') diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst index 67b6452e..2e2bbbea 100644 --- a/docs/en/developer/redis.rst +++ b/docs/en/developer/redis.rst @@ -35,7 +35,7 @@ Edit your ``parameters.yml`` file to edit Redis configuration. The default one s redis_host: localhost redis_port: 6379 -Enable Redos in wallabag +Enable Redis in wallabag ------------------------ In internal settings, in the **Import** section, enable Redis (with the value 1). diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 248c1995..45e14616 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -8,7 +8,7 @@ wallabag is compatible with PHP >= 5.5, including PHP 7. .. note:: - To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. + To install wallabag easily, we provide 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``). @@ -95,7 +95,7 @@ If you changed the database configuration to use MySQL or PostgreSQL, you need t 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. +We provide you a Docker image to install wallabag easily. Have a look at our repository on `Docker Hub `__ for more information. Command to launch container ^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -194,12 +194,12 @@ After reloading or restarting nginx, you should now be able to access wallabag a .. 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``. + When you want to import large files into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``. Configuration on lighttpd ~~~~~~~~~~~~~~~~~~~~~~~~~ -Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe for wallabag (edit your ``lighttpd.conf`` file and paste this configuration into it): +Assuming you install wallabag in the ``/var/www/wallabag`` folder, here's the recipe for wallabag (edit your ``lighttpd.conf`` file and paste this configuration into it): :: @@ -249,7 +249,7 @@ As soon as we use Apache or Nginx to access to our wallabag instance, and not fr 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). -So the folder ``/var/www/wallabag/web`` has to be accessible by this last one. But this could be not enough if we just care about this folder, because we could meet a blank page or get an error 500 when trying to access to the homepage of the project. +So the folder ``/var/www/wallabag/web`` has to be accessible by this last one. But this may not be enough if we just care about this folder, because we could meet a blank page or get an error 500 when trying to access to the homepage of the project. This is due to the fact that we will need to grant the same rights access on the folder ``/var/www/wallabag/var`` like those we gave on the folder ``/var/www/wallabag/web``. Thus, we fix this problem with the following command: diff --git a/docs/en/user/upgrade-2.0.x-2.1.1.rst b/docs/en/user/upgrade-2.0.x-2.1.1.rst index 2f08b7bd..f5a48592 100644 --- a/docs/en/user/upgrade-2.0.x-2.1.1.rst +++ b/docs/en/user/upgrade-2.0.x-2.1.1.rst @@ -2,7 +2,8 @@ Upgrade from 2.0.x to 2.1.1 =========================== .. 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. + + 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 --------------------------------- -- cgit v1.2.3 From 83634bab228e2200e51a3c732645517a03bfb32d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Thu, 13 Oct 2016 16:56:03 +0200 Subject: Added missing space --- docs/de/user/upgrade-2.0.x-2.1.1.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/de/user/upgrade-2.0.x-2.1.1.rst b/docs/de/user/upgrade-2.0.x-2.1.1.rst index e603f596..db81a1be 100644 --- a/docs/de/user/upgrade-2.0.x-2.1.1.rst +++ b/docs/de/user/upgrade-2.0.x-2.1.1.rst @@ -66,7 +66,7 @@ Bitte beachte, dass wir in dieser Version neue Parameter hinzugefügt haben. Du redis_host: localhost redis_port: 6379 -Du kannst `hier eine Dokumentation über die Parameter finden`_. +Du kannst `hier eine Dokumentation über die Parameter finden `_. Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. -- cgit v1.2.3 From eb7d1b4b308cfaeed7c598b2cba8670fb8ad39f0 Mon Sep 17 00:00:00 2001 From: Kaligule Date: Fri, 14 Oct 2016 09:09:28 +0200 Subject: Mention example instance Namely http://v2.wallabag.org/api/doc, so api methods can be looked up without installing wallabag first. --- docs/en/developer/api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst index 83f0bb8f..4828cddd 100644 --- a/docs/en/developer/api.rst +++ b/docs/en/developer/api.rst @@ -8,7 +8,7 @@ Requirements * wallabag freshly (or not) installed on http://localhost:8000 * ``httpie`` installed on your computer (`see project website `__). Note that you can also adapt the commands using curl or wget. -* all the API methods are documented here http://localhost:8000/api/doc +* all the API methods are documented here http://localhost:8000/api/doc (on your instance) and `on our example instance `_ Creating a new API client ------------------------- -- cgit v1.2.3 From 8edb250caadbe00bcf3297f5318859e3862d428d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Fri, 14 Oct 2016 14:45:32 +0200 Subject: Added information about tagging rules in documentation Fix #2060 --- docs/de/user/configuration.rst | 2 +- docs/en/user/configuration.rst | 2 +- docs/fr/user/configuration.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/de/user/configuration.rst b/docs/de/user/configuration.rst index 67695ff1..4fd6baea 100644 --- a/docs/de/user/configuration.rst +++ b/docs/de/user/configuration.rst @@ -102,7 +102,7 @@ Wenn *readingTime >= 5 AND domainName = "github.com"*, dann tagge als *lange zu Welche Variablen und Operatoren kann ich zum Regeln schreiben nutzen? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Die folgenden Variabel und Operatoren können genutzt werden, um Tagging-Regeln zu erstellen: +Die folgenden Variabel und Operatoren können genutzt werden, um Tagging-Regeln zu erstellen (be careful, for some values, you need to add quotes, for example ``language = "en"``): =========== ============================================== ======== ========== Variable Bedeutung Operator Bedeutung diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst index f4c55dea..f74924df 100644 --- a/docs/en/user/configuration.rst +++ b/docs/en/user/configuration.rst @@ -100,7 +100,7 @@ if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long r Which variables and operators can I use to write rules? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The following variables and operators can be used to create tagging rules: +The following variables and operators can be used to create tagging rules (be careful, for some values, you need to add quotes, for example ``language = "en"``): =========== ============================================== ======== ========== Variable Meaning Operator Meaning diff --git a/docs/fr/user/configuration.rst b/docs/fr/user/configuration.rst index 278f0022..8bfe66f5 100644 --- a/docs/fr/user/configuration.rst +++ b/docs/fr/user/configuration.rst @@ -102,7 +102,7 @@ if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long r Quels variables et opérateurs puis-je utiliser pour écrire mes règles ? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Les variables et opérateurs suivants peuvent être utilisés lors de la création de vos règles : +Les variables et opérateurs suivants peuvent être utilisés lors de la création de vos règles (attention, pour certaines valeurs, vous devez ajouter des guillemets, par exemple ``language = "en"``) : =========== ============================================== ========== ========== Variable Sens Opérateur Sens -- cgit v1.2.3 From 68b8e75f9422fd63cde1c60a8ad13afbfc547f2d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Fri, 14 Oct 2016 14:55:45 +0200 Subject: Fixed french and german doc homepages --- docs/de/index.rst | 4 ++-- docs/fr/index.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/de/index.rst b/docs/de/index.rst index 9ad62013..a380d7bd 100644 --- a/docs/de/index.rst +++ b/docs/de/index.rst @@ -30,8 +30,8 @@ Die Dokumentation ist in anderen Sprachen verfügbar : 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.0.x-2.1.1 user/migration user/import user/create_account diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 082173e5..2a265ff3 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -31,8 +31,8 @@ La documentation est disponible dans d'autres langues : 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.0.x-2.1.1 user/migration user/import user/create_account -- cgit v1.2.3 From 2752053f99420662fb1bf9e4f4ba1be1575ca764 Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Fri, 14 Oct 2016 23:47:37 +0200 Subject: docs/de/user/configuration.rst: German fix for tagging rules docu --- docs/de/user/configuration.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/de/user/configuration.rst b/docs/de/user/configuration.rst index 4fd6baea..71627a52 100644 --- a/docs/de/user/configuration.rst +++ b/docs/de/user/configuration.rst @@ -102,7 +102,7 @@ Wenn *readingTime >= 5 AND domainName = "github.com"*, dann tagge als *lange zu Welche Variablen und Operatoren kann ich zum Regeln schreiben nutzen? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Die folgenden Variabel und Operatoren können genutzt werden, um Tagging-Regeln zu erstellen (be careful, for some values, you need to add quotes, for example ``language = "en"``): +Die folgenden Variablen und Operatoren können genutzt werden, um Tagging-Regeln zu erstellen (sei vorsichtig, denn bei einigen Werten muss du Anführungszeichen hinzufügen, z.B. ``language = "de"``): =========== ============================================== ======== ========== Variable Bedeutung Operator Bedeutung -- cgit v1.2.3 From f878902e6a0ec7a92d6c765b5104efa907ead902 Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Fri, 14 Oct 2016 23:48:50 +0200 Subject: docs/de/user/configuration.rst: German fix for tagging rules docu --- docs/de/user/configuration.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/de/user/configuration.rst b/docs/de/user/configuration.rst index 71627a52..0b0793b1 100644 --- a/docs/de/user/configuration.rst +++ b/docs/de/user/configuration.rst @@ -102,7 +102,7 @@ Wenn *readingTime >= 5 AND domainName = "github.com"*, dann tagge als *lange zu Welche Variablen und Operatoren kann ich zum Regeln schreiben nutzen? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Die folgenden Variablen und Operatoren können genutzt werden, um Tagging-Regeln zu erstellen (sei vorsichtig, denn bei einigen Werten muss du Anführungszeichen hinzufügen, z.B. ``language = "de"``): +Die folgenden Variablen und Operatoren können genutzt werden, um Tagging-Regeln zu erstellen (sei vorsichtig, denn bei einigen Werten musst du Anführungszeichen hinzufügen, z.B. ``language = "de"``): =========== ============================================== ======== ========== Variable Bedeutung Operator Bedeutung -- cgit v1.2.3 From 39c3dd30d2138c1a942911762376f4bddbec4cdb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 17 Oct 2016 11:35:42 +0200 Subject: Removed MD5 hash in documentation --- docs/de/user/upgrade-2.1.x-2.1.y.rst | 2 +- docs/en/user/upgrade-2.1.x-2.1.y.rst | 2 +- docs/fr/user/upgrade-2.1.x-2.1.y.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/de/user/upgrade-2.1.x-2.1.y.rst b/docs/de/user/upgrade-2.1.x-2.1.y.rst index e638ea9b..2f9b7791 100644 --- a/docs/de/user/upgrade-2.1.x-2.1.y.rst +++ b/docs/de/user/upgrade-2.1.x-2.1.y.rst @@ -26,7 +26,7 @@ Lade das neueste Release von wallabag herunter: wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(md5 Hashsumme von 2.1.1: ``9584a3b60a2b2a4de87f536548caac93``) +Du findest die `md5 Hashsumme des neuesten Pakets auf unserer Website `_. Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. diff --git a/docs/en/user/upgrade-2.1.x-2.1.y.rst b/docs/en/user/upgrade-2.1.x-2.1.y.rst index 575f4ba9..62cb7dc0 100644 --- a/docs/en/user/upgrade-2.1.x-2.1.y.rst +++ b/docs/en/user/upgrade-2.1.x-2.1.y.rst @@ -26,7 +26,7 @@ Download the last release of wallabag: 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 `_. Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. diff --git a/docs/fr/user/upgrade-2.1.x-2.1.y.rst b/docs/fr/user/upgrade-2.1.x-2.1.y.rst index c048099f..b6f1a2d0 100644 --- a/docs/fr/user/upgrade-2.1.x-2.1.y.rst +++ b/docs/fr/user/upgrade-2.1.x-2.1.y.rst @@ -26,7 +26,7 @@ Téléchargez la dernière version de wallabag : 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 `_. Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. -- cgit v1.2.3 From fc75009de7cfd1a694a37846b4d5f30b2e3c28ee Mon Sep 17 00:00:00 2001 From: Baptiste Mille-Mathias Date: Sat, 22 Oct 2016 09:14:07 +0200 Subject: Document what to backup in Wallabag Fixes issue #2479 --- docs/en/index.rst | 1 + docs/en/user/backup.rst | 26 ++++++++++++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 docs/en/user/backup.rst (limited to 'docs') diff --git a/docs/en/index.rst b/docs/en/index.rst index 6d85db2b..0ead261b 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -46,6 +46,7 @@ The documentation is available in other languages: user/tags user/android user/parameters + user/backup .. _dev-docs: diff --git a/docs/en/user/backup.rst b/docs/en/user/backup.rst new file mode 100644 index 00000000..784da7e0 --- /dev/null +++ b/docs/en/user/backup.rst @@ -0,0 +1,26 @@ +Backup Wallabag +=============== +Because sometimes you may do a mistake with your Wallabag and lose data or in case you need to move your Wallabag to another server you want to backup your data. +This articles describes what you need to backup. + + +Basic Settings +-------------- +Wallabag stores some basic parameters (like SMTP server or database backend) in the file `app/config/parameters.yml`. + +Database +-------- +As Wallabag supports different kinds of database, the way to perform the backup depends on the database you use, so you need to refer to the vendor documentation. + +Here's some examples: + +- Mysql: http://dev.mysql.com/doc/refman/5.7/en/backup-methods.html +- Posgresql: https://www.postgresql.org/docs/current/static/backup.html + +sqlite +~~~~~~ +To backup the sqlite database, you just need to copy the directory `data/db` from the Wallabag application directory + +Images +------ +The images retrieved by Wallabag are stored under `data/assets/images`. -- cgit v1.2.3 From 89abc0b61b64d0013b03802addd600c78db5f915 Mon Sep 17 00:00:00 2001 From: Baptiste Mille-Mathias Date: Sat, 22 Oct 2016 13:21:53 +0200 Subject: Add missing words in the documentation --- docs/en/user/android.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/en/user/android.rst b/docs/en/user/android.rst index ccbad264..91dcb2fc 100644 --- a/docs/en/user/android.rst +++ b/docs/en/user/android.rst @@ -79,7 +79,7 @@ Known limitations 2FA ~~~ -Currently the does not support two-factor authentication. You should disable that to get the app working. +Currently the Android application does not support two-factor authentication. You should disable that to get the application working. Limited amount of articles with wallabag v2 -- cgit v1.2.3 From 67aa755fb542b5d6ddd77dbac61239cb4e0936da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Sat, 22 Oct 2016 14:16:17 +0200 Subject: Added :fr: documentation for wallabag backup --- docs/de/index.rst | 1 + docs/de/user/backup.rst | 25 +++++++++++++++++++++++++ docs/en/user/backup.rst | 21 ++++++++++----------- docs/fr/index.rst | 1 + docs/fr/user/backup.rst | 26 ++++++++++++++++++++++++++ 5 files changed, 63 insertions(+), 11 deletions(-) create mode 100644 docs/de/user/backup.rst create mode 100644 docs/fr/user/backup.rst (limited to 'docs') diff --git a/docs/de/index.rst b/docs/de/index.rst index a380d7bd..b422bf83 100644 --- a/docs/de/index.rst +++ b/docs/de/index.rst @@ -45,6 +45,7 @@ Die Dokumentation ist in anderen Sprachen verfügbar : user/tags user/android user/parameters + user/backup .. _dev-docs: diff --git a/docs/de/user/backup.rst b/docs/de/user/backup.rst new file mode 100644 index 00000000..51721000 --- /dev/null +++ b/docs/de/user/backup.rst @@ -0,0 +1,25 @@ +Backup wallabag +=============== +Because sometimes you may do a mistake with your wallabag and lose data or in case you need to move your wallabag to another server you want to backup your data. +This articles describes what you need to backup. + +Basic settings +-------------- +wallabag stores some basic parameters (like SMTP server or database backend) in the file `app/config/parameters.yml`. + +Database +-------- +As wallabag supports different kinds of database, the way to perform the backup depends on the database you use, so you need to refer to the vendor documentation. + +Here's some examples: + +- MySQL: http://dev.mysql.com/doc/refman/5.7/en/backup-methods.html +- PostgreSQL: https://www.postgresql.org/docs/current/static/backup.html + +SQLite +~~~~~~ +To backup the SQLite database, you just need to copy the directory `data/db` from the wallabag application directory. + +Images +------ +The images retrieved by wallabag are stored under `data/assets/images` (the images storage will be implemented in wallabag 2.2). diff --git a/docs/en/user/backup.rst b/docs/en/user/backup.rst index 784da7e0..51721000 100644 --- a/docs/en/user/backup.rst +++ b/docs/en/user/backup.rst @@ -1,26 +1,25 @@ -Backup Wallabag +Backup wallabag =============== -Because sometimes you may do a mistake with your Wallabag and lose data or in case you need to move your Wallabag to another server you want to backup your data. +Because sometimes you may do a mistake with your wallabag and lose data or in case you need to move your wallabag to another server you want to backup your data. This articles describes what you need to backup. - -Basic Settings +Basic settings -------------- -Wallabag stores some basic parameters (like SMTP server or database backend) in the file `app/config/parameters.yml`. +wallabag stores some basic parameters (like SMTP server or database backend) in the file `app/config/parameters.yml`. Database -------- -As Wallabag supports different kinds of database, the way to perform the backup depends on the database you use, so you need to refer to the vendor documentation. +As wallabag supports different kinds of database, the way to perform the backup depends on the database you use, so you need to refer to the vendor documentation. Here's some examples: -- Mysql: http://dev.mysql.com/doc/refman/5.7/en/backup-methods.html -- Posgresql: https://www.postgresql.org/docs/current/static/backup.html +- MySQL: http://dev.mysql.com/doc/refman/5.7/en/backup-methods.html +- PostgreSQL: https://www.postgresql.org/docs/current/static/backup.html -sqlite +SQLite ~~~~~~ -To backup the sqlite database, you just need to copy the directory `data/db` from the Wallabag application directory +To backup the SQLite database, you just need to copy the directory `data/db` from the wallabag application directory. Images ------ -The images retrieved by Wallabag are stored under `data/assets/images`. +The images retrieved by wallabag are stored under `data/assets/images` (the images storage will be implemented in wallabag 2.2). diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 2a265ff3..dbb85910 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -46,6 +46,7 @@ La documentation est disponible dans d'autres langues : user/filters user/tags user/parameters + user/backup .. _dev-docs: diff --git a/docs/fr/user/backup.rst b/docs/fr/user/backup.rst new file mode 100644 index 00000000..ec4b1f4d --- /dev/null +++ b/docs/fr/user/backup.rst @@ -0,0 +1,26 @@ +Sauvegarde de wallabag +====================== + +Parce que des fois vous faites des erreurs avec votre installation de wallabag et vous perdez des données ou parce que vous souhaitez migrer votre installation sur un autre serveur, vous souhaitez faire une sauvegarde de vos données. +Cette documentation décrit ce que vous devez sauvegarder. + +Configuration +------------- +wallabag stocke quelques paramètres (comme la configuration SMTP ou les infos de bases de données) dans le fichier `app/config/parameters.yml`. + +Base de données +--------------- +Comme wallabag supporte différentes sortes de bases de données, la manière de sauvegarder dépend du type de base de données que vous utilisez, donc vous devez vous en référez à la documentation correspondante. + +Quelques exemples : + +- MySQL: http://dev.mysql.com/doc/refman/5.7/en/backup-methods.html +- PostgreSQL: https://www.postgresql.org/docs/current/static/backup.html + +SQLite +~~~~~~ +Pour sauvegarder une base SQLite, vous devez juste copier le répertoire `data/db` de votre installation wallabag. + +Images +------ +Les images sauvegardées par wallabag sont stockées dans `data/assets/images` (le stockage des images sera implémenté dans wallabag 2.2). -- cgit v1.2.3 From 2ca1cc0c184d58dc479e3d375a47c3a7ff3b92b2 Mon Sep 17 00:00:00 2001 From: Julian Oster Date: Sat, 22 Oct 2016 21:11:20 +0200 Subject: Translate backup.rst to German --- docs/de/user/backup.rst | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) (limited to 'docs') diff --git a/docs/de/user/backup.rst b/docs/de/user/backup.rst index 51721000..ffe3ce37 100644 --- a/docs/de/user/backup.rst +++ b/docs/de/user/backup.rst @@ -1,25 +1,25 @@ -Backup wallabag -=============== -Because sometimes you may do a mistake with your wallabag and lose data or in case you need to move your wallabag to another server you want to backup your data. -This articles describes what you need to backup. +wallabag sichern +================ +Da es manchmal vorkommen kann, dass dir ein Fehler mit deiner wallabag unterläuft und du Daten verlierst oder deine wallabag auf einen anderen Server verschieben willst, ist eine Sicherung der Daten sicher ratsam. +Dieser Artikel beschreibt, was du für die Sicherung benötigst. -Basic settings --------------- -wallabag stores some basic parameters (like SMTP server or database backend) in the file `app/config/parameters.yml`. +Grundlegende Einstellungen +-------------------------- +wallabag speichert grundlegende Parameter (etwa der SMTP-Server oder das Datenbank-Backend) in der Datei `app/config/parameters.yml`. -Database --------- -As wallabag supports different kinds of database, the way to perform the backup depends on the database you use, so you need to refer to the vendor documentation. +Datenbank +--------- +Da wallabag verschiedene Datenbank-Typen unterstützt, hängt der Weg der Sicherung von dem verwendeten Typ ab. Daher verweisen wir an dieser Stelle auf die entsprechenden Dokumentationen: -Here's some examples: +Hier sind einige Beispiele: - MySQL: http://dev.mysql.com/doc/refman/5.7/en/backup-methods.html - PostgreSQL: https://www.postgresql.org/docs/current/static/backup.html SQLite ~~~~~~ -To backup the SQLite database, you just need to copy the directory `data/db` from the wallabag application directory. +Um die SQLite-Datenbank zu sichern, ist es lediglich notwendig, das Verzeichnis `data/db` aus dem wallabag-Installations-Ordner zu kopieren. -Images +Bilder ------ -The images retrieved by wallabag are stored under `data/assets/images` (the images storage will be implemented in wallabag 2.2). +Die Bilder, die von wallabag empfangen worden, sind unter `data/assets/images` gespeichert (der Bilder-Speicher wird in wallabag 2.2 implementiert). -- cgit v1.2.3