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