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