Konfigurieren des Dispatchers configuring-dispatcher

In den folgenden Abschnitten wird beschrieben, wie Sie verschiedene Aspekte des Dispatchers konfigurieren.

Unterstützung für IPv6 und IPv4 support-for-ipv-and-ipv

Alle Elemente von AEM und Dispatcher können sowohl in IPv4- als auch in IPv6-Netzwerken installiert werden. Siehe IPV4 und IPV6.

Dispatcher-Konfigurationsdateien dispatcher-configuration-files

Die Dispatcher-Konfiguration wird standardmäßig in der Textdatei dispatcher.any gespeichert. Sie können aber Namen und Speicherort der Datei während der Installation ändern.

Die Konfigurationsdatei enthält eine Reihe von Eigenschaften mit einzelnen oder mehreren Werten, die das Verhalten des Dispatchers steuern:

Eine Beispielkonfiguration sieht wie folgt aus:

# name of the dispatcher
/name "internet-server"

# each farm configures a set off (loadbalanced) renders
/farms
 {
  # first farm entry (label is not important, just for your convenience)
   /website
     {
     /clientheaders
       {
       # List of headers that are passed on
       }
     /virtualhosts
       {
       # List of URLs for this Web site
       }
     /sessionmanagement
       {
       # settings for user authentification
       }
     /renders
       {
       # List of AEM instances that render the documents
       }
     /filter
       {
       # List of filters
       }
     /vanity_urls
       {
       # List of vanity URLs
       }
     /cache
       {
       # Cache configuration
       /rules
         {
         # List of cachable documents
         }
       /invalidate
         {
         # List of auto-invalidated documents
         }
       }
     /statistics
       {
       /categories
         {
         # The document categories that are used for load balancing estimates
         }
       }
     /stickyConnectionsFor "/myFolder"
     /health_check
       {
       # Page gets contacted when an instance returns a 500
       }
     /retryDelay "1"
     /numberOfRetries "5"
     /unavailablePenalty "1"
     /failover "1"
     }
 }

Sie können auch andere Dateien in die Konfiguration einbeziehen:

Zum Einbeziehen der Datei „myFarm.any“ in die /farms-Konfiguration verwenden Sie beispielsweise folgenden Code:

/farms
  {
  $include "myFarm.any"
  }

Verwenden Sie das Sternchen (*) als Platzhalter, um einen Dateibereich auszuwählen.

Wenn beispielsweise die Dateien farm_1.any bis farm_5.any die Konfiguration der Farmen 1 bis 5 enthalten, können Sie sie wie folgt angeben bzw. auswählen:

/farms
  {
  $include "farm_*.any"
  }

Verwenden von Umgebungsvariablen using-environment-variables

Anstatt einer Hartkodierung von Werten können Sie in der Datei „dispatcher.any“ Umgebungsvariablen in Zeichenfolgen-Eigenschaften verwenden. Um den Wert einer Umgebungsvariablen einzubeziehen, verwenden Sie das Format ${variable_name}.

Wenn sich beispielsweise die Datei „dispatcher.any“ im selben Verzeichnis wie das Cache-Verzeichnis befindet, kann der folgende Wert für die Eigenschaft docroot verwendet werden:

/docroot "${PWD}/cache"

Wenn Sie als weiteres Beispiel eine Umgebungsvariable mit dem Namen PUBLISH_IP erstellen, in der der Host-Name der AEM-Veröffentlichungsinstanz gespeichert ist, kann die folgende Konfiguration der Eigenschaft /renders verwendet werden:

/renders {
  /0001 {
    /hostname "${PUBLISH_IP}"
    /port "8443"
  }
}

Benennen der Dispatcher-Instanz naming-the-dispatcher-instance-name

Verwenden Sie die /name-Eigenschaft, um einen eindeutigen Namen für die Dispatcher-Instanz anzugeben. Die /name-Eigenschaft ist eine Eigenschaft der obersten Ebene in der Konfigurationsstruktur.

Definieren von Farmen defining-farms-farms

Die /farms-Eigenschaft definiert eine oder mehrere Gruppen von Dispatcher-Verhalten, wobei jede Gruppe mit verschiedenen Websites oder URLs verknüpft ist. Die /farms-Eigenschaft kann eine oder mehrere Farmen umfassen:

Diese /farms-Eigenschaft ist eine Eigenschaft der obersten Ebene in der Konfigurationsstruktur. Zum Definieren einer Farm fügen Sie der /farms-Eigenschaft eine untergeordnete Eigenschaft hinzu. Verwenden Sie einen Eigenschaftsnamen, der die Farm in der Dispatcher-Instanz eindeutig identifiziert.

Die /farmname-Eigenschaft umfasst mehrere Werte und enthält andere Eigenschaften, die das Verhalten des Dispatchers definieren:

Der Wert kann ein beliebiges alphanumerisches Zeichen (a-z, 0–9) enthalten. Das folgende Beispiel zeigt das Definitionsgerüst für zwei Farmen mit den Namen /daycom und /docsdaycom:

#name of dispatcher
/name "day sites"

#farms section defines a list of farms or sites
/farms
{
   /daycom
   {
       ...
   }
   /docdaycom
   {
      ...
   }
}

Jede Farmeigenschaft kann die folgenden untergeordneten Eigenschaften enthalten:

Angeben einer Standardseite (nur IIS) – /homepage specify-a-default-page-iis-only-homepage

Festlegen der HTTP-Header zur Durchleitung specifying-the-http-headers-to-pass-through-clientheaders

Die Eigenschaft /clientheaders definiert eine Liste von HTTP-Headern, die der Dispatcher von der Client-HTTP-Anfrage an den Renderer (AEM-Instanz) übergibt.

Standardmäßig leitet der Dispatcher die Standard-HTTP-Header an die AEM-Instanz weiter. In einigen Fällen kann es notwendig werden, zusätzliche Header weiterzuleiten oder bestimmte Header zu entfernen:

Wenn Sie die Header zur Durchleitung anpassen, müssen Sie diese in einer vollständigen Header-Liste angeben, die auch die normalerweise standardmäßig eingeschlossenen Header umfasst.

Für eine Dispatcher-Instanz, die Seitenaktivierungsanfragen für Veröffentlichungsinstanzen verarbeitet, wird beispielsweise der Header PATH im Abschnitt /clientheaders benötigt. Der PATH-Header ermöglicht die Kommunikation zwischen dem Replikationsagenten und dem Dispatcher.

Der folgende Code ist eine Beispielkonfiguration für /clientheaders:

/clientheaders
  {
  "CSRF-Token"
  "X-Forwarded-Proto"
  "referer"
  "user-agent"
  "authorization"
  "from"
  "content-type"
  "content-length"
  "accept-charset"
  "accept-encoding"
  "accept-language"
  "accept"
  "host"
  "max-forwards"
  "proxy-authorization"
  "proxy-connection"
  "range"
  "cookie"
  "cq-action"
  "cq-handle"
  "handle"
  "action"
  "cqstats"
  "depth"
  "translate"
  "expires"
  "date"
  "dav"
  "ms-author-via"
  "if"
  "lock-token"
  "x-expected-entity-length"
  "destination"
  "PATH"
  }

Identifizieren von virtuellen Hosts identifying-virtual-hosts-virtualhosts

Die Eigenschaft /virtualhosts definiert eine Liste aller Hostnamen- und URI-Kombinationen, die der Dispatcher für diese Farm akzeptiert. Das Sternchen (*) kann als Platzhalter verwendet werden. Die Werte für die /virtualhosts-Eigenschaft weisen folgendes Format auf:

[scheme]host[uri][*]

Mit der folgenden Beispielkonfiguration werden Anfragen für die Domains .com und .ch von „myCompany“ und alle Domains von „mySubDivision“ verarbeitet:

   /virtualhosts
    {
    "www.myCompany.com"
    "www.myCompany.ch"
    "www.mySubDivison.*"
    }

Mithilfe der folgenden Konfiguration werden alle Anfragen verarbeitet:

   /virtualhosts
    {
    "*"
    }

