From 3fad6c74fe72b50bceb5f1c67c3f81370660634e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 27 Apr 2016 20:30:24 +0200 Subject: Add CLI import for wallabag v2 files --- docs/en/user/migration.rst | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) (limited to 'docs/en') diff --git a/docs/en/user/migration.rst b/docs/en/user/migration.rst index e141ae40..cfbca922 100644 --- a/docs/en/user/migration.rst +++ b/docs/en/user/migration.rst @@ -24,20 +24,38 @@ After creating an user account on your new wallabag v2 instance, you must head o :alt: Import from wallabag v1 :align: center +From wallabag 2.x +----------------- + +From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json. + +.. image:: ../../img/user/export_v2.png + :alt: Export depuis wallabag v2 + :align: center + +From your new wallabag instance, create your user account and click on the link in the menu to proceed to import. Choose import from wallabag v2 and select your json file to upload it. + +.. note:: + If you encounter issues during the export or the import, don't hesitate to `ask for support `__. + Import via command-line interface (CLI) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +--------------------------------------- If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export: :: - bin/console wallabag:import-v1 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod + bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod Please replace values: * ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1) * ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export +If you want to mark all these entries as read, you can add the ``--markAsRead=yes`` option. + +To import a wallabag v2 file, you need to add the option ``--importer=v2``. + You'll have this in return: :: @@ -46,17 +64,3 @@ You'll have this in return: 403 imported 0 already saved End : 05-04-2016 11:36:09 --- - -From wallabag 2.x ------------------ - -From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json. - -.. image:: ../../img/user/export_v2.png - :alt: Export depuis wallabag v2 - :align: center - -From your new wallabag instance, create your user account and click on the link in the menu to proceed to import. Choose import from wallabag v2 and select your json file to upload it. - -.. note:: - If you encounter issues during the export or the import, don't hesitate to `ask for support `__. -- cgit v1.2.3 From 235026e2c708eea306a12f1cc1de3da38593db37 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Thu, 28 Apr 2016 13:41:36 +0200 Subject: Enhance option in command --- docs/en/user/migration.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/en') diff --git a/docs/en/user/migration.rst b/docs/en/user/migration.rst index cfbca922..42062796 100644 --- a/docs/en/user/migration.rst +++ b/docs/en/user/migration.rst @@ -52,7 +52,7 @@ Please replace values: * ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1) * ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export -If you want to mark all these entries as read, you can add the ``--markAsRead=yes`` option. +If you want to mark all these entries as read, you can add the ``--markAsRead`` option. To import a wallabag v2 file, you need to add the option ``--importer=v2``. -- cgit v1.2.3 From eae86d340321a4c24a8808ebdc5242eb619b8998 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 23 May 2016 16:54:46 +0200 Subject: Prepare wallabag 2.0.5 --- docs/en/user/installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/en') diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 41542c45..2c6a2f5f 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -53,7 +53,7 @@ To install wallabag itself, you must run the following commands: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.0.4 + git checkout 2.0.5 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console wallabag:install --env=prod -- cgit v1.2.3 From afbe800be237e5124ba7b4fe3a15680ebd986fc9 Mon Sep 17 00:00:00 2001 From: Even Allmighty Date: Mon, 13 Jun 2016 10:35:05 +0200 Subject: Corrected Regex for lighttpd rewrite --- docs/en/user/installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/en') diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 2c6a2f5f..58d9fb7e 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -226,7 +226,7 @@ Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe dir-listing.activate = "disable" url.rewrite-if-not-file = ( - "^/([^?])(?:\?(.))?" => "/app.php?$1&$2", + "^/([^?]*)(?:\?(.*))?" => "/app.php?$1&$2", "^/([^?]*)" => "/app.php?=$1", ) -- cgit v1.2.3 From 3247b907768b520299bc4adae0adcc599d0b66d8 Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Mon, 23 May 2016 21:41:00 +0200 Subject: translate documentation to German --- docs/en/user/configuration.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/en') diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst index f681d874..f4c55dea 100644 --- a/docs/en/user/configuration.rst +++ b/docs/en/user/configuration.rst @@ -108,7 +108,7 @@ Variable Meaning Operator Meaning title Title of the entry <= Less than… url URL of the entry < Strictly less than… isArchived Whether the entry is archived or not => Greater than… -isStared Whether the entry is starred or not > Strictly greater than… +isStarred Whether the entry is starred or not > Strictly greater than… content The entry's content = Equal to… language The entry's language != Not equal to… mimetype The entry's mime-type OR One rule or another -- cgit v1.2.3 From dc9d76b4906c34a79fbfa6255814f267082033d5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Thu, 1 Sep 2016 13:36:26 +0200 Subject: Added documentation for Readability migration --- docs/en/user/import.rst | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) (limited to 'docs/en') diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst index 63210484..e6c37d72 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst @@ -30,14 +30,25 @@ You need to authorize wallabag to interact with your Pocket account. Your data will be imported. Data import can be a demanding process for your server (we need to work on this import to improve it). -From Instapaper ---------------- - -*Feature not yet implemented in wallabag v2.* - 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). + +Import your data into wallabag 2.x +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Click on ``Import`` link in the menu, on ``Import contents`` in Readability section +and then select your json file and upload it. + +Your data will be imported. Data import can be a demanding process for your server (we need to work on this import to improve it). + +From Instapaper +--------------- + *Feature not yet implemented in wallabag v2.* From HTML or JSON file -- cgit v1.2.3 From 56c778b4152a1b886353933276ee3626e4e8c004 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Fri, 15 Jan 2016 08:24:32 +0100 Subject: 1st draft for rabbitMQ --- docs/en/developer/rabbitmq.rst | 49 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 docs/en/developer/rabbitmq.rst (limited to 'docs/en') diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst new file mode 100644 index 00000000..a17e6e4d --- /dev/null +++ b/docs/en/developer/rabbitmq.rst @@ -0,0 +1,49 @@ +Install RabbitMQ for asynchronous tasks +======================================= + +In order to launch asynchronous tasks (useful for huge imports for example), we use RabbitMQ. + +Requirements +------------ + +You need to have RabbitMQ installed on your server. + +Installation +~~~~~~~~~~~~ + +.. code:: bash + + wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc + apt-key add rabbitmq-signing-key-public.asc + apt-get update + apt-get install rabbitmq-server + +Configuration and launch +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code:: bash + + rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest) + rabbitmq-server -detached + +Stop RabbitMQ +~~~~~~~~~~~~~ + +.. code:: bash + + rabbitmqctl stop + + +Configure RabbitMQ in wallabag +------------------------------ + +Edit your ``parameters.yml`` file to edit RabbitMQ configuration. + +Launch RabbitMQ consumer +------------------------ + +Put this command in a cron job: + +.. code:: bash + + bin/console rabbitmq:consumer entries -w \ No newline at end of file -- cgit v1.2.3 From 03e078d060db410fe56b978cdf45d8eec5e177cb Mon Sep 17 00:00:00 2001 From: Jeremy Benoist Date: Sun, 11 Sep 2016 20:43:16 +0200 Subject: Update docs about worker --- docs/en/developer/rabbitmq.rst | 26 +++++++++++++++--- docs/en/developer/redis.rst | 62 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 84 insertions(+), 4 deletions(-) create mode 100644 docs/en/developer/redis.rst (limited to 'docs/en') diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst index a17e6e4d..8cee45fb 100644 --- a/docs/en/developer/rabbitmq.rst +++ b/docs/en/developer/rabbitmq.rst @@ -1,7 +1,7 @@ Install RabbitMQ for asynchronous tasks ======================================= -In order to launch asynchronous tasks (useful for huge imports for example), we use RabbitMQ. +In order to launch asynchronous tasks (useful for huge imports for example), we can use RabbitMQ. Requirements ------------ @@ -37,13 +37,31 @@ Stop RabbitMQ Configure RabbitMQ in wallabag ------------------------------ -Edit your ``parameters.yml`` file to edit RabbitMQ configuration. +Edit your ``parameters.yml`` file to edit RabbitMQ configuration. The default one should be ok: + +.. code:: yaml + + rabbitmq_host: localhost + rabbitmq_port: 5672 + rabbitmq_user: guest + rabbitmq_password: guest + Launch RabbitMQ consumer ------------------------ -Put this command in a cron job: +Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job: .. code:: bash - bin/console rabbitmq:consumer entries -w \ No newline at end of file + # for Pocket import + bin/console rabbitmq:consumer import_pocket -w + + # for Readbility import + bin/console rabbitmq:consumer import_readability -w + + # for wallabag v1 import + bin/console rabbitmq:consumer import_wallabag_v1 -w + + # for wallabag v2 import + bin/console rabbitmq:consumer import_wallabag_v2 -w diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst new file mode 100644 index 00000000..5748e260 --- /dev/null +++ b/docs/en/developer/redis.rst @@ -0,0 +1,62 @@ +Install Redis for asynchronous tasks +======================================= + +In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis. + +Requirements +------------ + +You need to have Redis installed on your server. + +Installation +~~~~~~~~~~~~ + +.. code:: bash + + apt-get install redis-server + +Launch +~~~~~~ + +The server might be already running after installing, if not you can launch it using: + +.. code:: bash + + redis-server + + +Configure Redis in wallabag +--------------------------- + +Edit your ``parameters.yml`` file to edit Redis configuration. The default one should be ok: + +.. code:: yaml + + redis_host: localhost + redis_port: 6379 + + +Launch Redis consumer +------------------------ + +Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job: + +.. code:: bash + + # for Pocket import + bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log + + # for Readbility import + bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.log + + # for wallabag v1 import + bin/console wallabag:import:redis-worker wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log + + # for wallabag v2 import + bin/console wallabag:import:redis-worker wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log + +If you want to launch the import only for some messages and not all, you can specify this number (here 12) and the worker will stop right after the 12th message : + +.. code:: bash + + bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12 -- cgit v1.2.3 From 78d5da87fa19e9d385514f6ee5ec68f475f4e56d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Thu, 15 Sep 2016 14:58:14 +0200 Subject: Add links to translations in documentation homepage --- docs/en/index.rst | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs/en') diff --git a/docs/en/index.rst b/docs/en/index.rst index 03025ef9..bc3ce4c2 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -17,6 +17,11 @@ The main documentation for this application is organized into a couple sections: * :ref:`user-docs` * :ref:`dev-docs` +The documentation is available in other languages: + +* `Documentation en français `_ +* `Deutsch Dokumentation `_ + .. _user-docs: .. toctree:: -- cgit v1.2.3 From 8fed8d1bacbbcbf606a94497c5b58f49068bd6a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Thu, 25 Aug 2016 15:28:46 +0200 Subject: Add documentation about article sharing --- docs/en/index.rst | 1 + docs/en/user/installation.rst | 16 +++++++++++----- docs/en/user/share.rst | 17 +++++++++++++++++ 3 files changed, 29 insertions(+), 5 deletions(-) create mode 100644 docs/en/user/share.rst (limited to 'docs/en') diff --git a/docs/en/index.rst b/docs/en/index.rst index bc3ce4c2..46450b8f 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -40,6 +40,7 @@ The documentation is available in other languages: user/errors_during_fetching user/annotations user/download_articles + user/share user/filters user/tags user/android diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 763d7c66..3794c757 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -37,7 +37,7 @@ Installation On a dedicated web server (recommended way) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -wallabag uses a large number of 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``). +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: @@ -45,7 +45,14 @@ Install Composer: curl -s http://getcomposer.org/installer | php -You can find specific instructions `here `__: +You can find specific instructions `here `__. + +You also need to install node.js (via `the Download page `__), npm (already install with node.js), bower and grunt: + +:: + + npm install -g bower + npm install -g grunt-cli To install wallabag itself, you must run the following commands: @@ -53,9 +60,8 @@ To install wallabag itself, you must run the following commands: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.0.8 - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console wallabag:install --env=prod + git checkout 2.1 + ./install.sh To start PHP's build-in server and test if everything did install correctly, you can do: diff --git a/docs/en/user/share.rst b/docs/en/user/share.rst new file mode 100644 index 00000000..e99e51ab --- /dev/null +++ b/docs/en/user/share.rst @@ -0,0 +1,17 @@ +Share articles +============== + +When you're reading an article, you can share it. Just click on the share button: + +.. image:: ../../img/user/share.png + :alt: share article + :align: center + +Now, you can share the article: + +- with a public URL (you'll have a light view of the article) +- with a tweet +- into your Shaarli +- with a post in Diaspora* +- to Carrot +- with an email -- cgit v1.2.3 From ce0a32229a8d139115ccd1d247a0ee4f1fedc8a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Thu, 15 Sep 2016 14:26:30 +0200 Subject: Fix wallabag version in documentation --- docs/en/user/installation.rst | 9 +-------- docs/en/user/upgrade.rst | 7 +++---- 2 files changed, 4 insertions(+), 12 deletions(-) (limited to 'docs/en') diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 3794c757..8e9f71d4 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -47,20 +47,13 @@ Install Composer: You can find specific instructions `here `__. -You also need to install node.js (via `the Download page `__), npm (already install with node.js), bower and grunt: - -:: - - npm install -g bower - npm install -g grunt-cli - To install wallabag itself, you must run the following commands: :: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.1 + git checkout 2.1.0 ./install.sh To start PHP's build-in server and test if everything did install correctly, you can do: diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst index 90ed6c70..5c37be95 100644 --- a/docs/en/user/upgrade.rst +++ b/docs/en/user/upgrade.rst @@ -4,15 +4,14 @@ Upgrade wallabag 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): +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.0`` by the last release number): :: 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 + git checkout 2.1.0 + ./install.sh Upgrade on a shared hosting --------------------------- -- cgit v1.2.3 From a7dda1f2bf952d81a0c3ee6a9792db9331919b37 Mon Sep 17 00:00:00 2001 From: Jeremy Benoist Date: Tue, 27 Sep 2016 17:06:32 +0200 Subject: Add Instapaper docs --- docs/en/user/import.rst | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) (limited to 'docs/en') diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst index e6c37d72..758e3816 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst @@ -23,12 +23,11 @@ Now, all is fine to migrate from Pocket. Import your data into wallabag 2.x ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section +Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section and then on ``Connect to Pocket and import data``. You need to authorize wallabag to interact with your Pocket account. -Your data will be imported. Data import can be a demanding process for your server -(we need to work on this import to improve it). +Your data will be imported. Data import can be a demanding process for your server. From Readability ---------------- @@ -41,15 +40,26 @@ On the tools (`https://www.readability.com/tools/`_) 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 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Click on ``Import`` link in the menu, on ``Import contents`` in Instapaper section +and then select your CSV file and upload it. + +Your data will be imported. Data import can be a demanding process for your server. From HTML or JSON file ---------------------- -- cgit v1.2.3 From 084fb0d303efc6edd0bfbf43d96b6cbe48acb2b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 28 Sep 2016 10:02:31 +0200 Subject: Some fixes about upgrade from 2.0.x -> 2.1.0 --- docs/en/conf.py | 2 +- docs/en/user/upgrade.rst | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) (limited to 'docs/en') diff --git a/docs/en/conf.py b/docs/en/conf.py index 86e33704..717b35f1 100644 --- a/docs/en/conf.py +++ b/docs/en/conf.py @@ -12,7 +12,7 @@ source_suffix = '.rst' master_doc = 'index' project = u'wallabag' copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence' -version = '2.0.0' +version = '2.1.0' release = version exclude_patterns = ['_build'] pygments_style = 'sphinx' diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst index 5c37be95..f547f247 100644 --- a/docs/en/user/upgrade.rst +++ b/docs/en/user/upgrade.rst @@ -11,7 +11,9 @@ The last release is published on https://www.wallabag.org/pages/download-wallaba git fetch origin git fetch --tags git checkout 2.1.0 - ./install.sh + ASSETS=build ./install.sh + php bin/console doctrine:migrations:migrate --env=prod + php bin/console cache:clear --env=prod Upgrade on a shared hosting --------------------------- -- cgit v1.2.3 From eef8aeec8fa56519363e90977900f198ff3bd19b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 28 Sep 2016 11:13:20 +0200 Subject: Reordered upgrade documentation --- docs/en/index.rst | 3 ++- docs/en/user/upgrade-2.0.x-2.0.y.rst | 34 ++++++++++++++++++++++++ docs/en/user/upgrade-2.0.x-2.1.0.rst | 50 ++++++++++++++++++++++++++++++++++++ docs/en/user/upgrade.rst | 35 ------------------------- 4 files changed, 86 insertions(+), 36 deletions(-) create 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.0.rst delete mode 100644 docs/en/user/upgrade.rst (limited to 'docs/en') diff --git a/docs/en/index.rst b/docs/en/index.rst index 46450b8f..da23400b 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -30,7 +30,8 @@ The documentation is available in other languages: user/faq user/installation - user/upgrade + user/upgrade-2.0.x-2.1.0 + user/upgrade-2.0.x-2.0.y user/migration user/import user/create_account 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 new file mode 100644 index 00000000..6a0818b3 --- /dev/null +++ b/docs/en/user/upgrade-2.0.x-2.0.y.rst @@ -0,0 +1,34 @@ +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): + +:: + + 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.0.rst b/docs/en/user/upgrade-2.0.x-2.1.0.rst new file mode 100644 index 00000000..3a24ee58 --- /dev/null +++ b/docs/en/user/upgrade-2.0.x-2.1.0.rst @@ -0,0 +1,50 @@ +Upgrading from 2.0.x to 2.1.0 +============================= + +.. 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.0`` by the last release number): + +:: + + git fetch origin + git fetch --tags + git checkout 2.1.0 + ASSETS=build ./install.sh + 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 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. + +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.rst b/docs/en/user/upgrade.rst deleted file mode 100644 index f547f247..00000000 --- a/docs/en/user/upgrade.rst +++ /dev/null @@ -1,35 +0,0 @@ -Upgrade wallabag -================ - -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.0`` by the last release number): - -:: - - git fetch origin - git fetch --tags - git checkout 2.1.0 - ASSETS=build ./install.sh - 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 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. -- cgit v1.2.3 From 9866d39431ca58e4c913b6385ed74287f014c38d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 28 Sep 2016 11:59:35 +0200 Subject: Fixed review --- docs/en/index.rst | 2 +- docs/en/user/upgrade-2.0.x-2.1.0.rst | 50 ---------------------------- docs/en/user/upgrade-2.0.x-2.1.y.rst | 64 ++++++++++++++++++++++++++++++++++++ 3 files changed, 65 insertions(+), 51 deletions(-) delete mode 100644 docs/en/user/upgrade-2.0.x-2.1.0.rst create mode 100644 docs/en/user/upgrade-2.0.x-2.1.y.rst (limited to 'docs/en') diff --git a/docs/en/index.rst b/docs/en/index.rst index da23400b..026d174d 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -30,7 +30,7 @@ The documentation is available in other languages: user/faq user/installation - user/upgrade-2.0.x-2.1.0 + user/upgrade-2.0.x-2.1.y user/upgrade-2.0.x-2.0.y user/migration user/import diff --git a/docs/en/user/upgrade-2.0.x-2.1.0.rst b/docs/en/user/upgrade-2.0.x-2.1.0.rst deleted file mode 100644 index 3a24ee58..00000000 --- a/docs/en/user/upgrade-2.0.x-2.1.0.rst +++ /dev/null @@ -1,50 +0,0 @@ -Upgrading from 2.0.x to 2.1.0 -============================= - -.. 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.0`` by the last release number): - -:: - - git fetch origin - git fetch --tags - git checkout 2.1.0 - ASSETS=build ./install.sh - 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 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. - -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 new file mode 100644 index 00000000..5ae5eb43 --- /dev/null +++ b/docs/en/user/upgrade-2.0.x-2.1.y.rst @@ -0,0 +1,64 @@ +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.0`` by the last release number): + +:: + + git fetch origin + git fetch --tags + git checkout 2.1.0 + ASSETS=build ./install.sh + 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 package: ``4f84c725d1d6e3345eae0a406115e5ff``) + +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'; -- cgit v1.2.3 From cb0096df41229d41a960eb48132202adb83576ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 28 Sep 2016 16:37:02 +0200 Subject: Added links to async config in english doc --- docs/en/index.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/en') diff --git a/docs/en/index.rst b/docs/en/index.rst index 026d174d..beb3816e 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -57,3 +57,5 @@ The documentation is available in other languages: developer/documentation developer/translate developer/maintenance + developer/redis + developer/rabbitmq -- cgit v1.2.3 From 2d8af6fc7fe32dd8788cb89f8c3aec9269cbe33c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Thu, 29 Sep 2016 11:01:15 +0200 Subject: Added french documentation about Redis and RabbitMQ --- docs/en/developer/rabbitmq.rst | 11 ++++++++++- docs/en/developer/redis.rst | 15 ++++++++++++--- 2 files changed, 22 insertions(+), 4 deletions(-) (limited to 'docs/en') diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst index 8cee45fb..63b85106 100644 --- a/docs/en/developer/rabbitmq.rst +++ b/docs/en/developer/rabbitmq.rst @@ -57,11 +57,20 @@ Depending on which service you want to import from you need to enable one (or ma # for Pocket import bin/console rabbitmq:consumer import_pocket -w - # for Readbility import + # for Readability import bin/console rabbitmq:consumer import_readability -w + # for Instapaper import + bin/console rabbitmq:consumer import_instapaper -w + # for wallabag v1 import bin/console rabbitmq:consumer import_wallabag_v1 -w # for wallabag v2 import bin/console rabbitmq:consumer import_wallabag_v2 -w + + # for Firefox import + bin/console rabbitmq:consumer import_firefox -w + + # for Chrome import + bin/console rabbitmq:consumer import_chrome -w diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst index 5748e260..820a52e9 100644 --- a/docs/en/developer/redis.rst +++ b/docs/en/developer/redis.rst @@ -1,5 +1,5 @@ Install Redis for asynchronous tasks -======================================= +==================================== In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis. @@ -37,7 +37,7 @@ Edit your ``parameters.yml`` file to edit Redis configuration. The default one s Launch Redis consumer ------------------------- +--------------------- Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job: @@ -46,15 +46,24 @@ Depending on which service you want to import from you need to enable one (or ma # for Pocket import bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log - # for Readbility import + # for Readability import bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.log + # for Instapaper import + bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log + # for wallabag v1 import bin/console wallabag:import:redis-worker wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log # for wallabag v2 import bin/console wallabag:import:redis-worker wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log + # for Firefox import + bin/console wallabag:import:redis-worker firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log + + # for Chrome import + bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log + If you want to launch the import only for some messages and not all, you can specify this number (here 12) and the worker will stop right after the 12th message : .. code:: bash -- cgit v1.2.3 From 12f7fd004a64756e84cca963886e99225e79ec9a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 3 Oct 2016 09:16:57 +0200 Subject: Prepare wallabag 2.1.0 :rocket: --- docs/en/user/installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/en') diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 8e9f71d4..cc8211d8 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -54,7 +54,7 @@ To install wallabag itself, you must run the following commands: git clone https://github.com/wallabag/wallabag.git cd wallabag git checkout 2.1.0 - ./install.sh + ASSETS=build ./install.sh To start PHP's build-in server and test if everything did install correctly, you can do: -- cgit v1.2.3 From 9d3603147b0a4219a8065861351439cbe5e52772 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 3 Oct 2016 11:16:35 +0200 Subject: Update md5 hash for wallabag 2.1.0 --- docs/en/user/installation.rst | 2 +- docs/en/user/upgrade-2.0.x-2.1.y.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/en') diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index cc8211d8..7954fe0b 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -84,7 +84,7 @@ 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 package: ``4f84c725d1d6e3345eae0a406115e5ff``) +(md5 hash of the 2.1.0 package: ``6c33520e29cc754b687f9cee0398dede``) 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``. 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 index 5ae5eb43..63a77e7c 100644 --- a/docs/en/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/en/user/upgrade-2.0.x-2.1.y.rst @@ -29,7 +29,7 @@ Download the last release of wallabag: wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(md5 hash of the package: ``4f84c725d1d6e3345eae0a406115e5ff``) +(md5 hash of the 2.1.0 package: ``6c33520e29cc754b687f9cee0398dede``) Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. -- cgit v1.2.3 From 8fdb5e5766a6bf5970f268200a6c21fd39693637 Mon Sep 17 00:00:00 2001 From: Jeremy Benoist Date: Mon, 3 Oct 2016 14:21:49 +0200 Subject: Re-add wallabag:install --- docs/en/user/installation.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/en') diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 7954fe0b..82fa6f4e 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -55,6 +55,7 @@ To install wallabag itself, you must run the following commands: cd wallabag git checkout 2.1.0 ASSETS=build ./install.sh + php bin/console wallabag:install --env=prod To start PHP's build-in server and test if everything did install correctly, you can do: -- cgit v1.2.3 From 88d8125a5fa3b5c6c91cb22fc2bef1243d7391fc Mon Sep 17 00:00:00 2001 From: Jeremy Benoist Date: Mon, 3 Oct 2016 14:44:12 +0200 Subject: Ensure cache is clear before upgrading If we changed some namespace / classes, we need to refresh the cache before anything else. --- docs/en/user/upgrade-2.0.x-2.0.y.rst | 1 + docs/en/user/upgrade-2.0.x-2.1.y.rst | 1 + 2 files changed, 2 insertions(+) (limited to 'docs/en') 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 index 6a0818b3..3391c2cd 100644 --- a/docs/en/user/upgrade-2.0.x-2.0.y.rst +++ b/docs/en/user/upgrade-2.0.x-2.0.y.rst @@ -8,6 +8,7 @@ The last release is published on https://www.wallabag.org/pages/download-wallaba :: + rm -rf var/cache/* git fetch origin git fetch --tags git checkout 2.0.8 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 index 63a77e7c..234045ba 100644 --- a/docs/en/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/en/user/upgrade-2.0.x-2.1.y.rst @@ -11,6 +11,7 @@ The last release is published on https://www.wallabag.org/pages/download-wallaba :: + rm -rf var/cache/* git fetch origin git fetch --tags git checkout 2.1.0 -- cgit v1.2.3 From f7265b4b9dbe93b928874d6ec827cfbc27dffbb2 Mon Sep 17 00:00:00 2001 From: Zayon Date: Mon, 3 Oct 2016 23:21:35 +0200 Subject: Add php-bcmath extension to requirements Fix issue #2342 --- docs/en/user/installation.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/en') diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 82fa6f4e..8a26a376 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -22,6 +22,7 @@ You'll need the following extensions for wallabag to work. Some of these may alr - php-curl - php-gettext - php-tokenizer +- php-bcmath wallabag uses PDO to connect to the database, so you'll need one of the following: -- cgit v1.2.3 From f440e282819a1e92e3200cf2e588fc9a0c1278ac Mon Sep 17 00:00:00 2001 From: Jeremy Benoist Date: Tue, 4 Oct 2016 10:25:49 +0200 Subject: Update doc Merge VALIDATE_TRANSLATION_FILE & ASSET build (less build on Travis) --- docs/en/user/installation.rst | 2 +- docs/en/user/upgrade-2.0.x-2.1.y.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/en') diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 82fa6f4e..756eb74c 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -54,7 +54,7 @@ To install wallabag itself, you must run the following commands: git clone https://github.com/wallabag/wallabag.git cd wallabag git checkout 2.1.0 - ASSETS=build ./install.sh + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console wallabag:install --env=prod To start PHP's build-in server and test if everything did install correctly, you can do: 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 index 234045ba..ce5b5441 100644 --- a/docs/en/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/en/user/upgrade-2.0.x-2.1.y.rst @@ -15,7 +15,7 @@ The last release is published on https://www.wallabag.org/pages/download-wallaba git fetch origin git fetch --tags git checkout 2.1.0 - ASSETS=build ./install.sh + 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 -- cgit v1.2.3 From 5958597ba6c54abe0922e1950f301f6f40cdb430 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 3 Oct 2016 21:11:31 +0200 Subject: Prepare wallabag 2.1.1 --- docs/en/user/installation.rst | 2 +- docs/en/user/upgrade-2.0.x-2.1.y.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/en') diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 833a36a6..bab8f0a5 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -54,7 +54,7 @@ To install wallabag itself, you must run the following commands: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.1.0 + git checkout 2.1.1 --force SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console wallabag:install --env=prod 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 index ce5b5441..649ab6ca 100644 --- a/docs/en/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/en/user/upgrade-2.0.x-2.1.y.rst @@ -7,14 +7,14 @@ Before this migration, if you configured the Pocket import by adding your consum 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.0`` by the last release number): +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.0 + 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 -- cgit v1.2.3 From 837247dea48f94644cbc9589b0239265ce33d6f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Tue, 4 Oct 2016 17:43:28 +0200 Subject: Update md5 hash for package --- docs/en/user/installation.rst | 2 +- docs/en/user/upgrade-2.0.x-2.1.y.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/en') diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index bab8f0a5..4aaabd82 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -86,7 +86,7 @@ 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.0 package: ``6c33520e29cc754b687f9cee0398dede``) +(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) 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``. 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 index 649ab6ca..ec353a18 100644 --- a/docs/en/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/en/user/upgrade-2.0.x-2.1.y.rst @@ -30,7 +30,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.0 package: ``6c33520e29cc754b687f9cee0398dede``) +(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. -- cgit v1.2.3 From baf0ffa7df64b1bfe140593fb52f979fef97dbae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Fri, 7 Oct 2016 14:17:13 +0200 Subject: Added documentation about siteconfig fix Found in #2358, thank you @j0k3r --- docs/en/user/errors_during_fetching.rst | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) (limited to 'docs/en') diff --git a/docs/en/user/errors_during_fetching.rst b/docs/en/user/errors_during_fetching.rst index 68892750..615eb2da 100644 --- a/docs/en/user/errors_during_fetching.rst +++ b/docs/en/user/errors_during_fetching.rst @@ -12,9 +12,21 @@ There may be several reasons: How can I help to fix that? --------------------------- -- `by sending us an email with the article's URL `_ -- by trying to fix this article by yourself :) by creating a file for the article. - You can use `this tool `__. +You can `sending us an email with the article's URL `_. + +Or you can also try to fix this problem by yourself. + +You can try to see if it works here: `http://f43.me/feed/test `_ (it uses almost the same way as wallabag to retrieve content). + +If it works here and not on wallabag, it means there are something internally in wallabag that breaks the parser (hard to fix). + +If it doesn't works, try to extract a site config using: `http://siteconfig.fivefilters.org/ `_ (select which part of the content is actually the content). + +You can test it **f43.me** website: click on **Want to try a custom siteconfig?** and put the generated file from siteconfig.fivefilters.org. + +Repeat until you have something ok. + +Then you can submit a pull request to `https://github.com/fivefilters/ftr-site-config `_ which is the global repo for siteconfig files. How can I try to re-fetch this article? --------------------------------------- -- cgit v1.2.3 From 9cfea18a5dbcf0aee8a755396dd25084671e1b02 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Fri, 7 Oct 2016 14:40:32 +0200 Subject: Fixed review --- docs/en/user/errors_during_fetching.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/en') diff --git a/docs/en/user/errors_during_fetching.rst b/docs/en/user/errors_during_fetching.rst index 615eb2da..e8ef6ce6 100644 --- a/docs/en/user/errors_during_fetching.rst +++ b/docs/en/user/errors_during_fetching.rst @@ -14,7 +14,7 @@ How can I help to fix that? You can `sending us an email with the article's URL `_. -Or you can also try to fix this problem by yourself. +Or you can also try to fix this problem by yourself (so we can be focused on improving wallabag internally instead of writing siteconfig :) ). You can try to see if it works here: `http://f43.me/feed/test `_ (it uses almost the same way as wallabag to retrieve content). @@ -22,7 +22,7 @@ If it works here and not on wallabag, it means there are something internally in If it doesn't works, try to extract a site config using: `http://siteconfig.fivefilters.org/ `_ (select which part of the content is actually the content). -You can test it **f43.me** website: click on **Want to try a custom siteconfig?** and put the generated file from siteconfig.fivefilters.org. +You can test it on **f43.me** website: click on **Want to try a custom siteconfig?** and put the generated file from siteconfig.fivefilters.org. Repeat until you have something ok. -- cgit v1.2.3 From fba816c43bdf787d587f2fb11ba7c6b385a40dea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Fri, 7 Oct 2016 15:14:15 +0200 Subject: Added link to fivefilters website --- docs/en/user/errors_during_fetching.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/en') diff --git a/docs/en/user/errors_during_fetching.rst b/docs/en/user/errors_during_fetching.rst index e8ef6ce6..3190b4cc 100644 --- a/docs/en/user/errors_during_fetching.rst +++ b/docs/en/user/errors_during_fetching.rst @@ -16,11 +16,11 @@ You can `sending us an email with the article's URL ` Or you can also try to fix this problem by yourself (so we can be focused on improving wallabag internally instead of writing siteconfig :) ). -You can try to see if it works here: `http://f43.me/feed/test `_ (it uses almost the same way as wallabag to retrieve content). +You can try to see if it works here: `http://f43.me/feed/test `_ (it uses almost the same système as wallabag to retrieve content). -If it works here and not on wallabag, it means there are something internally in wallabag that breaks the parser (hard to fix). +If it works here and not on wallabag, it mean there is something internally in wallabag that breaks the parser (hard to fix: please open an issue about it). -If it doesn't works, try to extract a site config using: `http://siteconfig.fivefilters.org/ `_ (select which part of the content is actually the content). +If it doesn't works, try to extract a site config using: `http://siteconfig.fivefilters.org/ `_ (select which part of the content is actually the content). You can `read this documentation before `_. You can test it on **f43.me** website: click on **Want to try a custom siteconfig?** and put the generated file from siteconfig.fivefilters.org. -- cgit v1.2.3 From 4e5d219663b08c5dfba2aaa885c9cef38097bf7d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Fri, 7 Oct 2016 15:27:05 +0200 Subject: Fixed review --- docs/en/user/errors_during_fetching.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/en') diff --git a/docs/en/user/errors_during_fetching.rst b/docs/en/user/errors_during_fetching.rst index 3190b4cc..6684563a 100644 --- a/docs/en/user/errors_during_fetching.rst +++ b/docs/en/user/errors_during_fetching.rst @@ -16,9 +16,9 @@ You can `sending us an email with the article's URL ` Or you can also try to fix this problem by yourself (so we can be focused on improving wallabag internally instead of writing siteconfig :) ). -You can try to see if it works here: `http://f43.me/feed/test `_ (it uses almost the same système as wallabag to retrieve content). +You can try to see if it works here: `http://f43.me/feed/test `_ (it uses almost the same system as wallabag to retrieve content). -If it works here and not on wallabag, it mean there is something internally in wallabag that breaks the parser (hard to fix: please open an issue about it). +If it works here and not on wallabag, it means there is something internally in wallabag that breaks the parser (hard to fix: please open an issue about it). If it doesn't works, try to extract a site config using: `http://siteconfig.fivefilters.org/ `_ (select which part of the content is actually the content). You can `read this documentation before `_. -- cgit v1.2.3 From ba69216853b25f747591740fb039491692c1f76e Mon Sep 17 00:00:00 2001 From: Jeremy Benoist Date: Sat, 8 Oct 2016 09:39:07 +0200 Subject: Set env to prod in documentation --- docs/en/developer/maintenance.rst | 4 ++-- docs/en/developer/rabbitmq.rst | 14 +++++++------- docs/en/developer/redis.rst | 16 ++++++++-------- 3 files changed, 17 insertions(+), 17 deletions(-) (limited to 'docs/en') diff --git a/docs/en/developer/maintenance.rst b/docs/en/developer/maintenance.rst index 8277fb1f..6d55ed60 100644 --- a/docs/en/developer/maintenance.rst +++ b/docs/en/developer/maintenance.rst @@ -11,7 +11,7 @@ To enable maintenance mode, execute this command: :: - bin/console lexik:maintenance:lock --no-interaction + bin/console lexik:maintenance:lock --no-interaction -e=prod You can set your IP address in ``app/config/config.yml`` if you want to access to wallabag even if maintenance mode is enabled. For example: @@ -29,4 +29,4 @@ To disable maintenance mode, execute this command: :: - bin/console lexik:maintenance:unlock + bin/console lexik:maintenance:unlock -e=prod diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst index 63b85106..ca0b0f3a 100644 --- a/docs/en/developer/rabbitmq.rst +++ b/docs/en/developer/rabbitmq.rst @@ -55,22 +55,22 @@ Depending on which service you want to import from you need to enable one (or ma .. code:: bash # for Pocket import - bin/console rabbitmq:consumer import_pocket -w + bin/console rabbitmq:consumer -e=prod import_pocket -w # for Readability import - bin/console rabbitmq:consumer import_readability -w + bin/console rabbitmq:consumer -e=prod import_readability -w # for Instapaper import - bin/console rabbitmq:consumer import_instapaper -w + bin/console rabbitmq:consumer -e=prod import_instapaper -w # for wallabag v1 import - bin/console rabbitmq:consumer import_wallabag_v1 -w + bin/console rabbitmq:consumer -e=prod import_wallabag_v1 -w # for wallabag v2 import - bin/console rabbitmq:consumer import_wallabag_v2 -w + bin/console rabbitmq:consumer -e=prod import_wallabag_v2 -w # for Firefox import - bin/console rabbitmq:consumer import_firefox -w + bin/console rabbitmq:consumer -e=prod import_firefox -w # for Chrome import - bin/console rabbitmq:consumer import_chrome -w + bin/console rabbitmq:consumer -e=prod import_chrome -w diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst index 820a52e9..005d6e4f 100644 --- a/docs/en/developer/redis.rst +++ b/docs/en/developer/redis.rst @@ -44,28 +44,28 @@ Depending on which service you want to import from you need to enable one (or ma .. code:: bash # for Pocket import - bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log + bin/console wallabag:import:redis-worker -e=prod pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log # for Readability import - bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.log + bin/console wallabag:import:redis-worker -e=prod readability -vv >> /path/to/wallabag/var/logs/redis-readability.log # for Instapaper import - bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log + bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log # for wallabag v1 import - bin/console wallabag:import:redis-worker wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log + bin/console wallabag:import:redis-worker -e=prod wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log # for wallabag v2 import - bin/console wallabag:import:redis-worker wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log + bin/console wallabag:import:redis-worker -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log # for Firefox import - bin/console wallabag:import:redis-worker firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log + bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log # for Chrome import - bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log + bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log If you want to launch the import only for some messages and not all, you can specify this number (here 12) and the worker will stop right after the 12th message : .. code:: bash - bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12 + bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12 -- cgit v1.2.3 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/en/user/android.rst | 10 +++++----- docs/en/user/installation.rst | 32 +++++++++++++++----------------- 2 files changed, 20 insertions(+), 22 deletions(-) (limited to 'docs/en') 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 -- 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/en/developer/testsuite.rst | 10 ++++++++++ docs/en/user/installation.rst | 3 +++ 2 files changed, 13 insertions(+) create mode 100644 docs/en/developer/testsuite.rst (limited to 'docs/en') 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: -- 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/en/user/installation.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) (limited to 'docs/en') 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). -- 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/en') 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/en') 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/en/user/android.rst | 6 +++--- docs/en/user/parameters.rst | 48 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+), 3 deletions(-) create mode 100644 docs/en/user/parameters.rst (limited to 'docs/en') 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/en') 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 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/en') 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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- 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/en/developer/rabbitmq.rst | 4 ++++ docs/en/developer/redis.rst | 4 ++++ 2 files changed, 8 insertions(+) (limited to 'docs/en') 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 --------------------- -- 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/en/user/installation.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs/en') 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``). -- 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/en') 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 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 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) (limited to 'docs/en') 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 -- 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') 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/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/en') 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 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/en') 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/en/user/configuration.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/en') 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') 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