docs/en/user/installation.rst

   1 Install wallabag
   2 ================
   3
   4 Requirements
   5 ------------
   6
   7 wallabag is compatible with php >= 5.5, including php 7.
   8
   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.
  10
  11 - php-session
  12 - php-ctype
  13 - php-dom
  14 - php-hash
  15 - php-simplexml
  16 - php-json
  17 - php-gd
  18 - php-mbstring
  19 - php-xml
  20 - php-tidy
  21 - php-iconv
  22 - php-curl
  23 - php-gettext
  24 - php-tokenizer
  25
  26 wallabag uses PDO to connect to database, so you'll need one of:
  27
  28 - php-pdo_mysql
  29 - php-pdo_sqlite
  30 - php-pdo_pgsql
  31
  32 and it's corresponding database server.
  33
  34 Installation
  35 ------------
  36
  37 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.
  38
  39 Install Composer:
  40
  41 ::
  42
  43     curl -s http://getcomposer.org/installer | php
  44
  45 You can find specific instructions here : __ https://getcomposer.org/doc/00-intro.md
  46
  47 To install wallabag itself, you must run these two commands:
  48
  49 ::
  50
  51     git clone https://github.com/wallabag/wallabag.git
  52     cd wallabag
  53     git checkout 2.0.0-beta.2
  54     SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
  55     php bin/console wallabag:install --env=prod
  56
  57 To start php's build-in server and test if everything did install correctly, you can do:
  58
  59 ::
  60
  61     php bin/console server:run --env=prod
  62
  63 And access wallabag at http://yourserverip:8000
  64
  65 Installing on Apache
  66 --------------------
  67
  68 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:
  69
  70 ::
  71
  72     <VirtualHost *:80>
  73         ServerName domain.tld
  74         ServerAlias www.domain.tld
  75
  76         DocumentRoot /var/www/wallabag/web
  77         <Directory /var/www/wallabag/web>
  78             AllowOverride None
  79             Order Allow,Deny
  80             Allow from All
  81
  82             <IfModule mod_rewrite.c>
  83                 Options -MultiViews
  84                 RewriteEngine On
  85                 RewriteCond %{REQUEST_FILENAME} !-f
  86                 RewriteRule ^(.*)$ app.php [QSA,L]
  87             </IfModule>
  88         </Directory>
  89
  90         # uncomment the following lines if you install assets as symlinks
  91         # or run into problems when compiling LESS/Sass/CoffeScript assets
  92         # <Directory /var/www/wallabag>
  93         #     Options FollowSymlinks
  94         # </Directory>
  95
  96         # optionally disable the RewriteEngine for the asset directories
  97         # which will allow apache to simply reply with a 404 when files are
  98         # not found instead of passing the request into the full symfony stack
  99         <Directory /var/www/wallabag/web/bundles>
 100             <IfModule mod_rewrite.c>
 101                 RewriteEngine Off
 102             </IfModule>
 103         </Directory>
 104         ErrorLog /var/log/apache2/wallabag_error.log
 105         CustomLog /var/log/apache2/wallabag_access.log combined
 106     </VirtualHost>
 107
 108 After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld.
 109
 110 Installing on Nginx
 111 -------------------
 112
 113 Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe for wallabag :
 114
 115 ::
 116
 117     server {
 118         server_name domain.tld www.domain.tld;
 119         root /var/www/wallabag/web;
 120
 121         location / {
 122             # try to serve file directly, fallback to app.php
 123             try_files $uri /app.php$is_args$args;
 124         }
 125         location ~ ^/app\.php(/|$) {
 126             fastcgi_pass unix:/var/run/php5-fpm.sock;
 127             fastcgi_split_path_info ^(.+\.php)(/.*)$;
 128             include fastcgi_params;
 129             # When you are using symlinks to link the document root to the
 130             # current version of your application, you should pass the real
 131             # application path instead of the path to the symlink to PHP
 132             # FPM.
 133             # Otherwise, PHP's OPcache may not properly detect changes to
 134             # your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126
 135             # for more information).
 136             fastcgi_param  SCRIPT_FILENAME  $realpath_root$fastcgi_script_name;
 137             fastcgi_param DOCUMENT_ROOT $realpath_root;
 138             # Prevents URIs that include the front controller. This will 404:
 139             # http://domain.tld/app.php/some-path
 140             # Remove the internal directive to allow URIs like this
 141             internal;
 142         }
 143
 144         error_log /var/log/nginx/wallabag_error.log;
 145         access_log /var/log/nginx/wallabag_access.log;
 146     }
 147
 148 After reloading or restarting nginx, you should now be able to access wallabag at http://domain.tld.