Auflösen des virtuellen Hosts resolving-the-virtual-host

Wenn der Dispatcher eine HTTP- oder HTTPS-Anforderung erhält, wird der Wert des virtuellen Hosts gesucht, der den Headern host, uri und scheme der Anforderung am besten entspricht. Der Dispatcher wertet die Werte in den virtualhosts-Eigenschaften in der folgenden Reihenfolge aus:

Der Dispatcher ermittelt wie folgt den passendsten Wert für den virtuellen Host:

Daher sollten Sie Ihren standardmäßigen virtuellen Host an den Anfang der Eigenschaft virtualhosts setzen. Platzieren Sie ihn in der obersten Farm Ihrer dispatcher.any-Datei.

Beispiel für die Auflösung von virtuellen Hosts example-virtual-host-resolution

Das folgende Beispiel zeigt ein Code-Fragment der Datei dispatcher.any, mit dem zwei Dispatcher-Farmen definiert werden. Jede Farm definiert dabei eine Eigenschaft virtualhosts.

/farms
  {
  /myProducts
    {
    /virtualhosts
      {
      "www.mycompany.com/products/*"
      }
    /renders
      {
      /hostname "server1.myCompany.com"
      /port "80"
      }
    }
  /myCompany
    {
    /virtualhosts
      {
      "www.mycompany.com"
      }
    /renders
      {
      /hostname "server2.myCompany.com"
      /port "80"
      }
    }
  }

In der folgenden Tabelle sind die virtuellen Hosts aufgeführt, die für die HTTP-Anfrage im Beispiel aufgelöst werden:

Aktivierung von Sicherheitssitzungen – /sessionmanagement enabling-secure-sessions-sessionmanagement

Erstellen Sie eine sichere Sitzung für den Zugriff auf die Renderer-Farm, sodass Benutzende nur nach Anmeldung Zugriff auf Seiten in der Farm erhalten. Nach ihrer Anmeldung können sie dann auf Seiten in der Farm zugreifen. Informationen zur Verwendung dieser Funktion mit geschlossenen Benutzergruppen (Closed User Groups, CUGs) finden Sie unter Erstellen einer geschlossenen Benutzergruppe. Lesen Sie vor der Live-Schaltung auch die Sicherheits-Checkliste für den Dispatcher.

Die Eigenschaft /sessionmanagement ist eine Untereigenschaft von /farms.

/sessionmanagement weist mehrere Unterparameter auf:

/directory (obligatorisch)

Das Verzeichnis, in dem die Sitzungsinformationen gespeichert werden. Wenn das Verzeichnis nicht vorhanden ist, wird es erstellt.

/sessionmanagement
  {
  /directory "/usr/local/apache/.sessions"
  }

/encode (optional)

Gibt an, wie die Sitzungsinformationen kodiert werden. Verwenden Sie md5 zum Verschlüsseln mit dem md5-Algorithmus oder hex zur Hexadezimalcodierung. Wenn Sie die Sitzungsdaten verschlüsseln, können auch Benutzende mit Zugriff auf das Dateisystem den Sitzungsinhalt nicht lesen. Der Standardwert lautet md5.

/header (optional)

Der Name des HTTP-Headers oder Cookies, in dem die Autorisierungsinformationen gespeichert sind. Wenn Sie die Informationen im HTTP-Header speichern möchten, verwenden Sie HTTP:<header-name>. Um die Informationen in einem Cookie zu speichern, verwenden Sie Cookie:<header-name>. Wenn Sie keinen Wert angeben, wird HTTP:authorization verwendet.

/timeout (optional)

Die Anzahl der Sekunden an Inaktivität der Sitzung, bis sie abläuft. Wird kein Wert angegeben, wird "800" verwendet, sodass eine Zeitüberschreitung für die Sitzung gut 13 Minuten nach der letzten Benutzeranfrage eintritt.

Eine Beispielkonfiguration sieht wie folgt aus:

/sessionmanagement
  {
  /directory "/usr/local/apache/.sessions"
  /encode "md5"
  /header "HTTP:authorization"
  /timeout "800"
  }

Definieren von Seiten-Renderern defining-page-renderers-renders

Mit der Eigenschaft /renders wird die URL definiert, an die der Dispatcher Anfragen zum Rendern eines Dokuments sendet. Im folgenden beispielhaften /renders-Abschnitt wird eine einzelne AEM-Instanz zum Rendern definiert:

/renders
  {
    /myRenderer
      {
      # hostname or IP of the renderer
      /hostname "aem.myCompany.com"
      # port of the renderer
      /port "4503"
      # connection timeout in milliseconds, "0" (default) waits indefinitely
      /timeout "0"
      }
  }

Im folgenden beispielhaften /renders-Abschnitt wird eine AEM-Instanz definiert, die auf demselben Computer wie der Dispatcher ausgeführt wird:

/renders
  {
    /myRenderer
     {
     /hostname "127.0.0.1"
     /port "4503"
     }
  }

Mit folgendem beispielhaften /renders-Abschnitt werden Renderanfragen gleichmäßig auf zwei AEM-Instanzen verteilt:

/renders
  {
    /myFirstRenderer
      {
      /hostname "aem.myCompany.com"
      /port "4503"
      }
    /mySecondRenderer
      {
      /hostname "127.0.0.1"
      /port "4503"
      }
  }

Render-Optionen renders-options

/Zeitüberschreitung

Gibt die Verbindungszeitüberschreitung für den Zugriff auf die AEM-Instanz in Millisekunden an. Der Standardwert ist "0", d. h., der Dispatcher wartet unendlich lange.

/receiveTimeout

Gibt die Zeit in Millisekunden an, für die auf eine Antwort gewartet wird. Der Standardwert ist "600000", d. h., der Dispatcher wartet 10 Minuten. Bei einem Wert von "0" gibt es keine Zeitüberschreitung.

Wenn die Zeitüberschreitung beim Analysieren der Antwort-Header auftritt, wird der HTTP-Status 504 (fehlerhaftes Gateway) zurückgegeben. Wenn die Zeitüberschreitung beim Lesen des Antworttexts auftritt, gibt der Dispatcher die unvollständige Antwort an den Client zurück. Er löscht zudem alle Cache-Dateien, die ggf. geschrieben wurden.

/ipv4

Gibt an, ob der Dispatcher die getaddrinfo-Funktion (für IPv6) oder die gethostbyname-Funktion (für IPv4) zum Abrufen der IP-Adresse des Renderers nutzt. Ein Wert von 0 bewirkt, dass getaddrinfo verwendet wird. Ein Wert von 1 bewirkt, dass gethostbyname verwendet wird. Der Standardwert ist 0.

Die Funktion getaddrinfo gibt eine Liste von IP-Adressen zurück. Der Dispatcher durchläuft die Liste der Adressen, bis er eine TCP/IP-Verbindung herstellt. Daher ist die Eigenschaft ipv4 wichtig, wenn der Rendering-Host-Name mit mehreren IP-Adressen verbunden ist. Außerdem gibt der Host als Antwort auf die Funktion getaddrinfo eine Liste von IP-Adressen zurück, die immer in der gleichen Reihenfolge sind. In diesem Fall sollten Sie die Funktion gethostbyname verwenden, damit die IP-Adresse, mit der sich der Dispatcher verbindet, ein Zufallswert ist.

Amazon Elastic Load Balancing (ELB) ist ein solcher Dienst, der auf „getaddrinfo“ mit einer potenziell gleich sortierten Liste von IP-Adressen reagiert.

/secure

Wenn die Eigenschaft /secure den Wert "1" hat, verwendet der Dispatcher HTTPS zur Kommunikation mit der AEM-Instanz. Weitere Einzelheiten finden Sie unter Konfigurieren des Dispatchers für die Verwendung von SSL.

/always-resolve

Mit der Dispatcher-Version 4.1.6 können Sie die /always-resolve-Eigenschaft wie folgt konfigurieren:

