diff options
Diffstat (limited to 'docs/en/user/installation.rst')
-rw-r--r-- | docs/en/user/installation.rst | 51 |
1 files changed, 26 insertions, 25 deletions
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 4aaabd82..45e14616 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst | |||
@@ -6,7 +6,21 @@ Requirements | |||
6 | 6 | ||
7 | wallabag is compatible with PHP >= 5.5, including PHP 7. | 7 | wallabag is compatible with PHP >= 5.5, including PHP 7. |
8 | 8 | ||
9 | 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. | 9 | .. note:: |
10 | |||
11 | To install wallabag easily, we provide a ``Makefile``, so you need to have the ``make`` tool. | ||
12 | |||
13 | 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``). | ||
14 | |||
15 | Install Composer: | ||
16 | |||
17 | :: | ||
18 | |||
19 | curl -s http://getcomposer.org/installer | php | ||
20 | |||
21 | You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__. | ||
22 | |||
23 | 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. | ||
10 | 24 | ||
11 | - php-session | 25 | - php-session |
12 | - php-ctype | 26 | - php-ctype |
@@ -38,31 +52,18 @@ Installation | |||
38 | On a dedicated web server (recommended way) | 52 | On a dedicated web server (recommended way) |
39 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 53 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
40 | 54 | ||
41 | 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``). | ||
42 | |||
43 | Install Composer: | ||
44 | |||
45 | :: | ||
46 | |||
47 | curl -s http://getcomposer.org/installer | php | ||
48 | |||
49 | You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__. | ||
50 | |||
51 | To install wallabag itself, you must run the following commands: | 55 | To 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 | ||
61 | To start PHP's build-in server and test if everything did install correctly, you can do: | 62 | To 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 | ||
67 | And access wallabag at http://yourserverip:8000 | 68 | And 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``) | 90 | You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_. |
90 | 91 | ||
91 | Now, read the following documentation to create your virtual host, then access your wallabag. | 92 | Now, read the following documentation to create your virtual host, then access your wallabag. |
92 | 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``. | 93 | 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``. |
93 | 94 | ||
94 | Installation with Docker | 95 | Installation with Docker |
95 | ------------------------ | 96 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
96 | 97 | ||
97 | We 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 | We provide you a Docker image to install wallabag easily. Have a look at our repository on `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ for more information. |
98 | 99 | ||
99 | Command to launch container | 100 | Command to launch container |
100 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 101 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
101 | 102 | ||
102 | .. code-block:: bash | 103 | .. code-block:: bash |
103 | 104 | ||
@@ -193,12 +194,12 @@ After reloading or restarting nginx, you should now be able to access wallabag a | |||
193 | 194 | ||
194 | .. tip:: | 195 | .. tip:: |
195 | 196 | ||
196 | 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``. | 197 | 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``. |
197 | 198 | ||
198 | Configuration on lighttpd | 199 | Configuration on lighttpd |
199 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | 200 | ~~~~~~~~~~~~~~~~~~~~~~~~~ |
200 | 201 | ||
201 | 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): | 202 | 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): |
202 | 203 | ||
203 | :: | 204 | :: |
204 | 205 | ||
@@ -239,16 +240,16 @@ Rights access to the folders of the project | |||
239 | Test environment | 240 | Test environment |
240 | ~~~~~~~~~~~~~~~~ | 241 | ~~~~~~~~~~~~~~~~ |
241 | 242 | ||
242 | 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. | 243 | 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. |
243 | 244 | ||
244 | Production environment | 245 | Production environment |
245 | ~~~~~~~~~~~~~~~~~~~~~~ | 246 | ~~~~~~~~~~~~~~~~~~~~~~ |
246 | 247 | ||
247 | 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. | 248 | 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. |
248 | 249 | ||
249 | 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). | 250 | 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). |
250 | 251 | ||
251 | 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. | 252 | 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. |
252 | 253 | ||
253 | 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: | 254 | 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: |
254 | 255 | ||