aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/Administrator/install.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/en/Administrator/install.rst')
-rw-r--r--docs/en/Administrator/install.rst200
1 files changed, 200 insertions, 0 deletions
diff --git a/docs/en/Administrator/install.rst b/docs/en/Administrator/install.rst
new file mode 100644
index 00000000..006d8708
--- /dev/null
+++ b/docs/en/Administrator/install.rst
@@ -0,0 +1,200 @@
1Download and install wallabag
2=============================
3
4I don’t want to install wallabag
5--------------------------------
6
7If you can’t or don’t want to install Wallabag on your server, we
8suggest you create a free account on `Framabag`_ which uses our
9software (see :ref:`Framabag account creation`).
10
11I want to install wallabag
12--------------------------
13
14I want to download wallabag manually
15~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16
17`Download the latest wallabag version`_ and unpack it:
18
19::
20
21 wget http://wllbg.org/latest
22 unzip latest
23 mv wallabag-version-number wallabag
24
25Copy the files on your web server. For Ubuntu/Debian, it is the
26directory /var/www/html/ :
27
28::
29
30 sudo mv wallabag /var/www/html/
31
32Then, jump off to next section.
33
34I want to download wallabag via composer
35~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36
37You need to install composer:
38
39::
40
41 curl -s http://getcomposer.org/installer | php
42
43Next, on your web server, run this command:
44
45::
46
47 composer create-project wallabag/wallabag . dev-master
48
49All is downloaded into the current folder.
50
51Prerequisites for your web server
52^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
53
54Wallabag requires that several components to be installed on your web
55server. To make sure your server has all the prerequisites, open in your
56browser the page ``http://monserveur.com/wallabag/install/index.php``.
57
58The components are:
59
60- `PHP 5.3.3 or above`_ **with `PDO`_ support**
61- `XML for PHP`_
62- `PCRE`_
63- `ZLib`_ (otherwise, the processing of compressed pages will be
64 affected)
65- `mbstring`_ anb/or `iconv`_ (otherwise some pages will not be read -
66 even in English)
67- The `DOM/XML`_ extension
68- `Data filtering`_
69- `GD`_ (otherwise, pictures will not be saved)
70- `Tidy for PHP`_ (otherwise, you may encounter problems with some
71 pages)
72- `cURL`_ with ``Parallel URL fetching`` (optionnal)
73- `Parse ini file`_
74- `allow\_url\_fopen`_ (optionnal if cURL is installed)
75- `gettext`_ (required for multi-language support)
76
77Install the missing components before to proceed. For example, to
78install Tidy on Ubuntu/Debian:
79
80::
81
82 sudo apt-get install php5-tidy
83 sudo service apache2 reload
84
85Note : if you’re using IIS as a webserver, you have to disable
86*Anonymous Authentication* and `enable *Basic Authentication*`_ in order
87to be able to login.
88
89Twig installation
90^^^^^^^^^^^^^^^^^
91
92wallabag is build with Twig, a template library. You have to download it
93for wallabag to work. If you cannot install ``composer`` (for example in
94the case of shared hosting), we offer you to download a file which
95includes ``Twig``. This file can be downloaed from the page
96``http://myservur.com/wallabag/install/index.php`` (section TWIG
97INSTALLATION) or directly at http://wllbg.org/vendor. Uncompress it in
98your wallabag directory.
99
100Otherwise, you can use Composer to install ``Twig`` by launching
101``composer`` from your wallabag directory (in the case of Ubuntu/Debian
102too: /var/www/html/wallabag/) by following the commands written on
103screen:
104
105::
106
107 curl -s http://getcomposer.org/installer | php
108 php composer.phar install
109
110Creation of the database.
111^^^^^^^^^^^^^^^^^^^^^^^^^
112
113Wallabag can be installed on different types of databases:
114
115- `SQLite`_. The easiest system of all. No extra configuration needed.
116- `MySQL`_. A well known database system, which is in most cases more
117 efficient than SQLite.
118- `PostgreSQL`_. Some people found it better than MySQL.
119
120We advice you to use MySQL because it is more efficient. In this case,
121you should create a new database (for example ``wallabag``), a new user
122(for example ``wallabag``) and a password (here ``YourPassWord``). To do
123this, you can use ``phpMyAdmin``, or launch the following commands:
124
125::
126
127 mysql -p -u root
128 mysql> CREATE DATABASE wallabag;
129 mysql> GRANT ALL PRIVILEGES ON `wallabag`.* TO 'wallabag'@'localhost' IDENTIFIED BY 'VotreMotdePasse';
130 mysql> exit
131
132*Note:* If you’re using MySQL or Postgresql, you have to **fill all the
133fields**, otherwise the installation will not work and an error message
134will tell you what’s wrong. You must create the database that you will
135use for wallabag manually with a tool like PHPMyAdmin or the console.
136
137Permissions
138~~~~~~~~~~~
139
140Your web server needs a writing access to the ``assets``, ``cache`` and
141``db`` directories. Otherwise, a message will report that the
142installation is impossible:
143
144::
145
146 sudo chown -R www-data:www-data /var/www/html/wallabag
147
148Installation of wallabag. At last.
149~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
150
151Access to wallabag from your web browser:
152``http://votreserveur.com/wallabag``. If your server is correctly
153configured, you directly reach the setup screen.
154
155Select the type of database (``sqlite``, ``mysql`` or ``postgresql``)
156and fill the information about your database. In the case of the databse
157MySQL created before, the standard configuration will be:
158
159::
160
161 Database engine: MySQL
162 Server: localhost
163 Database: wallabag
164 Username: wallabag
165 Password: YourPassWord
166
167Finally, Create your first user and his/her password (different from the
168database user).
169
170Wallabag is now installed.
171
172Login
173-----
174
175From your web browser, you reach the login screen: fill your username
176and your password to connect to your account.
177
178Enjoy!
179
180.. _SQLite: http://php.net/manual/fr/book.sqlite.php
181.. _MySQL: http://php.net/manual/fr/book.mysql.php
182.. _PostgreSQL: http://php.net/manual/fr/book.pgsql.php
183.. _Framabag: https://framabag.org/
184.. _Download the latest wallabag version: http://wllbg.org/latest
185.. _PHP 5.3.3 or above: http://php.net/manual/fr/install.php
186.. _PDO: http://php.net/manual/en/book.pdo.php
187.. _XML for PHP: http://php.net/fr/xml
188.. _PCRE: http://php.net/fr/pcre
189.. _ZLib: http://php.net/en/zlib
190.. _mbstring: http://php.net/en/mbstring
191.. _iconv: http://php.net/en/iconv
192.. _DOM/XML: http://php.net/manual/en/book.dom.php
193.. _Data filtering: http://php.net/manual/fr/book.filter.php
194.. _GD: http://php.net/manual/en/book.image.php
195.. _Tidy for PHP: http://php.net/fr/tidy
196.. _cURL: http://php.net/fr/curl
197.. _Parse ini file: http://uk.php.net/manual/en/function.parse-ini-file.php
198.. _allow\_url\_fopen: http://www.php.net/manual/fr/filesystem.configuration.php#ini.allow-url-fopen
199.. _gettext: http://php.net/manual/fr/book.gettext.php
200.. _enable *Basic Authentication*: https://technet.microsoft.com/en-us/library/cc772009%28v=ws.10%29.aspx