Diese Eigenschaft kann auch verwendet werden, wenn Probleme mit der dynamischen IP-Auflösung auftreten, wie im folgenden Beispiel gezeigt wird:

/renders {
  /0001 {
     /hostname "host-name-here"
     /port "4502"
     /ipv4 "1"
     /always-resolve "1"
     }
  }

Konfigurieren des Zugriffs auf den Inhalt configuring-access-to-content-filter

Verwenden Sie den /filter-Abschnitt, um die HTTP-Anfragen anzugeben, die der Dispatcher akzeptiert. Alle anderen Anfragen werden zum Webserver mit dem Fehlercode 404 (Seite nicht gefunden) zurückgesendet. Wenn kein /filter-Abschnitt vorhanden ist, werden alle Anfragen akzeptiert.

Hinweis: Anforderungen für die Statfile werden immer abgelehnt.

Der Abschnitt /filter besteht aus einer Reihe von Regeln, die den Zugriff auf Inhalte zulassen oder verweigern, wozu Muster in der Anfragezeile der HTTP-Anfrage abgeglichen werden. Verwenden Sie eine Zulassungslisten-Strategie für den Abschnitt /filter:

Definieren eines Filters defining-a-filter

Jedes Element im /filter-Abschnitt enthält einen Typ und ein Muster, die mit einem bestimmten Element der Anfragezeile oder mit der gesamten Anfragezeile abgeglichen werden. Jeder Filter kann die folgenden Elemente enthalten:

Anfragezeilen von HTTP-Anfragen the-request-line-part-of-http-requests

Bei HTTP/1.1 wird die Anfragezeile wie folgt definiert:

Method Request-URI HTTP-Version<CRLF>

Die <CRLF>-Zeichen stehen für einen Wagenrücklauf, gefolgt von einem Zeilenvorschub. Das folgende Beispiel zeigt die Anfragezeile, die empfangen wird, wenn ein Client die US-englische Seite der WKND-Site anfordert:

GET /content/wknd/us/en.html HTTP.1.1<CRLF>

Muster müssen die Leerzeichen in der Anfragezeile sowie die <CRLF>-Zeichen berücksichtigen.

Doppelte und einfache Anführungszeichen double-quotes-vs-single-quotes

Verwenden Sie bei der Erstellung Ihrer Filterregeln doppelte Anführungszeichen "pattern" für einfache Muster. Wenn Sie die Dispatcher-Version 4.2.0 oder höher verwenden und Ihr Muster einen regulären Ausdruck enthält, müssen Sie das RegEx-Muster '(pattern1|pattern2)' in einfache Anführungszeichen setzen.

Reguläre Ausdrücke regular-expressions

In Dispatcher-Versionen höher als 4.2.0 können Sie POSIX-erweiterte reguläre Ausdrücke in Ihren Filtermustern verwenden.

Problembehebung bei Filtern troubleshooting-filters

Falls Ihre Filter nicht so ausgelöst werden, wie Sie es erwarten, können Sie im Dispatcher die Ablaufprotokollierung aktivieren, damit Sie sehen, welcher Filter die Anfrage abfängt.

Beispielfilter: Alle verweigern example-filter-deny-all

Bei dem folgenden Beispiel-Filterabschnitt verweigert der Dispatcher Anfragen für alle Dateien. Verweigern Sie den Zugriff auf alle Dateien und lassen Sie dann den Zugriff auf bestimmte Bereiche zu.

/0001  { /type "deny" /url "*"  }

Anfragen für explizit verweigerte Bereiche führen zur Rückgabe des Fehler-Codes 404 (Seite nicht gefunden).

Beispielfilter: Zugriff auf bestimmte Bereiche verweigern example-filter-deny-access-to-specific-areas

Mit Filtern können Sie den Zugriff auf bestimmte Elemente verweigern, z. B. ASP-Seiten und sensible Bereiche innerhalb einer Veröffentlichungsinstanz. Mit dem folgenden Filter wird der Zugriff auf ASP-Seiten verweigert:

/0002  { /type "deny" /url "*.asp"  }

Beispielfilter: POST-Anfragen ermöglichen example-filter-enable-post-requests

Mit dem folgenden Beispielfilter wird das Senden von Formulardaten mit der POST-Methode ermöglicht:

/filter {
    /0001  { /glob "*" /type "deny" }
    /0002 { /type "allow" /method "POST" /url "/content/[.]*.form.html" }
}

Beispielfilter: Zugriff auf die Workflow-Konsole zulassen example-filter-allow-access-to-the-workflow-console

Das folgende Beispiel zeigt einen Filter, mit dem der externe Zugriff auf die Workflow-Konsole zugelassen wird:

/filter {
    /0001  { /glob "*" /type "deny" }
    /0002  {  /type "allow"  /url "/libs/cq/workflow/content/console*"  }
}

Wenn Ihre Veröffentlichungsinstanz einen Web-Anwendungskontext verwendet (z. B. Veröffentlichung), kann sie auch zu Ihrer Filterdefinition hinzugefügt werden.

/0003   { /type "deny"  /url "/publish/libs/cq/workflow/content/console/archive*"  }

Wenn Sie innerhalb eines eingeschränkten Bereichs auf einzelne Seiten zugreifen müssen, können Sie den Zugriff auf diese zulassen. Um beispielsweise den Zugriff auf die Registerkarte „Archiv“ in der Workflow-Konsole zuzulassen, fügen Sie den folgenden Abschnitt hinzu:

/0004  { /type "allow"  /url "/libs/cq/workflow/content/console/archive*"   }

Beispielfilter: Reguläre Ausdrücke verwenden example-filter-using-regular-expressions

Dieser Filter ermöglicht mithilfe dieses regulären Ausdrucks (in einfachen Anführungszeichen) Erweiterungen in nicht öffentlichen Inhaltsordnern:

/005  {  /type "allow" /extension '(css|gif|ico|js|png|swf|jpe?g)' }

Beispielfilter: Filtern zusätzlicher Elemente einer Anforderungs-URL example-filter-filter-additional-elements-of-a-request-url

Mit dem nachstehenden Regelbeispiel wird der Inhaltsabruf aus dem /content-Pfad und seiner Unterstruktur mithilfe von Filtern für Pfad (path), Selektoren (selectors) und Erweiterung (extension) blockiert:

/006 {
        /type "deny"
        /path "/content/*"
        /selectors '(feed|rss|pages|languages|blueprint|infinity|tidy|sysview|docview|query|jcr:content|_jcr_content|search|childrenlist|ext|assets|assetsearch|[0-9-]+)'
        /extension '(json|xml|html|feed))'
        }

Beispielabschnitt /filter example-filter-section

Wenn Sie den Dispatcher konfigurieren, schränken Sie externe Zugriffe so weit wie möglich ein. Im folgenden Beispiel wird externen Besucherinnen und Besuchern ein minimaler Zugriff gewährt:

Testen Sie den Seitenzugriff nach dem Erstellen der Filter, um sicherzustellen, dass Ihre AEM-Instanz sicher ist.

Den folgenden /filter-Abschnitt der Datei dispatcher.any können Sie in Ihrer Dispatcher-Konfigurationsdatei als Grundlage verwenden.

Dieses Beispiel beruht auf der Standardkonfigurationsdatei, die mit dem Dispatcher zur Verfügung gestellt wird, und dient als Beispiel für die Verwendung in einer Produktionsumgebung. Elemente mit dem Präfix # sind deaktiviert (auskommentiert). Wenn Sie diese aktivieren möchten (durch Entfernen des #-Zeichens in dieser Zeile), sollten Sie mit Bedacht vorgehen. Denn dies kann sich auf die Sicherheit auswirken.

