docs/de/user/installation.rst

   1 Installation von wallabag
   2 =========================
   3
   4 Voraussetzungen
   5 ---------------
   6
   7 wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7.
   8
   9 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.
  10
  11 Composer installieren:
  12
  13 ::
  14
  15     curl -s http://getcomposer.org/installer | php
  16
  17 Du kannst eine spezifische Anleitung `hier <https://getcomposer.org/doc/00-intro.md>`__ finden.
  18
  19 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
  20 nicht alle folgenden Pakete installieren.
  21
  22 - php-session
  23 - php-ctype
  24 - php-dom
  25 - php-hash
  26 - php-simplexml
  27 - php-json
  28 - php-gd
  29 - php-mbstring
  30 - php-xml
  31 - php-tidy
  32 - php-iconv
  33 - php-curl
  34 - php-gettext
  35 - php-tokenizer
  36 - php-bcmath
  37
  38 wallabag nutzt PDO, um sich mit der Datenbank zu verbinden, darum benötigst du eines der folgenden Komponenten:
  39
  40 - pdo_mysql
  41 - pdo_sqlite
  42 - pdo_pgsql
  43
  44 und dessen dazugehörigen Datenbankserver.
  45
  46 Installation
  47 ------------
  48
  49 Auf einem dedizierten Webserver (empfohlener Weg)
  50 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  51
  52 Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen:
  53
  54 ::
  55
  56     git clone https://github.com/wallabag/wallabag.git
  57     cd wallabag
  58     ./install.sh
  59
  60 Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen:
  61
  62 ::
  63
  64     php bin/console server:run --env=prod
  65
  66 und wallabag unter http://deineserverip:8000 erreichen.
  67
  68 .. tip::
  69
  70     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.
  71
  72 Auf einem geteilten Webhosting
  73 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  74
  75 Wir stellen ein Paket inkl. aller Abhängigkeiten bereit.
  76 Die Standardkonfiguration nutzt SQLite für die Datenbank. Wenn du diese Einstellung ändern willst, ändere bitte ``app/config/parameters.yml``.
  77
  78 Wir haben bereits einen Nutzer erstellt: Login und Passwort sind ``wallabag``.
  79
  80 .. 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).
  81
  82 Führe dieses Kommando aus, um das neueste Paket herunterzuladen und zu entpacken:
  83
  84 .. code-block:: bash
  85
  86     wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
  87
  88 Du findest die `md5 Hashsumme des neuesten Pakets auf unserer Website <https://www.wallabag.org/pages/download-wallabag.html>`_.
  89
  90 Jetzt lies die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf dein wallabag zu.
  91 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``.
  92
  93 Installation mit Docker
  94 ~~~~~~~~~~~~~~~~~~~~~~~
  95
  96 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.
  97
  98 Kommando, um den Container zu starten
  99 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 100
 101 .. code-block:: bash
 102
 103     docker pull wallabag/wallabag
 104
 105 Virtualhosts
 106 ------------
 107
 108 Konfiguration von Apache
 109 ~~~~~~~~~~~~~~~~~~~~~~~~
 110
 111 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:
 112
 113 ::
 114
 115     <VirtualHost *:80>
 116         ServerName domain.tld
 117         ServerAlias www.domain.tld
 118
 119         DocumentRoot /var/www/wallabag/web
 120         <Directory /var/www/wallabag/web>
 121             AllowOverride None
 122             Order Allow,Deny
 123             Allow from All
 124
 125             <IfModule mod_rewrite.c>
 126                 Options -MultiViews
 127                 RewriteEngine On
 128                 RewriteCond %{REQUEST_FILENAME} !-f
 129                 RewriteRule ^(.*)$ app.php [QSA,L]
 130             </IfModule>
 131         </Directory>
 132
 133         # uncomment the following lines if you install assets as symlinks
 134         # or run into problems when compiling LESS/Sass/CoffeScript assets
 135         # <Directory /var/www/wallabag>
 136         #     Options FollowSymlinks
 137         # </Directory>
 138
 139         # optionally disable the RewriteEngine for the asset directories
 140         # which will allow apache to simply reply with a 404 when files are
 141         # not found instead of passing the request into the full symfony stack
 142         <Directory /var/www/wallabag/web/bundles>
 143             <IfModule mod_rewrite.c>
 144                 RewriteEngine Off
 145             </IfModule>
 146         </Directory>
 147         ErrorLog /var/log/apache2/wallabag_error.log
 148         CustomLog /var/log/apache2/wallabag_access.log combined
 149     </VirtualHost>
 150
 151 Nach dem du Apache neugeladen oder neugestartet hast, solltest du nun wallabag unter http://domain.tld erreichen.
 152
 153 Konfiguration von Nginx
 154 ~~~~~~~~~~~~~~~~~~~~~~~
 155
 156 Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren, dann ist hier ein Rezept für wallabag:
 157
 158 ::
 159
 160     server {
 161         server_name domain.tld www.domain.tld;
 162         root /var/www/wallabag/web;
 163
 164         location / {
 165             # try to serve file directly, fallback to app.php
 166             try_files $uri /app.php$is_args$args;
 167         }
 168         location ~ ^/app\.php(/|$) {
 169             fastcgi_pass unix:/var/run/php5-fpm.sock;
 170             fastcgi_split_path_info ^(.+\.php)(/.*)$;
 171             include fastcgi_params;
 172             # When you are using symlinks to link the document root to the
 173             # current version of your application, you should pass the real
 174             # application path instead of the path to the symlink to PHP
 175             # FPM.
 176             # Otherwise, PHP's OPcache may not properly detect changes to
 177             # your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126
 178             # for more information).
 179             fastcgi_param  SCRIPT_FILENAME  $realpath_root$fastcgi_script_name;
 180             fastcgi_param DOCUMENT_ROOT $realpath_root;
 181             # Prevents URIs that include the front controller. This will 404:
 182             # http://domain.tld/app.php/some-path
 183             # Remove the internal directive to allow URIs like this
 184             internal;
 185         }
 186
 187         error_log /var/log/nginx/wallabag_error.log;
 188         access_log /var/log/nginx/wallabag_access.log;
 189     }
 190
 191 Nach dem Neuladen oder Neustarten von nginx solltest du nun wallabag unter http://domain.tld erreichen.
 192
 193 .. tip::
 194
 195     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``.
 196
 197 Konfiguration von lighttpd
 198 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 199
 200 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):
 201
 202 ::
 203
 204     server.modules = (
 205         "mod_fastcgi",
 206         "mod_access",
 207         "mod_alias",
 208         "mod_compress",
 209         "mod_redirect",
 210         "mod_rewrite",
 211     )
 212     server.document-root = "/var/www/wallabag/web"
 213     server.upload-dirs = ( "/var/cache/lighttpd/uploads" )
 214     server.errorlog = "/var/log/lighttpd/error.log"
 215     server.pid-file = "/var/run/lighttpd.pid"
 216     server.username = "www-data"
 217     server.groupname = "www-data"
 218     server.port = 80
 219     server.follow-symlink = "enable"
 220     index-file.names = ( "index.php", "index.html", "index.lighttpd.html")
 221     url.access-deny = ( "~", ".inc" )
 222     static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" )
 223     compress.cache-dir = "/var/cache/lighttpd/compress/"
 224     compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" )
 225     include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
 226     include_shell "/usr/share/lighttpd/create-mime.assign.pl"
 227     include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
 228     dir-listing.activate = "disable"
 229
 230     url.rewrite-if-not-file = (
 231         "^/([^?]*)(?:\?(.*))?" => "/app.php?$1&$2",
 232         "^/([^?]*)" => "/app.php?=$1",
 233     )
 234
 235 Rechte, um das Projektverzeichnis zu betreten
 236 ---------------------------------------------
 237
 238 Testumgebung
 239 ~~~~~~~~~~~~
 240
 241 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.
 242
 243 Produktionsumgebung
 244 ~~~~~~~~~~~~~~~~~~~
 245
 246 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.
 247
 248 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).
 249
 250 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.
 251
 252 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:
 253
 254 .. code-block:: bash
 255
 256    chown -R www-data:www-data /var/www/wallabag/var
 257
 258 Es muss analog für die folgenden Ordner ausgeführt werden
 259
 260 * /var/www/wallabag/bin/
 261 * /var/www/wallabag/app/config/
 262 * /var/www/wallabag/vendor/
 263 * /var/www/wallabag/data/
 264
 265 durch Eingabe der Kommandos
 266
 267 .. code-block:: bash
 268
 269    chown -R www-data:www-data /var/www/wallabag/bin
 270    chown -R www-data:www-data /var/www/wallabag/app/config
 271    chown -R www-data:www-data /var/www/wallabag/vendor
 272    chown -R www-data:www-data /var/www/wallabag/data/
 273
 274 ansonsten wirst du früher oder später folgenden Fehlermeldung sehen:
 275
 276 .. code-block:: bash
 277
 278     Unable to write to the "bin" directory.
 279     file_put_contents(app/config/parameters.yml): failed to open stream: Permission denied
 280     file_put_contents(/.../wallabag/vendor/autoload.php): failed to open stream: Permission denied
 281
 282 Zusätzliche Regeln für SELinux
 283 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 284
 285 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:
 286
 287 ``getenforce``
 288
 289 Dies wird ``Enforcing`` ausgeben, wenn SELinux aktiviert ist. Einen neuen Kontext zu erstellen, erfordert die folgende Syntax:
 290
 291 ``semanage fcontext -a -t <context type> <full path>``
 292
 293 Zum Beispiel:
 294
 295 ``semanage fcontext -a -t httpd_sys_content_t "/var/www/wallabag(/.*)?"``
 296
 297 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:
 298
 299 +-----------------------------------+----------------------------+
 300 | Vollständiger Pfad                | Kontext                    |
 301 +===================================+============================+
 302 | /var/www/wallabag(/.*)?           | ``httpd_sys_content_t``    |
 303 +-----------------------------------+----------------------------+
 304 | /var/www/wallabag/data(/.*)?      | ``httpd_sys_rw_content_t`` |
 305 +-----------------------------------+----------------------------+
 306 | /var/www/wallabag/var/logs(/.*)?  | ``httpd_log_t``            |
 307 +-----------------------------------+----------------------------+
 308 | /var/www/wallabag/var/cache(/.*)? | ``httpd_cache_t``          |
 309 +-----------------------------------+----------------------------+
 310
 311 Nach dem diese Kontexte erstellt wurden, tippe das folgende, um deine Regeln anzuwenden:
 312
 313 ``restorecon -R -v /var/www/wallabag``
 314
 315 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.
 316
 317 Wenn du das vorkonfigurierte latest-v2-package installierst, dann ist eine weitere Regel während der Installation nötig:
 318
 319 ``semanage fcontext -a -t httpd_sys_rw_content_t "/var/www/wallabag/var"``
 320
 321 Nachdem du erfolgreich dein wallabag erreichst und die Installation fertiggestellt hast, kann dieser Kontext entfernt werden:
 322
 323 ::
 324
 325     semanage fcontext -d -t httpd_sys_rw_content_t "/var/www/wallabag/var"
 326     retorecon -R -v /var/www/wallabag/var