Installation

Voraussetzungen

Für die Installation einer Publikation benötigen Sie einen Account im oliwol Publisher Tool. Außerdem sollten Sie über die technischen Möglichkeiten verfügen, eine Domain einzurichten und die DNS-Konfiguration anzupassen.

Domain einrichten

Unabhängig für welche Integration Sie sich entscheiden (DNS, Iframe oder Script), wird für jede Publikation eine (Sub-)Domain benötigt, die auf das oliwol Publisher Tool zeigt.

Zu Testzwecken können Sie zusätzlich eine Staging-Domain einrichten und diese ebenfalls auf die entsprechende IP zeigen lassen.

SSL-Zertifikat

Für jede Domain ist ein SSL-Zertifikat zwingend erforderlich. Zur Übermittlung des jeweiligen Zertifikats sowie des Keys setzen Sie sich bitte mit Ihrem/Ihrer persönlichen Ansprechpartner:in in Verbindung.

Reverse-Proxy

Sollte Ihre Domain über einen Reverse Proxy laufen, wie bspw. Cloudflare, kontaktieren Sie bitte den Support.

Publikation erstellen

Wählen Sie im Dashboard zunächst "Publikation erstellen". Vergeben Sie im Formular einen Namen für Ihre Publikation, wählen Sie ein Spiel aus und tragen Sie die Domain ein, unter der Ihre Publikation später erreichbar sein soll.

Publikation erstellen

Zum Erstellen einer Publikation ist es nicht erforderlich, dass Ihre Domain bereits eingerichtet ist. Für die Installation der Rätsel und den produktiven Einsatz ist jedoch eine erfolgreiche DNS-Überprüfung Voraussetzung. Die Überprüfung können Sie im Nachgang jederzeit anstoßen.

DNS-Konfiguration überprüfen

Nachdem Ihre Domain angelegt und die Überprüfung der DNS-Konfiguration erfolgreich war, können Sie Ihre Publikation einrichten. Hierzu bearbeiten Sie die gewünschte Publikation und wählen unter Layout ein Icon im PNG-Format aus und vergeben einen Kurznamen für Ihre Publikation im Bereich "App", der im Web App Manifest ausgegeben wird. Damit ist das Minimal-Setup abgeschlossen und Sie können die Publikation speichern.

Rätsel installieren

Im nächsten Schritt werden die Rätsel Ihrer Publikation installiert.

Rätsel installieren

Die Installation der Rätsel kann einige Minuten in Anspruch nehmen. Sie werden informiert, sobald die Installation abgeschlossen ist.

Rätsel werden installiert

Nach erfolgreicher Installation wird Ihre Publikation veröffentlicht. Wenn sowohl die Installation als auch die Veröffentlichung abgeschlossen sind, können Sie Ihre Publikation unter der eingerichteten Domain aufrufen.

Integration

Sie können Ihre Publikation auf drei Arten integrieren: DNS, Iframe oder als Script. Nachfolgend werden die drei Möglichkeiten kurz erläutert, wobei die Integration via DNS die Standardmethode ist.

DNS

Bei der Integration via DNS wird Ihre Publikation über die verknüpfte Domain ausgespielt. Da es sich um eine eigenständige Seite handelt, empfiehlt es sich weitere Anpassungen vorzunehmen. Laden Sie Ihr Logo als SVG-Format hoch und wählen Sie Ihre Markenfarbe aus.

Aus datenschutzrelevanten Gründen sollte neben dem Impressum und den Datenschutzrichtlinien auch eine Consent Management Plattform angebunden werden.

Der entscheidende Vorteil dieser Integration ist das Erlebnis für Ihre Nutzer:innen. Es steht einzig das Spiel im Vordergrund - ohne zu scrollen oder anderweitig abgelenkt zu werden. Ihre Publikation ist auch offline oder bei sehr schlechtem Netz jederzeit erreichbar. Zusätzlich können alle Werbeplätze um das Spiel herum bestückt werden.

Iframe & Script

Wenn Sie Ihre Publikation in eine bereits bestehende Seite integrieren möchten, können Sie dies via Script oder Iframe tun. Um den Code abzurufen, navigieren Sie zur Detail-Seite Ihrer Publikation.

Publikation integrieren

Auf der Detail-Seite können Sie den Integrations-Code in die Zwischenablage kopieren und auf Ihrer Seite an die gewünschte Stelle einfügen.

Integrationscode für Iframes

Sie können die Breite und den CSS-Code des Iframes auf Ihre Bedürfnisse anpassen. Die Höhe wird über ein postMessage-Event gesteuert und passt sich an den Inhalt Ihrer Publikation an.

Die Integration via Script funktioniert auf dieselbe Art. Auch hierbei können Breite und CSS angepasst werden. Die Script-Variante ist speziell bei der Nutzung von Javascript-Frameworks, wie React oder VUE, eine empfohlene Alternative.

Debugging

Wenn Sie eine Publikation erstellen, ist der Debug-Modus aktiviert. Dies ist für Testzwecke sinnvoll, da im Debug-Modus keine Service-Worker aktiv sind und Ihre Publikation sich nicht aus dem Cache bedient. Sollten Fehler auftreten, werden diese innerhalb der Applikation und in der Konsole ausgegeben. Wenn Sie Ihre Publikation live stellen, wird der Debug-Modus deaktiviert. Fehlermeldungen sind für Ihre Nutzer:innen nicht mehr sichtbar.

Debug-Modus

Solange Sie noch Anpassungen an Ihrer Publikation vornehmen, sollte der Debug-Modus aktiv bleiben. Insbesondere wenn Sie auf einer Staging-Umgebung arbeiten, die nur über eine Authentifizierung erreichbar ist, könnte dies ohne Debug-Modus zu Problemen führen. Der Service-Worker wäre für Ihren Browser nicht erreichbar, wodurch Änderungen an Ihrer Publikation nicht registriert werden würden.

Produktiv setzen

Sobald die Einrichtung Ihrer Publikation abgeschlossen ist und die Rätsel installiert sind, können Sie die Applikation produktiv setzen. Diese Aufgabe nimmt rund zwei bis drei Minuten in Anspruch. Im Anschluss ist Ihre Publikation online und kann mit Ihren Leser:innen geteilt werden.

Produktiv setzen

Sobald Sie Ihre Publikation produktiv setzen, hat dies folgende Effekte:

  • Es werden keine Fehlermeldungen in der Applikation und der Konsole ausgegeben.
  • Der Service-Worker ist aktiviert, was bedeutet, dass die Publikation auch im Offline-Modus verwendet werden kann und alle Assets und Daten im Browser des Clients gespeichert werden.
  • Das Caching ist aktiviert, wodurch die Publikation schneller geladen wird.

Updates

Publikationen können jederzeit aktualisiert werden. Sobald Sie Änderungen vorgenommen haben und diese speichern, wird eine neue Version erstellt, die innerhalb weniger Minuten automatisch publiziert wird. Sie werden informiert, sobald Ihre Aktualisierungen online sind.

Beim Hinzufügen oder ändern von FAQs wird ebenfalls eine neue Version erstellt oder wenn Sie Anpassungen an einer verknüpften SSO vornehmen.