Sculpin in der ServBay-Umgebung installieren und konfigurieren

Überblick

Sculpin ist ein leistungsstarker und flexibler statischer Webseiten-Generator auf PHP-Basis. Er eignet sich besonders gut für die Erstellung von Blogs, Dokumentationsseiten oder jedes andere Projekt, bei dem dynamische Inhalte (wie Twig-Templates und Markdown-Dateien) in performante statische HTML-Seiten umgewandelt werden sollen. Sculpin verwaltet Abhängigkeiten über Composer und basiert auf Symfony-Komponenten, was Entwicklern eine vertraute sowie zuverlässige Arbeitsumgebung bietet.

ServBay ist eine speziell für macOS entwickelte lokale Web-Entwicklungsumgebung, die zahlreiche gängige Softwarepakete integriert, darunter PHP, Composer, Datenbanken (MySQL, PostgreSQL, MongoDB, Redis) und Webserver (Caddy, Nginx). Außerdem bietet sie eine benutzerfreundliche grafische Oberfläche. Mit ServBay wird das Einrichten einer Sculpin-Entwicklungsumgebung auf macOS stark vereinfacht – insbesondere die Handhabung von PHP-Versionen, Abhängigkeitsmanagement und Webserver-Konfigurationen.

Diese Anleitung zeigt Schritt für Schritt, wie Sie Sculpin in ServBay installieren und konfigurieren und eine lokale Entwicklungsseite einrichten.

Einsatzszenarien

• Aufbau eines leistungsfähigen statischen Blogs mit PHP-Technologie.
• Erstellung statischer Dokumentations-Websites für Open-Source-Projekte oder Produkte.
• Rascher Aufbau von statischen Marketing-Landingpages oder Unternehmenswebsites ohne Backend-Datenbank.
• Nutzung von Twig-Templates und Markdown für die Inhaltserstellung – profitieren Sie hierbei von der Geschwindigkeit und Sicherheit statischer Webseiten.

Voraussetzungen

Bitte stellen Sie vor dem Start sicher, dass Sie folgende Voraussetzungen erfüllen:

1. ServBay ist auf Ihrem macOS-System installiert und läuft bereits. ServBay stellt die benötigte PHP-Umgebung, den Composer-Abhängigkeitsmanager und einen Webserver (Caddy oder Nginx) bereit.
2. Grundlegende Kenntnisse im Umgang mit der Kommandozeile.
3. Vertrautheit mit den Grundlagen von PHP, Composer und Markdown.

Schritte zur Installation von Sculpin

Nachfolgend finden Sie die detaillierten Schritte zur Installation und Konfiguration von Sculpin in der ServBay-Umgebung:

Schritt 1: Projektverzeichnis erstellen

Legen Sie zunächst im ServBay-Webroot-Verzeichnis (/Applications/ServBay/www) ein neues Projektverzeichnis an. Wir verwenden hierfür beispielhaft den Projektnamen servbay-sculpin-app.

Öffnen Sie das Terminal und führen Sie folgende Befehle aus:

cd /Applications/ServBay/www
mkdir servbay-sculpin-app
cd servbay-sculpin-app

In diesem Verzeichnis werden Ihre Sculpin-Projektdateien abgelegt.

Schritt 2: Sculpin-Projekt mit Composer erstellen

ServBay bringt Composer bereits vorinstalliert mit – eine zusätzliche Installation entfällt. Sie können Composer direkt im Terminal verwenden.

Zum Schnellstart verwenden wir das offizielle Blog-Template von Sculpin. Wechseln Sie in das eben erstellte Verzeichnis servbay-sculpin-app und führen Sie diesen Composer-Befehl aus:

composer create-project sculpin/sculpin-blog-skeleton .

Mit diesem Befehl lädt Composer das Sculpin-Blog-Template mit allen benötigten Abhängigkeiten und installiert es im aktuellen Verzeichnis (.).

Schritt 3: ServBay-Website konfigurieren

Damit Sie Ihre Sculpin-Seite über den ServBay-Webserver (Caddy oder Nginx) aufrufen können, muss eine Website in ServBay angelegt und eingerichtet werden.

1. ServBay-App starten: Öffnen Sie die grafische Oberfläche von ServBay.
2. Zum „Websites“-Tab wechseln: Wählen Sie in der ServBay-Navigation den Reiter „Websites“.
3. Neue Website hinzufügen: Klicken Sie auf das „+“-Symbol unten links, um eine neue Website zu erstellen.
4. Website-Daten ausfüllen:
   • Name: Geben Sie einen leicht erkennbaren Namen ein, z.B. My Sculpin Site.
   • Domain: Tragen Sie die gewünschte lokale Domain ein, z.B. servbay-sculpin.local. ServBay richtet für .local-Domains die lokale Namensauflösung sowie ein SSL-Zertifikat automatisch ein (mit ServBay User CA).
   • Typ: Wählen Sie PHP, da Sculpin eine PHP-Anwendung ist.
   • PHP-Version: Wählen Sie die gewünschte PHP-Version aus. ServBay unterstützt mehrere PHP-Versionen – wählen Sie eine mit Sculpin kompatible (meist genügt die aktuelle Version).
   • Document Root: Dieser Schritt ist entscheidend. Sculpin speichert die generierten statischen Dateien standardmäßig in den Verzeichnissen output_dev oder output_prod im Projektordner. Für die lokale Entwicklung weisen Sie das Verzeichnis wie folgt zu: /Applications/ServBay/www/servbay-sculpin-app/output_dev
