nginx

Achtung!

Dieser Artikel wird aktuell in Baustelle/nginx überarbeitet. Daher kann es sein, dass diese Seite hier veraltete oder nicht (mehr) zutreffende Informationen enthält. Vergleiche beide Versionen und wende dich im Zweifelsfall mit deinem konkreten Anliegen an das Support-Forum. Änderungen am Artikel bitte nur in Baustelle/nginx!

Dieser Artikel wurde für die folgenden Ubuntu-Versionen getestet:

Zum Verständnis dieses Artikels sind folgende Seiten hilfreich:

  1. Installation von Programmen

  2. Verwenden eines PPAs, optional

  3. Archive entpacken, optional

  4. Pakete aus dem Quellcode erstellen, optional

  5. Ein Terminal öffnen

  6. Einen Editor öffnen

Inhaltsverzeichnis
  1. Installation
    1. PPA
    2. Manuell
  2. Konfiguration
    1. Konfigurieren des Webservers
    2. nginx als Reverse-Proxy
    3. Ändern der Umgebung
  3. Steuerung von nginx
    1. Mögliche Befehle
    2. Andere Konfigurationsdatei verwenden
  4. Optimierung von nginx
    1. GZip-Komprimierung aktivieren
    2. Charset festlegen
  5. Module
  6. Tipps & Tricks
    1. IPv6
    2. Loadbalancing mit nginx
    3. Rewriting
  7. Absicherung von nginx
  8. nginx mit anderen Programmiersprachen
  9. Probleme und Lösung
    1. Bei allen PHP-Dateien wird nur "No input...
    2. nginx zeigt bei existierenden Dateien im...
    3. Es erscheint auf allen Websites nur noch...
    4. nginx verarbeitet keine .htaccess-Dateie...
    5. nginx startet nicht automatisch
    6. nginx startet nicht, da die Konfiguratio...
    7. Obwohl nginx richtig konfiguriert ist, p...
    8. Wieso bleibt nginx an der Meldung "[...]...
    9. Wieso kann Plesk nginx nicht konfigurier...
    10. Wieso wird die neue Konfiguration nicht ...
    11. Die Log-Datei bleibt leer, warum?
    12. Weshalb läuft eine FastCGI-Schnittstelle...
  10. Links

nginx-logo.png nginx {en} (gesprochen „engine x”) ist ein Webserver, der im Vergleich zum Marktführer Apache sehr schnell und schlank ist. Er wurde mit der Vorgabe konzipiert, selbst unter hoher Last nur wenig Ressourcen zu verbrauchen. nginx wird von Igor Sysoev entwickelt und wird laut w3techs.com Statsitik {en} von ca. 30 % aller Websites genutzt (Stand: Sommer 2016). Damit ist nginx der am zweithäufigsten eingesetzte Webserver.

Installation

nginx kann aus den offiziellen Paketquellen installiert werden [1]:

Wiki/Vorlagen/Installbutton/button.png mit apturl

Paketliste zum Kopieren:

sudo apt-get install nginx 

sudo aptitude install nginx 

PPA

Eine – je nach eingesetzter Ubuntu-Version – aktuellere nginx-Version ist über ein "Personal Package Archiv" (PPA) [2] erhältlich.

Adresszeile zum Hinzufügen des PPAs:

Hinweis!

Zusätzliche Fremdquellen können das System gefährden.


Ein PPA unterstützt nicht zwangsläufig alle Ubuntu-Versionen. Weitere Informationen sind der Wiki/Vorlagen/PPA/ppa.png PPA-Beschreibung des Eigentümers/Teams nginx zu entnehmen.

Damit Pakete aus dem PPA genutzt werden können, müssen die Paketquellen neu eingelesen werden.

Manuell

Da im Gegensatz zu Apache keine (nachladbaren) Module zum Einsatz kommen, werden benötigte Funktionen bereits beim Kompilieren von nginx angegeben. So kann man im Gegensatz zu den vorkompilierten Paketen aus den offiziellen Paketquellen oder dem PPA den Webserver noch genauer auf den geplanten Einsatzzweck abstimmen und weitere Performance-Gewinne erzielen. Bevor nginx kompiliert werden kann, werden folgende Pakete benötigt (je nach gewünschter Funktionalität evtl. auch noch weitere Pakete; Details sind dem nginx-Wiki {en} zu entnehmen):

