7 wallabag is compatible with PHP >= 5.5, including PHP 7.
11 To install wallabag easily, we provide a ``Makefile``, so you need to have the ``make`` tool.
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``).
19 curl -s https://getcomposer.org/installer | php
21 You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__.
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.
41 wallabag uses PDO to connect to the database, so you'll need one of the following:
47 and its corresponding database server.
52 On a dedicated web server (recommended way)
53 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
55 To install wallabag itself, you must run the following commands:
59 git clone https://github.com/wallabag/wallabag.git
60 cd wallabag && make install
62 To start PHP's build-in server and test if everything did install correctly, you can do:
68 And access wallabag at http://yourserverip:8000
72 To define parameters with environment variables, you have to set these variables with ``SYMFONY__`` prefix. For example, ``SYMFONY__DATABASE_DRIVER``. You can have a look at `Symfony documentation <http://symfony.com/doc/current/cookbook/configuration/external_parameters.html>`__.
77 We provide a package with all dependencies inside.
78 The default configuration uses SQLite for the database. If you want to change these settings, please edit ``app/config/parameters.yml``.
80 We already created a user: login and password are ``wallabag``.
82 .. caution:: With this package, wallabag doesn't check for mandatory extensions used in the application (theses checks are made during ``composer install`` when you have a dedicated web server, see above).
84 Execute this command to download and extract the latest package:
88 wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package
90 You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
92 Now, read the following documentation to create your virtual host, then access your wallabag.
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``.
95 Installation with Docker
96 ~~~~~~~~~~~~~~~~~~~~~~~~
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.
100 Command to launch container
101 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
105 docker pull wallabag/wallabag
110 Configuration on Apache
111 ~~~~~~~~~~~~~~~~~~~~~~~
113 Assuming you install wallabag in the ``/var/www/wallabag`` folder and that you want to use PHP as an Apache module, here's a vhost for wallabag:
118 ServerName domain.tld
119 ServerAlias www.domain.tld
121 DocumentRoot /var/www/wallabag/web
122 <Directory /var/www/wallabag/web>
127 <IfModule mod_rewrite.c>
130 RewriteCond %{REQUEST_FILENAME} !-f
131 RewriteRule ^(.*)$ app.php [QSA,L]
135 # uncomment the following lines if you install assets as symlinks
136 # or run into problems when compiling LESS/Sass/CoffeScript assets
137 # <Directory /var/www/wallabag>
138 # Options FollowSymlinks
141 # optionally disable the RewriteEngine for the asset directories
142 # which will allow apache to simply reply with a 404 when files are
143 # not found instead of passing the request into the full symfony stack
144 <Directory /var/www/wallabag/web/bundles>
145 <IfModule mod_rewrite.c>
149 ErrorLog /var/log/apache2/wallabag_error.log
150 CustomLog /var/log/apache2/wallabag_access.log combined
153 After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld.
155 Configuration on Nginx
156 ~~~~~~~~~~~~~~~~~~~~~~
158 Assuming you installed wallabag in the ``/var/www/wallabag`` folder, here's the recipe for wallabag :
163 server_name domain.tld www.domain.tld;
164 root /var/www/wallabag/web;
167 # try to serve file directly, fallback to app.php
168 try_files $uri /app.php$is_args$args;
170 location ~ ^/app\.php(/|$) {
171 fastcgi_pass unix:/var/run/php5-fpm.sock;
172 fastcgi_split_path_info ^(.+\.php)(/.*)$;
173 include fastcgi_params;
174 # When you are using symlinks to link the document root to the
175 # current version of your application, you should pass the real
176 # application path instead of the path to the symlink to PHP
178 # Otherwise, PHP's OPcache may not properly detect changes to
179 # your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126
180 # for more information).
181 fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
182 fastcgi_param DOCUMENT_ROOT $realpath_root;
183 # Prevents URIs that include the front controller. This will 404:
184 # http://domain.tld/app.php/some-path
185 # Remove the internal directive to allow URIs like this
189 # return 404 for all other php files not matching the front controller
190 # this prevents access to other php files you don't want to be accessible.
195 error_log /var/log/nginx/wallabag_error.log;
196 access_log /var/log/nginx/wallabag_access.log;
199 After reloading or restarting nginx, you should now be able to access wallabag at http://domain.tld.
203 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``.
205 Configuration on lighttpd
206 ~~~~~~~~~~~~~~~~~~~~~~~~~
208 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):
220 server.document-root = "/var/www/wallabag/web"
221 server.upload-dirs = ( "/var/cache/lighttpd/uploads" )
222 server.errorlog = "/var/log/lighttpd/error.log"
223 server.pid-file = "/var/run/lighttpd.pid"
224 server.username = "www-data"
225 server.groupname = "www-data"
227 server.follow-symlink = "enable"
228 index-file.names = ( "index.php", "index.html", "index.lighttpd.html")
229 url.access-deny = ( "~", ".inc" )
230 static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" )
231 compress.cache-dir = "/var/cache/lighttpd/compress/"
232 compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" )
233 include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
234 include_shell "/usr/share/lighttpd/create-mime.assign.pl"
235 include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
236 dir-listing.activate = "disable"
238 url.rewrite-if-not-file = (
239 "^/([^?]*)(?:\?(.*))?" => "/app.php?$1&$2",
240 "^/([^?]*)" => "/app.php?=$1",
243 Rights access to the folders of the project
244 -------------------------------------------
249 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.
251 Production environment
252 ~~~~~~~~~~~~~~~~~~~~~~
254 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.
256 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).
258 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.
260 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:
264 chown -R www-data:www-data /var/www/wallabag/var
266 It has to be the same for the following folders
268 * /var/www/wallabag/bin/
269 * /var/www/wallabag/app/config/
270 * /var/www/wallabag/vendor/
271 * /var/www/wallabag/data/
277 chown -R www-data:www-data /var/www/wallabag/bin
278 chown -R www-data:www-data /var/www/wallabag/app/config
279 chown -R www-data:www-data /var/www/wallabag/vendor
280 chown -R www-data:www-data /var/www/wallabag/data/
282 otherwise, sooner or later you will see these error messages:
286 Unable to write to the "bin" directory.
287 file_put_contents(app/config/parameters.yml): failed to open stream: Permission denied
288 file_put_contents(/.../wallabag/vendor/autoload.php): failed to open stream: Permission denied
290 Additional rules for SELinux
291 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
293 If SELinux is enabled on your system, you will need to configure additional contexts in order for wallabag to function properly. To check if SELinux is enabled, simply enter the following:
297 This will return ``Enforcing`` if SELinux is enabled. Creating a new context involves the following syntax:
299 ``semanage fcontext -a -t <context type> <full path>``
303 ``semanage fcontext -a -t httpd_sys_content_t "/var/www/wallabag(/.*)?"``
305 This will recursively apply the httpd_sys_content_t context to the wallabag directory and all underlying files and folders. The following rules are needed:
307 +-----------------------------------+----------------------------+
308 | Full path | Context |
309 +===================================+============================+
310 | /var/www/wallabag(/.*)? | ``httpd_sys_content_t`` |
311 +-----------------------------------+----------------------------+
312 | /var/www/wallabag/data(/.*)? | ``httpd_sys_rw_content_t`` |
313 +-----------------------------------+----------------------------+
314 | /var/www/wallabag/var/logs(/.*)? | ``httpd_log_t`` |
315 +-----------------------------------+----------------------------+
316 | /var/www/wallabag/var/cache(/.*)? | ``httpd_cache_t`` |
317 +-----------------------------------+----------------------------+
319 After creating these contexts, enter the following in order to apply your rules:
321 ``restorecon -R -v /var/www/wallabag``
323 You can check contexts in a directory by typing ``ls -lZ`` and you can see all of your current rules with ``semanage fcontext -l -C``.
325 If you're installing the preconfigured latest-v2-package, then an additional rule is needed during the initial setup:
327 ``semanage fcontext -a -t httpd_sys_rw_content_t "/var/www/wallabag/var"``
329 After you successfully access your wallabag and complete the initial setup, this context can be removed:
333 semanage fcontext -d -t httpd_sys_rw_content_t "/var/www/wallabag/var"
334 retorecon -R -v /var/www/wallabag/var