1 Installation von wallabag
2 =========================
7 wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7.
11 To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool.
13 wallabag nutzt eine große Anzahl an Bibliotheken, um zu funktionieren. Diese Bibliotheken müssen mit einem Tool namens Composer installiert werden. Du musst es installieren sofern du es bisher noch nicht gemacht hast.
15 Composer installieren:
19 curl -s https://getcomposer.org/installer | php
21 Du kannst eine spezifische Anleitung `hier <https://getcomposer.org/doc/00-intro.md>`__ finden.
23 Du benötigst die folgenden Extensions damit wallabag funktioniert. Einige von diesen sind vielleicht schon in deiner Version von PHP aktiviert, somit musst du eventuell
24 nicht alle folgenden Pakete installieren.
42 wallabag nutzt PDO, um sich mit der Datenbank zu verbinden, darum benötigst du eines der folgenden Komponenten:
48 und dessen dazugehörigen Datenbankserver.
53 Auf einem dedizierten Webserver (empfohlener Weg)
54 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
56 Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen:
60 git clone https://github.com/wallabag/wallabag.git
61 cd wallabag && make install
63 Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen:
69 und wallabag unter http://deineserverip:8000 erreichen.
73 Um Parameter mit Umgebungsvariable zu definieren, musst du die Variable mit dem ``SYMFONY__`` Präfix setzen. Zum Beispiel ``SYMFONY__DATABASE_DRIVER``. Du kannst einen Blick die `Symfony Dokumentation <http://symfony.com/doc/current/cookbook/configuration/external_parameters.html>`__ werfen.
75 Auf einem geteilten Webhosting
76 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
78 Wir stellen ein Paket inkl. aller Abhängigkeiten bereit.
79 Die Standardkonfiguration nutzt SQLite für die Datenbank. Wenn du diese Einstellung ändern willst, ändere bitte ``app/config/parameters.yml``.
81 Wir haben bereits einen Nutzer erstellt: Login und Passwort sind ``wallabag``.
83 .. caution:: Mit diesem Paket überprüft wallabag nicht die von der Applikation gebrauchten Exentions (diese Tests werden während ``composer install`` durchgeführt wenn du einen dedizierten Webserver hast, siehe oben).
85 Führe dieses Kommando aus, um das neueste Paket herunterzuladen und zu entpacken:
89 wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package
91 Du findest die `md5 Hashsumme des neuesten Pakets auf unserer Website <https://www.wallabag.org/pages/download-wallabag.html>`_.
93 Jetzt lies die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf dein wallabag zu.
94 Wenn du die Datenbankkonfiguration eingestellt hast, MySQL oder PostgreSQL zu nutzen, musst du einen Nutzer über das folgende Kommando erstellen ``php bin/console wallabag:install --env=prod``.
96 Installation mit Docker
97 ~~~~~~~~~~~~~~~~~~~~~~~
99 Wir stellen ein Docker Image zu Verfügung, um wallabag einfach zu installieren. Schaue in unser Repository in unserem `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__, um mehr Informationen zu erhalten.
101 Kommando, um den Container zu starten
102 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
106 docker pull wallabag/wallabag
111 Konfiguration von Apache
112 ~~~~~~~~~~~~~~~~~~~~~~~~
114 Vergiss nicht, die *rewrite* mod von Apache zu aktivieren.
118 a2enmod rewrite && systemctl reload apache2
120 Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren und du willst PHP als Apache Modul nutzen, dann ist hier ein vhost für wallabag:
125 ServerName domain.tld
126 ServerAlias www.domain.tld
128 DocumentRoot /var/www/wallabag/web
129 <Directory /var/www/wallabag/web>
134 <IfModule mod_rewrite.c>
137 RewriteCond %{REQUEST_FILENAME} !-f
138 RewriteRule ^(.*)$ app.php [QSA,L]
142 # uncomment the following lines if you install assets as symlinks
143 # or run into problems when compiling LESS/Sass/CoffeScript assets
144 # <Directory /var/www/wallabag>
145 # Options FollowSymlinks
148 # optionally disable the RewriteEngine for the asset directories
149 # which will allow apache to simply reply with a 404 when files are
150 # not found instead of passing the request into the full symfony stack
151 <Directory /var/www/wallabag/web/bundles>
152 <IfModule mod_rewrite.c>
156 ErrorLog /var/log/apache2/wallabag_error.log
157 CustomLog /var/log/apache2/wallabag_access.log combined
160 Nach dem du Apache neugeladen oder neugestartet hast, solltest du nun wallabag unter http://domain.tld erreichen.
162 Konfiguration von Nginx
163 ~~~~~~~~~~~~~~~~~~~~~~~
165 Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren, dann ist hier ein Rezept für wallabag:
170 server_name domain.tld www.domain.tld;
171 root /var/www/wallabag/web;
174 # try to serve file directly, fallback to app.php
175 try_files $uri /app.php$is_args$args;
177 location ~ ^/app\.php(/|$) {
178 fastcgi_pass unix:/var/run/php5-fpm.sock;
179 fastcgi_split_path_info ^(.+\.php)(/.*)$;
180 include fastcgi_params;
181 # When you are using symlinks to link the document root to the
182 # current version of your application, you should pass the real
183 # application path instead of the path to the symlink to PHP
185 # Otherwise, PHP's OPcache may not properly detect changes to
186 # your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126
187 # for more information).
188 fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
189 fastcgi_param DOCUMENT_ROOT $realpath_root;
190 # Prevents URIs that include the front controller. This will 404:
191 # http://domain.tld/app.php/some-path
192 # Remove the internal directive to allow URIs like this
196 # return 404 for all other php files not matching the front controller
197 # this prevents access to other php files you don't want to be accessible.
202 error_log /var/log/nginx/wallabag_error.log;
203 access_log /var/log/nginx/wallabag_access.log;
206 Nach dem Neuladen oder Neustarten von nginx solltest du nun wallabag unter http://domain.tld erreichen.
210 Wenn du eine große Datei in wallabag importieren willst, solltest du diese Zeile zu deiner nginx Konfiguration hinzufügen ``client_max_body_size XM; # allows file uploads up to X megabytes``.
212 Konfiguration von lighttpd
213 ~~~~~~~~~~~~~~~~~~~~~~~~~~
215 Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren, dann ist hier ein Rezept für wallabag (bearbeite deine ``lighttpd.conf`` und füge die Konfiguration dort ein):
227 server.document-root = "/var/www/wallabag/web"
228 server.upload-dirs = ( "/var/cache/lighttpd/uploads" )
229 server.errorlog = "/var/log/lighttpd/error.log"
230 server.pid-file = "/var/run/lighttpd.pid"
231 server.username = "www-data"
232 server.groupname = "www-data"
234 server.follow-symlink = "enable"
235 index-file.names = ( "index.php", "index.html", "index.lighttpd.html")
236 url.access-deny = ( "~", ".inc" )
237 static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" )
238 compress.cache-dir = "/var/cache/lighttpd/compress/"
239 compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" )
240 include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
241 include_shell "/usr/share/lighttpd/create-mime.assign.pl"
242 include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
243 dir-listing.activate = "disable"
245 url.rewrite-if-not-file = (
246 "^/([^?]*)(?:\?(.*))?" => "/app.php?$1&$2",
247 "^/([^?]*)" => "/app.php?=$1",
250 Rechte, um das Projektverzeichnis zu betreten
251 ---------------------------------------------
256 Wenn wir nur wallabag testen wollen, führen wir nur das Kommando ``php bin/console server:run --env=prod`` aus, um unsere wallabag Instanz zu starten und alles wird geschmeidig laufen, weil der Nutzer, der das Projekt gestartet hat, den aktuellen Ordner ohne Probleme betreten kann.
261 Sobald wir Apache oder Nginx nutzen, um unsere wallabag Instanz zu erreichen, und nicht das Kommando ``php bin/console server:run --env=prod`` nutzen, sollten wir dafür sorgen, die Rechte vernünftig zu vergeben, um die Ordner des Projektes zu schützen.
263 Um dies zu machen, muss der Ordner, bekannt als ``DocumentRoot`` (bei Apache) oder ``root`` (bei Nginx), von dem Apache-/Nginx-Nutzer zugänglich sein. Sein Name ist meist ``www-data``, ``apache`` oder ``nobody`` (abhängig vom genutzten Linuxsystem).
265 Der Ordner ``/var/www/wallabag/web`` musst dem letztgenannten zugänglich sein. Aber dies könnte nicht genug sein, wenn wir nur auf diesen Ordner achten, weil wir eine leere Seite sehen könnten oder einen Fehler 500, wenn wir die Homepage des Projekt öffnen.
267 Dies kommt daher, dass wir die gleichen Rechte dem Ordner ``/var/www/wallabag/var`` geben müssen, so wie wir es für den Ordner ``/var/www/wallabag/web`` gemacht haben. Somit beheben wir das Problem mit dem folgenden Kommando:
271 chown -R www-data:www-data /var/www/wallabag/var
273 Es muss analog für die folgenden Ordner ausgeführt werden
275 * /var/www/wallabag/bin/
276 * /var/www/wallabag/app/config/
277 * /var/www/wallabag/vendor/
278 * /var/www/wallabag/data/
280 durch Eingabe der Kommandos
284 chown -R www-data:www-data /var/www/wallabag/bin
285 chown -R www-data:www-data /var/www/wallabag/app/config
286 chown -R www-data:www-data /var/www/wallabag/vendor
287 chown -R www-data:www-data /var/www/wallabag/data/
289 ansonsten wirst du früher oder später folgenden Fehlermeldung sehen:
293 Unable to write to the "bin" directory.
294 file_put_contents(app/config/parameters.yml): failed to open stream: Permission denied
295 file_put_contents(/.../wallabag/vendor/autoload.php): failed to open stream: Permission denied
297 Zusätzliche Regeln für SELinux
298 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
300 Wenn SELinux in deinem System aktiviert ist, wirst du zusätzliche Kontexte konfigurieren müssen damit wallabag ordentlich funktioniert. Um zu testen, ob SELinux aktiviert ist, führe einfach folgendes aus:
304 Dies wird ``Enforcing`` ausgeben, wenn SELinux aktiviert ist. Einen neuen Kontext zu erstellen, erfordert die folgende Syntax:
306 ``semanage fcontext -a -t <context type> <full path>``
310 ``semanage fcontext -a -t httpd_sys_content_t "/var/www/wallabag(/.*)?"``
312 Dies wird rekursiv den httpd_sys_content_t Kontext auf das wallabag Verzeichnis und alle darunterliegenden Dateien und Ordner anwenden. Die folgenden Regeln werden gebraucht:
314 +-----------------------------------+----------------------------+
315 | Vollständiger Pfad | Kontext |
316 +===================================+============================+
317 | /var/www/wallabag(/.*)? | ``httpd_sys_content_t`` |
318 +-----------------------------------+----------------------------+
319 | /var/www/wallabag/data(/.*)? | ``httpd_sys_rw_content_t`` |
320 +-----------------------------------+----------------------------+
321 | /var/www/wallabag/var/logs(/.*)? | ``httpd_log_t`` |
322 +-----------------------------------+----------------------------+
323 | /var/www/wallabag/var/cache(/.*)? | ``httpd_cache_t`` |
324 +-----------------------------------+----------------------------+
326 Nach dem diese Kontexte erstellt wurden, tippe das folgende, um deine Regeln anzuwenden:
328 ``restorecon -R -v /var/www/wallabag``
330 Du kannst deine Kontexte in einem Verzeichnis überprüfen, indem du ``ls -lZ`` tippst und alle deine aktuellen Regeln mit ``semanage fcontext -l -C`` überprüfst.
332 Wenn du das vorkonfigurierte latest-v2-package installierst, dann ist eine weitere Regel während der Installation nötig:
334 ``semanage fcontext -a -t httpd_sys_rw_content_t "/var/www/wallabag/var"``
336 Nachdem du erfolgreich dein wallabag erreichst und die Installation fertiggestellt hast, kann dieser Kontext entfernt werden:
340 semanage fcontext -d -t httpd_sys_rw_content_t "/var/www/wallabag/var"
341 retorecon -R -v /var/www/wallabag/var