]>
Commit | Line | Data |
---|---|---|
e6ebb14f NL |
1 | Install wallabag |
2 | ================ | |
3 | ||
4 | Requirements | |
5 | ------------ | |
6 | ||
89d95cdd TC |
7 | wallabag is compatible with php >= 5.5 |
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 | - pĥp-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 | ||
e6ebb14f NL |
34 | Installation |
35 | ------------ | |
36 | ||
89d95cdd TC |
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 | ||
e6ebb14f NL |
39 | Install Composer: |
40 | ||
41 | :: | |
42 | ||
43 | curl -s http://getcomposer.org/installer | php | |
44 | ||
89d95cdd TC |
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: | |
e6ebb14f NL |
48 | |
49 | :: | |
50 | ||
51 | SYMFONY_ENV=prod composer create-project wallabag/wallabag wallabag "2.0.*@alpha" --no-dev | |
52 | php bin/console wallabag:install --env=prod | |
53 | ||
89d95cdd TC |
54 | To start php's build-in server and test if everything did install correctly, you can do: |
55 | ||
56 | :: | |
57 | ||
58 | php bin/console server:run --env=prod | |
59 | ||
60 | And access wallabag at http://yourserverip:8000 | |
61 | ||
62 | Installing on Apache | |
63 | -------------------- | |
64 | ||
65 | 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: | |
66 | ||
67 | :: | |
68 | ||
69 | <VirtualHost *:80> | |
70 | ServerName domain.tld | |
71 | ServerAlias www.domain.tld | |
72 | ||
73 | DocumentRoot /var/www/wallabag/web | |
74 | <Directory /var/www/wallabag/web> | |
75 | AllowOverride None | |
76 | Order Allow,Deny | |
77 | Allow from All | |
78 | ||
79 | <IfModule mod_rewrite.c> | |
80 | Options -MultiViews | |
81 | RewriteEngine On | |
82 | RewriteCond %{REQUEST_FILENAME} !-f | |
83 | RewriteRule ^(.*)$ app.php [QSA,L] | |
84 | </IfModule> | |
85 | </Directory> | |
86 | ||
87 | # uncomment the following lines if you install assets as symlinks | |
88 | # or run into problems when compiling LESS/Sass/CoffeScript assets | |
89 | # <Directory /var/www/wallabag> | |
90 | # Options FollowSymlinks | |
91 | # </Directory> | |
92 | ||
93 | # optionally disable the RewriteEngine for the asset directories | |
94 | # which will allow apache to simply reply with a 404 when files are | |
95 | # not found instead of passing the request into the full symfony stack | |
96 | <Directory /var/www/wallabag/web/bundles> | |
97 | <IfModule mod_rewrite.c> | |
98 | RewriteEngine Off | |
99 | </IfModule> | |
100 | </Directory> | |
101 | ErrorLog /var/log/apache2/wallabag_error.log | |
102 | CustomLog /var/log/apache2/wallabag_access.log combined | |
103 | </VirtualHost> | |
104 | ||
105 | After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld. | |
106 | ||
107 | Installing on Nginx | |
108 | ------------------- | |
109 | ||
426bfdc3 | 110 | Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe for wallabag : |
89d95cdd TC |
111 | |
112 | :: | |
113 | ||
114 | server { | |
115 | server_name domain.tld www.domain.tld; | |
116 | root /var/www/wallabag/web; | |
117 | ||
118 | location / { | |
119 | # try to serve file directly, fallback to app.php | |
120 | try_files $uri /app.php$is_args$args; | |
121 | } | |
122 | location ~ ^/app\.php(/|$) { | |
123 | fastcgi_pass unix:/var/run/php5-fpm.sock; | |
124 | fastcgi_split_path_info ^(.+\.php)(/.*)$; | |
125 | include fastcgi_params; | |
126 | # When you are using symlinks to link the document root to the | |
127 | # current version of your application, you should pass the real | |
128 | # application path instead of the path to the symlink to PHP | |
129 | # FPM. | |
130 | # Otherwise, PHP's OPcache may not properly detect changes to | |
131 | # your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126 | |
132 | # for more information). | |
133 | fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name; | |
134 | fastcgi_param DOCUMENT_ROOT $realpath_root; | |
135 | # Prevents URIs that include the front controller. This will 404: | |
136 | # http://domain.tld/app.php/some-path | |
137 | # Remove the internal directive to allow URIs like this | |
138 | internal; | |
139 | } | |
140 | ||
141 | error_log /var/log/nginx/wallabag_error.log; | |
142 | access_log /var/log/nginx/wallabag_access.log; | |
143 | } | |
144 | ||
145 | After reloading or restarting nginx, you should now be able to access wallabag at http://domain.tld. |