Verweigern Sie zunächst den Zugriff auf alles und lassen Sie dann den Zugriff auf bestimmte (begrenzte) Elemente zu:

  /filter
      {
      # Deny everything first and then allow specific entries
      /0001  { /type "deny" /url "*"  }

      # Open consoles
#     /0011 { /type "allow" /url "/admin/*"  }  # allow servlet engine admin
#     /0012 { /type "allow" /url "/crx/*"    }  # allow content repository
#     /0013 { /type "allow" /url "/system/*" }  # allow OSGi console

      # Allow non-public content directories
#     /0021 { /type "allow" /url "/apps/*"   }  # allow apps access
#     /0022 { /type "allow" /url "/bin/*"    }
      /0023 { /type "allow" /url "/content*" }  # disable this rule to allow mapped content only

#     /0024 { /type "allow" /url "/libs/*"   }
#     /0025 { /type "deny"  /url "/libs/shindig/proxy*" } # if you enable /libs close access to proxy

#     /0026 { /type "allow" /url "/home/*"   }
#     /0027 { /type "allow" /url "/tmp/*"    }
#     /0028 { /type "allow" /url "/var/*"    }

      # Enable extensions in non-public content directories, using a regular expression
      /0041
        {
        /type "allow"
        /extension '(css|gif|ico|js|png|swf|jpe?g)'
        }

      # Enable features
      /0062 { /type "allow" /url "/libs/cq/personalization/*"  }  # enable personalization

      # Deny content grabbing, on all accessible pages, using regular expressions
      /0081
        {
        /type "deny"
        /selectors '((sys|doc)view|query|[0-9-]+)'
        /extension '(json|xml)'
        }
      # Deny content grabbing for /content and its subtree
      /0082
        {
        /type "deny"
        /path "/content/*"
        /selectors '(feed|rss|pages|languages|blueprint|infinity|tidy)'
        /extension '(json|xml|html)'
        }

#     /0087 { /type "allow" /method "GET" /extension 'json' "*.1.json" }  # allow one-level json requests
}

Berücksichtigen Sie die folgenden Empfehlungen, wenn Sie den Zugriff erweitern möchten:

Je nach Installation stehen unter /libs, /apps oder an einem anderen Ort möglicherweise mehr Ressourcen zur Verfügung, die ebenfalls verfügbar gemacht werden müssen. Sie können die Datei access.log zum Ermitteln von Ressourcen verwenden, auf die extern zugegriffen wird.

Einschränken von Abfragezeichenfolgen restricting-query-strings

Seit der Dispatcher-Version 4.1.5 können Sie den Abschnitt /filter zum Einschränken von Abfragezeichenfolgen nutzen. Es wird empfohlen, mit allow-Filterelementen bestimmte Abfragezeichenfolgen explizit zuzulassen und alle anderen zu verweigern.

Ein einzelner Eintrag kann entweder glob oder eine Kombination von method, url, query und version aufweisen, aber nicht beides. Im folgenden Beispiel wird die Abfragezeichenfolge a=* zugelassen. Alle anderen Abfragezeichenfolgen für URLs, die zum Knoten /etc auflösen, werden verweigert:

/filter {
 /0001 { /type "deny" /method "POST" /url "/etc/*" }
 /0002 { /type "allow" /method "GET" /url "/etc/*" /query "a=*" }
}

/filter {
>/0001 { /type "deny" /method "*" /url "/path/*" }
>/0002 { /type "allow" /method "GET" /url "/path/*" }
>/0003 { /type "deny" /method "GET" /url "/path/*" /query "*" }
>/0004 { /type "allow" /method "GET" /url "/path/*" /query "a=*" }
}

Testen der Dispatcher-Sicherheit testing-dispatcher-security

Dispatcher-Filter sollten den Zugriff auf folgende Seiten und Skripte in AEM-Veröffentlichungsinstanzen blockieren. Öffnen Sie diese Seiten in einem Webbrowser so wie Besucherinnen und Besucher der Site und stellen Sie sicher, dass der Code 404 zurückgegeben wird. Passen Sie die Filter an, falls ein anderes Ergebnis angezeigt wird.

Bei /content/add_valid_page.html?debug=layout sollte ein normales Rendering der Seite zu sehen sein.

Um festzustellen, ob ein anonymer Schreibzugriff aktiviert ist, geben Sie den folgenden Befehl in einem Terminal oder in einer Eingabeaufforderung ein. Das Schreiben von Daten in den Knoten sollte nicht möglich sein.

curl -X POST "https://anonymous:anonymous@hostname:port/content/usergenerated/mytestnode"

Um den Dispatcher-Cache zu invalidieren und sicherzustellen, dass Sie den Code 403 als Antwort erhalten, geben Sie den folgenden Befehl in einem Terminal oder einer Eingabeaufforderung ein:

curl -H "CQ-Handle: /content" -H "CQ-Path: /content" https://yourhostname/dispatcher/invalidate.cache

Ermöglichen des Zugriffs auf Vanity-URLs enabling-access-to-vanity-urls-vanity-urls

Sie können den Dispatcher so konfigurieren, dass der Zugriff auf Vanity-URLs möglich ist, die für Ihre AEM-Seiten konfiguriert sind.

Wenn der Zugriff auf Vanity-URLs aktiviert ist, ruft der Dispatcher regelmäßig einen Dienst in der Render-Instanz auf, um eine Liste der Vanity-URLs abzurufen. Der Dispatcher speichert diese Liste in einer lokalen Datei. Wenn eine Seitenanfrage wegen eines Filters im /filter-Abschnitt verweigert wird, prüft der Dispatcher diese Liste von Vanity-URLs. Befindet sich die abgelehnte URL in der Liste, wird der Dispatcher den Zugriff auf diese Vanity-URL zulassen.

Um den Zugriff auf Vanity-URLs zu aktivieren, fügen Sie einen /vanity_urls-Abschnitt zum /farms-Abschnitt hinzu, ähnlich wie im folgenden Beispiel:

 /vanity_urls {
      /url "/libs/granite/dispatcher/content/vanityUrls.html"
      /file "/tmp/vanity_urls"
      /delay 300
 }

Der /vanity_urls-Abschnitt enthält die folgenden Eigenschaften:

Führen Sie die folgenden Schritte aus, um den Zugriff auf Vanity-URLs zu aktivieren.

Weiterleiten von Syndizierungsanfragen – /propagateSyndPost forwarding-syndication-requests-propagatesyndpost

Syndizierungsanfragen beziehen sich nur auf den Dispatcher, sodass sie standardmäßig nicht an den Renderer (z. B. eine AEM-Instanz) gesendet werden.

Falls erforderlich, können Sie die Eigenschaft /propagateSyndPost auf "1" festlegen, damit Syndizierungsanfragen an den Dispatcher weitergeleitet werden. Wenn diese Einstellung festgelegt ist, müssen Sie sicherstellen, dass POST-Anfragen im Filterabschnitt nicht verweigert werden.

Konfigurieren des Dispatcher-Caches – /cache configuring-the-dispatcher-cache-cache

Über den /cache-Abschnitt wird gesteuert, wie der Dispatcher Dokumente zwischenspeichert. Konfigurieren Sie Untereigenschaften, um das Caching entsprechend Ihren Strategien zu implementieren:

Ein Cacheabschnitt kann beispielsweise wie folgt aussehen:

/cache
  {
  /docroot "/opt/dispatcher/cache"
  /statfile  "/tmp/dispatcher-website.stat"
  /allowAuthorized "0"

  /rules
    {
    # List of files that are cached
    }

  /invalidate
    {
    # List of files that are auto-invalidated
    }
  }

Festlegen des Cacheordners specifying-the-cache-directory

Die Eigenschaft /docroot identifiziert den Ordner, in dem die Cachedateien gespeichert werden.

Wenn Sie mehrere Farmen verwenden, muss jede Farm ein anderes Basisverzeichnis nutzen.

Benennen der Statfile naming-the-statfile

In der /statfile-Eigenschaft wird die Datei angegeben, die als Statfile verwendet werden soll. Der Dispatcher verwendet diese Datei, um den Zeitpunkt der letzten Inhaltsaktualisierung zu protokollieren. Die Stat-Datei kann eine beliebige Datei auf dem Webserver sein.

