Solr in TYPO3 einrichten

Solr in Ihre TYPO3-Installation zu integrieren funktioniert ganz einfach. Wie? Hier kommt der richtige Weg:

Verwendete Software: TYPO3 8.7, Solr 6.6, Solr Extension 8

Schritt 1

Zum Start brauchen Sie zwei Informationen:

  1. Welche TYPO3-Version nutzen Sie? Ein Blick in den Softwaremanager verrät es Ihnen. Öffnen Sie dazu in Ihrer Accountverwaltung unter Ihrem P-Account den Punkt Tools --> Softwaremanager.

Oder Sie schauen einfach direkt in Ihr Typo3-Backend:

2. Welche Solr-Version ist für Sie im Einsatz? Öffnen Sie in Ihrer Accountverwaltung die Leistungsübersicht – mit einem Klick auf Ihre Solr-Instanz. Dort sehen Sie Ihre aktuelle Version.

Schritt 2

Nun wählen Sie die zu Ihrer TYPO3- und Solr--Version passende Extension (EXT: solr) aus. Werfen Sie dazu einen Blick in die Version Matrix von TYPO3:

Welche Solr-Extension Sie nutzen, hängt von Ihrem Wunsch nach Aktualität ab. Für diese Anleitung entscheiden wir uns für die Extension 8.0.

Ein Tipp

Sie finden in der Version Matrix keine passende Extension? Dann brauchen Sie ein Update Ihrer Solr-Version.

Schritt 3

Nun benötigen Sie einen Kern mit der passenden Konfigurationsvorlage. Öffnen Sie dazu in Ihrer Accountverwaltung unter Ihrer Solr-Instanz „Solr …“ den Punkt „Kern hinzufügen“.

Geben Sie den Namen und bei Bedarf auch eine Notiz für Ihren Solr-Kern ein. Wählen Sie dann Ihre Konfigurationsvorlage und Sprache aus – passend zu Ihrer Webseite. Nun noch den Arbeitsspeicher passend zu den Inhalten Ihrer Webseite eingeben und dann Ihren neuen Kern mit einem Klick auf „speichern“ anlegen.

Hier ein paar Tipps:

  • Notiz: Tragen Sie zum Beispiel den p-Account ein, für den Sie den Solr-Kern nutzen möchten.
  • Konfigurationsvorlage: Ihre gewünschte Vorlage erscheint nicht im Dropdown-Feld? Dann gehen Sie noch einmal zurück zu Schritt 1 – haben Sie dort die richtige Solr-Version ausgewählt?
  • Sprache: Für eine mehrsprachige Webseite empfehlen wir Ihnen jeweils einen eigenen Kern pro Sprache. Übrigens: Nutzen Sie gerne pro Webseite mindestens einen Kern.

Schritt 4

Im nächsten Schritt binden Sie die Solr-Extension in Ihr TYPO3 ein. Und das geht so:

  • Öffnen Sie in Ihrem TYPO3 Backend unter „Adminwerkzeuge“ den Punkt „Erweiterungen“.
  • Wählen Sie oben im Dropdown-Feld „Erweiterungen hinzufügen“ aus und suchen Sie über das Textfeld Ihre Solr-Extension „Apache Solr for TYPO3“.
  • Installieren Sie die Extension mit einem Klick auf das Wolken-Symbol.
  • Wenn alles funktioniert hat, sehen Sie im Menü Ihres TYPO3 Backend den Punkt “APACHE SOLR“.

Ein Tipp

Sie erhalten bei der Installation die Frage, ob die Abhängigkeiten zu „Scheduler“ aufgelöst werden sollen? Bestätigen Sie dies!

Schritt 5

Konfigurieren Sie nun Ihre TYPO3-Seite für Solr. Klicken Sie dazu unter „APACHE SOLR“ auf „Info“ und dann auf die oberste Root-Page (Weltkugel) in Ihrem Verzeichnis. Dort sehen Sie, welche Konfigurationen nötig sind.

Schritt 6

Führen Sie nun die einzelnen Konfigurationen durch. In unserem Beispiel sind es diese:

Domain Record erstellen

Gehen Sie über „Liste“ --> „Root Page“ (Weltkugel) und klicken Sie oben auf das Plus-Symbol „Neuen Datensatz erstellen“. Tragen Sie dann unter „Systemdatensätze“ --> „Domäne“ Ihre Domain ein und bestätigen Sie diese mit einem Klick auf „Speichern

Root Page

Legen Sie Ihre Webseite in Typo3 als „Root Page“ (Weltkugel) an. Klicken Sie dazu auf „Liste“ und dann mit der rechten Maustaste auf Ihre Webseite. Weiter geht es mit „Bearbeiten“ --> „Verhalten“. Nun setzen Sie einfach unter „Sonstige“ einen Haken bei „Als Anfang der Webseite nutzen“ und bestätigen dies mit „Speichern“. Das war‘s. 

Typoskript konfigurieren

