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