Die Stat-Datei hat keinen Inhalt. Nach einer Inhaltsaktualisierung ändert der Dispatcher lediglich den Zeitstempel. Die Standard-Stat-Datei heißt .stat und ist im Basisverzeichnis gespeichert. Der Dispatcher blockiert den Zugriff auf die Stat-Datei.

Bereitstellen veralteter Dokumente, wenn Fehler auftreten serving-stale-documents-when-errors-occur

Die Eigenschaft /serveStaleOnError steuert, ob der Dispatcher als invalidiert gekennzeichnete Dokumente zurückgibt, wenn der Render-Server einen Fehler zurückgibt. Wenn eine Stat-Datei geändert wird und zwischengespeicherten Inhalt invalidiert, löscht der Dispatcher standardmäßig den zwischengespeicherten Inhalt. Diese Aktion wird ausgeführt, wenn sie das nächste Mal angefordert wird.

Wenn /serveStaleOnError auf "1" festgelegt ist, löscht der Dispatcher keine invalidierten Inhalte aus dem Cache, es sei denn, der Render-Server gibt eine „Erfolgreich“-Antwort zurück. Bei einer 5xx-Antwort von AEM oder einer Zeitüberschreitung gibt der Dispatcher den veralteten Inhalt mit dem HTTP-Status 111 („Erneute Validierung fehlgeschlagen“) zurück.

Zwischenspeicherung bei Verwendung von Authentifizierung caching-when-authentication-is-used

Die Eigenschaft /allowAuthorized steuert, ob Anfragen, die eine der folgenden Authentifizierungsinformationen enthalten, zwischengespeichert werden:

Standardmäßig werden Anfragen, die diese Authentifizierungsinformationen enthalten, nicht zwischengespeichert, da bei der Rückgabe eines zwischengespeicherten Dokuments an den Client keine Authentifizierung durchgeführt wird. Diese Konfiguration verhindert, dass der Dispatcher zwischengespeicherte Dokumente Benutzenden bereitstellt, die nicht über die erforderlichen Rechte verfügen.

Wenn Sie jedoch das Zwischenspeichern von authentifizierten Dokumenten erlauben möchten, legen Sie /allowAuthorized auf „1“ fest:

/allowAuthorized "1"

Festlegen der Dokumente, die zwischengespeichert werden sollen specifying-the-documents-to-cache

Die /rules-Eigenschaft steuert anhand des Dokumentenpfads, welche Dokumente zwischengespeichert werden sollen. Unabhängig von der /rules-Eigenschaft werden in folgenden Fällen Dokumente nie zwischengespeichert:

Jedes Element in der Eigenschaft /rules umfasst ein glob-Muster und einen Typ:

Wenn Sie keine dynamischen Seiten haben (abgesehen von denen, die durch die oben genannten Regeln bereits ausgeschlossen sind), können Sie den Dispatcher so konfigurieren, dass alles zwischengespeichert wird. Der rules-Abschnitt sieht wie folgt aus:

/rules
  {
    /0000  {  /glob "*"   /type "allow" }
  }

Weitere Informationen zu glob-Eigenschaften finden Sie unter Entwerfen von Mustern für glob-Eigenschaften.

Für dynamische Bereiche Ihrer Seite (z. B. eine App für Neuigkeiten) oder für geschlossene Benutzergruppen können Sie Ausnahmen definieren:

/rules
  {
   /0000  { /glob "*" /type "allow" }
   /0001  { /glob "/en/news/*" /type "deny" }
   /0002  { /glob "*/private/*" /type "deny"  }
  }

Komprimierung

Auf Apache-Webservern können Sie die im Cache gespeicherten Dokumente komprimieren. Dann kann Apache Dokumente komprimiert zurückgeben, wenn dies vom Client angefordert wird. Die Komprimierung erfolgt automatisch durch Aktivieren des Apache-Moduls mod_deflate, beispielsweise:

AddOutputFilterByType DEFLATE text/plain

Das Modul wird standardmäßig mit Apache 2.x installiert.

Invalidierung von Dateien nach Ordnerebene invalidating-files-by-folder-level

Verwenden Sie die /statfileslevel-Eigenschaft, um zwischengespeicherte Dateien anhand ihres Pfads als invalidiert zu kennzeichnen:

Es sind nur Ressourcen entlang des Pfads zur invalidierten Datei betroffen. Nehmen wir folgendes Beispiel: Eine Website verwendet die Struktur /content/myWebsite/xx/.. Wenn Sie statfileslevel auf 3 festlegen, wird eine .stat-Datei wie folgt erstellt:

Wird eine Datei in /content/myWebsite/xx invalidiert, wirkt sich dies auf jede .stat-Datei vom Basisverzeichnis bis zu /content/myWebsite/xx aus. Dieses gilt nur für /content/myWebsite/xx und nicht etwa für /content/myWebsite/yy oder /content/anotherWebSite.

Automatische Invalidierung zwischengespeicherter Dateien automatically-invalidating-cached-files

Die /invalidate-Eigenschaft definiert die Dokumente, die bei Aktualisierung des Inhalts automatisch invalidiert werden.

Bei der automatischen Invalidierung löscht der Dispatcher die im Cache gespeicherten Dateien nach einer Inhaltsaktualisierung nicht, prüft aber ihre Gültigkeit, wenn sie das nächste Mal angefordert werden. Dokumente im Cache, die nicht automatisch invalidiert werden, verbleiben im Cache, bis sie durch eine Inhaltsaktualisierung explizit gelöscht werden.

Die automatische Invalidierung wird in der Regel für HTML-Seiten verwendet. HTML-Seiten enthalten oft Links zu anderen Seiten, sodass nicht immer klar ist, ob sich eine Inhaltsaktualisierung auf eine Seite auswirkt. Um sicherzustellen, dass bei einer Inhaltsaktualisierung alle relevanten Seiten invalidiert werden, sollte dies für alle HTML-Seiten automatisch durchgeführt werden. Mit der folgenden Konfiguration werden alle HTML-Seiten invalidiert:

  /invalidate
  {
   /0000  { /glob "*" /type "deny" }
   /0001  { /glob "*.html" /type "allow" }
  }

Weitere Informationen zu Glob-Eigenschaften finden Sie unter Entwerfen von Mustern für Glob-Eigenschaften.

Diese Konfiguration löst die folgende Aktivität aus, wenn /content/wknd/us/en aktiviert wird:

Wenn Sie automatisch generierte PDF-Dateien und ZIP-Dateien zum Download anbieten, müssen Sie diese ggf. ebenfalls automatisch invalidieren. Eine mögliche Konfiguration sieht wie folgt aus:

/invalidate
  {
   /0000 { /glob "*" /type "deny" }
   /0001 { /glob "*.html" /type "allow" }
   /0002 { /glob "*.zip" /type "allow" }
   /0003 { /glob "*.pdf" /type "allow" }
  }

Die AEM-Integration in Adobe Analytics liefert Konfigurationsdaten in einer Datei namens analytics.sitecatalyst.js innerhalb Ihrer Website. Die Beispieldatei dispatcher.any, die mit dem Dispatcher bereitgestellt wird, enthält die folgende Invalidierungsregel für diese Datei:

{
   /glob "*/analytics.sitecatalyst.js"  /type "allow"
}

Verwenden von benutzerdefinierten Skripts zur Invalidierung using-custom-invalidation-scripts

Die Eigenschaft /invalidateHandler ermöglicht es Ihnen, ein Skript zu definieren, das bei jeder vom Dispatcher empfangenen Invalidierungsanfrage aufgerufen wird.

Es wird mit folgenden Argumenten aufgerufen:

Mit dieser Methode können mehrere unterschiedliche Anwendungsfälle abgedeckt werden, z. B. die Invalidierung anderer anwendungsspezifischer Caches oder für Fälle, in denen die externalisierte URL einer Seite und ihre Position im Basisverzeichnis nicht mit dem Inhaltspfad übereinstimmen.

Das folgende Beispielskript wird jede invalidierte Anfrage in einer Datei protokolliert.

/invalidateHandler "/opt/dispatcher/scripts/invalidate.sh"

