Umgebungen: entwickeln, testen, übertragen
Getrennte Stände Ihrer Inhalte für Entwicklung, Test und Produktion anlegen, zwischen ihnen wechseln, Umgebungen klonen und Änderungen gezielt in die Produktion übertragen.
Worum es geht
Eine Umgebung ist ein vollständig getrennter Stand Ihrer Inhalte. Typisch sind zwei: Produktion für die Live-Website und eine Entwicklungs- oder Test-Umgebung, in der neue Felder, Seiten und Inhalte entstehen, ohne dass Besucher etwas davon sehen. Ist alles geprüft, übertragen Sie die Änderungen gezielt in die Produktion.
Jede Umgebung hat eigene Collections und Einträge, Seiten, Layouts, Menüs, Themes, Blöcke, Formulare, Weiterleitungen und Analytics-Einstellungen. Medien gehören ebenfalls zu einer Umgebung; zusätzlich gibt es Medien, die allen Umgebungen gemeinsam gehören.
Jede Organisation hat mindestens die Standard-Umgebung Produktion (Key prod). Solange Sie keine weitere anlegen, müssen Sie sich um Umgebungen nicht kümmern.
Voraussetzungen
- Umgebungen anlegen, klonen, übertragen und löschen: Recht Einstellungen verwalten.
- Zwischen Umgebungen wechseln kann jede Person mit Zugang zu Sites.
Hinweis: Zeigt eine gehostete Website eine Umgebung, stellen Sie sie um, ohne die Domain zu ändern: Umgebung der Website umstellen und zurück.
Zwischen Umgebungen wechseln
Oben in der Seitenleiste steht Umgebung. Wählen Sie dort die gewünschte Umgebung. Ab sofort zeigt und ändert Sites nur deren Inhalte; die Standard-Umgebung ist mit Standard markiert. Eine Farbe je Umgebung hilft, nicht versehentlich in der Produktion zu arbeiten.
Tipp: Geben Sie der Produktion eine auffällige Farbe (z.B. Rot) und der Test-Umgebung eine ruhige (z.B. Blau). So sehen Sie auf einen Blick, wo Sie gerade arbeiten.
Die Übersicht der Umgebungen
Öffnen Sie Umgebungen (auch unter Einstellungen). Die Tabelle zeigt Name, Key, Standard, Vorschau (ob eine Vorschau-URL hinterlegt ist), die Zahl der Einträge und Tokens sowie die Aktionen Als Standard, Klonen, Bearbeiten (Stift) und Löschen (Papierkorb). Darunter listet Letzte Operationen die zuletzt ausgeführten Klon- und Übertragungsvorgänge mit Status.
Eine Umgebung anlegen
Wie viele Umgebungen Sie anlegen dürfen, bestimmt Ihr Abo. Ist das Kontingent voll, brauchen Sie einen Zusatz, siehe Kontingente und Zusatz-Pakete. Die verwaltete Umgebung für Hike zählt nicht mit.
Am einfachsten klonen Sie eine bestehende Umgebung – dann ist die Struktur gleich:
- Klicken Sie bei der Quelle (meist Produktion) auf Klonen.
- Tragen Sie Name (z.B. „Staging“) und Key (z.B.
staging; nur Kleinbuchstaben, Zahlen und Bindestriche) ein und wählen Sie eine Farbe. - Wählen Sie, was mitkommt. Immer kopiert werden die Collections mit ihren Feldern, die Feldgruppen, die eigenen Blöcke, die Layouts und die Komponenten (mit veröffentlichtem Stand und Entwurf), dazu optional:
- Inhalte (Einträge) mitklonen
- Seiten & Menüs mitklonen
- Themes mitklonen
- Klicken Sie auf Klonen starten. Danach zeigt Ergebnis, was kopiert wurde, und Warnungen nennen, was übersprungen wurde.
Alternativ legen Sie mit Umgebung erstellen eine neue Umgebung an (Name, Key). Sie startet nicht leer, sondern mit der Ausstattung (nächster Abschnitt).
Die Ausstattung einer neuen Umgebung
Im Builder stehen in jeder Umgebung immer alle Bausteine und Komponenten der Bibliothek bereit, auch in einer leeren. Beim ersten Einsetzen legt Scorebase den gewählten Baustein in der Umgebung an; Sie müssen nichts vorher übernehmen. Die Ausstattung ist der Weg, alles vorab anzulegen.
Im Dialog Neue Umgebung gibt es den Bereich Ausstattung. Er legt in der neuen Umgebung an, was Sie zum Gestalten brauchen, bevor die erste Seite entsteht. Nötig ist das nicht.
Code-Blöcke sind die fertigen Blöcke der Bibliothek, gruppiert nach dem, wofür sie da sind (Einstieg, Preise, Fragen, Formulare, Shop, Ticketing und so weiter):
- Allgemeine Blöcke sind immer dabei.
- Zu jeder abonnierten App kommt eine eigene Gruppe: Shop, Termine und Buchung, Ticketing oder Gastro. Sie schalten die Gruppe an oder ab. Apps ohne Abo erscheinen nicht, und der Server lehnt sie auch dann ab, wenn jemand sie von Hand nennt.
- Ihnen muss das Recht zustehen, Blöcke zu verwalten, sonst ist der Abschnitt gesperrt und sagt es.
Bibliotheks-Komponenten sind die fertigen Komponenten aus der Bibliothek. Sie wählen Alle, Nach Kategorie (Kategorien ankreuzen) oder Keine. Dafür braucht es das Recht, Komponenten und Layouts zu verwalten. Die Komponenten bekommen die Theme-Werte Ihrer Umgebung. Fehlt für eine Komponente eine passende Rolle, wird sie übersprungen und lässt sich später einzeln übernehmen.
Eine Zeile unter der Auswahl nennt die Summe, zum Beispiel „84 Code-Blöcke und 2 Komponenten werden angelegt“. Mit Später jederzeit ergänzbar ist gemeint: Nichts davon ist endgültig. Alles lässt sich nachrüsten, und im Builder steht es ohnehin bereit.
Nach dem Anlegen läuft die Ausstattung in kleinen Schritten, und der Dialog zeigt den Fortschritt als x von y. Lassen Sie das Fenster offen, bis „Die Umgebung ist ausgestattet“ erscheint. Ein zweiter Lauf legt nichts doppelt an, und was Sie gelöscht haben, kommt nicht zurück.
Hinweis: Die Hike-Umgebung wird von der Hike-App verwaltet und bekommt keine Ausstattung. Im Builder stehen dort trotzdem alle Bausteine und Komponenten bereit, und beim Einsetzen werden sie angelegt wie in jeder anderen Umgebung.
Nachrüsten und Unvollständiges nachholen
- Nach einem neuen Abo: Wird eine App aktiv (zum Beispiel Ticketing), zeigt die Übersicht der Umgebungen den Hinweis „… ist neu aktiv“ oder „Neue Code-Blöcke stehen bereit“ mit der Zahl der fehlenden Blöcke. Nachrüsten legt nur die fehlenden vorab an; im Builder wären sie auch ohne Nachrüsten wählbar. Bereits vorhandene und gelöschte Blöcke bleiben unberührt.
- Wenn die Ausstattung abbrach (Fenster geschlossen, Verbindung weg, einzelne Einträge fehlgeschlagen), steht in der Übersicht „Ausstattung unvollständig“ mit „x von y sind da“. Nachholen macht dort weiter, wo der Lauf stand. Schon vorhandene Einträge werden nicht doppelt angelegt. Meldet der Dialog „Ein anderer Vorgang arbeitet noch an dieser Umgebung“, warten Sie kurz und versuchen es noch einmal.
- Komponenten einzeln oder gesammelt übernehmen Sie jederzeit in der Bibliothek (Alle übernehmen, Kategorie übernehmen).
- Als Entwickler nutzen Sie dafür
hcms add --alle(siehe Eigene Website anbinden).
Der Lauf erscheint unter Letzte Operationen mit dem Typ Ausstattung.
Eine Umgebung bearbeiten
Über das Stift-Symbol ändern Sie Name und Farbe und wählen die Marke der Umgebung. Die Marke bestimmt Absender und Impressum der Mails, zum Beispiel von Formularen. Ohne Wahl gilt die Standard-Marke, siehe Marken. Das Feld erscheint, sobald Ihre Organisation Marken angelegt hat. Dazu hinterlegen Sie zwei Adressen:
| Feld | Bedeutung |
|---|---|
| API-Basis-URL | Optionale Adresse der Website, die diese Umgebung anzeigt |
| Vorschau-URL | Vorlage für Vorschau-Links aus dem Editor. Platzhalter: {token} und {path}, z.B. https://www.beispiel.ch/api/draft?token={token}&path={path} |
Ohne Vorschau-URL funktionieren die Knöpfe Vorschau und Vorschau öffnen in Seiten und Einträgen nicht.
Die Umgebung „Hike“
Hat Ihre Organisation die App Hike, gibt es zusätzlich die Umgebung Hike. Sie enthält die Inhalte des öffentlichen Portals, darunter das Layout Hike-Standard für Kopf und Fuss. Es wird beim ersten Gebrauch von Hike automatisch angelegt. Siehe Kopf und Fuss des Hike-Portals pflegen.
Vorschau-Links einer Umgebung
Ein Klick in der Spalte Vorschau der Übersicht öffnet die Vorschau-Seite der Umgebung, auch wenn noch keine Vorschau-URL hinterlegt ist. Dort sehen Sie:
- Vorschau-URL: wohin das Vorschaufenster aus dem Editor zeigt.
- Eigener Schlüssel dieser Umgebung: Jeder Vorschau-Link ist mit einem Vorschau-Schlüssel signiert, den nur diese Umgebung hat. Der Server prüft ihn bei jedem Aufruf. Angezeigt wird nur die Schlüssel-Version, der Schlüssel selbst nie.
- Gültigkeit eines Vorschau-Links: 4 Stunden ab dem Öffnen aus dem Editor. Danach zeigt das Vorschaufenster „abgelaufen“, und ein neuer Klick auf Vorschau öffnet es wieder. Ein weitergegebener Link gilt nur einmal und höchstens zwei Minuten; eine zweite Person öffnet die Vorschau aus ihrem eigenen Editor.
- Im Vorschaufenster aus: Tag Manager, Besucherstatistik, Werbe-Pixel und eigene Kopfskripte laden im Vorschaufenster des Hike-Portals nie. Sie sähen sonst unveröffentlichte Inhalte und zählten die Besuche der Redaktion mit. Bei einer eigenen Website schaltet die Website sie selbst ab (siehe Website-Anbindung prüfen).
- Offene Vorschau-Sitzungen: welche Person seit wann welche Seite in einem Vorschaufenster offen hat und wann die Sitzung abläuft.
Website-Anbindung prüfen
Die Karte Website-Anbindung auf derselben Seite zeigt, was Ihre Website im Vorschaufenster kann. Bei einem eigenen Website-Projekt steht dort auch die Zeile, die Ihr Entwickler im Layout der Website einbaut; in der Umgebung „Hike“ ist die Anbindung schon eingebaut.
- Klicken Sie auf Verbindung testen. Scorebase öffnet eine Seite dieser Umgebung in einem neuen Tab, als Vorschau. Dafür braucht die Umgebung eine Vorschau-URL und mindestens eine Seite.
- Antwortet die Website, steht in der Karte z.B. „Website antwortet · kann: Live-Vorschau, Auswahl, Text, Bilder“. Kann zählt auf, was die Vorschau-Anbindung Ihrer Website meldet: Live-Vorschau (Eingaben erscheinen vor dem Speichern), Auswahl (ein Klick im Vorschaufenster öffnet die Stelle im Editor), dazu Werkzeuge wie Text, Bilder, Stil, Blöcke ordnen oder Navigation.
- „Website antwortet, meldet aber keine Werkzeuge“ heisst: Die Live-Vorschau funktioniert, für Auswahl und Bearbeiten braucht die Website eine neuere Anbindung. „Keine Antwort vom Vorschaufenster“ heisst: Die Website hat keine Vorschau-Anbindung. Ohne sie lädt das Vorschaufenster nach jedem Speichern neu.
Darunter sehen Sie, ob Ihre Website im Vorschaufenster Mess- und Marketingskripte lädt (Tag Manager, Besucherstatistik, Werbe-Pixel). Sie gehören dort abgeschaltet, sonst sähen sie unveröffentlichte Inhalte und zählten die Besuche der Redaktion mit. Abschalten muss die Website selbst; die Angabe stammt von Ihrer Website und wird nicht unabhängig geprüft.
Alle Vorschau-Links ungültig machen
Ist ein Vorschau-Link in falsche Hände geraten, klicken Sie auf Alle Vorschau-Links ungültig machen. Der Dialog nennt, wie viele offene Vorschau-Sitzungen betroffen sind. Nach Ungültig machen steigt die Schlüssel-Version um eins:
- Alle bisherigen Vorschau-Links dieser Umgebung laufen sofort ab, offene Vorschaufenster zeigen „abgelaufen“.
- Gespeicherte Inhalte bleiben unverändert.
- Neue Vorschau-Links aus dem Editor funktionieren sofort wieder.
Meldet Scorebase „Nicht alle offenen Vorschaufenster liessen sich sofort beenden“, gilt der Widerruf trotzdem: Beim nächsten Laden zeigen diese Fenster keine Entwürfe mehr, und sie laufen spätestens nach 4 Stunden ab. Die Aktion braucht das Recht Einstellungen verwalten und wird protokolliert.
Änderungen übertragen (Promote)
- Klicken Sie in der Übersicht auf Promote.
- Quelle & Ziel: Wählen Sie Quelle (z.B. Staging) und Ziel (z.B. Produktion), den Modus (Nur Schema = nur Collections und Felder, oder Schema + Inhalte), die Collections (alle oder eine Auswahl) und unter Zusätzlich übertragen optional Seiten, Menüs, Themes, Blöcke, Layouts und Komponenten. Klicken Sie auf Weiter. Von Komponenten wird der veröffentlichte Stand übertragen; eine Komponente, die noch nie veröffentlicht wurde, bleibt mit einer Warnung zurück.
- Vorschau: Scorebase zeigt, was im Ziel Neu, Geändert oder Unverändert ist. Was nur im Ziel existiert, erscheint unter „Nur im Ziel vorhanden (wird NICHT gelöscht)“.
- Bestätigung: Wählen Sie die Konflikt-Strategie:
- Überschreiben (mit Rollback-Revision) – Einträge im Ziel werden ersetzt; der vorherige Stand bleibt als Version erhalten.
- Überspringen – bestehende Einträge im Ziel bleiben unverändert.
- Abbrechen bei Konflikt – bei einem Konflikt wird nichts übertragen.
- Klicken Sie auf Promote ausführen. Ergebnis zeigt, was erstellt, überschrieben und übersprungen wurde.
Wichtig: Eine Übertragung löscht im Ziel nie etwas. Was Sie in der Quelle gelöscht haben, entfernen Sie im Ziel von Hand.
Standard-Umgebung ändern und Umgebungen löschen
- Als Standard macht eine Umgebung zur Standard-Umgebung. Die Content API liefert sie aus, wenn eine Anfrage keine andere Umgebung nennt und das Token an keine Umgebung gebunden ist. Ändern Sie das nur bewusst: Ihre Website zeigt danach die Inhalte dieser Umgebung.
- Löschen (nur bei Umgebungen, die nicht Standard sind): Zur Bestätigung tippen Sie den Key der Umgebung ein. Die Aktion ist unwiderruflich und entfernt alle Einträge, Seiten, Collections, Medien und Tokens dieser Umgebung.
Tokens und Umgebungen
Ein API-Token kann an eine Umgebung gebunden werden (siehe API-Tokens). Ein gebundenes Token liefert immer diese Umgebung, egal was die Anfrage verlangt. Empfehlung:
- Die Live-Website nutzt ein Token, das an Produktion gebunden ist und nur Lesen darf.
- Entwicklung und Tests nutzen ein Token, das an die Test-Umgebung gebunden ist.
- Ein ungebundenes Token wählt die Umgebung mit
?environment=<key>; ohne Angabe gilt die Standard-Umgebung.
Für Entwickler: Umgebungen per Kommandozeile
hcms env list # Umgebungen auflisten
hcms env clone --from prod --to staging --name "Staging" --content --pages --theme
hcms env status --op <id> # Stand eines Vorgangs
hcms promote --from staging --to prod --with-content --pages --menus --themes --dry-run
hcms promote --from staging --to prod --conflict skipOption von hcms promote |
Bedeutung |
|---|---|
--from, --to |
Quell- und Ziel-Umgebung (Key) |
--collections a,b |
Nur diese Collections |
--with-content |
Einträge mitnehmen |
--pages, --menus, --themes |
Seiten, Menüs, Themes mitnehmen |
--conflict |
overwrite (Standard), skip oder fail |
--dry-run |
Nur anzeigen, was passieren würde |
Fast jeder Befehl nimmt --env <key> entgegen; ohne Angabe gilt environment aus hcms.config.json. Alle Befehle brauchen ein Token mit der Berechtigung Verwaltung.
Wenn etwas nicht klappt
| Symptom | Ursache | Lösung |
|---|---|---|
| Neue Inhalte fehlen auf der Website | Sie haben in einer anderen Umgebung gearbeitet | Umgebung oben in der Seitenleiste prüfen; Änderungen mit Promote übertragen |
Die Content API meldet UNKNOWN_ENVIRONMENT |
Der Key in ?environment= existiert nicht |
Key in der Übersicht nachsehen |
Die Website ignoriert ?environment= |
Das Token ist an eine Umgebung gebunden | Anderes Token verwenden oder Bindung beim neuen Token anders wählen |
| Promote meldet Konflikte | Einträge wurden in beiden Umgebungen geändert | Strategie Überspringen oder Überschreiben wählen; vorher die Vorschau prüfen |
| Löschen fehlt bei einer Umgebung | Die Standard-Umgebung lässt sich nicht löschen | Erst eine andere Umgebung Als Standard setzen |
| Die neue Umgebung hat weniger Blöcke als erwartet | Die Übersicht zählt nur, was schon angelegt ist; eine App ist nicht abonniert, oder Ihnen fehlt das Recht für Blöcke bzw. Komponenten | Im Seiten-Editor sind alle Bausteine der Bibliothek wählbar. Wollen Sie sie vorab anlegen: Abo und Rechte prüfen, danach Nachrüsten |
| „Die Ausstattung ist unterbrochen“ oder „nicht vollständig“ | Fenster geschlossen, Verbindung weg oder einzelne Einträge fehlgeschlagen | Nachholen wählen, der Lauf setzt fort |
| Alle Vorschaufenster zeigen „abgelaufen“ | Jemand hat Alle Vorschau-Links ungültig machen ausgelöst, oder die 4 Stunden sind um | Im Editor erneut auf Vorschau klicken |