aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/user/installation.rst
diff options
context:
space:
mode:
authorNicolas LÅ“uillet <nicolas@loeuillet.org>2016-10-08 15:10:56 +0200
committerNicolas LÅ“uillet <nicolas@loeuillet.org>2016-10-08 15:10:56 +0200
commit7eff4736a1309ad71a75fa74dc1081a3b2303169 (patch)
treef9cad7366b9d8fb394b4927a754b0acfefef7062 /docs/en/user/installation.rst
parent32d103f702968b494309adcba77bc6226043c6ce (diff)
downloadwallabag-7eff4736a1309ad71a75fa74dc1081a3b2303169.tar.gz
wallabag-7eff4736a1309ad71a75fa74dc1081a3b2303169.tar.zst
wallabag-7eff4736a1309ad71a75fa74dc1081a3b2303169.zip
Cleaned up documentation for installation process
Diffstat (limited to 'docs/en/user/installation.rst')
-rw-r--r--docs/en/user/installation.rst32
1 files changed, 15 insertions, 17 deletions
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
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. 9wallabag 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``).
10
11Install Composer:
12
13::
14
15 curl -s http://getcomposer.org/installer | php
16
17You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__.
18
19You'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 20
11- php-session 21- php-session
12- php-ctype 22- php-ctype
@@ -38,25 +48,13 @@ Installation
38On a dedicated web server (recommended way) 48On a dedicated web server (recommended way)
39~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 49~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
40 50
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: 51To install wallabag itself, you must run the following commands:
52 52
53:: 53::
54 54
55 git clone https://github.com/wallabag/wallabag.git 55 git clone https://github.com/wallabag/wallabag.git
56 cd wallabag 56 cd wallabag
57 git checkout 2.1.1 --force 57 ./install.sh
58 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
59 php bin/console wallabag:install --env=prod
60 58
61To start PHP's build-in server and test if everything did install correctly, you can do: 59To start PHP's build-in server and test if everything did install correctly, you can do:
62 60
@@ -86,18 +84,18 @@ Execute this command to download and extract the latest package:
86 84
87 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package 85 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
88 86
89(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) 87You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
90 88
91Now, read the following documentation to create your virtual host, then access your wallabag. 89Now, 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``. 90If 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 91
94Installation with Docker 92Installation with Docker
95------------------------ 93~~~~~~~~~~~~~~~~~~~~~~~~
96 94
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. 95We 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 96
99Command to launch container 97Command to launch container
100~~~~~~~~~~~~~~~~~~~~~~~~~~~ 98^^^^^^^^^^^^^^^^^^^^^^^^^^^
101 99
102.. code-block:: bash 100.. code-block:: bash
103 101