]>
Commit | Line | Data |
---|---|---|
e6ebb14f NL |
1 | Install wallabag |
2 | ================ | |
3 | ||
4 | Requirements | |
5 | ------------ | |
6 | ||
eff75729 | 7 | wallabag is compatible with PHP >= 5.5, including PHP 7. |
89d95cdd | 8 | |
84e3c36e | 9 | .. note:: |
36ef9e27 | 10 | |
a25377cb | 11 | To install wallabag easily, we provide a ``Makefile``, so you need to have the ``make`` tool. |
84e3c36e | 12 | |
7eff4736 NL |
13 | 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``). |
14 | ||
15 | Install Composer: | |
16 | ||
17 | :: | |
18 | ||
7c05d591 | 19 | curl -s https://getcomposer.org/installer | php |
7eff4736 NL |
20 | |
21 | You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__. | |
22 | ||
23 | You'll also 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. | |
89d95cdd TC |
24 | |
25 | - php-session | |
26 | - php-ctype | |
27 | - php-dom | |
5dfd321d | 28 | - php-hash |
89d95cdd TC |
29 | - php-simplexml |
30 | - php-json | |
31 | - php-gd | |
32 | - php-mbstring | |
33 | - php-xml | |
34 | - php-tidy | |
35 | - php-iconv | |
36 | - php-curl | |
37 | - php-gettext | |
38 | - php-tokenizer | |
f7265b4b | 39 | - php-bcmath |
89d95cdd | 40 | |
b5fa6607 | 41 | wallabag uses PDO to connect to the database, so you'll need one of the following: |
89d95cdd | 42 | |
eff75729 NL |
43 | - pdo_mysql |
44 | - pdo_sqlite | |
45 | - pdo_pgsql | |
89d95cdd | 46 | |
b5fa6607 | 47 | and its corresponding database server. |
89d95cdd | 48 | |
e6ebb14f NL |
49 | Installation |
50 | ------------ | |
51 | ||
bba9907d NL |
52 | On a dedicated web server (recommended way) |
53 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
54 | ||
b5fa6607 | 55 | To install wallabag itself, you must run the following commands: |
e6ebb14f NL |
56 | |
57 | :: | |
58 | ||
c1181313 | 59 | git clone https://github.com/wallabag/wallabag.git |
7c122534 | 60 | cd wallabag && make install |
e6ebb14f | 61 | |
bba9907d | 62 | To start PHP's build-in server and test if everything did install correctly, you can do: |
89d95cdd TC |
63 | |
64 | :: | |
65 | ||
7c122534 | 66 | make run |
89d95cdd TC |
67 | |
68 | And access wallabag at http://yourserverip:8000 | |
69 | ||
bba9907d | 70 | .. tip:: |
7704ef5d | 71 | |
b5fa6607 | 72 | 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>`__. |
7704ef5d | 73 | |
bba9907d NL |
74 | On a shared hosting |
75 | ~~~~~~~~~~~~~~~~~~~ | |
76 | ||
b5fa6607 | 77 | We provide a package with all dependencies inside. |
bba9907d NL |
78 | The default configuration uses SQLite for the database. If you want to change these settings, please edit ``app/config/parameters.yml``. |
79 | ||
80 | We already created a user: login and password are ``wallabag``. | |
81 | ||
b5fa6607 | 82 | .. 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). |
bba9907d NL |
83 | |
84 | Execute this command to download and extract the latest package: | |
85 | ||
86 | .. code-block:: bash | |
87 | ||
7c05d591 | 88 | wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package |
bba9907d | 89 | |
7eff4736 | 90 | You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_. |
94d1dae4 | 91 | |
b5fa6607 | 92 | Now, read the following documentation to create your virtual host, then access your wallabag. |
bba9907d NL |
93 | 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``. |
94 | ||
95 | Installation with Docker | |
7eff4736 | 96 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
bba9907d | 97 | |
a25377cb | 98 | We provide you a Docker image to install wallabag easily. Have a look at our repository on `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ for more information. |
89d95cdd | 99 | |
bba9907d | 100 | Command to launch container |
7eff4736 | 101 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
bba9907d NL |
102 | |
103 | .. code-block:: bash | |
104 | ||
105 | docker pull wallabag/wallabag | |
106 | ||
107 | Virtual hosts | |
108 | ------------- | |
109 | ||
110 | Configuration on Apache | |
111 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
112 | ||
0a82d6e2 QT |
113 | Do not forget to active the *rewrite* mod of Apache |
114 | ||
115 | .. code-block:: bash | |
116 | ||
117 | a2enmod rewrite && systemctl reload apache2 | |
118 | ||
bba9907d | 119 | 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: |
89d95cdd TC |
120 | |
121 | :: | |
122 | ||
123 | <VirtualHost *:80> | |
124 | ServerName domain.tld | |
125 | ServerAlias www.domain.tld | |
126 | ||
127 | DocumentRoot /var/www/wallabag/web | |
128 | <Directory /var/www/wallabag/web> | |
129 | AllowOverride None | |
130 | Order Allow,Deny | |
131 | Allow from All | |
132 | ||
133 | <IfModule mod_rewrite.c> | |
134 | Options -MultiViews | |
135 | RewriteEngine On | |
136 | RewriteCond %{REQUEST_FILENAME} !-f | |
137 | RewriteRule ^(.*)$ app.php [QSA,L] | |
138 | </IfModule> | |
139 | </Directory> | |
140 | ||
141 | # uncomment the following lines if you install assets as symlinks | |
142 | # or run into problems when compiling LESS/Sass/CoffeScript assets | |
143 | # <Directory /var/www/wallabag> | |
144 | # Options FollowSymlinks | |
145 | # </Directory> | |
146 | ||
147 | # optionally disable the RewriteEngine for the asset directories | |
148 | # which will allow apache to simply reply with a 404 when files are | |
149 | # not found instead of passing the request into the full symfony stack | |
150 | <Directory /var/www/wallabag/web/bundles> | |
151 | <IfModule mod_rewrite.c> | |
152 | RewriteEngine Off | |
153 | </IfModule> | |
154 | </Directory> | |
155 | ErrorLog /var/log/apache2/wallabag_error.log | |
156 | CustomLog /var/log/apache2/wallabag_access.log combined | |
157 | </VirtualHost> | |
947ccd07 KG |
158 | |
159 | ||
160 | .. tip:: Note for Apache 2.4, in the section `<Directory /var/www/wallabag/web>` you have to replace the directives : | |
161 | ||
162 | :: | |
163 | ||
164 | AllowOverride None | |
165 | Order Allow,Deny | |
166 | Allow from All | |
167 | ||
168 | ||
169 | by | |
170 | ||
171 | :: | |
172 | ||
173 | Require All granted | |
174 | ||
89d95cdd TC |
175 | |
176 | After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld. | |
177 | ||
bba9907d NL |
178 | Configuration on Nginx |
179 | ~~~~~~~~~~~~~~~~~~~~~~ | |
89d95cdd | 180 | |
b5fa6607 | 181 | Assuming you installed wallabag in the ``/var/www/wallabag`` folder, here's the recipe for wallabag : |
89d95cdd TC |
182 | |
183 | :: | |
184 | ||
185 | server { | |
186 | server_name domain.tld www.domain.tld; | |
187 | root /var/www/wallabag/web; | |
188 | ||
189 | location / { | |
190 | # try to serve file directly, fallback to app.php | |
191 | try_files $uri /app.php$is_args$args; | |
192 | } | |
193 | location ~ ^/app\.php(/|$) { | |
194 | fastcgi_pass unix:/var/run/php5-fpm.sock; | |
195 | fastcgi_split_path_info ^(.+\.php)(/.*)$; | |
196 | include fastcgi_params; | |
197 | # When you are using symlinks to link the document root to the | |
198 | # current version of your application, you should pass the real | |
199 | # application path instead of the path to the symlink to PHP | |
200 | # FPM. | |
201 | # Otherwise, PHP's OPcache may not properly detect changes to | |
202 | # your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126 | |
203 | # for more information). | |
204 | fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name; | |
205 | fastcgi_param DOCUMENT_ROOT $realpath_root; | |
206 | # Prevents URIs that include the front controller. This will 404: | |
207 | # http://domain.tld/app.php/some-path | |
208 | # Remove the internal directive to allow URIs like this | |
209 | internal; | |
210 | } | |
211 | ||
ccad5d76 OD |
212 | # return 404 for all other php files not matching the front controller |
213 | # this prevents access to other php files you don't want to be accessible. | |
214 | location ~ \.php$ { | |
215 | return 404; | |
216 | } | |
217 | ||
89d95cdd TC |
218 | error_log /var/log/nginx/wallabag_error.log; |
219 | access_log /var/log/nginx/wallabag_access.log; | |
220 | } | |
221 | ||
222 | After reloading or restarting nginx, you should now be able to access wallabag at http://domain.tld. | |
cea846d4 | 223 | |
bba9907d | 224 | .. tip:: |
cea846d4 | 225 | |
a25377cb | 226 | When you want to import large files into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``. |
9ddf49ba | 227 | |
8b563fc0 | 228 | Configuration on lighttpd |
e546a2d6 NL |
229 | ~~~~~~~~~~~~~~~~~~~~~~~~~ |
230 | ||
a25377cb | 231 | 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): |
e546a2d6 NL |
232 | |
233 | :: | |
234 | ||
235 | server.modules = ( | |
8b563fc0 NL |
236 | "mod_fastcgi", |
237 | "mod_access", | |
238 | "mod_alias", | |
239 | "mod_compress", | |
240 | "mod_redirect", | |
241 | "mod_rewrite", | |
e546a2d6 NL |
242 | ) |
243 | server.document-root = "/var/www/wallabag/web" | |
244 | server.upload-dirs = ( "/var/cache/lighttpd/uploads" ) | |
245 | server.errorlog = "/var/log/lighttpd/error.log" | |
246 | server.pid-file = "/var/run/lighttpd.pid" | |
247 | server.username = "www-data" | |
248 | server.groupname = "www-data" | |
249 | server.port = 80 | |
250 | server.follow-symlink = "enable" | |
251 | index-file.names = ( "index.php", "index.html", "index.lighttpd.html") | |
252 | url.access-deny = ( "~", ".inc" ) | |
253 | static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" ) | |
254 | compress.cache-dir = "/var/cache/lighttpd/compress/" | |
255 | compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" ) | |
256 | include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port | |
257 | include_shell "/usr/share/lighttpd/create-mime.assign.pl" | |
258 | include_shell "/usr/share/lighttpd/include-conf-enabled.pl" | |
259 | dir-listing.activate = "disable" | |
260 | ||
261 | url.rewrite-if-not-file = ( | |
02d10905 | 262 | "^/([^?]*)(?:\?(.*))?" => "/app.php?$1&$2", |
8b563fc0 | 263 | "^/([^?]*)" => "/app.php?=$1", |
e546a2d6 NL |
264 | ) |
265 | ||
9ddf49ba OD |
266 | Rights access to the folders of the project |
267 | ------------------------------------------- | |
268 | ||
bba9907d | 269 | Test environment |
9ddf49ba OD |
270 | ~~~~~~~~~~~~~~~~ |
271 | ||
7c122534 | 272 | When we just want to test wallabag, we just run the command ``make run`` 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. |
9ddf49ba | 273 | |
bba9907d | 274 | Production environment |
9ddf49ba OD |
275 | ~~~~~~~~~~~~~~~~~~~~~~ |
276 | ||
7c122534 | 277 | As soon as we use Apache or Nginx to access to our wallabag instance, and not from the command ``make run`` 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. |
9ddf49ba OD |
278 | |
279 | 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). | |
280 | ||
a25377cb | 281 | So the folder ``/var/www/wallabag/web`` has to be accessible by this last one. But this may not be 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. |
9ddf49ba OD |
282 | |
283 | 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: | |
284 | ||
285 | .. code-block:: bash | |
286 | ||
287 | chown -R www-data:www-data /var/www/wallabag/var | |
ab46a256 OD |
288 | |
289 | It has to be the same for the following folders | |
290 | ||
291 | * /var/www/wallabag/bin/ | |
292 | * /var/www/wallabag/app/config/ | |
293 | * /var/www/wallabag/vendor/ | |
b5fa6607 | 294 | * /var/www/wallabag/data/ |
ab46a256 OD |
295 | |
296 | by entering | |
297 | ||
298 | .. code-block:: bash | |
299 | ||
300 | chown -R www-data:www-data /var/www/wallabag/bin | |
301 | chown -R www-data:www-data /var/www/wallabag/app/config | |
302 | chown -R www-data:www-data /var/www/wallabag/vendor | |
458854f1 | 303 | chown -R www-data:www-data /var/www/wallabag/data/ |
ab46a256 | 304 | |
b5fa6607 | 305 | otherwise, sooner or later you will see these error messages: |
ab46a256 OD |
306 | |
307 | .. code-block:: bash | |
308 | ||
309 | Unable to write to the "bin" directory. | |
310 | file_put_contents(app/config/parameters.yml): failed to open stream: Permission denied | |
311 | file_put_contents(/.../wallabag/vendor/autoload.php): failed to open stream: Permission denied | |
b5fa6607 P |
312 | |
313 | Additional rules for SELinux | |
314 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
315 | ||
316 | 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: | |
317 | ||
318 | ``getenforce`` | |
319 | ||
320 | This will return ``Enforcing`` if SELinux is enabled. Creating a new context involves the following syntax: | |
321 | ||
322 | ``semanage fcontext -a -t <context type> <full path>`` | |
323 | ||
324 | For example: | |
325 | ||
326 | ``semanage fcontext -a -t httpd_sys_content_t "/var/www/wallabag(/.*)?"`` | |
327 | ||
328 | 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: | |
329 | ||
330 | +-----------------------------------+----------------------------+ | |
331 | | Full path | Context | | |
332 | +===================================+============================+ | |
333 | | /var/www/wallabag(/.*)? | ``httpd_sys_content_t`` | | |
334 | +-----------------------------------+----------------------------+ | |
335 | | /var/www/wallabag/data(/.*)? | ``httpd_sys_rw_content_t`` | | |
336 | +-----------------------------------+----------------------------+ | |
337 | | /var/www/wallabag/var/logs(/.*)? | ``httpd_log_t`` | | |
338 | +-----------------------------------+----------------------------+ | |
339 | | /var/www/wallabag/var/cache(/.*)? | ``httpd_cache_t`` | | |
340 | +-----------------------------------+----------------------------+ | |
341 | ||
342 | After creating these contexts, enter the following in order to apply your rules: | |
343 | ||
344 | ``restorecon -R -v /var/www/wallabag`` | |
345 | ||
346 | 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``. | |
347 | ||
348 | If you're installing the preconfigured latest-v2-package, then an additional rule is needed during the initial setup: | |
349 | ||
350 | ``semanage fcontext -a -t httpd_sys_rw_content_t "/var/www/wallabag/var"`` | |
351 | ||
352 | After you successfully access your wallabag and complete the initial setup, this context can be removed: | |
353 | ||
354 | :: | |
355 | ||
356 | semanage fcontext -d -t httpd_sys_rw_content_t "/var/www/wallabag/var" | |
357 | retorecon -R -v /var/www/wallabag/var |