Ihre Solr-Extension muss wissen, zu welchem Host sie eine Verbindung aufbauen soll.

  • Öffnen Sie dazu Ihre Template-Werkzeuge über „Template“ --> „Root Page“ --> „vollständigen Template-Datensatz bearbeiten“.
  • Fügen Sie unter dem Reiter „Allgemein“ folgenden Code zu Ihren „Konstanten“ hinzu:

plugin.tx_solr {
     solr {
        scheme = https
        host = solr1234:MEIN-PASSWORT@solr1234.solr-hosting.info
        port = 443
        path = /blog/
    }
}

Hierzu drei wichtige Punkte:

  1. Tragen Sie in der Zeile „host“ bitte Ihren Host und Ihr Passwort statt „solr1234:MEIN-PASSWORT@solr1234” ein. Nur so weiß die Solr-Extension mit welchem Host sie verbinden soll.
  2. Verzichten Sie bei Ihrem Passwort auf folgende Sonderzeichen „#, ?, $, @“.
  3. Geben Sie in der Zeile „path“ den Namen Ihres Solr-Kerns ein.
  4. Bei Setup fügen wir dann noch folgenden Code hinzu:

page.config.index_enable = 1
  • Öffnen Sie dann den Reiter „Enthält“ und klicken Sie in der Liste „Verfügbare Objekte“ auf den Punkt „Search – Base Configuration (solr)“. Damit erweitern Sie Ihr Template um das statische Template Ihrer Solr-Extension.
  • Mit einem Klick auf „Speichern“ bestätigen Sie Ihre beiden neuen Konfigurationen.

Schritt 7

Klappt die Verbindung zu Ihrer Solr-Instanz mit den neuen Konstanten? Hier ein Test:

  • Klicken Sie auf den „Blitz“ plus „Initialize Solr connections“. Im Hintergrund baut sich dann die Verbindung auf.

War die Verbindung erfolgreich? Ein Klick auf „APACHE SOLR“ --> „Info“ gibt Ihnen die Antwort. Sie lautet „Ja“, wenn Sie dort das sehen:

War die Verbindung nicht erfolgreich? Dann sehen Sie den Fehler in Ihren Statusberichten. Öffnen Sie dazu in Ihrem TYPO3-Menü den Punkt „Berichte“ --> "Statusberichte".

Schritt 8

Nun geht es zum Indexieren Ihres Webseiten-Inhalts.

  • Öffnen Sie in Ihrem Menü den Punkt „Index Queue“ und fügen Sie den Inhalt hinzu: Häkchen an „Alle umschalten“ und Klick auf „Queue Selected Content for Indexing“.
  • Starten Sie die Indexierung dann mit einem Klick auf „Index now“ im nächsten Fenster.

Alternativ über „Scheduler“

Sie möchten Ihre Webseite gerne über „Scheduler“ indexieren? Dazu liefert die Solr-Extension den Job „Index Queue Worker“. Und so geht es:

  • Wählen Sie den Job „Index Queue Worker“ unter „Klasse“ aus.
  • Wählen Sie als Typ „wiederkehrend“.
  • Geben Sie eine Startzeit ein.
  • Definieren Sie sich unter „Häufigkeit“ das Intervall der Laufzeit – zum Beispiel alle 3.600 Sekunden.
  • Wählen Sie als Webseite Ihre „Root Page“ aus.
  • Legen Sie nun noch fest, wie viele Dokumente pro Durchlauf Sie indexieren möchten.
  • Mit einem Klick auf „Speichern“ lassen Sie Scheduler den neuen Job erledigen.

Schritt 9

In einem letzten Schritt integrieren Sie die Suche in Ihre Webseite.

  • Öffnen Sie in Ihrem TYPO3-Menü den Punkt „Seite“ und klicken Sie auf das „Plus-Symbol“.
  • Ziehen Sie nun eine Standardseite (leeres Blatt) in die gleiche Ebene wie „Home“ und geben Sie ihr einen Namen – zum Beispiel „Suche“.
  • Fügen Sie das Inhaltselement "Search" hinzu: "Suche" --> "Inhalt" --> "Plug-Ins" --> "Search" --> "Speichern".
  • Damit Ihre Suche sichtbar wird, klicken Sie mit der rechten Maustaste noch einmal auf "Suche" und dann auf "Aktivieren".
  • Jetzt noch den Cache leeren mit einem Klick auf das Blitz-Symbol – fertig.

    Sehen Sie die Suche nun auf Ihrer Webseite? Wunderbar, dann hat alles klappt.

Ergebnisse:

Ein Tipp

Sollten Sie auf der Ergebnis Seite keinen Content angezeigt bekommen stellen Sie sicher, dass die TYPO3SEARCH subparts gesetzt sind.
Wenn dies nicht der Fall ist müssen Diese im Template gesetzt werden.

<!--TYPO3SEARCH_begin-->
Content-Div
<!--TYPO3SEARCH_end-->

War diese Antwort hilfreich?