Einrichtung ​

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.

Publikation erstellen ​

Wählen Sie im Dashboard zunächst "Publikation erstellen". Vergeben Sie im Formular einen Namen für Ihre Publikation und wählen Sie ein Spiel, beispielsweise Sudoku, aus. Optional können Sie bereits die Domain eintragen, unter der Ihre Publikation später erreichbar sein soll.

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

Sobald Sie eine Publikation anlegen, wird automatisch eine Testumgebung (Stage) eingerichtet. Unter dieser können Sie Ihre Publikation aufrufen. Bevor Sie diese für Ihre Nutzer:innen frei zugänglich machen, können Sie Ihre Systeme anbinden und alle Änderungen testen.

Zu Beginn befindet sich Ihre Publikation im Offline-Modus. Über ein Deployment können Sie in die Entwicklungsumgebung (Dev) wechseln. Hierfür ist es erforderlich, dass Sie die Installation der Rätsel abgeschlossen haben.

Rätsel installieren ​

Bevor Sie die täglichen Rätsel für Ihr Spiel installieren, sollten Sie die Spiel-Einstellungen überprüfen. Sobald die Rätsel installiert sind, lassen sich einige Einstellungen, beispielsweise das Punktesystem eines Spiels, im laufenden Betrieb nicht mehr anpassen. Im Offline-Modus (Maintenance) lassen sich alle Einstellungen anpassen und eine Neuinstallation der Rätsel anstoßen.

Nachdem Sie die Konfiguration überprüft haben, können Sie mit der Installation der Rätsel beginnen.

Die Installation kann einige Minuten in Anspruch nehmen. Sie werden benachrichtigt, sobald diese abgeschlossen ist.

Nach erfolgreicher Installation können Sie erstmals ein Deployment durchführen. Wenn sowohl die Installation als auch das Deployment abgeschlossen sind, können Sie Ihre Publikation unter der eingerichteten Testumgebung aufrufen.

Deployment ​

Deployments begleiten Sie auf dem Weg vom Offline-Modus (Offline) bis hin zum produktiven Einsatz (Produktiv) Ihrer Publikation. Dieser Weg beinhaltet 5 Entwicklungsstufen:

• Offline
• Dev
• Stage
• Nicht synchronisiert
• Produktiv

Für die Stufen Dev, Stage und Produktiv sind jeweils Deployments notwendig. Jede Entwicklungsstufe hat Auswirkungen auf Ihre Publikation. Um ein Deployment durchzuführen, müssen gewisse Voraussetzungen erfüllt werden.

Bevor Sie ein Deployment starten, werden Ihnen die Voraussetzungen und, ob Sie diese erfüllen, angezeigt. Daneben sehen Sie die Auswirkungen, die das jeweilige Deployment mit sich bringt.

Nachfolgend werden die Entwicklungsstufen vorgestellt.

Offline ​

Eine neu erstellte Publikation befindet sich zu Beginn im Offline-Modus. Die Publikation ist nicht aufrufbar. Die Testumgebung liefert einen 403 Status-Code zurück.

Dev ​

Sobald sich die Publikation im Dev-Modus befindet, können Sie diese unter der Testumgebung aufrufen. Die Testumgebung ist über eine HTTP-Authentifizierung geschützt. Verwenden Sie hierfür die Zugangsdaten Ihres oliwol Publisher Tool-Accounts.

Voraussetzungen für ein Deployment

• Gültiger DNS-Eintrag für die Domain der Testumgebung
• Rätsel sind installiert
• Es findet keine Publizierung statt
• Ihre Publikation ist offline

Im Dev-Modus sind keine Caches und kein Service-Worker aktiv. Innerhalb der Konsole der Browser-DevTools F12 werden Debug-Meldungen ausgegeben. Darunter auch die aktuellen Daten Ihrer Publikation. Dieser Modus eignet sich vor allem für den Aufbau einer Publikation (Layout, Inhalte, Anbindung der SSO und Paywall, etc.).

Stage ​

Der Stage-Modus simuliert die produktive Umgebung. Sobald Sie Änderungen an Ihrer Publikation vornehmen, können Sie diese auf der Testumgebung unter Produktivbedingungen überprüfen. Im Stage-Modus ist der Service-Worker aktiv, wodurch sämtliche Assets und Rätsel im Browser abgespeichert werden.

