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