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 database, so you'll need one of:
32 and it's corresponding database server.
37 On a dedicated web server (recommended way)
38 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
40 wallabag uses a big number of libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you don't already have.
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 these two 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 to the `Symfony documentation <http://symfony.com/doc/current/cookbook/configuration/external_parameters.html>`__.
75 We provide you a package with all dependancies 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 don't check 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 Now, read the following documentation to create your virtual host, then access to your wallabag.
89 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``.
91 Installation with Docker
92 ------------------------
94 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.
96 Command to launch container
97 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
101 docker pull wallabag/wallabag
106 Configuration on Apache
107 ~~~~~~~~~~~~~~~~~~~~~~~
109 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:
114 ServerName domain.tld
115 ServerAlias www.domain.tld
117 DocumentRoot /var/www/wallabag/web
118 <Directory /var/www/wallabag/web>
123 <IfModule mod_rewrite.c>
126 RewriteCond %{REQUEST_FILENAME} !-f
127 RewriteRule ^(.*)$ app.php [QSA,L]
131 # uncomment the following lines if you install assets as symlinks
132 # or run into problems when compiling LESS/Sass/CoffeScript assets
133 # <Directory /var/www/wallabag>
134 # Options FollowSymlinks
137 # optionally disable the RewriteEngine for the asset directories
138 # which will allow apache to simply reply with a 404 when files are
139 # not found instead of passing the request into the full symfony stack
140 <Directory /var/www/wallabag/web/bundles>
141 <IfModule mod_rewrite.c>
145 ErrorLog /var/log/apache2/wallabag_error.log
146 CustomLog /var/log/apache2/wallabag_access.log combined
149 After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld.
151 Configuration on Nginx
152 ~~~~~~~~~~~~~~~~~~~~~~
154 Assuming you install wallabag in the ``/var/www/wallabag`` folder, here's the recipe for wallabag :
159 server_name domain.tld www.domain.tld;
160 root /var/www/wallabag/web;
163 # try to serve file directly, fallback to app.php
164 try_files $uri /app.php$is_args$args;
166 location ~ ^/app\.php(/|$) {
167 fastcgi_pass unix:/var/run/php5-fpm.sock;
168 fastcgi_split_path_info ^(.+\.php)(/.*)$;
169 include fastcgi_params;
170 # When you are using symlinks to link the document root to the
171 # current version of your application, you should pass the real
172 # application path instead of the path to the symlink to PHP
174 # Otherwise, PHP's OPcache may not properly detect changes to
175 # your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126
176 # for more information).
177 fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
178 fastcgi_param DOCUMENT_ROOT $realpath_root;
179 # Prevents URIs that include the front controller. This will 404:
180 # http://domain.tld/app.php/some-path
181 # Remove the internal directive to allow URIs like this
185 error_log /var/log/nginx/wallabag_error.log;
186 access_log /var/log/nginx/wallabag_access.log;
189 After reloading or restarting nginx, you should now be able to access wallabag at http://domain.tld.
193 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``.
195 Configuration on lighttpd
196 ~~~~~~~~~~~~~~~~~~~~~~~~~
198 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):
210 server.document-root = "/var/www/wallabag/web"
211 server.upload-dirs = ( "/var/cache/lighttpd/uploads" )
212 server.errorlog = "/var/log/lighttpd/error.log"
213 server.pid-file = "/var/run/lighttpd.pid"
214 server.username = "www-data"
215 server.groupname = "www-data"
217 server.follow-symlink = "enable"
218 index-file.names = ( "index.php", "index.html", "index.lighttpd.html")
219 url.access-deny = ( "~", ".inc" )
220 static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" )
221 compress.cache-dir = "/var/cache/lighttpd/compress/"
222 compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" )
223 include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
224 include_shell "/usr/share/lighttpd/create-mime.assign.pl"
225 include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
226 dir-listing.activate = "disable"
228 url.rewrite-if-not-file = (
229 "^/([^?])(?:\?(.))?" => "/app.php?$1&$2",
230 "^/([^?]*)" => "/app.php?=$1",
233 Rights access to the folders of the project
234 -------------------------------------------
239 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.
241 Production environment
242 ~~~~~~~~~~~~~~~~~~~~~~
244 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.
246 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).
248 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.
250 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:
254 chown -R www-data:www-data /var/www/wallabag/var