Lokales Setup APF-Doku-Seite

Aus APF Wiki
Version vom 11. Mai 2014, 14:56 Uhr von Christian (Diskussion | Beiträge) (Diese Seite wurde zum Übersetzen freigegeben)
Wechseln zu: Navigation, Suche

Die folgende Anleitung zeigt, wie die offizielle APF-Webseite auf einer lokalen Entwicklungsmschine installiert werden kann.

GIT Checkout

Die Quellen der APF-Webseite werden unter GitHub.com/docs verwaltet. Zusätzlich dazu benötigen Sie die Inhalte des code-Repositories in der gewünschten Version. Für letztere ist bereits eine Submodule-Konfiguration auf den aktuellen Entwicklungszweig vorhanden, der lokal nur noch initialisiert werden muss.

Führen Sie zunächst ein

mkdir -p /var/www/html/docu-page && cd /var/www/html/docu-page
git clone https://www.github.com/AdventurePHP/docs.git .

aus. Sie haben nun die Quellen der APF-Webseite zur Verfügung.

In einem weiteren Schritt ist muss nun das definierte Submodule code wie folgt initialisiert werden:

git submodule init

Sofern es für das code-Repository bereits eine lokale Arbeitskopie gibt, wird git versuchen, diese als Remote-Repository zu nutzen. Um dies zu umgehen, können Sie im Ordner /var/www/html/docu-page/APF das Kommando

git remote set-url origin https://github.com/AdventurePHP/code.git

ausführen.

Nun sind auch die Quellen des Frameworks lokal vorhanden und Sie können mit den folgenden Kapiteln fortfahren.

Einrichtung der VHOSTs

Für den Betrieb der Webseite sind zwei virtueller Hosts erforderlich:

  • apf.org (o.ä.): Auslieferung der Seite
  • media.adventure-php-framework.org: Auslieferung der statischen Resourcen

Die Domain apf.org kann beliebig angepasst werden, media.adventure-php-framework.org ist verpflichtend.

Die folgende Code-Box zeigt ein Beispiel für die notwendigen VHOSTs (Checkout-Verzeichnis: /var/www/html/docu-page):

<VirtualHost *:80>
    DocumentRoot /var/www/html/docu-page/www
    ServerName apf.org
    AllowEncodedSlashes On
    ...
</VirtualHost>

<VirtualHost *:80>
    DocumentRoot /var/www/html/docu-page/media
    ServerName media.adventure-php-framework.org
    ...
</VirtualHost>

Möchten Sie auch den Download von Release-Dateien testen, ist ein dritter VHOST erforderlich: files.adventure-php-framework.org. Die Konfiguration kann wie folgt aussehen:

<VirtualHost *:80>
    DocumentRoot /var/www/html/docu-page/builds
    ServerName files.adventure-php-framework.org
    ...
</VirtualHost>

Bitte beachten Sie, dass der Ordner builds später im Wizzard eingetragen werden muss.


Anpassung .htaccess

Die SVN-Quellen liefern einen Wizzard zur lokalen Einrichtung der APF-Webseite mit. Um diesen unter http://apf.org/setup_wizard.php aufgerufen werden kann, ist zumächst eine Anpassung der .htaccess-Datei notwendig. Entfernen Sie bitte die Zeile, in der setup_wizard steht (Zeile 19) und kommentieren Sie die darauf folgende aus.


Ausführen des Wizzard

Im Anschluss an die Vorarbeiten können Sie nun die einzelnen Schritte des Wizzard durchlaufen.

Die einzelnen Schritte sind bewusst getrennt gehalten, damit Sie nachträglich auch eigenständig ausgeführt werden können. Dies ist insbesondere für die Pflege des Such-Index wichtig.


Anpassung der index.php

Die Konfiguration der index.php ist von Ihrer lokalen Umgebung abhängig. Mit dem ersten Wizzard http://apf.org/setup_wizzard.php?page=index können Sie diese anpassen. Bitte geben Sie dazu denjenigen Ordner an, in dem die Release-Dateien abgelegt sein werden.

Sofern Sie keine Build-Dateien vorhalten, geben Sie trotzdem einen lokalen, leeren Ordner an. Der Wizzard erstellt darin ein leeres Standard-Layout.

Weitere Instruktionen entnehmen Sie bitte dem Wizzard.


Datenbank-Konfiguration

Im Anschluss können Sie die Datenbank-Konfiguration vornehmen. Der Wizzard http://apf.org/setup_wizard.php?page=database geht davon aus, dass alle benötigten Verbindungen über den selben Benutzer verfügen Sollte dies für Ihre lokale Umgebung nicht zutreffen, passen Sie die Konfigurations-Datei bitte nach dem Ausführen des Wizzards manuell an.

Weitere Instruktionen entnehmen Sie bitte dem Wizzard.


Datenbank-Initialisierung

Um die Anwendung lokal betreiben zu können, muss die gewählte Datenbank bzw. die gewählten Datenbanken initialisiert werden. Der Wizzard unter http://apf.org/setup_wizard.php?page=setup lässt sich dabei auch mehrmals ausführen und Sie können entweder alle Datenbanken zusammen oder mehrere einzeln initialisieren.

Mehrmaliges Ausführen führt dabei nicht zu Datenverlust, da der Wizzard keine Daten löscht und die Tabellen nur anlegt, wenn diese noch nicht erstellt wurden.

Weitere Instruktionen entnehmen Sie bitte dem Wizzard.


Erstellen des Such-Index

Der Such-Index erfüllt zwei Aufgaben: URL-Generierung und Basis für die Suche. Die URL-Generierung nutzt dabei die Artikel-Liste innerhalb des Suche-Index.

Führen Sie den Wizzard http://apf.org/setup_wizard.php?page=search immer dann aus, wenn Sie einen neuen Artikel angelegt haben oder den Such-Index aktualisieren wollen.

Weitere Instruktionen entnehmen Sie bitte dem Wizzard.

Sprachen:
Deutsch • ‎English