Wiki/Vorlagen/Installbutton/button.png mit apturl

Paketliste zum Kopieren:

sudo apt-get install build-essential libpcre3-dev libssl-dev zlib1g-dev 

sudo aptitude install build-essential libpcre3-dev libssl-dev zlib1g-dev 

Dann wird der Quellcode von der offiziellen Downloadseite {en} {dl} benötigt. Nun entpackt [3] man das Quellcode-Archiv und kompiliert [4] nginx. Damit sich der selbst-kompilierte nginx (fast) wie eine Paket-Installation anfühlt, setzt man noch folgende symbolischen Links:

mkdir /etc/nginx
ln -s /usr/local/nginx/conf/nginx.conf /etc/nginx/nginx.conf
ln -s /usr/local/nginx/sbin/nginx /usr/local/bin/nginx

Somit spart man sich das umständliche Zusammensuchen der Komponenten und kann nginx direkt ohne Pfadangabe starten.

Wiki/Icons/settings.png

Konfiguration

nginx liest die Konfiguration aus der Datei /etc/nginx/nginx.conf. Diese besteht aus den Blöcken events { [...] } und http { [...] }. Kommentiert wird mit einer Raute (#).

Konfigurieren des Webservers

Grundkonfiguration

Damit nginx an eine Domain oder IP gebunden wird, muss folgender Grundblock in den http-Teil eingefügt werden:

server {

}

Hinweis:

Die Datei ist nach der Installation schon vorkonfiguriert. Es ist empfehlenswert, jegliche server { [...] }-Bereiche zu entfernen, um Komplikationen zu vermeiden.

Nun wird angegeben, an welchen Port sich nginx binden soll (80) und an welche Domain bzw. IP (localhost):

server {
     listen       80;
     server_name  localhost;
}

Alleine mit dieser Konfiguration ist nginx bereits erreichbar, hat aber keine Daten verfügbar, die an den Benutzer versendet werden können. Dies ändert man mit root (im Beispiel liegen die Dateien in /srv/localhost):

root         /srv/localhost;

Hinweis:

root steht für document root und nicht, wie man denken könnte, für den Benutzer root.

Zuletzt wird noch festgelegt, welche Datei aufgerufen werden soll, wenn der Nutzer nur localhost eintippt:

location / {
        index     index.html  index.htm;
}

Domains einbinden

Domains lassen sich folgendermaßen einbinden:

server_name  www.example.com example.com;

Damit hört nginx sowohl an www.example.com als auch example.com.

Sub- und Wildcarddomains einbinden

Sub- und Wildcarddomains bindet man mit

server_name  *.example.com subdomain.example.com;

ein.

Achtung!

Jede Domain, die in server_name aufgelistet ist, wird auch von dem (virtuellen) Server betrieben. Konkret würde dies für das Beispiel heißen, dass die beiden Domains mit dem gleichen Inhalt und den gleichen Einstellungen betrieben werden.

Beispiel

[...]

http {
     server {
          listen       80;
          server_name  localhost example.com www.example.com;
          root         /srv/daten;

          location / {
             index     index.html  index.htm;
          }
     }

     server {
          listen       80;
          server_name  subdomain.example.com;
          root         /srv/subdomain/daten;

          location / {
             index     index.html  index.htm;
          }
     }
}

[...]

nginx als Reverse-Proxy

Der nginx Webserver ist auch recht beliebt zum Einsatz als "Reverse Proxy". Dabei nimmt der Server die Anfrage aus dem Internet an, leitet diese an einen lokal laufenden Applikationsserver weiter und liefert anschließend dessen Antwort wird aus. So ist z.B. im Python-Umfeld der Einsatz von nginx als Reverse Proxy in Kombination mit dem (lokal laufenden) WSGI-Applikationsserver Gunicorn oder uwsgi eine durchaus beliebte Lösung.

Im einfachsten Fall benötigt man in der Konfiguration von nginx nur die folgenden beiden Zeilen:

location / {
                proxy_pass http://127.0.0.1:8000;
}

Damit werden alle Anfragen an diese location - im obigen Beispiel als das Root-Verzeichnis der Domäne - an http://127.0.0.1:8000 weitergeleitet, wo dann ein Applikationsserver läuft.

Trotz der Weiterleitung übergibt nginx den angesteuerten Pfad (z.B. http://example.com/neu, und nicht http://127.0.0.1:8000/).

Weiterführende Informationen findet man in der Dokumention {en} des Servers.

Ändern der Umgebung

Ändern des Nutzers

Nginx kann - wie viele andere Webserver - auch einen anderen Nutzer als root benutzen. Um dies einzurichten, ändert man folgende Zeile:

#user  nobody;

ab zu folgender Zeile (in diesem Beispiel wird der Nutzer „www-data” verwendet):

user  www-data;

Dies ändert - unabhängig davon, mit welchem Nutzer nginx gestartet wurde - das Konto, mit dem der Daemon arbeitet.

Aktivierung einer Logdatei

Um eine komplette Logdatei nach /etc/nginx/logs/error.log zu schreiben, ändert man die Zeile:

#error_log  logs/error.log;

ab zu:

error_log  /etc/nginx/logs/error.log;

Durch das Hinzufügen von info oder notice nach dem Dateinamen kann das Protokoll gefiltert werden. Dies bedeutet, dass z.B. nur Informationen gesichert werden.

Steuerung von nginx

Nginx bildet sich aus einem „Master”-Prozess und vielen „Slave”- bzw. „Client”-Prozessen. Man steuert nginx mit dem Master-Prozess, den man mit dem Befehl nginx anspricht. Dies geht nach folgendem Prinzip:

nginx [-s signal] [-c filename] [-p prefix] [-g directives] 

Mögliche Befehle

Starten lässt sich nginx recht simpel:

sudo nginx 

Es sind Rootrechte erforderlich, wenn nginx an einem Port kleiner als 1024 horchen soll (siehe auch Liste der standardisierten Ports).

Für das Stoppen übergibt man das stop-Signal an nginx:

sudo nginx -s stop 

Falls ein Dienste-Skript vorhanden ist, kann man nginx auch mit diesen Optionen steuern:

/etc/init.d/nginx (start|stop|restart|reload|force-reload) 

Andere Konfigurationsdatei verwenden

Falls eine andere Konfigurationsdatei als /etc/nginx/nginx.conf, z.B. zu Testzwecken, verwendet werden soll, startet man nginx folgendermaßen:

sudo nginx -c /pfad/der/konfigurationsdatei 

Optimierung von nginx

GZip-Komprimierung aktivieren

Dank der GZip-Komprimierung kann man sich viel Datenverkehr sparen. Wie die Kompression von Websites funktioniert und warum man sie aktivieren sollte, kann man auf betterexplained.com {en} nachlesen. nginx kann alle Typen von Websites und Textdateien komprimieren, im Gegensatz zu dem ZLib-Modul von PHP, welches nur PHP komprimiert.

Um die Komprimierung zu aktivieren, fügt man folgende Zeile in den http { [...] }-Block ein:

gzip on;

und startet nginx neu. Zusätzlich sollte man festlegen, welche Dateitypen geschrumpft werden sollen und welche Browser ausgenommen werden sollen:

gzip_types       text/plain application/xml;
gzip_disable     "MSIE [1-6]\.";

Charset festlegen

Falls ein Charset (=Zeichensatz) festgelegt werden soll, kann man sich mit folgendem Befehl im server { [...] }-Block behelfen:

charset         utf-8;

Module

nginx besitzt standardmäßig nur einige Module, welche im ngimx-Wiki {en} gelistet sind. Allerdings kann man nginx mit vielen weiteren Modulen benutzen, deren offiziellen Anlaufstellen unter Optional HTTPmodules {en} und Nginx 3rd Party Modules {en} sind. Die Module kann man allerdings - nicht wie bei allen anderen Webservern - direkt benutzen, sondern muss sie mit nginx kompilieren[4]. Wie das funktioniert, steht in aller Regel in der Dokumentation des Modules. Bei optionalen HTTP-Modulen {en} funktioniert das folgendermaßen:

Im Beispiel wird SSL-Unterstützung installiert. Man bezieht sich den Quellcode (siehe Installation) von nginx und entpackt ihn. Statt nun

./configure 

einzugeben, fügt man nun das Modul an:

./configure --with-http_ssl_module 

Somit wird bei der weiteren Kompilierung SSL berücksichtigt. Um SSL zu benutzen, muss die Konfiguration angepasst werden, wie es im nginx-Wiki {en} beschrieben wird.

Tipps & Tricks

IPv6

Um nginx für IPv6 bereit zu machen, muss man zuerst - sofern man den Webserver nicht als Paket installiert hat - folgendermaßen neu kompilieren:

./configure --with-ipv6
make
sudo make install 

Im zweiten Schritt öffnet man die Konfigurationsdatei und sorgt dafür, dass nginx IPv4- und IPv6-Verbindungen an Port 80 akzeptiert, indem man listen 80 durch listen [::]:80 ersetzt. Sofern noch nicht erledigt, müssen für jede Domain AAAA-Einträge in seinem DNS-Manager angelegt sein.

Loadbalancing mit nginx

Loadbalancing ist standardmäßig in nginx vorhanden und schlägt laut diesem Artikel {de} Pound deutlich. Im folgenden Beispiel verteilt nginx die Last auf 3 Server:

http {
  upstream loadbalancer {
    server 127.0.0.1:8000;
    server 127.0.0.1:8001;
    server 127.0.0.1:8002;    
  }
 
  server {
    listen 80;
    server_name www.example.com example.com;
    location / {
      proxy_pass http://loadbalancer;
    }
  }
}

Zur Erklärung: Im Upstream loadbalancer sind drei (Web-)Server vorhanden und mit ihren jeweiligen Daten (IP:Port) angegeben. Im server { [...] }-Block hört nginx an den Domains www.example.com und example.com an Port 80 und leitet die Anfrage an den upstream weiter.

Rewriting

nginx unterstützt URL-Rewriting nativ und kann mithilfe von Regex (Regulärer Ausdruck) Anfragen umschreiben. So kann zum Beispiel eine Domain example.com/artikel.php?id=123 zu example.com/artikel/123 vereinfacht werden, ohne dass der Nutzer weitergeleitet werden muss. Das Rewriting kann im Hintergrund auf Server-Ebene geschehen. Um Rewriting zu aktivieren, fügt man folgendes in seine Konfiguration in einem server { [...] }-Block ein:

rewrite  ^/artikel/(.*)$  /artikel.php?id=$1?  last;

Der reguläre Ausdruck ^/artikel/(.*)$ bedeutet folgendes: Existiert in der aufgerufenen Domain an irgendeiner Stelle die Zeichenfolge /artikel/ wird sämtliches hinter dieser an artikel.php als GET-Parameter id übergeben.

Dieses Rewriting passiert mit der Flag last nur intern. nginx bietet folgende Flags zur Auswahl an:

last/break Internes Rewriting ohne Weiterleitung
redirect Leitet den Nutzer auf die Seite weiter (HTTP 302 - Temporäre Weiterleitung)
permanent Leitet den Nutzer auf die Seite weiter (HTTP 301 - Dauerhafte Weiterleitung)

Achtung!

Ohne eine gesetzte Flag gibt nginx den Fehler HTTP 500 zurück.

Weitere Hilfe, Tipps und Tricks findet man im nginx-Wiki {en}.

Absicherung von nginx

Man stelle sich vor, ein Hacker würde eine Datei via PHP/Perl/Python in das Verzeichnis /uploads/ hochladen. Diese Datei ist mit Schadcode infiziert und würde bei der Ausführung dem Server schaden. Wenn jetzt aber die Ausführung der Datei nicht verboten wird, könnte der Hacker seinen Angriff starten. Um das zu verhindern, fügt man in den server { [...] }-Block folgendes ein:

if ($uri !~ "^/uploads/") {
    fastcgi_pass 127.0.0.1:9000;
}

Dies löst aus, dass alle Dateien, die sonst über die FastCGI-Schnittstelle an Port 9000 laufen würden, in allen Ordnern mit dem Namen uploads nicht mehr ausgeführt werden.

nginx mit anderen Programmiersprachen

Die Nutzung von nginx in Kombination mit PHP ist im Artikel nginx/PHP beschrieben, die in Kombination mit Perl im Artikel nginx/Perl.

Probleme und Lösung

Wiki/Icons/hint.png Siehe auch Nginx Pitfalls {en} (sinngemäß: typische Fehler).

Bei allen PHP-Dateien wird nur "No input file specified" angezeigt

Dies ist ein üblicher Fehler, der aber schnell behoben werden kann. Es gibt zwei hauptsächliche Ursachen:

Ursache 1

Folgende Konfiguration wird für PHP-Dateien benutzt:

location ~ \.php$ {
        fastcgi_pass   localhost:9000;
        include           fastcgi_params; # Statt fastcgi.conf
}

Da nur in der Datei fastcgi.conf spezifiziert ist, dass PHP-Dateien auch unabhängig von dem document root-Verzeichnis verarbeitet werden sollen, sollte man diese statt fastcgi_params verwenden. Wer fastcgi_params trotzdem nutzen möchte, kann statt des Ersetzen folgende Zeile hinzufügen:

        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;

Ursache 2

Folgende (vereinfachte) Konfiguration wird benutzt:

location / {
        root               /srv/www/;
}

location ~ \.php$ {
        fastcgi_pass   localhost:9000;
        include          fastcgi.conf;
}

Da die location ~ \.php$ eine andere als / ist, ist für die FastCGI-Schnittstelle unbekannt, wo das Wurzelverzeichnis für diesen server { [...] }-Block ist, weil dieses nur in location / festgelegt ist. Folgende Konfiguration löst dieses Problem:

root               /srv/www/; # 'root' wird nun global für den server { [...] }-Block festgelegt

location ~ \.php$ {
                     fastcgi_pass   localhost:9000;
                     include          fastcgi.conf;
}

nginx zeigt bei existierenden Dateien im Browser "403" an

Benutzerberechtigungen überprüfen! Diese Meldung kommt meistens, wenn nginx bzw. der Benutzer, mit dem nginx läuft, keinen Zugriff auf die Dateien hat.

Es erscheint auf allen Websites nur noch die Meldung "502 Bad Gateway"

Dies passiert, wenn die FastCGI-Schnittstelle oder die Adresse von proxy_pass nicht für nginx erreichbar ist (auf Servern kann dies mit Lynx überprüft werden). Gründe können z.B. ein Absturz der Schnittstelle sein.

Da man das Problem mithilfe dieser Meldung nicht pauschal festmachen kann, gibt es auf codeweblog.com {en} eine Liste von möglichen Ursachen und deren Behebung.

nginx verarbeitet keine .htaccess-Dateien

Das ist korrekt, da alle Änderungen bzw. Einstellungen in der Konfigurationsdatei nginx.conf vorgenommen werden. Und Absicht - diverse Gründe, wieso es unter nginx keine htaccess-Dateien gibt, finden sich im FAQ von nginx {en} - kurz gesagt ist .htaccess ist ein Performancekiller und potentielle Sicherheitslücke. Allerdings gibt es diverse Konverter {en} von htaccess zu nginx, um den Umstieg leicht zu machen.

nginx startet nicht automatisch

Eventuell fehlt das /etc/init.d/-Startskript. Create an Init Script to Manage nginx {en} bietet Hilfe.

nginx startet nicht, da die Konfigurationsdatei angeblich falsch ist

Die Konfigurationsdatei überprüfen, ob überall am Ende jedes Befehls/jeder Zeile ein Semikolon steht, und, ob alle server { [...] }-Blöcke auch mit dem Zeichen "}" geschlossen sind!

Obwohl nginx richtig konfiguriert ist, passiert beim Aufrufen von Subdomains nichts

Bei diesem Problem wird vermutlich eine Fehlkonfiguration der DNS-Zonen vorliegen.

Wieso bleibt nginx an der Meldung "[...]:80 failed (98: Address already in use)" hängen?

nginx oder ein anderer Webserver benutzt bereits den Port 80. Es kann immer nur ein Programm an dem Port lauschen.

Wieso kann Plesk nginx nicht konfigurieren?

Das liegt daran, dass Plesk Apache nutzt und nicht auf nginx zugeschnitten ist.

Wieso wird die neue Konfiguration nicht übernommen?

Für eine Konfigurationsänderung muss nginx neugestartet werden. Wie das geht, steht im Bereich nginx steuern.

Die Log-Datei bleibt leer, warum?

Falls der Nutzer geändert wurde, mit dem nginx läuft, muss dieser über Schreibzugriff auf diese Datei verfügen.

Weshalb läuft eine FastCGI-Schnittstelle, die andere aber nicht?

Eventuell sollen beide Schnittstellen den selben Port verwenden. Allerdings kann sich jeweils nur eine Schnittstelle an einen Port binden.