5. Konfiguration speichern: Wenn alle Angaben gemacht sind, klicken Sie auf „Speichern“. ServBay übernimmt die Konfiguration automatisch auf den Webserver (Caddy oder Nginx). Üblicherweise ist kein manueller Neustart von ServBay erforderlich.

Schritt 4: Sculpin-Website bauen

Nach dem Einrichten der Website in ServBay müssen mit Sculpin die statischen Seiten generiert werden.

Stellen Sie im Terminal sicher, dass Sie weiterhin im Projekt-Stammverzeichnis /Applications/ServBay/www/servbay-sculpin-app sind. Führen Sie dann folgenden Befehl aus, um alle Abhängigkeiten zu installieren (falls bereits in Schritt 2 erledigt, ist das optional, aber sollte ausgeführt werden, um sicherzustellen, dass alles korrekt installiert ist):

composer install

Danach bauen Sie die Projektseite mit folgendem Sculpin-Befehl:

vendor/bin/sculpin generate --watch

• vendor/bin/sculpin: Pfad zur mit Composer installierten Sculpin-Programmdatei.
• generate: Das Sculpin-Kommando, das aus Vorlagen und Inhalten im Verzeichnis source statische Webseiten erzeugt und sie ins Ausgabe-Verzeichnis schreibt (standardmäßig output_dev).
• --watch: Mit diesem Flag überwacht Sculpin das source-Verzeichnis auf Änderungen. Bei Änderungen werden die statischen Seiten automatisch neu gebaut – ideal für die Entwicklungsphase.

Sobald dieser Befehl erfolgreich abgeschlossen ist und Sie beispielsweise "Sculpin has generated your site!" sehen, wurden alle statischen Dateien im Verzeichnis output_dev abgelegt.

Schritt 5: Lokale Entwicklungsseite aufrufen

Jetzt können Sie Ihre Sculpin-Website unter der im ServBay eingerichteten Domain aufrufen.

Öffnen Sie Ihren Webbrowser und besuchen Sie die in Schritt 3 konfigurierte Domain:

https://servbay-sculpin.local

Da Sie das Document Root auf output_dev gesetzt haben und der Befehl sculpin generate --watch läuft, können Sie unter https://servbay-sculpin.local Ihre Änderungen an Inhalten und Templates in Echtzeit überprüfen. Das von ServBay ausgestellte SSL-Zertifikat sorgt dafür, dass Sie die Seite sicher per HTTPS im lokalen Netzwerk abrufen können.

Entwicklung mit Sculpin

Mit der erfolgreichen Installation und Konfiguration von Sculpin in ServBay können Sie nun mit der Entwicklung Ihrer statischen Website beginnen. Im Folgenden einige grundlegende Arbeitsschritte:

Sculpin-Projektstruktur im Überblick

Ein grundlegendes Verständnis für die zentrale Sculpin-Verzeichnisstruktur hilft beim Entwickeln:

servbay-sculpin-app/
├── app/                # App-Konfigurationsdateien und Cache
├── output_dev/         # Ausgabeverzeichnis (Staging/Entwicklung) für statische Dateien (ServBay weist das Document Root hierhin)
├── output_prod/        # Ausgabeverzeichnis (Produktion) für statische Dateien
├── source/             # Quellverzeichnis der Webseite (Markdown-Inhalte, Twig-Templates, statische Ressourcen etc.)
│   ├── _layouts/       # Twig-Layoutdateien
│   ├── _posts/         # Markdown-Dateien für Blogbeiträge
│   ├── assets/         # Statische Ressourcen (CSS, JS, Bilder etc.)
│   └── index.md        # Markdown-Datei für die Startseite
├── vendor/             # Von Composer installierte Abhängigkeiten
├── sculpin.yml         # Zentrale Sculpin-Konfigurationsdatei
├── composer.json       # Composer-Abhängigkeitsverwaltung
└── ...weitere Dateien

Die meiste Arbeit findet im Ordner source statt.

Blogbeitrag erstellen

Zum Erstellen eines neuen Blogposts legen Sie einfach eine neue Markdown-Datei im Verzeichnis source/_posts ab. Die gängige Dateibenennung folgt diesem Muster: YYYY-MM-DD-slug.md.

Beispiel: Einen Blogbeitrag als 2024-06-06-my-first-post.md anlegen:

---
title: "Mein erster Beitrag"
date: 2024-06-06
tags: [Anleitung, Sculpin, ServBay]
---

# Mein erster Beitrag

Dies ist der Inhalt meines ersten Sculpin-Blogposts. Hier teile ich einige Erfahrungen über die Nutzung von ServBay und Sculpin.