Beispiel für ein Handler-Skript zur Invalidierung sample-invalidation-handler-script

#!/bin/bash

printf "%-15s: %s %s" $1 $2 $3>> /opt/dispatcher/logs/invalidate.log

Eingrenzen der Clients, die den Cache leeren können limiting-the-clients-that-can-flush-the-cache

Mit der /allowedClients-Eigenschaft werden bestimmte Clients definiert, die den Cache leeren können. Die Globbing-Muster werden mit der IP abgeglichen.

Im folgenden Beispiel:

/allowedClients
  {
   /0001 { /glob "*.*.*.*"  /type "deny" }
   /0002 { /glob "127.0.0.1" /type "allow" }
  }

Weitere Informationen zu Glob-Eigenschaften finden Sie unter Entwerfen von Mustern für Glob-Eigenschaften.

Ignorieren von URL-Parametern ignoring-url-parameters

Im ignoreUrlParams-Abschnitt wird definiert, welche URL-Parameter bei der Prüfung, ob eine Seite zwischengespeichert wird oder aus dem Cache geliefert wird, ignoriert werden sollen:

Wenn ein Parameter für eine Seite ignoriert wird, wird die Seite bei der ersten Anfrage zwischengespeichert. Nachfolgende Anfragen für die Seite werden an die zwischengespeicherte Seite weitergeleitet, unabhängig vom Wert des Parameters in der Anfrage.

Um festzulegen, welche Parameter ignoriert werden, fügen Sie glob-Regeln zu der Eige nschaft ignoreUrlParamshinzu:

Das folgende Beispiel führt dazu, dass der Dispatcher alle Parameter außer nocache ignoriert. Daher speichert der Dispatcher niemals URL-Anfragen, die den Parameter nocache enthalten:

/ignoreUrlParams
{
    # ignore-all-url-parameters-by-dispatcher-and-requests-are-cached
    /0001 { /glob "*" /type "allow" }
    # allow-the-url-parameter-nocache-to-bypass-dispatcher-on-every-request
    /0002 { /glob "nocache" /type "deny" }
}

Im Kontext des Konfigurationsbeispiels für ignoreUrlParams oben bewirkt die folgende HTTP-Anfrage, dass die Seite zwischengespeichert wird, da der Parameter willbecached ignoriert wird:

GET /mypage.html?willbecached=true

Im Kontext des Konfigurationsbeispiels für ignoreUrlParams bewirkt die folgende HTTP-Anfrage, dass die Seite nicht zwischengespeichert wird, da der Parameter nocache nicht ignoriert wird:

GET /mypage.html?nocache=true
GET /mypage.html?nocache=true&willbecached=true

Weitere Informationen zu Glob-Eigenschaften finden Sie unter Entwerfen von Mustern für Glob-Eigenschaften.

Zwischenspeichern von HTTP-Antwort-Headern caching-http-response-headers

Mit der Eigenschaft /headers können Sie die HTTP-Header-Typen definieren, die der Dispatcher zwischenspeichern soll. Bei der ersten Anfrage an eine nicht zwischengespeicherte Ressource werden alle Header, die mit einem der konfigurierten Werte übereinstimmen (siehe Konfigurationsbeispiel unten), in einer separaten Datei neben der Cache-Datei gespeichert. Bei nachfolgenden Anfragen an die zwischengespeicherte Ressource werden die gespeicherten Header zur Antwort hinzugefügt.

Im Folgenden ein Beispiel aus der Standardkonfiguration:

/cache {
  ...
  /headers {
    "Cache-Control"
    "Content-Disposition"
    "Content-Type"
    "Expires"
    "Last-Modified"
    "X-Content-Type-Options"
    "Last-Modified"
  }
}

FileETag none

Dispatcher-Cache-Dateiberechtigungen dispatcher-cache-file-permissions

Die Eigenschaft mode gibt an, welche Dateiberechtigungen auf neue Verzeichnisse und Dateien im Cache angewendet werden. Die umask des aufrufenden Prozesses schränkt diese Einstellung ein. Es handelt sich um eine Oktalzahl, die aus der Summe eines oder mehrerer der folgenden Werte gebildet wird:

Der Standardwert ist 0755. Dies ermöglicht der Inhaberin oder dem Inhaber, zu lesen, zu schreiben oder zu suchen, und der Gruppe sowie anderen, zu lesen oder zu suchen.

Einschränken von .stat-Dateiänderungen throttling-stat-file-touching

Im Falle der /invalidate-Standardeigenschaft werden bei jeder Aktivierung alle .html-Dateien invalidiert (wenn ihr Pfad dem Abschnitt /invalidate entspricht). Auf einer Website mit hohem Traffic erhöhen mehrere aufeinander folgende Aktivierungen die Back-End-CPU-Last. In einem solchen Szenario ist es wünschenswert, Änderungen der .stat-Datei zu „drosseln“, damit die Website responsiv bleibt. Dies ist über die Eigenschaft /gracePeriod möglich.

Die Eigenschaft /gracePeriod definiert die Anzahl der Sekunden, während derer eine veraltete, automatisch validierte Ressource nach der letzten Aktivierung noch aus dem Cache bereitgestellt werden darf. Die Eigenschaft kann in einem Setup verwendet werden, bei dem ein Stapel von Aktivierungen ansonsten wiederholt den gesamten Cache invalidieren würde. Der empfohlene Wert ist 2 Sekunden.

Weitere Informationen finden Sie unter /invalidate und /statfileslevel weiter oben.

Konfigurieren der zeitbasierten Cache-Invalidierung – /enableTTL configuring-time-based-cache-invalidation-enablettl

Die zeitbasierte Cache-Invalidierung hängt zum einen von der Eigenschaft /enableTTL ab, zum anderen davon, ob reguläre Ablauf-Header des HTTP-Standards vorhanden sind. Wenn Sie die Eigenschaft auf „1“ setzen (/enableTTL "1"), wertet sie die Antwort-Header vom Backend aus. Wenn der Header eine Datumsangabe für Cache-Control, max-age oder Expires enthält, wird eine leere Hilfsdatei neben der zwischengespeicherten Datei erstellt, deren Änderungszeitpunkt dem Ablaufdatum entspricht. Wenn die zwischengespeicherte Datei nach dem Änderungszeitpunkt angefordert wird, wird sie automatisch erneut vom Backend angefordert.

Vor Dispatcher 4.3.5 basierte die TTL-Invalidierungslogik alleine auf dem konfigurierten TTL-Wert. Bei Dispatcher 4.3.5 werden die festgelegte TTL und die Dispatcher-Cache-Invalidierungsregeln berücksichtigt. Für eine zwischengespeicherte Datei gilt daher Folgendes:

Diese neue Implementierung unterstützt Anwendungsfälle, in denen Dateien eine längere TTL aufweisen (z. B. im CDN). Diese Dateien können jedoch invalidiert werden, auch wenn die TTL noch nicht abgelaufen ist. Die Aktualität des Inhalts wird der Cache-Trefferquote im Dispatcher vorgezogen.

Falls Sie umgekehrt nur die auf eine Datei angewendete Ablauflogik benötigen, legen Sie /enableTTL auf „1“ fest und schließen Sie diese Datei vom standardmäßigen Cache-Invalidierungsmechanismus aus. Sie haben beispielsweise folgende Möglichkeiten:

  /invalidate
  {
   /0000  { /glob "*" /type "deny" }
   /0001  { /glob "*.html" /type "allow" }
   /0002  { /glob "*.example.html" /type "deny" }
  }

Dadurch wird sichergestellt, dass die Invalidierung der .stat-Datei nicht zur Anwendung kommt und für die angegebenen Dateien nur der TTL-Ablauf gilt.

Konfigurieren des Lastenausgleichs – /statistics configuring-load-balancing-statistics

Im /statistics-Abschnitt werden Kategorien von Dateien definiert, für die der Dispatcher die Reaktionsfähigkeit jedes Renderers bewertet. Der Dispatcher nutzt diese Bewertung, um festzulegen, an welchen Renderer eine Anfrage gesendet wird.

