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/user/installation.rst') 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/user/installation.rst') 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 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/user/installation.rst | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) (limited to 'docs/en/user/installation.rst') 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: -- 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 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) (limited to 'docs/en/user/installation.rst') 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: -- 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/user/installation.rst') 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 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/en/user/installation.rst') 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``. -- 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/user/installation.rst') 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 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/user/installation.rst') 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 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/en/user/installation.rst') 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: -- 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 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/en/user/installation.rst') 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 -- 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 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/en/user/installation.rst') 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``. -- 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/installation.rst | 32 +++++++++++++++----------------- 1 file changed, 15 insertions(+), 17 deletions(-) (limited to 'docs/en/user/installation.rst') 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/user/installation.rst | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs/en/user/installation.rst') 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/user/installation.rst') 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 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/user/installation.rst') 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 a25377cb4c6308710f82f147e27c72e64cead752 Mon Sep 17 00:00:00 2001 From: zertrin Date: Wed, 12 Oct 2016 23:52:19 +0200 Subject: Minor fixes in the english documentation --- docs/en/user/installation.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/en/user/installation.rst') 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: -- cgit v1.2.3