aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/user/installation.rst
diff options
context:
space:
mode:
authorJeremy Benoist <j0k3r@users.noreply.github.com>2016-10-10 16:58:15 +0200
committerGitHub <noreply@github.com>2016-10-10 16:58:15 +0200
commitbccf7a70bc22171904a5bb82d282e9c956684abc (patch)
treef03a771ac950296aa1a91af363784ec7915eac27 /docs/en/user/installation.rst
parentc99d90455bf2c3bac8a85cc0fdaf60134ae06cb4 (diff)
parentfa4c39b37c1e1a1b52739a070775e9ba0fafe802 (diff)
downloadwallabag-bccf7a70bc22171904a5bb82d282e9c956684abc.tar.gz
wallabag-bccf7a70bc22171904a5bb82d282e9c956684abc.tar.zst
wallabag-bccf7a70bc22171904a5bb82d282e9c956684abc.zip
Merge pull request #2403 from wallabag/cleanup-install-process-in-doc
Cleaned up documentation for installation process
Diffstat (limited to 'docs/en/user/installation.rst')
-rw-r--r--docs/en/user/installation.rst42
1 files changed, 21 insertions, 21 deletions
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index 4aaabd82..e08e0306 100644
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -6,7 +6,20 @@ 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::
10To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool.
11
12wallabag 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``).
13
14Install Composer:
15
16::
17
18 curl -s http://getcomposer.org/installer | php
19
20You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__.
21
22You'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 23
11- php-session 24- php-session
12- php-ctype 25- php-ctype
@@ -38,31 +51,18 @@ Installation
38On a dedicated web server (recommended way) 51On a dedicated web server (recommended way)
39~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 52~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
40 53
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: 54To install wallabag itself, you must run the following commands:
52 55
53:: 56::
54 57
55 git clone https://github.com/wallabag/wallabag.git 58 git clone https://github.com/wallabag/wallabag.git
56 cd wallabag 59 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 60
61To start PHP's build-in server and test if everything did install correctly, you can do: 61To start PHP's build-in server and test if everything did install correctly, you can do:
62 62
63:: 63::
64 64
65 php bin/console server:run --env=prod 65 make run
66 66
67And access wallabag at http://yourserverip:8000 67And access wallabag at http://yourserverip:8000
68 68
@@ -86,18 +86,18 @@ Execute this command to download and extract the latest package:
86 86
87 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package 87 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
88 88
89(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) 89You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
90 90
91Now, read the following documentation to create your virtual host, then access your wallabag. 91Now, 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``. 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``.
93 93
94Installation with Docker 94Installation with Docker
95------------------------ 95~~~~~~~~~~~~~~~~~~~~~~~~
96 96
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. 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.
98 98
99Command to launch container 99Command to launch container
100~~~~~~~~~~~~~~~~~~~~~~~~~~~ 100^^^^^^^^^^^^^^^^^^^^^^^^^^^
101 101
102.. code-block:: bash 102.. code-block:: bash
103 103
@@ -239,12 +239,12 @@ Rights access to the folders of the project
239Test environment 239Test environment
240~~~~~~~~~~~~~~~~ 240~~~~~~~~~~~~~~~~
241 241
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. 242When 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 243
244Production environment 244Production environment
245~~~~~~~~~~~~~~~~~~~~~~ 245~~~~~~~~~~~~~~~~~~~~~~
246 246
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. 247As 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 248
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). 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).
250 250