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 You also need to install node.js (via `the Download page <https://nodejs.org/en/download/>`__), npm (already install with node.js), bower and grunt:
55 npm install -g grunt-cli
57 To install wallabag itself, you must run the following commands:
61 git clone https://github.com/wallabag/wallabag.git
66 To start PHP's build-in server and test if everything did install correctly, you can do:
70 php bin/console server:run --env=prod
72 And access wallabag at http://yourserverip:8000
76 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>`__.
81 We provide a package with all dependencies inside.
82 The default configuration uses SQLite for the database. If you want to change these settings, please edit ``app/config/parameters.yml``.
84 We already created a user: login and password are ``wallabag``.
86 .. 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).
88 Execute this command to download and extract the latest package:
92 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
94 (md5 hash of the package: ``4f84c725d1d6e3345eae0a406115e5ff``)
96 Now, read the following documentation to create your virtual host, then access your wallabag.
97 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``.
99 Installation with Docker
100 ------------------------
102 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.
104 Command to launch container
105 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
109 docker pull wallabag/wallabag
114 Configuration on Apache
115 ~~~~~~~~~~~~~~~~~~~~~~~
117 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:
122 ServerName domain.tld
123 ServerAlias www.domain.tld
125 DocumentRoot /var/www/wallabag/web
126 <Directory /var/www/wallabag/web>
131 <IfModule mod_rewrite.c>
134 RewriteCond %{REQUEST_FILENAME} !-f
135 RewriteRule ^(.*)$ app.php [QSA,L]
139 # uncomment the following lines if you install assets as symlinks
140 # or run into problems when compiling LESS/Sass/CoffeScript assets
141 # <Directory /var/www/wallabag>
142 # Options FollowSymlinks
145 # optionally disable the RewriteEngine for the asset directories
146 # which will allow apache to simply reply with a 404 when files are
147 # not found instead of passing the request into the full symfony stack
148 <Directory /var/www/wallabag/web/bundles>
149 <IfModule mod_rewrite.c>
153 ErrorLog /var/log/apache2/wallabag_error.log
154 CustomLog /var/log/apache2/wallabag_access.log combined
157 After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld.
159 Configuration on Nginx
160 ~~~~~~~~~~~~~~~~~~~~~~
162 Assuming you installed wallabag in the ``/var/www/wallabag`` folder, here's the recipe for wallabag :
167 server_name domain.tld www.domain.tld;
168 root /var/www/wallabag/web;
171 # try to serve file directly, fallback to app.php
172 try_files $uri /app.php$is_args$args;
174 location ~ ^/app\.php(/|$) {
175 fastcgi_pass unix:/var/run/php5-fpm.sock;
176 fastcgi_split_path_info ^(.+\.php)(/.*)$;
177 include fastcgi_params;
178 # When you are using symlinks to link the document root to the
179 # current version of your application, you should pass the real
180 # application path instead of the path to the symlink to PHP
182 # Otherwise, PHP's OPcache may not properly detect changes to
183 # your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126
184 # for more information).
185 fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
186 fastcgi_param DOCUMENT_ROOT $realpath_root;
187 # Prevents URIs that include the front controller. This will 404:
188 # http://domain.tld/app.php/some-path
189 # Remove the internal directive to allow URIs like this
193 error_log /var/log/nginx/wallabag_error.log;
194 access_log /var/log/nginx/wallabag_access.log;
197 After reloading or restarting nginx, you should now be able to access wallabag at http://domain.tld.
201 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``.
203 Configuration on lighttpd
204 ~~~~~~~~~~~~~~~~~~~~~~~~~
206 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):
218 server.document-root = "/var/www/wallabag/web"
219 server.upload-dirs = ( "/var/cache/lighttpd/uploads" )
220 server.errorlog = "/var/log/lighttpd/error.log"
221 server.pid-file = "/var/run/lighttpd.pid"
222 server.username = "www-data"
223 server.groupname = "www-data"
225 server.follow-symlink = "enable"
226 index-file.names = ( "index.php", "index.html", "index.lighttpd.html")
227 url.access-deny = ( "~", ".inc" )
228 static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" )
229 compress.cache-dir = "/var/cache/lighttpd/compress/"
230 compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" )
231 include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
232 include_shell "/usr/share/lighttpd/create-mime.assign.pl"
233 include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
234 dir-listing.activate = "disable"
236 url.rewrite-if-not-file = (
237 "^/([^?]*)(?:\?(.*))?" => "/app.php?$1&$2",
238 "^/([^?]*)" => "/app.php?=$1",
241 Rights access to the folders of the project
242 -------------------------------------------
247 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.
249 Production environment
250 ~~~~~~~~~~~~~~~~~~~~~~
252 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.
254 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).
256 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.
258 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:
262 chown -R www-data:www-data /var/www/wallabag/var
264 It has to be the same for the following folders
266 * /var/www/wallabag/bin/
267 * /var/www/wallabag/app/config/
268 * /var/www/wallabag/vendor/
269 * /var/www/wallabag/data/
275 chown -R www-data:www-data /var/www/wallabag/bin
276 chown -R www-data:www-data /var/www/wallabag/app/config
277 chown -R www-data:www-data /var/www/wallabag/vendor
278 chown -R www-data:www-data /var/www/wallabag/data/
280 otherwise, sooner or later you will see these error messages:
284 Unable to write to the "bin" directory.
285 file_put_contents(app/config/parameters.yml): failed to open stream: Permission denied
286 file_put_contents(/.../wallabag/vendor/autoload.php): failed to open stream: Permission denied
288 Additional rules for SELinux
289 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
291 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:
295 This will return ``Enforcing`` if SELinux is enabled. Creating a new context involves the following syntax:
297 ``semanage fcontext -a -t <context type> <full path>``
301 ``semanage fcontext -a -t httpd_sys_content_t "/var/www/wallabag(/.*)?"``
303 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:
305 +-----------------------------------+----------------------------+
306 | Full path | Context |
307 +===================================+============================+
308 | /var/www/wallabag(/.*)? | ``httpd_sys_content_t`` |
309 +-----------------------------------+----------------------------+
310 | /var/www/wallabag/data(/.*)? | ``httpd_sys_rw_content_t`` |
311 +-----------------------------------+----------------------------+
312 | /var/www/wallabag/var/logs(/.*)? | ``httpd_log_t`` |
313 +-----------------------------------+----------------------------+
314 | /var/www/wallabag/var/cache(/.*)? | ``httpd_cache_t`` |
315 +-----------------------------------+----------------------------+
317 After creating these contexts, enter the following in order to apply your rules:
319 ``restorecon -R -v /var/www/wallabag``
321 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``.
323 If you're installing the preconfigured latest-v2-package, then an additional rule is needed during the initial setup:
325 ``semanage fcontext -a -t httpd_sys_rw_content_t "/var/www/wallabag/var"``
327 After you successfully access your wallabag and complete the initial setup, this context can be removed:
331 semanage fcontext -d -t httpd_sys_rw_content_t "/var/www/wallabag/var"
332 retorecon -R -v /var/www/wallabag/var