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/user/parameters.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/en/user') 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 -- 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/en/user/upgrade-2.0.x-2.1.1.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/en/user') 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. -- 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/user/installation.rst | 10 +++++----- docs/en/user/upgrade-2.0.x-2.1.1.rst | 3 ++- 2 files changed, 7 insertions(+), 6 deletions(-) (limited to 'docs/en/user') 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 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/en/user/configuration.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/en/user') 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 -- 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/en/user/upgrade-2.1.x-2.1.y.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/en/user') 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. -- 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/user/backup.rst | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 docs/en/user/backup.rst (limited to 'docs/en/user') 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/en/user') 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/en/user/backup.rst | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) (limited to 'docs/en/user') 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). -- cgit v1.2.3