Jede Kategorie, die Sie erstellen, definiert ein glob-Muster. Der Dispatcher vergleicht den URI des angeforderten Inhalts mit diesen Mustern, um die Kategorie des angeforderten Inhalts zu ermitteln:

Der Dispatcher unterstützt maximal acht Statistikkategorien. Wenn Sie mehr als acht Kategorien definieren, werden nur die ersten acht verwendet.

Renderer-Auswahl

Jedes Mal, wenn der Dispatcher eine gerenderte Seite anfordert, wird der folgende Algorithmus zur Renderer-Auswahl angewendet:

Die Bewertung für eine Renderer-Kategorie basiert auf vorherigen Antwortzeiten sowie auf früheren fehlgeschlagenen und erfolgreichen Verbindungsversuchen durch den Dispatcher. Bei jedem Versuch wird die Bewertung für die Kategorie des angeforderten URI aktualisiert.

Definieren von Statistikkategorien defining-statistics-categories

Definieren Sie eine Kategorie für jeden Dokumenttyp, für den Sie Statistiken zur Renderer-Auswahl erheben möchten. Der Abschnitt /statistics enthält einen Abschnitt /categories. Wenn Sie eine Kategorie definieren möchten, fügen Sie unter dem Abschnitt /categories eine Zeile mit folgendem Format hinzu:

/name { /glob "pattern"}

Die Kategorie name muss für die Farm eindeutig sein. pattern wird im Abschnitt Entwerfen von Mustern für glob-Eigenschaften beschrieben.

Um die Kategorie eines URI zu ermitteln, vergleicht der Dispatcher den URI so lange mit den einzelnen Kategoriemustern, bis ein Treffer gefunden wird. Der Dispatcher beginnt mit der ersten Kategorie in der Liste und geht diese dann weiter nach unten durch. Platzieren Sie daher Kategorien mit spezifischeren Mustern zuerst.

Beispielsweise werden in der standardmäßigen Datei dispatcher.any eine Kategorie „html“ und eine Kategorie „others“ definiert. Die Kategorie „HTML“ ist die spezifischere und erscheint daher als erste:

/statistics
  {
  /categories
    {
      /html { /glob "*.html" }
      /others  { /glob "*" }
    }
  }

Das folgende Beispiel enthält außerdem eine Kategorie für Suchseiten:

/statistics
  {
  /categories
    {
      /search { /glob "*search.html" }
      /html { /glob "*.html" }
      /others  { /glob "*" }
    }
  }

Widerspiegeln der Server-Nichtverfügbarkeit in Dispatcher-Statistiken reflecting-server-unavailability-in-dispatcher-statistics

Mit der /unavailablePenalty-Eigenschaft wird die Strafzeit (in Zehntelsekunden) für Renderer-Statistiken festgelegt, die beim Fehlschlagen einer Verbindung zu einem Renderer angewendet wird. Der Dispatcher addiert diese Zeit der Statistikkategorie hinzu, die dem angeforderten URI entspricht.

Beispielsweise wird die Strafzeit angewendet, wenn die TCP/IP-Verbindung zum angegebenen Host-Namen/Port nicht hergestellt werden kann. Der Grund dafür ist entweder, dass AEM nicht ausgeführt (und nicht überwacht) wird oder dass ein Netzwerkproblem vorliegt.

Die Eigenschaft /unavailablePenalty ist ein direktes untergeordnetes Element des /farm-Abschnitts (gleichrangig mit dem /statistics-Abschnitt).

Wenn keine Eigenschaft /unavailablePenalty vorhanden ist, wird der Wert "1" verwendet.

/unavailablePenalty "1"

Identifizieren eines „Sticky“-Verbindungsordners – /stickyConnectionsFor identifying-a-sticky-connection-folder-stickyconnectionsfor

Mit der Eigenchaft /stickyConnectionsFor wird ein Ordner definiert, der „Sticky“-Dokumente enthält. Der Zugriff auf diese Eigenschaft erfolgt über die URL. Der Dispatcher sendet alle Anfragen von einer Person, die sich in diesem Ordner befinden, an eine Renderer-Instanz. Mit Sticky-Verbindungen wird sichergestellt, dass Sitzungsdaten für alle Dokumente vorhanden und konsistent sind. Für diesen Mechanismus wird der renderid-Cookie verwendet.

Im folgenden Beispiel wird eine gebundene Verbindung zum /products-Ordner definiert:

/stickyConnectionsFor "/products"

Wenn eine Seite aus Inhalten von mehreren Inhaltsknoten besteht, beziehen Sie die /paths-Eigenschaft ein, die die Pfade zum Inhalt auflistet. Eine Seite kann z. B. Inhalte von /content/image, /content/video und /var/files/pdfs enthalten. Die folgende Konfiguration ermöglicht gebundene Verbindungen für alle Inhalte auf der Seite:

/stickyConnections {
  /paths {
    "/content/image"
    "/content/video"
    "/var/files/pdfs"
  }
}

httpOnly httponly

Wenn Sticky-Verbindungen aktiviert sind, setzt das Dispatcher-Modul das renderid-Cookie. Dieses Cookie verfügt nicht über das Flag httponly, das hinzugefügt werden sollte, um die Sicherheit zu erhöhen. Wenn Sie das Flag httponly hinzufügen möchten, legen Sie die Eigenschaft httpOnly im Knoten /stickyConnections einer Konfigurationsdatei dispatcher.any fest. Der Wert der Eigenschaft (entweder 0 oder 1) definiert, ob dem renderid-Cookie das Attribut HttpOnly angehängt wird. Der Standardwert ist 0. Dies bedeutet, dass das Attribut nicht hinzugefügt wird.

Weitere Informationen über das Flag httponly finden Sie auf dieser Seite.

secure secure

Wenn Sticky-Verbindungen aktiviert sind, setzt das Dispatcher-Modul das renderid-Cookie. Dieses Cookie verfügt nicht über das Flag secure, das hinzugefügt werden sollte, um die Sicherheit zu erhöhen. Wenn Sie das Flag secure hinzufügen möchten, legen Sie die Eigenschaft secure im Knoten /stickyConnections einer Konfigurationsdatei dispatcher.any fest. Der Wert der Eigenschaft (entweder 0 oder 1) definiert, ob dem renderid-Cookie das Attribut secure angehängt wird. Der Standardwert ist 0. Das bedeutet, dass das Attribut hinzugefügt wird, wenn die eingehende Anfrage sicher ist. Wenn der Wert auf 1 gesetzt ist, wird das secure-Flag hinzugefügt, unabhängig davon, ob die eingehende Anfrage sicher ist oder nicht.

Umgang mit Renderer-Verbindungsfehlern handling-render-connection-errors

Konfigurieren Sie das Dispatcher-Verhalten für die Fälle, in denen der Render-Server einen 500-Fehler zurückgibt oder nicht verfügbar ist.

Angeben einer Seite für die Konsistenzprüfung specifying-a-health-check-page

Verwenden Sie die Eigenschaft /health_check, um eine URL anzugeben, die beim Auftreten des Status-Codes 500 geprüft wird. Wenn diese Seite ebenfalls einen Status-Code 500 zurückgibt, wird die Instanz als nicht verfügbar eingestuft. Vor einer Wiederholung wird auf den Renderer dann eine konfigurierbare Strafzeit (/unavailablePenalty) angewendet.

/health_check
  {
  # Page gets contacted when an instance returns a 500
  /url "/health_check.html"
  }

Festlegen der Wiederholungsverzögerung für die Seite specifying-the-page-retry-delay

Die Eigenschaft /retryDelay legt die Zeit (in Sekunden) fest, die der Dispatcher zwischen den einzelnen Runden der Verbindungsherstellung zu den Farm-Renderern abwartet. Die maximale Anzahl der Dispatcher-Verbindungsversuche pro Runde entspricht der Anzahl der Renderer in der Farm.

Der Dispatcher verwendet den Wert "1", wenn /retryDelay nicht explizit definiert ist. Der Standardwert ist in der Regel angemessen.

