GitLab Pages ist eine Initiative von GitLab, die Benutzern dabei hilft, Websites für ihre GitLab-Projekte, -Gruppen und -Benutzerkonten zu erstellen. Sie können Ihre statischen Websites kostenlos auf GitLab.com hosten – oder sogar auf Ihrer eigenen Instanz der GitLab Enterprise Edition.
In diesem Handbuch erkunden wir GitLab Pages detaillierter und geben Ihnen eine Schritt-für-Schritt-Anleitung, die Ihnen beim Erstellen einer GitLab Pages-Website hilft.
Was sind GitLab Pages überhaupt?
Mit GitLab Pages können Sie statische Websites aus dem Repository in GitLab veröffentlichen. Es dient einer Vielzahl von Zwecken, darunter:
- Für jede private oder geschäftliche Website verwenden
- Verwenden Sie einen beliebigen Static Site Generator (SSG) oder einfaches HTML
- Erstellen Sie eine Website für Ihre Projekte, Gruppen und Benutzerkonten
- Erstellen Sie kostenlos eine Website auf Ihrer eigenen GitLab-Instanz oder auf GitLab.com
- Verbinden Sie Ihre benutzerdefinierten Domänen und TLS-Zertifikate
- Weisen Sie Ihren Inhalten eine beliebige Lizenz zu
Um eine Website mit GitLab Pages veröffentlichen zu können, benötigen Sie einen Static Site Generator (z. B. Jekyll, Middleman, Gatsby, Hugo, Brunch oder Harp). Sie können auch Websites veröffentlichen, die direkt in einfachem HTML, JavaScript und CSS geschrieben sind.
Website-Typen
Sie können mit GitLab Pages zwei Arten von Websites erstellen und hosten:
- Benutzer-/Gruppenwebsite – Einzelne Site pro Benutzer oder Gruppe
- Projektwebsite – So viele Websites wie Sie möchten
So funktioniert GitLab Pages
Um GitLab Pages zu verwenden, müssen Sie zunächst ein Projekt in GitLab erstellen, unabhängig davon, ob es öffentlich, privat oder intern ist, um Ihre Website-Dateien hochzuladen. GitLab Pages stellt Ihre Website immer aus einem bestimmten Ordner namens „ öffentlich“ in Ihrem Repository bereit. Immer wenn Sie ein neues Projekt erstellen, wird automatisch ein Repository in GitLab verfügbar.
Um Ihre Site bereitzustellen, verwendet GitLab sein integriertes Tool namens GitLab CI/CD, um Ihre Website zu erstellen und auf dem GitLab Pages-Server zu veröffentlichen. Die Skriptsequenz, die GitLab CI/CD ausführt, um diese Aufgabe zu erfüllen, wird aus einer speziellen Datei namens .gitlab -ci.yml erstellt , die erstellt und geändert werden kann.
Hier müssen Sie auch über einen bestimmten Job namens „Pages“ in der Konfigurationsdatei Bescheid wissen, der GitLab darüber informiert, dass Sie eine GitLab Pages-Website bereitstellen.
Hierfür können Sie entweder die GitLab-Standarddomäne für GitLab Pages-Websites, * .gitlab.io , oder Ihre eigene Domäne (z. B. abc.com ) verwenden. Denken Sie daran, dass Sie der Administrator Ihres Domänenregistrars oder Ihres Kontrollplan-Panels sein müssen, um es mit Seiten einzurichten.
Kurzer Überblick über GitLab Pages
Wir werden die Schritt-für-Schritt-Anleitung später im Artikel noch ausführlicher behandeln, hier jedoch ein kurzer Überblick über die Verwendung von GitLab Pages:
Für diesen Artikel gehen wir davon aus, dass Sie eines der Beispielprojekte von GitLab forken, anstatt ein Projekt von Grund auf neu zu erstellen. Sie können jeden beliebigen statischen Site-Generator wählen, da GitLab Pages mit allen kompatibel ist.
Als Nächstes müssen Sie Shed-Runner aktivieren. Wir empfehlen, die kostenlosen gemeinsam genutzten Runner auf GitLab.com zu nutzen, wo alle Ihre Builds auf separaten virtuellen Maschinen ausgeführt werden, die die neueste Docker-Engine verwenden. Da es außerhalb des Containers zu keinen möglichen Ausfällen kommt, werden Sicherheitsprobleme effektiv ausgeschlossen. Dies ist jedoch nur ein Vorschlag, und Sie können jederzeit Ihren eigenen Runner für Ihr Projekt einrichten.
Als Nächstes folgt die Projektkonfiguration, ein optionaler Schritt. Wenn Sie Ihr Projekt nicht konfigurieren, ist Ihre Website unter https:// Benutzername .gitlab.io/ Projektname verfügbar , wobei Benutzername Ihr Benutzername auf GitLab und Projektname der Name des Projekts ist, das Sie im ersten Schritt geforkt haben. Dies wird auch als Projektseite bezeichnet.
Sobald dies erledigt ist, müssen Sie zum ersten Mal manuell eine Pipeline ausführen, um den Joberfolg auszulösen. Alternativ können Sie mindestens eine Änderung committen und pushen. Sie können Ihre Site-Dateien direkt im Browser bearbeiten, aber Sie können Git auch über die Befehlszeile verwenden, wenn Sie möchten.
Danach können Sie endlich Ihren Shop besuchen. Starten Sie einfach Ihren Browser und besuchen Sie https://Benutzername.gitlab.io/Projektname oder https://Benutzername.gitlab.io , je nachdem , ob Sie Ihr Projekt konfiguriert haben oder nicht .
Beispiele für GitLab Pages
Sie können sich die offizielle Pages-Gruppe ansehen, um eine Liste mit Beispielprojekten zu erhalten. Dies kann ein guter Ort sein, um Optionen für statische Statusgeneratoren für Ruby-, Python- und NodeJS-Umgebungen zu erkunden.
Hier ist für den Anfang eine Liste mit spezifischeren Beispielen:
- Von iOS aus in Ihrem GitLab Pages-Blog posten .
- GitLab CI: Führen Sie Jobs sequenziell oder parallel aus oder erstellen Sie eine benutzerdefinierte Pipeline .
- GitLab CI: Bereitstellung und Umgebungen .
- Erstellen einer neuen GitLab-Dokumentationssite mit Nanoc, GitLab CI und GitLab Pages .
- Veröffentlichen Sie Code Coverage-Berichte mit GitLab Pages .
So erstellen Sie eine GitLab Pages-Website
Bevor wir mit dem Tutorial beginnen, stellen Sie sicher, dass Sie ein leeres Projekt in GitLab haben. Sehen wir uns nun an, wie Sie eine GitLab Pages-Website erstellen können.
Schritt 1: Erstellen Sie die Projektdateien
Erstellen Sie drei Dateien im obersten Verzeichnis bzw. Stammverzeichnis.
- .gitlab-ci.yml: Dies ist eine YAML-Datei, die die Befehle enthält, die Sie ausführen möchten. Lassen Sie den Dateiinhalt vorerst leer.
- index.html: Dies ist eine HTML-Datei, die Sie mit jedem gewünschten HTML-Inhalt füllen können.
- Gemfile: Diese Datei beschreibt Abhängigkeiten für Ruby-Programme. Füllen Sie sie mit folgendem Inhalt:
Quelle „https://rubygems.org“
Edelstein „Jekyll“
Schritt 2: Wählen Sie ein Docker-Image
Der Runner verwendet ein Docker-Image, um Skripte auszuführen und die Site bereitzustellen, während das Ruby-Image auf DockerHub verwaltet wird.
Bearbeiten Sie Ihre .gitlab-ci.yml-Datei und fügen Sie den folgenden Text als erste Zeile hinzu:
Bild: Ruby:2.7
Wenn Ihr SSG zum Erstellen NodeJS benötigt, geben Sie unbedingt ein Image an, das NodeJS als Teil seines Dateisystems enthält.
Schritt 3: Jekyll installieren
Bevor Sie Jekyll lokal ausführen können, müssen Sie es installieren. So gehen Sie dazu vor:
- Öffnen Sie Ihr Terminal und installieren Sie Bundler , indem Sie „gem install bundler“ ausführen .
- Führen Sie die Bundle-Installation aus , um Gemfile.lock zu erstellen.
- Installieren Sie Jekyll, indem Sie „bundle exec jekyll build“ ausführen.
Um Jekyll in Ihrem Projekt auszuführen, müssen Sie die Datei .gitlab-ci.yml bearbeiten und die folgenden Installationsbefehle hinzufügen:
Skript:
– Gem-Installationspaket
– Bundle-Installation
– Bundle-Exec-Jekyll-Build
Interessanterweise ist jedes Skript in der Datei .gitlab-ci.yml nach einem Job organisiert . Ein Job enthält die Skripte und Einstellungen, die Sie zum Ausführen dieser bestimmten Aufgabe anwenden müssen.
So wird es aussehen:
Arbeit:
Skript:
– Gem-Installationspaket
– Bundle-Installation
– Bundle-Exec-Jekyll-Build
Für GitLab Pages hat dieser Job einen bestimmten Namen, der als „ pages“ bezeichnet wird . Diese spezielle Einstellung ist wichtig, da sie dem Runner mitteilt, dass der Job Ihre Website mit GitLab Pages bereitstellen soll.
Seiten:
Skript:
– Gem-Installationspaket
– Bundle-Installation
– Bundle-Exec-Jekyll-Build
Schritt 4: Öffentliches Verzeichnis für die Ausgabe festlegen
Hier müssen Sie Jekyll angeben, wo die Ausgabe generiert werden soll. Denken Sie daran, dass GitLab Pages nur Dateien in einem Verzeichnis namens „ public“ berücksichtigt .
Jekyll verwendet ein Zielflag ( -d ), um ein Ausgabeverzeichnis für die erstellte Website anzugeben. Ihre Aufgabe besteht darin, Ihrer .gitlab-ci.yml-Datei ein Ziel hinzuzufügen:
Seiten:
Skript:
– Gem-Installationspaket
– Bundle-Installation
– Bündel exec jekyll build -d öffentlich
Schritt 5: Öffentliches Verzeichnis für Artefakte festlegen
Zu diesem Zeitpunkt hat Jekyll die Dateien in das öffentliche Verzeichnis ausgegeben. Nun muss der Runner wissen, wo er sie bekommt.
Wie erwähnt werden die Artefakte im öffentlichen Verzeichnis für eine GitLab Pages-Website gespeichert. So sehen die Artefakte aus:
Seiten:
Skript:
– Gem-Installationspaket
– Bundle-Installation
– Bündel exec jekyll build -d öffentlich
Artefakte:
Pfade:
– öffentlich
Ihre .gitlab-ci.yml-Datei sollte jetzt folgendermaßen aussehen:
Bild: Ruby:2.7
Seiten:
Skript:
– Gem-Installationspaket
– Bundle-Installation
– Bündel exec jekyll build -d öffentlich
Artefakte:
Pfade:
– öffentlich
Schritt 6: Bereitstellen und Anzeigen der GitLab Pages-Website
Schließlich können Sie Ihre GitLab Pages-Website bereitstellen!
Gehen Sie hierzu folgendermaßen vor:
- Speichern und committen Sie die Datei .gitlab-ci.yml.
- Gehen Sie zu CI/CD , gefolgt von Pipelines, um die Pipeline zu beobachten.
- Wenn die Pipeline erfolgreich ist, navigieren Sie zu „Einstellungen“ und klicken Sie auf „Seiten“ . Zeigen Sie die URL an, unter der Ihre Site jetzt verfügbar ist.
Mehr lesen: 18 Beste Free YouTube Downloader
Hilfreiche Beiträge zur Navigation in GitLab
Wenn Ihnen dieser Beitrag gefallen hat und Sie die faszinierende Welt von GitLab weiter erkunden möchten, empfehlen wir Ihnen, sich einige der anderen Blogbeiträge anzusehen, die wir zur Unterstützung von Entwicklern erstellt haben.
- Das ultimative Handbuch zum GitLab-Workflow
- Das ultimative Handbuch zur GitLab Jira Integration
- Das ultimative Handbuch zur Einrichtung des GitLab-SSH-Schlüssels
- GitLab vs. GitHub