Sie können hier Inhalte mit der Markdown-Syntax verfassen.

## Unterüberschrift

Liste:
- Punkt 1
- Punkt 2

Speichern Sie die Datei. Dank des laufenden Befehls sculpin generate --watch erkennt Sculpin Änderungen automatisch, baut die Seite neu und zeigt den neuen Beitrag nach Aktualisierung von https://servbay-sculpin.local an.

Neue Seite erstellen

Um eine eigenständige Seite (wie „Über uns“) hinzuzufügen, legen Sie im Verzeichnis source einfach eine Markdown-Datei an, z.B. about.md:

---
title: "Über uns"
layout: page.html.twig # Verwendetes Layout-Template angeben
---

# ServBay Sculpin Leitfaden

Diese Seite ist ein Leitfaden zum Erstellen statischer Websites mit ServBay und Sculpin.

Nach dem Speichern erzeugt Sculpin (bei „schöner URL“-Konfiguration) die Datei output_dev/about/index.html. Über https://servbay-sculpin.local/about/ ist die Seite dann erreichbar.

Eigene Styles und Skripte

Statische Ressourcen wie CSS- oder JS-Dateien liegen üblicherweise in source/assets. Diese können Sie direkt editieren.

Zum Anpassen des Seitenstils bearbeiten Sie etwa source/assets/css/style.css.

Beim Bauen der Seite kopiert Sculpin diese Dateien ins Ausgabe-Verzeichnis. Änderungen erkennt Sculpin bei aktiviertem --watch automatisch und startet den Seitenneuaufbau.

Seite für die Produktion bauen

Ist die Seite fertig entwickelt, sollen die Dateien für den Einsatz im Produktionssystem optimiert werden (etwa Ressourcenminimierung).

Das erfolgt mit folgendem Befehl:

vendor/bin/sculpin generate --env=prod

Die statischen Dateien landen dann im Verzeichnis output_prod. Sie können diese Inhalte für das Hosting auf GitHub Pages, Netlify, Vercel oder auf dem eigenen Webserver verwenden.

Soll ServBay die Produktionsversion anzeigen, passen Sie in der Web-Konfiguration das Document Root auf /Applications/ServBay/www/servbay-sculpin-app/output_prod an, speichern Sie und rufen Sie die Domain wie gewohnt auf.

Hinweise

• Stellen Sie sicher, dass ServBay läuft und Ihre Website aktiviert ist.
• Vergewissern Sie sich, dass der Befehl sculpin generate --watch läuft, um während der Entwicklung automatische Updates zu erhalten.
• Prüfen Sie im ServBay-Website-Setup, dass das Document Root richtig auf das Sculpin-Ausgabeverzeichnis verweist (während der Entwicklung i.d.R. output_dev).
• ServBay stellt automatische SSL-Zertifikate für .local-Domains bereit. Möglicherweise müssen Sie in Ihrem Betriebssystem der ServBay User CA vertrauen. Details finden Sie in der ServBay-Dokumentation.

Häufig gestellte Fragen (FAQ)

F: Ich habe Dateien geändert, aber auf der Website passiert nichts?

A: Überprüfen Sie, ob Sie den Befehl vendor/bin/sculpin generate --watch im Projektverzeichnis gestartet haben und er ohne Fehler läuft. Prüfen Sie die Terminalausgabe auf etwaige Fehlermeldungen. Leeren Sie ggf. den Browsercache oder verwenden Sie den privaten Modus.

F: SSL-Fehler bei Zugriff auf https://servbay-sculpin.local?

A: ServBay erstellt für .local-Domains selbstsignierte Zertifikate. Ihr Betriebssystem muss die ServBay User CA als vertrauenswürdig einstufen. Folgen Sie den Anleitungen in der offiziellen ServBay-Dokumentation, um das CA-Zertifikat zu installieren und zu vertrauen.

F: Wie kann ich die PHP-Version wechseln?

A: Im „Pakete“-Tab der ServBay-App lassen sich verschiedene PHP-Versionen installieren und verwalten. Im „Websites“-Tab können Sie dann die gewünschte PHP-Version für Ihre Sculpin-Seite auswählen und speichern.

F: Welche Template-Engines und Markups werden von Sculpin unterstützt?

A: Sculpin verwendet standardmäßig Twig als Template-Engine und unterstützt für Inhalte vor allem Markdown.

Fazit

Dank ServBays integrierter Umgebung lässt sich der Sculpin Static Site Generator unter macOS sehr komfortabel installieren und einrichten. Die vorinstallierte PHP- und Composer-Unterstützung sowie die einfach konfigurierbaren Webserver mit automatischem SSL bilden eine solide Grundlage für lokale Sculpin-Entwicklung. Mit dieser Anleitung können Sie rasch eine Sculpin-Umgebung aufbauen und Ihre statischen Webprojekte effizient entwickeln und testen. Die Stärke von Sculpin in Kombination mit der Benutzerfreundlichkeit von ServBay ermöglicht Ihnen den vollen Fokus auf hochwertige Inhalte – zeitaufwändige, komplexe Setup-Schritte sind damit passé.