7 wallabag is compatible with PHP >= 5.5, including PHP 7.
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.
26 wallabag uses PDO to connect to the database, so you'll need one of the following:
32 and its corresponding database server.
37 On a dedicated web server (recommended way)
38 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
40 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``).
46 curl -s http://getcomposer.org/installer | php
48 You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__.
50 To install wallabag itself, you must run the following commands:
54 git clone https://github.com/wallabag/wallabag.git
57 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
58 php bin/console wallabag:install --env=prod
60 To start PHP's build-in server and test if everything did install correctly, you can do:
64 php bin/console server:run --env=prod
66 And access wallabag at http://yourserverip:8000
70 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>`__.
75 We provide a package with all dependencies inside.
76 The default configuration uses SQLite for the database. If you want to change these settings, please edit ``app/config/parameters.yml``.
78 We already created a user: login and password are ``wallabag``.
80 .. 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).
82 Execute this command to download and extract the latest package:
86 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
88 (md5 hash of the 2.1.0 package: ``6c33520e29cc754b687f9cee0398dede``)
90 Now, read the following documentation to create your virtual host, then access your wallabag.
91 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 Installation with Docker
94 ------------------------
96 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 Command to launch container
99 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
103 docker pull wallabag/wallabag
108 Configuration on Apache
109 ~~~~~~~~~~~~~~~~~~~~~~~
111 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:
116 ServerName domain.tld
117 ServerAlias www.domain.tld
119 DocumentRoot /var/www/wallabag/web
120 <Directory /var/www/wallabag/web>
125 <IfModule mod_rewrite.c>
128 RewriteCond %{REQUEST_FILENAME} !-f
129 RewriteRule ^(.*)$ app.php [QSA,L]
133 # uncomment the following lines if you install assets as symlinks
134 # or run into problems when compiling LESS/Sass/CoffeScript assets
135 # <Directory /var/www/wallabag>
136 # Options FollowSymlinks
139 # optionally disable the RewriteEngine for the asset directories
140 # which will allow apache to simply reply with a 404 when files are
141 # not found instead of passing the request into the full symfony stack
142 <Directory /var/www/wallabag/web/bundles>
143 <IfModule mod_rewrite.c>
147 ErrorLog /var/log/apache2/wallabag_error.log
148 CustomLog /var/log/apache2/wallabag_access.log combined
151 After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld.
153 Configuration on Nginx
154 ~~~~~~~~~~~~~~~~~~~~~~
156 Assuming you installed wallabag in the ``/var/www/wallabag`` folder, here's the recipe for wallabag :
161 server_name domain.tld www.domain.tld;
162 root /var/www/wallabag/web;
165 # try to serve file directly, fallback to app.php
166 try_files $uri /app.php$is_args$args;
168 location ~ ^/app\.php(/|$) {
169 fastcgi_pass unix:/var/run/php5-fpm.sock;
170 fastcgi_split_path_info ^(.+\.php)(/.*)$;
171 include fastcgi_params;
172 # When you are using symlinks to link the document root to the
173 # current version of your application, you should pass the real
174 # application path instead of the path to the symlink to PHP
176 # Otherwise, PHP's OPcache may not properly detect changes to
177 # your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126
178 # for more information).
179 fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
180 fastcgi_param DOCUMENT_ROOT $realpath_root;
181 # Prevents URIs that include the front controller. This will 404:
182 # http://domain.tld/app.php/some-path
183 # Remove the internal directive to allow URIs like this
187 error_log /var/log/nginx/wallabag_error.log;
188 access_log /var/log/nginx/wallabag_access.log;
191 After reloading or restarting nginx, you should now be able to access wallabag at http://domain.tld.
195 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 Configuration on lighttpd
198 ~~~~~~~~~~~~~~~~~~~~~~~~~
200 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):
212 server.document-root = "/var/www/wallabag/web"
213 server.upload-dirs = ( "/var/cache/lighttpd/uploads" )
214 server.errorlog = "/var/log/lighttpd/error.log"
215 server.pid-file = "/var/run/lighttpd.pid"
216 server.username = "www-data"
217 server.groupname = "www-data"
219 server.follow-symlink = "enable"
220 index-file.names = ( "index.php", "index.html", "index.lighttpd.html")
221 url.access-deny = ( "~", ".inc" )
222 static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" )
223 compress.cache-dir = "/var/cache/lighttpd/compress/"
224 compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" )
225 include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
226 include_shell "/usr/share/lighttpd/create-mime.assign.pl"
227 include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
228 dir-listing.activate = "disable"
230 url.rewrite-if-not-file = (
231 "^/([^?]*)(?:\?(.*))?" => "/app.php?$1&$2",
232 "^/([^?]*)" => "/app.php?=$1",
235 Rights access to the folders of the project
236 -------------------------------------------
241 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 Production environment
244 ~~~~~~~~~~~~~~~~~~~~~~
246 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 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 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 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:
256 chown -R www-data:www-data /var/www/wallabag/var
258 It has to be the same for the following folders
260 * /var/www/wallabag/bin/
261 * /var/www/wallabag/app/config/
262 * /var/www/wallabag/vendor/
263 * /var/www/wallabag/data/
269 chown -R www-data:www-data /var/www/wallabag/bin
270 chown -R www-data:www-data /var/www/wallabag/app/config
271 chown -R www-data:www-data /var/www/wallabag/vendor
272 chown -R www-data:www-data /var/www/wallabag/data/
274 otherwise, sooner or later you will see these error messages:
278 Unable to write to the "bin" directory.
279 file_put_contents(app/config/parameters.yml): failed to open stream: Permission denied
280 file_put_contents(/.../wallabag/vendor/autoload.php): failed to open stream: Permission denied
282 Additional rules for SELinux
283 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
285 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:
289 This will return ``Enforcing`` if SELinux is enabled. Creating a new context involves the following syntax:
291 ``semanage fcontext -a -t <context type> <full path>``
295 ``semanage fcontext -a -t httpd_sys_content_t "/var/www/wallabag(/.*)?"``
297 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:
299 +-----------------------------------+----------------------------+
300 | Full path | Context |
301 +===================================+============================+
302 | /var/www/wallabag(/.*)? | ``httpd_sys_content_t`` |
303 +-----------------------------------+----------------------------+
304 | /var/www/wallabag/data(/.*)? | ``httpd_sys_rw_content_t`` |
305 +-----------------------------------+----------------------------+
306 | /var/www/wallabag/var/logs(/.*)? | ``httpd_log_t`` |
307 +-----------------------------------+----------------------------+
308 | /var/www/wallabag/var/cache(/.*)? | ``httpd_cache_t`` |
309 +-----------------------------------+----------------------------+
311 After creating these contexts, enter the following in order to apply your rules:
313 ``restorecon -R -v /var/www/wallabag``
315 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``.
317 If you're installing the preconfigured latest-v2-package, then an additional rule is needed during the initial setup:
319 ``semanage fcontext -a -t httpd_sys_rw_content_t "/var/www/wallabag/var"``
321 After you successfully access your wallabag and complete the initial setup, this context can be removed:
325 semanage fcontext -d -t httpd_sys_rw_content_t "/var/www/wallabag/var"
326 retorecon -R -v /var/www/wallabag/var