Voraussetzungen für ein Deployment

• Gültiger DNS-Eintrag für die Domain der Testumgebung
• Rätsel sind installiert
• Es findet keine Publizierung statt
• Ihre Publikation befindet sich im Dev-Modus

Genau wie der Dev-Modus ist der Stage-Modus über eine HTTP-Authentifizierung gesichert.

Publikationen können jederzeit aktualisiert werden. Nachdem Sie Änderungen vorgenommen und gespeichert haben, wird eine neue Version erstellt, die innerhalb weniger Minuten auf Ihrer Testumgebung automatisch publiziert wird. Sie werden informiert, sobald die neue Version publiziert ist.

Beim Hinzufügen oder Ändern von FAQs sowie einer verknüpften SSO wird ebenfalls eine neue Version erstellt.

Nicht synchronisiert ​

Sobald Ihre Publikation sich im Livebetrieb befindet, werden künftige Änderungen zunächst automatisiert auf der Testumgebung publiziert. Dadurch sind der Livebetrieb (Produktiv) und die Testumgebung (Stage) nicht synchron. Um beide Umgebungen zu synchronisieren und Ihre Änderungen produktiv zu stellen, müssen Sie ein erneutes Deployment durchführen.

Produktiv ​

Ihre Publikation ist online (Livebetrieb) und somit für jede Person frei zugänglich - auch offline.

Voraussetzungen für ein Deployment

• Gültiger DNS-Eintrag für die eingetragene Domain
• Rätsel sind installiert
• Es findet keine Publizierung statt
• Ihre Publikation befindet sich im Stage-Modus bzw. ist nicht synchronisiert
• Sie haben mindestens 1 freies Kontingent an Publikationen

Rollback ​

Sie haben jederzeit die Möglichkeit, ein Deployment rückgängig zu machen. Um eine Publikation offline zu nehmen, müssen Sie, wie bei einem Deployment, jede Umgebung nacheinander zurückrollen. Sie können eine produktive Umgebung nicht direkt in den Offline-Modus versetzen. Ein Rollback ist dann sinnvoll, wenn Sie Ihre Publikation generell deaktivieren möchten oder Sie die Spiel-Konfiguration anpassen wollen.

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.

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.

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.

DNS-Konfiguration ​

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.

Die Domain können Sie beim Anlegen einer Publikation hinterlegen oder später beim Bearbeiten. Sobald Sie Ihre Publikation produktiv stellen möchten, ist die Angabe einer Domain erforderlich. Das System prüft, ob die DNS-Konfiguration korrekt hinterlegt ist. Sollte die Prüfung nicht erfolgreich sein, können Sie diese im Nachgang manuell anstoßen.

Produktive Domain ​

Für den produktiven Einsatz ist ein A-Record in Ihren DNS-Einstellungen erforderlich.

Tauschen Sie sudoku.example.com mit Ihrer Domain aus. Sobald der A-Record eingerichtet ist, können Sie die DNS-Überprüfung starten.

Eigene Testdomain ​

Beim Anlegen einer Publikation wird automatisch eine Domain für Sie angelegt, die Sie als Testumgebung nutzen können. Die Testumgebung können Sie in der Übersicht Ihrer Publikationen in der Spalte Domain aufrufen. Hierbei handelt es sich um eine Subdomain, die unter der Domain des oliwol Publisher Tools läuft.

Sie haben alternativ die Möglichkeit eine eigene Subdomain zu hinterlegen, die als Testumgebung genutzt werden soll. Diese können Sie in der Bearbeitungsmaske Ihrer Publikation anlegen. Hierfür ist es erforderlich zunächst eine Domain zu hinterlegen, unter der Ihre Publikation später erreichbar sein soll. Eine erfolgreiche DNS-Konfiguration ist hierfür nicht notwendig.

Für die Einrichtung einer eigenen Stage-Domain muss die nachfolgende DNS-Konfiguration angelegt werden.

Nachdem Sie Ihre eigene Domain für die Stage-Umgebung hinterlegt haben, prüft das System die DNS-Konfiguration. Bei erfolgreicher Überprüfung können Sie die Testumgebung Ihrer Publikation unter Ihrer eigenen Domain aufrufen. Sie haben alternativ die Möglichkeit die Überprüfung der DNS-Konfiguration im Nachgang manuell anzustoßen.

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.