/retryDelay "1"

Konfigurieren der Wiederholungsanzahl configuring-the-number-of-retries

Mit der /numberOfRetries-Eigenschaft wird die maximale Anzahl der Runden an Verbindungsversuchen festgelegt, die der Dispatcher für die Renderer durchführt. Wenn der Dispatcher nach diesen Wiederholungen keine erfolgreiche Verbindung zu einem Renderer herstellen konnte, gibt er einen Fehler zurück.

Die maximale Anzahl der Dispatcher-Verbindungsversuche pro Runde entspricht der Anzahl der Renderer in der Farm. Die maximale Anzahl der Dispatcher-Verbindungsversuche berechnet sich daher wie folgt: (/numberOfRetries) x (Anzahl der Renderer).

Wenn der Wert nicht explizit definiert ist, ist der Standardwert 5.

/numberOfRetries "5"

Verwenden des Failover-Mechanismus using-the-failover-mechanism

Um Anfragen erneut an andere Renderer zu senden, wenn die ursprüngliche Anfrage fehlschlägt, aktivieren Sie den Failover-Mechanismus in Ihrer Dispatcher-Farm. Wenn das Failover aktiviert ist, weist der Dispatcher folgendes Verhalten auf:

Um das Failover zu aktivieren, fügen Sie der Farm (oder Website) folgende Zeile hinzu:

/failover "1"

Ignorieren von Netzwerkunterbrechungsfehlern – /ignoreEINTR ignoring-interruption-errors-ignoreeintr

Jeder dateisystemorientierte Systemaufruf kann mit EINTR unterbrochen werden, wenn sich das Objekt des Systemaufrufs auf einem Remote-System befindet, auf das über NFS zugegriffen wird. Ob diese Systemaufrufe ein Zeitlimit überschreiten oder unterbrochen werden können, richtet sich danach, wie das zugrunde liegende Dateisystem auf dem lokalen Computer bereitgestellt wurde.

Verwenden Sie den Parameter /ignoreEINTR, wenn Ihre Instanz eine solche Konfiguration aufweist und das Protokoll folgende Meldung enthält:

Error while reading response: Interrupted system call

Intern liest der Dispatcher die Antwort vom Remote-Server (z. B. AEM) mit einer Schleife, die sich wie folgt darstellen lässt:

while (response not finished) {
read more data
}

Solche Meldungen können generiert werden, wenn EINTR im Abschnitt read more data vorkommt. Ursache ist der Empfang eines Signals vor dem Empfang von Daten.

Um diese Unterbrechungen zu ignorieren, können Sie die folgenden Parameter zu dispatcher.any hinzufügen (vor /farms):

/ignoreEINTR "1"

Durch das Festlegen von /ignoreEINTR auf "1" liest der Dispatcher so lange weiter Daten, bis die vollständige Antwort erfasst wurde. Der Standardwert ist 0 und deaktiviert die Option.

Entwerfen von Mustern für Glob-Eigenschaften designing-patterns-for-glob-properties

In einigen Abschnitten in der Dispatcher-Konfigurationsdatei können glob-Eigenschaften als Auswahlkriterien für Client-Anfragen verwendet werden. Die Werte der glob-Eigenschaften sind Muster, die der Dispatcher mit einem Aspekt der Anfrage abgleicht, beispielsweise dem Pfad der angeforderten Ressource oder der IP-Adresse des Clients. Die Elemente im Abschnitt /filter verwenden etwa glob-Muster, um die Pfade der Seiten zu identifizieren, mit denen der Dispatcher interagiert oder die der Dispatcher zurückweist.

Die glob-Werte können Platzhalterzeichen und alphanumerische Zeichen enthalten, um das Muster zu definieren.

Protokollierung logging

In der Webserver-Konfiguration können Sie Folgendes festlegen:

Weitere Informationen finden Sie in der Dokumentation zum Webserver und in der Readme-Datei Ihrer Dispatcher-Instanz.

Rotierende oder wechselnde Protokolle in Apache

Wenn Sie einen Apache-Webserver verwenden, können Sie die Standardfunktionen für rotierende und/oder wechselnde Protokolle verwenden. Beispiel für die Verwendung wechselnder Protokolle:

DispatcherLog "| /usr/apache/bin/rotatelogs logs/dispatcher.log%Y%m%d 604800"

Diese Funktionalität rotiert Folgendes automatisch:

Weitere Informationen zu rotierenden und wechselnden Protokollen finden Sie in der Dokumentation zum Apache-Webserver. z. B. Apache 2.4.

Ablaufprotokollierung trace-logging

Neben weiteren Verbesserungen beim Dispatcher wurde mit der Version 4.2.0 auch die Ablaufprotokollierung eingeführt.

Diese Funktion entspricht einer höheren Ebene als die Debug-Protokollierungsebene, bei der zusätzliche Informationen in den Protokollen angezeigt werden. Folgende Informationen werden protokolliert:

Sie können die Ablaufprotokollierung aktivieren, indem Sie die Protokollierungsebene in Ihrem Webserver auf 4 festlegen.

Nachfolgend finden Sie ein Beispiel für Protokolle mit aktivierter Ablaufverfolgung:

[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[Host] = "localhost:8443"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[User-Agent] = "curl/7.43.0"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[Accept] = "*/*"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-SSL-Client-Cert] = "(null)"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[Via] = "1.1 localhost:8443 (dispatcher)"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-For] = "::1"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-SSL] = "on"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-SSL-Cipher] = "DHE-RSA-AES256-SHA"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-SSL-Session-ID] = "ba931f5e4925c2dde572d766fdd436375e15a0fd24577b91f4a4d51232a934ae"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-Port] = "8443"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[Server-Agent] = "Communique-Dispatcher"

Außerdem wird ein Ereignis protokolliert, wenn eine Datei angefordert wird, die einer Blockierungsregel entspricht:

[Thu Mar 03 14:42:45 2016] [T] [11831] 'GET /content.infinity.json HTTP/1.1' was blocked because of /0082

Bestätigen der normalen Funktionsweise confirming-basic-operation

Um die normale Funktionsweise und Interaktion des Webservers, des Dispatchers und der AEM-Instanz zu prüfen, können Sie folgende Schritte ausführen:

Verwenden mehrerer Dispatcher using-multiple-dispatchers

In komplexen Umgebungen können Sie mehrere Dispatcher verwenden. Folgende Szenarien sind möglich:

In einem solchen Fall müssen Sie sicherstellen, dass jede Anfrage nur einen Dispatcher durchläuft. Ein Dispatcher verarbeitet keine Anfragen, die von einem anderen Dispatcher stammen. Stellen Sie daher sicher, dass beide Dispatcher direkt auf die AEM-Website zugreifen.

Debugging debugging

Beim Hinzufügen des Headers X-Dispatcher-Info zu einer Anfrage antwortet der Dispatcher, ob das Ziel zwischengespeichert oder aus dem Cache zurückgegeben wurde bzw. überhaupt nicht zwischenspeicherbar war. Der Antwortheader X-Cache-Info enthält diese Informationen in lesbarer Form. Mithilfe dieser Antwortheader können Sie Probleme mit vom Dispatcher zwischengespeicherten Antworten beheben.

Diese Funktionalität ist standardmäßig nicht aktiviert. Daher muss die Farm den folgenden Eintrag enthalten, damit der Antwort-Header X-Cache-Info eingebunden werden kann:

/info "1"

z. B.:

/farm
{
    /mywebsite
    {
        # Include X-Cache-Info response header if X-Dispatcher-Info is in request header
        /info "1"
    }
}

Auch der X-Dispatcher-Info-Header benötigt keinen Wert, aber wenn Sie curl zum Testen verwenden, müssen Sie einen Wert angeben, um den Header zu senden, z. B.:

curl -v -H "X-Dispatcher-Info: true" https://localhost/content/wknd/us/en.html

Nachfolgend finden Sie eine Liste mit den Antwort-Headern, die von X-Dispatcher-Info zurückgegeben werden: