aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/user/installation.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/en/user/installation.rst')
-rw-r--r--docs/en/user/installation.rst43
1 files changed, 22 insertions, 21 deletions
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index 4aaabd82..248c1995 100644
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -6,7 +6,21 @@ Requirements
6 6
7wallabag is compatible with PHP >= 5.5, including PHP 7. 7wallabag is compatible with PHP >= 5.5, including PHP 7.
8 8
9You'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. 9.. note::
10
11 To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool.
12
13wallabag 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``).
14
15Install Composer:
16
17::
18
19 curl -s http://getcomposer.org/installer | php
20
21You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__.
22
23You'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.
10 24
11- php-session 25- php-session
12- php-ctype 26- php-ctype
@@ -38,31 +52,18 @@ Installation
38On a dedicated web server (recommended way) 52On a dedicated web server (recommended way)
39~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 53~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
40 54
41wallabag 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``).
42
43Install Composer:
44
45::
46
47 curl -s http://getcomposer.org/installer | php
48
49You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__.
50
51To install wallabag itself, you must run the following commands: 55To install wallabag itself, you must run the following commands:
52 56
53:: 57::
54 58
55 git clone https://github.com/wallabag/wallabag.git 59 git clone https://github.com/wallabag/wallabag.git
56 cd wallabag 60 cd wallabag && make install
57 git checkout 2.1.1 --force
58 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
59 php bin/console wallabag:install --env=prod
60 61
61To start PHP's build-in server and test if everything did install correctly, you can do: 62To start PHP's build-in server and test if everything did install correctly, you can do:
62 63
63:: 64::
64 65
65 php bin/console server:run --env=prod 66 make run
66 67
67And access wallabag at http://yourserverip:8000 68And access wallabag at http://yourserverip:8000
68 69
@@ -86,18 +87,18 @@ Execute this command to download and extract the latest package:
86 87
87 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package 88 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
88 89
89(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) 90You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
90 91
91Now, read the following documentation to create your virtual host, then access your wallabag. 92Now, read the following documentation to create your virtual host, then access your wallabag.
92If 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``. 93If 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``.
93 94
94Installation with Docker 95Installation with Docker
95------------------------ 96~~~~~~~~~~~~~~~~~~~~~~~~
96 97
97We provide you a Docker image to install wallabag easily. Have a look to our repository on `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ to have more information. 98We provide you a Docker image to install wallabag easily. Have a look to our repository on `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ to have more information.
98 99
99Command to launch container 100Command to launch container
100~~~~~~~~~~~~~~~~~~~~~~~~~~~ 101^^^^^^^^^^^^^^^^^^^^^^^^^^^
101 102
102.. code-block:: bash 103.. code-block:: bash
103 104
@@ -239,12 +240,12 @@ Rights access to the folders of the project
239Test environment 240Test environment
240~~~~~~~~~~~~~~~~ 241~~~~~~~~~~~~~~~~
241 242
242When 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. 243When 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.
243 244
244Production environment 245Production environment
245~~~~~~~~~~~~~~~~~~~~~~ 246~~~~~~~~~~~~~~~~~~~~~~
246 247
247As 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. 248As 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.
248 249
249To 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). 250To 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).
250 251